has_eav 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "activerecord", "~> 3.0.3"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+  gem "rails", "~> 3.0.3"
+  gem "sqlite3-ruby", :require => "sqlite3"
+end

data/Gemfile.lock

@@ -0,0 +1,85 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.12)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    sqlite3-ruby (1.3.2)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.3)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rails (~> 3.0.3)
+  rcov
+  shoulda
+  sqlite3-ruby

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Hartog C. de Mik
+
+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,100 @@
+= has_eav
+
+== Description
+
+Enabled EAV behaviour on ActiveRecord (or is at least supposed to).
+
+This was inspired by https://github.com/visfleet/acts_as_eav_model but is a 
+more minimized approach and is less automated.
+
+=== EAV
+
+Stands for Entity-Attribute-Value and is a database design pattern to unload
+attributes from a table.
+
+From wikipedia:
+
+Entity-attribute-value model (EAV) is a data model to describe entities where
+the number of attributes (properties, parameters) that can be used to describe
+them is potentially vast, but the number that will actually apply to a given
+entity is relatively modest. In mathematics, this model is known as a
+*sparse matrix*. EAV is also known as *object-attribute-value* model and
+*open schema*.
+
+
+== Author
+[name]    Hartog de Mik (aka: coffeeaddict, coffeeaddict_nl)
+[email]   name.downcase.gsub(" ",".")@gmail.com
+[source]  https://github.com/coffeeaddict/has_eav
+
+== Installation
+  gem install has_eav
+
+== Setup
+
+In your model
+
+  class Post < ActiveRecord::Base
+    has_many :tags
+    belongs_to :user
+    has_eav :through => :post_attribute do
+      eav_attribute :author_name
+      eav_attribute :author_age, Integer
+      eav_attribute :author_email
+    end
+  end
+
+Now, generate a model to hold the attributes
+
+  rails generate model PostAttribute post:references name:string value:string
+
+And you are good to go.
+
+== Usage
+
+=== Usage of EAV
+
+For the general usage of EAV, thread wisely. Be careful and suspicious about 
+your needs.
+
+=== Usage of has_eav
+
+Once you have setup +has_eav :through+ on your model, you can call the defined
+attributes as if they where present on your model. You should be able to treat
+your model as if the defined attributes where present in the database.
+
+In contradiction to acts_as_eav_model, has_eav will not allow for an all open
+structure. You must define the attributes to be required.
+
+==== Instance eav_attributes
+
+If you create a method +instance_eav_attributes+ in your model, has_eav will 
+recognize these attributes as well.
+
+This might be useful for state machines or STI classes where you want to have
+different attributes based on the current state or type of the instance. 
+
+== Contributing to has_eav
+ 
+* Check out the latest master to make sure the feature hasn't been implemented 
+  or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested
+  it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to
+  have your own version, or is otherwise necessary, that is fine, but please
+  isolate to its own commit so I can cherry-pick around it.
+
+== TODO
+
+* Create a nice generator
+* Put type casting on instance eav attributes
+
+== Copyright
+
+Copyright (c) 2010 Hartog C. de Mik. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "has_eav"
+  gem.homepage = "http://github.com/coffeeaddict/has_eav"
+  gem.license = "MIT"
+  gem.summary = %Q{Put EAV behaviour on your ActiveRecord models}
+  gem.description = %Q{Put EAV behaviour on your ActiveRecord models}
+  gem.email = "hcdm@matchvertise.com"
+  gem.authors = ["Hartog C. de Mik"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "has_eav #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/has_eav.gemspec

@@ -0,0 +1,131 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{has_eav}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Hartog C. de Mik"]
+  s.date = %q{2010-12-10}
+  s.description = %q{Put EAV behaviour on your ActiveRecord models}
+  s.email = %q{hcdm@matchvertise.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "has_eav.gemspec",
+    "init.rb",
+    "lib/has_eav.rb",
+    "test/app/models/post.rb",
+    "test/app/models/post_attribute.rb",
+    "test/app/models/product.rb",
+    "test/app/models/product_attribute.rb",
+    "test/config.ru",
+    "test/config/application.rb",
+    "test/config/boot.rb",
+    "test/config/database.yml",
+    "test/config/environment.rb",
+    "test/config/environments/development.rb",
+    "test/config/environments/production.rb",
+    "test/config/environments/test.rb",
+    "test/config/initializers/backtrace_silencers.rb",
+    "test/config/initializers/inflections.rb",
+    "test/config/initializers/mime_types.rb",
+    "test/config/initializers/secret_token.rb",
+    "test/config/initializers/session_store.rb",
+    "test/config/locales/en.yml",
+    "test/config/routes.rb",
+    "test/db/migrate/20101210093949_create_posts.rb",
+    "test/db/migrate/20101210100309_create_post_attributes.rb",
+    "test/db/migrate/20101210102322_create_products.rb",
+    "test/db/migrate/20101210102347_create_product_attributes.rb",
+    "test/helper.rb",
+    "test/log/development.log",
+    "test/script/rails",
+    "test/test/fixtures/post_attributes.yml",
+    "test/test/fixtures/posts.yml",
+    "test/test/fixtures/product_attributes.yml",
+    "test/test/fixtures/products.yml",
+    "test/test/unit/post_attribute_test.rb",
+    "test/test/unit/post_test.rb",
+    "test/test/unit/product_attribute_test.rb",
+    "test/test/unit/product_test.rb",
+    "test/test_has_eav.rb"
+  ]
+  s.homepage = %q{http://github.com/coffeeaddict/has_eav}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Put EAV behaviour on your ActiveRecord models}
+  s.test_files = [
+    "test/app/models/post.rb",
+    "test/app/models/post_attribute.rb",
+    "test/app/models/product.rb",
+    "test/app/models/product_attribute.rb",
+    "test/config/application.rb",
+    "test/config/boot.rb",
+    "test/config/environment.rb",
+    "test/config/environments/development.rb",
+    "test/config/environments/production.rb",
+    "test/config/environments/test.rb",
+    "test/config/initializers/backtrace_silencers.rb",
+    "test/config/initializers/inflections.rb",
+    "test/config/initializers/mime_types.rb",
+    "test/config/initializers/secret_token.rb",
+    "test/config/initializers/session_store.rb",
+    "test/config/routes.rb",
+    "test/db/migrate/20101210093949_create_posts.rb",
+    "test/db/migrate/20101210100309_create_post_attributes.rb",
+    "test/db/migrate/20101210102322_create_products.rb",
+    "test/db/migrate/20101210102347_create_product_attributes.rb",
+    "test/helper.rb",
+    "test/test/unit/post_attribute_test.rb",
+    "test/test/unit/post_test.rb",
+    "test/test/unit/product_attribute_test.rb",
+    "test/test/unit/product_test.rb",
+    "test/test_has_eav.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.3"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rails>, ["~> 3.0.3"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, ["~> 3.0.3"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rails>, ["~> 3.0.3"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["~> 3.0.3"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rails>, ["~> 3.0.3"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'lib/has_eav.rb'

data/lib/has_eav.rb

@@ -0,0 +1,214 @@
+module ActiveRecord
+  module ActsAs
+    module HasEav
+      def self.included(base)        
+        base.extend ActiveRecord::ActsAs::HasEav::ClassMethods    
+      end
+      
+      module ClassMethods
+        # Specify that the ActiveModel is an EAV model
+        #
+        # == Usage
+        # # specifiy eav_attributes at instance level
+        # has_eav :through => :some_class_with_name_and_value_attributes
+        # def available_eav_attributes
+        #   case self.origin
+        #   when "remote"
+        #     %(remote_ip user_agent)
+        #   when "local"
+        #     %(user)
+        #   end + [ :uniq_id ]
+        # end
+        #
+        # # specify some eav_attributes at class level
+        # has_eav :through => :x_attributes do
+        #   eav_attribute :remote_ip
+        #   eav_attribute :uniq_id
+        # end
+        #
+        # == Mixing class and instance defined EAV attributes
+        # You can define EAV attributes both in class and instance context and
+        # they will be both adhered
+        #
+        def has_eav opts={}, &block
+          klass = opts.delete :through
+          raise(
+          "Eav Class cannot be nil. Specify a class using " +
+          "has_eav :through => :class"
+          ) if klass.blank?
+          
+          class_eval do
+            after_save :save_eav_attributes
+          end
+          
+          @eav_class      = klass.to_s.camelize.constantize
+          @eav_attributes = {}
+          
+          yield if block_given?
+          
+          send :include, ActiveRecord::ActsAs::HasEav::InstanceMethods
+        end
+        
+        # Add an other attribute to the class list
+        def eav_attribute name, type = String
+          name = name.to_s if !name.is_a? String
+          
+          self.class_eav_attributes[name] = type
+        end
+                  
+        # class accessor
+        def class_eav_attributes # :nodoc:
+          @eav_attributes
+        end
+        
+        # class accessor
+        def eav_class # :nodoc:
+          @eav_class
+        end        
+      end # /ClassMethods
+      
+      module InstanceMethods
+        # get to the eav class
+        def eav_class
+          self.class.eav_class
+        end
+        
+        # get the class eav attributes
+        def class_eav_attributes
+          self.class.class_eav_attributes
+        end
+        
+        # Override this to get some usable attributes
+        # 
+        # Cowardly refusing to adhere to all
+        def instance_eav_attributes
+          []
+        end    
+        
+        # override method missing, but only kick in when super fails with a
+        # NoMethodError
+        #
+        def method_missing method_symbol, *args, &block
+          super
+        rescue NoMethodError => e
+          method_name    = method_symbol.to_s
+          attribute_name = method_name.gsub(/[\?=]$/, '')
+          
+          raise e unless eav_attributes_list.include? attribute_name
+          
+          attribute = self.eav_attributes.select { |a|
+            a.name == attribute_name
+          }.first
+            
+          if method_name =~ /\=$/
+            value = args[0]
+            
+            if attribute
+              if value
+                return attribute.send(:write_attribute, "value", value)
+                
+              elsif value.nil?
+                return attribute.destroy
+                
+              end
+              
+            else
+              @eav_attributes << eav_class.new(
+                :name  => attribute_name,
+                :value => "#{value}"
+              )
+              
+              return cast_eav_value(value, attribute_name)
+              
+            end
+          elsif method_name =~ /\?$/
+            return ( attribute and attribute.value == true ) ? true : false
+            
+          else
+            return attribute ? 
+              cast_eav_value(attribute.value, attribute_name) :
+              nil
+            
+          end
+          
+          raise e
+        end    
+        
+        # override respond_to?
+        def respond_to? method_symbol, is_private=false
+          if super == false
+            method_name = method_symbol.to_s.gsub(/[\?=]$/, '')
+            return true if eav_attributes_list.include? method_name
+            
+            false
+          else
+            true
+          end
+        end  
+        
+        # get all the eav attribute instances available for this model instance
+        #
+        # eg: if you model says 'has_eav :through => :post_attribute' these are 
+        # all PostAttribute's
+        #
+        def eav_attributes
+          @eav_attributes ||= eav_class.all(
+            :conditions => { self_key => self.id }
+          )
+        end
+        
+        # save the list of eav_attribute back to the database
+        def save_eav_attributes # :nodoc:
+          eav_attributes.select { |a| a.changed? }.each do |a|
+            if a.new_record?
+              a.send( :write_attribute, self_key, self.id )
+            end
+            
+            a.save!
+          end
+        end
+        
+        # override changed - if any of the eav_attributes has changed, the 
+        # object has changed.
+        #
+        def changed?
+          eav_attributes.each do |attribute|            
+            return true if ( attribute.changed? || attribute.new_record? )
+          end
+          
+          super
+        end
+        
+        # get a complete list of eav_attributes (class + instance)
+        def eav_attributes_list # :nodoc:
+          (
+            self.instance_eav_attributes + self.class_eav_attributes.keys
+          ).collect { |attribute| attribute.to_s }.uniq
+        end
+        
+        # get the key to my <3
+        def self_key # :nodoc:
+          "#{self.class.name.underscore}_id".to_sym
+        end
+        
+        # cast an eav value to it's desired class
+        def cast_eav_value value, attribute # :nodoc:
+          attributes = self.class_eav_attributes.stringify_keys
+          return value unless attributes.keys.include?(attribute)
+                    
+          return (
+            eval("#{attributes[attribute]} '#{value}'") ||
+            eval("#{attributes[attribute]}.new('#{value}')") ||
+            value
+          )
+        end
+        
+        protected :save_eav_attributes, :self_key, :cast_eav_value
+        
+      end # /InstanceMethods
+    end # /HasEav
+  end # /ActsAs
+end # /ActiveRecord
+
+# insert the has_eav method into ActiveRecord
+ActiveRecord::Base.send( :include, ActiveRecord::ActsAs::HasEav )

data/test/app/models/post.rb

@@ -0,0 +1,6 @@
+class Post < ActiveRecord::Base
+  has_eav :through => :post_attribute do
+    eav_attribute :author_name
+    eav_attribute :author_email    
+  end
+end

data/test/app/models/post_attribute.rb

@@ -0,0 +1,3 @@
+class PostAttribute < ActiveRecord::Base
+  belongs_to :post
+end

data/test/app/models/product.rb

@@ -0,0 +1,8 @@
+# class for testing attribute casting
+#
+class Product < ActiveRecord::Base
+  has_eav :through => :product_attribute do
+    eav_attribute :price, Float
+    eav_attribute :cost_price, BigDecimal
+  end
+end

data/test/app/models/product_attribute.rb

@@ -0,0 +1,2 @@
+class ProductAttribute < ActiveRecord::Base
+end