hashmake 0.1.0 → 0.1.1

data/ChangeLog.rdoc

@@ -2,3 +2,8 @@
 
 * Initial release:
 
+Supports hash-based initialization of objects, given that the class include HashMakeable and calls hash_make on the given args hash.
+
+=== 0.1.1 / 2013-02-03
+
+Changed HashedArg to ArgSpec. Added documentation.

data/README.md

@@ -1,4 +1,8 @@
 hashmake
 ========
 
-Like making your ruby objects with hashed args? This lib aims to make the process easier and more powerful
+Like making your ruby objects with hashed args? This lib aims to make the process easier and more powerful.
+
+Provides hash_make method that can consider parameter name, type, default value, validation, and requiredd/not, according to the specification provided.
+
+Also, by default assigns to instance variable of same name as parameter.

data/README.rdoc

@@ -6,7 +6,11 @@
 
 == Description
 
-Make hash-based object initialization easy! Provides hash_make method that can consider parameter name, type, default value, validation, and requiredd/not, according to the specification provided. Also, by default assigns by default to instance variable of same name as parameter.
+Make hash-based object initialization easy!
+
+Provides hash_make method that can consider parameter name, type, default value, validation, and requiredd/not, according to the specification provided.
+
+Also, by default assigns to instance variable of same name as parameter.
 
 == Features
 

data/hashmake.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake', '~> 0.8'
   gem.add_development_dependency 'rspec', '~> 2.4'
   gem.add_development_dependency 'yard', '~> 0.8'
+  gem.add_development_dependency 'pry'
 end

data/lib/hashmake.rb

@@ -1,3 +1,3 @@
 require 'hashmake/version'
-require 'hashmake/hashed_arg'
+require 'hashmake/arg_spec'
 require 'hashmake/hash_makeable'

data/lib/hashmake/arg_spec.rb

@@ -0,0 +1,59 @@
+module Hashmake
+
+# Provides a specification of how a hashed arg is to be processed by the
+# hash_make method. 
+# 
+# @author James Tunnell
+# 
+class ArgSpec
+  
+  # Defines default key/value pairs to use in initializing an instance.
+  DEFAULT_ARGS = {
+    :reqd => true,
+    :validator => ->(a){true},
+    :array => false,
+  }
+  
+  attr_reader :key, :type, :validator, :reqd, :default, :array
+  
+  # A new instance of ArgSpec. 
+  # 
+  # @param [Hash] hashed_args Hash to use in initializing an instance. Required
+  #                           keys are :key and :type. Optional keys are :reqd,
+  #                           :validator, :array, and :default.
+  #                           :key => the key used to identify a hashed arg.
+  #                           :type => the type of object expected to be paired
+  #                                    with the key.
+  #                           :reqd => If true, the arg key must be in the hash
+  #                                    passed to #initialize. If false, then a
+  #                                    default must be specified with :default
+  #                                    key. Set to true by default.
+  #                           :default => If reqd is false, this must be specified.
+  #                                       This can be any object reference. If it
+  #                                       is a Proc, then the Proc will be called,
+  #                                       expecting it to produce the default.
+  #                           :validator => a Proc used to check the validity of
+  #                                         whatever value is paired with an arg key.
+  #                           :array => indicates the arg key will be paired with
+  #                                     an array containing objects of the type
+  #                                     specified by :type.
+  def initialize hashed_args
+    new_args = DEFAULT_ARGS.merge(hashed_args)
+    
+    @key = new_args[:key]
+    @type = new_args[:type]
+    raise ArgumentError, "args[:type] #{@type} is not a Class" unless @type.is_a?(Class)
+    
+    @validator = new_args[:validator]
+    @reqd = new_args[:reqd]
+    @array = new_args[:array]
+    
+    unless @reqd
+      msg = "if hashed arg is not required, a default value or value generator (proc) must be defined via :default key"
+      raise ArgumentError, msg unless new_args.has_key?(:default)
+      @default = new_args[:default]
+    end
+  end
+
+end
+end

data/lib/hashmake/hash_makeable.rb

@@ -7,9 +7,20 @@ module HashMakeable
     base.extend(ClassMethods)
   end
 
+  # Process a hash that contains 'hashed args'. Each hashed arg is intended to
+  # be used in initializing an object instance. 
+  #
+  # @param [Enumerable] arg_specs An enumerable of ArgSpec objects. Each object
+  #                               details an arg key that might be expected in the
+  #                               args hash.
+  # @param [Hash] hashed_args A hash that should contain at least all the required
+  #                           keys and valid values, according to the arg_specs passed in.
+  #                           Nonrequired keys can be given as well, but if they are
+  #                           not then a default value is assigned (again, according to
+  #                           arg_specs passed in).
   def hash_make arg_specs, hashed_args, assign_args = true
     arg_specs.each do |arg_spec|
-      raise ArgumentError, "arg_specs item #{arg_spec} is not a HashedArg" unless arg_spec.is_a?(HashedArg)
+      raise ArgumentError, "arg_specs item #{arg_spec} is not a ArgSpec" unless arg_spec.is_a?(ArgSpec)
     end
     raise ArgumentError, "hashed_args is not a Hash" unless hashed_args.is_a?(Hash)
 
@@ -45,8 +56,10 @@ module HashMakeable
     end
   end
 
+  # Contains class methods to be added to a class that includes the
+  # HashMakeable module.
   module ClassMethods
-    # none right now, maybe later
+    
   end
 
 end

data/lib/hashmake/version.rb

@@ -1,4 +1,8 @@
+# This module provides the outer namespace of the hashmake gem.
+#
+# @author James Tunnell
+#
 module Hashmake
   # hashmake version
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/{hashed_arg_spec.rb → arg_spec_spec.rb}

@@ -1,12 +1,12 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe Hashmake::HashedArg do
+describe Hashmake::ArgSpec do
   it 'should raise ArgumentError if :reqd is false and no :default value is given' do
     hash = {
       :reqd => false, :key => :some_variable, :type => String
     }
     
-    lambda { Hashmake::HashedArg.new hash }.should raise_error(ArgumentError)
+    lambda { Hashmake::ArgSpec.new hash }.should raise_error(ArgumentError)
   end
   
   it 'should not raise ArgumentError if :reqd is false and a :default value is given' do
@@ -14,6 +14,6 @@ describe Hashmake::HashedArg do
       :reqd => false, :key => :some_variable, :type => String, :default => ""
     }
     
-    lambda { Hashmake::HashedArg.new hash }.should_not raise_error(ArgumentError)
+    lambda { Hashmake::ArgSpec.new hash }.should_not raise_error(ArgumentError)
   end
 end

data/spec/hash_makeable_spec.rb

@@ -5,8 +5,8 @@ describe Hashmake::HashMakeable do
     include HashMakeable
     
     HASHED_ARG_SPECS = [
-      HashedArg.new(:reqd => true, :key => :reqd_string, :type => String, :validator => ->(a){ a.length < 10 }),
-      HashedArg.new(:reqd => false, :key => :not_reqd_float, :type => Float, :default => 0.0, :validator => ->(a){ a.between?(0.0,1.0) }),
+      ArgSpec.new(:reqd => true, :key => :reqd_string, :type => String, :validator => ->(a){ a.length < 10 }),
+      ArgSpec.new(:reqd => false, :key => :not_reqd_float, :type => Float, :default => 0.0, :validator => ->(a){ a.between?(0.0,1.0) }),
     ]
     
     attr_reader :reqd_string, :not_reqd_float

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashmake
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Make hash-based object initialization easy! Provides hash_make method
   that can consider parameter name, type, default value, validation, and requiredd/not,
   according to the specification provided. Also, by default assigns by default to
@@ -93,11 +109,11 @@ files:
 - Rakefile
 - hashmake.gemspec
 - lib/hashmake.rb
+- lib/hashmake/arg_spec.rb
 - lib/hashmake/hash_makeable.rb
-- lib/hashmake/hashed_arg.rb
 - lib/hashmake/version.rb
+- spec/arg_spec_spec.rb
 - spec/hash_makeable_spec.rb
-- spec/hashed_arg_spec.rb
 - spec/hashmake_spec.rb
 - spec/spec_helper.rb
 homepage: https://rubygems.org/gems/hashmake
@@ -115,7 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -762830051
+      hash: -66247597
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -124,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -762830051
+      hash: -66247597
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -132,8 +148,8 @@ signing_key:
 specification_version: 3
 summary: Make hashed-based object initialization easy!
 test_files:
+- spec/arg_spec_spec.rb
 - spec/hash_makeable_spec.rb
-- spec/hashed_arg_spec.rb
 - spec/hashmake_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/hashmake/hashed_arg.rb

@@ -1,31 +0,0 @@
-module Hashmake
-class HashedArg
-  
-  DEFAULT_ARGS = {
-    :reqd => true,
-    :validator => ->(a){true},
-    :array => false,
-  }
-  
-  attr_reader :key, :type, :validator, :reqd, :default, :array
-  
-  def initialize args
-    new_args = DEFAULT_ARGS.merge(args)
-    
-    @key = new_args[:key]
-    @type = new_args[:type]
-    raise ArgumentError, "args[:type] #{@type} is not a Class" unless @type.is_a?(Class)
-    
-    @validator = new_args[:validator]
-    @reqd = new_args[:reqd]
-    @array = new_args[:array]
-    
-    unless @reqd
-      msg = "if hashed arg is not required, a default value or value generator (proc) must be defined via :default key"
-      raise ArgumentError, msg unless args.has_key?(:default)
-      @default = new_args[:default]
-    end
-  end
-
-end
-end