attribute-driven 1.0.1

data/README

@@ -0,0 +1,43 @@
+ATTRIBUTE-DRIVEN
+by Aman King
+
+http://bitbucket.org/amanking/attribute-driven/
+
+A module that 
+(1) allows you to mention a list of attributes in a class, 
+(2) provides reader methods for the attributes, 
+(3) allows initialization of the class via a hash argument that gives values for the attributes,
+(4) overrides equals and hash method to check for field equality 
+
+Usage:
+
+require 'attribute_driven'
+class Money
+  include AttributeDriven
+  attributes :value, :currency
+  # initializes_with :value, :currency #=> only adds the initialize method
+  # equality_based_on :value, :currency #=> only overrides equality methods and hash
+end
+
+money = Money.new(:value => 20, :currency => 'USD') #=> #<Money:0x5138e4 @value=20, @currency="USD">
+money.value #=> 20
+money.currency #=> "USD"
+money == Money.new(:value => 20, :currency => 'USD') #=> true
+
+(see test/attribute_driven_test.rb for more)
+
+License
+
+   Copyright 2009 Aman King
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/lib/attribute-driven.rb

@@ -0,0 +1 @@
+require 'attribute_driven'

data/lib/attribute_driven.rb

@@ -0,0 +1,61 @@
+=begin
+   Copyright 2009 Aman King
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+=end
+
+module AttributeDriven
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    def initializes_with(*attributes)
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        def initialize(params = {})
+          #{attributes.inspect}.each do |attribute|
+            instance_variable_set("@\#{attribute}", params[attribute])
+          end
+        end
+      EOS
+    end
+    
+    def equality_based_on(*attributes)
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        def eql?(other)
+          return true if equal?(other)
+          #{attributes.inspect}.inject(true) do |result, attribute|
+            result &&= (self.send(attribute) == other.send(attribute))
+          end
+        end
+        alias_method :==, :eql?
+        
+        def hash
+          #{attributes.inspect}.inject(0) do |result, attribute|
+            result += self.send(attribute).hash if self.send(attribute)
+            result
+          end
+        end
+        
+        protected
+        attr_reader *attributes        
+      EOS
+    end
+    
+    def attributes(*attributes)
+      initializes_with *attributes
+      equality_based_on *attributes
+      attr_reader *attributes
+    end
+  end
+end

data/lib/attributedriven.rb

@@ -0,0 +1 @@
+require 'attribute_driven'

data/test/attribute_driven_test.rb

@@ -0,0 +1,65 @@
+=begin
+   Copyright 2009 Aman King
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+=end
+
+require 'test/unit'
+require File.join(File.dirname(__FILE__), '../lib/attribute_driven')
+
+class AttributeDrivenTest < Test::Unit::TestCase
+  def setup
+    @klass = Class.new do
+    	include AttributeDriven
+    	attributes :foo, :bar
+    end
+  end
+
+  def test_should_create_getters_for_specified_attributes
+    instance = @klass.new
+    assert_equal(true, instance.respond_to?(:foo))
+    assert_equal(true, instance.respond_to?(:bar))
+  end
+
+  def test_should_allow_setting_attribute_values_when_instantiating
+    instance = @klass.new(:foo => "hi", :bar => "bye")
+    assert_equal("hi", instance.foo)
+    assert_equal("bye", instance.bar)
+  end
+
+  def test_should_return_nil_for_unset_attributes
+    instance = @klass.new(:foo => "hi")
+    assert_nil(instance.bar)
+  end
+
+  def test_should_ignore_unknown_attributes_when_instantiating
+    instance = @klass.new(:x => "x")
+    assert_equal(false, instance.respond_to?(:x))
+    assert_equal(false, instance.instance_variables.include?('@x'))
+  end
+
+  def test_should_allow_two_instances_to_be_equated_based_on_attributes
+    assert_equal(@klass.new(:foo => "foo"), @klass.new(:foo => "foo"))
+    assert_not_equal(@klass.new(:foo => "foo1"), @klass.new(:foo => "foo2"))
+  end
+
+  def test_should_return_same_hash_for_two_equal_objects
+    assert_equal(@klass.new.hash, @klass.new.hash)
+    assert_equal(@klass.new(:foo => "hi", :bar => "bye").hash, @klass.new(:foo => "hi", :bar => "bye").hash)
+  end
+
+  def test_should_not_break_equality_based_on_reference
+    instance = @klass.new(:foo => "foo")
+    assert_same(instance, instance)
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: attribute-driven
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Aman King
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-02-12 00:00:00 +05:30
+default_executable: 
+dependencies: []
+
+description: AttributeDriven provides a class method to generate attribute-based equality-methods, initializer, and reader methods.
+email: amanking@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- lib/attribute-driven.rb
+- lib/attribute_driven.rb
+- lib/attributedriven.rb
+- test/attribute_driven_test.rb
+has_rdoc: true
+homepage: http://bitbucket.org/amanking/attribute-driven/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: AttributeDriven provides a class method to generate attribute-based equality-methods, initializer, and reader methods.
+test_files: 
+- test/attribute_driven_test.rb