Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

update dist.ini and support files

  • Loading branch information...
commit 674e246750f0ee808543d9cf8aef3d18df96dcb4 1 parent 79af30a
@dagolden dagolden authored
View
52 CONTRIBUTING
@@ -1,4 +1,4 @@
-CONTRIBUTING
+## HOW TO CONTRIBUTE
Thank you for considering contributing to this distribution. This file
contains instructions that will help you work with the source code.
@@ -7,44 +7,56 @@ The distribution is managed with Dist::Zilla. This means than many of the
usual files you might expect are not in the repository, but are generated
at release time (e.g. Makefile.PL).
-However, you can run tests directly using the 'prove' tool:
+### Getting dependencies
- $ prove -l
- $ prove -lv t/some_test_file.t
+See the included `cpanfile` file for a list of dependencies. If you have
+App::cpanminus 1.6 or later installed, you can use `cpanm` to satisfy
+dependencies like this:
-For most distributions, 'prove' is entirely sufficent for you to test any
-patches you have.
+ $ cpanm --installdeps .
+
+Otherwise, you can install Module::CPANfile 1.0002 or later and then satisfy
+dependencies with the regular `cpan` client and `cpanfile-dump`:
+
+ $ cpan `cpanfile-dump`
-You may need to satisfy some dependencies. See the included META.json
-file for a list. If you install App::mymeta_requires from CPAN, it's easy
-to satisfy any that you are missing by piping the output to your favorite
-CPAN client:
+### Running tests
- $ mymeta-requires | cpanm
- $ cpan `mymeta-requires`
+You can run tests directly using the `prove` tool:
+
+ $ prove -l
+ $ prove -lv t/some_test_file.t
+
+For most distributions, `prove` is entirely sufficent for you to test any
+patches you have.
+
+### Patching documentation
Likewise, much of the documentation Pod is generated at release time.
Depending on the distribution, some documentation may be written in a Pod
-dialect called WikiDoc. (See Pod::WikiDoc on CPAN.) If you would like to
-submit a documentation edit, please limit yourself to the documentation you
-see.
+dialect called WikiDoc. (See Pod::WikiDoc on CPAN.)
+
+If you would like to submit a documentation edit, please limit yourself to the
+documentation you see.
If you see typos or documentation issues in the generated docs, please
email or open a bug ticket instead of patching.
+### Learning Dist::Zilla
+
Dist::Zilla is a very powerful authoring tool, but requires a number of
author-specific plugins. If you would like to use it for contributing,
install it from CPAN, then run one of the following commands, depending on
your CPAN client:
- $ cpan `dzil authordeps`
- $ dzil authordeps | cpanm
+ $ cpan `dzil authordeps`
+ $ dzil authordeps | cpanm
Once installed, here are some dzil commands you might try:
- $ dzil build
- $ dzil test
- $ dzil xtest
+ $ dzil build
+ $ dzil test
+ $ dzil xtest
You can learn more about Dist::Zilla at http://dzil.org/
View
1  Changes
@@ -1,6 +1,7 @@
Changes for Perl programming language extension Parse-CPAN-Meta
{{$NEXT}}
+ - Fixed improperly encoded META.yml
1.4405 2013-07-17 21:43:34 America/New_York
- Fixed incorrect "return ... or die ..." constructs
View
93 META.json
@@ -1,93 +0,0 @@
-{
- "abstract" : "Parse META.yml and META.json CPAN metadata files",
- "author" : [
- "Adam Kennedy <adamk@cpan.org>"
- ],
- "dynamic_config" : 0,
- "generated_by" : "Dist::Zilla version 4.300035, CPAN::Meta::Converter version 2.130880",
- "license" : [
- "perl_5"
- ],
- "meta-spec" : {
- "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
- "version" : "2"
- },
- "name" : "Parse-CPAN-Meta",
- "no_index" : {
- "directory" : [
- "t",
- "xt",
- "examples",
- "corpus"
- ],
- "package" : [
- "DB"
- ]
- },
- "prereqs" : {
- "configure" : {
- "requires" : {
- "ExtUtils::MakeMaker" : "6.30"
- }
- },
- "develop" : {
- "requires" : {
- "Pod::Coverage::TrustPod" : "0",
- "Test::CPAN::Meta" : "0",
- "Test::Pod" : "1.41",
- "Test::Pod::Coverage" : "1.08"
- }
- },
- "runtime" : {
- "requires" : {
- "CPAN::Meta::YAML" : "0.008",
- "Carp" : "0",
- "Exporter" : "0",
- "File::Spec" : "0.80",
- "JSON::PP" : "2.27200",
- "perl" : "5.006",
- "strict" : "0"
- }
- },
- "test" : {
- "requires" : {
- "ExtUtils::MakeMaker" : "0",
- "File::Find" : "0",
- "File::Spec" : "0",
- "File::Spec::Functions" : "0",
- "File::Temp" : "0",
- "List::Util" : "0",
- "Test::More" : "0.47",
- "vars" : "0",
- "warnings" : "0"
- }
- }
- },
- "provides" : {
- "Parse::CPAN::Meta" : {
- "file" : "lib/Parse/CPAN/Meta.pm",
- "version" : "1.4406"
- }
- },
- "release_status" : "stable",
- "resources" : {
- "bugtracker" : {
- "mailto" : "bug-Parse-CPAN-Meta@rt.cpan.org",
- "web" : "https://rt.cpan.org/Public/Dist/Display.html?Name=Parse-CPAN-Meta"
- },
- "homepage" : "https://metacpan.org/release/Parse-CPAN-Meta",
- "repository" : {
- "type" : "git",
- "url" : "git://github.com/Perl-Toolchain-Gang/Parse-CPAN-Meta.git",
- "web" : "http://github.com/Perl-Toolchain-Gang/Parse-CPAN-Meta"
- }
- },
- "version" : "1.4406",
- "x_contributors" : [
- "David Golden <dagolden@cpan.org>",
- "Joshua ben Jore <jjore@cpan.org>",
- "Ricardo SIGNES <rjbs@cpan.org>",
- "Steffen M\u00fcller <smueller@cpan.org>"
- ]
-}
-
View
1  README.mkdn
View
190 README.pod
@@ -1,190 +0,0 @@
-=pod
-
-=encoding utf-8
-
-=head1 NAME
-
-Parse::CPAN::Meta - Parse META.yml and META.json CPAN metadata files
-
-=head1 VERSION
-
-version 1.4406
-
-=head1 SYNOPSIS
-
- #############################################
- # In your file
-
- ---
- name: My-Distribution
- version: 1.23
- resources:
- homepage: "http://example.com/dist/My-Distribution"
-
-
- #############################################
- # In your program
-
- use Parse::CPAN::Meta;
-
- my $distmeta = Parse::CPAN::Meta->load_file('META.yml');
-
- # Reading properties
- my $name = $distmeta->{name};
- my $version = $distmeta->{version};
- my $homepage = $distmeta->{resources}{homepage};
-
-=head1 DESCRIPTION
-
-B<Parse::CPAN::Meta> is a parser for F<META.json> and F<META.yml> files, using
-L<JSON::PP> and/or L<CPAN::Meta::YAML>.
-
-B<Parse::CPAN::Meta> provides three methods: C<load_file>, C<load_json_string>,
-and C<load_yaml_string>. These will read and deserialize CPAN metafiles, and
-are described below in detail.
-
-B<Parse::CPAN::Meta> provides a legacy API of only two functions,
-based on the YAML functions of the same name. Wherever possible,
-identical calling semantics are used. These may only be used with YAML sources.
-
-All error reporting is done with exceptions (die'ing).
-
-Note that META files are expected to be in UTF-8 encoding, only. When
-converted string data, it must first be decoded from UTF-8.
-
-=for Pod::Coverage HAVE_UTF8 IO_LAYER
-
-=head1 METHODS
-
-=head2 load_file
-
- my $metadata_structure = Parse::CPAN::Meta->load_file('META.json');
-
- my $metadata_structure = Parse::CPAN::Meta->load_file('META.yml');
-
-This method will read the named file and deserialize it to a data structure,
-determining whether it should be JSON or YAML based on the filename. On
-Perl 5.8.1 or later, the file will be read using the ":utf8" IO layer.
-
-=head2 load_yaml_string
-
- my $metadata_structure = Parse::CPAN::Meta->load_yaml_string($yaml_string);
-
-This method deserializes the given string of YAML and returns the first
-document in it. (CPAN metadata files should always have only one document.)
-If the source was UTF-8 encoded, the string must be decoded before calling
-C<load_yaml_string>.
-
-=head2 load_json_string
-
- my $metadata_structure = Parse::CPAN::Meta->load_json_string($json_string);
-
-This method deserializes the given string of JSON and the result.
-If the source was UTF-8 encoded, the string must be decoded before calling
-C<load_json_string>.
-
-=head2 yaml_backend
-
- my $backend = Parse::CPAN::Meta->yaml_backend;
-
-Returns the module name of the YAML serializer. See L</ENVIRONMENT>
-for details.
-
-=head2 json_backend
-
- my $backend = Parse::CPAN::Meta->json_backend;
-
-Returns the module name of the JSON serializer. This will either
-be L<JSON::PP> or L<JSON>. Even if C<PERL_JSON_BACKEND> is set,
-this will return L<JSON> as further delegation is handled by
-the L<JSON> module. See L</ENVIRONMENT> for details.
-
-=head1 FUNCTIONS
-
-For maintenance clarity, no functions are exported. These functions are
-available for backwards compatibility only and are best avoided in favor of
-C<load_file>.
-
-=head2 Load
-
- my @yaml = Parse::CPAN::Meta::Load( $string );
-
-Parses a string containing a valid YAML stream into a list of Perl data
-structures.
-
-=head2 LoadFile
-
- my @yaml = Parse::CPAN::Meta::LoadFile( 'META.yml' );
-
-Reads the YAML stream from a file instead of a string.
-
-=head1 ENVIRONMENT
-
-=head2 PERL_JSON_BACKEND
-
-By default, L<JSON::PP> will be used for deserializing JSON data. If the
-C<PERL_JSON_BACKEND> environment variable exists, is true and is not
-"JSON::PP", then the L<JSON> module (version 2.5 or greater) will be loaded and
-used to interpret C<PERL_JSON_BACKEND>. If L<JSON> is not installed or is too
-old, an exception will be thrown.
-
-=head2 PERL_YAML_BACKEND
-
-By default, L<CPAN::Meta::YAML> will be used for deserializing YAML data. If
-the C<PERL_YAML_BACKEND> environment variable is defined, then it is interpreted
-as a module to use for deserialization. The given module must be installed,
-must load correctly and must implement the C<Load()> function or an exception
-will be thrown.
-
-=for :stopwords cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan
-
-=head1 SUPPORT
-
-=head2 Bugs / Feature Requests
-
-Please report any bugs or feature requests through the issue tracker
-at L<https://rt.cpan.org/Public/Dist/Display.html?Name=Parse-CPAN-Meta>.
-You will be notified automatically of any progress on your issue.
-
-=head2 Source Code
-
-This is open source software. The code repository is available for
-public review and contribution under the terms of the license.
-
-L<http://github.com/Perl-Toolchain-Gang/Parse-CPAN-Meta>
-
- git clone git://github.com/Perl-Toolchain-Gang/Parse-CPAN-Meta.git
-
-=head1 AUTHOR
-
-Adam Kennedy <adamk@cpan.org>
-
-=head1 CONTRIBUTORS
-
-=over 4
-
-=item *
-
-David Golden <dagolden@cpan.org>
-
-=item *
-
-Joshua ben Jore <jjore@cpan.org>
-
-=item *
-
-Ricardo SIGNES <rjbs@cpan.org>
-
-=item *
-
-Steffen Müller <smueller@cpan.org>
-
-=back
-
-=head1 COPYRIGHT AND LICENSE
-
-This software is copyright (c) 2013 by Adam Kennedy and Contributors.
-
-This is free software; you can redistribute it and/or modify it under
-the same terms as the Perl 5 programming language system itself.
-
View
31 cpanfile
@@ -0,0 +1,31 @@
+requires "CPAN::Meta::YAML" => "0.008";
+requires "Carp" => "0";
+requires "Exporter" => "0";
+requires "File::Spec" => "0.80";
+requires "JSON::PP" => "2.27200";
+requires "perl" => "5.006";
+requires "strict" => "0";
+
+on 'test' => sub {
+ requires "ExtUtils::MakeMaker" => "0";
+ requires "File::Spec" => "0";
+ requires "File::Spec::Functions" => "0";
+ requires "File::Temp" => "0";
+ requires "IO::Handle" => "0";
+ requires "IPC::Open3" => "0";
+ requires "List::Util" => "0";
+ requires "Test::More" => "0.47";
+ requires "vars" => "0";
+ requires "warnings" => "0";
+};
+
+on 'configure' => sub {
+ requires "ExtUtils::MakeMaker" => "6.30";
+};
+
+on 'develop' => sub {
+ requires "Pod::Coverage::TrustPod" => "0";
+ requires "Test::CPAN::Meta" => "0";
+ requires "Test::Pod" => "1.41";
+ requires "Test::Pod::Coverage" => "1.08";
+};
View
7 dist.ini
@@ -1,5 +1,6 @@
name = Parse-CPAN-Meta
author = Adam Kennedy <adamk@cpan.org>
+author = David Golden <dagolden@cpan.org>
license = Perl_5
copyright_holder = Adam Kennedy and Contributors
@@ -12,10 +13,10 @@ JSON::PP = 2.27200
Test::More = 0.47
[@DAGOLDEN]
-:version = 0.043
-AutoMetaResources.repository.github = 0
+:version = 0.052
+authority = cpan:ADAMK
+github_issues = 0
no_critic = 0
-auto_prereq = 1
stopwords = LoadFile
stopwords = deserialization
stopwords = deserialize
Please sign in to comment.
Something went wrong with that request. Please try again.