Parse-PlainConfig-2.06/0000755000014400001440000000000011055444416014440 5ustar acorlissusersParse-PlainConfig-2.06/t/0000755000014400001440000000000011055444416014703 5ustar acorlissusersParse-PlainConfig-2.06/t/06_scalar.t0000644000014400001440000000507710435577707016666 0ustar acorlissusers# 06_scalar.t # # Tests for proper extraction of scalar values use Parse::PlainConfig; $|++; print "1..13\n"; my $test = 1; my $rcfile = './t/testrc'; my $conf = Parse::PlainConfig->new(FILE => $rcfile); # First series with smart parser off # # 1 scalar 1 $conf->read($rcfile); $conf->parameter("SCALAR 1") eq "value1" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 scalar 2 $conf->parameter("SCALAR 2") eq "these, are, all one => value" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 3 scalar 3 $conf->parameter("SCALAR 3") eq "this is a continued line." ? print "ok $test\n" : print "not ok $test\n"; $test++; # 4 scalar 4 $conf->parameter("SCALAR 4") eq "ASDFKAS234123098ASDFA9082341ASDFIO23489078907SFASDF8A972" ? print "ok $test\n" : print "not ok $test\n"; $test++; # Second series with smart parser on # # 5 scalar 1 $conf->property(SMART_PARSER => 1); $conf->property(AUTOPURGE => 1); $conf->read("${rcfile}_smart"); $conf->parameter("SCALAR 1") eq "value1" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 6 scalar 2 $conf->parameter("SCALAR 2") eq "these, are, all one => value" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 7 scalar 3 $conf->parameter("SCALAR 3") eq "this is a continued line." ? print "ok $test\n" : print "not ok $test\n"; $test++; # 8 scalar 4 $conf->parameter("SCALAR 4") eq "ASDFKAS234123098ASDFA9082341ASDFIO23489078907SFASDF8A972" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 9 scalar 2 with scalar coercion set and smart parsing $conf->coerce("string", "SCALAR 2"); $conf->read; $conf->parameter("SCALAR 2") eq '"these, are, all one => value"' ? print "ok $test\n" : print "not ok $test\n"; $test++; # Set tests # # 10 new scalar 1 $conf->parameter("NEW SCALAR 1", "this is new"); $conf->parameter("NEW SCALAR 1") eq "this is new" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 11 new scalar 2 with coercion set $conf->coerce("string", "NEW SCALAR 2"); $conf->parameter("NEW SCALAR 2", "this is also new"); $conf->parameter("NEW SCALAR 2") eq "this is also new" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 12 new scalar 2 with list value $conf->parameter("NEW SCALAR 2", [qw(this is new again)]); $conf->parameter("NEW SCALAR 2") eq "this , is , new , again" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 13 new scalar 2 with hash value $conf->parameter("NEW SCALAR 2", {qw(this is new indeed)}); $conf->parameter("NEW SCALAR 2") eq "new => indeed , this => is" ? print "ok $test\n" : print "not ok $test\n"; $test++; # end 06_scalar.t Parse-PlainConfig-2.06/t/15_defaults.t0000644000014400001440000000106010535202773017201 0ustar acorlissusers# 15_defaults.t # # Test the defaults capability use Parse::PlainConfig; $|++; print "1..2\n"; my $test = 1; my $conf = new Parse::PlainConfig; my $testrc = "./t/testrc"; my ($val, $val2); $conf->read($testrc); $conf->property(DEFAULTS => { NOT_PRESENT => 1, }); # 1 Test defaults $val = $conf->parameter('NOT_PRESENT'); $val == 1 ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 Test present key $val = $conf->parameter('SCALAR 1'); $val eq 'value1' ? print "ok $test\n" : print "not ok $test\n"; $test++; # end 15_defaults.t Parse-PlainConfig-2.06/t/03_read.t0000644000014400001440000000072110435577707016320 0ustar acorlissusers# 03_read.t # # Tests the read method use Parse::PlainConfig; $|++; print "1..2\n"; my $test = 1; my $testrc = "./t/testrc"; my $conf = new Parse::PlainConfig; # 1 Read failure (non-existent file) $rv = $conf->read("${testrc}-1"); ! $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 Read test $rv = $conf->read($testrc); $rv && grep(/^SCALAR 1$/, $conf->parameters) ? print "ok $test\n" : print "not ok $test\n"; $test++; # end 03_read.t Parse-PlainConfig-2.06/t/08_hash.t0000644000014400001440000000245110435577707016337 0ustar acorlissusers# 08_hash.t # # Tests for proper extraction of hash values use Parse::PlainConfig; $|++; print "1..6\n"; my $test = 1; my $rcfile = './t/testrc'; my $conf = Parse::PlainConfig->new(FILE => $rcfile); $conf->read($rcfile); my %hash = ( $conf->parameter("HASH 1") ); # 1 hash 1 $hash{two} eq "2" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 hash 1 $hash{three} eq "Three for Me! 3 => 2" ? print "ok $test\n" : print "not ok $test\n"; $test++; # Set tests # # 3 new hash 1 $conf->parameter('NEW HASH 1', { 'foo' => 'bar' }); %hash = $conf->parameter('NEW HASH 1'); $hash{foo} eq "bar" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 4 new hash 2 with coercion set $conf->coerce('hash', 'NEW HASH 2'); $conf->parameter('NEW HASH 2', { 'foo' => 'bar' }); %hash = $conf->parameter('NEW HASH 2'); $hash{foo} eq "bar" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 5 new hash 2 with string value $conf->parameter('NEW HASH 2', "bar => foo"); %hash = $conf->parameter('NEW HASH 2'); $hash{bar} eq "foo" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 6 new hash 2 with list value $conf->parameter('NEW HASH 2', [qw(foo bar roo)]); %hash = $conf->parameter('NEW HASH 2'); $hash{foo} eq "bar" ? print "ok $test\n" : print "not ok $test\n"; $test++; # end 08_hash.t Parse-PlainConfig-2.06/t/07_list.t0000644000014400001440000000377310435577707016376 0ustar acorlissusers# 07_list.t # # Tests for proper extraction of scalar values use Parse::PlainConfig; $|++; print "1..10\n"; my $test = 1; my $rcfile = './t/testrc'; my $conf = Parse::PlainConfig->new(FILE => $rcfile); # First series with smart parser off # # 1 list 1 $conf->read($rcfile); ($conf->parameter("LIST 1"))[2] eq "value3" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 list 2 ($conf->parameter("LIST 2"))[1] eq "two, parts" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 3 list 3 ($conf->parameter("LIST 3"))[2] eq "two => parts" ? print "ok $test\n" : print "not ok $test\n"; $test++; # Second series with smart parser on # # 4 list 1 $conf->property(SMART_PARSER => 1); $conf->property(AUTOPURGE => 1); $conf->read("${rcfile}_smart"); ($conf->parameter("LIST 1"))[2] eq "value3" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 5 list 2 ($conf->parameter("LIST 2"))[1] eq "two, parts" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 6 list 3 with list coercion set and smart parsing $conf->coerce("list", "LIST 3"); $conf->read; ($conf->parameter("LIST 3"))[2] eq "two => parts" ? print "ok $test\n" : print "not ok $test\n"; $test++; # Set tests # # 7 new list 1 $conf->parameter("NEW LIST 1", [qw(this is a new list)]); ($conf->parameter("NEW LIST 1"))[2] eq "a" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 8 new list 2 with coercion set $conf->coerce("list", "NEW LIST 2"); $conf->parameter("NEW LIST 2", [qw(this is a new list)]); ($conf->parameter("NEW LIST 2"))[2] eq "a" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 9 new list 2 with string value $conf->parameter("NEW LIST 2", "this is new"); ($conf->parameter("NEW LIST 2"))[0] eq "this is new" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 10 new list 2 with hash value $conf->parameter("NEW LIST 2", { 'this' => 'is', 'also' => 'new' }); ($conf->parameter("NEW LIST 2"))[2] eq "this" ? print "ok $test\n" : print "not ok $test\n"; $test++; # end 07_list.t Parse-PlainConfig-2.06/t/02_property.t0000644000014400001440000000347410471011373017256 0ustar acorlissusers# 02_property.t # # Tests the property method use Parse::PlainConfig; $|++; print "1..17\n"; my $test = 1; my $conf = new Parse::PlainConfig; my @valScalar = qw(PARAM_DELIM LIST_DELIM HASH_DELIM AUTOPURGE SMART_PARSER PADDING FILE MTIME); my $rv; # Test invalid properties # # 1 Calling FOO should cause it to croak $rv = eval { $conf->property(FOO => "bar") }; ! defined $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 Call a scalar property with a non-scalar value $rv = $conf->property(PARAM_DELIM => []); ! $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 3 Call a list property with a non-list reference value $rv = $conf->property(ORDER => "foo"); ! $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 4 Call a hash property with a non-hash reference value $rv = $conf->property(COERCE => []); ! $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 5 Try to coerce a parameter to an unknown data type $rv = $conf->property(COERCE => { FOO => 'bar' }); ! $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # Test valid properties # # 6 .. 13 Scalar value properties foreach (@valScalar) { $rv = $conf->property($_ => "foo"); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; } # 14 List value properties $rv = $conf->property(ORDER => [qw(FOO BAR ROO)]); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 15 Hash value properties $rv = $conf->property(COERCE => { FOO => 'list', BAR => 'string', ROO => 'hash', }); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 16 .. 17 MAX_BYTES $rv = $conf->property(MAX_BYTES => 512); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; $rv = $conf->read("./t/testrc"); ! $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # end 02_property.t Parse-PlainConfig-2.06/t/testrc_smart0000644000014400001440000000074510435577707017361 0ustar acorlissusers# Scalar tests SCALAR 1: value1 SCALAR 2: "these, are, all one => value" SCALAR 3: this is a continued line. SCALAR 4: ASDFKAS234123098ASDFA9082341 ASDFIO23489078907SFASDF8A972 # List tests LIST 1: value1, value2, value3 LIST 2: value1, "two, parts", value3, "\"two => parts\"" LIST 3: value1, "two, parts", two => parts # Hash tests HASH 1: one => 1, two => 2, three => "Three for Me! 3 => 2", four => 4 Parse-PlainConfig-2.06/t/14_compat.t0000644000014400001440000000323610461475453016670 0ustar acorlissusers# 14_compat.t # # Tests the traditional usage for backwards compatibility use Parse::PlainConfig; $|++; print "1..9\n"; my $test = 1; my $conf = new Parse::PlainConfig; my $testrc = "./t/testrc"; my ($val, $val2); $conf->read($testrc); # 1 Test purge property set $conf->purge(1); $conf->property("AUTOPURGE") ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 Test FORCE_SCALAR property $conf->property("FORCE_SCALAR", ["SCALAR 1", "SCALAR 2"]); $val = $conf->property("COERCE"); $$val{'SCALAR 1'} eq 'string' ? print "ok $test\n" : print "not ok $test\n"; $test++; # 3 Test DELIM property $conf->property("DELIM", "**"); $val = $conf->property("PARAM_DELIM"); $val eq "**" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 4 Test delim method $conf->delim("="); $val = $conf->property("PARAM_DELIM"); $val eq "=" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 5 Test get method $val = $conf->get('SCALAR 1'); $val eq "value1" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 6 Test get method again ($val, $val2) = $conf->get('SCALAR 1', 'SCALAR 3'); $val2 eq "this is a continued line." ? print "ok $test\n" : print "not ok $test\n"; $test++; # 7 Test set method $conf->set('SCALAR 1', 'value one'); $val = $conf->get('SCALAR 1'); $val eq 'value one' ? print "ok $test\n" : print "not ok $test\n"; $test++; # 8 Test get_ref method $val = $conf->get_ref; $val2 = $$val{'SCALAR 1'}; $val2 eq 'value one' ? print "ok $test\n" : print "not ok $test\n"; $test++; # 9 Test error method Parse::PlainConfig::ERROR = 'ouch!'; $val = $conf->error; $val eq 'ouch!' ? print "ok $test\n" : print "not ok $test\n"; $test++; # end 14_compat.t Parse-PlainConfig-2.06/t/testrc0000644000014400001440000000205210435577762016145 0ustar acorlissusers# Scalar tests SCALAR 1: value1 SCALAR 2: "these, are, all one => value" SCALAR 3: this is a \ continued line. SCALAR 4: ASDFKAS234123098ASDFA9082341\ ASDFIO23489078907SFASDF8A972 SCALAR 5: this is a really long text that should definitely cause the output \ generator to wrap lines -- hopefully breaking along whitespace. \ I should also generation a really freaking long line just to see \ it break on non-whitespace as well. Well, how about this: \ AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\ BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB\ CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC\ DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD # List tests LIST 1: value1, value2, value3 LIST 2: value1, "two, parts", value3, "\"two => parts\"" LIST 3: value1, "two, parts", "two => parts" # Hash tests HASH 1: one => 1, two => 2, three => "Three for Me! 3 => 2", \ four => 4 # Disconnected comment # # Empty EMPTY: Parse-PlainConfig-2.06/t/13_readIfNewer.t0000644000014400001440000000240410461475453017573 0ustar acorlissusers# 13_readIfNewer.t # # Tests the readIfNewer method use Parse::PlainConfig; $|++; print "1..8\n"; my $test = 1; my $conf1 = new Parse::PlainConfig; my $conf2 = new Parse::PlainConfig; my $testrc = "./t/testrc-tmp"; my $rv; # 1 & 2 Load & write to temp file $rv = $conf1->read("./t/testrc"); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; $rv = $conf1->write($testrc); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; $conf1->property(FILE => $testrc); # 3 Load conf2 w/temp file $rv = $conf2->read($testrc); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 4 Write new value w/conf1 sleep 3; $conf1->parameter("FOO" => "BAR"); $rv = $conf1->write; $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 5 Reread w/conf2 sleep 3; $rv = $conf2->readIfNewer; $rv == 1 ? print "ok $test\n" : print "not ok $test\n"; $test++; # 6 Make sure new value is there grep(/^FOO$/, $conf2->parameters) ? print "ok $test\n" : print "not ok $test\n"; $test++; # 7 Reread once more sleep 1; $rv = $conf2->readIfNewer; $rv == 2 ? print "ok $test\n" : print "not ok $test\n"; $test++; # 8 Unlink file and reread unlink $testrc; $rv = $conf2->readIfNewer; $rv ? print "not ok $test\n" : print "ok $test\n"; $test++; # end 13_readIfNewer.t Parse-PlainConfig-2.06/t/01_ini.t0000644000014400001440000000070610435577707016165 0ustar acorlissusers# 01_ini.t # # Tests for proper loading of the module use Parse::PlainConfig; $|++; print "1..2\n"; my $test = 1; # 1 load my $conf = new Parse::PlainConfig; ref($conf) eq "Parse::PlainConfig" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 alternate load $conf = Parse::PlainConfig->new('PARAM_DELIM' => '=', PADDING => 1); ref($conf) eq "Parse::PlainConfig" ? print "ok $test\n" : print "not ok $test\n"; $test++; # end 01_ini.t Parse-PlainConfig-2.06/t/04_parameters.t0000644000014400001440000000121010435577707017543 0ustar acorlissusers# 04_parameters.t # # Tests the parameters method use Parse::PlainConfig; $|++; print "1..7\n"; my $test = 1; my $testrc = "./t/testrc"; my $conf = Parse::PlainConfig->new(FILE => $testrc); my @test = ("SCALAR 1", "SCALAR 2", "SCALAR 3", "LIST 1", "LIST 2", "HASH 1"); my @params; # 1 Make sure parameters have been read $conf->read; @params = $conf->parameters; scalar @params > 1 ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 .. 7 Make sure specific parameters are present foreach (@test) { grep(/^\Q$_\E$/, @params) ? print "ok $test\n" : print "not ok $test\n"; $test++; } # end 04_parameters.t Parse-PlainConfig-2.06/t/16_hasParameter.t0000644000014400001440000000133410535203602020003 0ustar acorlissusers# 16_hasParameter.t # # Tests the traditional usage for backwards compatibility use Parse::PlainConfig; $|++; print "1..3\n"; my $test = 1; my $conf = new Parse::PlainConfig; my $testrc = "./t/testrc"; my ($val, $val2); $conf->read($testrc); $conf->property(DEFAULTS => { NOT_PRESENT => 1, }); # 1 Test key that exists in the defaults hash $rv = $conf->hasParameter('NOT_PRESENT'); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 Test present key $rv = $conf->hasParameter('SCALAR 1'); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 3 Test invalid key $rv = ! $conf->hasParameter('NOT_THERE'); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # end 16_hasParameter.t Parse-PlainConfig-2.06/t/10_write.t0000644000014400001440000000306610435577707016542 0ustar acorlissusers# 10_write.t # # Tests the write method use Parse::PlainConfig; $|++; print "1..6\n"; my $test = 1; my $conf = new Parse::PlainConfig; my $nconf = new Parse::PlainConfig; my $testrc = "./t/testrc"; $conf->coerce('string', 'SCALAR 5'); $conf->read($testrc); # 1 write w/o smart $rv = $conf->write("${testrc}_write"); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 verify worthiness of new file $rv = $nconf->read("${testrc}_write"); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 3 compare values in both $conf->parameter('SCALAR 5') eq $nconf->parameter('SCALAR 5') ? print "ok $test\n" : print "not ok $test\n"; unlink "${testrc}_write"; $test++; # 4 write w/smart $conf->property("SMART_PARSER", 1); $conf->coerce('string', 'SCALAR 1', 'SCALAR 2', 'SCALAR 3', 'SCALAR 4', 'SCALAR 5'); $conf->coerce('list', 'LIST 1', 'LIST 2', 'LIST 3'); $conf->coerce('hash', 'HASH 1'); $rv = $conf->write("${testrc}_write_smart"); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 5 verify worthiness of new file $nconf->purge; $nconf->property("SMART_PARSER", 1); $nconf->coerce('string', 'SCALAR 1', 'SCALAR 2', 'SCALAR 3', 'SCALAR 4', 'SCALAR 5'); $nconf->coerce('list', 'LIST 1', 'LIST 2', 'LIST 3'); $nconf->coerce('hash', 'HASH 1'); $nconf->read("${testrc}_write_smart"); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 6 compare values in both $conf->parameter('SCALAR 5') eq $nconf->parameter('SCALAR 5') ? print "ok $test\n" : print "not ok $test\n"; unlink "${testrc}_write_smart"; $test++; # end 10_write.t Parse-PlainConfig-2.06/t/05_purge.t0000644000014400001440000000103710435577707016532 0ustar acorlissusers# 05_purge.t # # Tests the purge method use Parse::PlainConfig; $|++; print "1..2\n"; my $test = 1; my $testrc = "./t/testrc"; my $conf = Parse::PlainConfig->new(FILE => $testrc); my @params; # 1 Make sure parameters have been read $conf->read; @params = $conf->parameters; scalar @params > 1 ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 Purge and make sure there are no parameters $conf->purge; @params = $conf->parameters; scalar @params == 0 ? print "ok $test\n" : print "not ok $test\n"; $test++; # end 05_purge.t Parse-PlainConfig-2.06/t/12_purge.t0000644000014400001440000000157210461475453016526 0ustar acorlissusers# 12_purge.t # # Tests the purge and autopurge functionality use Parse::PlainConfig; $|++; print "1..5\n"; my $test = 1; my $conf = new Parse::PlainConfig; my $testrc = "./t/testrc"; my ($val, $val2, @params); $conf->read($testrc); # 1 & 2 Test purge @params = $conf->parameters(); @params ? print "ok $test\n" : print "not ok $test\n"; $test++; $conf->purge(); @params = $conf->parameters(); @params ? print "not ok $test\n" : print "ok $test\n"; $test++; # 3 .. 5 Test autopurge $conf->read; $conf->parameter("FOO" => "BAR"); @params = $conf->parameters(); grep(/^FOO$/, @params) ? print "ok $test\n" : print "not ok $test\n"; $test++; $conf->property("AUTOPURGE" => 1); $conf->read; @params = $conf->parameters(); grep(/^FOO$/, @params) ? print "not ok $test\n" : print "ok $test\n"; $test++; @params ? print "ok $test\n" : print "not ok $test\n"; $test++; # end 12_purge.t Parse-PlainConfig-2.06/t/09_coerce.t0000644000014400001440000000221310435577707016651 0ustar acorlissusers# 09_coerce.t # # Tests coerce method use Parse::PlainConfig; $|++; print "1..5\n"; my $test = 1; my $rcfile = './t/testrc_smart'; my $conf = Parse::PlainConfig->new( FILE => $rcfile, SMART_PARSER => 1, COERCE => { 'SCALAR 2' => 'string', 'LIST 3' => 'list', }, ); $conf->read; my %hash; # 1 scalar 2 $conf->parameter("SCALAR 2") eq '"these, are, all one => value"' ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 list 3 ($conf->parameter("LIST 3"))[2] eq "two => parts" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 3 coerce list 1 into string $conf->coerce('string', 'LIST 1'); $conf->parameter("LIST 1") eq "value1 , value2 , value3" ? print "ok $test\n" : print "not ok $test\n"; $test++; # 4 .. 5 coerce scalar 2 into a hash $conf->parameter('SCALAR 2', ($conf->parameter('SCALAR 2') =~ /^"(.*)"$/)[0]); $conf->coerce('hash', 'SCALAR 2'); %hash = ( $conf->parameter('SCALAR 2') ); $hash{"these"} eq 'are' ? print "ok $test\n" : print "not ok $test\n"; $test++; $hash{"all one"} eq 'value' ? print "ok $test\n" : print "not ok $test\n"; $test++; # end 09_coerce.t Parse-PlainConfig-2.06/t/11_order.t0000644000014400001440000000205010435577707016514 0ustar acorlissusers# 11_order.t # # Tests the order method use Parse::PlainConfig; $|++; print "1..2\n"; my $test = 1; my $conf = new Parse::PlainConfig; my $nconf = new Parse::PlainConfig; my $testrc = "./t/testrc"; $conf->coerce('string', 'SCALAR 5'); $conf->read($testrc); # 1 change order and write w/smart $conf->property("SMART_PARSER", 1); $conf->coerce('string', 'SCALAR 1', 'SCALAR 2', 'SCALAR 3', 'SCALAR 4', 'SCALAR 5'); $conf->coerce('list', 'LIST 1', 'LIST 2', 'LIST 3'); $conf->coerce('hash', 'HASH 1'); $conf->order('HASH 1', 'LIST 3', 'SCALAR 5'); $rv = $conf->write("${testrc}_order"); $rv ? print "ok $test\n" : print "not ok $test\n"; $test++; # 2 read and compare order $nconf->property("SMART_PARSER", 1); $nconf->coerce('string', 'SCALAR 1', 'SCALAR 2', 'SCALAR 3', 'SCALAR 4', 'SCALAR 5'); $nconf->coerce('list', 'LIST 1', 'LIST 2', 'LIST 3'); $nconf->coerce('hash', 'HASH 1'); $nconf->read("${testrc}_order"); ($nconf->order)[0] eq 'HASH 1' ? print "ok $test\n" : print "not ok $test\n"; unlink "${testrc}_order"; $test++; # end 11_order.t Parse-PlainConfig-2.06/CHANGELOG0000644000014400001440000000165611034517643015662 0ustar acorlissusersv2.06 (2008/07/07) ------------------ --write method was always reporting true when it's possible that it could fail for various reasons. Fixed to reflect actual result --write method now detaints filename before calling open v2.05 (2008/04/29) ------------------ --Updated debug messages since Paranoid now adds calling function v2.02 (2006/07/25) ------------------ --Fixed AUTOPURGE (didn't work since it was looking for old key PURGE) --Added new method readIfNewer v2.01 (2006/07/21) ------------------ --Forgot to implement documented MAX_BYTES. Fixed. --Wasn't saving all errors to Parse::PlainConfig::ERROR as documented. Fixed. v2.0 (2006/05/26) ----------------- --Complete rewrite --Built against Paraniod::* modules --Internal diagnostics provided via Paraniod::Debug --Smart parser mode added --Forced coercion now available for all datatypes (strings, lists, hashes) --Lists and hash delimiters can now be user-defined Parse-PlainConfig-2.06/MANIFEST0000644000014400001440000000063411055444416015574 0ustar acorlissusersMakefile.PL lib/Parse/PlainConfig.pm CHANGELOG CREDITS README LICENSE MANIFEST t/01_ini.t t/02_property.t t/03_read.t t/04_parameters.t t/05_purge.t t/06_scalar.t t/07_list.t t/08_hash.t t/09_coerce.t t/10_write.t t/11_order.t t/12_purge.t t/13_readIfNewer.t t/14_compat.t t/15_defaults.t t/16_hasParameter.t t/testrc t/testrc_smart META.yml Module meta-data (added by MakeMaker) Parse-PlainConfig-2.06/CREDITS0000644000014400001440000000051610435577707015475 0ustar acorlissusersCredits (Alphabetically listed): ================================ --Credit has to be given, as always, to Larry Wall, for starting this train a-rolling. :-) --Stephen Heilbronner for suggesting variable delimiters --Martin Schmitt for suggesting a force-to-scalar option --All those that pointed out my test framework errors ;-) Parse-PlainConfig-2.06/lib/0000755000014400001440000000000011055444416015206 5ustar acorlissusersParse-PlainConfig-2.06/lib/Parse/0000755000014400001440000000000011055444416016260 5ustar acorlissusersParse-PlainConfig-2.06/lib/Parse/PlainConfig.pm0000644000014400001440000012346411034517727021024 0ustar acorlissusers# Parse::PlainConfig -- Parser for plain-text configuration files # # (c) 2002 - 2006, Arthur Corliss , # # $Id: PlainConfig.pm,v 2.06 2008/07/07 22:59:35 acorliss Exp $ # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. # ##################################################################### =head1 NAME Parse::PlainConfig - Parser for plain-text configuration files =head1 MODULE VERSION $Id: PlainConfig.pm,v 2.06 2008/07/07 22:59:35 acorliss Exp $ =head1 SYNOPSIS use Parse::PlainConfig; $conf = new Parse::PlainConfig; $conf = Parse::PlainConfig->new( 'PARAM_DELIM' => '=', 'FILE' => '.myrc', 'MAX_BYTES' => 65536, 'SMART_PARSER => 1, ); $conf->property(PARAM_DELIM => '='); $rv = $conf->read('myconf.conf'); $rv = $conf->read; $rv = $conf->readIfNewer; $conf->write('.myrc', 2); $conf->purge; @parameters = $conf->parameters; $conf->parameter(FOO => "bar"); $value = $conf->parameter(FOO); $conf->describe(FOO => 'This is foo'); $conf->coerce("string", qw(FOO BAR)); @order = $conf->order; $conf->order(@new_order); $errstr = Parse::PlainConfig::ERROR; $rv = $conf->hasParameter('FOO'); The following methods are only supported for backwards compatibility reasons. They will likely be removed at some point in the future. # Use of the tags DELIM and PURGE are deprecated in favour of # PARAM_DELIM, LIST_DELIM, HASH_DELIM, and AUTOPURGE $conf = Parse::PlainConfig->new( 'DELIM' => '=', 'PURGE' => 1, ); # As is the delim method since it works only on the tag delimiter $conf->delim('='); # Auto-purge should be enabled/disabled via the property method $conf->purge(1); # directives is replaced with parameters @directives = $conf->directives; # get/set methods are replaced with a unifed parameter method $field = $conf->get('KEY1'); ($field1, $field2) = $conf->get(qw(KEY1 KEY2)); $conf->set(KEY1 => 'foo', KEY2 => 'bar'); # This was just a really bad idea to begin with, plus it's # effective broken at this point (only returns a copy of the # internal hash now, so it's effectively read-only) $hashref = $conf->getRef; # This is just a wrapper for the class function $errstr = $conf->error =head1 REQUIREMENTS =over =item * Paranoid =item * Text::ParseWords =item * Text::Tabs =back =head1 DESCRIPTION Parse::PlainConfig provides OO objects which can parse and generate human-readable configuration files. =cut ##################################################################### # # Environment definitions # ##################################################################### package Parse::PlainConfig; use strict; use vars qw($VERSION); use Text::ParseWords; use Text::Tabs; use Carp; use Fcntl qw(:flock); use Paranoid::Debug; use Paranoid::Filesystem; use Paranoid::Input; ($VERSION) = (q$Revision: 2.06 $ =~ /(\d+(?:\.(\d+))+)/); ##################################################################### # # Module code follows # ##################################################################### =head1 FILE SYNTAX =head2 TRADITIONAL USAGE The plain parser supports the reconstructions of relatively simple data structures. Simple string assignments and one-dimensional arrays and hashes are possible. Below are are various examples of constructs: # Scalar assignment FIRST_NAME: Joe LAST_NAME: Blow # Array assignment FAVOURITE_COLOURS: red, yellow, green ACCOUNT_NUMBERS: 9956-234-9943211, \ 2343232-421231445, \ 004422-03430-0343 # Hash assignment CARS: crown_vic => 1982, \ geo => 1993 As the example above demonstrates, all lines that begin with a '#' (leading whitespace is allowed) are ignored as comments. if '#" occurs in any other position, it is accepted as part of the passed value. This means that you B place comments on the same lines as values. All directives and associated values will have both leading and trailing whitespace stripped from them before being stored in the configuration hash. Whitespace is allowed within both. In traditional mode (meaning no parameters are set to be coerced into a specific datatype) one must encapsulate list and hash delimiters with quotation marks in order to prevent the string from being split and stored as a list or hash. Quotation marks that are a literal part of the string must be backslashed. =head2 SMART PARSER The new parser now provides some options to make the file syntax more convenient. You can activate the smart parser by setting B to a true value during object instantiation or via the B method. With the traditional parser you had to backslach the end of all preceding lines if you wanted to split a value into more than one line: FOO: This line starts here \ and ends here... With the smart parser enabled that is no longer necessary as long as the following lines are indented further than the first line: FOO: This line starts here and ends here... B The indentation is compared by byte count with no recognition of tab stops. That means if you indent with spaces on the first line and indent with tabs on the following it may not concantenate those values. Another benefit of the smart parser is found when you specify a parameter to be of a specific datatype via the B hash during object instantiation or the B method. For instance, the traditional parser requires you to encapsulate strings with quotation marks if they contain list or hash delimiters: Quote: "\"It can't be that easy,\" he said." Also note how you had to escape quotation marks if they were to be a literal part of the string. With this parameter set to be coerced to a scalar you can simply write: Quote: "It can't be that easy," he said. Similarly, you don't have to quote hash delimiters in parameters set to be coerced into lists. Quotation marks as part of an element value must be escaped, though, since unescaped quotation marks are assumed to encapsulate strings containing list delimiters you don't want to split on. B The previous versions of Parse::PlainConfig did not allow the user to set keys like: FOO: \ bar or save empty assignments like FOO: This is no longer the case. Both are now valid and honoured. =head1 SECURITY B This parser will attempt to open what ever you pass to it for a filename as is. If this object is to be used in programs that run with permissions other than the calling user, make sure you sanitize any user-supplied filename strings before passing them to this object. This also uses a blocking b call to open the file for reading and writing. =head1 FUNCTIONS =head2 Parse::PlainConfig::ERROR =cut { my $ERROR = ''; sub ERROR : lvalue { $ERROR }; } =head1 METHODS =head2 new $conf = new Parse::PlainConfig; $conf = Parse::PlainConfig->new( 'PARAM_DELIM' => '=', 'FILE' => '.myrc', 'MAX_BYTES' => 65536, 'SMART_PARSER => 1, ); The object constructor can be called with or without arguments. Arguments available for use include: Argument Default Purpose ============================================================= ORDER [] Specifies specific order of fields to be used while writing FILE undef Filename for read/write ops PARAM_DELIM ':' Field/value delimiter LIST_DELIM ',' List delimiter within field values HASH_DELIM '=>' Hash key/value delimiter within field values AUTOPURGE 0 Autopurge enabled/disabled COERCE {} Field coercion hash DEFAULTS {} Default field values SMART_PARSER 0 Smart parser enabled/disabled MAX_BYTES 16384 Integer denoting maximum bytes to read in any given file B, B, and B are still available for backwards compatibility, but may be removed in the future. One should use B B, and B instead. B is a hash of field name/data type pairs. If a field is listed in this hash then their values will always be returned in the requested format of either string, list, or hash. Any field coerced to string, for instance, will ignore list and hash delimiters and assume the entire value will always be string value. B is a hash of field name/value pairs. This ensures that even if a field is not explicitly set (either in a conf file or programmatically) a default value can still be retrieved. B removes the need to backslash end-of-lines to continue the value onto the next. If the following line is indented further than the tag was it will automatically assume that the next line is a continuation of the previous. It also affects the need to encapsulate coerced datatypes with quotation marks for irrelevant delimiters. B erases all stored parameters and values before reading a file. This does not, however, erase any values set for B. =cut sub new { my $class = shift; my %init = ( CONF => {}, ORDER => [], FILE => undef, PARAM_DELIM => ':', LIST_DELIM => ',', HASH_DELIM => '=>', AUTOPURGE => 0, COERCE => {}, DEFAULTS => {}, SMART_PARSER => 0, PADDING => 2, MAX_BYTES => 16384, MTIME => 0, ); my $self = \%init; my %args = @_; my (@keyList, $k, $v, $rv); pdebug("entering", 7); pIn(); bless $self, $class; # Assign all the arguments $rv = 1; while ($rv && scalar keys %args) { $k = shift @{[ keys %args ]}; $v = $args{$k}; delete $args{$k}; $rv = $self->property($k, $v); } # Return the object reference if no errors occurred during initialization if ($rv) { $v = $rv = $self; } else { $rv = undef; $v = 'undef'; } pOut(); pdebug("leaving w/rv: $v", 7); return $self; } =head2 property $conf->property(PARAM_DELIM => '='); This method sets or retrieves the specified property. Please note that this B the current value, even for those properties that are references to lists and hashes. If you're using this to set a property it will return a boolean true or false depending on the success of the operation. If you're just retrieving a property it will return the value of the property. If you ask for a nonexistent property it will B. =cut sub property ($$;$) { my $self = shift; my @args = @_; my $arg = $args[0]; my $val = $args[1]; my $ival = defined $val ? $val : 'undef'; my $rv = 1; croak "Parse::PlainConfig::property was called with an undefined property" unless defined $arg; $arg = 'PARAM_DELIM' if $arg eq 'DELIM'; $arg = 'AUTOPURGE' if $arg eq 'PURGE'; croak "Parse::PlainConfig::property was called with an unknown property" . "($arg)" unless exists $$self{$arg} or $arg eq 'FORCE_SCALAR'; pdebug("entering w/($arg)($ival)", 7); pIn(); pdebug("method is in " . (scalar @args == 2 ? 'set' : 'get') . " mode", 7); $arg = uc($arg); # TODO 2008/05/11: properties deprecated, remove FORCE_SCALAR, DELIM, PURGE # Validate argument & value if (scalar @args == 2) { # Make sure list properties are list references if ($arg =~ /^(?:ORDER|FORCE_SCALAR)$/) { unless (ref($val) eq 'ARRAY') { $rv = 0; ERROR = pdebug("${arg}'s value must be a list reference", 7); } # Hash properties are hash references } elsif ($arg =~ /^(?:CONF|COERCE|DEFAULTS)$/) { unless (ref($val) eq 'HASH') { $rv = 0; ERROR = pdebug("${arg}'s value must be a hash reference", 7); } # Validate coerced values if ($rv && $arg eq 'COERCE') { foreach (keys %$val) { $ival = defined $$val{$_} ? $$val{$_} : 'undef'; ERROR = pdebug("coerced data type ($_: $ival) not a string, " . "list, or hash") and $rv = 0 unless $ival =~ /^(?:string|list|hash)$/; } } # And the rest are scalars... # TODO? Validate properties like PADDING that have a concrete list of # TODO? valid values? } elsif (ref($val) ne '') { $rv = 0; ERROR = pdebug("${arg}'s value must be a scalar value", 7); } } # Set the value if all's kosher if ($rv) { if (scalar @args == 2) { if ($arg eq 'FORCE_SCALAR') { foreach (@$val) { $$self{COERCE}{$_} = 'string' }; } else { $$self{$arg} = $val; } } else { $rv = $$self{$arg}; } } pOut(); pdebug("leaving w/rv: $rv", 7); return $rv; } =head2 purge $conf->purge(1); $conf->purge; B Use of this method to set the purge mode is deprecated and will be removed in the future. For that please use the B method instead. This method either (re)sets the auto-purge mode, or performs an immediate manual purge. Auto-purge mode clears the configuration hash each time a configuration file is read, so that the internal configuration data consists solely of what is in that file. If you wanted to combine the settings of multiple files that each may exclusively hold some directives, setting this to 'off' will load the combined configuration as you read each file. You can still clobber configuration values, of course, if the same directive is defined in multiple files. In that case, the last file's value will be the one stored in the hash. This does not clear the B or B properties. Autopurge mode is disabled by default. =cut sub purge($$) { my $self = shift; my $arg = shift; $arg = 'undef' unless defined $arg; pdebug("entering w/($arg)", 7); pIn(); # TODO: 2008/05/11: property set invocation deprecated, remove if ($arg ne 'undef') { pdebug("setting AUTOPURGE to $arg", 7); $self->property('AUTOPURGE', $arg); } else { pdebug("clearing CONF", 7); $$self{CONF} = {}; } pOut(); pdebug("leaving w/rv: 1", 7); return 1; } =head2 read $rv = $conf->read('myconf.conf'); $rv = $conf->read; The read method is called initially with a filename as the only argument. This causes the parser to read the file and extract all of the configuration directives from it. You'll notice that you can also call the read method without an argument. The name of the file read is stored internally, and if already set to a valid value (either by a previous call to B with a filename argument or by setting the B property) this will read that file's contents. The return value will be one if the file was successfully read and parsed, or zero otherwise. The reason for failure can be read via B. This function will cause the program to croak if called without a filename ever being defined. =cut sub read($;$) { my $self = shift; my $file = shift || $$self{FILE}; my $purge = $$self{AUTOPURGE}; my $rv = 0; my $oldSize = FSZLIMIT; my ($line, @lines); croak "Parse::PlainConfig::read called an undefined filename" unless defined $file; pdebug("entering w/($file)", 7); pIn(); # Reset the error string and update the internal filename ERROR = ''; $$self{FILE} = $file; # Temporarily set the specified size limit FSZLIMIT = $$self{MAX_BYTES}; # Store the file's current mtime $$self{MTIME} = (stat $file)[9]; if (slurp($file, \@lines, 1)) { # Empty the current config hash and key order $self->purge if $purge; # Parse the rc file's lines $rv = $self->_parse(@lines); } else { ERROR = Paranoid::ERROR; } # Restore old size limit FSZLIMIT = $oldSize; pOut(); pdebug("leaving w/rv: $rv", 7); # Return the result code return $rv; } =head2 readIfNewer $rv = $conf->readIfNewer; This method is used to reread & parse the file only if the mtime appears newer than when last read. If the file was successfully reread or appears to be the same it will return true. Any errors will be stored in B and it will return a false value. You can determine whether or not the file was read by the true value. If it was re-read it will return 1. If the file appears to be the same age it will return a 2. =cut sub readIfNewer($) { my $self = shift; my $file = $$self{FILE}; my $omtime = $$self{MTIME}; my $rv = 0; my $mtime; croak "Parse::PlainConfig::readIfNewer called an undefined filename" unless defined $file; pdebug("entering w/($file)", 7); pIn(); # Make sure the file exists and is readable if (-e $file && -r _) { # Read if the file appears to be newer $mtime = (stat _)[9]; pdebug("current mtime: $mtime last: $omtime", 7); $rv = $mtime > $omtime ? $self->read : 2; # Report errors } else { ERROR = "Parse::PlainConfig::readIfNewere: File ($file) does not exist " . "or is not readable!"; } pOut(); pdebug("leaving w/rv: $rv", 7); # Return the result code return $rv; } =head2 write $conf->write('.myrc', 2); This method writes the current configuration stored in memory to the specified file, either specified as the first argument, or as stored from an explicit or implicit B call. The second argument specifies what kind of whitespace padding, if any, to use with the directive/value delimiter. The following values are recognised: Value Meaning ================================================ 0 No padding (i.e., written as KEY:VALUE) 1 Left padding (i.e., written as KEY :VALUE) 2 Right padding (i.e., written as KEY: VALUE) 3 Full padding (i.e., written as KEY : VALUE) Both arguments are optional. =cut sub write($;$$) { my $self = shift; my $file = shift || $self->{FILE}; my $padding = shift; my $conf = $self->{CONF}; my $order = $self->{ORDER}; my $coerce = $self->{COERCE}; my $smart = $self->{SMART_PARSER}; my $paramDelim = $self->{PARAM_DELIM}; my $hashDelim = $self->{HASH_DELIM}; my $listDelim = $self->{LIST_DELIM}; my $rv = 0; my $tw = 78; my $delimRegex = qr/(?:\Q$hashDelim\E|\Q$listDelim\E)/; my (@forder, $type, $param, $value, $description, $entry, $out); my ($tmp, $tvalue, $lines); # TODO: Implement non-blocking flock support # TODO: Store read padding and/or use PADDING property value croak "Parse::PlainConfig::write called an undefined filename" unless defined $file; $padding = 2 unless defined $padding; $tw -= 2 unless $smart; pdebug("entering w/($file)($padding)", 7); pIn(); # Pad the delimiter as specified $paramDelim = $padding == 0 ? $paramDelim : $padding == 1 ? " $paramDelim" : $padding == 2 ? "$paramDelim " : " $paramDelim "; pdebug("PARAM_DELIM w/padding is '$paramDelim'", 7); # Create a list of parameters for output @forder = @$order; foreach $tmp (sort keys %$conf) { push (@forder, $tmp) unless grep /^\Q$tmp\E$/, @forder }; pdebug("order of params to be " . "written:\n\t@forder", 7); # Compose the new output $out = ''; foreach $param (@forder) { # Determine the datatype $value = exists $$conf{$param} ? $$conf{$param}{Value} : ''; $description = exists $$conf{$param} ? $$conf{$param}{Description} : ''; $type = exists $$coerce{$param} ? $$coerce{$param} : ref($value) eq 'HASH' ? 'hash' : ref($value) eq 'ARRAY' ? 'list' : 'string'; pdebug("adding $type param ($param)", 7); # Append the comments $out .= $description; $out .= "\n" unless $out =~ /\n$/m; # Start the new entry with the parameter name and delimiter $entry = "$param$paramDelim"; # Append the value, taking into consideration the smart parser # and coercion settings if ($type eq 'string') { $tvalue = $value; unless ($smart && exists $$coerce{$param}) { $tvalue =~ s/"/\\"/g; $tvalue = "\"$tvalue\"" if $tvalue =~ /$delimRegex/; } $lines = "$entry$tvalue"; } elsif ($type eq 'list') { $tvalue = [ @$value ]; foreach (@$tvalue) { s/"/\\"/g; if ($smart && exists $$coerce{$param}) { $_ = "\"$_\"" if /\Q$listDelim\E/; } else { $_ = "\"$_\"" if /$delimRegex/; } } $lines = $entry . join(" $listDelim ", @$tvalue); } else { $tvalue = { %$value }; foreach (keys %$tvalue) { $tmp = $_; $tmp =~ s/"/\\"/g; $tmp = "\"$tmp\"" if /$delimRegex/; if ($tmp ne $_) { $$tvalue{$tmp} = $$tvalue{$_}; delete $$tvalue{$_}; } $$tvalue{$tmp} =~ s/"/\\"/g; $$tvalue{$tmp} = "\"$$tvalue{$tmp}\"" if $$tvalue{$tmp} =~ /$delimRegex/; } $lines = $entry . join(" $listDelim ", map { "$_ $hashDelim $$tvalue{$_}" } sort keys %$tvalue); } # wrap the output to the column width and append to the output $out .= _wrap("", "\t", $tw, ($smart ? "\n" : "\\\n"), $lines); $out .= "\n" unless $out =~ /\n$/m; } # Attempt to open the file if (detaint($file, 'filename', \$file)) { if (open(RCFILE, "> $file")) { # Write the file flock(RCFILE, LOCK_EX); if (print RCFILE $out) { $rv = 1; } else { ERROR = $!; } flock(RCFILE, LOCK_UN); close(RCFILE); # Store the new mtime on successful writes $$self{MTIME} = (stat $file)[9] if $rv; # Opening the file failed } else { ERROR = "Parse::PlainConfig::write: Error writing file: $!"; } # Detainting filename failed } else { ERROR = "Parse::PlainConfig::write: illegal characters in filename: " . $file; } pOut(); pdebug("leaving w/rv: $rv", 7); return $rv; } =head2 parameters @parameters = $conf->parameters; This method returns a list of all the names of the directives currently stored in the configuration hash in no particular order. =cut sub parameters() { my $self = shift; my @parameters = keys %{ $$self{CONF} }; pdebug("Called Parse::PlainConfig::parameters -- rv: @parameters", 7); return @parameters; } =head2 parameter $value = $conf->parameter('SCALAR1'); @values = $conf->parameter('LIST1'); %values = $conf->parameter('HASH1'); $conf->parameter('SCALAR1', "foo"); $conf->parameter('LIST1', [qw(foo bar)]); $conf->parameter('HASH1', { foo => 'bar' }); This method sets or retrieves the specified parameter. Hash and list values are copied and returned as a list. If the specified parameter is set to be coerced into a specific data type the specified value will be converted to that datatype. This means you can do something like: # SCALAR1 will equal "foo , bar , roo" assuming LIST_DELIM is set to ',' $conf->coerce(qw(string SCALAR1)); $conf->parameter('SCALAR1', [qw(foo bar roo)]); # SCALAR1 will equal "foo => bar : roo => ''" assuming HASH_DELIM is set # to '=>' and LIST_DELIM is set to ':' $conf->parameter('SCALAR1', { 'foo' => 'bar', 'roo' => '' }); In order for conversions to be somewhat predictable (in the case of hashes coerced into other values) hash key/value pairs will be assigned to string or list portions according to the alphabetic sort order of the keys. =cut sub parameter($$;$) { my $self = shift; my @args = @_; my $param = $args[0]; my $value = $args[1]; my $ivalue = defined $value ? $value : 'undef'; my $conf = $$self{CONF}; my $listDelim = $$self{LIST_DELIM}; my $hashDelim = $$self{HASH_DELIM}; my $paramDelim = $$self{PARAM_DELIM}; my $coerceType = exists $$self{COERCE}{$param} ? $$self{COERCE}{$param} : 'undef'; my $defaults = $$self{DEFAULTS}; my $rv = 1; my ($finalValue, @elements); # TODO: Consider storing a list/hash padding value as well, for use # TODO: in coercion to string. croak "Parse::PlainConfig::parameter was called with an undefined parameter" unless defined $param; pdebug("entering w/($param)($ivalue)", 7); pIn(); if (scalar @args == 2) { pdebug("method in set mode", 7); # Create a blank record if it hasn't been defined yet $$conf{$param} = { Value => '', Description => '', } unless exists $$conf{$param}; # Start processing value assignment if ($coerceType ne 'undef') { pdebug("coercing into $coerceType", 7); # Coerce values into strings if ($coerceType eq 'string' && ref($value) ne '') { # Convert lists into a string using the list delimiter if (ref($value) eq 'ARRAY') { foreach (@$value) { s/"/\\"/g; $_ = "\"$_\"" if /\Q$listDelim\E/; } $finalValue = join(" $listDelim ", @$value); # Convert hashes into a string using the hash & list delimiters } elsif (ref($value) eq 'HASH') { foreach (sort keys %$value) { $ivalue = $_; $ivalue =~ s/"/\\"/g; $ivalue = "\"$ivalue\"" if /(?:\Q$hashDelim\E|\Q$listDelim\E)/; $$value{$_} = '' unless defined $$value{$_}; $$value{$_} = "\"$$value{$_}\"" if $$value{$_} =~ /(?:\Q$hashDelim\E|\Q$listDelim\E)/; push(@elements, join(" $hashDelim ", $_, (defined $$value{$_} ? $$value{$_} : ''))) }; $finalValue = join(" $listDelim ", @elements); # Try to stringify everything else } else { $finalValue = "$value"; } # Coerce value into a list } elsif ($coerceType eq 'list' && ref($value) ne 'ARRAY') { # Convert hashes into a list if (ref($value) eq 'HASH') { $finalValue = []; foreach (sort keys %$value) { push(@$finalValue, $_, $$value{$_}) }; # Convert strings into a list } elsif (ref($value) eq '') { $self->_parse(split(/\n/m, "$$conf{$param}{Description}\n$param $paramDelim $value")); $finalValue = $$conf{$param}{Value}; # Stringify everything else and put it into an array } else { $finalValue = [ "$value" ]; } # Coerce value into a hash } elsif ($coerceType eq 'hash' && ref($value) ne 'HASH') { # Convert a list into a hash using every two elements as a # key/value pair if (ref($value) eq 'ARRAY') { push(@$value, '') unless int(scalar @$value / 2) == scalar @$value / 2; $finalValue = { @$value }; # Convert strings into a hash } elsif (ref($value) eq '') { $self->_parse(split(/\n/m, "$$conf{$param}{Description}\n$param $paramDelim $value")); $finalValue = $$conf{$param}{Value}; # Stringify everything else and put the value into the hash key } else { $finalValue = { "$value" => '' }; } # No coercion is necessary } else { $finalValue = $value; } } else { pdebug("no coercion to do", 7); $finalValue = $value; } $$conf{$param}{Value} = $finalValue; } else { pdebug("method in retrieve mode", 7); $rv = exists $$conf{$param} ? $$conf{$param}{Value} : exists $$defaults{$param} ? $$defaults{$param} : undef; } pOut(); pdebug("leaving w/rv: " . (defined $rv ? $rv : 'undef'), 7); return ref($rv) eq 'HASH' ? (%$rv) : ref($rv) eq 'ARRAY' ? (@$rv) : $rv; } =head2 coerce $conf->coerce("string", "FOO", "BAR"); This method configures the parser to coerce values into the specified datatype (either string, list, or hash) and immediately convert any existing values and store them into that datatype as well. =cut sub coerce($$@) { my $self = shift; my $type = shift; my $itype = defined $type ? $type : 'undef'; my @params = @_; croak "Parse::PlainConfig::coerce called with an invalid datatype ($itype)" unless $itype =~ /^(?:string|list|hash)$/; croak "Parse::PlainConfig::coerce called with no named parameters" unless @params; pdebug("entering w/($itype)(@params)", 7); pIn(); foreach (@params) { $$self{COERCE}{$_} = $type; $self->parameter($_, $$self{CONF}{$_}{Value}) if exists $$self{CONF}{$_}; } pOut(); pdebug("leaving w/rv: 1", 7); } =head2 describe $conf->describe(KEY1 => 'This is foo', KEY2 => 'This is bar'); The describe method takes any number of key/description pairs which will be used as comments preceding the directives in any newly written conf file. You are responsible for prepending a comment character to each line, as well as splitting along your desired text width. =cut sub describe($@) { my $self = shift; my $conf = $$self{CONF}; my $coerce = $$self{COERCE}; my %new = (@_); pdebug("entering", 7); pIn(); # TODO: Consider allowing comment tags to be specified # TODO: Consider line splitting and comment tag prepending where # TODO: it's not already done. foreach (keys %new) { pdebug("$_ is described as '$new{$_}'", 7); unless (exists $$conf{$_}) { $$conf{$_} = {}; if (exists $$coerce{$_}) { $$conf{$_}{Value} = $$coerce{$_} eq 'list' ? [] : $$coerce{$_} eq 'hash' ? {} : ''; } else { $$conf{$_}{Value} = ''; } } $$conf{$_}{Description} = $new{$_}; } pOut(); pdebug("leaving w/rv: 1", 7); return 1; } =head2 order @order = $conf->order; $conf->order(@new_order); This method returns the current order of the configuration directives as read from the file. If called with a list as an argument, it will set the directive order with that list. This method is probably of limited use except when you wish to control the order in which directives are written in new conf files. Please note that if there are more directives than are present in this list, those extra keys will still be included in the new file, but will appear in alphabetically sorted order at the end, after all of the keys present in the list. =cut sub order($@) { my $self = shift; my $order = $$self{ORDER}; my @new = (@_); pdebug("entering w/(@new)", 7); @$order = (@new) if scalar @new; pdebug("leaving w/rv: @$order", 7); return @$order; } sub _parse($@) { # Parses the passed list of lines and extracts comments, fields, and # values from them, storing them in the CONF hash. # # Usage: $self->_parse(@lines); my $self = shift; my $conf = $$self{CONF}; my $order = $$self{ORDER}; my $smart = $$self{SMART_PARSER}; my $tagDelim = $$self{PARAM_DELIM}; my $hashDelim = $$self{HASH_DELIM}; my $listDelim = $$self{LIST_DELIM}; my @lines = @_; my $rv = 1; my ($i, $line, $comment, $entry, $field, $value); my ($indentation, $data); # Make sure some of the properties are sane croak "LIST_DELIM and HASH_DELIM cannot be the same character sequence!\n" unless $$self{LIST_DELIM} ne $$self{HASH_DELIM}; pdebug("entering", 8); pIn(); # Flatten lines using an explicit backslash for ($i = 0; $i <= $#lines ; $i++) { # Let's disable uninitialized warnings since there's a few # places here we really don't care no warnings 'uninitialized'; if ($lines[$i] =~ /\\\s*$/) { pdebug("joining lines @{[ $i + 1 ]} " . "\& @{[ $i + 2 ]}", 8); # Lop off the trailing whitespace and backslash, preserving # only one space on the assumption that if it's there it's a # natural word break. $lines[$i] =~ s/(\s)?\s*\\\s*$/$1/; # Concatenate the following line (if there is one) after stripping # off preceding whitespace if ($i < $#lines) { $lines[$i + 1] =~ s/^\s+//; $lines[$i] .= $lines[$i + 1]; splice(@lines, $i + 1, 1); --$i; } } } local *saveEntry = sub { # Saves the extracted data into the conf hash and resets # the vars. my ($type); ($field, $value) = ($entry =~ /^\s*([^$tagDelim]+?)\s*\Q$tagDelim\E\s*(.*)$/); pdebug("saving data:\n\t($field: $value)", 8); # Get the field data type from COERCE if set if (exists $$self{COERCE}{$field}) { $type = $$self{COERCE}{$field}; # Otherwise, autodetect } else { $type = scalar quotewords(qr/\s*\Q$hashDelim\E\s*/, 0, $value) > 1 ? 'hash' : scalar quotewords(qr/\s*\Q$listDelim\E\s*/, 0, $value) > 1 ? 'list' : 'scalar'; } pdebug("detected type of $field is $type", 8); # We'll apply quotewords to scalar values only if the smart parser is # not being used or if we're not coercing all values into scalar for # this field. # # I hate having to do this but I was an idiot in the previous versions # and this is necessary for backwards compatibility. if ($type eq 'scalar') { $value = join('', quotewords(qr/\s*\Q$listDelim\E\s*/, 0, $value)) unless $smart && exists $$self{COERCE}{$field} && $$self{COERCE}{$field} eq 'scalar'; } elsif ($type eq 'hash') { $value = { quotewords(qr/\s*(?:\Q$hashDelim\E|\Q$listDelim\E)\s*/, 0, $value) }; } elsif ($type eq 'list') { $value = [ quotewords(qr/\s*\Q$listDelim\E\s*/, 0, $value) ]; } # Create the parameter record $$conf{$field} = {}; $$conf{$field}{Value} = $value; $$conf{$field}{Description} = $comment; push(@$order, $field) unless grep /^\Q$field\E$/, @$order; $comment = $entry = ''; }; # Process lines $comment = $entry = ''; while (defined ($line = shift @lines)) { # Grab comments and blank lines if ($line =~ /^\s*(?:#.*)?$/) { pdebug("comment/blank line:\n\t$line", 9); # First save previous entries if $entry has content &saveEntry() and $i = 0 if length($entry); # Save the comments $comment = length($comment) > 0 ? "$comment$line\n" : "$line\n"; # Grab configuration lines } else { # If this is the first line of a new entry and there's no # PARAM_DELIM skip the line -- something must be wrong. # # TODO: Error out/raise exception pdebug("skipping spurious text:\n\t$line", 9) and next unless length($entry) || $line =~ /\Q$tagDelim\E/; # Grab indentation characters and line content ($indentation, $data) = ($line =~ /^(\s*)(.+)$/); pdebug("data line:\n\t$data", 9); # If smart parsing is enabled if ($smart) { # If there's current content if (length($entry)) { # If new indentation is greater than original indentation # we concatenate the lines as a continuation if (length($indentation) > $i) { $entry .= $data; # Otherwise we treat this a a new entry, so we save the old # and store the current } else { &saveEntry(); ($i, $entry) = (length($indentation) , $data); } # No current content, so just store the current data and continue # processing } else { ($i, $entry) = (length($indentation) , $data); } # Smart parsing is disabled, so treat every line as a new entry } else { $entry = $data; &saveEntry(); } } } &saveEntry() if length($entry); pOut(); pdebug("leaving w/rv: $rv", 8); return $rv; } sub _wrap($$$$$) { # Parses the passed line of text and inserts indentation and line breaks as # specified. # # Usage: $paragraph = _wrap(...); my $firstIndent = shift; my $subIndent = shift; my $textWidth = shift; my $lineBreak = shift; my $paragraph = shift; my (@lines, $segment, $output); pdebug("entering w/($firstIndent)" . "($subIndent)($textWidth)($lineBreak):\n\t$paragraph", 8); pIn(); # Expand tabs in everything -- sorry everyone ($firstIndent) = expand($firstIndent); ($subIndent) = expand($subIndent); $paragraph = expand("$firstIndent$paragraph"); $lines[0] = ''; while (length($paragraph) > 0) { ($segment) = ($paragraph =~ /^(\s*\S+\s?)/); # If the segment will fit appended to the current line, concatenate it if (length($segment) <= $textWidth - length($lines[$#lines])) { $lines[$#lines] .= $segment; # Or, if the segment will fit into the next line, add it } elsif (length($segment) <= $textWidth - length($subIndent)) { $lines[$#lines] .= $lineBreak; push(@lines, "$subIndent$segment"); # Else, split on the text width } else { $segment = $#lines == 0 ? substr($paragraph, 0, $textWidth) : substr($paragraph, 0, $textWidth - length($subIndent)); if (length($segment) > $textWidth - length($lines[$#lines])) { $lines[$#lines] .= $lineBreak; push(@lines, ($#lines == 0 ? $segment : "$subIndent$segment")); } else { $lines[$#lines] .= $segment; } } $paragraph =~ s/^.{@{[length($segment)]}}//; } $lines[$#lines] .= "\n"; $output = join('', @lines); pOut(); pdebug("leaving w/rv:\n$output", 8); return $output; } =head2 hasParameter $rv = $conf->hasParameter('FOO'); This function allows you to see if a parameter has been defined or has a default set for it. Returns a boolean value. =cut sub hasParameter($$) { my $self = shift; my $param = shift; my $rv = 0; my @params = ( keys %{ $self->{CONF} }, keys %{ $self->{DEFAULTS} }, ); croak "Parse::PlainConfig::parameter was called with an undefined parameter" unless defined $param; pdebug("entering w/($param)", 7); pIn(); $rv = scalar grep /^\Q$param\E$/, @params; pOut(); pdebug("leaving w/rv: $rv", 7); return $rv; } ################################## # Backwards compatibilty graveyard ################################## =head1 DEPRECATED METHODS =head2 delim $conf->delim('='); This method gets and/or sets the parameter name/value delimiter to be used in the conf files. The default delimiter is ':'. This can be multiple characters. =cut sub delim { # TODO 2008/05/11: deprecated, remove my $self = shift; my $delim = shift || $self->property('PARAM_DELIM'); pdebug("Called Parse::PlainConfig::delim -- calling property", 7); $self->property(PARAM_DELIM => $delim); return $delim; } =head2 directives @directives = $conf->directives; This method returns a list of all the names of the directives currently stored in the configuration hash in no particular order. =cut sub directives { # TODO 2008/05/11: deprecated, remove my $self = shift; pdebug("Called Parse::PlainConfig::directives -- calling parameters", 7); return $self->parameters; } =head2 get $field = $conf->get('KEY1'); ($field1, $field2) = $conf->get(qw(KEY1 KEY2)); The get method takes any number of directives to retrieve, and returns them. Please note that both hash and list values are passed by reference. In order to protect the internal state information, the contents of either reference is merely a copy of what is in the configuration object's hash. This will B pass you a reference to data stored internally in the object. Because of this, it's perfectly safe for you to shift off values from a list as you process it, and so on. =cut sub get { # TODO 2008/05/11: deprecated, remove my $self = shift; my $conf = $$self{CONF}; my @fields = @_; my (@results, $ref); croak "Parse::PlainConfig::get called with no fields" unless @fields; pdebug("Entering Parse::PlainConfig::get", 7); pIn(); # Loop through each requested field foreach (@fields) { $ref = exists $$conf{$_}{Value} ? $$conf{$_}{Value} : undef; $ref = { %$ref } if ref($ref) eq 'HASH'; $ref = [ @$ref ] if ref($ref) eq 'ARRAY'; push(@results, $ref); } pOut(); pdebug("Leaving Parse::PlainConfig::get w/rv: @results", 7); # Return the values return (scalar @fields > 1) ? @results : $results[0]; } =head2 set $conf->set(KEY1 => 'foo', KEY2 => 'bar'); The set method takes any number of directive/value pairs and copies them into the internal configuration hash. =cut sub set { # TODO 2008/05/11: deprecated, remove my $self = shift; my $conf = $$self{CONF}; my %new = (@_); foreach (keys %new) { $self->parameter($_, $new{$_}) }; return 1; } =head2 get_ref $href = $conf->get_ref B: This used to give you a reference to the internal configuration hash so you could manipulate it directly. It now only gives you a B of the internal hash (actually, it's reconstructed has to make it look like the old data structure). In short, any changes you make to this hash B. =cut sub get_ref { # TODO 2008/05/11: deprecated, remove my $self = shift; my $href = {}; foreach (keys %{ $$self{CONF} }) { $$href{$_} = $$self{CONF}{$_}{Value} }; pdebug("Called Parse::PlainConfig::get_ref -- rv: $href", 7); return $href; } =head2 error warn $conf->error; This method returns a zero-length string if no errors were registered with the last operation, or a text message describing the error. =cut sub error { # TODO 2008/05/11: deprecated, remove my $errStr = ERROR; pdebug("Called Parse::PlainConfig::error -- rv: $errStr", 7); return $errStr; } 1; =head1 DIAGNOSTICS Through the use of B this module will produce internal diagnostic output to STDERR. It begins logging at log level 7. To enable debugging output please see the pod for Paranoid::Debug. =head1 HISTORY 2002/01/18: Original public release (v1.1) 2006/05/26: Complete rewrite (v2.0) =head1 AUTHOR/COPYRIGHT (c) 2002 Arthur Corliss (corliss@digitalmages.com) =cut Parse-PlainConfig-2.06/LICENSE0000644000014400001440000004307610435601243015451 0ustar acorlissusers GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave, Cambridge, MA 02139, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19yy name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. Parse-PlainConfig-2.06/README0000644000014400001440000000105110435577707015330 0ustar acorlissusersParse::PlainConfig ================== Author: Arthur Corliss Date: May 26, 2006 Description: ------------ This is a long overdue complete rewrite. It has a lot of feature improvements along with much cleaner and robust coding. Instructions: ------------- Like all CPAN modules, just enter the following commands: $ perl Makefile.PL $ make $ make test $ make install If you wish to see sample code using the module, please examine test files in the t directory. A sample rc file is there as well, which shows the robustness of the parser. Parse-PlainConfig-2.06/Makefile.PL0000644000014400001440000000061510435577707016427 0ustar acorlissusersuse ExtUtils::MakeMaker; WriteMakefile( NAME => 'Parse::PlainConfig', AUTHOR => 'Arthur Corliss ', ABSTRACT => 'Parser/Generator of human-readable conf files', VERSION_FROM => 'lib/Parse/PlainConfig.pm', PREREQ_PM => { Paranoid => undef, Text::ParseWords => undef, Text::Tabs => undef, }, ); exit 0; Parse-PlainConfig-2.06/META.yml0000644000014400001440000000101711055444416015710 0ustar acorlissusers--- #YAML:1.0 name: Parse-PlainConfig version: 2.06 abstract: Parser/Generator of human-readable conf files license: ~ generated_by: ExtUtils::MakeMaker version 6.36 distribution_type: module requires: Paranoid: Text::ParseWords: Text::Tabs: meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.2.html version: 1.2 author: - Arthur Corliss