simple_eav 0.0.1 → 0.1.0

data/README.rdoc

@@ -3,22 +3,11 @@
 simple_eav provides a more simple alternative to {acts_as_eav_model}[https://github.com/visfleet/acts_as_eav_model] that works with 
 ActiveRecord without any monkey patching.  This gem is designed to be a replacement for acts_as_eav_model.
 
-Acts_as_eav_model's purpose is to provide a model with any number of custom attributes.  This project has the same purpose.  The difference being maintaining utmost
-compatibility with ActiveRecord::Base.  For this reason, there is one glaring inconsistency between this gem and acts_as_eav_model.
-Acts_as_eav_model overrides attributes (among other functionality) to allow you to set any custom attributes. Simple eav does not.  I ommitted this in the interest
-of not having to monkey patch ActiveRecord.
+Acts_as_eav_model's purpose is to provide a model with any number of custom attributes.  This project has the same purpose.  The difference being maintaining utmost compatibility with ActiveRecord::Base.  
 
-=== Example
-  person = Person.new {:custom_attribute=>'value'} #This does not work in simple_eav
+Version 0.1.0 makes this library, to my knowledge, fully compatible with acts_as_eav_model.  This update introduced the ability to specify custom attributes exactly the same as attributes with an actual column in the database ie:
 
-  person = Person.new {:simple_eav_attributes => {:custom_attribute=>'value'} #This does work in simple_eav
-  person.custom_attribute ~> 'value'
-
-The latter works because all simple_eav does is use ActiveRecord's built in serialize mechanism to store a hash of custom attributes.
-So in this example, simple_eav_attributes is a text column in the database for the persons table.  Simple eav then takes of
-serializing the data for this column and defines setters/getters for your custom values.
-
-This is the only known inconsistency between these two gems. If this is an issue in your project please let me know.
+  Person.create :attribute_with_column=>true, :attribute_without_column=>true
 
 == Installation
   gem install simple_eav
@@ -43,6 +32,10 @@ This is the only known inconsistency between these two gems. If this is an issue
   person = Person.new
   person.name = 'Joe'
   person.name ~> 'Joe'
+  
+  person = Person.new :name => 'Joe'
+  person.save!
+  person.name ~> 'Joe'
 
 == Migrating to simple_eav
 I have not done this yet but will hopefully be making the transition soon.  I'll update the README once that's complete or let me know what you find if you migrate your project first.
@@ -50,8 +43,6 @@ At the moment, a migration would be needed that:
  - Moves each attribute record to a key => value pair for the simple_eav_column on the model using acts_as_eav_model
  - Destroys each attribute record
 
-You'd also need to review where your models using acts_as_eav_model are initialized.  If they depended on the single incompatibility mentioned above those calls will need to be updated.
-
 == Contributing
 
 * Fork the project.

data/lib/simple_eav.rb

@@ -17,6 +17,10 @@ module SimpleEav
   def simple_eav_column
     self.class.simple_eav_column
   end
+  
+  def actual_columns_of_table
+    self.class.columns.map{|col| col.name.to_sym }
+  end
 
   def simple_eav_attributes
     self.send(simple_eav_column.to_sym) || {}
@@ -25,6 +29,20 @@ module SimpleEav
   def simple_eav_attributes=(attributes={})
     self.send("#{simple_eav_column}=", attributes)
   end
+  
+  def attributes=(_attributes={})
+    #Iterate over each attribute:
+    # - skip columns that are actually defined in the db
+    # - remove undefined columns to prevent UnknownAttribute::Error from being thrown
+    simple_eav_attrs = read_attribute(:simple_eav_column) || {}
+    _attributes.each do |column,value|
+      next if actual_columns_of_table.include?(column)
+      simple_eav_attrs[column] = value 
+      _attributes.delete(column)
+    end
+    self.simple_eav_attributes = simple_eav_attrs
+    super(_attributes)
+  end
 
   def respond_to?(method, include_private=false)
     super || simple_eav_attributes.has_key?(method)

data/lib/version.rb

@@ -1,3 +1,3 @@
 module SimpleEav
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/simple_eav.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = SimpleEav::VERSION
   s.authors     = ["Tim Linquist"]
   s.email       = ["tim.linquist@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = %q{http://github.com/timo3377/simple_eav}
   s.summary     = %q{A simple alternative to acts_as_eav_model.}
   s.description = %q{A simple alternative to acts_as_eav_model that works with ActiveRecord without any monkey patching needed.  Acts_as_eav_model's gives a model the ability to have any number of custom attributes.  This project has the same goal.  The difference being maintaining utmost compatability with ActiveRecord::Base.}
 

data/spec/lib/simple_eav_spec.rb

@@ -13,17 +13,52 @@ describe SimpleEav do
   end
 
   describe "Expected ActiveRecord behavior" do
-    it "set all of the attributes" do
+    describe "given a hash of undefined attributes" do
+      it "creates a person with a name" do
+        person = Person.create(:name=>'Joseph')
+        person.name.should eql 'Joseph'
+      end
+      it "saves the person's name" do
+        person = Person.new(:name=>'Jeremiah')
+        person.save!
+        person.reload
+        person.name.should eql 'Jeremiah'
+      end
+      it "updates the person's name" do
+        person = Person.create(:name=>'Joseph')
+        person.update_attributes(:name=>'Joe')
+        person.name.should eql 'Joe'
+      end
+      it "initializes the person with a name" do
+        person = Person.new(:name=>'John')
+        person.name.should eql 'John'
+      end
+    end
+    describe "given a hash of defined attributes" do
+      it "updates the person's age" do
+        person = Person.create(:age=>98)
+        person.update_attributes(:age=>99)
+        person.save!
+        person.reload
+        person.age.to_i.should eql 99
+      end
+      it "does not set the age in the simple eav attributes" do
+        person = Person.create(:age=>97, :new_age=>98)
+        person.simple_eav_attributes.should_not have_key :age
+        person.simple_eav_attributes.should have_key :new_age
+      end
+    end
+    it "sets all of the attributes" do
       person = Person.create!({
-        :age=>'John Johnson',
+        :age=>99,
         :simple_attributes=>{
           :name=>'John'
         }
       })
-      person.age.should eql('John Johnson')
+      person.age.should eql(99)
       person.name.should eql('John')
     end
-    it "serialize and deserialize the simple_eav attributes" do
+    it "serializes and deserializes the simple_eav attributes" do
       person = Person.new({:simple_attributes=>{
         :name=>'John'
       }})

metadata

@@ -2,7 +2,7 @@
 name: simple_eav
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Tim Linquist
@@ -10,7 +10,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-04 00:00:00 Z
+date: 2011-06-16 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -79,7 +80,8 @@ files:
 - spec/lib/simple_eav_spec.rb
 - spec/spec_helper.rb
 - spec/support/person.rb
-homepage: ""
+has_rdoc: true
+homepage: http://github.com/timo3377/simple_eav
 licenses: []
 
 post_install_message: 
@@ -102,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.3
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: A simple alternative to acts_as_eav_model.