hashmake 0.1.0

data/.gitignore

@@ -0,0 +1,20 @@
+Gemfile.lock
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/ChangeLog.rdoc

@@ -0,0 +1,4 @@
+=== 0.1.0 / 2013-02-01
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 James Tunnell
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+hashmake
+========
+
+Like making your ruby objects with hashed args? This lib aims to make the process easier and more powerful

data/README.rdoc

@@ -0,0 +1,27 @@
+= hashmake
+
+* {Homepage}[https://rubygems.org/gems/hashmake]
+* {Documentation}[http://rubydoc.info/gems/hashmake/frames]
+* {Email}[mailto:jamestunnell at lavabit.com]
+
+== 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.
+
+== Features
+
+== Examples
+
+  require 'hashmake'
+
+== Requirements
+
+== Install
+
+  $ gem install hashmake
+
+== Copyright
+
+Copyright (c) 2013 James Tunnell
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec
+
+require "bundler/gem_tasks"
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard

data/hashmake.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/hashmake/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "hashmake"
+  gem.version       = Hashmake::VERSION
+  gem.summary       = %q{Make hashed-based object initialization easy!}
+  gem.description   = %q{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.}
+  gem.license       = "MIT"
+  gem.authors       = ["James Tunnell"]
+  gem.email         = "jamestunnell@lavabit.com"
+  gem.homepage      = "https://rubygems.org/gems/hashmake"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 0.8'
+  gem.add_development_dependency 'rspec', '~> 2.4'
+  gem.add_development_dependency 'yard', '~> 0.8'
+end

data/lib/hashmake.rb

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

data/lib/hashmake/hash_makeable.rb

@@ -0,0 +1,53 @@
+module Hashmake
+module HashMakeable
+  
+  # Use the included hook to also extend the including class with HashMake
+  # class methods
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  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)
+    end
+    raise ArgumentError, "hashed_args is not a Hash" unless hashed_args.is_a?(Hash)
+
+    arg_specs.each do |arg_spec|
+      key = arg_spec.key
+      if hashed_args.has_key?(key)
+        val = hashed_args[key]
+      else
+        if arg_spec.reqd
+          raise ArgumentError, "hashed_args does not have required key #{key}"
+        else
+          if arg_spec.default.is_a?(Proc) && arg_spec.type != Proc
+            val = arg_spec.default.call
+          else
+            val = arg_spec.default
+          end
+        end
+      end
+      
+      if arg_spec.array
+        raise ArgumentError, "val #{val} is not an array" unless val.is_a?(Array)
+        val.each do |item|
+          raise ArgumentError, "array item #{item} is not a #{arg_spec.type}" unless item.is_a?(arg_spec.type)
+        end
+      else
+        raise ArgumentError, "val #{val} is not a #{arg_spec.type}" unless val.is_a?(arg_spec.type)
+      end
+      
+      if assign_args
+        raise ArgumentError, "value #{val} is not valid" unless arg_spec.validator.call(val)
+        self.instance_variable_set("@#{key.to_s}".to_sym, val)
+      end
+    end
+  end
+
+  module ClassMethods
+    # none right now, maybe later
+  end
+
+end
+end

data/lib/hashmake/hashed_arg.rb

@@ -0,0 +1,31 @@
+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

data/lib/hashmake/version.rb

@@ -0,0 +1,4 @@
+module Hashmake
+  # hashmake version
+  VERSION = "0.1.0"
+end

data/spec/hash_makeable_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Hashmake::HashMakeable do
+  class MyTestClass
+    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) }),
+    ]
+    
+    attr_reader :reqd_string, :not_reqd_float
+    
+    def initialize hashed_args = {}
+      hash_make MyTestClass::HASHED_ARG_SPECS, hashed_args
+    end
+  end
+  
+  describe '#hash_make' do
+    context 'for a reqd arg' do
+      it 'should raise an ArgumentError if not given in the hash' do
+        lambda { MyTestClass.new }.should raise_error(ArgumentError)
+      end
+    end
+    
+    context 'for a not reqd arg' do
+      it 'should not raise an ArgumentError if not given in the hash' do
+        lambda { MyTestClass.new( :reqd_string => "okedoke" ) }.should_not raise_error(ArgumentError)
+      end      
+    end
+    
+    context 'any arg' do
+      it 'should not raise an ArgumentError if validator returns true' do
+        lambda { MyTestClass.new( :reqd_string => "okedoke" ) }.should_not raise_error(ArgumentError)
+        lambda { MyTestClass.new( :reqd_string => "okedoke", :not_reqd_float => 0.5 ) }.should_not raise_error(ArgumentError)
+      end
+      
+      it 'should raise an ArgumentError if validator returns false' do
+        lambda { MyTestClass.new( :reqd_string => "okedokedokedoke" ) }.should raise_error(ArgumentError)
+        lambda { MyTestClass.new( :reqd_string => "okedoke", :not_reqd_float => 1.1 ) }.should raise_error(ArgumentError)
+      end
+
+      it 'should raise an ArgumentError if arg of incorrect type is given' do
+        lambda { MyTestClass.new( :reqd_string => 1.1 ) }.should raise_error(ArgumentError)
+        lambda { MyTestClass.new( :reqd_string => "okedoke", :not_reqd_float => "" ) }.should raise_error(ArgumentError)
+      end
+      
+      it 'should set instance variables to correspond with each hashed arg' do
+        a = MyTestClass.new :reqd_string => "goodstuff", :not_reqd_float => 0.321
+        a.instance_variables.include?("@#{:reqd_string.to_s}".to_sym).should be_true
+        a.instance_variables.include?("@#{:not_reqd_float.to_s}".to_sym).should be_true
+        a.reqd_string.should eq("goodstuff")
+        a.not_reqd_float.should eq(0.321)
+      end
+    end
+  end  
+end

data/spec/hashed_arg_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Hashmake::HashedArg 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)
+  end
+  
+  it 'should not raise ArgumentError if :reqd is false and a :default value is given' do
+    hash = {
+      :reqd => false, :key => :some_variable, :type => String, :default => ""
+    }
+    
+    lambda { Hashmake::HashedArg.new hash }.should_not raise_error(ArgumentError)
+  end
+end

data/spec/hashmake_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'hashmake'
+
+describe Hashmake do
+  it "should have a VERSION constant" do
+    subject.const_get('VERSION').should_not be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'hashmake'
+
+include Hashmake

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: hashmake
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- James Tunnell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+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.
+email: jamestunnell@lavabit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- ChangeLog.rdoc
+- Gemfile
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- hashmake.gemspec
+- lib/hashmake.rb
+- lib/hashmake/hash_makeable.rb
+- lib/hashmake/hashed_arg.rb
+- lib/hashmake/version.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
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -762830051
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -762830051
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Make hashed-based object initialization easy!
+test_files:
+- spec/hash_makeable_spec.rb
+- spec/hashed_arg_spec.rb
+- spec/hashmake_spec.rb
+- spec/spec_helper.rb
+has_rdoc: