shuber-hattr_accessor 1.0.3 → 1.0.4

data/CHANGELOG

@@ -1,3 +1,7 @@
+2009-01-12 - Sean Huber (shuber@huberry.com)
+  * Check for existing reader and writer methods separately before creating default ones for options[:attribute]
+  * Remove alias_method_chain - unnecessary
+
 2009-01-10 - Sean Huber (shuber@huberry.com)
   * Object includes Huberry::AliasMethodChain instead of Module
   * Remove init.rb

data/README.markdown

@@ -1,54 +1,55 @@
 hattr\_accessor
 ===============
 
-Allows you to define attr\_accessors that reference members of a hash.
+Allows you to define attr\_accessors that reference members of a hash
 
 
 Installation
 ------------
 
 	gem install shuber-hattr_accessor --source http://gems.github.com
-	OR
-	script/plugin install git://github.com/shuber/proxy.git
 
 
 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:
+The hattr\_accessor method requires an option named `:attribute` which should be name of an attribute which will store the hash. For example:
 
-	class SomeClass
-	  attr_accessor :my_hash
-	  hattr_accessor :my_attr, :attribute => :my_hash
+	class DataSource
+	  hattr_accessor :adapter, :username, :password, :attribute => :credentials
 	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:
+The reader and writer methods for `:attribute` (`:credentials` in the example above) would be automatically created unless they exist already. 
+You can then use those attributes like normal ones:
 
-	class SomeClass
-	  attr_accessor :my_hash
-	  hattr_accessor :birth_day, :birth_year, :type => :integer, :attribute => :my_hash
-	end
+	@data_source = DataSource.new
+	@data_source.adapter = 'mysql'
+	@data_source.username = 'root'
+	@data_source.credentials # { :adapter => 'mysql', :username => 'root' }
 	
-	@some_class.birth_day = '12'
-	@some_class.birth_day # => 12
-	
-	@some_class.birth_year = 2008
-	@some_class.birth_year # => 2008
+	@data_source.credentials = {}
+	@data_source.adapter # nil
+
+The reader method for `:attribute` is overwritten with logic to ensure that it returns a hash by default.
 
-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:
+	@data_source = DataSource.new
+	@data_source.credentials # {}
 
-	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
+You may optionally pass a `:type` option which will type cast the values when calling their getter methods. This is useful if you're using this 
+gem with rails which will pass values as strings if submitted from a form. For example:
+
+	class CustomField::Date < CustomField
+	  hattr_accessor :offset, :type => :integer, :attribute => :configuration
+	  hattr_accessor :unit, :reference, :type => :string, :attribute => :configuration
+	  
+	  def default_value
+	    self.offset.send(self.unit.to_sym).send(self.reference.to_sym)
 	  end
 	end
+	
+	@custom_field = CustomField::Date.new(:offset => '5', :unit => 'days', :reference => 'from_now')
+	@custom_field.offset # 5 (notice it's an integer, not a string)
+	@custom_field.default_value # evaluates 5.days.from_now 
 
 The current options (email me for suggestions for others) for `:type` are:
 
@@ -57,27 +58,16 @@ The current options (email me for suggestions for others) for `:type` are:
 	:float
 	:boolean
 
-
-Example
--------
+NOTE: Make sure your call `define_attribute_methods` before calling `hattr_accessor` when you're using ActiveRecord and your `:attribute` is a 
+database field.
 
 	class CustomField < ActiveRecord::Base
-	  # has a text or blob attribute named :configuration
+	  define_attribute_methods
+	  
 	  serialize :configuration, Hash
+	  
+	  hattr_accessor :testing, :attribute => :configuration
 	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

data/lib/hattr_accessor.rb

@@ -1,8 +1,3 @@
-unless Object.method_defined? :alias_method_chain
-  require File.dirname(__FILE__) + '/alias_method_chain'
-  Object.send :include, Huberry::AliasMethodChain
-end
-
 module Huberry
   module HattrAccessor
     class MissingAttributeError < StandardError; self; end
@@ -10,7 +5,7 @@ module Huberry
     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?
+      raise MissingAttributeError, 'Must specify the :attribute option with the name of an attribute which will store the hash' if options[:attribute].nil?
 
       attrs.each do |name|
         # Defines a type casting getter method for each attribute
@@ -25,7 +20,7 @@ module Huberry
             when :float
               value.to_f
             when :boolean
-              ![false, nil, 0, '0'].include? value
+              ![false, nil, 0, '0'].include?(value)
             else
               value
           end
@@ -38,15 +33,24 @@ module Huberry
         end
       end
       
+      # Create the reader for #{options[:attribute]} unless it exists already
+      #
+      attr_reader options[:attribute] unless instance_methods.include?(options[:attribute].to_s)
+      
+      # Create the writer for #{options[:attribute]} unless it exists already
+      #
+      attr_writer options[:attribute] unless instance_methods.include?("#{options[:attribute]}=")
+      
       # 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"
+      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
+          alias_method :#{options[:attribute]}_without_hattr_accessor, :#{options[:attribute]}
+          alias_method :#{options[:attribute]}, :#{options[:attribute]}_with_hattr_accessor
         EOF
       end
     end

data/test/hattr_accessor_test.rb

@@ -2,12 +2,19 @@ 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
+  
+  def configuration2
+    @configuration2 ||= { :some_default_reader_value => true }
+  end
+  
+  def configuration2=(value)
+    @configuration2 = value.merge(:some_default_writer_value => true)
+  end
 end
 
 class HattrAccessorTest < Test::Unit::TestCase
@@ -99,7 +106,7 @@ class HattrAccessorTest < Test::Unit::TestCase
   
   def test_should_set_required_in_configuration2
     @custom_field.required = true
-    assert_equal({ :required => true }, @custom_field.configuration2)
+    assert_equal true, @custom_field.configuration2[:required]
   end
   
   def test_should_get_required
@@ -138,10 +145,13 @@ class HattrAccessorTest < Test::Unit::TestCase
     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
+  def test_should_not_overwrite_existing_reader
+    assert_equal true, @custom_field.configuration2[:some_default_reader_value]
   end
-
+  
+  def test_should_not_overwrite_existing_writer
+    @custom_field.configuration2 = {}
+    assert_equal true, @custom_field.configuration2[:some_default_writer_value]
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shuber-hattr_accessor
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors: 
 - Sean Huber
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-10 00:00:00 -08:00
+date: 2009-01-12 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -23,7 +23,6 @@ extra_rdoc_files: []
 
 files: 
 - CHANGELOG
-- lib/alias_method_chain.rb
 - lib/hattr_accessor.rb
 - MIT-LICENSE
 - Rakefile

data/lib/alias_method_chain.rb

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