namedarguments 0.0.2 → 0.0.3

data/README.txt

@@ -3,17 +3,28 @@ NamedArguments
 
 == DESCRIPTION:
 
-=== Not yet ready for production.
+Adds the ability to call class constructors with a hash of arguments to
+initialize attributes in the new object.
 
 == FEATURES/PROBLEMS:
   
-== SYNOPSYS:
-
-== REQUIREMENTS:
+  class Snark
+    include NamedArguments
+    
+    attr_accessor :color, :size, :name
+    
+    attribute_defaults :color => 'blue', :size => lambda {|s| some_method_call(s)}
+    required_fields :color, :name
+    required_respond_to :name => :to_s
+    required_kind_of? :size => Fixnum
+    type_conversion :size => Fixnum
+  end
+
+  s = Snark.new :boojum => 7, :color => red
 
 == INSTALL:
 
-sudo gem install
+gem install namedarguments
 
 == LICENSE:
 

data/Rakefile

@@ -6,7 +6,7 @@ Hoe.new('namedarguments', NamedArguments::VERSION) do |p|
   p.summary = 'Provide named arguments (hashes) to constructors to initialize attributes.'
   p.author = "James M Moore"
   p.email = 'james@phonesonrails.com'
-  # p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
   # p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
 end

data/lib/hash_extended_tools.rb

@@ -1,17 +1,27 @@
-# Hash utilities.
+# Provides several hash utilities.
 # 
 # Note that you need to extend your hash with this module:
 # 
 #   hash = {}
 #   hash.extend HashExtendedTools
 #   hash = hash.exclude :foo, :bar
+# 
+# Or create a new class:
+# 
+#   class HashWithExtendedTools < Hash
+#     include HashExtendedTools
+#   end
 module HashExtendedTools
   # Change keys in a hash.
   # 
   # Pass in a hash of:
   # 
-  #   :old_key => :new_key
-  def switch_keys(args = {})
+  #   old_key => new_key
+  # 
+  # Any keys matching +old_key+ will be
+  # deleted and a new entry created with
+  # the same value and the new key.
+  def switch_keys args = {}
     args.each_pair do
       |old_key, new_key|
       if self.has_key?(old_key)
@@ -21,6 +31,14 @@ module HashExtendedTools
     end
   end
   
+  # Return a new hash not including
+  # keys that are contained in 
+  # +keys_to_exclude+.
+  # 
+  # Keys that match entries in 
+  # +keys_to_exclude+ are deleted if
+  # either they match as string or a 
+  # symbol (created with to_sym).
   def exclude *keys_to_exclude
     result = self.dup
     keys_to_exclude.each do |k|
@@ -34,6 +52,9 @@ module HashExtendedTools
   # return a hash containing
   # the key/value pairs
   # for the matching keys.
+  # 
+  # Values that are nil are not
+  # returned.
   def slice *slice_keys
     result = {}
     slice_keys.each do |k|

data/lib/named_arguments.rb

@@ -9,7 +9,7 @@ require File.dirname(__FILE__) + '/singleton_creator_mixin'
 # * Set default values for arguments (attribute_defaults)
 # * Require arguments (required_fields)
 # * Require kind_of? tests for arguments (required_kind_of)
-# * Change the type of the object passed in (type_conversion)
+# * Change the type of the object passed in (type_converter)
 # 
 # =Sample
 #
@@ -22,14 +22,17 @@ require File.dirname(__FILE__) + '/singleton_creator_mixin'
 #    required_fields :color, :name
 #    required_respond_to :name => :to_s
 #    required_kind_of? :size => Fixnum
-#    type_conversion :size => Fixnum
+#    type_converter :size => Fixnum
 #  end
 #  
 # = See also
 # 
-# See NamedArgumentsClassMethods for more methods.
+# See NamedArgumentsClassMethods for more methods:
+# 
+# * NamedArgumentsClassMethods#type_converter
+# * NamedArgumentsClassMethods#option_attr
 module NamedArguments
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
   
   include HashExtendedTools
   
@@ -167,9 +170,15 @@ module NamedArguments
     end
   end
   
-  # For every key/value pair in +args+, call:
+  # For every key/value pair in +args+, set the
+  # value of the attribute +key+ to +value+.
   # 
-  #   self.send k, 
+  #  class Snark
+  #    include NamedArguments
+  #    attr_accessor :boojum
+  #  end
+  #  
+  #  s = Snark.new :boojum => 7
   def initialize args = {}
     if kind_of? ActiveRecord::Base
       super
@@ -201,39 +210,42 @@ module NamedArguments
       option_attr_storage.include? k
     end
   end
-end
-
-module NamedArgumentsClassMethods
-  def option_attr *array_of_names
-    array_of_names.each { |n| 
-      define_method n, lambda {
-        option_attr_get n
-      }
-      define_method "#{n}=", lambda { |v|
-        option_attr_set n, v
+  
+  # Class methods (methods of the class
+  # object itself) provided when 
+  # NamedArguments in included.
+  module NamedArgumentsClassMethods
+    def option_attr *array_of_names
+      array_of_names.each { |n| 
+        define_method n, lambda {
+          option_attr_get n
+        }
+        define_method "#{n}=", lambda { |v|
+          option_attr_set n, v
+        }
       }
-    }
-  end
-  
-  def type_converter field, new_klass
-    alias_name = ('attribute_setter_for_' + field.to_s).to_sym
-    setter_method_name = (field.to_s + '=').to_sym
-    alias_method alias_name, setter_method_name
-    send :define_method, setter_method_name do |rhs|
-      if [Fixnum].member? new_klass
-        v = rhs.to_i
-      elsif new_klass == String
-        v = rhs.to_s
-      elsif new_klass == Symbol
-        v = rhs.to_sym
-      elsif new_klass == :boolean
-        v = !!rhs
-      elsif new_klass.kind_of? Proc
-        v = new_klass.call v
-      else
-        v = new_klass.new rhs
+    end
+    
+    def type_converter field, new_klass
+      alias_name = ('attribute_setter_for_' + field.to_s).to_sym
+      setter_method_name = (field.to_s + '=').to_sym
+      alias_method alias_name, setter_method_name
+      send :define_method, setter_method_name do |rhs|
+        if [Fixnum].member? new_klass
+          v = rhs.to_i
+        elsif new_klass == String
+          v = rhs.to_s
+        elsif new_klass == Symbol
+          v = rhs.to_sym
+        elsif new_klass == :boolean
+          v = !!rhs
+        elsif new_klass.kind_of? Proc
+          v = new_klass.call v
+        else
+          v = new_klass.new rhs
+        end
+        self.send alias_name, v
       end
-      self.send alias_name, v
     end
   end
 end

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: namedarguments
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2006-12-05 00:00:00 -08:00
+  version: 0.0.3
+date: 2006-12-06 00:00:00 -08:00
 summary: Provide named arguments (hashes) to constructors to initialize attributes.
 require_paths: 
 - lib
 email: james@phonesonrails.com
 homepage: http://www.zenspider.com/ZSS/Products/namedarguments/
 rubyforge_project: namedarguments
-description: The author was too lazy to write a description
+description: "Adds the ability to call class constructors with a hash of arguments to initialize attributes in the new object.  == FEATURES/PROBLEMS:  class Snark include NamedArguments  attr_accessor :color, :size, :name  attribute_defaults :color => 'blue', :size => lambda {|s| some_method_call(s)} required_fields :color, :name required_respond_to :name => :to_s required_kind_of? :size => Fixnum type_conversion :size => Fixnum end  s = Snark.new :boojum => 7, :color => red  == INSTALL:"
 autorequire: 
 default_executable: 
 bindir: bin