Module::Format::Module - encapsulates a single Perl module.
version 0.4.0
use Module::Format::Module; my $module = Module::Format::Module->from( { format => 'colon', value => 'XML::RSS', } ); my $module = Module::Format::Module->from( { format => 'dash', value => 'XML-RSS', } ); my $module = Module::Format::Module->from( { format => 'unix', value => 'XML/RSS.pm', } ); my $module = Module::Format::Module->from( { format => 'rpm_dash', value => 'perl-XML-RSS', } ); my $module = Module::Format::Module->from( { format => 'rpm_colon', value => 'perl(XML::RSS)', } ); my $module = Module::Format::Module->from_guess( { value => # All of the above... } ); # Prints "XML-RSS" print $module->format_as('dash'), "\n"; # Prints "perl(XML::RSS)" print $module->format_as('rpm_colon'), "\n"; # Prints "libxml-rss-perl" print $module->format_as('debian'), "\n";
Constructs a module from @components which are strings that indicate the individual components of the module. For example:
my $module = Module::Format::Module->from_components( { components => [qw(XML Grammar Fiction)], } );
Construct a Module::Format::Module object from the given format $format and the string value $string .
Valid formats are:
'colon'
Separated by a double colon, e.g: XML::RSS, Data::Dumper, Catalyst::Plugin::Model::DBIx::Class, etc.
XML::RSS
Data::Dumper
Catalyst::Plugin::Model::DBIx::Class
'dash'
Separated by a double colon, e.g: XML-RSS, Data-Dumper, Catalyst-Plugin-Model-DBIx-Class, etc.
XML-RSS
Data-Dumper
Catalyst-Plugin-Model-DBIx-Class
'unix'
UNIX path, e.g: XML/RSS.pm, Catalyst/Plugin/Model/DBIx/Class.pm .
XML/RSS.pm
Catalyst/Plugin/Model/DBIx/Class.pm
This is commonly displayed in Perl error messages.
'rpm_dash'
Like dash, only with 'perl-' prefixed: perl-XML-RSS, perl-Data-Dumper.
'perl-'
perl-XML-RSS
perl-Data-Dumper
'rpm_colon'
Like colon only wrapped inside perl(...) - useful for rpm provides for individual modules. E.g: perl(XML::RSS), perl(Catalyst::Plugin::Authentication) .
perl(...)
perl(XML::RSS)
perl(Catalyst::Plugin::Authentication)
'metacpan_rel'
A MetaCPAN release page URL, e.g: https://metacpan.org/release/Text-Sprintf-Named , https://metacpan.org/release/Class-XSAccessor .
https://metacpan.org/release/Text-Sprintf-Named
https://metacpan.org/release/Class-XSAccessor
'metacpan_pod'
A MetaCPAN POD page URL, e.g: https://metacpan.org/pod/Module::Format , https://metacpan.org/pod/Data::ParseBinary .
https://metacpan.org/pod/Module::Format
https://metacpan.org/pod/Data::ParseBinary
'debian'
Debian package format, such as libxml-rss-perl, libcatalyst-plugin-authentication-perl . Output only.
libxml-rss-perl
libcatalyst-plugin-authentication-perl
'freebsd_dash'
Like dash, only with 'p5-' prefixed: p5-XML-RSS, p5-Data-Dumper.
'p5-'
p5-XML-RSS
p5-Data-Dumper
Returns the components list of the module as an array reference. For example for the module One::Two::Three it would be ["One", "Two", "Three"].
One::Two::Three
["One", "Two", "Three"]
Format the module in the given format. See from() for a list.
Duplicates the object.
Returns a boolean depending on if the component of the module do not contain any funny character (only alphanumeric characters and underscore.).
Initialises a module object from a string while trying to guess its format. It accepts a hash-ref with the following keys: 'value' that points to the string to serve as an input, and an optional 'format_ref' that will give the format that was decided upon.
'value'
'format_ref'
Shlomi Fish, http://www.shlomifish.org/ .
Please report any bugs or feature requests to bug-module-format at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module-Format. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-module-format at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Module::Format::Module
You can also look for information at:
MetaCPAN
https://metacpan.org/release/Module-Format
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Module-Format
CPAN Ratings
http://cpanratings.perl.org/d/Module-Format
Copyright 2010 Shlomi Fish.
This program is distributed under the MIT (X11) License: http://www.opensource.org/licenses/mit-license.php
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.
A modern, open-source CPAN search engine, useful to view POD in HTML format.
RT: CPAN's Bug Tracker
The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.
https://rt.cpan.org/Public/Dist/Display.html?Name=Module-Format
CPANTS
The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.
http://cpants.cpanauthors.org/dist/Module-Format
CPAN Testers
The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.
http://www.cpantesters.org/distro/M/Module-Format
CPAN Testers Matrix
The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.
http://matrix.cpantesters.org/?dist=Module-Format
CPAN Testers Dependencies
The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.
http://deps.cpantesters.org/?module=Module::Format
Please report any bugs or feature requests by email to bug-module-format at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=Module-Format. You will be automatically notified of any progress on the request by the system.
The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)
https://github.com/shlomif/perl-Module-Format
git clone git://github.com/shlomif/perl-Module-Format.git
Shlomi Fish <shlomif@cpan.org>
Please report any bugs or feature requests on the bugtracker website https://github.com/shlomif/perl-Module-Format/issues
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
This software is Copyright (c) 2018 by Shlomi Fish.
This is free software, licensed under:
The MIT (X11) License
To install Module::Format, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Module::Format
CPAN shell
perl -MCPAN -e shell install Module::Format
For more information on module installation, please visit the detailed CPAN module installation guide.