shuber-hattr_accessor 1.0.1

data/CHANGELOG

@@ -0,0 +1,8 @@
+2008-10-17 - Sean Huber (shuber@einsteinindustries.com)
+	* Refactor #{attribute}_with_hattr_accessor method
+	* Rename doc/README.markdown to doc/README
+
+2008-10-14 - Sean Huber (shuber@huberry.com)
+	* Initial import
+	* Update README
+	* Add tests to ensure errors are raised when :attribute does not exist

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Sean Huber (shuber@huberry.com)
+ 
+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

@@ -0,0 +1,88 @@
+hattr_accessor
+==============
+
+A gem/plugin that allows you to define attr_accessors that reference members of a hash.
+
+
+Installation
+------------
+
+	script/plugin install git://github.com/shuber/proxy.git
+
+OR
+
+	gem install shuber-hattr_accessor
+
+
+Usage
+-----
+
+The hattr_accessor method requires an option named :attribute which should be a symbol that represents the attribute name of the hash that you want to reference. For example:
+
+	class SomeClass
+	  attr_accessor :my_hash
+	  hattr_accessor :my_attr, :attribute => :my_hash
+	end
+	
+	@some_class = SomeClass.new
+	@some_class.my_attr = 'test'
+	@some_class.my_hash # => { :my_attr => 'test' }
+
+You may optionally pass a :type option which will type cast the value when calling the getter method. For example:
+
+	class SomeClass
+	  attr_accessor :my_hash
+	  hattr_accessor :birth_day, :birth_year, :type => :integer, :attribute => :my_hash
+	end
+	
+	@some_class.birth_day = '12'
+	@some_class.birth_day # => 12
+	
+	@some_class.birth_year = 2008
+	@some_class.birth_year # => 2008
+
+This is useful if you're using this gem/plugin with ActiveRecord which will pass values as strings if submitted from a form. For Example:
+
+	class SomeController < ApplicationController
+	  def create
+	    @some_class = SomeClass.new(params[:some_class])
+	    @some_class.birth_day # => '12'
+	    # notice it returns as a string instead of an integer
+	    # using :type => :integer will fix this
+	  end
+	end
+
+The current options (email me for suggestions for others) for :type are:
+
+	:string
+	:integer
+	:float
+	:boolean
+
+
+Example
+-------
+
+	class CustomField < ActiveRecord::Base
+	  # has a text or blob attribute named :configuration
+	  serialize :configuration, Hash
+	end
+	
+	class CustomFields::Date < CustomField
+	  hattr_accessor :offset, :type => :integer, :attribute => :configuration
+	  hattr_accessor :unit, :reference, :attribute => :configuration
+		
+	  def default_value
+	    self.offset.send(self.unit).send(self.reference)
+	  end
+	end
+	
+	@field = CustomFields::Date.new({ :offset => '5', :unit => 'days', :reference => 'from_now' })
+	@field.configuration # => { :offset => '5', :unit => 'days', :reference => 'from_now' }
+	@field.default_value # => evaluates 5.days.from_now
+
+
+Contact
+-------
+
+Problems, comments, and suggestions all welcome: [shuber@huberry.com](mailto:shuber@huberry.com)

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+ 
+desc 'Default: run the hattr_accessor tests'
+task :default => :test
+ 
+desc 'Test the hattr_accessor plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+ 
+desc 'Generate documentation for the hattr_accessor plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'hattr_accessor'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/lib/hattr_accessor'
+$:.unshift File.dirname(__FILE__) + '/lib'

data/lib/alias_method_chain.rb

@@ -0,0 +1,23 @@
+module Huberry
+  module AliasMethodChain # :nodoc:
+    # Defines the alias_method_chain method from rails unless it exists already
+    #
+    def alias_method_chain(target, feature)
+      aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
+      yield(aliased_target, punctuation) if block_given?
+      with_method, without_method = "#{aliased_target}_with_#{feature}#{punctuation}", "#{aliased_target}_without_#{feature}#{punctuation}"
+      alias_method without_method, target
+      alias_method target, with_method
+      case
+        when public_method_defined?(without_method)
+          public target
+        when protected_method_defined?(without_method)
+          protected target
+        when private_method_defined?(without_method)
+          private target
+      end
+    end
+  end
+end
+
+Module.send :include, Huberry::AliasMethodChain unless Module.method_defined? :alias_method_chain

data/lib/hattr_accessor.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/alias_method_chain'
+
+module Huberry
+  module HattrAccessor
+    class MissingAttributeError < StandardError; self; end
+    
+    def hattr_accessor(*attrs)
+      options = attrs.last.is_a?(Hash) ? attrs.pop : {}
+      
+      raise MissingAttributeError, 'Must specify the :attribute option which should be a symbol that references a hash attribute' if options[:attribute].nil?
+
+      attrs.each do |name|
+        # Defines a type casting getter method for each attribute
+        #
+        define_method name do
+          value = send(options[:attribute])[name]
+          case options[:type]
+            when :string
+              value.to_s
+            when :integer
+              value.to_i
+            when :float
+              value.to_f
+            when :boolean
+              ![false, nil, 0, '0'].include? value
+            else
+              value
+          end
+        end
+        
+        # Defines a setter method for each attribute
+        #
+        define_method "#{name}=" do |value|
+          send(options[:attribute])[name] = value
+        end
+      end
+      
+      # Overwrites the method passed as the :attribute option to ensure that it is a hash by default
+      #
+      unless instance_methods.include? "#{options[:attribute]}_with_hattr_accessor"
+        class_eval <<-EOF
+          def #{options[:attribute]}_with_hattr_accessor
+            self.#{options[:attribute]} = {} if #{options[:attribute]}_without_hattr_accessor.nil?
+            #{options[:attribute]}_without_hattr_accessor
+          end
+          alias_method_chain :#{options[:attribute]}, :hattr_accessor
+        EOF
+      end
+    end
+  end
+end
+
+Class.send :include, Huberry::HattrAccessor

data/test/hattr_accessor_test.rb

@@ -0,0 +1,147 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/hattr_accessor'
+
+class CustomField
+  attr_accessor :configuration, :configuration2
+  hattr_accessor :name, :type, :type => :string, :attribute => :configuration
+  hattr_accessor :unit, :reference, :attribute => :configuration
+  hattr_accessor :offset, :type => :integer, :attribute => :configuration
+  hattr_accessor :amount, :type => :float, :attribute => :configuration
+  hattr_accessor :required, :type => :boolean, :attribute => :configuration2
+end
+
+class HattrAccessorTest < Test::Unit::TestCase
+  
+  def setup
+    @custom_field = CustomField.new
+  end
+  
+  def test_should_alias_method_chain_configuration
+    assert CustomField.method_defined?(:configuration_with_hattr_accessor)
+    assert CustomField.method_defined?(:configuration_without_hattr_accessor)
+  end
+  
+  def test_configuration_should_be_a_hash_by_default
+    assert_equal({}, @custom_field.configuration)
+  end
+  
+  def test_should_set_name
+    @custom_field.name = 'Date'
+    assert_equal({ :name => 'Date' }, @custom_field.configuration)
+  end
+  
+  def test_should_get_name
+    @custom_field.name = 'Date'
+    assert_equal 'Date', @custom_field.name
+  end
+  
+  def test_should_type_cast_name_as_string
+    assert_equal '', @custom_field.name
+  end
+  
+  def test_should_set_and_get_an_attribute_named_type
+    @custom_field.type = 'Date'
+    assert_equal 'Date', @custom_field.type
+  end
+  
+  def test_should_set_unit
+    @custom_field.unit = 'days'
+    assert_equal({ :unit => 'days' }, @custom_field.configuration)
+  end
+  
+  def test_should_get_unit
+    @custom_field.unit = 'days'
+    assert_equal 'days', @custom_field.unit
+  end
+  
+  def test_should_set_reference
+    @custom_field.reference = 'from_now'
+    assert_equal({ :reference => 'from_now' }, @custom_field.configuration)
+  end
+  
+  def test_should_get_reference
+    @custom_field.reference = 'from_now'
+    assert_equal 'from_now', @custom_field.reference
+  end
+  
+  def test_should_set_offset
+    @custom_field.offset = 1
+    assert_equal({ :offset => 1 }, @custom_field.configuration)
+  end
+  
+  def test_should_get_offset
+    @custom_field.offset = 1
+    assert_equal 1, @custom_field.offset
+  end
+  
+  def test_should_type_cast_offset_as_integer
+    @custom_field.offset = '1'
+    assert_equal 1, @custom_field.offset
+  end
+  
+  def test_should_set_amount
+    @custom_field.amount = 1.0
+    assert_equal({ :amount => 1.0 }, @custom_field.configuration)
+  end
+  
+  def test_should_get_amount
+    @custom_field.amount = 1.0
+    assert_equal 1.0, @custom_field.amount
+  end
+  
+  def test_should_type_cast_amount_as_float
+    @custom_field.amount = '1'
+    assert_equal 1.0, @custom_field.amount
+    
+    @custom_field.amount = 1
+    assert_equal 1.0, @custom_field.amount
+  end
+  
+  def test_should_set_required_in_configuration2
+    @custom_field.required = true
+    assert_equal({ :required => true }, @custom_field.configuration2)
+  end
+  
+  def test_should_get_required
+    @custom_field.required = true
+    assert_equal true, @custom_field.required
+  end
+  
+  def test_should_type_cast_required_as_boolean
+    assert_equal false, @custom_field.required
+    
+    @custom_field.required = false
+    assert_equal false, @custom_field.required
+    
+    @custom_field.required = 0
+    assert_equal false, @custom_field.required
+    
+    @custom_field.required = '0'
+    assert_equal false, @custom_field.required
+    
+    @custom_field.required = true
+    assert_equal true, @custom_field.required
+    
+    @custom_field.required = 1
+    assert_equal true, @custom_field.required
+    
+    @custom_field.required = '1'
+    assert_equal true, @custom_field.required
+    
+    @custom_field.required = ''
+    assert_equal true, @custom_field.required
+  end
+  
+  def test_should_raise_exception_if_attribute_option_is_not_passed
+    assert_raises Huberry::HattrAccessor::MissingAttributeError do
+      CustomField.hattr_accessor :test
+    end
+  end
+  
+  def test_should_raise_exception_if_attribute_option_reference_does_not_exist
+    assert_raises NameError do
+      CustomField.hattr_accessor :test, :attribute => :non_existent
+    end
+  end
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: shuber-hattr_accessor
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Sean Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A gem/plugin that allows you to define attr_accessors that reference members of a hash
+email: shuber@huberry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- init.rb
+- lib/alias_method_chain.rb
+- lib/hattr_accessor.rb
+- MIT-LICENSE
+- Rakefile
+- README
+has_rdoc: false
+homepage: http://github.com/shuber/hattr_accessor
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A gem/plugin that allows you to define attr_accessors that reference members of a hash
+test_files: 
+- test/hattr_accessor_test.rb