/ 
Module-Format-v0.0.3
River stage one • 1 direct dependent • 1 total dependent
/ Module::Format::Module

NAME

Module::Format::Module - encapsulates a single Perl module.

VERSION

Version 0.0.3

SYNOPSIS

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";

FUNCTIONS

my $module = Module::Format::Module->from_components({components => [@components]})

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)],
    }
);

my $module = Module::Format::Module->from({format => $format, value => $string});

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.

  • 'dash'

    Separated by a double colon, e.g: XML-RSS, Data-Dumper, Catalyst-Plugin-Model-DBIx-Class, etc.

  • 'unix'

    UNIX path, e.g: 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.

  • 'rpm_colon'

    Like colon only wrapped inside perl(...) - useful for rpm provides for individual modules. E.g: perl(XML::RSS), perl(Catalyst::Plugin::Authentication) .

  • 'debian'

    Debian package format, such as libxml-rss-perl, libcatalyst-plugin-authentication-perl . Output only.

my $array_ref = $module->get_components_list()

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"].

$module->format_as($format)

Format the module in the given format. See from() for a list.

my $clone = $module->clone()

Duplicates the object.

my $bool = $module->is_sane();

Returns a boolean depending on if the component of the module do not contain any funny character (only alphanumeric characters and underscore.).

my $module = Module::Format::Module->from_guess({ value => $string});

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.

AUTHOR

Shlomi Fish, http://www.shlomifish.org/ .

BUGS

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.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Module::Format::Module

You can also look for information at:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

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.