eav_presenter 0.0.1

data/lib/eav_presenter.rb

@@ -0,0 +1,94 @@
+# Usage:
+# Say you have an eav design pattern like this: Person, PersonAttribute and PersonAttrValue
+# You can then define a new class:
+# class EavPerson < Person
+#  include EavPresenter
+#  eav :eav_attr_class => PersonAttribute, :eav_value_class => PersonAttrValue, :eav_entity_foreign_key => "personId",
+#    :eav_attr_foreign_key => "attrId"
+# end
+#
+# The attributes in PersonAttribute will now behave as DB columns. You can also use AR validation macros on them
+# Dirty-tracking will not work in this case. Should be possible to implement.
+# I have tested such a presenter model with scaffolding_extensions plugin only. More testing would be nice.
+
+module EavPresenter
+  def self.included(base)
+    base.send(:extend, ClassMethods)
+  end
+
+  def load_eav_attr_values_if_not_loaded
+    entity_foreign_key = self.class.instance_variable_get("@eav_entity_foreign_key")
+    @eav_attr_values ||= self.class.instance_variable_get("@eav_value_class").send("find_all_by_#{entity_foreign_key}",self.id)
+  end
+
+  def save_eav_attr_values
+    self.class.instance_variable_get("@eav_attrs").each { |at|
+      eavs = load_eav_attr_values_if_not_loaded
+      eav = eavs.find { |i| i.attrId == at.id } #eav in the db
+      name = at.eav_attr_name
+      entity_foreign_key = self.class.instance_variable_get("@eav_entity_foreign_key")
+      attr_foreign_key = self.class.instance_variable_get("@eav_attr_foreign_key")
+      eav_value_class = self.class.instance_variable_get("@eav_value_class")
+      ivalue = send(name)
+      if attribute_changed?(name)
+        if eav
+          if ivalue.blank?
+            #eav needs to be deleted
+            eav_value_class.send("find_by_#{attr_foreign_key}_and_#{entity_foreign_key}",at.id,self.id).destroy
+          else
+            # eav has been modified. needs to be saved.
+            eav.value = ivalue
+            eav.save!
+          end
+        else
+          #eav needs to be created
+          eav_value_class.create({entity_foreign_key.to_sym => self.id, attr_foreign_key.to_sym => at.id, :value => ivalue})
+        end
+      end
+    }
+    self.reload # Values have been changed in DB. Better reload them.
+    @eav_attr_values = nil
+    load_eav_attr_values_if_not_loaded
+  end
+
+  module ClassMethods
+    def eav(opts)
+      @eav_attr_class = opts[:eav_attr_class]
+      @eav_value_class = opts[:eav_value_class]
+      @eav_entity_foreign_key = opts[:eav_entity_foreign_key]
+      @eav_attr_foreign_key = opts[:eav_attr_foreign_key]
+      @eav_attrs = @eav_attr_class.all
+      
+      define_method(:attributes) {
+       super.merge(Hash[self.class.instance_variable_get("@eav_attrs").map(&:eav_attr_name).map { |name| [name, send(name)] }])
+      }
+      # define_attribute_methods(@eav_attrs.collect(&:eav_attr_name))
+      
+      @eav_attrs.each { |at|
+        define_method(at.eav_attr_name) { |*args|
+          eavs = load_eav_attr_values_if_not_loaded
+          if instance_variables.include?("@#{at.eav_attr_name}")
+            instance_variable_get("@#{at.eav_attr_name}")
+          else
+            eavs.find { |i| i.attrId == at.id }.try(:value)
+          end
+        }
+
+        define_method("#{at.eav_attr_name}=") { |value|
+          raise "EAV value for #{at.eav_attr_name} must be a string or nil" unless value.nil? || value.is_a?(String)
+          eavs = load_eav_attr_values_if_not_loaded
+          instance_variable_set("@#{at.eav_attr_name}",value)
+          old = eavs.find { |i| i.attrId == at.id }.try(:value)
+          if value == old
+            changed_attributes.delete(at.eav_attr_name)
+          else
+            changed_attributes[at.eav_attr_name] = old
+          end
+        }
+      }
+      after_save :save_eav_attr_values # Register a callback which makes sure that any changes made are sync'ed to the AttrValues table
+      after_find :load_eav_attr_values_if_not_loaded
+    end
+  end
+end
+

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: eav_presenter
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+  - Nilesh Trivedi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-30 00:00:00 +05:30
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: activerecord
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id001
+description: ActiveRecord model like presenter for Entity-Attribute-Value pattern
+email: 
+  - github@nileshtrivedi.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - lib/eav_presenter.rb
+has_rdoc: true
+homepage: http://github.com/nileshtrivedi/eav_presenter
+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.5.1
+signing_key: 
+specification_version: 3
+summary: ActiveRecord model like presenter for Entity-Attribute-Value pattern
+test_files: []
+