portable-hole 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    portable-hole (0.0.1)
+      rails (>= 3.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.6)
+      actionpack (= 3.2.6)
+      mail (~> 2.4.4)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.4)
+    json (1.7.3)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.6)
+      actionmailer (= 3.2.6)
+      actionpack (= 3.2.6)
+      activerecord (= 3.2.6)
+      activeresource (= 3.2.6)
+      activesupport (= 3.2.6)
+      bundler (~> 1.0)
+      railties (= 3.2.6)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.15.4)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  portable-hole!

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Lantirn, Inc
+
+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.md

@@ -0,0 +1,4 @@
+Portable Hole
+=============
+
+Portable Hole is an extension to ActiveRecord that adds EAV functionality to a model via a polymorphic association with an EAV table.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the gem'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PortableHole'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/portable-hole/association_extensions.rb

@@ -0,0 +1,50 @@
+module Reamaze
+  module PortableHole
+    module AssociationExtensions
+      def save
+        do_save(false)
+      end
+
+      def save!
+        do_save(true)
+      end
+
+      def []=(name, value)
+        @association.owner.set_preferential(@association.reflection.name, name, value)
+      end
+
+      def [](name)
+        @association.owner.get_preferential(@association.reflection.name, name)
+      end
+
+      def valid?
+        valid = true
+        proxy_target.each do |thing|
+          thing.model_cache = @association.owner
+          unless thing.valid?
+            thing.errors.each{ |attr, msg| @association.owner.errors.add(@association.reflection.name, msg) }
+            valid = false
+          end
+        end
+        valid
+      end
+
+      # Private Methods
+      private
+        def do_save(with_bang)
+          success = true
+          proxy_target.each do |thing|
+            thing.model_cache = @association.owner
+            if with_bang
+              thing.save!
+            elsif thing.save == false
+              # Delegate the errors to the proxy owner
+              thing.errors.each { |attr,msg| @association.owner.errors.add(@association.reflection.name, msg) }
+              success = false
+            end
+          end
+          success
+        end
+    end
+  end
+end

data/lib/portable-hole/hash.rb

@@ -0,0 +1,29 @@
+module Reamaze
+  module PortableHole
+    class PrefHash < Hash
+      def initialize(owner, preferential)
+        @owner = owner
+        @preferential = preferential
+      end
+
+      def [] key
+        @owner.get_preferential @preferential, key.to_s, true
+      end
+
+      def []= key, value
+        @owner.set_preferential @preferential, key.to_s, value, true
+        super key.to_s, value
+      end
+
+      def method_missing(id, *args, &block)
+        match = /(.+)=$/.match id.to_s
+        return self[match[1]] = args[0] if match
+        
+        match = /(.+)\?$/.match id.to_s
+        return !!self[match[1]] if match
+        
+        self[id]
+      end 
+    end
+  end
+end

data/lib/portable-hole/helpers.rb

@@ -0,0 +1,10 @@
+module Reamaze
+  module PortableHole
+    module Helpers
+      # Converts give symbol to string and downcases it
+      def self.normalize(symbol)
+        symbol.to_s.downcase
+      end
+    end
+  end
+end

data/lib/portable-hole.rb

@@ -0,0 +1,126 @@
+require 'portable-hole/helpers'
+require 'portable-hole/association_extensions'
+require 'portable-hole/hash'
+require 'portable-value'
+
+module Reamaze
+  module PortableHole
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    # Make methods available to ActiveRecord in the class context
+    module ClassMethods
+      def portable_hole(eav = :data, options = {})
+        send :include, InstanceMethods
+
+        eav = Helpers.normalize(eav)
+
+        # Create accessor methods to our configuration info
+        class << self
+          attr_accessor :eav_configuration unless method_defined?(:eav_configuration)
+        end
+
+        # Initialize the configuration to an empty hash
+        self.eav_configuration = {} if self.eav_configuration.nil?
+
+        # Redefining a configuration once defined should not be allowed
+        raise ArgumentError, "#{self} class already has a portal_hole :#{eav} defined" if self.eav_configuration.has_key?(eav)
+
+        eav_configuration[eav] = options
+
+        class_eval <<-end_eval
+          # Define the has_many relationship
+          has_many :_#{eav}, :class_name => 'PortableValue',
+                            :as         => :model,
+                            :conditions => {:context => '#{eav}'},
+                            :extend     => AssociationExtensions,
+                            :inverse_of => :model,
+                            :dependent  => :destroy
+
+          accepts_nested_attributes_for :_#{eav}, :allow_destroy => true
+
+          def #{eav}
+            h = Reamaze::PortableHole::PrefHash.new self, "_#{eav}"
+            values = self._#{eav}
+            values.each do |v|
+              h[v.key] = v.value
+            end
+            h
+          end
+
+          def #{eav}=(hash)
+            array = []
+
+            deletables = self._#{eav}.reject {|x| hash.keys.include? x.key}
+
+            hash.each do |k, v|
+              current = self._#{eav}.detect {|x| x.key == k}
+              if current.present?
+                if v == '_destroy'
+                  array << {:id => current.id, :key => k, :value => v, :_destroy => true}
+                else
+                  array << {:id => current.id, :key => k, :value => v}
+                end
+              else
+                array << {:key => k, :value => v}
+              end
+            end
+
+            deletables.each do |x|
+              array << {:id => x.id, :_destroy => true}
+            end
+
+            self._#{eav}_attributes = array
+            hash
+          end
+        end_eval
+      end
+    end
+
+    # Make methods available to ActiveRecord models in the instance context
+    module InstanceMethods
+      def set_preferential(preferential, name, value, do_preprocess = false)
+        preferential = Helpers.normalize(preferential)
+        name    = Helpers.normalize(name)
+
+        # Invoke the association
+        prefs = send(preferential)
+
+        # If pref already exists, update it, otherwise add a new one
+        pref = prefs.detect { |pref| pref.key == name }
+
+        if pref.blank?
+          pref = prefs.build :key      => name,
+                             :value    => value
+        else
+          pref.value = value
+        end
+
+        pref.value
+      end
+
+      def get_preferential(preferential, name, do_postprocess = false)
+        preferential = Helpers.normalize(preferential)
+        name         = Helpers.normalize(name)
+
+        # Invoke the association
+        prefs = send(preferential)
+
+        # Try to find what they are looking for
+        pref = prefs.detect{ |pref| pref.key == name }
+
+        # If the pref isn't found, try to fallback on a default
+        if pref.blank?
+          value = nil
+        else
+          value = pref.value
+        end
+
+        value
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Reamaze::PortableHole

data/lib/portable-value.rb

@@ -0,0 +1,15 @@
+class PortableValue < ActiveRecord::Base
+  belongs_to        :model, :polymorphic => true
+  belongs_to        :group, :polymorphic => true
+
+  before_validation :set_group
+
+  def set_group
+    config = eval(self.model_type).eav_configuration
+    if config[self.context].present?
+      if config[self.context][:group].present?
+        self.group = model.send(config[self.context][:group])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: portable-hole
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Lu Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-16 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 3
+        - 1
+        - 0
+        version: 3.1.0
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+- lwang@reamaze.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/portable-hole/association_extensions.rb
+- lib/portable-hole/hash.rb
+- lib/portable-hole/helpers.rb
+- lib/portable-hole.rb
+- lib/portable-value.rb
+- MIT-LICENSE
+- README.md
+- Gemfile
+- Gemfile.lock
+- Rakefile
+homepage: http://github.com/lunaru/portable-hole
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Portable Hole is an extension to ActiveRecord that adds EAV functionality to a model via a polymorphic association with an EAV table.
+test_files: []
+