[Bps-public-commit] Module-Install-RTx branch, master, updated. 0.35-1-g3a83130

[Kevin Falcone]

The branch, master has been updated
       via  3a83130e2c1006f93cab7cb1150aa6eff02c5794 (commit)
      from  5177165d5ae7fb383045a6da2d6069778daefb05 (commit)

Summary of changes:
 META.yml                  |  4 ++--
 README                    | 22 ++++++++++++++++++++++
 lib/Module/Install/RTx.pm | 28 +++++++++++++++++++++++-----
 3 files changed, 47 insertions(+), 7 deletions(-)

- Log -----------------------------------------------------------------
commit 3a83130e2c1006f93cab7cb1150aa6eff02c5794
Author: Kevin Falcone <falcone at bestpractical.com>
Date:   Mon Aug 11 14:57:12 2014 -0400

    Add two new features, deprecated_rt and no_readme_generation
    
    These allow using modern MIRTx on a 3.8 extension (drop the 4.0.0
    minimum version check) and preventing an automatic ReadmeFromPod, useful
    if your main module file shouldn't overwrite your lovingly crafted
    README (RTIR).

diff --git a/META.yml b/META.yml
index 5e3c853..3a31417 100644
--- a/META.yml
+++ b/META.yml
@@ -21,7 +21,7 @@ no_index:
 provides:
   Module::Install::RTx:
     file: lib/Module/Install/RTx.pm
-    version: '0.35'
+    version: 0.35_01
   Module::Install::RTx::Runtime:
     file: lib/Module/Install/RTx/Runtime.pm
 requires:
@@ -29,4 +29,4 @@ requires:
   perl: 5.8.0
 resources:
   license: http://opensource.org/licenses/mit-license.php
-version: '0.35'
+version: 0.35_01
diff --git a/README b/README
index 6780960..0905fca 100644
--- a/README
+++ b/README
@@ -29,6 +29,18 @@ DESCRIPTION
         ./static => $RT::LocalPluginPath/RT-Extension-Example/static
         ./var    => $RT::LocalPluginPath/RT-Extension-Example/var
 
+    Accepts an optional argument hashref after the extension name with two
+    possible keys
+
+    deprecated_rt
+            If set to a true value, skips the enforced RT-4.0.0 minimum version check
+
+            You should set a perl_version if using this option and requires_rt(), because requires_rt
+            only handles figuring our what perl you need if you're on RT 4.0.0 or higher.
+
+    no_readme_generation
+            If set to a true value, will not call readme_from on the extension's primary perl module.
+
   requires_rt *version*
     Takes one argument, a valid RT version. If an attempt is made to install
     on an RT than that version, it will die before Makefile creation.
@@ -92,3 +104,13 @@ COPYRIGHT
     TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
     SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+POD ERRORS
+    Hey! The above document had some coding errors, which are explained
+    below:
+
+    Around line 297:
+        '=item' outside of any '=over'
+
+    Around line 308:
+        You forgot a '=back' before '=head2'
+
diff --git a/lib/Module/Install/RTx.pm b/lib/Module/Install/RTx.pm
index 40cdd76..abf9b0b 100644
--- a/lib/Module/Install/RTx.pm
+++ b/lib/Module/Install/RTx.pm
@@ -7,7 +7,7 @@ no warnings 'once';
 
 use Module::Install::Base;
 use base 'Module::Install::Base';
-our $VERSION = '0.35';
+our $VERSION = '0.35_01';
 
 use FindBin;
 use File::Glob     ();
@@ -17,7 +17,8 @@ my @DIRS = qw(etc lib html static bin sbin po var);
 my @INDEX_DIRS = qw(lib bin sbin);
 
 sub RTx {
-    my ( $self, $name ) = @_;
+    my ( $self, $name, $extra_args ) = @_;
+    $extra_args ||= {};
 
     # Set up names
     my $fname = $name;
@@ -29,8 +30,10 @@ sub RTx {
         unless $self->version;
     $self->abstract("$name Extension")
         unless $self->abstract;
-    $self->readme_from( "lib/$fname.pm",
-                        { options => [ quotes => "none" ] } );
+    unless ( $extra_args->{no_readme_generation} ) {
+        $self->readme_from( "lib/$fname.pm",
+                            { options => [ quotes => "none" ] } );
+    }
     $self->add_metadata("x_module_install_rtx_version", $VERSION );
 
     # Try to find RT.pm
@@ -61,7 +64,9 @@ sub RTx {
     unshift @INC, $lib_path;
 
     # Set a baseline minimum version
-    $self->requires_rt('4.0.0');
+    unless ( $extra_args->{deprecated_rt} ) {
+        $self->requires_rt('4.0.0');
+    }
 
     # Installation locations
     my %path;
@@ -287,6 +292,19 @@ they exist (assuming C<RTx('RT-Extension-Example')>):
     ./static => $RT::LocalPluginPath/RT-Extension-Example/static
     ./var    => $RT::LocalPluginPath/RT-Extension-Example/var
 
+Accepts an optional argument hashref after the extension name with two possible keys
+
+=item deprecated_rt
+
+    If set to a true value, skips the enforced RT-4.0.0 minimum version check
+
+    You should set a perl_version if using this option and requires_rt(), because requires_rt
+    only handles figuring our what perl you need if you're on RT 4.0.0 or higher.
+
+=item no_readme_generation
+
+    If set to a true value, will not call readme_from on the extension's primary perl module.
+
 =head2 requires_rt I<version>
 
 Takes one argument, a valid RT version. If an attempt is made to install

-----------------------------------------------------------------------