configtoolkit 2.0.0 → 2.1.0

data/FAQ.txt

@@ -94,13 +94,14 @@ can tell it to treat ConfigToolkit::BaseConfig.add_required_param and
 ConfigToolkit::BaseConfig.add_optional_param as attribute specifiers via
 command-line options (the -A option), but this produces slightly broken
 output because +rdoc+ misinterprets the second and third (if present) arguments
-to the method as additional attributes (since +attr_reader+, for instance,
+to the methods as additional attributes (since +attr_reader+, for instance,
 can take multiple Symbols as arguments, each of which becomes an attribute).
-The +configtoolkit+ gem includes small patch to +rdoc+ (*only* to version 2.0.0,
-available as a gem at http://rubyforge.org/projects/rdoc/) that fixes this for
+The +configtoolkit+ includes a small patch for the +rdoc+ gem (only
+versions 2.0.0 and 2.1.0, which can be obtained with +gem+ or at
+http://rubyforge.org/projects/rdoc/) that fixes this for
 ConfigToolkit::BaseConfig.add_required_param and
 ConfigToolkit::BaseConfig.add_optional_param:
-======+rdoc_support/rdoc.patch+:
+======+rdoc_support/rdoc-2.0.0.patch+:
  --- parse_rb.rb	2008-07-14 12:25:06.000000000 -0400
  +++ /usr/lib/ruby/gems/1.8/gems/rdoc-2.0.0/lib/rdoc/parsers/parse_rb.rb	2008-07-14 12:32:02.000000000 -0400
  @@ -2505,6 +2505,21 @@
@@ -126,12 +127,40 @@ ConfigToolkit::BaseConfig.add_optional_param:
         att = RDoc::Attr.new get_tkread, name, rw, comment
         context.add_attribute att
 
-The patch should be applied to +rdoc-2.0.0/lib/rdoc/parsers/parse_rb.rb+ in the
-Ruby gems directory with the +patch+ utility.
+This patch only should be applied to the +rdoc+ version 2.0.0 gem with the
++patch+ utility:
+======+rdoc_support/rdoc-2.1.0.patch+:
+ --- rdoc-2.1.0/lib/rdoc/parser/ruby.rb	2008-07-25 13:09:44.000000000 -0400
+ +++ /usr/lib/ruby/gems/1.8/gems/rdoc-2.1.0/lib/rdoc/parser/ruby.rb	2008-07-25 13:08:37.000000000 -0400
+ @@ -1807,6 +1807,21 @@
+        rw = '?' if rw.nil?
+      end
+  
+ +    #
+ +    # This is a temporary hack.
+ +    # At some point in the (near) future, this should be specifiable via
+ +    # rdoc's command-line options.
+ +    # 
+ +    # Unlike the attr* family of functions, only the first argument of 
+ +    # the add*param functions is an attribute; the other arguments
+ +    # constrain the attribute.
+ +    #
+ +    if((tk.name == "add_optional_param") || (tk.name == "add_required_param"))
+ +      if(args.size > 1)
+ +        args[1, args.size - 1] = nil
+ +      end
+ +    end
+ +    
+      for name in args
+        att = RDoc::Attr.new get_tkread, name, rw, comment
+        context.add_attribute att
+
+This patch only should be applied to the +rdoc+ version 2.1.0 gem with the
++patch+ utility:
 
-After applying this patch, +rdoc+ should register the parameters as attributes
-with this command-line option:
- --accessor=add_optional_param=rw,add_required_param=rw
+After applying the appropriate patch, +rdoc+ should register the parameters as
+attributes with this command-line option:
+ --accessor=add_optional_param=RW,add_required_param=RW
 
 As with standard attributes, +rdoc+ will display a comment block above the
 call to add a new parameter in the generated HTML along with the attribute.  The

data/Hash.txt

@@ -125,4 +125,4 @@ When run, the program produces:
  }
  
  The Hash dumped from the second config:
- {:production=>{:www=>{:addresses=>[#<URI::HTTP:0xb7e2f8d0 URL:http://www.designingpatterns.com>, #<URI::HTTP:0xb7e2f880 URL:http://tokyo.designingpatterns.com>], :num_cpus=>64, :os=>{:version=>10.0, :name=>"Solaris"}, :behind_firewall=>true, :contains_sensitive_data=>true}}}
+ {:production=>{:www=>{:addresses=>[#<URI::HTTP:0xb7e8b018 URL:http://www.designingpatterns.com>, #<URI::HTTP:0xb7e8aed8 URL:http://tokyo.designingpatterns.com>], :num_cpus=>64, :os=>{:version=>10.0, :name=>"Solaris"}, :behind_firewall=>true, :contains_sensitive_data=>true}}}

data/History.txt

@@ -1,3 +1,8 @@
+=== 2.1.0 / 2008-07-25
+* Small documentation enhancements
+* Add a patch for properly documenting configuration parameters for rdoc
+  version 2.1.0, in addition to the existing patch for rdoc version 2.0.0
+
 === 2.0.0 / 2008-07-03
 This version of the ConfigToolkit has a ton of enhancements.  I really would
 welcome input from the community about it!

data/Manifest.txt

@@ -40,6 +40,8 @@ lib/configtoolkit/types.rb
 lib/configtoolkit/writer.rb
 lib/configtoolkit/yamlreader.rb
 lib/configtoolkit/yamlwriter.rb
+rdoc_support/rdoc-2.0.0.patch
+rdoc_support/rdoc-2.1.0.patch
 test/readerwritertest.rb
 test/test_baseconfig.rb
 test/test_hash.rb

data/README.txt

@@ -3,8 +3,8 @@
 * Documentation: http://configtoolkit.rubyforge.org/
 
 == DESCRIPTION:
-This package makes sourcing information from configuration files robust
-and easy!  It:
+This package makes sourcing information from (parsing) configuration files
+robust and easy!  It:
 * Allows programmers to specify the type of data that should be loaded
   from a configuration file.  The toolkit automatically will validate
   the file's data against this specification when loading the file, ensuring
@@ -15,9 +15,9 @@ and easy!  It:
   from the configuration's specification.
 * Allows programmers to create configuration files,
   easily and programatically.
-* Provides a class that can load Ruby configuration files (allowing the
+* Provides a class that can load (parse) Ruby configuration files (allowing the
   full power of Ruby to be used within configuration files).
-* Provides classes that can load from and dump to YAML and key-value
+* Provides classes that can load from (parse) and dump to YAML and key-value
   configuration files.
 * Provides classes that can load from and dump to Hashes.
 * Is very extensible, allowing the engine to be used with custom format
@@ -64,9 +64,9 @@ and easy!  It:
   same configuration file and can be loaded into separate configuration
   instances (by specifying a different "containing object name" for each
   ConfigToolkit::BaseConfig#load call)
-* A reader class to read Ruby configuration files
+* A reader class to read (parse) Ruby configuration files
   (ConfigToolkit::RubyReader)
-* A reader class to read YAML configuration files
+* A reader class to read (parse) YAML configuration files
   (ConfigToolkit::YAMLReader)
 * A writer class to dump YAML configuration files
   (ConfigToolkit::YAMLWriter)
@@ -74,7 +74,7 @@ and easy!  It:
   (ConfigToolkit::HashReader)
 * A writer class do dump configuration directly to a Hash
   (ConfigToolkit::HashWriter)
-* A reader class to read key-value configuration files
+* A reader class to read (parse) key-value configuration files
   (ConfigToolkit::KeyValueReader)
 * A writer class to dump key-value configuration files
   (ConfigToolkit::KeyValueWriter)
@@ -85,7 +85,7 @@ and easy!  It:
 * The ConfigToolkit code has detailed comments.
 * The ConfigToolkit code has many example programs (in the +examples+
   subdirectory).
-* The ConfigToolkit package includesx extensive documentation, including
+* The ConfigToolkit package includes extensive documentation, including
   FAQ.txt and documentation for the support file formats.
 
 == PROBLEMS:

data/Rakefile

@@ -3,7 +3,7 @@
 require 'rubygems'
 require 'hoe'
 
-Hoe.new('configtoolkit', "2.0.0") do |p|
+Hoe.new('configtoolkit', "2.1.0") do |p|
   p.extra_deps << ['relative', '>= 1.0.0']
   p.extra_deps << ['assertions', '>= 1.0.0']
   p.remote_rdoc_dir = ''

data/rdoc_support/rdoc-2.0.0.patch

@@ -0,0 +1,24 @@
+--- parse_rb.rb	2008-07-14 12:25:06.000000000 -0400
++++ /usr/lib/ruby/gems/1.8/gems/rdoc-2.0.0/lib/rdoc/parsers/parse_rb.rb	2008-07-14 12:32:02.000000000 -0400
+@@ -2505,6 +2505,21 @@
+       rw = @options.extra_accessor_flags[tk.name]
+     end
+ 
++    #
++    # This is a temporary hack.
++    # At some point in the (near) future, this should be specifiable via
++    # rdoc's command-line options.
++    # 
++    # Unlike the attr* family of functions, only the first argument of 
++    # the add*param functions is an attribute; the other arguments
++    # constrain the attribute.
++    #
++    if((tk.name == "add_optional_param") || (tk.name == "add_required_param"))
++      if(args.size > 1)
++        args[1, args.size - 1] = nil
++      end
++    end
++    
+     for name in args
+       att = RDoc::Attr.new get_tkread, name, rw, comment
+       context.add_attribute att

data/rdoc_support/rdoc-2.1.0.patch

@@ -0,0 +1,24 @@
+--- rdoc-2.1.0/lib/rdoc/parser/ruby.rb	2008-07-25 13:09:44.000000000 -0400
++++ /usr/lib/ruby/gems/1.8/gems/rdoc-2.1.0/lib/rdoc/parser/ruby.rb	2008-07-25 13:08:37.000000000 -0400
+@@ -1807,6 +1807,21 @@
+       rw = '?' if rw.nil?
+     end
+ 
++    #
++    # This is a temporary hack.
++    # At some point in the (near) future, this should be specifiable via
++    # rdoc's command-line options.
++    # 
++    # Unlike the attr* family of functions, only the first argument of 
++    # the add*param functions is an attribute; the other arguments
++    # constrain the attribute.
++    #
++    if((tk.name == "add_optional_param") || (tk.name == "add_required_param"))
++      if(args.size > 1)
++        args[1, args.size - 1] = nil
++      end
++    end
++    
+     for name in args
+       att = RDoc::Attr.new get_tkread, name, rw, comment
+       context.add_attribute att

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: configtoolkit
 version: !ruby/object:Gem::Version 
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors: 
 - DesigningPatterns
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-14 00:00:00 -04:00
+date: 2008-07-25 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,7 +42,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.7.0
     version: 
-description: "This package makes sourcing information from configuration files robust and easy!  It: * Allows programmers to specify the type of data that should be loaded from a configuration file.  The toolkit automatically will validate the file's data against this specification when loading the file, ensuring that the specification always is obeyed and saving the programmer the tedious chore of writing validation code. * Automagically generates parameter accessor methods (getters, setters, and predicates to test for presence), an equality operator, and a +to_s+ method from the configuration's specification. * Allows programmers to create configuration files, easily and programatically. * Provides a class that can load Ruby configuration files (allowing the full power of Ruby to be used within configuration files). * Provides classes that can load from and dump to YAML and key-value configuration files. * Provides classes that can load from and dump to Hashes. * Is very extensible, allowing the engine to be used with custom format configuration files and with custom data validation rules."
+description: "This package makes sourcing information from (parsing) configuration files robust and easy!  It: * Allows programmers to specify the type of data that should be loaded from a configuration file.  The toolkit automatically will validate the file's data against this specification when loading the file, ensuring that the specification always is obeyed and saving the programmer the tedious chore of writing validation code. * Automagically generates parameter accessor methods (getters, setters, and predicates to test for presence), an equality operator, and a +to_s+ method from the configuration's specification. * Allows programmers to create configuration files, easily and programatically. * Provides a class that can load (parse) Ruby configuration files (allowing the full power of Ruby to be used within configuration files). * Provides classes that can load from (parse) and dump to YAML and key-value configuration files. * Provides classes that can load from and dump to Hashes. * Is very extensible, allowing the engine to be used with custom format configuration files and with custom data validation rules."
 email: 
 - technical.inquiries@designingpatterns.com
 executables: []
@@ -101,6 +101,8 @@ files:
 - lib/configtoolkit/writer.rb
 - lib/configtoolkit/yamlreader.rb
 - lib/configtoolkit/yamlwriter.rb
+- rdoc_support/rdoc-2.0.0.patch
+- rdoc_support/rdoc-2.1.0.patch
 - test/readerwritertest.rb
 - test/test_baseconfig.rb
 - test/test_hash.rb
@@ -170,7 +172,7 @@ rubyforge_project: configtoolkit
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: "This package makes sourcing information from configuration files robust and easy!  It: * Allows programmers to specify the type of data that should be loaded from a configuration file"
+summary: "This package makes sourcing information from (parsing) configuration files robust and easy!  It: * Allows programmers to specify the type of data that should be loaded from a configuration file"
 test_files: 
 - test/test_baseconfig.rb
 - test/test_ruby.rb