NAME
File::SubPM - support sub program modules as files in a sub directory
SYNOPSIS
use File::SubPM
@sub_modules = File::FileUtil->sub_modules($base_file, @dirs)
$module = File::FileUtil->is_module($module, @modules)DESCRIPTION
is_module method
$driver = Test::TestUtil->is_module($module, @modules)The is_module method determines if $module is present in @modules. The detemination is case insensitive and only the leading characters are needed.
sub_modules method
@sub_modules = File::FileUtil->sub_modules($base_file, @dirs)Placing sub modules in their own private directory provides a method to add a new sub_modules without changing the using module. The parent object finds all the available sub_modules by listing the modules in the sub_module directory using the sub_modules method.
The sub_modules method takes as its input a $base_file, a file in the parent directory, and a list of subdirectories, @dirs, relative to the $base_file. It returns the a list, @sub_modules, of *.pm file names stripped of the extension .pm in the identified directory.
REQUIREMENTS
Coming soon.
DEMONSTRATION
~~~~~~ Demonstration overview ~~~~~Perl code begins with the prompt
=>The selected results from executing the Perl Code follow on the next lines. For example,
=> 2 + 2
4
~~~~~~ The demonstration follows ~~~~~
=> use File::Spec;
=> use File::Package;
=> my $fp = 'File::Package';
=> my $sm = 'File::SubPM';
=> my $loaded = '';
=> my $errors = $fp->load_package( $sm )
=> $errors
''
=> my @drivers = sort $sm->sub_modules( __FILE__, 'Drivers' )
=> join (', ', @drivers)
'Driver, Generate, IO'
=> $sm->is_module('dri', @drivers )
'Driver'QUALITY ASSURANCE
The module "t::File::SubPM" is the Software Test Description(STD) module for the "File::SubPM". module.
To generate all the test output files, run the generated test script, run the demonstration script and include it results in the "File::SubPM" POD, execute the following in any directory:
tmake -test_verbose -replace -run -pm=t::File::SubPMNote that tmake.pl must be in the execution path $ENV{PATH} and the "t" directory containing "t::File::SubPM" on the same level as the "lib" directory that contains the "File::SubPM" module.
NOTES
AUTHOR
The holder of the copyright and maintainer is
<support@SoftwareDiamonds.com>
COPYRIGHT NOTICE
Copyrighted (c) 2002 Software Diamonds
All Rights Reserved
BINDING REQUIREMENTS NOTICE
Binding requirements are indexed with the pharse 'shall[dd]' where dd is an unique number for each header section. This conforms to standard federal government practices, 490A ("3.2.3.6" in STD490A). In accordance with the License, Software Diamonds is not liable for any requirement, binding or otherwise.
LICENSE
Software Diamonds permits the redistribution and use in source and binary forms, with or without modification, provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
SOFTWARE DIAMONDS, http::www.softwarediamonds.com, PROVIDES THIS SOFTWARE 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SOFTWARE DIAMONDS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING USE OF THIS SOFTWARE, EVEN IF ADVISED OF NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE POSSIBILITY OF SUCH DAMAGE.