Acme-CPANModules-StructuredDATA

 view release on metacpan or  search on metacpan

LICENSE  view on Meta::CPAN

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.

  10. 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

        Appendix: How to Apply These Terms to Your New Programs

  If you develop a new program, and you want it to be of the greatest
possible use to humanity, the best way to achieve this is to make it

MANIFEST  view on Meta::CPAN

# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.024.
Changes
LICENSE
MANIFEST
META.json
META.yml
Makefile.PL
README
dist.ini
lib/Acme/CPANModules/StructuredDATA.pm
t/00-compile.t
t/author-critic.t
t/author-pod-coverage.t
t/author-pod-syntax.t
weaver.ini

META.json  view on Meta::CPAN

{
   "abstract" : "List of modules that give some structure to DATA",
   "author" : [
      "perlancar <perlancar@cpan.org>"
   ],
   "dynamic_config" : 0,
   "generated_by" : "Dist::Zilla version 6.024, CPAN::Meta::Converter version 2.150010",
   "license" : [
      "perl_5"
   ],
   "meta-spec" : {
      "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
      "version" : 2
   },
   "name" : "Acme-CPANModules-StructuredDATA",
   "prereqs" : {
      "configure" : {
         "requires" : {
            "ExtUtils::MakeMaker" : "0"
         }
      },
      "develop" : {
         "requires" : {
            "Pod::Coverage::TrustPod" : "0",
            "Test::Perl::Critic" : "0",

META.json  view on Meta::CPAN

      },
      "x_mentions" : {
         "x_mentions" : {
            "Data::Section" : "0",
            "Data::Section::Seekable" : "0",
            "Inline::Files" : "0"
         }
      }
   },
   "provides" : {
      "Acme::CPANModules::StructuredDATA" : {
         "file" : "lib/Acme/CPANModules/StructuredDATA.pm",
         "version" : "0.002"
      }
   },
   "release_status" : "stable",
   "resources" : {
      "bugtracker" : {
         "web" : "https://rt.cpan.org/Public/Dist/Display.html?Name=Acme-CPANModules-StructuredDATA"
      },
      "homepage" : "https://metacpan.org/release/Acme-CPANModules-StructuredDATA",
      "repository" : {
         "type" : "git",
         "url" : "git://github.com/perlancar/perl-Acme-CPANModules-StructuredDATA.git",
         "web" : "https://github.com/perlancar/perl-Acme-CPANModules-StructuredDATA"
      }
   },
   "version" : "0.002",
   "x_Dist_Zilla" : {
      "perl" : {
         "version" : "5.034000"
      },
      "plugins" : [
         {
            "class" : "Dist::Zilla::Plugin::Acme::CPANModules",

META.yml  view on Meta::CPAN

---
abstract: 'List of modules that give some structure to DATA'
author:
  - 'perlancar <perlancar@cpan.org>'
build_requires:
  File::Spec: '0'
  IO::Handle: '0'
  IPC::Open3: '0'
  Test::More: '0'
configure_requires:
  ExtUtils::MakeMaker: '0'
dynamic_config: 0
generated_by: 'Dist::Zilla version 6.024, CPAN::Meta::Converter version 2.150010'
license: perl
meta-spec:
  url: http://module-build.sourceforge.net/META-spec-v1.4.html
  version: '1.4'
name: Acme-CPANModules-StructuredDATA
provides:
  Acme::CPANModules::StructuredDATA:
    file: lib/Acme/CPANModules/StructuredDATA.pm
    version: '0.002'
requires:
  strict: '0'
resources:
  bugtracker: https://rt.cpan.org/Public/Dist/Display.html?Name=Acme-CPANModules-StructuredDATA
  homepage: https://metacpan.org/release/Acme-CPANModules-StructuredDATA
  repository: git://github.com/perlancar/perl-Acme-CPANModules-StructuredDATA.git
version: '0.002'
x_Dist_Zilla:
  perl:
    version: '5.034000'
  plugins:
    -
      class: Dist::Zilla::Plugin::Acme::CPANModules
      name: Acme::CPANModules
      version: '0.004'
    -

Makefile.PL  view on Meta::CPAN

# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.024.
use strict;
use warnings;



use ExtUtils::MakeMaker;

my %WriteMakefileArgs = (
  "ABSTRACT" => "List of modules that give some structure to DATA",
  "AUTHOR" => "perlancar <perlancar\@cpan.org>",
  "CONFIGURE_REQUIRES" => {
    "ExtUtils::MakeMaker" => 0
  },
  "DISTNAME" => "Acme-CPANModules-StructuredDATA",
  "LICENSE" => "perl",
  "NAME" => "Acme::CPANModules::StructuredDATA",
  "PREREQ_PM" => {
    "strict" => 0
  },
  "TEST_REQUIRES" => {
    "File::Spec" => 0,
    "IO::Handle" => 0,
    "IPC::Open3" => 0,
    "Test::More" => 0
  },
  "VERSION" => "0.002",

README  view on Meta::CPAN

NAME
    Acme::CPANModules::StructuredDATA - List of modules that give some
    structure to DATA

VERSION
    This document describes version 0.002 of
    Acme::CPANModules::StructuredDATA (from Perl distribution
    Acme-CPANModules-StructuredDATA), released on 2022-03-18.

DESCRIPTION
    The DATA file handle is a convenient feature provided by Perl to let
    scripts access its own source code (specifically the part after END or
    DATA). Scripts can usually put some data so they can run without
    additional data files.

    Instead of just a stream of bytes, some modules allow you to access the
    DATA as some kind of structured storage.

ACME::CPANMODULES ENTRIES
    *   Data::Section - read multiple hunks of data out of your DATA section

        Author: RJBS <https://metacpan.org/author/RJBS>

        With this module, you can put several strings in your DATA section,
        each prepended with a header line containing the label for each. For
        example:

         __[ content1 ]__
         content for content1.
 
         __[ content2 ]__
         content
         for
         content2

        and access each string by referring to its label.

    *   Data::Section::Seekable - Read and write parts from data section

        Author: PERLANCAR <https://metacpan.org/author/PERLANCAR>

        This module is similar to Data::Section in letting you put several
        multipart content in DATA with the exception that it writes a table
        of content (TOC) of all parts at the beginning of DATA, e.g.:

         __DATA__
         Data::Section::Seekable v1
         part1,0,14
         part2,14,17,important
 
         This is part1
         This is part
         two

        The first paragraph after DATA is called the TOC which lists all the
        parts along with their offsets and lengths. It is therefore possible
        to locate any part just from reading the TOC instead of scanning for
        headers on the whole data. It is useful when the amount of data is
        quite large and you need quick access to random parts.

    *   Inline::Files - Multiple virtual files at the end of your code

        Author: AMBS <https://metacpan.org/author/AMBS>

        This is a prior art for Data::Section but more magical (using source
        filters) and allows writing in addition to reading your parts. It
        completely replaces DATA with an unlimited number of LABEL's. I'd be
        wary in using it, and the module itself gives such warning.

FAQ
  What is an Acme::CPANModules::* module?
    An Acme::CPANModules::* module, like this module, contains just a list
    of module names that share a common characteristics. It is a way to
    categorize modules and document CPAN. See Acme::CPANModules for more
    details.

  What are ways to use this Acme::CPANModules module?
    Aside from reading this Acme::CPANModules module's POD documentation,
    you can install all the listed modules (entries) using cpanm-cpanmodules
    script (from App::cpanm::cpanmodules distribution):

     % cpanm-cpanmodules -n StructuredDATA

    Alternatively you can use the cpanmodules CLI (from App::cpanmodules
    distribution):

        % cpanmodules ls-entries StructuredDATA | cpanm -n

    or Acme::CM::Get:

        % perl -MAcme::CM::Get=StructuredDATA -E'say $_->{module} for @{ $LIST->{entries} }' | cpanm -n

    or directly:

        % perl -MAcme::CPANModules::StructuredDATA -E'say $_->{module} for @{ $Acme::CPANModules::StructuredDATA::LIST->{entries} }' | cpanm -n

    This Acme::CPANModules module also helps lcpan produce a more meaningful
    result for "lcpan related-mods" command when it comes to finding related
    modules for the modules listed in this Acme::CPANModules module. See
    App::lcpan::Cmd::related_mods for more details on how "related modules"
    are found.

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/Acme-CPANModules-StructuredDATA>.

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-Acme-CPANModules-StructuredDATA>.

SEE ALSO
    Acme::CPANModules - about the Acme::CPANModules namespace

    cpanmodules - CLI tool to let you browse/view the lists

AUTHOR
    perlancar <perlancar@cpan.org>

CONTRIBUTING

README  view on Meta::CPAN

COPYRIGHT AND LICENSE
    This software is copyright (c) 2022, 2019 by perlancar
    <perlancar@cpan.org>.

    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.

BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=Acme-CPANModules-Stru
    cturedDATA>

    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.

dist.ini  view on Meta::CPAN

;---------------------------------
author  = perlancar <perlancar@cpan.org>
copyright_holder = perlancar <perlancar@cpan.org>
license = Perl_5
;---------------------------------

version=0.002

name=Acme-CPANModules-StructuredDATA

[Acme::CPANModules]

[@Author::PERLANCAR]
:version=0.606

[Prereqs]
strict=0

[Prereqs / DevelopX_spec]

lib/Acme/CPANModules/StructuredDATA.pm  view on Meta::CPAN

package Acme::CPANModules::StructuredDATA;

use strict;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2022-03-18'; # DATE
our $DIST = 'Acme-CPANModules-StructuredDATA'; # DIST
our $VERSION = '0.002'; # VERSION

our $LIST = {
    summary => 'List of modules that give some structure to DATA',
    description => <<'_',

The DATA file handle is a convenient feature provided by Perl to let scripts
access its own source code (specifically the part after __END__ or __DATA__).
Scripts can usually put some data so they can run without additional data files.

Instead of just a stream of bytes, some modules allow you to access the DATA as
some kind of structured storage.

_
    entries => [
        {
            module=>'Data::Section',
            description => <<'_',

With this module, you can put several strings in your DATA section, each
prepended with a header line containing the label for each. For example:

    __[ content1 ]__
    content for content1.

    __[ content2 ]__
    content
    for
    content2

and access each string by referring to its label.

_
        },
        {
            module=>'Data::Section::Seekable',
            description => <<'_',

This module is similar to <pm:Data::Section> in letting you put several
multipart content in DATA with the exception that it writes a table of content
(TOC) of all parts at the beginning of DATA, e.g.:

    __DATA__
    Data::Section::Seekable v1
    part1,0,14
    part2,14,17,important

    This is part1
    This is part
    two

The first paragraph after __DATA__ is called the TOC which lists all the parts
along with their offsets and lengths. It is therefore possible to locate any
part just from reading the TOC instead of scanning for headers on the whole
data. It is useful when the amount of data is quite large and you need quick
access to random parts.

_
        },
        {
            module=>'Inline::Files',
            description => <<'_',

This is a prior art for <pm:Data::Section> but more magical (using source
filters) and allows writing in addition to reading your parts. It completely
replaces __DATA__ with an unlimited number of __LABEL__'s. I'd be wary in using
it, and the module itself gives such warning.

_
        },
    ],
};

1;
# ABSTRACT: List of modules that give some structure to DATA

__END__

=pod

=encoding UTF-8

=head1 NAME

Acme::CPANModules::StructuredDATA - List of modules that give some structure to DATA

=head1 VERSION

This document describes version 0.002 of Acme::CPANModules::StructuredDATA (from Perl distribution Acme-CPANModules-StructuredDATA), released on 2022-03-18.

=head1 DESCRIPTION

The DATA file handle is a convenient feature provided by Perl to let scripts
access its own source code (specifically the part after B<END> or B<DATA>).
Scripts can usually put some data so they can run without additional data files.

Instead of just a stream of bytes, some modules allow you to access the DATA as
some kind of structured storage.

=head1 ACME::CPANMODULES ENTRIES

=over

=item * L<Data::Section> - read multiple hunks of data out of your DATA section

Author: L<RJBS|https://metacpan.org/author/RJBS>

With this module, you can put several strings in your DATA section, each
prepended with a header line containing the label for each. For example:

 __[ content1 ]__
 content for content1.
 
 __[ content2 ]__
 content
 for
 content2

and access each string by referring to its label.


=item * L<Data::Section::Seekable> - Read and write parts from data section

Author: L<PERLANCAR|https://metacpan.org/author/PERLANCAR>

This module is similar to L<Data::Section> in letting you put several
multipart content in DATA with the exception that it writes a table of content
(TOC) of all parts at the beginning of DATA, e.g.:

 __DATA__
 Data::Section::Seekable v1
 part1,0,14
 part2,14,17,important
 
 This is part1
 This is part
 two

The first paragraph after B<DATA> is called the TOC which lists all the parts
along with their offsets and lengths. It is therefore possible to locate any
part just from reading the TOC instead of scanning for headers on the whole
data. It is useful when the amount of data is quite large and you need quick
access to random parts.


=item * L<Inline::Files> - Multiple virtual files at the end of your code

Author: L<AMBS|https://metacpan.org/author/AMBS>

This is a prior art for L<Data::Section> but more magical (using source
filters) and allows writing in addition to reading your parts. It completely
replaces B<DATA> with an unlimited number of B<LABEL>'s. I'd be wary in using
it, and the module itself gives such warning.


=back

=head1 FAQ

=head2 What is an Acme::CPANModules::* module?

An Acme::CPANModules::* module, like this module, contains just a list of module
names that share a common characteristics. It is a way to categorize modules and
document CPAN. See L<Acme::CPANModules> for more details.

=head2 What are ways to use this Acme::CPANModules module?

Aside from reading this Acme::CPANModules module's POD documentation, you can
install all the listed modules (entries) using L<cpanm-cpanmodules> script (from
L<App::cpanm::cpanmodules> distribution):

 % cpanm-cpanmodules -n StructuredDATA

Alternatively you can use the L<cpanmodules> CLI (from L<App::cpanmodules>
distribution):

    % cpanmodules ls-entries StructuredDATA | cpanm -n

or L<Acme::CM::Get>:

    % perl -MAcme::CM::Get=StructuredDATA -E'say $_->{module} for @{ $LIST->{entries} }' | cpanm -n

or directly:

    % perl -MAcme::CPANModules::StructuredDATA -E'say $_->{module} for @{ $Acme::CPANModules::StructuredDATA::LIST->{entries} }' | cpanm -n

This Acme::CPANModules module also helps L<lcpan> produce a more meaningful
result for C<lcpan related-mods> command when it comes to finding related
modules for the modules listed in this Acme::CPANModules module.
See L<App::lcpan::Cmd::related_mods> for more details on how "related modules"
are found.

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/Acme-CPANModules-StructuredDATA>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-Acme-CPANModules-StructuredDATA>.

=head1 SEE ALSO

L<Acme::CPANModules> - about the Acme::CPANModules namespace

L<cpanmodules> - CLI tool to let you browse/view the lists

=head1 AUTHOR

perlancar <perlancar@cpan.org>

lib/Acme/CPANModules/StructuredDATA.pm  view on Meta::CPAN


=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2019 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Acme-CPANModules-StructuredDATA>

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.

=cut

t/00-compile.t  view on Meta::CPAN

use strict;
use warnings;

# this test was generated with Dist::Zilla::Plugin::Test::Compile 2.058

use Test::More;

plan tests => 1 + ($ENV{AUTHOR_TESTING} ? 1 : 0);

my @module_files = (
    'Acme/CPANModules/StructuredDATA.pm'
);



# no fake home requested

my @switches = (
    -d 'blib' ? '-Mblib' : '-Ilib',
);

t/author-critic.t  view on Meta::CPAN

}


use strict;
use warnings;

# this test was generated with Dist::Zilla::Plugin::Test::Perl::Critic::Subset 3.001.006

use Test::Perl::Critic (-profile => "") x!! -e "";

my $filenames = ['lib/Acme/CPANModules/StructuredDATA.pm'];
unless ($filenames && @$filenames) {
    $filenames = -d "blib" ? ["blib"] : ["lib"];
}

all_critic_ok(@$filenames);



( run in 1.293 second using v1.01-cache-2.11-cpan-cdf2f3d4e48 )