CatalystX-I18N
view release on metacpan or search on metacpan
Revision history for Perl module CatalystX::I18N
1.14 Sun Jan 14 2018
- Fix leaking context (RT124055, Charlie Garrison)
- Fix warnings
- Remove MYMETA from dist
- Fix failing tests
1.13 Tue Jan 28 2013
- Fix deprecation warning with latest Moose
- Fix failing tests
1.12 Sat Apr 07 2012
- Removed built in DateTime related type constraints in favour of global
type constraints (MooseX::Types::DateTime) (moltar via github)
- Fixed failing tests (moltar via github)
- Fix dependencies
- Improve documentation
1.11 Sat Apr 07 2012
- Maintenance release
1.10 Sun Jan 22 2012
- Fix test failures on perl < 5.010
- Renamed i18n_timezone to i18n_datetime_timezone (moltar via github)
1.09 Wed Oct 26 2011
- Fix failing tests
- Refactor POSIX locale handling into a separate role
1.08 Fri 14 Oct 2011
- Add support for Data::Localize localization
- Better checks for valid locales
- Refactoring and code cleanup
1.07 Wed 28 Sep 2011
- Fix broken fallback random locale (RT71098, Alexander Hosfeld)
- Fix wrong helper filenames (RT71098, Alexander Hosfeld)
1.06 Thu 08 Sep 2011
- Fix conflicting role method names error with latest Moose
- Check against invalid browser languages
- Dist cleanup
1.05 Sun 12 Dec 2010
- Add CatalystX::I18N::TraitFor::ViewTT
- Add CatalystX::I18N::Role::Colate
- Rename Model::L10N an Role::L10N to *::Maketext (Incompatible change!)
1.04 Sat 16 Oct 2010
- Added more missing dependencies
- Add support for fail_with method in L10N model
- Better posix setlocale support (check for return value)
- Extend documentation
1.03 Tue 12 Oct 2010
- Added missing dependencies
- Fixed bugs in GetLocale role
- Make sure that request/response traits will be applied only once
- Documentation typos
- Better locale checks
- More tests
1.02 Sun 10 Oct 2010
- Added missing dependencies
- Better handling of default locales
- 'All' role for loading all available roles and traits
- Required perl version 5.010 -> 5.008
1.01 Wed 06 Oct 2010
- Added missing dependencies
- Better handling of default locales
- Language-only locales are also accepted
1.00 Wed 06 Oct 2010
- original version
Terms of Perl itself
a) the GNU General Public License as published by the Free
Software Foundation; either version 1, or (at your option) any
later version, or
b) the "Artistic License"
---------------------------------------------------------------------------
The General Public License (GPL)
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave,
Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute
verbatim copies of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your freedom to share
and change it. By contrast, the GNU General Public License is intended to
guarantee your freedom to share and change free software--to make sure the
software is free for all its users. This General Public License applies to most of
the Free Software Foundation's software and to any other program whose
authors commit to using it. (Some other Free Software Foundation software is
covered by the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not price. Our
General Public Licenses are designed to make sure that you have the freedom
to distribute copies of free software (and charge for this service if you wish), that
you receive source code or can get it if you want it, that you can change the
software or use pieces of it in new free programs; and that you know you can do
these things.
To protect your rights, we need to make restrictions that forbid anyone to deny
you these rights or to ask you to surrender the rights. These restrictions
translate to certain responsibilities for you if you distribute copies of the
software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for a
fee, you must give the recipients all the rights that you have. You must make
sure that they, too, receive or can get the source code. And you must show
them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2) offer
you this license which gives you legal permission to copy, distribute and/or
modify the software.
Also, for each author's protection and ours, we want to make certain that
everyone understands that there is no warranty for this free software. If the
software is modified by someone else and passed on, we want its recipients to
know that what they have is not the original, so that any problems introduced by
others will not reflect on the original authors' reputations.
Finally, any free program is threatened constantly by software patents. We wish
to avoid the danger that redistributors of a free program will individually obtain
patent licenses, in effect making the program proprietary. To prevent this, we
have made it clear that any patent must be licensed for everyone's free use or
not licensed at all.
The precise terms and conditions for copying, distribution and modification
follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
MODIFICATION
0. This License applies to any program or other work which contains a notice
placed by the copyright holder saying it may be distributed under the terms of
this General Public License. The "Program", below, refers to any such program
or work, and a "work based on the Program" means either the Program or any
derivative work under copyright law: that is to say, a work containing the
Program or a portion of it, either verbatim or with modifications and/or translated
into another language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not covered by
this License; they are outside its scope. The act of running the Program is not
restricted, and the output from the Program is covered only if its contents
constitute a work based on the Program (independent of having been made by
running the Program). Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's source code as
you receive it, in any medium, provided that you conspicuously and appropriately
publish on each copy an appropriate copyright notice and disclaimer of warranty;
keep intact all the notices that refer to this License and to the absence of any
warranty; and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and you may at
your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion of it, thus
forming a work based on the Program, and copy and distribute such
modifications or work under the terms of Section 1 above, provided that you also
meet all of these conditions:
a) You must cause the modified files to carry prominent notices stating that you
changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in
part contains or is derived from the Program or any part thereof, to be licensed
as a whole at no charge to all third parties under the terms of this License.
c) If the modified program normally reads commands interactively when run, you
must cause it, when started running for such interactive use in the most ordinary
way, to print or display an announcement including an appropriate copyright
notice and a notice that there is no warranty (or else, saying that you provide a
warranty) and that users may redistribute the program under these conditions,
and telling the user how to view a copy of this License. (Exception: if the
Program itself is interactive but does not normally print such an announcement,
your work based on the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If identifiable
sections of that work are not derived from the Program, and can be reasonably
considered independent and separate works in themselves, then this License,
and its terms, do not apply to those sections when you distribute them as
separate works. But when you distribute the same sections as part of a whole
which is a work based on the Program, the distribution of the whole must be on
the terms of this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to
work written entirely by you; rather, the intent is to exercise the right to control
the distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the
Program (or with a work based on the Program) on a volume of a storage or
distribution medium does not bring the other work under the scope of this
License.
3. You may copy and distribute the Program (or a work based on it, under
Section 2) in object code or executable form under the terms of Sections 1 and 2
above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable source
code, which must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three years, to give any
third party, for a charge no more than your cost of physically performing source
distribution, a complete machine-readable copy of the corresponding source
code, to be distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute
corresponding source code. (This alternative is allowed only for noncommercial
distribution and only if you received the program in object code or executable
form with such an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for making
modifications to it. For an executable work, complete source code means all the
source code for all modules it contains, plus any associated interface definition
files, plus the scripts used to control compilation and installation of the
executable. However, as a special exception, the source code distributed need
not include anything that is normally distributed (in either source or binary form)
with the major components (compiler, kernel, and so on) of the operating system
on which the executable runs, unless that component itself accompanies the
executable.
If distribution of executable or object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the source
code from the same place counts as distribution of the source code, even though
third parties are not compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program except as
expressly provided under this License. Any attempt otherwise to copy, modify,
sublicense or distribute the Program is void, and will automatically terminate
your rights under this License. However, parties who have received copies, or
rights, from you under this License will not have their licenses terminated so long
as such parties remain in full compliance.
5. You are not required to accept this License, since you have not signed it.
However, nothing else grants you permission to modify or distribute the Program
or its derivative works. These actions are prohibited by law if you do not accept
this License. Therefore, by modifying or distributing the Program (or any work
based on the Program), you indicate your acceptance of this License to do so,
and all its terms and conditions for copying, distributing or modifying the
Program or works based on it.
6. Each time you redistribute the Program (or any work based on the Program),
the recipient automatically receives a license from the original licensor to copy,
distribute or modify the Program subject to these terms and conditions. You
may not impose any further restrictions on the recipients' exercise of the rights
granted herein. You are not responsible for enforcing compliance by third parties
to this License.
7. If, as a consequence of a court judgment or allegation of patent infringement
or for any other reason (not limited to patent issues), conditions are imposed on
you (whether by court order, agreement or otherwise) that contradict the
conditions of this License, they do not excuse you from the conditions of this
License. If you cannot distribute so as to satisfy simultaneously your obligations
under this License and any other pertinent obligations, then as a consequence
you may not distribute the Program at all. For example, if a patent license would
not permit royalty-free redistribution of the Program by all those who receive
copies directly or indirectly through you, then the only way you could satisfy
both it and this License would be to refrain entirely from distribution of the
Program.
If any portion of this section is held invalid or unenforceable under any particular
circumstance, the balance of the section is intended to apply and the section as
a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other
property right claims or to contest validity of any such claims; this section has
the sole purpose of protecting the integrity of the free software distribution
system, which is implemented by public license practices. Many people have
made generous contributions to the wide range of software distributed through
that system in reliance on consistent application of that system; it is up to the
author/donor to decide if he or she is willing to distribute software through any
other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a
consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in certain countries
either by patents or by copyrighted interfaces, the original copyright holder who
places the Program under this License may add an explicit geographical
distribution limitation excluding those countries, so that distribution is permitted
only in or among countries not thus excluded. In such case, this License
incorporates the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions of the
General Public License from time to time. Such new versions will be similar in
spirit to the present version, but may differ in detail to address new problems or
concerns.
Each version is given a distinguishing version number. If the Program specifies a
version number of this License which applies to it and "any later version", you
have the option of following the terms and conditions either of that version or of
any later version published by the Free Software Foundation. If the Program does
not specify a version number of this License, you may choose any version ever
published by the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free programs
whose distribution conditions are different, write to the author to ask for
permission. For software which is copyrighted by the Free Software Foundation,
write to the Free Software Foundation; we sometimes make exceptions for this.
Our decision will be guided by the two goals of preserving the free status of all
derivatives of our free software and of promoting the sharing and reuse of
software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS
NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM
"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED
TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY
WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS
PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM
(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY
OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS
BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
---------------------------------------------------------------------------
The Artistic License
Preamble
The intent of this document is to state the conditions under which a Package
may be copied, such that the Copyright Holder maintains some semblance of
artistic control over the development of the package, while giving the users of the
package the right to use and distribute the Package in a more-or-less customary
fashion, plus the right to make reasonable modifications.
Definitions:
- "Package" refers to the collection of files distributed by the Copyright
Holder, and derivatives of that collection of files created through textual
modification.
- "Standard Version" refers to such a Package if it has not been modified,
or has been modified in accordance with the wishes of the Copyright
Holder.
- "Copyright Holder" is whoever is named in the copyright or copyrights for
the package.
- "You" is you, if you're thinking about copying or distributing this Package.
- "Reasonable copying fee" is whatever you can justify on the basis of
media cost, duplication charges, time of people involved, and so on. (You
will not be required to justify it to the Copyright Holder, but only to the
computing community at large as a market that must bear the fee.)
- "Freely Available" means that no fee is charged for the item itself, though
there may be fees involved in handling the item. It also means that
recipients of the item may redistribute it under the same conditions they
received it.
1. You may make and give away verbatim copies of the source form of the
Standard Version of this Package without restriction, provided that you duplicate
all of the original copyright notices and associated disclaimers.
2. You may apply bug fixes, portability fixes and other modifications derived from
the Public Domain or from the Copyright Holder. A Package modified in such a
way shall still be considered the Standard Version.
3. You may otherwise modify your copy of this Package in any way, provided
that you insert a prominent notice in each changed file stating how and when
you changed that file, and provided that you do at least ONE of the following:
a) place your modifications in the Public Domain or otherwise
make them Freely Available, such as by posting said modifications
to Usenet or an equivalent medium, or placing the modifications on
a major archive site such as ftp.uu.net, or by allowing the
Copyright Holder to include your modifications in the Standard
Version of the Package.
b) use the modified Package only within your corporation or
organization.
c) rename any non-standard executables so the names do not
conflict with standard executables, which must also be provided,
and provide a separate manual page for each non-standard
executable that clearly documents how it differs from the Standard
Version.
d) make other distribution arrangements with the Copyright Holder.
4. You may distribute the programs of this Package in object code or executable
form, provided that you do at least ONE of the following:
a) distribute a Standard Version of the executables and library
files, together with instructions (in the manual page or equivalent)
on where to get the Standard Version.
b) accompany the distribution with the machine-readable source of
the Package with your modifications.
c) accompany any non-standard executables with their
corresponding Standard Version executables, giving the
non-standard executables non-standard names, and clearly
documenting the differences in manual pages (or equivalent),
together with instructions on where to get the Standard Version.
d) make other distribution arrangements with the Copyright Holder.
5. You may charge a reasonable copying fee for any distribution of this Package.
You may charge any fee you choose for support of this Package. You may not
charge a fee for this Package itself. However, you may distribute this Package in
aggregate with other (possibly commercial) programs as part of a larger
(possibly commercial) software distribution provided that you do not advertise
this Package as a product of your own.
6. The scripts and library files supplied as input to or produced as output from
the programs of this Package do not automatically fall under the copyright of this
Package, but belong to whomever generated them, and may be sold
commercially, and may be aggregated with this Package.
7. C or perl subroutines supplied by you and linked into this Package shall not
be considered part of this Package.
8. Aggregation of this Package with a commercial distribution is always permitted
provided that the use of this Package is embedded; that is, when no overt attempt
is made to make this Package's interfaces visible to the end user of the
commercial distribution. Such use shall not be construed as a distribution of
this Package.
9. The name of the Copyright Holder may not be used to endorse or promote
products derived from this software without specific prior written permission.
10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
PURPOSE.
The End
Changes
inc/Module/Install.pm
inc/Module/Install/AuthorRequires.pm
inc/Module/Install/Base.pm
inc/Module/Install/Can.pm
inc/Module/Install/Fetch.pm
inc/Module/Install/Makefile.pm
inc/Module/Install/Metadata.pm
inc/Module/Install/ReadmeFromPod.pm
inc/Module/Install/Win32.pm
inc/Module/Install/WriteAll.pm
lib/Catalyst/Helper/Model/DataLocalize.pm
lib/Catalyst/Helper/Model/Maketext.pm
lib/CatalystX/I18N.pm
lib/CatalystX/I18N/DataLocalize.pm
lib/CatalystX/I18N/Maketext.pm
lib/CatalystX/I18N/Model/Base.pm
lib/CatalystX/I18N/Model/DataLocalize.pm
lib/CatalystX/I18N/Model/L10N.pm
lib/CatalystX/I18N/Model/Maketext.pm
lib/CatalystX/I18N/Role/All.pm
lib/CatalystX/I18N/Role/Base.pm
lib/CatalystX/I18N/Role/Collate.pm
lib/CatalystX/I18N/Role/DataLocalize.pm
lib/CatalystX/I18N/Role/DateTime.pm
lib/CatalystX/I18N/Role/GetLocale.pm
lib/CatalystX/I18N/Role/Maketext.pm
lib/CatalystX/I18N/Role/NumberFormat.pm
lib/CatalystX/I18N/Role/PosixLocale.pm
lib/CatalystX/I18N/TraitFor/Request.pm
lib/CatalystX/I18N/TraitFor/Response.pm
lib/CatalystX/I18N/TraitFor/ViewTT.pm
lib/CatalystX/I18N/TypeConstraints.pm
LICENSE
Makefile.PL
MANIFEST This list of files
META.yml
README
t/01_load.t
t/02_base.t
t/03_get_locale.t
t/04_view_tt.t
t/testapp/lib/TestApp.pm
t/testapp/lib/TestApp/Controller/Base.pm
t/testapp/lib/TestApp/DataLocalize.pm
t/testapp/lib/TestApp/DataLocalize/de.po
t/testapp/lib/TestApp/DataLocalize/de_AT.po
t/testapp/lib/TestApp/DataLocalize/de_DE.po
t/testapp/lib/TestApp/DataLocalize/fr_CH.po
t/testapp/lib/TestApp/Maketext.pm
t/testapp/lib/TestApp/Maketext/de.po
t/testapp/lib/TestApp/Maketext/de_AT.po
t/testapp/lib/TestApp/Maketext/de_DE.po
t/testapp/lib/TestApp/Maketext/fr_ch.pm
t/testapp/lib/TestApp/Model/DataLocalize.pm
t/testapp/lib/TestApp/Model/Maketext.pm
t/testapp/lib/TestApp/View/Test.pm
t/testapp/lib/TestApp/View/TT.pm
t/testapp/Makefile.PL
t/testapp/root/template/base/test7
t/testapp/script/testapp_server.pl
t/testlib.pm
xt/perlcritic.t
xt/pod.t
xt/podcoverage.t
xt/podstyle.t
---
abstract: 'Catalyst internationalisation (I18N) framework'
author:
- 'Maroš Kollár'
build_requires:
Catalyst::Plugin::Session: 0
Catalyst::Plugin::Session::State::Cookie: 0
Catalyst::Plugin::Session::Store::File: 0
Catalyst::View::TT: 0
ExtUtils::MakeMaker: 6.59
JSON: '2.17'
Template: 0
Test::Most: 0
Test::NoWarnings: 0
Test::WWW::Mechanize::Catalyst: 0
configure_requires:
ExtUtils::MakeMaker: 6.59
distribution_type: module
dynamic_config: 1
generated_by: 'Module::Install version 1.19'
license: perl
meta-spec:
url: http://module-build.sourceforge.net/META-spec-v1.4.html
version: 1.4
name: CatalystX-I18N
no_index:
directory:
- inc
- t
- xt
requires:
Catalyst::Runtime: '5.80004'
Clone: 0
Data::Localize: 0
Data::Localize::Format::Gettext: 0
DateTime: 0
DateTime::Format::CLDR: 0
DateTime::Locale: '0.40'
DateTime::TimeZone: 0
HTTP::BrowserDetect: '1.09'
IP::Country: 0
Locale::Geocode: 0
Locale::Maketext: 0
Locale::Maketext::Lexicon: 0
Moose: 0
MooseX::Types::DateTime: 0
MooseX::Types::Path::Class: 0
Number::Format: 0
POSIX: 0
Path::Class: 0
Unicode::Collate: 0
namespace::autoclean: 0
parent: 0
perl: 5.8.0
resources:
license: http://dev.perl.org/licenses/
repository: git://github.com/maros/CatalystX-I18N.git
version: '1.13'
Makefile.PL view on Meta::CPAN
# Load the Module::Install bundled in ./inc/
use strict;
use lib '.';
use inc::Module::Install 1.05;
my $from = 'lib/CatalystX/I18N.pm';
# Define metadata
name 'CatalystX-I18N';
all_from $from;
readme_from $from;
perl_version '5.008';
# Specific dependencies
requires 'Catalyst::Runtime' => '5.80004';
requires 'Moose' => 0;
requires 'parent' => 0;
requires 'POSIX' => 0;
requires 'namespace::autoclean' => 0;
requires 'Path::Class' => 0;
requires 'MooseX::Types::Path::Class' => 0;
requires 'Clone' => 0;
requires 'Locale::Maketext::Lexicon' => 0;
requires 'Locale::Maketext' => 0;
requires 'Locale::Geocode' => 0;
requires 'DateTime' => 0;
requires 'DateTime::Locale' => '0.40';
requires 'DateTime::Format::CLDR' => 0;
requires 'DateTime::TimeZone' => 0;
requires 'MooseX::Types::DateTime' => 0;
requires 'IP::Country' => 0;
requires 'HTTP::BrowserDetect' => '1.09';
requires 'Number::Format' => 0;
requires 'Unicode::Collate' => 0;
requires 'Data::Localize' => 0;
requires 'Data::Localize::Format::Gettext' => 0;
build_requires 'Test::Most' => 0;
build_requires 'Test::NoWarnings' => 0;
build_requires 'Test::WWW::Mechanize::Catalyst' => 0;
build_requires 'JSON' => '2.17';
build_requires 'Catalyst::Plugin::Session' => 0;
build_requires 'Catalyst::Plugin::Session::State::Cookie'=> 0;
build_requires 'Catalyst::Plugin::Session::Store::File'=> 0;
build_requires 'Catalyst::View::TT' => 0;
build_requires 'Template' => 0;
author_requires 'Test::Pod' => '1.14';
author_requires 'Test::Pod::Coverage' => '1.04';
author_requires 'Test::Perl::Critic' => 0;
author_requires 'Module::Install::ReadmeFromPod' => 0;
author_requires 'Module::Install::AuthorRequires' => 0;
repository 'git://github.com/maros/CatalystX-I18N.git';
WriteAll;
NAME
CatalystX::I18N - Catalyst internationalisation (I18N) framework
SYNOPSIS
package MyApp::Catalyst;
use strict;
use warnings;
use Catalyst qw/
+CatalystX::I18N::Role::Base
+CatalystX::I18N::Role::GetLocale
+CatalystX::I18N::Role::DateTime
+CatalystX::I18N::Role::Maketext
/;
# Choose only the roles you need
# CatalystX::I18N::Role::All is a convinient shortcut to load all available roles
# Optionally also load request and response roles (also loaded by CatalystX::I18N::Role::All)
use CatalystX::RoleApplicator;
__PACKAGE__->apply_request_class_roles(qw/CatalystX::I18N::TraitFor::Request/);
__PACKAGE__->apply_response_class_roles(qw/CatalystX::I18N::TraitFor::Response/);
# Add some I18N configuration
__PACKAGE__->config(
name => 'MyApp',
I18N => {
default_locale => 'de_AT',
locales => {
'de' => {
format_date => 'dd.MM.yyyy',
format_datetime => 'dd.MM.yyyy HH:mm',
},
'de_AT' => {
inherits => 'de',
timezone => 'Europe/Vienna',
format_datetime => 'dd.MM.yyyy uma HH\'e\'',
},
'de_DE' => {
inherits => 'de',
timezone => 'Europe/Berlin',
},
}
},
);
Then in your controller classes
package MyApp::Catalyst::Controller::Main;
use strict;
use warnings;
use parent qw/Catalyst::Controller/;
sub auto : Private {
my ($self,$c) = @_;
$c->get_locale();
# Tries to fetch the locale from the folloing sources in the given order
# 1. Session
# 2. User settings
# 3. Browser settings
# 4. Client address
# 5. Default locale from config
}
sub action : Local {
my ($self,$c) = @_;
$c->stash->{title} = $c->maketext('Hello world!');
$c->stash->{location} = $c->i18n_geocode->name;
$c->stash->{language} = $c->language;
$c->stash->{localtime} = $c->i18n_datetime_format_date->format_datetime(DateTime->now);
}
If you want to load all available roles and traits you can use
CatalystX::I18N::Role::All as a shortcut.
package MyApp::Catalyst;
use strict;
use warnings;
use Catalyst qw/
+CatalystX::I18N::Role::All
/;
DESCRIPTION
CatalystX::I18N provides a comprehensive toolset for
internationalisation (I18N) and localisation (L10N) of catalyst
applications. This distribution consists of several modules that are
designed to integrate seamlessly, but can be run idependently or
replaced easily if necessary.
* CatalystX::I18N::Role::Base
Basic I18N role that glues everything toghether.
* CatalystX::I18N::Role::Maketext
Localize text via Locale::Maketext. Prefered over
CatalystX::I18N::Role::DataLocalize
* CatalystX::I18N::Role::DataLocalize
Localize text via Data::Localize. Alternative to
CatalystX::I18N::Role::Maketext
* CatalystX::I18N::Role::PosixLocale
Sets the POSIX locale
* CatalystX::I18N::Role::DateTime
Methods for localising date and time information.
* CatalystX::I18N::Role::NumberFormat
Methods for localising numbers.
* CatalystX::I18N::TraitFor::Request
Extends Catalyst::Request with useful methods to help dealing with
various I18N related information in HTTP requests.
* CatalystX::I18N::TraitFor::Response
Adds a "Content-Language" header to the response.
* CatalystX::I18N::Role::GetLocale
Tries to determine the most appropriate locale for the current
request.
* CatalystX::I18N::Model::Maketext
Provides access to Locale::Maketext classes via a Catalyst model.
* CatalystX::I18N::Model::DataLocalize
Provides access to a Data::Localize class via a Catalyst model.
* CatalystX::I18N::Maketext
Helpful wrapper around Locale::Maketext. Can also be used outside of
Catalyst.
* CatalystX::I18N::DataLocalize
Helpful wrapper around Data::Localize. Can also be used outside of
Catalyst.
CONFIGURATION
In order to work properly, CatalystX::I18N will need some values in your
Catalyst configuration
__PACKAGE__->config(
name => 'MyApp',
I18N => {
default_locale => 'de_AT', # Fallback locale
locales => {
'de' => {
inactive => 1,
# Mark this locale as inactive (sort of abstract locale)
...
# Arbitrary configuration parameters
},
'de_AT' => {
inherits => 'de',
# Inherit all settings form the 'de' locale
...
},
}
},
);
The configuration must be stored under the key "I18N". It should contain
a hashref of "locales" and optionally a default locale
("default_locale").
Locales can be marked as "inactive". Inactive locales will not be
selected by the "get_locale" in CatalystX::I18N::Role::GetLocale method.
Locales can inherit from other locales ("inherits"). All configuration
values from inherited locales will be copied. If you use
CatalystX::I18N::Model::Maketext together with CatalystX::I18N::Maketext
the generated lexicons will also inherit in the selected order.
Additional configuration values are defined by the various
CatalystX::I18N::Role::* plugins.
EXTENDING
Extending the functionality of CatalystX::I18N distribution is easy.
E.g. writing a new plugin that does some processing when the locale is
set
package CatalystX::MyI18N::Role::MyPlugin;
use Moose::Role;
use namespace::autoclean;
after 'set_locale' => sub {
my ($c,$locale) = @_;
$c->do_someting($c->locale);
};
1;
SEE ALSO
Locale::Maketext, <Locale::Maketext::Lexicon>, Data::Localize,
Number::Format, DateTime::Locale, DateTime::Format::CLDR,
DateTime::TimeZone, HTTP::BrowserDetect and Locale::Geocode
SUPPORT
Please report any bugs or feature requests to
"catalystx-i18n@rt.cpan.org", or through the web interface at
<http://rt.cpan.org/Public/Bug/Report.html?Queue=CatalystX::I18N>. I
will be notified and then you'll automatically be notified of the
progress on your report as I make changes.
AUTHOR
Maroš Kollár
CPAN ID: MAROS
maros [at] k-1.com
http://www.k-1.com
COPYRIGHT
CatalystX::I18N is Copyright (c) 2012 Maroš Kollár -
<http://www.k-1.com>
LICENCE
This library is free software, you can redistribute it and/or modify it
under the same terms as Perl itself.
inc/Module/Install.pm view on Meta::CPAN
#line 1
package Module::Install;
# For any maintainers:
# The load order for Module::Install is a bit magic.
# It goes something like this...
#
# IF ( host has Module::Install installed, creating author mode ) {
# 1. Makefile.PL calls "use inc::Module::Install"
# 2. $INC{inc/Module/Install.pm} set to installed version of inc::Module::Install
# 3. The installed version of inc::Module::Install loads
# 4. inc::Module::Install calls "require Module::Install"
# 5. The ./inc/ version of Module::Install loads
# } ELSE {
# 1. Makefile.PL calls "use inc::Module::Install"
# 2. $INC{inc/Module/Install.pm} set to ./inc/ version of Module::Install
# 3. The ./inc/ version of Module::Install loads
# }
use 5.006;
use strict 'vars';
use Cwd ();
use File::Find ();
use File::Path ();
use vars qw{$VERSION $MAIN};
BEGIN {
# All Module::Install core packages now require synchronised versions.
# This will be used to ensure we don't accidentally load old or
# different versions of modules.
# This is not enforced yet, but will be some time in the next few
# releases once we can make sure it won't clash with custom
# Module::Install extensions.
$VERSION = '1.19';
# Storage for the pseudo-singleton
$MAIN = undef;
*inc::Module::Install::VERSION = *VERSION;
@inc::Module::Install::ISA = __PACKAGE__;
}
sub import {
my $class = shift;
my $self = $class->new(@_);
my $who = $self->_caller;
#-------------------------------------------------------------
# all of the following checks should be included in import(),
# to allow "eval 'require Module::Install; 1' to test
# installation of Module::Install. (RT #51267)
#-------------------------------------------------------------
# Whether or not inc::Module::Install is actually loaded, the
# $INC{inc/Module/Install.pm} is what will still get set as long as
# the caller loaded module this in the documented manner.
# If not set, the caller may NOT have loaded the bundled version, and thus
# they may not have a MI version that works with the Makefile.PL. This would
# result in false errors or unexpected behaviour. And we don't want that.
my $file = join( '/', 'inc', split /::/, __PACKAGE__ ) . '.pm';
unless ( $INC{$file} ) { die <<"END_DIE" }
Please invoke ${\__PACKAGE__} with:
use inc::${\__PACKAGE__};
not:
use ${\__PACKAGE__};
END_DIE
# This reportedly fixes a rare Win32 UTC file time issue, but
# as this is a non-cross-platform XS module not in the core,
# we shouldn't really depend on it. See RT #24194 for detail.
# (Also, this module only supports Perl 5.6 and above).
eval "use Win32::UTCFileTime" if $^O eq 'MSWin32' && $] >= 5.006;
# If the script that is loading Module::Install is from the future,
# then make will detect this and cause it to re-run over and over
# again. This is bad. Rather than taking action to touch it (which
# is unreliable on some platforms and requires write permissions)
# for now we should catch this and refuse to run.
if ( -f $0 ) {
my $s = (stat($0))[9];
# If the modification time is only slightly in the future,
# sleep briefly to remove the problem.
my $a = $s - time;
if ( $a > 0 and $a < 5 ) { sleep 5 }
# Too far in the future, throw an error.
my $t = time;
if ( $s > $t ) { die <<"END_DIE" }
Your installer $0 has a modification time in the future ($s > $t).
This is known to create infinite loops in make.
Please correct this, then run $0 again.
END_DIE
}
# Build.PL was formerly supported, but no longer is due to excessive
# difficulty in implementing every single feature twice.
if ( $0 =~ /Build.PL$/i ) { die <<"END_DIE" }
Module::Install no longer supports Build.PL.
It was impossible to maintain duel backends, and has been deprecated.
Please remove all Build.PL files and only use the Makefile.PL installer.
END_DIE
#-------------------------------------------------------------
# To save some more typing in Module::Install installers, every...
# use inc::Module::Install
# ...also acts as an implicit use strict.
$^H |= strict::bits(qw(refs subs vars));
#-------------------------------------------------------------
unless ( -f $self->{file} ) {
foreach my $key (keys %INC) {
delete $INC{$key} if $key =~ /Module\/Install/;
}
local $^W;
require "$self->{path}/$self->{dispatch}.pm";
File::Path::mkpath("$self->{prefix}/$self->{author}");
$self->{admin} = "$self->{name}::$self->{dispatch}"->new( _top => $self );
$self->{admin}->init;
@_ = ($class, _self => $self);
goto &{"$self->{name}::import"};
}
local $^W;
*{"${who}::AUTOLOAD"} = $self->autoload;
$self->preload;
# Unregister loader and worker packages so subdirs can use them again
delete $INC{'inc/Module/Install.pm'};
delete $INC{'Module/Install.pm'};
# Save to the singleton
$MAIN = $self;
return 1;
}
sub autoload {
my $self = shift;
my $who = $self->_caller;
my $cwd = Cwd::getcwd();
my $sym = "${who}::AUTOLOAD";
$sym->{$cwd} = sub {
my $pwd = Cwd::getcwd();
if ( my $code = $sym->{$pwd} ) {
# Delegate back to parent dirs
goto &$code unless $cwd eq $pwd;
}
unless ($$sym =~ s/([^:]+)$//) {
# XXX: it looks like we can't retrieve the missing function
# via $$sym (usually $main::AUTOLOAD) in this case.
# I'm still wondering if we should slurp Makefile.PL to
# get some context or not ...
my ($package, $file, $line) = caller;
die <<"EOT";
Unknown function is found at $file line $line.
Execution of $file aborted due to runtime errors.
If you're a contributor to a project, you may need to install
some Module::Install extensions from CPAN (or other repository).
If you're a user of a module, please contact the author.
EOT
}
my $method = $1;
if ( uc($method) eq $method ) {
# Do nothing
return;
} elsif ( $method =~ /^_/ and $self->can($method) ) {
# Dispatch to the root M:I class
return $self->$method(@_);
}
# Dispatch to the appropriate plugin
unshift @_, ( $self, $1 );
goto &{$self->can('call')};
};
}
sub preload {
my $self = shift;
unless ( $self->{extensions} ) {
$self->load_extensions(
"$self->{prefix}/$self->{path}", $self
);
}
my @exts = @{$self->{extensions}};
unless ( @exts ) {
@exts = $self->{admin}->load_all_extensions;
}
my %seen;
foreach my $obj ( @exts ) {
while (my ($method, $glob) = each %{ref($obj) . '::'}) {
next unless $obj->can($method);
next if $method =~ /^_/;
next if $method eq uc($method);
$seen{$method}++;
}
}
my $who = $self->_caller;
foreach my $name ( sort keys %seen ) {
local $^W;
*{"${who}::$name"} = sub {
${"${who}::AUTOLOAD"} = "${who}::$name";
goto &{"${who}::AUTOLOAD"};
};
}
}
sub new {
my ($class, %args) = @_;
delete $INC{'FindBin.pm'};
{
# to suppress the redefine warning
local $SIG{__WARN__} = sub {};
require FindBin;
}
# ignore the prefix on extension modules built from top level.
my $base_path = Cwd::abs_path($FindBin::Bin);
unless ( Cwd::abs_path(Cwd::getcwd()) eq $base_path ) {
delete $args{prefix};
}
return $args{_self} if $args{_self};
$base_path = VMS::Filespec::unixify($base_path) if $^O eq 'VMS';
$args{dispatch} ||= 'Admin';
$args{prefix} ||= 'inc';
$args{author} ||= ($^O eq 'VMS' ? '_author' : '.author');
$args{bundle} ||= 'inc/BUNDLES';
$args{base} ||= $base_path;
$class =~ s/^\Q$args{prefix}\E:://;
$args{name} ||= $class;
$args{version} ||= $class->VERSION;
unless ( $args{path} ) {
$args{path} = $args{name};
$args{path} =~ s!::!/!g;
}
$args{file} ||= "$args{base}/$args{prefix}/$args{path}.pm";
$args{wrote} = 0;
bless( \%args, $class );
}
sub call {
my ($self, $method) = @_;
my $obj = $self->load($method) or return;
splice(@_, 0, 2, $obj);
goto &{$obj->can($method)};
}
sub load {
my ($self, $method) = @_;
$self->load_extensions(
"$self->{prefix}/$self->{path}", $self
) unless $self->{extensions};
foreach my $obj (@{$self->{extensions}}) {
return $obj if $obj->can($method);
}
my $admin = $self->{admin} or die <<"END_DIE";
The '$method' method does not exist in the '$self->{prefix}' path!
Please remove the '$self->{prefix}' directory and run $0 again to load it.
END_DIE
my $obj = $admin->load($method, 1);
push @{$self->{extensions}}, $obj;
$obj;
}
sub load_extensions {
my ($self, $path, $top) = @_;
my $should_reload = 0;
unless ( grep { ! ref $_ and lc $_ eq lc $self->{prefix} } @INC ) {
unshift @INC, $self->{prefix};
$should_reload = 1;
}
foreach my $rv ( $self->find_extensions($path) ) {
my ($file, $pkg) = @{$rv};
next if $self->{pathnames}{$pkg};
local $@;
my $new = eval { local $^W; require $file; $pkg->can('new') };
unless ( $new ) {
warn $@ if $@;
next;
}
$self->{pathnames}{$pkg} =
$should_reload ? delete $INC{$file} : $INC{$file};
push @{$self->{extensions}}, &{$new}($pkg, _top => $top );
}
$self->{extensions} ||= [];
}
sub find_extensions {
my ($self, $path) = @_;
my @found;
File::Find::find( {no_chdir => 1, wanted => sub {
my $file = $File::Find::name;
return unless $file =~ m!^\Q$path\E/(.+)\.pm\Z!is;
my $subpath = $1;
return if lc($subpath) eq lc($self->{dispatch});
$file = "$self->{path}/$subpath.pm";
my $pkg = "$self->{name}::$subpath";
$pkg =~ s!/!::!g;
# If we have a mixed-case package name, assume case has been preserved
# correctly. Otherwise, root through the file to locate the case-preserved
# version of the package name.
if ( $subpath eq lc($subpath) || $subpath eq uc($subpath) ) {
my $content = Module::Install::_read($File::Find::name);
my $in_pod = 0;
foreach ( split /\n/, $content ) {
$in_pod = 1 if /^=\w/;
$in_pod = 0 if /^=cut/;
next if ($in_pod || /^=cut/); # skip pod text
next if /^\s*#/; # and comments
if ( m/^\s*package\s+($pkg)\s*;/i ) {
$pkg = $1;
last;
}
}
}
push @found, [ $file, $pkg ];
}}, $path ) if -d $path;
@found;
}
#####################################################################
# Common Utility Functions
sub _caller {
my $depth = 0;
my $call = caller($depth);
while ( $call eq __PACKAGE__ ) {
$depth++;
$call = caller($depth);
}
return $call;
}
sub _read {
local *FH;
open( FH, '<', $_[0] ) or die "open($_[0]): $!";
binmode FH;
my $string = do { local $/; <FH> };
close FH or die "close($_[0]): $!";
return $string;
}
sub _readperl {
my $string = Module::Install::_read($_[0]);
$string =~ s/(?:\015{1,2}\012|\015|\012)/\n/sg;
$string =~ s/(\n)\n*__(?:DATA|END)__\b.*\z/$1/s;
$string =~ s/\n\n=\w+.+?\n\n=cut\b.+?\n+/\n\n/sg;
return $string;
}
sub _readpod {
my $string = Module::Install::_read($_[0]);
$string =~ s/(?:\015{1,2}\012|\015|\012)/\n/sg;
return $string if $_[0] =~ /\.pod\z/;
$string =~ s/(^|\n=cut\b.+?\n+)[^=\s].+?\n(\n=\w+|\z)/$1$2/sg;
$string =~ s/\n*=pod\b[^\n]*\n+/\n\n/sg;
$string =~ s/\n*=cut\b[^\n]*\n+/\n\n/sg;
$string =~ s/^\n+//s;
return $string;
}
sub _write {
local *FH;
open( FH, '>', $_[0] ) or die "open($_[0]): $!";
binmode FH;
foreach ( 1 .. $#_ ) {
print FH $_[$_] or die "print($_[0]): $!";
}
close FH or die "close($_[0]): $!";
}
# _version is for processing module versions (eg, 1.03_05) not
# Perl versions (eg, 5.8.1).
sub _version {
my $s = shift || 0;
my $d =()= $s =~ /(\.)/g;
if ( $d >= 2 ) {
# Normalise multipart versions
$s =~ s/(\.)(\d{1,3})/sprintf("$1%03d",$2)/eg;
}
$s =~ s/^(\d+)\.?//;
my $l = $1 || 0;
my @v = map {
$_ . '0' x (3 - length $_)
} $s =~ /(\d{1,3})\D?/g;
$l = $l . '.' . join '', @v if @v;
return $l + 0;
}
sub _cmp {
_version($_[1]) <=> _version($_[2]);
}
# Cloned from Params::Util::_CLASS
sub _CLASS {
(
defined $_[0]
and
! ref $_[0]
and
$_[0] =~ m/^[^\W\d]\w*(?:::\w+)*\z/s
) ? $_[0] : undef;
}
1;
# Copyright 2008 - 2012 Adam Kennedy.
inc/Module/Install/AuthorRequires.pm view on Meta::CPAN
#line 1
use strict;
use warnings;
package Module::Install::AuthorRequires;
use base 'Module::Install::Base';
# cargo cult
BEGIN {
our $VERSION = '0.02';
our $ISCORE = 1;
}
sub author_requires {
my $self = shift;
return $self->{values}->{author_requires}
unless @_;
my @added;
while (@_) {
my $mod = shift or last;
my $version = shift || 0;
push @added, [$mod => $version];
}
push @{ $self->{values}->{author_requires} }, @added;
$self->admin->author_requires(@added);
return map { @$_ } @added;
}
1;
__END__
#line 92
inc/Module/Install/Base.pm view on Meta::CPAN
#line 1
package Module::Install::Base;
use strict 'vars';
use vars qw{$VERSION};
BEGIN {
$VERSION = '1.19';
}
# Suspend handler for "redefined" warnings
BEGIN {
my $w = $SIG{__WARN__};
$SIG{__WARN__} = sub { $w };
}
#line 42
sub new {
my $class = shift;
unless ( defined &{"${class}::call"} ) {
*{"${class}::call"} = sub { shift->_top->call(@_) };
}
unless ( defined &{"${class}::load"} ) {
*{"${class}::load"} = sub { shift->_top->load(@_) };
}
bless { @_ }, $class;
}
#line 61
sub AUTOLOAD {
local $@;
my $func = eval { shift->_top->autoload } or return;
goto &$func;
}
#line 75
sub _top {
$_[0]->{_top};
}
#line 90
sub admin {
$_[0]->_top->{admin}
or
Module::Install::Base::FakeAdmin->new;
}
#line 106
sub is_admin {
! $_[0]->admin->isa('Module::Install::Base::FakeAdmin');
}
sub DESTROY {}
package Module::Install::Base::FakeAdmin;
use vars qw{$VERSION};
BEGIN {
$VERSION = $Module::Install::Base::VERSION;
}
my $fake;
sub new {
$fake ||= bless(\@_, $_[0]);
}
sub AUTOLOAD {}
sub DESTROY {}
# Restore warning handler
BEGIN {
$SIG{__WARN__} = $SIG{__WARN__}->();
}
1;
#line 159
inc/Module/Install/Can.pm view on Meta::CPAN
#line 1
package Module::Install::Can;
use strict;
use Config ();
use ExtUtils::MakeMaker ();
use Module::Install::Base ();
use vars qw{$VERSION @ISA $ISCORE};
BEGIN {
$VERSION = '1.19';
@ISA = 'Module::Install::Base';
$ISCORE = 1;
}
# check if we can load some module
### Upgrade this to not have to load the module if possible
sub can_use {
my ($self, $mod, $ver) = @_;
$mod =~ s{::|\\}{/}g;
$mod .= '.pm' unless $mod =~ /\.pm$/i;
my $pkg = $mod;
$pkg =~ s{/}{::}g;
$pkg =~ s{\.pm$}{}i;
local $@;
eval { require $mod; $pkg->VERSION($ver || 0); 1 };
}
# Check if we can run some command
sub can_run {
my ($self, $cmd) = @_;
my $_cmd = $cmd;
return $_cmd if (-x $_cmd or $_cmd = MM->maybe_command($_cmd));
for my $dir ((split /$Config::Config{path_sep}/, $ENV{PATH}), '.') {
next if $dir eq '';
require File::Spec;
my $abs = File::Spec->catfile($dir, $cmd);
return $abs if (-x $abs or $abs = MM->maybe_command($abs));
}
return;
}
# Can our C compiler environment build XS files
sub can_xs {
my $self = shift;
# Ensure we have the CBuilder module
$self->configure_requires( 'ExtUtils::CBuilder' => 0.27 );
# Do we have the configure_requires checker?
local $@;
eval "require ExtUtils::CBuilder;";
if ( $@ ) {
# They don't obey configure_requires, so it is
# someone old and delicate. Try to avoid hurting
# them by falling back to an older simpler test.
return $self->can_cc();
}
# Do we have a working C compiler
my $builder = ExtUtils::CBuilder->new(
quiet => 1,
);
unless ( $builder->have_compiler ) {
# No working C compiler
return 0;
}
# Write a C file representative of what XS becomes
require File::Temp;
my ( $FH, $tmpfile ) = File::Temp::tempfile(
"compilexs-XXXXX",
SUFFIX => '.c',
);
binmode $FH;
print $FH <<'END_C';
#include "EXTERN.h"
#include "perl.h"
#include "XSUB.h"
int main(int argc, char **argv) {
return 0;
}
int boot_sanexs() {
return 1;
}
END_C
close $FH;
# Can the C compiler access the same headers XS does
my @libs = ();
my $object = undef;
eval {
local $^W = 0;
$object = $builder->compile(
source => $tmpfile,
);
@libs = $builder->link(
objects => $object,
module_name => 'sanexs',
);
};
my $result = $@ ? 0 : 1;
# Clean up all the build files
foreach ( $tmpfile, $object, @libs ) {
next unless defined $_;
1 while unlink;
}
return $result;
}
# Can we locate a (the) C compiler
sub can_cc {
my $self = shift;
if ($^O eq 'VMS') {
require ExtUtils::CBuilder;
my $builder = ExtUtils::CBuilder->new(
quiet => 1,
);
return $builder->have_compiler;
}
my @chunks = split(/ /, $Config::Config{cc}) or return;
# $Config{cc} may contain args; try to find out the program part
while (@chunks) {
return $self->can_run("@chunks") || (pop(@chunks), next);
}
return;
}
# Fix Cygwin bug on maybe_command();
if ( $^O eq 'cygwin' ) {
require ExtUtils::MM_Cygwin;
require ExtUtils::MM_Win32;
if ( ! defined(&ExtUtils::MM_Cygwin::maybe_command) ) {
*ExtUtils::MM_Cygwin::maybe_command = sub {
my ($self, $file) = @_;
if ($file =~ m{^/cygdrive/}i and ExtUtils::MM_Win32->can('maybe_command')) {
ExtUtils::MM_Win32->maybe_command($file);
} else {
ExtUtils::MM_Unix->maybe_command($file);
}
}
}
}
1;
__END__
#line 245
inc/Module/Install/Fetch.pm view on Meta::CPAN
#line 1
package Module::Install::Fetch;
use strict;
use Module::Install::Base ();
use vars qw{$VERSION @ISA $ISCORE};
BEGIN {
$VERSION = '1.19';
@ISA = 'Module::Install::Base';
$ISCORE = 1;
}
sub get_file {
my ($self, %args) = @_;
my ($scheme, $host, $path, $file) =
$args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return;
if ( $scheme eq 'http' and ! eval { require LWP::Simple; 1 } ) {
$args{url} = $args{ftp_url}
or (warn("LWP support unavailable!\n"), return);
($scheme, $host, $path, $file) =
$args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return;
}
$|++;
print "Fetching '$file' from $host... ";
unless (eval { require Socket; Socket::inet_aton($host) }) {
warn "'$host' resolve failed!\n";
return;
}
return unless $scheme eq 'ftp' or $scheme eq 'http';
require Cwd;
my $dir = Cwd::getcwd();
chdir $args{local_dir} or return if exists $args{local_dir};
if (eval { require LWP::Simple; 1 }) {
LWP::Simple::mirror($args{url}, $file);
}
elsif (eval { require Net::FTP; 1 }) { eval {
# use Net::FTP to get past firewall
my $ftp = Net::FTP->new($host, Passive => 1, Timeout => 600);
$ftp->login("anonymous", 'anonymous@example.com');
$ftp->cwd($path);
$ftp->binary;
$ftp->get($file) or (warn("$!\n"), return);
$ftp->quit;
} }
elsif (my $ftp = $self->can_run('ftp')) { eval {
# no Net::FTP, fallback to ftp.exe
require FileHandle;
my $fh = FileHandle->new;
local $SIG{CHLD} = 'IGNORE';
unless ($fh->open("|$ftp -n")) {
warn "Couldn't open ftp: $!\n";
chdir $dir; return;
}
my @dialog = split(/\n/, <<"END_FTP");
open $host
user anonymous anonymous\@example.com
cd $path
binary
get $file $file
quit
END_FTP
foreach (@dialog) { $fh->print("$_\n") }
$fh->close;
} }
else {
warn "No working 'ftp' program available!\n";
chdir $dir; return;
}
unless (-f $file) {
warn "Fetching failed: $@\n";
chdir $dir; return;
}
return if exists $args{size} and -s $file != $args{size};
system($args{run}) if exists $args{run};
unlink($file) if $args{remove};
print(((!exists $args{check_for} or -e $args{check_for})
? "done!" : "failed! ($!)"), "\n");
chdir $dir; return !$?;
}
1;
inc/Module/Install/Makefile.pm view on Meta::CPAN
#line 1
package Module::Install::Makefile;
use strict 'vars';
use ExtUtils::MakeMaker ();
use Module::Install::Base ();
use Fcntl qw/:flock :seek/;
use vars qw{$VERSION @ISA $ISCORE};
BEGIN {
$VERSION = '1.19';
@ISA = 'Module::Install::Base';
$ISCORE = 1;
}
sub Makefile { $_[0] }
my %seen = ();
sub prompt {
shift;
# Infinite loop protection
my @c = caller();
if ( ++$seen{"$c[1]|$c[2]|$_[0]"} > 3 ) {
die "Caught an potential prompt infinite loop ($c[1]|$c[2]|$_[0])";
}
# In automated testing or non-interactive session, always use defaults
if ( ($ENV{AUTOMATED_TESTING} or -! -t STDIN) and ! $ENV{PERL_MM_USE_DEFAULT} ) {
local $ENV{PERL_MM_USE_DEFAULT} = 1;
goto &ExtUtils::MakeMaker::prompt;
} else {
goto &ExtUtils::MakeMaker::prompt;
}
}
# Store a cleaned up version of the MakeMaker version,
# since we need to behave differently in a variety of
# ways based on the MM version.
my $makemaker = eval $ExtUtils::MakeMaker::VERSION;
# If we are passed a param, do a "newer than" comparison.
# Otherwise, just return the MakeMaker version.
sub makemaker {
( @_ < 2 or $makemaker >= eval($_[1]) ) ? $makemaker : 0
}
# Ripped from ExtUtils::MakeMaker 6.56, and slightly modified
# as we only need to know here whether the attribute is an array
# or a hash or something else (which may or may not be appendable).
my %makemaker_argtype = (
C => 'ARRAY',
CONFIG => 'ARRAY',
# CONFIGURE => 'CODE', # ignore
DIR => 'ARRAY',
DL_FUNCS => 'HASH',
DL_VARS => 'ARRAY',
EXCLUDE_EXT => 'ARRAY',
EXE_FILES => 'ARRAY',
FUNCLIST => 'ARRAY',
H => 'ARRAY',
IMPORTS => 'HASH',
INCLUDE_EXT => 'ARRAY',
LIBS => 'ARRAY', # ignore ''
MAN1PODS => 'HASH',
MAN3PODS => 'HASH',
META_ADD => 'HASH',
META_MERGE => 'HASH',
PL_FILES => 'HASH',
PM => 'HASH',
PMLIBDIRS => 'ARRAY',
PMLIBPARENTDIRS => 'ARRAY',
PREREQ_PM => 'HASH',
CONFIGURE_REQUIRES => 'HASH',
SKIP => 'ARRAY',
TYPEMAPS => 'ARRAY',
XS => 'HASH',
# VERSION => ['version',''], # ignore
# _KEEP_AFTER_FLUSH => '',
clean => 'HASH',
depend => 'HASH',
dist => 'HASH',
dynamic_lib=> 'HASH',
linkext => 'HASH',
macro => 'HASH',
postamble => 'HASH',
realclean => 'HASH',
test => 'HASH',
tool_autosplit => 'HASH',
# special cases where you can use makemaker_append
CCFLAGS => 'APPENDABLE',
DEFINE => 'APPENDABLE',
INC => 'APPENDABLE',
LDDLFLAGS => 'APPENDABLE',
LDFROM => 'APPENDABLE',
);
sub makemaker_args {
my ($self, %new_args) = @_;
my $args = ( $self->{makemaker_args} ||= {} );
foreach my $key (keys %new_args) {
if ($makemaker_argtype{$key}) {
if ($makemaker_argtype{$key} eq 'ARRAY') {
$args->{$key} = [] unless defined $args->{$key};
unless (ref $args->{$key} eq 'ARRAY') {
$args->{$key} = [$args->{$key}]
}
push @{$args->{$key}},
ref $new_args{$key} eq 'ARRAY'
? @{$new_args{$key}}
: $new_args{$key};
}
elsif ($makemaker_argtype{$key} eq 'HASH') {
$args->{$key} = {} unless defined $args->{$key};
foreach my $skey (keys %{ $new_args{$key} }) {
$args->{$key}{$skey} = $new_args{$key}{$skey};
}
}
elsif ($makemaker_argtype{$key} eq 'APPENDABLE') {
$self->makemaker_append($key => $new_args{$key});
}
}
else {
if (defined $args->{$key}) {
warn qq{MakeMaker attribute "$key" is overriden; use "makemaker_append" to append values\n};
}
$args->{$key} = $new_args{$key};
}
}
return $args;
}
# For mm args that take multiple space-separated args,
# append an argument to the current list.
sub makemaker_append {
my $self = shift;
my $name = shift;
my $args = $self->makemaker_args;
$args->{$name} = defined $args->{$name}
? join( ' ', $args->{$name}, @_ )
: join( ' ', @_ );
}
sub build_subdirs {
my $self = shift;
my $subdirs = $self->makemaker_args->{DIR} ||= [];
for my $subdir (@_) {
push @$subdirs, $subdir;
}
}
sub clean_files {
my $self = shift;
my $clean = $self->makemaker_args->{clean} ||= {};
%$clean = (
%$clean,
FILES => join ' ', grep { length $_ } ($clean->{FILES} || (), @_),
);
}
sub realclean_files {
my $self = shift;
my $realclean = $self->makemaker_args->{realclean} ||= {};
%$realclean = (
%$realclean,
FILES => join ' ', grep { length $_ } ($realclean->{FILES} || (), @_),
);
}
sub libs {
my $self = shift;
my $libs = ref $_[0] ? shift : [ shift ];
$self->makemaker_args( LIBS => $libs );
}
sub inc {
my $self = shift;
$self->makemaker_args( INC => shift );
}
sub _wanted_t {
}
sub tests_recursive {
my $self = shift;
my $dir = shift || 't';
unless ( -d $dir ) {
die "tests_recursive dir '$dir' does not exist";
}
my %tests = map { $_ => 1 } split / /, ($self->tests || '');
require File::Find;
File::Find::find(
sub { /\.t$/ and -f $_ and $tests{"$File::Find::dir/*.t"} = 1 },
$dir
);
$self->tests( join ' ', sort keys %tests );
}
sub write {
my $self = shift;
die "&Makefile->write() takes no arguments\n" if @_;
# Check the current Perl version
my $perl_version = $self->perl_version;
if ( $perl_version ) {
eval "use $perl_version; 1"
or die "ERROR: perl: Version $] is installed, "
. "but we need version >= $perl_version";
}
# Make sure we have a new enough MakeMaker
require ExtUtils::MakeMaker;
if ( $perl_version and $self->_cmp($perl_version, '5.006') >= 0 ) {
# This previous attempted to inherit the version of
# ExtUtils::MakeMaker in use by the module author, but this
# was found to be untenable as some authors build releases
# using future dev versions of EU:MM that nobody else has.
# Instead, #toolchain suggests we use 6.59 which is the most
# stable version on CPAN at time of writing and is, to quote
# ribasushi, "not terminally fucked, > and tested enough".
# TODO: We will now need to maintain this over time to push
# the version up as new versions are released.
$self->build_requires( 'ExtUtils::MakeMaker' => 6.59 );
$self->configure_requires( 'ExtUtils::MakeMaker' => 6.59 );
} else {
# Allow legacy-compatibility with 5.005 by depending on the
# most recent EU:MM that supported 5.005.
$self->build_requires( 'ExtUtils::MakeMaker' => 6.36 );
$self->configure_requires( 'ExtUtils::MakeMaker' => 6.36 );
}
# Generate the MakeMaker params
my $args = $self->makemaker_args;
$args->{DISTNAME} = $self->name;
$args->{NAME} = $self->module_name || $self->name;
$args->{NAME} =~ s/-/::/g;
$args->{VERSION} = $self->version or die <<'EOT';
ERROR: Can't determine distribution version. Please specify it
explicitly via 'version' in Makefile.PL, or set a valid $VERSION
in a module, and provide its file path via 'version_from' (or
'all_from' if you prefer) in Makefile.PL.
EOT
if ( $self->tests ) {
my @tests = split ' ', $self->tests;
my %seen;
$args->{test} = {
TESTS => (join ' ', grep {!$seen{$_}++} @tests),
};
} elsif ( $Module::Install::ExtraTests::use_extratests ) {
# Module::Install::ExtraTests doesn't set $self->tests and does its own tests via harness.
# So, just ignore our xt tests here.
} elsif ( -d 'xt' and ($Module::Install::AUTHOR or $ENV{RELEASE_TESTING}) ) {
$args->{test} = {
TESTS => join( ' ', map { "$_/*.t" } grep { -d $_ } qw{ t xt } ),
};
}
if ( $] >= 5.005 ) {
$args->{ABSTRACT} = $self->abstract;
$args->{AUTHOR} = join ', ', @{$self->author || []};
}
if ( $self->makemaker(6.10) ) {
$args->{NO_META} = 1;
#$args->{NO_MYMETA} = 1;
}
if ( $self->makemaker(6.17) and $self->sign ) {
$args->{SIGN} = 1;
}
unless ( $self->is_admin ) {
delete $args->{SIGN};
}
if ( $self->makemaker(6.31) and $self->license ) {
$args->{LICENSE} = $self->license;
}
my $prereq = ($args->{PREREQ_PM} ||= {});
%$prereq = ( %$prereq,
map { @$_ } # flatten [module => version]
map { @$_ }
grep $_,
($self->requires)
);
# Remove any reference to perl, PREREQ_PM doesn't support it
delete $args->{PREREQ_PM}->{perl};
# Merge both kinds of requires into BUILD_REQUIRES
my $build_prereq = ($args->{BUILD_REQUIRES} ||= {});
%$build_prereq = ( %$build_prereq,
map { @$_ } # flatten [module => version]
map { @$_ }
grep $_,
($self->configure_requires, $self->build_requires)
);
# Remove any reference to perl, BUILD_REQUIRES doesn't support it
delete $args->{BUILD_REQUIRES}->{perl};
# Delete bundled dists from prereq_pm, add it to Makefile DIR
my $subdirs = ($args->{DIR} || []);
if ($self->bundles) {
my %processed;
foreach my $bundle (@{ $self->bundles }) {
my ($mod_name, $dist_dir) = @$bundle;
delete $prereq->{$mod_name};
$dist_dir = File::Basename::basename($dist_dir); # dir for building this module
if (not exists $processed{$dist_dir}) {
if (-d $dist_dir) {
# List as sub-directory to be processed by make
push @$subdirs, $dist_dir;
}
# Else do nothing: the module is already present on the system
$processed{$dist_dir} = undef;
}
}
}
unless ( $self->makemaker('6.55_03') ) {
%$prereq = (%$prereq,%$build_prereq);
delete $args->{BUILD_REQUIRES};
}
if ( my $perl_version = $self->perl_version ) {
eval "use $perl_version; 1"
or die "ERROR: perl: Version $] is installed, "
. "but we need version >= $perl_version";
if ( $self->makemaker(6.48) ) {
$args->{MIN_PERL_VERSION} = $perl_version;
}
}
if ($self->installdirs) {
warn qq{old INSTALLDIRS (probably set by makemaker_args) is overriden by installdirs\n} if $args->{INSTALLDIRS};
$args->{INSTALLDIRS} = $self->installdirs;
}
my %args = map {
( $_ => $args->{$_} ) } grep {defined($args->{$_} )
} keys %$args;
my $user_preop = delete $args{dist}->{PREOP};
if ( my $preop = $self->admin->preop($user_preop) ) {
foreach my $key ( keys %$preop ) {
$args{dist}->{$key} = $preop->{$key};
}
}
my $mm = ExtUtils::MakeMaker::WriteMakefile(%args);
$self->fix_up_makefile($mm->{FIRST_MAKEFILE} || 'Makefile');
}
sub fix_up_makefile {
my $self = shift;
my $makefile_name = shift;
my $top_class = ref($self->_top) || '';
my $top_version = $self->_top->VERSION || '';
my $preamble = $self->preamble
? "# Preamble by $top_class $top_version\n"
. $self->preamble
: '';
my $postamble = "# Postamble by $top_class $top_version\n"
. ($self->postamble || '');
local *MAKEFILE;
open MAKEFILE, "+< $makefile_name" or die "fix_up_makefile: Couldn't open $makefile_name: $!";
eval { flock MAKEFILE, LOCK_EX };
my $makefile = do { local $/; <MAKEFILE> };
$makefile =~ s/\b(test_harness\(\$\(TEST_VERBOSE\), )/$1'inc', /;
$makefile =~ s/( -I\$\(INST_ARCHLIB\))/ -Iinc$1/g;
$makefile =~ s/( "-I\$\(INST_LIB\)")/ "-Iinc"$1/g;
$makefile =~ s/^(FULLPERL = .*)/$1 "-Iinc"/m;
$makefile =~ s/^(PERL = .*)/$1 "-Iinc"/m;
# Module::Install will never be used to build the Core Perl
# Sometimes PERL_LIB and PERL_ARCHLIB get written anyway, which breaks
# PREFIX/PERL5LIB, and thus, install_share. Blank them if they exist
$makefile =~ s/^PERL_LIB = .+/PERL_LIB =/m;
#$makefile =~ s/^PERL_ARCHLIB = .+/PERL_ARCHLIB =/m;
# Perl 5.005 mentions PERL_LIB explicitly, so we have to remove that as well.
$makefile =~ s/(\"?)-I\$\(PERL_LIB\)\1//g;
# XXX - This is currently unused; not sure if it breaks other MM-users
# $makefile =~ s/^pm_to_blib\s+:\s+/pm_to_blib :: /mg;
seek MAKEFILE, 0, SEEK_SET;
truncate MAKEFILE, 0;
print MAKEFILE "$preamble$makefile$postamble" or die $!;
close MAKEFILE or die $!;
1;
}
sub preamble {
my ($self, $text) = @_;
$self->{preamble} = $text . $self->{preamble} if defined $text;
$self->{preamble};
}
sub postamble {
my ($self, $text) = @_;
$self->{postamble} ||= $self->admin->postamble;
$self->{postamble} .= $text if defined $text;
$self->{postamble}
}
1;
__END__
#line 544
inc/Module/Install/Metadata.pm view on Meta::CPAN
#line 1
package Module::Install::Metadata;
use strict 'vars';
use Module::Install::Base ();
use vars qw{$VERSION @ISA $ISCORE};
BEGIN {
$VERSION = '1.19';
@ISA = 'Module::Install::Base';
$ISCORE = 1;
}
my @boolean_keys = qw{
sign
};
my @scalar_keys = qw{
name
module_name
abstract
version
distribution_type
tests
installdirs
};
my @tuple_keys = qw{
configure_requires
build_requires
requires
recommends
bundles
resources
};
my @resource_keys = qw{
homepage
bugtracker
repository
};
my @array_keys = qw{
keywords
author
};
*authors = \&author;
sub Meta { shift }
sub Meta_BooleanKeys { @boolean_keys }
sub Meta_ScalarKeys { @scalar_keys }
sub Meta_TupleKeys { @tuple_keys }
sub Meta_ResourceKeys { @resource_keys }
sub Meta_ArrayKeys { @array_keys }
foreach my $key ( @boolean_keys ) {
*$key = sub {
my $self = shift;
if ( defined wantarray and not @_ ) {
return $self->{values}->{$key};
}
$self->{values}->{$key} = ( @_ ? $_[0] : 1 );
return $self;
};
}
foreach my $key ( @scalar_keys ) {
*$key = sub {
my $self = shift;
return $self->{values}->{$key} if defined wantarray and !@_;
$self->{values}->{$key} = shift;
return $self;
};
}
foreach my $key ( @array_keys ) {
*$key = sub {
my $self = shift;
return $self->{values}->{$key} if defined wantarray and !@_;
$self->{values}->{$key} ||= [];
push @{$self->{values}->{$key}}, @_;
return $self;
};
}
foreach my $key ( @resource_keys ) {
*$key = sub {
my $self = shift;
unless ( @_ ) {
return () unless $self->{values}->{resources};
return map { $_->[1] }
grep { $_->[0] eq $key }
@{ $self->{values}->{resources} };
}
return $self->{values}->{resources}->{$key} unless @_;
my $uri = shift or die(
"Did not provide a value to $key()"
);
$self->resources( $key => $uri );
return 1;
};
}
foreach my $key ( grep { $_ ne "resources" } @tuple_keys) {
*$key = sub {
my $self = shift;
return $self->{values}->{$key} unless @_;
my @added;
while ( @_ ) {
my $module = shift or last;
my $version = shift || 0;
push @added, [ $module, $version ];
}
push @{ $self->{values}->{$key} }, @added;
return map {@$_} @added;
};
}
# Resource handling
my %lc_resource = map { $_ => 1 } qw{
homepage
license
bugtracker
repository
};
sub resources {
my $self = shift;
while ( @_ ) {
my $name = shift or last;
my $value = shift or next;
if ( $name eq lc $name and ! $lc_resource{$name} ) {
die("Unsupported reserved lowercase resource '$name'");
}
$self->{values}->{resources} ||= [];
push @{ $self->{values}->{resources} }, [ $name, $value ];
}
$self->{values}->{resources};
}
# Aliases for build_requires that will have alternative
# meanings in some future version of META.yml.
sub test_requires { shift->build_requires(@_) }
sub install_requires { shift->build_requires(@_) }
# Aliases for installdirs options
sub install_as_core { $_[0]->installdirs('perl') }
sub install_as_cpan { $_[0]->installdirs('site') }
sub install_as_site { $_[0]->installdirs('site') }
sub install_as_vendor { $_[0]->installdirs('vendor') }
sub dynamic_config {
my $self = shift;
my $value = @_ ? shift : 1;
if ( $self->{values}->{dynamic_config} ) {
# Once dynamic we never change to static, for safety
return 0;
}
$self->{values}->{dynamic_config} = $value ? 1 : 0;
return 1;
}
# Convenience command
sub static_config {
shift->dynamic_config(0);
}
sub perl_version {
my $self = shift;
return $self->{values}->{perl_version} unless @_;
my $version = shift or die(
"Did not provide a value to perl_version()"
);
# Normalize the version
$version = $self->_perl_version($version);
# We don't support the really old versions
unless ( $version >= 5.005 ) {
die "Module::Install only supports 5.005 or newer (use ExtUtils::MakeMaker)\n";
}
$self->{values}->{perl_version} = $version;
}
sub all_from {
my ( $self, $file ) = @_;
unless ( defined($file) ) {
my $name = $self->name or die(
"all_from called with no args without setting name() first"
);
$file = join('/', 'lib', split(/-/, $name)) . '.pm';
$file =~ s{.*/}{} unless -e $file;
unless ( -e $file ) {
die("all_from cannot find $file from $name");
}
}
unless ( -f $file ) {
die("The path '$file' does not exist, or is not a file");
}
$self->{values}{all_from} = $file;
# Some methods pull from POD instead of code.
# If there is a matching .pod, use that instead
my $pod = $file;
$pod =~ s/\.pm$/.pod/i;
$pod = $file unless -e $pod;
# Pull the different values
$self->name_from($file) unless $self->name;
$self->version_from($file) unless $self->version;
$self->perl_version_from($file) unless $self->perl_version;
$self->author_from($pod) unless @{$self->author || []};
$self->license_from($pod) unless $self->license;
$self->abstract_from($pod) unless $self->abstract;
return 1;
}
sub provides {
my $self = shift;
my $provides = ( $self->{values}->{provides} ||= {} );
%$provides = (%$provides, @_) if @_;
return $provides;
}
sub auto_provides {
my $self = shift;
return $self unless $self->is_admin;
unless (-e 'MANIFEST') {
warn "Cannot deduce auto_provides without a MANIFEST, skipping\n";
return $self;
}
# Avoid spurious warnings as we are not checking manifest here.
local $SIG{__WARN__} = sub {1};
require ExtUtils::Manifest;
local *ExtUtils::Manifest::manicheck = sub { return };
require Module::Build;
my $build = Module::Build->new(
dist_name => $self->name,
dist_version => $self->version,
license => $self->license,
);
$self->provides( %{ $build->find_dist_packages || {} } );
}
sub feature {
my $self = shift;
my $name = shift;
my $features = ( $self->{values}->{features} ||= [] );
my $mods;
if ( @_ == 1 and ref( $_[0] ) ) {
# The user used ->feature like ->features by passing in the second
# argument as a reference. Accomodate for that.
$mods = $_[0];
} else {
$mods = \@_;
}
my $count = 0;
push @$features, (
$name => [
map {
ref($_) ? ( ref($_) eq 'HASH' ) ? %$_ : @$_ : $_
} @$mods
]
);
return @$features;
}
sub features {
my $self = shift;
while ( my ( $name, $mods ) = splice( @_, 0, 2 ) ) {
$self->feature( $name, @$mods );
}
return $self->{values}->{features}
? @{ $self->{values}->{features} }
: ();
}
sub no_index {
my $self = shift;
my $type = shift;
push @{ $self->{values}->{no_index}->{$type} }, @_ if $type;
return $self->{values}->{no_index};
}
sub read {
my $self = shift;
$self->include_deps( 'YAML::Tiny', 0 );
require YAML::Tiny;
my $data = YAML::Tiny::LoadFile('META.yml');
# Call methods explicitly in case user has already set some values.
while ( my ( $key, $value ) = each %$data ) {
next unless $self->can($key);
if ( ref $value eq 'HASH' ) {
while ( my ( $module, $version ) = each %$value ) {
$self->can($key)->($self, $module => $version );
}
} else {
$self->can($key)->($self, $value);
}
}
return $self;
}
sub write {
my $self = shift;
return $self unless $self->is_admin;
$self->admin->write_meta;
return $self;
}
sub version_from {
require ExtUtils::MM_Unix;
my ( $self, $file ) = @_;
$self->version( ExtUtils::MM_Unix->parse_version($file) );
# for version integrity check
$self->makemaker_args( VERSION_FROM => $file );
}
sub abstract_from {
require ExtUtils::MM_Unix;
my ( $self, $file ) = @_;
$self->abstract(
bless(
{ DISTNAME => $self->name },
'ExtUtils::MM_Unix'
)->parse_abstract($file)
);
}
# Add both distribution and module name
sub name_from {
my ($self, $file) = @_;
if (
Module::Install::_read($file) =~ m/
^ \s*
package \s*
([\w:]+)
[\s|;]*
/ixms
) {
my ($name, $module_name) = ($1, $1);
$name =~ s{::}{-}g;
$self->name($name);
unless ( $self->module_name ) {
$self->module_name($module_name);
}
} else {
die("Cannot determine name from $file\n");
}
}
sub _extract_perl_version {
if (
$_[0] =~ m/
^\s*
(?:use|require) \s*
v?
([\d_\.]+)
\s* ;
/ixms
) {
my $perl_version = $1;
$perl_version =~ s{_}{}g;
return $perl_version;
} else {
return;
}
}
sub perl_version_from {
my $self = shift;
my $perl_version=_extract_perl_version(Module::Install::_read($_[0]));
if ($perl_version) {
$self->perl_version($perl_version);
} else {
warn "Cannot determine perl version info from $_[0]\n";
return;
}
}
sub author_from {
my $self = shift;
my $content = Module::Install::_read($_[0]);
if ($content =~ m/
=head \d \s+ (?:authors?)\b \s*
([^\n]*)
|
=head \d \s+ (?:licen[cs]e|licensing|copyright|legal)\b \s*
.*? copyright .*? \d\d\d[\d.]+ \s* (?:\bby\b)? \s*
([^\n]*)
/ixms) {
my $author = $1 || $2;
# XXX: ugly but should work anyway...
if (eval "require Pod::Escapes; 1") {
# Pod::Escapes has a mapping table.
# It's in core of perl >= 5.9.3, and should be installed
# as one of the Pod::Simple's prereqs, which is a prereq
# of Pod::Text 3.x (see also below).
$author =~ s{ E<( (\d+) | ([A-Za-z]+) )> }
{
defined $2
? chr($2)
: defined $Pod::Escapes::Name2character_number{$1}
? chr($Pod::Escapes::Name2character_number{$1})
: do {
warn "Unknown escape: E<$1>";
"E<$1>";
};
}gex;
}
elsif (eval "require Pod::Text; 1" && $Pod::Text::VERSION < 3) {
# Pod::Text < 3.0 has yet another mapping table,
# though the table name of 2.x and 1.x are different.
# (1.x is in core of Perl < 5.6, 2.x is in core of
# Perl < 5.9.3)
my $mapping = ($Pod::Text::VERSION < 2)
? \%Pod::Text::HTML_Escapes
: \%Pod::Text::ESCAPES;
$author =~ s{ E<( (\d+) | ([A-Za-z]+) )> }
{
defined $2
? chr($2)
: defined $mapping->{$1}
? $mapping->{$1}
: do {
warn "Unknown escape: E<$1>";
"E<$1>";
};
}gex;
}
else {
$author =~ s{E<lt>}{<}g;
$author =~ s{E<gt>}{>}g;
}
$self->author($author);
} else {
warn "Cannot determine author info from $_[0]\n";
}
}
#Stolen from M::B
my %license_urls = (
perl => 'http://dev.perl.org/licenses/',
apache => 'http://apache.org/licenses/LICENSE-2.0',
apache_1_1 => 'http://apache.org/licenses/LICENSE-1.1',
artistic => 'http://opensource.org/licenses/artistic-license.php',
artistic_2 => 'http://opensource.org/licenses/artistic-license-2.0.php',
lgpl => 'http://opensource.org/licenses/lgpl-license.php',
lgpl2 => 'http://opensource.org/licenses/lgpl-2.1.php',
lgpl3 => 'http://opensource.org/licenses/lgpl-3.0.html',
bsd => 'http://opensource.org/licenses/bsd-license.php',
gpl => 'http://opensource.org/licenses/gpl-license.php',
gpl2 => 'http://opensource.org/licenses/gpl-2.0.php',
gpl3 => 'http://opensource.org/licenses/gpl-3.0.html',
mit => 'http://opensource.org/licenses/mit-license.php',
mozilla => 'http://opensource.org/licenses/mozilla1.1.php',
open_source => undef,
unrestricted => undef,
restrictive => undef,
unknown => undef,
);
sub license {
my $self = shift;
return $self->{values}->{license} unless @_;
my $license = shift or die(
'Did not provide a value to license()'
);
$license = __extract_license($license) || lc $license;
$self->{values}->{license} = $license;
# Automatically fill in license URLs
if ( $license_urls{$license} ) {
$self->resources( license => $license_urls{$license} );
}
return 1;
}
sub _extract_license {
my $pod = shift;
my $matched;
return __extract_license(
($matched) = $pod =~ m/
(=head \d \s+ L(?i:ICEN[CS]E|ICENSING)\b.*?)
(=head \d.*|=cut.*|)\z
/xms
) || __extract_license(
($matched) = $pod =~ m/
(=head \d \s+ (?:C(?i:OPYRIGHTS?)|L(?i:EGAL))\b.*?)
(=head \d.*|=cut.*|)\z
/xms
);
}
sub __extract_license {
my $license_text = shift or return;
my @phrases = (
'(?:under )?the same (?:terms|license) as (?:perl|the perl (?:\d )?programming language)' => 'perl', 1,
'(?:under )?the terms of (?:perl|the perl programming language) itself' => 'perl', 1,
'Artistic and GPL' => 'perl', 1,
'GNU general public license' => 'gpl', 1,
'GNU public license' => 'gpl', 1,
'GNU lesser general public license' => 'lgpl', 1,
'GNU lesser public license' => 'lgpl', 1,
'GNU library general public license' => 'lgpl', 1,
'GNU library public license' => 'lgpl', 1,
'GNU Free Documentation license' => 'unrestricted', 1,
'GNU Affero General Public License' => 'open_source', 1,
'(?:Free)?BSD license' => 'bsd', 1,
'Artistic license 2\.0' => 'artistic_2', 1,
'Artistic license' => 'artistic', 1,
'Apache (?:Software )?license' => 'apache', 1,
'GPL' => 'gpl', 1,
'LGPL' => 'lgpl', 1,
'BSD' => 'bsd', 1,
'Artistic' => 'artistic', 1,
'MIT' => 'mit', 1,
'Mozilla Public License' => 'mozilla', 1,
'Q Public License' => 'open_source', 1,
'OpenSSL License' => 'unrestricted', 1,
'SSLeay License' => 'unrestricted', 1,
'zlib License' => 'open_source', 1,
'proprietary' => 'proprietary', 0,
);
while ( my ($pattern, $license, $osi) = splice(@phrases, 0, 3) ) {
$pattern =~ s#\s+#\\s+#gs;
if ( $license_text =~ /\b$pattern\b/i ) {
return $license;
}
}
return '';
}
sub license_from {
my $self = shift;
if (my $license=_extract_license(Module::Install::_read($_[0]))) {
$self->license($license);
} else {
warn "Cannot determine license info from $_[0]\n";
return 'unknown';
}
}
sub _extract_bugtracker {
my @links = $_[0] =~ m#L<(
https?\Q://rt.cpan.org/\E[^>]+|
https?\Q://github.com/\E[\w_]+/[\w_]+/issues|
https?\Q://code.google.com/p/\E[\w_\-]+/issues/list
)>#gx;
my %links;
@links{@links}=();
@links=keys %links;
return @links;
}
sub bugtracker_from {
my $self = shift;
my $content = Module::Install::_read($_[0]);
my @links = _extract_bugtracker($content);
unless ( @links ) {
warn "Cannot determine bugtracker info from $_[0]\n";
return 0;
}
if ( @links > 1 ) {
warn "Found more than one bugtracker link in $_[0]\n";
return 0;
}
# Set the bugtracker
bugtracker( $links[0] );
return 1;
}
sub requires_from {
my $self = shift;
my $content = Module::Install::_readperl($_[0]);
my @requires = $content =~ m/^use\s+([^\W\d]\w*(?:::\w+)*)\s+(v?[\d\.]+)/mg;
while ( @requires ) {
my $module = shift @requires;
my $version = shift @requires;
$self->requires( $module => $version );
}
}
sub test_requires_from {
my $self = shift;
my $content = Module::Install::_readperl($_[0]);
my @requires = $content =~ m/^use\s+([^\W\d]\w*(?:::\w+)*)\s+([\d\.]+)/mg;
while ( @requires ) {
my $module = shift @requires;
my $version = shift @requires;
$self->test_requires( $module => $version );
}
}
# Convert triple-part versions (eg, 5.6.1 or 5.8.9) to
# numbers (eg, 5.006001 or 5.008009).
# Also, convert double-part versions (eg, 5.8)
sub _perl_version {
my $v = $_[-1];
$v =~ s/^([1-9])\.([1-9]\d?\d?)$/sprintf("%d.%03d",$1,$2)/e;
$v =~ s/^([1-9])\.([1-9]\d?\d?)\.(0|[1-9]\d?\d?)$/sprintf("%d.%03d%03d",$1,$2,$3 || 0)/e;
$v =~ s/(\.\d\d\d)000$/$1/;
$v =~ s/_.+$//;
if ( ref($v) ) {
# Numify
$v = $v + 0;
}
return $v;
}
sub add_metadata {
my $self = shift;
my %hash = @_;
for my $key (keys %hash) {
warn "add_metadata: $key is not prefixed with 'x_'.\n" .
"Use appopriate function to add non-private metadata.\n" unless $key =~ /^x_/;
$self->{values}->{$key} = $hash{$key};
}
}
######################################################################
# MYMETA Support
sub WriteMyMeta {
die "WriteMyMeta has been deprecated";
}
sub write_mymeta_yaml {
my $self = shift;
# We need YAML::Tiny to write the MYMETA.yml file
unless ( eval { require YAML::Tiny; 1; } ) {
return 1;
}
# Generate the data
my $meta = $self->_write_mymeta_data or return 1;
# Save as the MYMETA.yml file
print "Writing MYMETA.yml\n";
YAML::Tiny::DumpFile('MYMETA.yml', $meta);
}
sub write_mymeta_json {
my $self = shift;
# We need JSON to write the MYMETA.json file
unless ( eval { require JSON; 1; } ) {
return 1;
}
# Generate the data
my $meta = $self->_write_mymeta_data or return 1;
# Save as the MYMETA.yml file
print "Writing MYMETA.json\n";
Module::Install::_write(
'MYMETA.json',
JSON->new->pretty(1)->canonical->encode($meta),
);
}
sub _write_mymeta_data {
my $self = shift;
# If there's no existing META.yml there is nothing we can do
return undef unless -f 'META.yml';
# We need Parse::CPAN::Meta to load the file
unless ( eval { require Parse::CPAN::Meta; 1; } ) {
return undef;
}
# Merge the perl version into the dependencies
my $val = $self->Meta->{values};
my $perl = delete $val->{perl_version};
if ( $perl ) {
$val->{requires} ||= [];
my $requires = $val->{requires};
# Canonize to three-dot version after Perl 5.6
if ( $perl >= 5.006 ) {
$perl =~ s{^(\d+)\.(\d\d\d)(\d*)}{join('.', $1, int($2||0), int($3||0))}e
}
unshift @$requires, [ perl => $perl ];
}
# Load the advisory META.yml file
my @yaml = Parse::CPAN::Meta::LoadFile('META.yml');
my $meta = $yaml[0];
# Overwrite the non-configure dependency hashes
delete $meta->{requires};
delete $meta->{build_requires};
delete $meta->{recommends};
if ( exists $val->{requires} ) {
$meta->{requires} = { map { @$_ } @{ $val->{requires} } };
}
if ( exists $val->{build_requires} ) {
$meta->{build_requires} = { map { @$_ } @{ $val->{build_requires} } };
}
return $meta;
}
1;
inc/Module/Install/ReadmeFromPod.pm view on Meta::CPAN
#line 1
package Module::Install::ReadmeFromPod;
use 5.006;
use strict;
use warnings;
use base qw(Module::Install::Base);
use vars qw($VERSION);
$VERSION = '0.26';
{
# these aren't defined until after _require_admin is run, so
# define them so prototypes are available during compilation.
sub io;
sub capture(&;@);
#line 28
my $done = 0;
sub _require_admin {
# do this once to avoid redefinition warnings from IO::All
return if $done;
require IO::All;
IO::All->import( '-binary' );
require Capture::Tiny;
Capture::Tiny->import ( 'capture' );
return;
}
}
sub readme_from {
my $self = shift;
return unless $self->is_admin;
_require_admin;
# Input file
my $in_file = shift || $self->_all_from
or die "Can't determine file to make readme_from";
# Get optional arguments
my ($clean, $format, $out_file, $options);
my $args = shift;
if ( ref $args ) {
# Arguments are in a hashref
if ( ref($args) ne 'HASH' ) {
die "Expected a hashref but got a ".ref($args)."\n";
} else {
$clean = $args->{'clean'};
$format = $args->{'format'};
$out_file = $args->{'output_file'};
$options = $args->{'options'};
}
} else {
# Arguments are in a list
$clean = $args;
$format = shift;
$out_file = shift;
$options = \@_;
}
# Default values;
$clean ||= 0;
$format ||= 'txt';
# Generate README
print "readme_from $in_file to $format\n";
if ($format =~ m/te?xt/) {
$out_file = $self->_readme_txt($in_file, $out_file, $options);
} elsif ($format =~ m/html?/) {
$out_file = $self->_readme_htm($in_file, $out_file, $options);
} elsif ($format eq 'man') {
$out_file = $self->_readme_man($in_file, $out_file, $options);
} elsif ($format eq 'md') {
$out_file = $self->_readme_md($in_file, $out_file, $options);
} elsif ($format eq 'pdf') {
$out_file = $self->_readme_pdf($in_file, $out_file, $options);
}
if ($clean) {
$self->clean_files($out_file);
}
return 1;
}
sub _readme_txt {
my ($self, $in_file, $out_file, $options) = @_;
$out_file ||= 'README';
require Pod::Text;
my $parser = Pod::Text->new( @$options );
my $io = io->file($out_file)->open(">");
my $out_fh = $io->io_handle;
$parser->output_fh( *$out_fh );
$parser->parse_file( $in_file );
return $out_file;
}
sub _readme_htm {
my ($self, $in_file, $out_file, $options) = @_;
$out_file ||= 'README.htm';
require Pod::Html;
my ($o) = capture {
Pod::Html::pod2html(
"--infile=$in_file",
"--outfile=-",
@$options,
);
};
io->file($out_file)->print($o);
# Remove temporary files if needed
for my $file ('pod2htmd.tmp', 'pod2htmi.tmp') {
if (-e $file) {
unlink $file or warn "Warning: Could not remove file '$file'.\n$!\n";
}
}
return $out_file;
}
sub _readme_man {
my ($self, $in_file, $out_file, $options) = @_;
$out_file ||= 'README.1';
require Pod::Man;
my $parser = Pod::Man->new( @$options );
my $io = io->file($out_file)->open(">");
my $out_fh = $io->io_handle;
$parser->output_fh( *$out_fh );
$parser->parse_file( $in_file );
return $out_file;
}
sub _readme_pdf {
my ($self, $in_file, $out_file, $options) = @_;
$out_file ||= 'README.pdf';
eval { require App::pod2pdf; }
or die "Could not generate $out_file because pod2pdf could not be found\n";
my $parser = App::pod2pdf->new( @$options );
$parser->parse_from_file($in_file);
my ($o) = capture { $parser->output };
io->file($out_file)->print($o);
return $out_file;
}
sub _readme_md {
my ($self, $in_file, $out_file, $options) = @_;
$out_file ||= 'README.md';
require Pod::Markdown;
my $parser = Pod::Markdown->new( @$options );
my $io = io->file($out_file)->open(">");
my $out_fh = $io->io_handle;
$parser->output_fh( *$out_fh );
$parser->parse_file( $in_file );
return $out_file;
}
sub _all_from {
my $self = shift;
return unless $self->admin->{extensions};
my ($metadata) = grep {
ref($_) eq 'Module::Install::Metadata';
} @{$self->admin->{extensions}};
return unless $metadata;
return $metadata->{values}{all_from} || '';
}
'Readme!';
__END__
#line 316
inc/Module/Install/Win32.pm view on Meta::CPAN
#line 1
package Module::Install::Win32;
use strict;
use Module::Install::Base ();
use vars qw{$VERSION @ISA $ISCORE};
BEGIN {
$VERSION = '1.19';
@ISA = 'Module::Install::Base';
$ISCORE = 1;
}
# determine if the user needs nmake, and download it if needed
sub check_nmake {
my $self = shift;
$self->load('can_run');
$self->load('get_file');
require Config;
return unless (
$^O eq 'MSWin32' and
$Config::Config{make} and
$Config::Config{make} =~ /^nmake\b/i and
! $self->can_run('nmake')
);
print "The required 'nmake' executable not found, fetching it...\n";
require File::Basename;
my $rv = $self->get_file(
url => 'http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe',
ftp_url => 'ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe',
local_dir => File::Basename::dirname($^X),
size => 51928,
run => 'Nmake15.exe /o > nul',
check_for => 'Nmake.exe',
remove => 1,
);
die <<'END_MESSAGE' unless $rv;
-------------------------------------------------------------------------------
Since you are using Microsoft Windows, you will need the 'nmake' utility
before installation. It's available at:
http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe
or
ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe
Please download the file manually, save it to a directory in %PATH% (e.g.
C:\WINDOWS\COMMAND\), then launch the MS-DOS command line shell, "cd" to
that directory, and run "Nmake15.exe" from there; that will create the
'nmake.exe' file needed by this module.
You may then resume the installation process described in README.
-------------------------------------------------------------------------------
END_MESSAGE
}
1;
inc/Module/Install/WriteAll.pm view on Meta::CPAN
#line 1
package Module::Install::WriteAll;
use strict;
use Module::Install::Base ();
use vars qw{$VERSION @ISA $ISCORE};
BEGIN {
$VERSION = '1.19';
@ISA = qw{Module::Install::Base};
$ISCORE = 1;
}
sub WriteAll {
my $self = shift;
my %args = (
meta => 1,
sign => 0,
inline => 0,
check_nmake => 1,
@_,
);
$self->sign(1) if $args{sign};
$self->admin->WriteAll(%args) if $self->is_admin;
$self->check_nmake if $args{check_nmake};
unless ( $self->makemaker_args->{PL_FILES} ) {
# XXX: This still may be a bit over-defensive...
unless ($self->makemaker(6.25)) {
$self->makemaker_args( PL_FILES => {} ) if -f 'Build.PL';
}
}
# Until ExtUtils::MakeMaker support MYMETA.yml, make sure
# we clean it up properly ourself.
$self->realclean_files('MYMETA.yml');
if ( $args{inline} ) {
$self->Inline->write;
} else {
$self->Makefile->write;
}
# The Makefile write process adds a couple of dependencies,
# so write the META.yml files after the Makefile.
if ( $args{meta} ) {
$self->Meta->write;
}
# Experimental support for MYMETA
if ( $ENV{X_MYMETA} ) {
if ( $ENV{X_MYMETA} eq 'JSON' ) {
$self->Meta->write_mymeta_json;
} else {
$self->Meta->write_mymeta_yaml;
}
}
return 1;
}
1;
lib/Catalyst/Helper/Model/DataLocalize.pm view on Meta::CPAN
# ============================================================================
package Catalyst::Helper::Model::DataLocalize;
# ============================================================================
use strict;
use warnings;
use Path::Class;
use FindBin;
sub mk_compclass {
my ($self, $helper) = @_;
my %args = ();
my $basedir = Path::Class::Dir->new( $FindBin::Bin, '..', 'lib');
my $datalocalize_module = $helper->{app}.'::'.$helper->{name};
my @path = split (/\:\:/,$datalocalize_module);
my $file = pop @path;
my $datalocalize_dir = $basedir->subdir( join '/', @path );
my $datalocalize_file = $datalocalize_dir->file($file.'.pm');
$datalocalize_dir->mkpath();
$helper->render_file('datalocalizeclass', $datalocalize_file->stringify, \%args);
$helper->render_file('modelclass', $helper->{file}, \%args);
return 1;
}
sub mk_comptest {
my ($self, $helper) = @_;
return $helper->render_file('modeltest', $helper->{test});
}
=encoding utf8
=head1 NAME
Catalyst::Helper::Model::DataLocalize - Helper for DataLocalize models
=head1 SYNOPSIS
script/myapp_create.pl model DataLocalize DataLocalize
=head1 DESCRIPTION
Helper for the L<Catalyst> DataLocalize model.
=head1 ARGUMENTS
./script/myapp_create.pl model <model_name> DataLocalize
You need to sepecify the C<model_name> (the name of the model).
=head1 AUTHOR
Maroš Kollár
CPAN ID: MAROS
maros [at] k-1.com
http://www.k-1.com
=head1 LICENSE
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
=cut
1;
__DATA__
=begin pod_to_ignore
__datalocalizeclass__
package [% app %]::[% name %];
use strict;
use warnings;
use parent qw(CatalystX::I18N::DataLocalize);
1;
__modelclass__
package [% class %];
use strict;
use warnings;
use parent qw(CatalystX::I18N::Model::DataLocalize);
1;
=head1 NAME
[% class %] - DataLocalize Catalyst model component
=head1 SYNOPSIS
See L<[% app %]>.
=head1 DESCRIPTION
DataLocalize Catalyst model component.
=head1 AUTHOR
[% author %]
=head1 LICENSE
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
1;
__modeltest__
use strict;
use warnings;
use Test::More tests => 3;
use_ok('Catalyst::Test', '[% app %]');
use_ok('[% class %]');
use_ok('[% app %]::[% name %]');
lib/Catalyst/Helper/Model/Maketext.pm view on Meta::CPAN
# ============================================================================
package Catalyst::Helper::Model::Maketext;
# ============================================================================
use strict;
use warnings;
use Path::Class;
use FindBin;
sub mk_compclass {
my ($self, $helper) = @_;
my %args = ();
my $basedir = Path::Class::Dir->new( $FindBin::Bin, '..', 'lib');
my $maketext_module = $helper->{app}.'::'.$helper->{name};
my @path = split (/\:\:/,$maketext_module);
my $file = pop @path;
my $maketext_dir = $basedir->subdir( join '/', @path );
my $maketext_file = $maketext_dir->file($file.'.pm');
$maketext_dir->mkpath();
$helper->render_file('maketextclass', $maketext_file->stringify, \%args);
$helper->render_file('modelclass', $helper->{file}, \%args);
return 1;
}
sub mk_comptest {
my ($self, $helper) = @_;
return $helper->render_file('modeltest', $helper->{test});
}
=encoding utf8
=head1 NAME
Catalyst::Helper::Model::Maketext - Helper for Maketext models
=head1 SYNOPSIS
script/myapp_create.pl model Maketext Maketext
=head1 DESCRIPTION
Helper for the L<Catalyst> Maketext model.
=head1 ARGUMENTS
./script/myapp_create.pl model <model_name> Maketext
You need to sepecify the C<model_name> (the name of the model).
=head1 AUTHOR
Maroš Kollár
CPAN ID: MAROS
maros [at] k-1.com
http://www.k-1.com
=head1 LICENSE
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
=cut
1;
__DATA__
=begin pod_to_ignore
__maketextclass__
package [% app %]::[% name %];
use strict;
use warnings;
use parent qw(CatalystX::I18N::Maketext);
1;
__modelclass__
package [% class %];
use strict;
use warnings;
use parent qw(CatalystX::I18N::Model::Maketext);
1;
=head1 NAME
[% class %] - Maketext Catalyst model component
=head1 SYNOPSIS
See L<[% app %]>.
=head1 DESCRIPTION
Maketext Catalyst model component.
=head1 AUTHOR
[% author %]
=head1 LICENSE
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
1;
__modeltest__
use strict;
use warnings;
use Test::More tests => 3;
use_ok('Catalyst::Test', '[% app %]');
use_ok('[% class %]');
use_ok('[% app %]::[% name %]');
lib/CatalystX/I18N.pm view on Meta::CPAN
# ============================================================================
package CatalystX::I18N;
# ============================================================================
use strict;
use warnings;
our $VERSION = "1.14";
our $AUTHORITY = 'cpan:MAROS';
1;
=encoding utf8
=head1 NAME
CatalystX::I18N - Catalyst internationalisation (I18N) framework
=head1 SYNOPSIS
package MyApp::Catalyst;
use strict;
use warnings;
use Catalyst qw/
+CatalystX::I18N::Role::Base
+CatalystX::I18N::Role::GetLocale
+CatalystX::I18N::Role::DateTime
+CatalystX::I18N::Role::Maketext
/;
# Choose only the roles you need
# CatalystX::I18N::Role::All is a convinient shortcut to load all available roles
# Optionally also load request and response roles (also loaded by CatalystX::I18N::Role::All)
use CatalystX::RoleApplicator;
__PACKAGE__->apply_request_class_roles(qw/CatalystX::I18N::TraitFor::Request/);
__PACKAGE__->apply_response_class_roles(qw/CatalystX::I18N::TraitFor::Response/);
# Add some I18N configuration
__PACKAGE__->config(
name => 'MyApp',
I18N => {
default_locale => 'de_AT',
locales => {
'de' => {
format_date => 'dd.MM.yyyy',
format_datetime => 'dd.MM.yyyy HH:mm',
},
'de_AT' => {
inherits => 'de',
timezone => 'Europe/Vienna',
format_datetime => 'dd.MM.yyyy uma HH\'e\'',
},
'de_DE' => {
inherits => 'de',
timezone => 'Europe/Berlin',
},
}
},
);
Then in your controller classes
package MyApp::Catalyst::Controller::Main;
use strict;
use warnings;
use parent qw/Catalyst::Controller/;
sub auto : Private {
my ($self,$c) = @_;
$c->get_locale();
# Tries to fetch the locale from the folloing sources in the given order
# 1. Session
# 2. User settings
# 3. Browser settings
# 4. Client address
# 5. Default locale from config
}
sub action : Local {
my ($self,$c) = @_;
$c->stash->{title} = $c->maketext('Hello world!');
$c->stash->{location} = $c->i18n_geocode->name;
$c->stash->{language} = $c->language;
$c->stash->{localtime} = $c->i18n_datetime_format_date->format_datetime(DateTime->now);
}
If you want to load all available roles and traits you can use
L<CatalystX::I18N::Role::All> as a shortcut.
package MyApp::Catalyst;
use strict;
use warnings;
use Catalyst qw/
+CatalystX::I18N::Role::All
/;
=head1 DESCRIPTION
CatalystX::I18N provides a comprehensive toolset for internationalisation
(I18N) and localisation (L10N) of catalyst applications. This distribution
consists of several modules that are designed to integrate seamlessly, but
can be run idependently or replaced easily if necessary.
=over
=item * L<CatalystX::I18N::Role::Base>
Basic I18N role that glues everything toghether.
=item * L<CatalystX::I18N::Role::Maketext>
Localize text via L<Locale::Maketext>. Prefered over
L<CatalystX::I18N::Role::DataLocalize>
=item * L<CatalystX::I18N::Role::DataLocalize>
Localize text via L<Data::Localize>. Alternative to
L<CatalystX::I18N::Role::Maketext>
=item * L<CatalystX::I18N::Role::PosixLocale>
Sets the POSIX locale
=item * L<CatalystX::I18N::Role::DateTime>
Methods for localising date and time information.
=item * L<CatalystX::I18N::Role::NumberFormat>
Methods for localising numbers.
=item * L<CatalystX::I18N::TraitFor::Request>
Extends L<Catalyst::Request> with useful methods to help dealing with
various I18N related information in HTTP requests.
=item * L<CatalystX::I18N::TraitFor::Response>
Adds a C<Content-Language> header to the response.
=item * L<CatalystX::I18N::Role::GetLocale>
Tries to determine the most appropriate locale for the current request.
=item * L<CatalystX::I18N::Model::Maketext>
Provides access to L<Locale::Maketext> classes via a Catalyst model.
=item * L<CatalystX::I18N::Model::DataLocalize>
Provides access to a L<Data::Localize> class via a Catalyst model.
=item * L<CatalystX::I18N::Maketext>
Helpful wrapper around L<Locale::Maketext>. Can also be used outside of
Catalyst.
=item * L<CatalystX::I18N::DataLocalize>
Helpful wrapper around L<Data::Localize>. Can also be used outside of
Catalyst.
=back
=head1 CONFIGURATION
In order to work properly, CatalystX::I18N will need some values in your
Catalyst configuration
__PACKAGE__->config(
name => 'MyApp',
I18N => {
default_locale => 'de_AT', # Fallback locale
locales => {
'de' => {
inactive => 1,
# Mark this locale as inactive (sort of abstract locale)
...
# Arbitrary configuration parameters
},
'de_AT' => {
inherits => 'de',
# Inherit all settings form the 'de' locale
...
},
}
},
);
The configuration must be stored under the key C<I18N>. It should contain
a hashref of C<locales> and optionally a default locale (C<default_locale>).
Locales can be marked as C<inactive>. Inactive locales will not be selected
by the L<CatalystX::I18N::Role::GetLocale/get_locale> method.
Locales can inherit from other locales (C<inherits>). All configuration values
from inherited locales will be copied. If you use
L<CatalystX::I18N::Model::Maketext> together with L<CatalystX::I18N::Maketext>
the generated lexicons will also inherit in the selected order.
Additional configuration values are defined by the various
CatalystX::I18N::Role::* plugins.
=head1 EXTENDING
Extending the functionality of CatalystX::I18N distribution is easy.
E.g. writing a new plugin that does some processing when the locale is set
package CatalystX::MyI18N::Role::MyPlugin;
use Moose::Role;
use namespace::autoclean;
after 'set_locale' => sub {
my ($c,$locale) = @_;
$c->do_someting($c->locale);
};
1;
=head1 SEE ALSO
L<Locale::Maketext>, <Locale::Maketext::Lexicon>, L<Data::Localize>,
L<Number::Format>, L<DateTime::Locale>, L<DateTime::Format::CLDR>,
L<DateTime::TimeZone>, L<HTTP::BrowserDetect> and L<Locale::Geocode>
=head1 SUPPORT
Please report any bugs or feature requests to
C<catalystx-i18n@rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org/Public/Bug/Report.html?Queue=CatalystX::I18N>.
I will be notified and then you'll automatically be notified of the progress
on your report as I make changes.
=head1 AUTHOR
Maroš Kollár
CPAN ID: MAROS
maros [at] k-1.com
http://www.k-1.com
=head1 COPYRIGHT
CatalystX::I18N is Copyright (c) 2012 Maroš Kollár
- L<http://www.k-1.com>
=head1 LICENCE
This library is free software, you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
lib/CatalystX/I18N/DataLocalize.pm view on Meta::CPAN
# ============================================================================
package CatalystX::I18N::DataLocalize;
# ============================================================================
use Moose;
extends qw(Data::Localize);
use Path::Class;
use CatalystX::I18N::TypeConstraints;
use Data::Localize::Format::Gettext;
sub gettext_formatter {
my ($self) = @_;
# Taken from Locale::Maketext
my $numf = sub {
my ($lang, $args) = @_;
my $num = shift(@$args);
if($num < 10_000_000_000 and $num > -10_000_000_000 and $num == int($num)) {
$num += 0; # Just use normal integer stringification.
# Specifically, don't let %G turn ten million into 1E+007
}
else {
$num = CORE::sprintf('%G', $num);
# "CORE::" is there to avoid confusion with the above sub sprintf.
}
while( $num =~ s/^([-+]?\d+)(\d{3})/$1,$2/s ) {1} # right from perlfaq5
# The initial \d+ gobbles as many digits as it can, and then we
# backtrack so it un-eats the rightmost three, and then we
# insert the comma there.
# This is just a lame hack instead of using Number::Format
return $num;
};
my $numerate = sub {
my ($lang, $args) = @_;
my $num = shift(@$args);
# return this lexical item in a form appropriate to this number
my $s = ($num == 1);
return ''
unless scalar(@$args);
if(scalar(@$args) == 1) { # only the headword form specified
return $s ? $args->[0] : ($args->[0] . 's'); # very cheap hack.
}
else { # sing and plural were specified
return $s ? $args->[0] : $args->[1];
}
};
my $formatter = Data::Localize::Format::Gettext->new(
functions => {
quant => sub {
my ($lang, $args) = @_;
my $num = shift(@$args);
return $num if scalar(@$args) == 0; # what should this mean?
return $args->[2] if scalar(@$args) > 2 and $num == 0; # special zeroth case
return $numf->($lang,[$num]) . ' ' . $numerate->($lang,[$num,@$args]);
},
numerate => $numerate,
numf => $numf,
}
);
return $formatter;
}
sub add_localizers {
my ( $self, %params ) = @_;
my $locales = $params{locales} || [];
my $directories = $params{directories};
$directories = [ $directories ]
if defined $directories
&& ref $directories ne 'ARRAY';
$directories ||= [];
$locales = [ $locales ]
unless ref $locales eq 'ARRAY';
die "Invalid locales"
unless defined $locales
&& scalar @$locales > 0
&& ! grep { $_ !~ $CatalystX::I18N::TypeConstraints::LOCALE_RE } @$locales;
my $formatter;
# Loop all directories
foreach my $directory (@$directories) {
next
unless defined $directory;
$directory = Path::Class::Dir->new($directory)
unless ref $directory eq 'Path::Class::Dir';
next
unless -d $directory->stringify && -e _ && -r _;
$formatter ||= $self->gettext_formatter;
$self->add_localizer(
class => "Gettext",
path => $directory.'/*.po',
formatter => $formatter,
);
}
return;
}
1;
=encoding utf8
=head1 NAME
CatalystX::I18N::DataLocalize - Wrapper around Data::Localize
=head1 SYNOPSIS
package MyApp::DataLocalize;
use Moose;
extends qw(CatalystX::I18N::DataLocalize);
=head1 DESCRIPTION
This class can be used as your Data Localize base-class. It is a wrapper around
L<Data::Localize> and provides methods for auto-loading po files.
It is designed to work toghether with L<CatalystX::Model::DataLocalize>.
You need to subclass this package in your project in order to use it.
=head1 MEDTHODS
=head3 load_lexicon
MyApp::DataLocalize->add_localizer(
locales => ['de','de_AT'], # Required
directories => ['/path/to/your/maketext/files'], # Required
);
This method will search the given directories and load all available *.po
files.
This class provides only the most basic functionality and probably needs
to be re-implemented according to your specific requirements.
=head1 SEE ALSO
L<Data::Localize>
=head1 AUTHOR
Maroš Kollár
CPAN ID: MAROS
maros [at] k-1.com
L<http://www.k-1.com>
lib/CatalystX/I18N/Maketext.pm view on Meta::CPAN
# ============================================================================
package CatalystX::I18N::Maketext;
# ============================================================================
use strict;
use warnings;
use parent qw(Locale::Maketext);
use Locale::Maketext::Lexicon;
use CatalystX::I18N::TypeConstraints;
#use Locale::Maketext::Lexicon::Gettext;
use Path::Class;
sub load_lexicon {
my ( $class, %params ) = @_;
my $locales = $params{locales} || [];
my $directories = $params{directories};
my $gettext_style = defined $params{gettext_style} ? $params{gettext_style} : 1;
my $inheritance = $params{inheritance} || {};
$directories = [ $directories ]
if defined $directories
&& ref $directories ne 'ARRAY';
$directories ||= [];
$locales = [ $locales ]
unless ref $locales eq 'ARRAY';
die "Invalid locales"
unless defined $locales
&& scalar @$locales > 0
&& ! grep { $_ !~ $CatalystX::I18N::TypeConstraints::LOCALE_RE } @$locales;
{
no strict 'refs';
my $lexicon_loaded = ${$class.'::LEXICON_LOADED'};
if (defined $lexicon_loaded
&& $lexicon_loaded == 1) {
warn "Lexicon has already been loaded for $class";
return;
}
}
my $lexicondata = {
_decode => 1,
};
$lexicondata->{_style} = 'gettext'
if $gettext_style;
my %locale_loaded;
# Loop all directories
foreach my $directory (@$directories) {
next
unless defined $directory;
$directory = Path::Class::Dir->new($directory)
unless ref $directory eq 'Path::Class::Dir';
next
unless -d $directory->stringify && -e _ && -r _;
my @directory_content = $directory->children();
# Load all avaliable message files
foreach my $locale (@$locales) {
my $lc_locale = lc($locale);
$lc_locale =~ s/-/_/g;
my @locale_lexicon;
foreach my $content (@directory_content) {
if ($content->is_dir) {
push(@locale_lexicon,'Slurp',$content->stringify)
if $content->basename eq $locale;
} else {
my $filename = $content->basename;
if ($filename =~ m/^$locale\.(mo|po)$/i) {
push(@locale_lexicon,'Gettext',$content->stringify);
} elsif ($filename =~ m/^$locale\.m$/i) {
push(@locale_lexicon,'Msgcat',$content->stringify);
} elsif($filename =~ m/^$locale\.db$/i) {
push(@locale_lexicon,'Tie',[ $class, $content->stringify ]);
} elsif ($filename =~ m/^$lc_locale\.pm$/) {
$locale_loaded{$locale} = 1;
require $content->stringify;
# TODO transform maketext -> gettext syntax if flag is set
# Locale::Maketext::Lexicon::Gettext::_gettext_to_maketext
}
}
}
$lexicondata->{$locale} = \@locale_lexicon
if scalar @locale_lexicon;
}
}
# Fallback lexicon
foreach my $locale (@$locales) {
next
if exists $inheritance->{$locale};
next
if exists $locale_loaded{$locale};
$lexicondata->{$locale} ||= ['Auto'];
}
eval qq[
package $class;
our \$LEXICON_LOADED = 1;
Locale::Maketext::Lexicon->import(\$lexicondata)
];
while (my ($locale,$inherit) = each %$inheritance) {
my $locale_class = lc($locale);
my $inherit_class = lc($inherit);
$locale_class =~ s/-/_/g;
$inherit_class =~ s/-/_/g;
$locale_class = $class.'::'.$locale_class;
$inherit_class = $class.'::'.$inherit_class;
no strict 'refs';
push(@{$locale_class.'::ISA'},$inherit_class);
}
die("Could not load Locale::Maketext::Lexicon") if $@;
return;
}
#sub set_lexicon {
# my ( $class, $locale, $lexicon ) = @_;
#
# $locale = lc($locale);
# $locale =~ s/-/_/g;
#
# no strict 'refs';
# %{$class .'::'.$locale.'::Lexicon'} = %{$lexicon};
# return;
#}
1;
=encoding utf8
=head1 NAME
CatalystX::I18N::Maketext - Wrapper around Locale::Maketext
=head1 SYNOPSIS
package MyApp::Maketext;
use parent qw(CatalystX::I18N::Maketext);
=head1 DESCRIPTION
This class can be used as your Maketext base-class. It is a wrapper around
L<Locale::Maketext> and provides methods for auto-loading lexicon files.
It is designed to work toghether with L<CatalystX::Model::Maketext>.
You need to subclass this package in your project in order to use it.
=head1 MEDTHODS
=head3 load_lexicon
MyApp::Maketext->load_lexicon(
locales => ['de','de_AT'], # Required
directories => ['/path/to/your/maketext/files'], # Required
gettext_style => 0, # Optional, Default 1
inheritance => { # Optional
de_AT => 'de',
},
);
This method will search the given directories and load all available maketext
files for the requested locales
=over
=item * *.mo, *.po
via L<Locale::Maketext::Lexicon::Gettext>
=item * *.db
via L<Locale::Maketext::Lexicon::Tie> The files will be tied to you Maketext
class, thus you need to implement the necessary tie methods in your class.
=item * *.m
via L<Locale::Maketext::Lexicon::Msgcat>
=item * Directories
via L<Locale::Maketext::Lexicon::Slurp>
=item * Perl Packages
Will be loaded (only lowercase locale names e.g. locale 'de_AT' will only
load 'de_at.pm'). The packages must have a C<%Lexion> variable.
=back
If no translation files can be found for a given locale then
L<Locale::Maketext::Lexicon::Auto> will be loaded.
The following parameters are recognized/required
=over
=item * locales
Array reference of locales.
Required
=item * directories
Array reference of directories. Also accepts L<Path::Class::Dir> objects
and single values.
Required
=item * gettext_style
Enable gettext style. C<%quant(%1,document,documents)> instead of
C<[quant,_1,document,documents]>
Optional, Default TRUE
=item * inheritance
Set inheritance as as HashRef (e.g. 'en_US' inherits from 'en')
Optional
=back
=head1 SEE ALSO
L<Locale::Maketext> and L<Locale::Maketext::Lexicon>
=head1 AUTHOR
Maroš Kollár
CPAN ID: MAROS
maros [at] k-1.com
L<http://www.k-1.com>
Ã
lib/CatalystX/I18N/Model/Base.pm view on Meta::CPAN
# ============================================================================
package CatalystX::I18N::Model::Base;
# ============================================================================
use namespace::autoclean;
use Moose;
extends 'Catalyst::Model';
has '_app' => (
is => 'rw',
isa => 'Str',
required => 1,
);
has 'class' => (
is => 'rw',
isa => 'Str',
lazy_build => 1,
);
has 'directories' => (
is => 'rw',
isa => 'CatalystX::I18N::Type::DirList',
coerce => 1,
lazy_build => 1,
);
around BUILDARGS => sub {
my $orig = shift;
my ( $self,$app,$config ) = @_;
# Set _app class
$config->{_app} = $app;
# Call original BUILDARGS
return $self->$orig($app,$config);
};
sub _build_class {
my ($self) = @_;
return $self->_app.'::'.class_name($self);
}
sub class_name {
my ($class_name) = @_;
$class_name = ref($class_name)
if ref($class_name);
my ($return) = reverse split(/::/,$class_name);
return $return;
}
sub _build_directories {
my ($self) = @_;
my $class_name = class_name($self->class);
my $calldir = $self->_app;
$calldir =~ s{::}{/}g;
my $file = $calldir.".pm";
my $path = $INC{$file};
$path =~ s{\.pm$}{/$class_name};
return [ Path::Class::Dir->new($path) ];
}
__PACKAGE__->meta->make_immutable( inline_constructor => 0 );
no Moose;
1;
lib/CatalystX/I18N/Model/DataLocalize.pm view on Meta::CPAN
# ============================================================================
package CatalystX::I18N::Model::DataLocalize;
# ============================================================================
use namespace::autoclean;
use Moose;
extends 'CatalystX::I18N::Model::Base';
has 'data_localize' => (
is => 'rw',
isa => 'Data::Localize',
lazy_build => 1,
);
sub _build_data_localize {
my ($self) = @_;
# Get DataLocalize class
my $class = $self->class || $self->_app .'::DataLocalize';
# Load DataLocalize class
my ($ok,$error) = Class::Load::try_load_class($class);
Catalyst::Exception->throw(sprintf("Could not load '%s' : %s",$class,$error))
unless $ok;
Catalyst::Exception->throw(sprintf("Could initialize '%s' because is is not a 'Data::Localize' class",$class))
unless $class->isa('Data::Localize');
return $class->new();
}
sub BUILD {
my ($self) = @_;
my $loc = $self->data_localize;
my $app = $self->_app;
# Add localizers if possible
if ($loc->can('add_localizers')) {
my (@locales,$config);
$config = $app->config->{I18N}{locales};
@locales = keys %$config;
$app->log->debug(sprintf("Adding localizers for locales %s",join(',',@locales)))
if $app->debug;
$loc->add_localizers(
locales => \@locales,
directories => $self->directories,
);
} else {
$app->log->warn(sprintf("'%s' does not implement a 'add_localizers' method",ref($loc)))
}
$self->data_localize($loc);
return;
}
sub ACCEPT_CONTEXT {
my ( $self, $c ) = @_;
my @languages = ($c->locale);
push(@languages,@{$c->i18n_config->{_inherits}});
# set locale and inheritance
$self->data_localize->set_languages(@languages);
return $self->data_localize;
}
__PACKAGE__->meta->make_immutable( inline_constructor => 0 );
no Moose;
1;
lib/CatalystX/I18N/Model/L10N.pm view on Meta::CPAN
# ============================================================================
package CatalystX::I18N::Model::L10N;
# ============================================================================
use namespace::autoclean;
use Moose;
extends 'CatalystX::I18N::Model::Maketext';
before 'BUILD' => sub {
my ($self) = @_;
my $app = $self->_app;
$app->log->warn('CatalystX::I18N::Model::L10N is deprecated, use CatalystX::I18N::Model::Maketext instead');
};
__PACKAGE__->meta->make_immutable( inline_constructor => 0 );
no Moose;
1;
lib/CatalystX/I18N/Model/Maketext.pm view on Meta::CPAN
# ============================================================================
package CatalystX::I18N::Model::Maketext;
# ============================================================================
use namespace::autoclean;
use Moose;
extends 'CatalystX::I18N::Model::Base';
use CatalystX::I18N::TypeConstraints;
use Path::Class;
use Scalar::Util qw(weaken);
has 'gettext_style' => (
is => 'rw',
isa => 'Bool',
default => 1,
);
sub BUILD {
my ($self) = @_;
my $class = $self->class;
# Load Maketext class
my ($ok,$error) = Class::Load::try_load_class($class);
Catalyst::Exception->throw(sprintf("Could not load '%s' : %s",$class,$error))
unless $ok;
Catalyst::Exception->throw(sprintf("Could initialize '%s' because is is not a 'Locale::Maketext' class",$class))
unless $class->isa('Locale::Maketext');
my $app = $self->_app;
# Load lexicons in the Maketext class if possible
if ($class->can('load_lexicon')) {
my (@locales,%inhertiance,$config);
$config = $app->config->{I18N}{locales};
foreach my $locale (keys %$config) {
push(@locales,$locale);
$inhertiance{$locale} = $config->{$locale}{inherits}
if defined $config->{$locale}{inherits};
}
$app->log->debug(sprintf("Loading maketext lexicons for locales %s",join(',',@locales)))
if $app->debug;
$class->load_lexicon(
locales => \@locales,
directories => $self->directories,
gettext_style => $self->gettext_style,
inheritance => \%inhertiance,
);
} else {
$app->log->warn(sprintf("'%s' does not implement a 'load_lexicon' method",$class))
}
return;
}
sub ACCEPT_CONTEXT {
my ( $self, $c ) = @_;
# set locale and fallback
my $handle = $self->class->get_handle( $c->locale );
# Catch error
Catalyst::Exception->throw(sprintf("Could not fetch lanuage handle for locale '%s'",$c->locale))
unless ( scalar $handle );
if ($self->can('fail_with')) {
weaken($c);
$handle->fail_with( sub {
$self->fail_with($c,@_);
} );
} else {
$handle->fail_with( sub { } );
}
return $handle;
}
__PACKAGE__->meta->make_immutable( inline_constructor => 0 );
no Moose;
1;
=encoding utf8
=head1 NAME
CatalystX::I18N::Model::Maketext - Glues Locale::Maketext into Catalyst
=head1 SYNOPSIS
# In your catalyst base class
package MyApp::Catalyst;
use Catalyst qw/CatalystX::I18N::Role::Base/;
__PACKAGE__->config(
'Model::Maketext' => {
class => 'MyApp::Maketext', # optional
directories => '/path/to/maketext/files', # optional
},
);
# Create a model class
package MyApp::Model::Maketext;
use parent qw/CatalystX::I18N::Model::Maketext/;
# Create a Maketext class (must be a Locale::Maketext class)
package MyApp::Maketext;
use parent qw/CatalystX::I18N::Maketext/;
# In your controller class(es)
package MyApp::Controller::Main;
use parent qw/Catalyst::Controller/;
sub action : Local {
my ($self,$c) = @_;
my $model = $c->model('Maketext');
$c->stash->{title} = $model->maketext('Hello world');
# See CatalystX::I18N::Role::Maketext for a convinient wrapper
}
=head1 DESCRIPTION
This model glues a L<Locale::Maketext> class
(eg. L<CatalystX::I18N::Maketext>) into you Catalyst application.
The method C<fail_with> will be called for each missing msgid if present
in your model class.
package MyApp::Model::Maketext;
use parent qw/CatalystX::I18N::Model::Maketext/;
sub fail_with {
my ($self,$c,$language_handle,$msgid,$params) = @_;
# Do somenthing clever
return $string;
}
See L<Catalyst::Helper::Model::Maketext> for gerating an Maketext model from
the command-line.
=head1 CONFIGURATION
=head3 class
Set the L<Locale::Maketext> class you want to use from this model.
Defaults to $APPNAME::Maketext
=head3 gettext_style
Enable gettext style. C<%quant(%1,document,documents)> instead of
C<[quant,_1,document,documents]>
Default TRUE
=head3 directories
Array reference of directories to be searched for maketext files.
See L<CatalystX::I18N::Maketext> for more details on the C<directory>
parameter
=head1 SEE ALSO
L<CatalystX::I18N::Maketext>, L<Locale::Maketext>,
L<Locale::Maketext::Lexicon> and L<CatalystX::I18N::Role::Maketext>
=head1 AUTHOR
Maroš Kollár
CPAN ID: MAROS
maros [at] k-1.com
L<http://www.k-1.com>
lib/CatalystX/I18N/Role/All.pm view on Meta::CPAN
# ============================================================================
package CatalystX::I18N::Role::All;
# ============================================================================
use namespace::autoclean;
use Moose::Role;
requires qw(response_class request_class);
with qw(
CatalystX::I18N::Role::Base
CatalystX::I18N::Role::DateTime
CatalystX::I18N::Role::Maketext
CatalystX::I18N::Role::GetLocale
CatalystX::I18N::Role::NumberFormat
CatalystX::I18N::Role::Collate
);
# CatalystX::I18N::Role::PosixLocale
before 'setup' => sub {
my ($class) = @_;
for my $type (qw(Response Request)) {
my $accessor_method = lc($type).'_class';
my $super_class = $class->$accessor_method();
# Get role
my $role_class = 'CatalystX::I18N::TraitFor::'.$type;
Class::Load::load_class($role_class);
# Check if role has already been applied
next
if grep { $_->meta->does_role($role_class) } $super_class->meta->linearized_isa;
# Build anon class with our roles
my $meta = Moose::Meta::Class->create_anon_class(
superclasses => [$super_class],
roles => [$role_class],
cache => 1,
);
$class->$accessor_method($meta->name);
}
};
around 'setup_component' => sub {
my $orig = shift;
my ($class,$component) = @_;
Class::Load::load_class($component);
# Load View::TT role
if ($component->isa('Catalyst::View::TT')
&& $component->can('meta')) {
my $component_meta = $component->meta;
unless ($component_meta->does_role('CatalystX::I18N::TraitFor::ViewTT')) {
if ($component_meta->is_mutable) {
Moose::Util::apply_all_roles($component_meta, 'CatalystX::I18N::TraitFor::ViewTT')
}
}
}
return $class->$orig($component);
};
no Moose::Role;
1;
=encoding utf8
=head1 NAME
CatalystX::I18N::Role::All - Load all available roles
=head1 SYNOPSIS
package MyApp::Catalyst;
use Catalyst qw/MyPlugins
CatalystX::I18N::Role::All/;
=head1 DESCRIPTION
This role is just a shortcut for loading every I18N role and trait (except POSIX)
individually.
use Catalyst qw/CatalystX::I18N::Role::All/;
Is same as
use Catalyst qw/
+CatalystX::I18N::Role::Base
+CatalystX::I18N::Role::GetLocale
+CatalystX::I18N::Role::DateTime
+CatalystX::I18N::Role::Maketext
+CatalystX::I18N::Role::Collate
+CatalystX::I18N::Role::NumberFormat
/;
use CatalystX::RoleApplicator;
__PACKAGE__->apply_request_class_roles(qw/CatalystX::I18N::TraitFor::Request/);
__PACKAGE__->apply_response_class_roles(qw/CatalystX::I18N::TraitFor::Response/);
=head1 AUTHOR
Maroš Kollár
CPAN ID: MAROS
maros [at] k-1.com
L<http://www.k-1.com>
lib/CatalystX/I18N/Role/Base.pm view on Meta::CPAN
# ============================================================================
package CatalystX::I18N::Role::Base;
# ============================================================================
use namespace::autoclean;
use Moose::Role;
requires qw(config response log);
use CatalystX::I18N::TypeConstraints;
use Clone qw();
has 'locale' => (
is => 'rw',
isa => 'CatalystX::I18N::Type::Locale',
lazy_build => 1,
builder => '_build_default_locale',
predicate => 'has_locale',
trigger => sub { shift->set_locale(@_) },
);
sub _build_default_locale {
my ($c) = @_;
my $locale = $c->config->{I18N}{default_locale};
$c->set_locale($locale);
return $locale;
}
sub i18n_config {
my ($c) = @_;
return {}
unless defined $c->config->{I18N}{locales}{$c->locale};
my $config = Clone::clone($c->config->{I18N}{locales}{$c->locale});
$config->{locale} = $c->locale;
return $config;
}
sub i18n_geocode {
my ($c) = @_;
my $territory = $c->territory;
return
unless $territory;
Class::Load::load_class('Locale::Geocode');
my $lc = Locale::Geocode->new();
return $lc->lookup($territory);
}
sub language {
my ($self) = @_;
return
unless $self->locale =~ $CatalystX::I18N::TypeConstraints::LOCALE_RE;
return lc($1);
}
sub territory {
my ($self) = @_;
return
unless $self->locale =~ $CatalystX::I18N::TypeConstraints::LOCALE_RE;
return
unless $2;
return lc($2);
}
sub set_locale {
my ($c,$value) = @_;
return
unless $value =~ $CatalystX::I18N::TypeConstraints::LOCALE_RE;
my $meta_attribute = $c->meta->get_attribute('locale');
my $language = $1;
my $territory = $2;
my $locale = lc($language);
$locale .= '_'.uc($territory)
if defined $territory && $territory ne '';
# Check for valid locale
if (! exists $c->config->{I18N}{locales}{$locale}
|| $c->config->{I18N}{locales}{$locale}{inactive} == 1) {
$meta_attribute->clear_value($c);
return;
}
# Set content language header
$c->response->content_language($language)
if $c->response->can('content_language');
# Save locale in session
if ($c->can('session')) {
$c->session->{i18n_locale} = $locale
}
# Set locale
$meta_attribute->set_raw_value($c,$locale)
if ! $meta_attribute->has_value($c)
|| $meta_attribute->get_raw_value($c) ne $locale;
return $locale;
}
after setup_finalize => sub {
my ($app) = @_;
$app->config->{I18N} ||= {};
my $config = $app->config->{I18N};
my $locales = $config->{locales} ||= {};
my $locale_type_constraint = $app
->meta
->get_attribute('locale')
->type_constraint;
my $default_locale = $config->{default_locale};
if (defined $default_locale
&& ! $locale_type_constraint->check($default_locale)) {
Catalyst::Exception->throw(sprintf("Default locale '%s' does not match %s",$default_locale,$CatalystX::I18N::TypeConstraints::LOCALE_RE));
}
# Default locale fallback
$default_locale ||= 'en';
# Enable default locale
$locales->{$default_locale} ||= {};
# Build inheritance tree
my (%tree,$changed);
$changed = 1;
while ($changed) {
$changed = 0;
foreach my $locale (keys %$locales) {
next
if exists $tree{$locale};
my $locale_config = $locales->{$locale};
my $locale_inactive = $locale_type_constraint->check($locale) ? 0:1;
$locale_config->{inactive} = 0
unless defined $locale_config->{inactive};
if ($locale_config->{inactive} == 0
&& $locale_config->{inactive} != $locale_inactive) {
$app->log->warn(sprintf("Locale '%s' has been set inactive because it does not match %s",$locale,$CatalystX::I18N::TypeConstraints::LOCALE_RE));
$locale_config->{inactive} = 1;
}
unless (exists $locale_config->{inherits}) {
$locale_config->{_inherits} = [];
$tree{$locale} = $locale_config;
$changed = 1;
} elsif (exists $tree{$locale_config->{inherits}}) {
my $inactive = $locale_config->{inactive};
my @inheritance = (@{$tree{$locale_config->{inherits}}->{_inherits}},$locale_config->{inherits});
$tree{$locale} = $locales->{$locale} = $locale_config = Catalyst::Utils::merge_hashes($tree{$locale_config->{inherits}}, $locale_config);
$locale_config->{_inherits} = \@inheritance;
$locale_config->{inactive} = $inactive;
$changed = 1;
}
}
}
# Check inheritance tree for circular references
foreach my $locale (keys %$locales) {
my $locale_config = $locales->{$locale};
unless (exists $locale_config->{_inherits}) {
Catalyst::Exception->throw(sprintf("Circular I18N inheritance detected between '%s' and '%s'",$locale,$locale_config->{inherits}))
}
}
};
no Moose::Role;
1;
=encoding utf8
=head1 NAME
CatalystX::I18N::Role::Base - Basic catalyst I18N support
=head1 SYNOPSIS
package MyApp::Catalyst;
use Catalyst qw/MyPlugins
CatalystX::I18N::Role::Base/;
package MyApp::Catalyst::Controller::Main;
use strict;
use warnings;
use parent qw/Catalyst::Controller/;
sub action : Local {
my ($self,$c) = @_;
$c->locale('de_AT');
}
=head1 DESCRIPTION
This role is required by all other roles and provides basic I18N support for
Catalyst.
=head1 METHODS
=head3 locale
$c->locale('de_AT');
OR
my $locale = $c->locale();
Get/set the current locale. Changing this value has some side-effects:
=over
=item * Stores the locale in the current session (if any)
=item * Sets the 'Content-Language' response header (if L<CatalystX::I18N::TraitFor::Response> has been loaded)
=back
=head3 set_locale
Same as C<$c-E<gt>locale($locale);>.
=head3 language
Returns the language part of the current locale
=head3 territory
Returns the territory part of the current locale
=head3 i18n_config
Returns the (cloned) I18N config hash for the current locale.
=head3 i18n_geocode
my $lgt = $c->i18n_geocode
say $lgt->name;
Returns a L<Locale::Geocode::Territory> object for the current territory.
=head1 SEE ALSO
L<POSIX>, L<Locale::Geocode>
=head1 AUTHOR
Maroš Kollár
CPAN ID: MAROS
maros [at] k-1.com
L<http://www.k-1.com>
lib/CatalystX/I18N/Role/Collate.pm view on Meta::CPAN
# ============================================================================
package CatalystX::I18N::Role::Collate;
# ============================================================================
use utf8;
use namespace::autoclean;
use Moose::Role;
use namespace::autoclean;
use CatalystX::I18N::TypeConstraints;
use Unicode::Collate::Locale;
has 'i18n_collator' => (
is => 'rw',
isa => 'Unicode::Collate',
lazy_build => 1,
builder => '_build_i18n_collator',
clearer => '_clear_i18n_collator',
);
sub _build_i18n_collator {
my ($c) = @_;
my $language = $c->language;
my $config = $c->i18n_config;
$config->{collate} ||= {};
my $collator = Unicode::Collate::Locale->new( locale => $language, %{$config->{collate}} );
return $collator;
}
sub i18n_sort {
my ($c,@arguments) = @_;
@arguments = @{$arguments[0]}
if scalar(@arguments) == 0 && ref($arguments[0]) eq 'ARRAY';
my @results = $c->i18n_collator->sort(@arguments);
return wantarray ? @results : \@results;
}
after 'set_locale' => sub {
my ($c,$locale) = @_;
$c->_clear_i18n_collator();
};
no Moose::Role;
1;
=encoding utf8
=head1 NAME
CatalystX::I18N::Role::Collate - Support for localised collation
=head1 SYNOPSIS
package MyApp::Catalyst;
use Catalyst qw/MyPlugins
CatalystX::I18N::Role::Base
CatalystX::I18N::Role::Collate/;
package MyApp::Catalyst::Controller::Main;
use strict;
use warnings;
use parent qw/Catalyst::Controller/;
sub action : Local {
my ($self,$c) = @_;
$c->locale('de');
@sorted_names = $c->i18n_sort(qw/Algerien Ägypten Armenien Argentinien Äthiopien Afganistan Aserbaidschan/);
$c->stash->{names} = \@sorted_names;
}
=head1 DESCRIPTION
This role adds support for localised collation your Catalyst application.
my @german_alphabeth = (A..Z,a..z,'ä','Ä','ü','Ü','ö','Ö','ß');
$sort = join(',',sort @german_alphabeth);
# $sort_no_collate is 'A,B,C,[...],Z,a,b,c,[...],z,Ä,Ö,Ü,ß,ä,ö,ü'
$sort_localised = join(',',$c->i18n_sort(@german_alphabeth));
# $sort_no_collate is 'a,A,ä,Ä,b,B,c,C,[...],s,S,ß,t,T,u,U,ü,Ü,v,V,w,[...],z,Z'
All methods are lazy. This means that the values will be only calculated
upon the first call of the method.
=head1 METHODS
=head3 i18n_sort
my @sorted = $c->i18n_sort(@list);
OR
my $sorted = $c->i18n_sort(\@list);
Sorts the given list or arrayref with the current locale and returns a
list or arrayref.
=head3 i18n_collator
my $collator = $c->i18n_collator();
Returns a L<Unicode::Collate::Locale> object with the current language used
as the locale. The collator settings can be configured in your Catalyst I18N
configuration:
# Add some I18N configuration
__PACKAGE__->config(
name => 'MyApp',
I18N => {
default_locale => 'de_AT',
locales => {
'de_AT' => {
collate => {
level => 3,
variable => 'Non-Ignorable',
...
},
},
}
},
);
The following configuration options are available (see L<Unicode::Collate> for
detailed documentation):
=over
=item * UCA_Version
=item * alternate
=item * backwards
=item * entry
=item * hangul_terminator
=item * ignoreChar
=item * katakana_before_hiragana
=item * level
=item * normalisation
=item * overrideCJK
=item * overrideHangul
=item * preprocess
=item * rearrange
=item * suppress
=item * table
=item * undefName
=item * undefChar
=item * upper_before_lower
=item * variable
=back
=head1 SEE ALSO
L<Unicode::Collate>
=head1 AUTHOR
Maroš Kollár
CPAN ID: MAROS
maros [at] k-1.com
L<http://www.k-1.com>
lib/CatalystX/I18N/Role/DataLocalize.pm view on Meta::CPAN
# ============================================================================
package CatalystX::I18N::Role::DataLocalize;
# ============================================================================
use namespace::autoclean;
use Moose::Role;
sub localize {
my ($c,$msgid,@args) = @_;
my @args_expand;
foreach my $arg (@args) {
push @args_expand,
(ref $arg eq 'ARRAY') ? @$arg : $arg;
}
# TODO: Check if DataLocalize model is available
my $loc = $c->model('DataLocalize');
my $msgstr = $loc->localize( $msgid, @args_expand );
return $msgstr;
}
no Moose::Role;
1;
=encoding utf8
=head1 NAME
CatalystX::I18N::Role::DataLocalize - Support for localize
=head1 SYNOPSIS
# In your catalyst base class
package MyApp::Catalyst;
use Catalyst qw/MyPlugins
CatalystX::I18N::Role::Base
CatalystX::I18N::Role::DataLocalize/;
# Maketext model class
package MyApp::Model::DataLocalize;
use parent qw/CatalystX::I18N::Model::DataLocalize/;
# Create a Maketext class (must be a Data::Localize class)
package MyApp::Maketext;
use parent qw/CatalystX::I18N::DataLocalize/;
# In your controller class(es)
package MyApp::Catalyst::Controller::Main;
use strict;
use warnings;
use parent qw/Catalyst::Controller/;
sub action : Local {
my ($self,$c) = @_;
$c->stash->{results} = $c->localize('Your search found %quant(%1,result,results)',$count);
}
=head1 DESCRIPTION
This role adds support for L<Data::Localize> localisation via the
L<CatalystX::I18N::Model::DataLocalize> model.
In order to work properly this role needs a model called C<DataLocalize>. A
call to C<$c-E<gt>model('DataLocalize')> should return a L<Data::Localize>
object. You can either write your own Model and use L<Data::Localize> directly
or use L<CatalystX::I18N::Model::DataLocalize> togheter with
L<CatalystX::I18N::DataLocalize>.
=head1 METHODS
=head3 localize
my $translated_string = $c->localize($msgid,@params);
OR
my $translated_string = $c->localize($msgid,\@params);
Translates a string via L<Data::Localize>.
=head1 SEE ALSO
L<Data::Localize>, L<CatalystX::I18N::Model::DataLocalize>
and L<CatalystX::I18N::DataLocalize>
=head1 AUTHOR
Maroš Kollár
CPAN ID: MAROS
maros [at] k-1.com
L<http://www.k-1.com>
lib/CatalystX/I18N/Role/DateTime.pm view on Meta::CPAN
# ============================================================================
package CatalystX::I18N::Role::DateTime;
# ============================================================================
use namespace::autoclean;
use Moose::Role;
use CatalystX::I18N::TypeConstraints;
use MooseX::Types::DateTime;
use Carp qw(carp);
use DateTime;
use DateTime::Format::CLDR;
use DateTime::TimeZone;
use DateTime::Locale;
has 'i18n_datetime_timezone' => (
is => 'rw',
isa => 'DateTime::TimeZone',
lazy_build=> 1,
builder => '_build_i18n_datetime_timezone',
clearer => '_clear_i18n_datetime_timezone',
);
has 'i18n_datetime_locale' => (
is => 'rw',
isa => 'DateTime::Locale',
lazy_build=> 1,
builder => '_build_i18n_datetime_locale',
clearer => '_clear_i18n_datetime_locale',
);
has 'i18n_datetime_format_date' => (
is => 'rw',
isa => 'DateTime::Format::CLDR',
lazy_build=> 1,
builder => '_build_i18n_datetime_format_date',
clearer => '_clear_i18n_datetime_format_date',
);
has 'i18n_datetime_format_datetime' => (
is => 'rw',
isa => 'DateTime::Format::CLDR',
lazy_build=> 1,
builder => '_build_i18n_datetime_format_datetime',
clearer => '_clear_i18n_datetime_format_datetime',
);
sub i18n_timezone {
carp "Method 'i18n_timezone' is deprecated: Use i18n_datetime_timezone instead";
return shift->i18n_datetime_timezone(@_);
}
sub i18n_datetime_now {
my ($c) = @_;
return DateTime->from_epoch(
epoch => time(),
time_zone => $c->i18n_datetime_timezone,
locale => $c->i18n_datetime_locale,
);
}
sub i18n_datetime_today {
my ($c) = @_;
return $c->now->truncate( to => 'day' );
}
after 'set_locale' => sub {
my ($c,$locale) = @_;
$c->_clear_i18n_datetime_timezone();
$c->_clear_i18n_datetime_locale();
$c->_clear_i18n_datetime_format_date();
$c->_clear_i18n_datetime_format_datetime();
};
sub _build_i18n_datetime_timezone {
my ($c) = @_;
my $config = $c->i18n_config;
$c->_clear_i18n_datetime_format_date();
$c->_clear_i18n_datetime_format_datetime();
return DateTime::TimeZone->new( name => $config->{timezone} || 'floating' );
}
sub _build_i18n_datetime_locale {
my ($c) = @_;
$c->_clear_i18n_datetime_format_date();
$c->_clear_i18n_datetime_format_datetime();
return DateTime::Locale->load( $c->locale );
}
sub _build_i18n_datetime_format_date {
my ($c) = @_;
my $config = $c->i18n_config;
my $datetime_locale = $c->i18n_datetime_locale;
my $datetime_timezone = $c->i18n_datetime_timezone;
# Set datetime_format_date
my $datetime_format_date =
$config->{format_date} ||
$datetime_locale->date_format_medium;
return DateTime::Format::CLDR->new(
locale => $datetime_locale,
time_zone => $datetime_timezone,
pattern => $datetime_format_date
)
}
sub _build_i18n_datetime_format_datetime {
my ($c) = @_;
my $config = $c->i18n_config;
my $datetime_locale = $c->i18n_datetime_locale;
my $datetime_timezone = $c->i18n_datetime_timezone;
# Set datetime_format_date
my $datetime_format_datetime =
$config->{format_datetime} ||
$datetime_locale->datetime_format_medium;
return DateTime::Format::CLDR->new(
locale => $datetime_locale,
time_zone => $datetime_timezone,
pattern => $datetime_format_datetime
)
}
no Moose::Role;
1;
=encoding utf8
=head1 NAME
CatalystX::I18N::Role::DateTime - Support for I18N datetime
=head1 SYNOPSIS
package MyApp::Catalyst;
use Catalyst qw/MyPlugins
+CatalystX::I18N::Role::Base
+CatalystX::I18N::Role::DateTime/;
package MyApp::Catalyst::Controller::Main;
use strict;
use warnings;
use parent qw/Catalyst::Controller/;
sub action : Local {
my ($self,$c) = @_;
$c->stash->{timestamp} = $c->i18n_datetime_format_date->format_datetime($datetime);
}
=head1 DESCRIPTION
This role add support for localised datetime to your Catalyst application.
Most methods are lazy. This means that the values will be only calculated
upon the first call of the method.
Most settings will be taken from L<DateTime::Locale> but
can be overdriven in your Catalyst I18N configuration:
# Add I18N configuration
__PACKAGE__->config(
name => 'MyApp',
I18N => {
default_locale => 'de_AT',
locales => {
'de_AT' => {
timezone => 'Europe/Vienna', # default 'floating'
format_date => 'dd.MM.yyyy', # default date_format_medium from DateTime::Locale
format_datetime => 'dd.MM.yyyy uma HH:mm', # default datetime_format_medium from DateTime::Locale
},
}
},
);
=head1 METHODS
=head3 i18n_datetime_today
my $dt = $c->i18n_datetime_today
say $dt->dmy;
Returns the current date as a L<DateTime> object with the current
timezone and locale set.
=head3 i18n_datetime_now
my $dt = $c->i18n_datetime_now
say $dt->hms;
Returns the current timestamp as a L<DateTime> object with the current
timezone and locale set.
=head3 i18n_datetime_timezone
Returns/sets the current timezone as a L<DateTime::TimeZone> object. The
timezone for each locale can be defined in the I18N configuration.
If no timezone is set L<DateTime::TimeZone::Floating> will be used.
=head3 i18n_datetime_locale
Returns/sets the current datetime locale as a L<DateTime::Locale> object.
=head3 i18n_datetime_format_date
my $date = $c->i18n_datetime_format_date->format_datetime($date);
Returns a L<DateTime::Format::CLDR> object for parsing and printig
localised date data.
The format for each locale can either be set via the
C<format_date> coniguration key, or will be taken from the
C<date_format_medium> method in the current L<DateTime::Locale> object.
=head3 i18n_datetime_format_datetime
my $datetime = $c->i18n_datetime_format_datetime->format_datetime($datetime);
Returns a L<DateTime::Format::CLDR> object for parsing and printig
localised datetime data.
The format for each locale can either be set via the
C<format_datetime> coniguration key, or will be taken from the
C<datetime_format_medium> method in the current L<DateTime::Locale> object.
=head1 SEE ALSO
L<DateTime::Format::CLDR>, L<DateTime::Locale>, L<DateTime::TimeZone>
and L<DateTime>
=head1 AUTHOR
Maroš Kollár
CPAN ID: MAROS
maros [at] k-1.com
L<http://www.k-1.com>
( run in 2.905 seconds using v1.01-cache-2.11-cpan-0d23b851a93 )