simple_eav 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.2-p180@simple_eav

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Tim Linquist
+
+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.rdoc

@@ -0,0 +1,75 @@
+= simple_eav
+
+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.
+
+=== Example
+  person = Person.new {:custom_attribute=>'value'} #This does not work in simple_eav
+
+  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.
+
+== Installation
+  gem install simple_eav
+
+== Usage
+=== 1. Create the migration for your model
+
+  create_table :people do |t|
+    t.text  :custom_attributes # Name this column whatever you like just *make sure* it is a TEXT field
+    ....
+  end
+
+=== 2. Configure simple_eav in your model
+
+  class Person < ActiveRecord::Base
+    include SimpleEav
+
+    configure_simple_eav :custom_attributes # This sets up the serialization for your custom attributes
+  end
+
+=== 3. Set and Get custom attributes as if they were a normal attribute on your model
+  person = Person.new
+  person.name = 'Joe'
+  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.
+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.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a
+  commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+== Author
+
+{Tim Linquist}[http://github.com/timo3377]
+
+== Copyright
+
+Copyright (c) 2011 {Tim Linquist}[http://github.com/timo3377]
+
+See {LICENSE}[http://github.com/timo3377/simple_eav] for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/simple_eav.rb

@@ -0,0 +1,45 @@
+module SimpleEav
+  module ClassMethods
+    def configure_simple_eav(column)
+      @@column = column.to_sym
+      serialize @@column
+    end
+
+    def simple_eav_column
+      @@column if defined? @@column
+    end
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def simple_eav_column
+    self.class.simple_eav_column
+  end
+
+  def simple_eav_attributes
+    self.send(simple_eav_column.to_sym) || {}
+  end
+
+  def simple_eav_attributes=(attributes={})
+    self.send("#{simple_eav_column}=", attributes)
+  end
+
+  def respond_to?(method, include_private=false)
+    super || simple_eav_attributes.has_key?(method)
+  end
+
+  def method_missing(method, *args, &block)
+    if method.to_s =~ /=$/
+      _attributes = self.simple_eav_attributes
+      setter = method.to_s.gsub(/=/, '')
+      _attributes[setter.to_sym] = args.shift
+      self.simple_eav_attributes = _attributes
+    elsif simple_eav_attributes.has_key?(method.to_sym)
+      simple_eav_attributes[method.to_sym]
+    else
+      super(method, *args, &block)
+    end
+  end
+end

data/lib/version.rb

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

data/simple_eav.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "version"
+
+Gem::Specification.new do |s|
+  s.name        = "simple_eav"
+  s.version     = SimpleEav::VERSION
+  s.authors     = ["Tim Linquist"]
+  s.email       = ["tim.linquist@gmail.com"]
+  s.homepage    = ""
+  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.}
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.extra_rdoc_files = [ "README.rdoc" ]
+  s.require_path     = "lib"
+
+  s.add_dependency 'activerecord', '~> 3.0.7'
+  if RUBY_VERSION < '1.9'
+    s.add_development_dependency 'ruby-debug'
+  else
+    s.add_development_dependency 'ruby-debug19'
+  end
+  s.add_development_dependency 'sqlite3', '~> 1.3.3'
+  s.add_development_dependency 'rspec', '~> 2.6.0'
+end

data/spec/db/schema.rb

@@ -0,0 +1,10 @@
+require 'active_record'
+
+ActiveRecord::Schema.define do
+  create_table 'people', :force => true do |t|
+    t.string   'age'
+    t.text     'simple_attributes'
+    t.datetime 'created_at'
+    t.datetime 'updated_at'
+  end
+end

data/spec/lib/simple_eav_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe SimpleEav do
+  describe "Configuring a model" do
+    it "with the column to serialize" do
+      Person.simple_eav_column.should eql(:simple_attributes)
+    end
+
+    it "serializes the configured column" do
+      p= Person.create({:simple_attributes => {:name=>'John'}})
+      p.simple_attributes[:name].should eql('John')
+    end
+  end
+
+  describe "Expected ActiveRecord behavior" do
+    it "set all of the attributes" do
+      person = Person.create!({
+        :age=>'John Johnson',
+        :simple_attributes=>{
+          :name=>'John'
+        }
+      })
+      person.age.should eql('John Johnson')
+      person.name.should eql('John')
+    end
+    it "serialize and deserialize the simple_eav attributes" do
+      person = Person.new({:simple_attributes=>{
+        :name=>'John'
+      }})
+      person.save!
+      person.reload
+      person.name.should eql('John')
+    end
+  end
+
+  describe "A missing attribute" do
+    before( :each ) do
+      @person = Person.new
+    end
+    describe "when reading" do
+      it "raises a NoMethodError" do
+        lambda{ @person.unknown_eav }.should raise_error(NoMethodError)
+      end
+    end
+    describe "when writing" do
+      it "always defines the attribute without an error" do
+        lambda{ @person.unknown_eav = 'Simple' }.should_not raise_error
+      end
+    end
+  end
+
+  describe "A custom attribute" do
+    describe "John is a Person" do
+      before( :each ) do
+        @person = Person.new
+      end
+      it "who knows his name" do
+        @person.name = 'John'
+        @person.name.should eql('John')
+      end
+
+      it "who can change his name" do
+        @person.name = 'John'
+        @person.name = 'Joe'
+        @person.name.should eql('Joe')
+      end
+
+      it "who responds to his name" do
+        @person.name = 'John'
+        @person.respond_to?(:name).should be_true
+      end
+
+      it "who doesn't respond to someone else's name" do
+        @person.respond_to?(:someone_elses_name).should be_false
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup
+require 'rspec'
+
+require 'active_record'
+require 'sqlite3'
+require 'logger'
+
+ActiveRecord::Base.establish_connection({
+  :adapter  => 'sqlite3',
+  :database => ":memory:"
+})
+load('db/schema.rb')
+
+$:.push File.expand_path("../lib", __FILE__)
+require 'support/person'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+
+

data/spec/support/person.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+require 'simple_eav'
+
+class Person < ActiveRecord::Base
+  include SimpleEav
+
+  configure_simple_eav :simple_attributes
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: simple_eav
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tim Linquist
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.3.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id004
+description: 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.
+email: 
+- tim.linquist@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/simple_eav.rb
+- lib/version.rb
+- simple_eav.gemspec
+- spec/db/schema.rb
+- spec/lib/simple_eav_spec.rb
+- spec/spec_helper.rb
+- spec/support/person.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.3
+signing_key: 
+specification_version: 3
+summary: A simple alternative to acts_as_eav_model.
+test_files: 
+- spec/db/schema.rb
+- spec/lib/simple_eav_spec.rb
+- spec/spec_helper.rb
+- spec/support/person.rb