Эх сурвалжийг харах

Merge pull request #117 from gempesaw/weaver

Fix #114 - use podweaver for repeated documentation
Daniel Gempesaw 11 жил өмнө
parent
commit
c935b67f5e

+ 8 - 0
.mailmap

@@ -0,0 +1,8 @@
+Aditya Ivaturi <ivaturi@gmail.com> <aivaturi@juniper.net>
+Charles Howes <charles.howes@globalrelay.net> <git-author@ch.pkts.ca>
+Charles Howes <charles.howes@globalrelay.net> <github.com@ch.pkts.ca>
+Daniel Gempesaw <gempesaw@gmail.com>
+Daniel Gempesaw <gempesaw@gmail.com> <dgempesaw@sharecare.com>
+Gordon Child <gordon@gordonchild.com> <gordon@cpanel.net>
+Gordon Child <gordon@gordonchild.com> <gchild@solutionstream.com>
+Mark Stosberg <mark@stosberg.com> <mark@summersault.com>

+ 33 - 9
dist.ini

@@ -1,14 +1,15 @@
 name = Selenium-Remote-Driver
-version = 0.18
-author = 'Aditya Ivaturi <ivaturi@gmail.com>'
-author = 'Daniel Gempesaw <gempesaw@gmail.com>'
-author = 'Luke Closs <cpan@5thplane.com>'
-author = 'Mark Stosberg <mark@stosberg.com>'
-
+version = 0.19
+author = Aditya Ivaturi <ivaturi@gmail.com>
+author = Daniel Gempesaw <gempesaw@gmail.com>
+author = Luke Closs <cpan@5thplane.com>
+author = Mark Stosberg <mark@stosberg.com>
 license = Apache_2_0
 copyright_holder = Daniel Gempesaw
+copyright_year = 2014
 
 [TravisYML]
+build_branch = cpan
 
 [Git::Check]
 [Git::Commit]
@@ -31,17 +32,40 @@ include_dotfiles = 1
 [MetaYAML]
 [PkgVersion]
 
+[ContributorsFromGit]
+
+; skip the Test::SRD modules, their attribution is non-standard
+[FileFinder::ByName / :NotTestSRD]
+dir = lib
+match = \.pm$
+skip = Test
+
+; `dzil authordeps` doesn't pick up the Pod Weaver deps:
+; authordep Pod::Weaver::Section::Contributors = 0
+; authordep Pod::Weaver::Plugin::Encoding = 0
+; authordep Pod::Weaver::Section::GenerateSection = 0
+; authordep Pod::Elemental::Transformer::List = 0
+[PodWeaver]
+finder = :NotTestSRD
+
+[ReadmeAnyFromPod]
+type = markdown
+filename = README.md
+location = build
+
+[CopyFilesFromBuild]
+copy = README.md
+
 [PruneCruft]
 except = \.travis.yml
 
 [PodCoverageTests]
 [PodSyntaxTests]
-[PodVersion]
 
 [TestRelease]
 [ConfirmRelease]
-; [FakeRelease]
-[UploadToCPAN]
+[FakeRelease]
+; [UploadToCPAN]
 
 [Prereqs / RuntimeRequires]
 perl = 5.010

+ 2 - 40
lib/Selenium/Remote/Commands.pm

@@ -1,5 +1,7 @@
 package Selenium::Remote::Commands;
 
+# ABSTRACT: Implement commands for Selenium::Remote::Driver
+
 use Moo;
 
 has '_cmds' => (
@@ -330,43 +332,3 @@ sub get_params {
 1;
 
 __END__
-
-=pod
-
-=head1 NAME
-
-Selenium::Remote::Commands - Implement commands for Selenium::Remote::Driver
-
-=head1 SEE ALSO
-
-For more information about Selenium , visit the website at
-L<http://code.google.com/p/selenium/>.
-
-=head1 BUGS
-
-The Selenium issue tracking system is available online at
-L<http://github.com/gempesaw/Selenium-Remote-Driver/issues>.
-
-=head1 CURRENT MAINTAINER
-
-Daniel Gempesaw C<< <gempesaw@gmail.com> >>
-
-=head1 AUTHOR
-
-Perl Bindings for Selenium Remote Driver by Aditya Ivaturi C<< <ivaturi@gmail.com> >>
-
-=head1 LICENSE
-
-Copyright (c) 2010-2011 Aditya Ivaturi, Gordon Child
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

+ 2 - 53
lib/Selenium/Remote/Driver.pm

@@ -1,5 +1,7 @@
 package Selenium::Remote::Driver;
 
+# ABSTRACT: Perl Client for Selenium Remote Driver
+
 use Moo;
 use Try::Tiny;
 
@@ -32,12 +34,6 @@ use constant FINDERS => {
     xpath             => 'xpath',
 };
 
-=head1 NAME
-
-Selenium::Remote::Driver - Perl Client for Selenium Remote Driver
-
-=cut
-
 =head1 SYNOPSIS
 
     use Selenium::Remote::Driver;
@@ -2083,50 +2079,3 @@ L<https://github.com/gempesaw/Selenium-Remote-Driver/wiki>.
 
 The Selenium issue tracking system is available online at
 L<http://github.com/gempesaw/Selenium-Remote-Driver/issues>.
-
-=head1 AUTHOR
-
-Perl Bindings for Selenium Remote Driver by Aditya Ivaturi C<< <ivaturi@gmail.com> >>
-
-=head1 ACKNOWLEDGEMENTS
-
-The following people have contributed to this module. (Thanks!)
-
-=over 4
-
-=item * Gordon Child
-
-=item * Daniel Gempesaw
-
-=item * Charles Howes
-
-=item * Tom Hukins
-
-=item * Phil Kania
-
-=item * Allen Lew
-
-=item * Phil Mitchell
-
-=item * Emmanuel Peroumalnaik
-
-=item * Mark Stosberg
-
-=back
-
-=head1 LICENSE
-
-Copyright (c) 2010-2011 Aditya Ivaturi, Gordon Child
-Copyright (c) 2014      Daniel Gempesaw
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

+ 2 - 40
lib/Selenium/Remote/ErrorHandler.pm

@@ -1,5 +1,7 @@
 package Selenium::Remote::ErrorHandler;
 
+# ABSTRACT: Error handler for Selenium::Remote::Driver
+
 use Moo;
 use Carp qw(croak);
 
@@ -131,43 +133,3 @@ sub process_error {
 1;
 
 __END__
-
-=pod
-
-=head1 NAME
-
-Selenium::Remote::ErrorHandler - Error handler for Selenium::Remote::Driver
-
-=head1 SEE ALSO
-
-For more information about Selenium , visit the website at
-L<http://code.google.com/p/selenium/>.
-
-=head1 BUGS
-
-The Selenium issue tracking system is available online at
-L<http://github.com/gempesaw/Selenium-Remote-Driver/issues>.
-
-=head1 CURRENT MAINTAINER
-
-Daniel Gempesaw C<< <gempesaw@gmail.com> >>
-
-=head1 AUTHOR
-
-Perl Bindings for Remote Driver by Aditya Ivaturi C<< <ivaturi@gmail.com> >>
-
-=head1 LICENSE
-
-Copyright (c) 2010-2011 Aditya Ivaturi, Gordon Child
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

+ 2 - 40
lib/Selenium/Remote/RemoteConnection.pm

@@ -1,5 +1,7 @@
 package Selenium::Remote::RemoteConnection;
 
+#ABSTRACT: Connect to a selenium server
+
 use Moo;
 use Try::Tiny;
 use LWP::UserAgent;
@@ -146,43 +148,3 @@ sub _process_response {
 1;
 
 __END__
-
-=pod
-
-=head1 NAME
-
-Selenium::Remote::RemoteConnection - Connect to a selenium server
-
-=head1 SEE ALSO
-
-For more information about Selenium, visit the website at
-L<http://code.google.com/p/selenium/>.
-
-=head1 BUGS
-
-The Selenium issue tracking system is available online at
-L<http://github.com/gempesaw/Selenium-Remote-Driver/issues>.
-
-=head1 CURRENT MAINTAINER
-
-Daniel Gempesaw C<< <gempesaw@gmail.com> >>
-
-=head1 AUTHOR
-
-Perl Bindings for Selenium Remote Driver by Aditya Ivaturi C<< <ivaturi@gmail.com> >>
-
-=head1 LICENSE
-
-Copyright (c) 2010-2011 Aditya Ivaturi, Gordon Child
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

+ 1 - 5
lib/Selenium/Remote/WDKeys.pm

@@ -1,10 +1,6 @@
 package Selenium::Remote::WDKeys;
 
-=head1 NAME
-
-Selenium::Remote::WDKeys - Representation of keystrokes used by Selenium::Remote::WebDriver
-
-=cut
+# ABSTRACT: Representation of keystrokes used by Selenium::Remote::WebDriver
 
 =head1 DESCRIPTION
 

+ 2 - 42
lib/Selenium/Remote/WebElement.pm

@@ -1,14 +1,10 @@
 package Selenium::Remote::WebElement;
 
+# ABSTRACT: Representation of an HTML Element used by Selenium Remote Driver
+
 use Moo;
 use Carp qw(croak);
 
-=head1 NAME
-
-Selenium::Remote::WebElement - Representation of an HTML Element used by Selenium Remote Driver
-
-=cut
-
 =head1 DESCRIPTION
 
 Selenium Webdriver represents all the HTML elements as WebElement. This module
@@ -444,39 +440,3 @@ sub describe {
 }
 
 1;
-
-=head1 SEE ALSO
-
-For more information about Selenium , visit the website at
-L<http://code.google.com/p/selenium/>.
-
-=head1 BUGS
-
-The Selenium issue tracking system is available online at
-L<http://github.com/gempesaw/Selenium-Remote-Driver/issues>.
-
-=head1 CURRENT MAINTAINER
-
-Daniel Gempesaw C<< <gempesaw@gmail.com> >>
-
-=head1 AUTHOR
-
-Perl Bindings for Selenium Remote Driver by Aditya Ivaturi C<< <ivaturi@gmail.com> >>
-
-=head1 LICENSE
-
-Copyright (c) 2010-2011 Aditya Ivaturi, Gordon Child
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-480:    hit eof while in pod documentation (no =cut seen)
-        this can cause trouble with some pod utilities

+ 2 - 6
lib/Test/Selenium/Remote/WebElement.pm

@@ -1,5 +1,7 @@
 package Test::Selenium::Remote::WebElement;
 
+# ABSTRACT: A sub-class of L<Selenium::Remote::WebElement>, with several test-specific method additions.
+
 use parent 'Selenium::Remote::WebElement';
 use Moo;
 use Test::Builder;
@@ -179,14 +181,8 @@ sub attribute_unlike {
 
 __END__
 
-=head1 NAME
-
-Test::Selenium::Remote::WebElement
-
 =head1 DESCRIPTION
 
-A sub-class of L<Selenium::Remote::WebElement>, with several test-specific method additions.
-
 This is an I<experimental> addition to the Selenium::Remote::Driver
 distribution, and some interfaces may change.
 

+ 56 - 0
weaver.ini

@@ -0,0 +1,56 @@
+[@CorePrep]
+
+[-SingleEncoding]
+
+[Name]
+[Version]
+
+[Region  / prelude]
+
+[Generic / SYNOPSIS]
+[Generic / DESCRIPTION]
+[Generic / OVERVIEW]
+
+[Collect / ATTRIBUTES]
+command = attr
+
+[Collect / METHODS]
+command = method
+
+[Collect / FUNCTIONS]
+command = func
+
+[Leftovers]
+
+[GenerateSection / SEE ALSO]
+text = For more information about Selenium , visit the website at
+text = L<http://code.google.com/p/selenium/>.
+
+[GenerateSection / BUGS]
+text = The Selenium issue tracking system is available online at
+text = L<http://github.com/gempesaw/Selenium-Remote-Driver/issues>.
+
+[Region  / postlude]
+
+[Authors]
+[Contributors]
+[GenerateSection / COPYRIGHT AND LICENSE]
+text = Copyright (c) 2010-2011 Aditya Ivaturi, Gordon Child
+text =
+text = Copyright (c) 2014 Daniel Gempesaw
+text =
+text = Licensed under the Apache License, Version 2.0 (the "License");
+text = you may not use this file except in compliance with the License.
+text = You may obtain a copy of the License at
+text =
+text =      http://www.apache.org/licenses/LICENSE-2.0
+text =
+text = Unless required by applicable law or agreed to in writing, software
+text = distributed under the License is distributed on an "AS IS" BASIS,
+text = WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+text = See the License for the specific language governing permissions and
+text = limitations under the License.
+
+
+[-Transformer]
+transformer = List