From 27b7fe27c99d8cd75e6f5a4b02262410c9feb958 2012-05-09 14:24:50 From: Jani Honkonen Date: 2012-05-09 14:24:50 Subject: [PATCH] Added Config::Tiny as a local module. This removes the dependency to install any extra modules on perl. --- diff --git a/test/scripts/Jobs.pm b/test/scripts/Jobs.pm index ed15c72..e2021da 100644 --- a/test/scripts/Jobs.pm +++ b/test/scripts/Jobs.pm @@ -1,6 +1,6 @@ package Jobs; use File::Basename; -use Config::Tiny; +use Tiny; sub get { my $inifile = shift; diff --git a/test/scripts/Tiny.pm b/test/scripts/Tiny.pm new file mode 100644 index 0000000..2496129 --- /dev/null +++ b/test/scripts/Tiny.pm @@ -0,0 +1,280 @@ +package Config::Tiny; + +# If you thought Config::Simple was small... + +use strict; +BEGIN { + require 5.004; + $Config::Tiny::VERSION = '2.14'; + $Config::Tiny::errstr = ''; +} + +# Create an empty object +sub new { bless {}, shift } + +# Create an object from a file +sub read { + my $class = ref $_[0] ? ref shift : shift; + + # Check the file + my $file = shift or return $class->_error( 'You did not specify a file name' ); + return $class->_error( "File '$file' does not exist" ) unless -e $file; + return $class->_error( "'$file' is a directory, not a file" ) unless -f _; + return $class->_error( "Insufficient permissions to read '$file'" ) unless -r _; + + # Slurp in the file + local $/ = undef; + open( CFG, $file ) or return $class->_error( "Failed to open file '$file': $!" ); + my $contents = ; + close( CFG ); + + $class->read_string( $contents ); +} + +# Create an object from a string +sub read_string { + my $class = ref $_[0] ? ref shift : shift; + my $self = bless {}, $class; + return undef unless defined $_[0]; + + # Parse the file + my $ns = '_'; + my $counter = 0; + foreach ( split /(?:\015{1,2}\012|\015|\012)/, shift ) { + $counter++; + + # Skip comments and empty lines + next if /^\s*(?:\#|\;|$)/; + + # Remove inline comments + s/\s\;\s.+$//g; + + # Handle section headers + if ( /^\s*\[\s*(.+?)\s*\]\s*$/ ) { + # Create the sub-hash if it doesn't exist. + # Without this sections without keys will not + # appear at all in the completed struct. + $self->{$ns = $1} ||= {}; + next; + } + + # Handle properties + if ( /^\s*([^=]+?)\s*=\s*(.*?)\s*$/ ) { + $self->{$ns}->{$1} = $2; + next; + } + + return $self->_error( "Syntax error at line $counter: '$_'" ); + } + + $self; +} + +# Save an object to a file +sub write { + my $self = shift; + my $file = shift or return $self->_error( + 'No file name provided' + ); + + # Write it to the file + my $string = $self->write_string; + return undef unless defined $string; + open( CFG, '>' . $file ) or return $self->_error( + "Failed to open file '$file' for writing: $!" + ); + print CFG $string; + close CFG; +} + +# Save an object to a string +sub write_string { + my $self = shift; + + my $contents = ''; + foreach my $section ( sort { (($b eq '_') <=> ($a eq '_')) || ($a cmp $b) } keys %$self ) { + # Check for several known-bad situations with the section + # 1. Leading whitespace + # 2. Trailing whitespace + # 3. Newlines in section name + return $self->_error( + "Illegal whitespace in section name '$section'" + ) if $section =~ /(?:^\s|\n|\s$)/s; + my $block = $self->{$section}; + $contents .= "\n" if length $contents; + $contents .= "[$section]\n" unless $section eq '_'; + foreach my $property ( sort keys %$block ) { + return $self->_error( + "Illegal newlines in property '$section.$property'" + ) if $block->{$property} =~ /(?:\012|\015)/s; + $contents .= "$property=$block->{$property}\n"; + } + } + + $contents; +} + +# Error handling +sub errstr { $Config::Tiny::errstr } +sub _error { $Config::Tiny::errstr = $_[1]; undef } + +1; + +__END__ + +=pod + +=head1 NAME + +Config::Tiny - Read/Write .ini style files with as little code as possible + +=head1 SYNOPSIS + + # In your configuration file + rootproperty=blah + + [section] + one=twp + three= four + Foo =Bar + empty= + + # In your program + use Config::Tiny; + + # Create a config + my $Config = Config::Tiny->new; + + # Open the config + $Config = Config::Tiny->read( 'file.conf' ); + + # Reading properties + my $rootproperty = $Config->{_}->{rootproperty}; + my $one = $Config->{section}->{one}; + my $Foo = $Config->{section}->{Foo}; + + # Changing data + $Config->{newsection} = { this => 'that' }; # Add a section + $Config->{section}->{Foo} = 'Not Bar!'; # Change a value + delete $Config->{_}; # Delete a value or section + + # Save a config + $Config->write( 'file.conf' ); + +=head1 DESCRIPTION + +C is a perl class to read and write .ini style configuration +files with as little code as possible, reducing load time and memory +overhead. Most of the time it is accepted that Perl applications use a lot +of memory and modules. The C<::Tiny> family of modules is specifically +intended to provide an ultralight alternative to the standard modules. + +This module is primarily for reading human written files, and anything we +write shouldn't need to have documentation/comments. If you need something +with more power move up to L, L or one of +the many other C modules. To rephrase, L does B +preserve your comments, whitespace, or the order of your config file. + +=head1 CONFIGURATION FILE SYNTAX + +Files are the same format as for windows .ini files. For example: + + [section] + var1=value1 + var2=value2 + +If a property is outside of a section at the beginning of a file, it will +be assigned to the C<"root section">, available at C<$Config-E{_}>. + +Lines starting with C<'#'> or C<';'> are considered comments and ignored, +as are blank lines. + +When writing back to the config file, all comments, custom whitespace, +and the ordering of your config file elements is discarded. If you need +to keep the human elements of a config when writing back, upgrade to +something better, this module is not for you. + +=head1 METHODS + +=head2 new + +The constructor C creates and returns an empty C object. + +=head2 read $filename + +The C constructor reads a config file, and returns a new +C object containing the properties in the file. + +Returns the object on success, or C on error. + +When C fails, C sets an error message internally +you can recover via Cerrstr>. Although in B +cases a failed C will also set the operating system error +variable C<$!>, not all errors do and you should not rely on using +the C<$!> variable. + +=head2 read_string $string; + +The C method takes as argument the contents of a config file +as a string and returns the C object for it. + +=head2 write $filename + +The C method generates the file content for the properties, and +writes it to disk to the filename specified. + +Returns true on success or C on error. + +=head2 write_string + +Generates the file content for the object and returns it as a string. + +=head2 errstr + +When an error occurs, you can retrieve the error message either from the +C<$Config::Tiny::errstr> variable, or using the C method. + +=head1 CAVEATS + +=head2 Unsupported Section Headers + +Some edge cases in section headers are not support, and additionally may not +be detected when writing the config file. + +Specifically, section headers with leading whitespace, trailing whitespace, +or newlines anywhere in the section header, will not be written correctly +to the file and may cause file corruption. + +=head1 SUPPORT + +Bugs should be reported via the CPAN bug tracker at + +L + +For other issues, or commercial enhancement or support, contact the author. + +=head1 AUTHOR + +Adam Kennedy Eadamk@cpan.orgE + +=head1 ACKNOWLEGEMENTS + +Thanks to Sherzod Ruzmetov Esherzodr@cpan.orgE for +L, which inspired this module by being not quite +"simple" enough for me :) + +=head1 SEE ALSO + +L, L, L + +=head1 COPYRIGHT + +Copyright 2002 - 2011 Adam Kennedy. + +This program is free software; you can redistribute +it and/or modify it under the same terms as Perl itself. + +The full text of the license can be found in the +LICENSE file included with this module. + +=cut