Codebase list libcapture-tiny-perl / bc4cf98
import boilerplate David Golden 15 years ago
17 changed file(s) with 597 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
+31
-0
Build.PL less more
0 # Copyright (c) 2009 by David Golden. All rights reserved.
1 # Licensed under Apache License, Version 2.0 (the "License").
2 # You may not use this file except in compliance with the License.
3 # A copy of the License was distributed with this file or you may obtain a
4 # copy of the License from http://www.apache.org/licenses/LICENSE-2.0
5
6 use strict;
7 use lib 'inc';
8 eval "require Pod::WikiDoc";
9 my $class = $@ ? "Module::Build" : "Module::Build::WikiDoc";
10 eval "require $class";
11 my $build = $class->new(
12 module_name => 'Capture::Tiny',
13 dist_author => 'David Golden <dagolden@cpan.org>',
14 license => 'apache',
15 create_readme => 1,
16 # create_makefile_pl => 'traditional',
17 requires => {
18 'perl' => '5.004',
19 },
20 build_requires => {
21 'Test::More' => 0.47,
22 },
23 meta_add => {
24 no_index => {
25 directory => [ qw/ examples inc t /],
26 }
27 },
28 );
29 $build->create_build_script;
30
+11
-0
Changes less more
0 # Changes
1 # Copyright (c) 2009 by David Golden. All rights reserved.
2 # Licensed under Apache License, Version 2.0 (the "License").
3 # You may not use this file except in compliance with the License.
4 # A copy of the License was distributed with this file or you may obtain a
5 # copy of the License from http://www.apache.org/licenses/LICENSE-2.0
6
7 Revision history for Capture-Tiny
8
9 0.01 Wed Feb 11 15:50:11 2009
10 - original skeleton created with Module::Boilerplate
+28
-0
INSTALL less more
0 # Copyright (c) 2009 by David Golden. All rights reserved.
1 # Licensed under Apache License, Version 2.0 (the "License").
2 # You may not use this file except in compliance with the License.
3 # A copy of the License was distributed with this file or you may obtain a
4 # copy of the License from http://www.apache.org/licenses/LICENSE-2.0
5
6 INSTALLATION
7
8 This distribution may be installed via one of the following
9 methods:
10
11
12 1. If Build.PL exists and Module::Build is installed:
13
14 perl Build.PL
15 perl Build
16 perl Build test
17 perl Build install
18
19 2. If Makefile.PL exists:
20
21 perl Makefile.PL
22 make
23 make test
24 make install
25
26 If you are on a Windows machine you should use
27 'nmake' or 'dmake' rather than 'make'.
+201
-0
LICENSE less more
0 Apache License
1 Version 2.0, January 2004
2 http://www.apache.org/licenses/
3
4 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
5
6 1. Definitions.
7
8 "License" shall mean the terms and conditions for use, reproduction,
9 and distribution as defined by Sections 1 through 9 of this document.
10
11 "Licensor" shall mean the copyright owner or entity authorized by
12 the copyright owner that is granting the License.
13
14 "Legal Entity" shall mean the union of the acting entity and all
15 other entities that control, are controlled by, or are under common
16 control with that entity. For the purposes of this definition,
17 "control" means (i) the power, direct or indirect, to cause the
18 direction or management of such entity, whether by contract or
19 otherwise, or (ii) ownership of fifty percent (50%) or more of the
20 outstanding shares, or (iii) beneficial ownership of such entity.
21
22 "You" (or "Your") shall mean an individual or Legal Entity
23 exercising permissions granted by this License.
24
25 "Source" form shall mean the preferred form for making modifications,
26 including but not limited to software source code, documentation
27 source, and configuration files.
28
29 "Object" form shall mean any form resulting from mechanical
30 transformation or translation of a Source form, including but
31 not limited to compiled object code, generated documentation,
32 and conversions to other media types.
33
34 "Work" shall mean the work of authorship, whether in Source or
35 Object form, made available under the License, as indicated by a
36 copyright notice that is included in or attached to the work
37 (an example is provided in the Appendix below).
38
39 "Derivative Works" shall mean any work, whether in Source or Object
40 form, that is based on (or derived from) the Work and for which the
41 editorial revisions, annotations, elaborations, or other modifications
42 represent, as a whole, an original work of authorship. For the purposes
43 of this License, Derivative Works shall not include works that remain
44 separable from, or merely link (or bind by name) to the interfaces of,
45 the Work and Derivative Works thereof.
46
47 "Contribution" shall mean any work of authorship, including
48 the original version of the Work and any modifications or additions
49 to that Work or Derivative Works thereof, that is intentionally
50 submitted to Licensor for inclusion in the Work by the copyright owner
51 or by an individual or Legal Entity authorized to submit on behalf of
52 the copyright owner. For the purposes of this definition, "submitted"
53 means any form of electronic, verbal, or written communication sent
54 to the Licensor or its representatives, including but not limited to
55 communication on electronic mailing lists, source code control systems,
56 and issue tracking systems that are managed by, or on behalf of, the
57 Licensor for the purpose of discussing and improving the Work, but
58 excluding communication that is conspicuously marked or otherwise
59 designated in writing by the copyright owner as "Not a Contribution."
60
61 "Contributor" shall mean Licensor and any individual or Legal Entity
62 on behalf of whom a Contribution has been received by Licensor and
63 subsequently incorporated within the Work.
64
65 2. Grant of Copyright License. Subject to the terms and conditions of
66 this License, each Contributor hereby grants to You a perpetual,
67 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
68 copyright license to reproduce, prepare Derivative Works of,
69 publicly display, publicly perform, sublicense, and distribute the
70 Work and such Derivative Works in Source or Object form.
71
72 3. Grant of Patent License. Subject to the terms and conditions of
73 this License, each Contributor hereby grants to You a perpetual,
74 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
75 (except as stated in this section) patent license to make, have made,
76 use, offer to sell, sell, import, and otherwise transfer the Work,
77 where such license applies only to those patent claims licensable
78 by such Contributor that are necessarily infringed by their
79 Contribution(s) alone or by combination of their Contribution(s)
80 with the Work to which such Contribution(s) was submitted. If You
81 institute patent litigation against any entity (including a
82 cross-claim or counterclaim in a lawsuit) alleging that the Work
83 or a Contribution incorporated within the Work constitutes direct
84 or contributory patent infringement, then any patent licenses
85 granted to You under this License for that Work shall terminate
86 as of the date such litigation is filed.
87
88 4. Redistribution. You may reproduce and distribute copies of the
89 Work or Derivative Works thereof in any medium, with or without
90 modifications, and in Source or Object form, provided that You
91 meet the following conditions:
92
93 (a) You must give any other recipients of the Work or
94 Derivative Works a copy of this License; and
95
96 (b) You must cause any modified files to carry prominent notices
97 stating that You changed the files; and
98
99 (c) You must retain, in the Source form of any Derivative Works
100 that You distribute, all copyright, patent, trademark, and
101 attribution notices from the Source form of the Work,
102 excluding those notices that do not pertain to any part of
103 the Derivative Works; and
104
105 (d) If the Work includes a "NOTICE" text file as part of its
106 distribution, then any Derivative Works that You distribute must
107 include a readable copy of the attribution notices contained
108 within such NOTICE file, excluding those notices that do not
109 pertain to any part of the Derivative Works, in at least one
110 of the following places: within a NOTICE text file distributed
111 as part of the Derivative Works; within the Source form or
112 documentation, if provided along with the Derivative Works; or,
113 within a display generated by the Derivative Works, if and
114 wherever such third-party notices normally appear. The contents
115 of the NOTICE file are for informational purposes only and
116 do not modify the License. You may add Your own attribution
117 notices within Derivative Works that You distribute, alongside
118 or as an addendum to the NOTICE text from the Work, provided
119 that such additional attribution notices cannot be construed
120 as modifying the License.
121
122 You may add Your own copyright statement to Your modifications and
123 may provide additional or different license terms and conditions
124 for use, reproduction, or distribution of Your modifications, or
125 for any such Derivative Works as a whole, provided Your use,
126 reproduction, and distribution of the Work otherwise complies with
127 the conditions stated in this License.
128
129 5. Submission of Contributions. Unless You explicitly state otherwise,
130 any Contribution intentionally submitted for inclusion in the Work
131 by You to the Licensor shall be under the terms and conditions of
132 this License, without any additional terms or conditions.
133 Notwithstanding the above, nothing herein shall supersede or modify
134 the terms of any separate license agreement you may have executed
135 with Licensor regarding such Contributions.
136
137 6. Trademarks. This License does not grant permission to use the trade
138 names, trademarks, service marks, or product names of the Licensor,
139 except as required for reasonable and customary use in describing the
140 origin of the Work and reproducing the content of the NOTICE file.
141
142 7. Disclaimer of Warranty. Unless required by applicable law or
143 agreed to in writing, Licensor provides the Work (and each
144 Contributor provides its Contributions) on an "AS IS" BASIS,
145 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
146 implied, including, without limitation, any warranties or conditions
147 of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
148 PARTICULAR PURPOSE. You are solely responsible for determining the
149 appropriateness of using or redistributing the Work and assume any
150 risks associated with Your exercise of permissions under this License.
151
152 8. Limitation of Liability. In no event and under no legal theory,
153 whether in tort (including negligence), contract, or otherwise,
154 unless required by applicable law (such as deliberate and grossly
155 negligent acts) or agreed to in writing, shall any Contributor be
156 liable to You for damages, including any direct, indirect, special,
157 incidental, or consequential damages of any character arising as a
158 result of this License or out of the use or inability to use the
159 Work (including but not limited to damages for loss of goodwill,
160 work stoppage, computer failure or malfunction, or any and all
161 other commercial damages or losses), even if such Contributor
162 has been advised of the possibility of such damages.
163
164 9. Accepting Warranty or Additional Liability. While redistributing
165 the Work or Derivative Works thereof, You may choose to offer,
166 and charge a fee for, acceptance of support, warranty, indemnity,
167 or other liability obligations and/or rights consistent with this
168 License. However, in accepting such obligations, You may act only
169 on Your own behalf and on Your sole responsibility, not on behalf
170 of any other Contributor, and only if You agree to indemnify,
171 defend, and hold each Contributor harmless for any liability
172 incurred by, or claims asserted against, such Contributor by reason
173 of your accepting any such warranty or additional liability.
174
175 END OF TERMS AND CONDITIONS
176
177 APPENDIX: How to apply the Apache License to your work.
178
179 To apply the Apache License to your work, attach the following
180 boilerplate notice, with the fields enclosed by brackets "[]"
181 replaced with your own identifying information. (Don't include
182 the brackets!) The text should be enclosed in the appropriate
183 comment syntax for the file format. We also recommend that a
184 file or class name and description of purpose be included on the
185 same "printed page" as the copyright notice for easier
186 identification within third-party archives.
187
188 Copyright [yyyy] [name of copyright owner]
189
190 Licensed under the Apache License, Version 2.0 (the "License");
191 you may not use this file except in compliance with the License.
192 You may obtain a copy of the License at
193
194 http://www.apache.org/licenses/LICENSE-2.0
195
196 Unless required by applicable law or agreed to in writing, software
197 distributed under the License is distributed on an "AS IS" BASIS,
198 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
199 See the License for the specific language governing permissions and
200 limitations under the License.
+18
-0
MANIFEST less more
0 # Initial manifest generated by Module::Boilerplate
1 lib/Capture/Tiny.pm
2 t/01-Capture-Tiny.t
3 Build.PL
4 LICENSE
5 INSTALL
6 MANIFEST
7 MANIFEST.SKIP
8 README
9 Changes
10 Todo
11 inc/Module/Build/WikiDoc.pm
12 xt/pod-format.t
13 xt/pod-coverage.t
14 xt/critic.t
15 xt/perlcriticrc
16 xt/spelling.t
17 xt/stopwords.txt
+33
-0
MANIFEST.SKIP less more
0 # Copyright (c) 2009 by David Golden. All rights reserved.
1 # Licensed under Apache License, Version 2.0 (the "License").
2 # You may not use this file except in compliance with the License.
3 # A copy of the License was distributed with this file or you may obtain a
4 # copy of the License from http://www.apache.org/licenses/LICENSE-2.0
5
6 # Version control files and dirs.
7 \bRCS\b
8 \bCVS\b
9 ,v$
10 .svn/
11 ^.git
12
13 # Generated by Perl module toolchain
14 ^MANIFEST\.(?!SKIP)
15 ^Makefile$
16 ^blib/
17 ^blibdirs$
18 ^PM_to_blib$
19 ^MakeMaker-\d
20 ^Build$
21 ^_build
22 ^cover_db
23 ^.*\.bat$
24
25 # Temp, old, vi and emacs files.
26 ~$
27 \.old$
28 \#\.*\#$
29 \.\#$
30 \.swp$
31 \.bak$
32 ^pod.*\.tmp$
+7
-0
README less more
0 # Copyright (c) 2009 by David Golden. All rights reserved.
1 # Licensed under Apache License, Version 2.0 (the "License").
2 # You may not use this file except in compliance with the License.
3 # A copy of the License was distributed with this file or you may obtain a
4 # copy of the License from http://www.apache.org/licenses/LICENSE-2.0
5
6
+9
-0
Todo less more
0 # Copyright (c) 2009 by David Golden. All rights reserved.
1 # Licensed under Apache License, Version 2.0 (the "License").
2 # You may not use this file except in compliance with the License.
3 # A copy of the License was distributed with this file or you may obtain a
4 # copy of the License from http://www.apache.org/licenses/LICENSE-2.0
5
6 - Write some code
7 - Write some tests
8 - Replace boilerplate docs with real documentation
+62
-0
inc/Module/Build/WikiDoc.pm less more
0 # Copyright (c) 2009 by David Golden. All rights reserved.
1 # Licensed under Apache License, Version 2.0 (the "License").
2 # You may not use this file except in compliance with the License.
3 # A copy of the License was distributed with this file or you may obtain a
4 # copy of the License from http://www.apache.org/licenses/LICENSE-2.0
5
6 package Module::Build::WikiDoc;
7 use strict;
8 use base qw/Module::Build/;
9 use File::Spec;
10
11 sub ACTION_wikidoc {
12 my $self = shift;
13 eval "use Pod::WikiDoc";
14 if ( $@ eq '' ) {
15 my $parser = Pod::WikiDoc->new({
16 comment_blocks => 1,
17 keywords => { VERSION => $self->dist_version },
18 });
19 for my $src ( keys %{ $self->find_pm_files() } ) {
20 (my $tgt = $src) =~ s{\.pm$}{.pod};
21 $parser->filter( {
22 input => $src,
23 output => $tgt,
24 });
25 print "Creating $tgt\n";
26 $tgt =~ s{\\}{/}g;
27 $self->_add_to_manifest( 'MANIFEST', $tgt );
28 }
29 }
30 else {
31 warn "Pod::WikiDoc not available. Skipping wikidoc.\n";
32 }
33 }
34
35 sub ACTION_test {
36 my $self = shift;
37 my $missing_pod;
38 for my $src ( keys %{ $self->find_pm_files() } ) {
39 (my $tgt = $src) =~ s{\.pm$}{.pod};
40 $missing_pod = 1 if ! -e $tgt;
41 }
42 if ( $missing_pod ) {
43 $self->depends_on('wikidoc');
44 $self->depends_on('build');
45 }
46 $self->SUPER::ACTION_test;
47 }
48
49 sub ACTION_testpod {
50 my $self = shift;
51 $self->depends_on('wikidoc');
52 $self->SUPER::ACTION_testpod;
53 }
54
55 sub ACTION_distmeta {
56 my $self = shift;
57 $self->depends_on('wikidoc');
58 $self->SUPER::ACTION_distmeta;
59 }
60
61 1;
+76
-0
lib/Capture/Tiny.pm less more
0 # Copyright (c) 2009 by David Golden. All rights reserved.
1 # Licensed under Apache License, Version 2.0 (the "License").
2 # You may not use this file except in compliance with the License.
3 # A copy of the License was distributed with this file or you may obtain a
4 # copy of the License from http://www.apache.org/licenses/LICENSE-2.0
5
6 package Capture::Tiny;
7 use strict;
8 use warnings;
9
10 our $VERSION = '0.01';
11 $VERSION = eval $VERSION; ## no critic
12
13 1;
14
15 __END__
16
17 =begin wikidoc
18
19 = NAME
20
21 Capture::Tiny - Add abstract here
22
23 = VERSION
24
25 This documentation describes version %%VERSION%%.
26
27 = SYNOPSIS
28
29 use Capture::Tiny;
30
31 = DESCRIPTION
32
33
34 = USAGE
35
36
37 = BUGS
38
39 Please report any bugs or feature using the CPAN Request Tracker.
40 Bugs can be submitted through the web interface at
41 [http://rt.cpan.org/Dist/Display.html?Queue=Capture-Tiny]
42
43 When submitting a bug or request, please include a test-file or a patch to an
44 existing test-file that illustrates the bug or desired feature.
45
46 = SEE ALSO
47
48
49 = AUTHOR
50
51 David A. Golden (DAGOLDEN)
52
53 = COPYRIGHT AND LICENSE
54
55 Copyright (c) 2009 by David A. Golden. All rights reserved.
56
57 Licensed under Apache License, Version 2.0 (the "License").
58 You may not use this file except in compliance with the License.
59 A copy of the License was distributed with this file or you may obtain a
60 copy of the License from http://www.apache.org/licenses/LICENSE-2.0
61
62 Files produced as output though the use of this software, shall not be
63 considered Derivative Works, but shall be considered the original work of the
64 Licensor.
65
66 Unless required by applicable law or agreed to in writing, software
67 distributed under the License is distributed on an "AS IS" BASIS,
68 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
69 See the License for the specific language governing permissions and
70 limitations under the License.
71
72 =end wikidoc
73
74 =cut
75
+13
-0
t/01-Capture-Tiny.t less more
0 # Copyright (c) 2009 by David Golden. All rights reserved.
1 # Licensed under Apache License, Version 2.0 (the "License").
2 # You may not use this file except in compliance with the License.
3 # A copy of the License was distributed with this file or you may obtain a
4 # copy of the License from http://www.apache.org/licenses/LICENSE-2.0
5
6 use strict;
7 use warnings;
8
9 use Test::More tests => 1;
10
11 require_ok( 'Capture::Tiny' );
12
+15
-0
xt/critic.t less more
0 # Copyright (c) 2009 by David Golden. All rights reserved.
1 # Licensed under Apache License, Version 2.0 (the "License").
2 # You may not use this file except in compliance with the License.
3 # A copy of the License was distributed with this file or you may obtain a
4 # copy of the License from http://www.apache.org/licenses/LICENSE-2.0
5
6 use strict;
7 use warnings;
8 use File::Spec;
9 use Test::More;
10 require Test::Perl::Critic;
11
12 my $rcfile = File::Spec->catfile( 'xt', 'perlcriticrc' );
13 Test::Perl::Critic->import( -profile => $rcfile );
14 all_critic_ok( 'lib', 'examples' );
+20
-0
xt/perlcriticrc less more
0 severity = 5
1 verbose = 8
2
3 [Variables::ProhibitPunctuationVars]
4 allow = $@ $!
5
6 # Turn these off
7 [-BuiltinFunctions::ProhibitStringyEval]
8 [-ControlStructures::ProhibitPostfixControls]
9 [-ControlStructures::ProhibitUnlessBlocks]
10 [-Documentation::RequirePodSections]
11 [-InputOutput::ProhibitInteractiveTest]
12 [-Miscellanea::RequireRcsKeywords]
13 [-References::ProhibitDoubleSigils]
14 [-RegularExpressions::RequireExtendedFormatting]
15 [-InputOutput::ProhibitTwoArgOpen]
16
17 # Turn this on
18 [Lax::ProhibitStringyEval::ExceptForRequire]
19
+29
-0
xt/pod-coverage.t less more
0 # Copyright (c) 2009 by David Golden. All rights reserved.
1 # Licensed under Apache License, Version 2.0 (the "License").
2 # You may not use this file except in compliance with the License.
3 # A copy of the License was distributed with this file or you may obtain a
4 # copy of the License from http://www.apache.org/licenses/LICENSE-2.0
5
6 use Test::More;
7
8 my $min_tpc = 1.08;
9 eval "use Test::Pod::Coverage $min_tpc";
10 plan skip_all => "Test::Pod::Coverage $min_tpc required for testing POD coverage"
11 if $@;
12
13 my $min_pc = 0.17;
14 eval "use Pod::Coverage $min_pc";
15 plan skip_all => "Pod::Coverage $min_pc required for testing POD coverage"
16 if $@;
17
18 my @modules = all_modules('lib');
19
20 plan tests => scalar @modules;
21
22 for my $mod ( @modules ) {
23 my $doc = "lib/$mod";
24 $doc =~ s{::}{/}g;
25 $doc = -f "$doc\.pod" ? "$doc\.pod" : "$doc\.pm" ;
26 pod_coverage_ok( $mod, { pod_from => $doc } );
27 }
28
+13
-0
xt/pod-format.t less more
0 # Copyright (c) 2009 by David Golden. All rights reserved.
1 # Licensed under Apache License, Version 2.0 (the "License").
2 # You may not use this file except in compliance with the License.
3 # A copy of the License was distributed with this file or you may obtain a
4 # copy of the License from http://www.apache.org/licenses/LICENSE-2.0
5
6 use Test::More;
7
8 my $min_tp = 1.22;
9 eval "use Test::Pod $min_tp";
10 plan skip_all => "Test::Pod $min_tp required for testing POD" if $@;
11
12 all_pod_files_ok();
+21
-0
xt/spelling.t less more
0 # Copyright (c) 2009 by David Golden. All rights reserved.
1 # Licensed under Apache License, Version 2.0 (the "License").
2 # You may not use this file except in compliance with the License.
3 # A copy of the License was distributed with this file or you may obtain a
4 # copy of the License from http://www.apache.org/licenses/LICENSE-2.0
5
6 use Test::More;
7 use IO::File;
8
9 my $min_tps = 0.11;
10 eval "use Test::Spelling $min_tps";
11 plan skip_all => "Test::Spelling $min_tps required for testing POD" if $@;
12 system( "ispell -v" ) and plan skip_all => "No ispell";
13
14 set_spell_cmd( "ispell -l" );
15
16 my $swf = IO::File->new('xt/stopwords.txt');
17 my @stopwords = grep { length } map { chomp; $_ } <$swf>;
18 add_stopwords( @stopwords );
19
20 all_pod_files_spelling_ok();
+10
-0
xt/stopwords.txt less more
0 CPAN
1 CTRL
2 DAGOLDEN
3 Foo
4 MSWin
5 README
6 STDERR
7 STDOUT
8 XS
9 html