hydra_attribute 0.1.0

data/features/where_conditions.feature

@@ -0,0 +1,77 @@
+Feature: hydra attribute where conditions
+  When filter by hydra attribute and this value is not nil
+  Then the correct hydra attribute table should be joined and filter by this value should be added
+
+  When filter by hydra attribute and this value is nil
+  Then records with nil value should be selected  or records which don't have this hydra attribute
+
+  Background: create models and describe hydra attributes
+    Given removed constants if they exist:
+      | name          |
+      | GroupProduct  |
+      | SimpleProduct |
+      | Product       |
+    And create model class "Product"
+    And create model class "SimpleProduct" as "Product" with hydra attributes:
+      | type    | name    |
+      | string  | code    |
+      | string  | summary |
+      | string  | title   |
+      | float   | price   |
+      | boolean | active  |
+      | integer | state   |
+
+  Scenario: add filter by one hydra attribute
+    Given create models:
+      | model         | attributes                         |
+      | SimpleProduct | code=[string:1] price=[float:2.75] |
+      | SimpleProduct | code=[string:2] price=[float:2.75] |
+      | SimpleProduct | code=[string:3] price=[float:2.76] |
+      | SimpleProduct | code=[string:4] price=[nil:]       |
+    When filter "SimpleProduct" by:
+      | field | value         |
+      | price | [string:2.75] |
+    Then total records should be "2"
+    And records should have the following attributes:
+      | field | value      |
+      | code  | [string:1] |
+      | code  | [string:2] |
+
+  Scenario: add nil filter by one hydra attribute
+    Given create models:
+      | model         | attributes                      |
+      | SimpleProduct | code=[string:1] price=[nil:]    |
+      | SimpleProduct | code=[string:2] price=[float:0] |
+      | SimpleProduct | code=[string:3]                 |
+    When filter "SimpleProduct" by:
+      | field | value  |
+      | price | [nil:] |
+    Then total records should be "2"
+    And records should have the following attributes:
+      | field | value      |
+      | code  | [string:1] |
+      | code  | [string:3] |
+
+  Scenario: add filter by several fields including both the hydra and general attributes
+    Given create models:
+      | model         | attributes                                                                                                                                   |
+      | SimpleProduct | name=[string:toy] code=[string:1] title=[string:story] price=[float:2.45] active=[boolean:true]               info=[string:]                 |
+      | SimpleProduct | name=[string:toy] code=[string:2] title=[string:story] price=[float:2.45] active=[boolean:true]               info=[string:a] summary=[nil:] |
+      | SimpleProduct | name=[string:toy] code=[string:3] title=[string:story] price=[float:2.45] active=[boolean:true]  state=[nil:] info=[string:a] summary=[nil:] |
+      | SimpleProduct | name=[string:toy] code=[string:4]                      price=[float:2.45] active=[boolean:false] state=[nil:] info=[string:a] summary=[nil:] |
+      | SimpleProduct |                   code=[string:5]                      price=[float:2.45] active=[boolean:true]  state=[nil:] info=[string:a] summary=[nil:] |
+      | SimpleProduct | name=[string:toy] code=[string:6]                      price=[float:2.46] active=[boolean:true]  state=[nil:] info=[string:a] summary=[nil:] |
+    When filter "SimpleProduct" by:
+      | field   | value          |
+      | name    | [string:toy]   |
+      | title   | [string:story] |
+      | summary | [nil:]         |
+      | price   | [string:2.45]  |
+      | active  | [boolean:true] |
+      | info    | [string:a]     |
+      | state   | [nil:]         |
+    Then total records should be "2"
+    And records should have the following attributes:
+      | field | value      |
+      | code  | [string:2] |
+      | code  | [string:3] |

data/gemfiles/3.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "activerecord", "~> 3.1.0"
+
+gemspec :path=>"../"

data/gemfiles/3.1.gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: /Users/kostyantyn/Sites/github/gems/hydra_attribute
+  specs:
+    hydra_attribute (0.1.0.beta2)
+      activerecord (>= 3.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.5)
+      activesupport (= 3.1.5)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.5)
+      activemodel (= 3.1.5)
+      activesupport (= 3.1.5)
+      arel (~> 2.2.3)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.5)
+      multi_json (>= 1.0, < 1.3)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (2.2.3)
+    builder (3.0.0)
+    cucumber (1.2.0)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.10.0)
+      json (>= 1.4.6)
+    database_cleaner (0.8.0)
+    diff-lcs (1.1.3)
+    gherkin (2.10.0)
+      json (>= 1.4.6)
+    i18n (0.6.0)
+    json (1.7.3)
+    multi_json (1.2.0)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.1.0)
+  appraisal
+  cucumber
+  database_cleaner
+  hydra_attribute!
+  rspec
+  sqlite3

data/gemfiles/3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "activerecord", "~> 3.2.0"
+
+gemspec :path=>"../"

data/gemfiles/3.2.gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: /Users/kostyantyn/Sites/github/gems/hydra_attribute
+  specs:
+    hydra_attribute (0.1.0.beta2)
+      activerecord (>= 3.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.5)
+      activesupport (= 3.2.5)
+      builder (~> 3.0.0)
+    activerecord (3.2.5)
+      activemodel (= 3.2.5)
+      activesupport (= 3.2.5)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.5)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.0)
+    cucumber (1.2.0)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.10.0)
+      json (>= 1.4.6)
+    database_cleaner (0.8.0)
+    diff-lcs (1.1.3)
+    gherkin (2.10.0)
+      json (>= 1.4.6)
+    i18n (0.6.0)
+    json (1.7.3)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.2.0)
+  appraisal
+  cucumber
+  database_cleaner
+  hydra_attribute!
+  rspec
+  sqlite3

data/hydra_attribute.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hydra_attribute/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.author                = 'Kostyantyn Stepanyuk'
+  gem.email                 = 'kostya.stepanyuk@gmail.com'
+  gem.summary               = 'hydra_attribute allows to use EAV database structure for ActiveRecord models.'
+  gem.description           = 'hydra_attribute allows to use EAV database structure for ActiveRecord models.'
+  gem.homepage              = ""
+  gem.files                 = `git ls-files`.split("\n")
+  gem.test_files            = `git ls-files -- Appraisals {spec,features,gemfiles}/*`.split("\n")
+  gem.name                  = "hydra_attribute"
+  gem.require_paths         = %w(lib)
+  gem.required_ruby_version = Gem::Requirement.new('>= 1.9.2')
+  gem.version               = HydraAttribute::VERSION
+
+  gem.add_dependency('activerecord', '>= 3.1.0')
+
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('cucumber')
+  gem.add_development_dependency('sqlite3')
+  gem.add_development_dependency('database_cleaner')
+  gem.add_development_dependency('appraisal')
+end

data/lib/generators/hydra_attribute/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+  This generator generate the default initializer file.
+
+Usage:
+  rails generate hydra_attribute:install
+
+  This will create:
+    config/initializers/hydra_attribute.rb

data/lib/generators/hydra_attribute/install/install_generator.rb

@@ -0,0 +1,11 @@
+module HydraAttribute
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_initializer_file
+        copy_file 'hydra_attribute.txt', 'config/initializers/hydra_attribute.rb'
+      end
+    end
+  end
+end

data/lib/generators/hydra_attribute/install/templates/hydra_attribute.txt

@@ -0,0 +1,11 @@
+# Change default hydra_attribute configurations
+HydraAttribute.setup do |config|
+  # Add prefix for all attribute tables
+  # config.table_prefix = 'hydra_'
+
+  # Add prefix for has_many associations
+  # config.association_prefix = 'hydra_'
+
+  # Wrap all associated models in HydraAttribute module
+  # config.use_module_for_associated_models = true
+end

data/lib/hydra_attribute.rb

@@ -0,0 +1,31 @@
+module HydraAttribute
+  SUPPORT_TYPES = [:string, :text, :integer, :float, :boolean, :datetime]
+
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+
+    def setup
+      yield config
+    end
+  end
+
+end
+
+require 'hydra_attribute/version'
+require 'hydra_attribute/configuration'
+require 'hydra_attribute/association_builder'
+require 'hydra_attribute/attribute_builder'
+require 'hydra_attribute/builder'
+require 'hydra_attribute/migration'
+require 'hydra_attribute/attribute_proxy'
+require 'hydra_attribute/active_record'
+require 'hydra_attribute/active_record/scoping'
+require 'hydra_attribute/active_record/relation'
+require 'hydra_attribute/active_record/relation/query_methods'
+require 'hydra_attribute/active_record/attribute_methods'
+require 'hydra_attribute/active_record/attribute_methods/read'
+require 'hydra_attribute/active_record/attribute_methods/before_type_cast'
+
+require 'hydra_attribute/railtie' if defined?(Rails)

data/lib/hydra_attribute/active_record.rb

@@ -0,0 +1,7 @@
+module HydraAttribute
+  module ActiveRecord
+    def define_hydra_attributes
+      yield Builder.new(self)
+    end
+  end
+end

data/lib/hydra_attribute/active_record/attribute_methods.rb

@@ -0,0 +1,72 @@
+module HydraAttribute
+  module ActiveRecord
+    module AttributeMethods
+      extend ActiveSupport::Concern
+
+      included do
+        @hydra_attributes = {}
+
+        include Read
+        include BeforeTypeCast
+      end
+
+      module ClassMethods
+        def inherited(base)
+          base.instance_variable_set(:@hydra_attributes, hydra_attributes)
+          super
+        end
+
+        def hydra_attributes
+          @hydra_attributes.dup
+        end
+
+        def hydra_attribute_names
+          hydra_attributes.keys
+        end
+
+        def hydra_attribute_types
+          hydra_attributes.values.uniq
+        end
+      end
+
+      def initialize(attributes = nil, options = {})
+        @hydra_attribute_names = self.class.hydra_attribute_names
+        super
+      end
+
+      def init_with(coder)
+        @hydra_attribute_names = self.class.hydra_attribute_names
+        super
+      end
+
+      def initialize_dup(other)
+        if other.instance_variable_defined?(:@hydra_attribute_names)
+          @hydra_attribute_names = other.instance_variable_get(:@hydra_attribute_names)
+        else
+          @hydra_attribute_names = self.class.hydra_attribute_names
+        end
+        super
+      end
+
+      def hydra_attribute_model(name, type)
+        collection = send(HydraAttribute.config.association(type))
+        collection.detect { |model| model.name == name } || collection.build(name: name)
+      end
+
+      def attributes
+        super.merge(hydra_attributes)
+      end
+
+      %w(attributes attributes_before_type_cast).each do |attr_method|
+        module_eval <<-EOS, __FILE__, __LINE__ + 1
+          def hydra_#{attr_method}
+            @hydra_attribute_names.each_with_object({}) do |name, attributes|
+              type = self.class.hydra_attributes[name]
+              attributes[name] = hydra_attribute_model(name, type).#{attr_method}['value']
+            end
+          end
+        EOS
+      end
+    end
+  end
+end

data/lib/hydra_attribute/active_record/attribute_methods/before_type_cast.rb

@@ -0,0 +1,16 @@
+module HydraAttribute
+  module ActiveRecord
+    module AttributeMethods
+      module BeforeTypeCast
+        extend ActiveSupport::Concern
+        extend AttributeProxy
+
+        use_proxy_to_hydra_attribute :read_attribute_before_type_cast
+
+        def attributes_before_type_cast
+          super.merge(hydra_attributes_before_type_cast)
+        end
+      end
+    end
+  end
+end

data/lib/hydra_attribute/active_record/attribute_methods/read.rb

@@ -0,0 +1,13 @@
+module HydraAttribute
+  module ActiveRecord
+    module AttributeMethods
+      module Read
+        extend ActiveSupport::Concern
+        extend AttributeProxy
+
+        use_proxy_to_hydra_attribute :read_attribute
+
+      end
+    end
+  end
+end

data/lib/hydra_attribute/active_record/relation.rb

@@ -0,0 +1,44 @@
+module HydraAttribute
+  module ActiveRecord
+    module Relation
+      extend ActiveSupport::Concern
+
+      included do
+        include QueryMethods
+      end
+
+      define_method HydraAttribute.config.relation_execute_method do
+        return @records if loaded?
+        records = super()
+        return records if records.empty?
+
+        limit_values = select_values.any? || hydra_select_values.any?
+
+        if records.many?
+          if limit_values
+            hydra_attribute_types = hydra_select_values.map { |value| records.first.class.hydra_attributes[value] }.uniq
+          else
+            hydra_attribute_types = records.first.class.hydra_attribute_types
+          end
+
+          hydra_attribute_types.each do |type|
+            association = HydraAttribute.config.association(type)
+            unless records.first.association(association).loaded?
+              ::ActiveRecord::Associations::Preloader.new(records, association).run
+            end
+          end
+        end
+
+        if limit_values
+          records.each do |record| # force limit getter methods for hydra attributes
+            record.instance_variable_set(:@hydra_attribute_names, hydra_select_values)
+            record.instance_variable_get(:@attributes).delete('id') if @id_for_hydra_attributes
+          end
+        end
+
+        records
+      end
+
+    end
+  end
+end