hydra_attribute 0.4.0.rc1 → 0.4.0.rc2

data/README.md

@@ -1,8 +1,9 @@
-# hydra_attribute
-[![Build Status](https://secure.travis-ci.org/kostyantyn/hydra_attribute.png)](http://travis-ci.org/kostyantyn/hydra_attribute)
+# hydra_attribute [![Build Status](https://secure.travis-ci.org/kostyantyn/hydra_attribute.png)](http://travis-ci.org/kostyantyn/hydra_attribute)
+
+[Wiki](https://github.com/kostyantyn/hydra_attribute/wiki) | [RDoc](http://rdoc.info/github/kostyantyn/hydra_attribute)
 
 hydra_attribute is an implementation of
-[EAV pattern](http://en.wikipedia.org/wiki/Entity–attribute–value_model) for ActiveRecord models.
+[EAV (Entity-Attribute-Value) pattern](http://en.wikipedia.org/wiki/Entity–attribute–value_model) for ActiveRecord models. It allows to create or remove attributes in runtime. Also each record may have different sets of attributes, for example: Product with ID 1 can have different set of attributes than Product with ID 2.
 
 ## Requirements
 * ruby >= 1.9.2
@@ -36,7 +37,8 @@ class CreateHydraAttributeTables < ActiveRecord::Migration
 end
 ```
 
-##### or if we have already the entity table
+**or if we have already the entity table**
+
 ```ruby    
 class CreateHydraAttributeTables < ActiveRecord::Migration
   def up
@@ -51,7 +53,7 @@ end
 
 ## Usage
 
-##### Create model
+### Create model
 ```shell
 rails generate model Product type:string name:string --migration=false
 rake db:migrate
@@ -71,7 +73,7 @@ class Product < ActiveRecord::Base
 end
 ```
 
-##### Create some hydra attributes from `rails console`
+### Create hydra attributes
 ```ruby
 Product.hydra_attributes.create(name: 'color', backend_type: 'string', default_value: 'green')
 Product.hydra_attributes.create(name: 'title', backend_type: 'string')
@@ -88,57 +90,85 @@ Creating method accepts the following options:
     Product.hydra_attributes.create({name: 'title', backend_type: 'string', white_list: true}, as: :admin)
   ```
 
-##### Create several objects
-
+### Create records
 ```ruby
-Product.create.attributes
-# {"id"=>1, created_at"=>..., "updated_at"=>..., "color"=>"green", "title"=>nil, "total"=>1}
-Product.create(color: 'red', title: 'toy').attributes
-# {"id"=>1, "created_at"=>..., "updated_at"=>..., "color"=>"red", "title"=>"toy", "total"=>1}
-Product.create(title: 'book', total: 2).attributes
-# {"id"=>1, "created_at"=>..., "updated_at"=>..., "color"=>"green", "title"=>"book", "total"=>2} 
+Product.create
+#<Product id: 1, hydra_set_id: nil, created_at: ..., updated_at: ..., color: "green", title: nil, total: 1>
+Product.create(color: 'red', title: 'toy')
+#<Product id: 2, hydra_set_id: nil, created_at: ..., updated_at: ..., color: "red", title: "toy", total: 1>
+Product.create(title: 'book', total: 2)
+#<Product id: 3, hydra_set_id: nil, created_at: ..., updated_at: ..., color: "green", title: "book", total: 2>
 ```
 
-##### Add the new attribute in runtime
+### Add new hydra attribute in runtime
 ```ruby
 Product.hydra_attributes.create(name: 'price', backend_type: 'float', default_value: 0.0)
-Product.create(title: 'car', price: 2.50).attributes
-# {"id"=>4, "created_at"=>..., "updated_at"=>..., "color"=>"green", "title"=>"car", "price"=>2.5, "total"=>1} 
+Product.create(title: 'car', price: 2.50)
+#<Product id: 4, hydra_set_id: nil, created_at: ..., updated_at: ..., color: "green", title: "car", total: 2, price: 2.5>
+```
+
+### Create hydra set
+**Hydra set** allows set unique attribute list for each entity.
+
+```ruby
+hydra_set = Product.hydra_sets.create(name: 'Default')
+hydra_set.hydra_attributes = Product.hydra_attributes.where(name: %w(color title price))
+
+Product.create(color: 'black', title: 'ipod', price: 49.95, total: 5) do |product|
+  product.hydra_set_id = hydra_set.id
+end
+#<Product id: 5, hydra_set_id: 1, created_at: ..., updated_at: ..., color: "black", title: "ipod", price: 49.95>
 ```
+**Notice:** the `total` attribute was skipped because it doesn't exist in hydra set.
 
-##### Obtain data
+### Obtain data
 ```ruby
-Product.where(color: 'red').map(&:attributes)
-# [{"id"=>2, "created_at"=>..., "updated_at"=>..., "color"=>"red", "title"=>"toy", "price"=>0.0, "total"=>1}] 
-Product.where(color: 'green', price: nil).map(&:attributes)
-# [{"id"=>1, "created_at"=>..., "updated_at"=>..., "color"=>"green", "title"=>nil, "price"=>0.0, "total"=>1},  
-#  {"id"=>3, "created_at"=>..., "updated_at"=>..., "color"=>"green", "title"=>"book", "price"=>0.0, "total"=>2}] 
+Product.where(color: 'red')
+# [#<Product id: 2, hydra_set_id: nil, created_at: ..., updated_at: ..., color: "red", title: "toy", price: 0.0, total: 1>]
+Product.where(color: 'green', price: nil)
+# [
+    #<Product id: 1, hydra_set_id: nil, created_at: ..., updated_at: ..., color: "green", title: nil, price: 0.0, total: 1>,
+    #<Product id: 3, hydra_set_id: nil, created_at: ..., updated_at: ..., color: "green", title: "book", price: 0.0, total: 2>
+# ]
 ```
 **Notice**: the attribute `price` was added in runtime and records that were created before have not this attribute
 so they matched this condition `where(price: nil)`
 
-##### Order data
+### Order data
 ```ruby
-Product.order(:color).first.attributes
-# {"id"=>1, "created_at"=>..., "updated_at"=>..., "color"=>"green", "title"=>nil, "price"=>0.0, "total"=>1} 
-Product.order(:color).reverse_order.first.attributes
-# {"id"=>2, "created_at"=>..., "updated_at"=>..., "color"=>"red", "title"=>"toy", "price"=>0.0, "total"=>1}
+Product.order(:color, :title).first
+#<Product id: 5, hydra_set_id: 1, created_at: ..., updated_at: ..., color: "black", title: "ipod", price: 49.95>
+Product.order(:color, :title).reverse_order.first
+#<Product id: 2, hydra_set_id: nil, created_at: ..., updated_at: ..., color: "red", title: "toy", price: 0.0, total: 1>
 ```
 
-##### Select concrete attributes
+### Select concrete attributes
 ```ruby
-Product.select([:color, :title]).map(&:attributes)
-# [{"id"=>1, "color"=>"green", "title"=>nil}, {"id"=>2, "color"=>"red", "title"=>"toy"},  
-#  {"id"=>3, "color"=>"green", "title"=>"book"}, {"id"=>4, "color"=>"green", "title"=>"car"}]
+Product.select([:color, :title])
+# [
+    #<Product id: 1, hydra_set_id: nil, color: "green", title: nil>,
+    #<Product id: 2, hydra_set_id: nil, color: "red", title: "toy">,
+    #<Product id: 3, hydra_set_id: nil, color: "green", title: "book">,
+    #<Product id: 4, hydra_set_id: nil, color: "green", title: "car">,
+    #<Product id: 5, hydra_set_id: 1, color: "black", title: "ipod">
+# ] 
 ```
-**Notice**: `id` attribute will be added if we want to select hydra attribute
+**Notice:** `id` and `hydra_set_id` attributes are forced added because they are important for correct work.
 
-##### Group by attribute
+### Group by attribute
 ```ruby
 Product.group(:color).count
-# {"green"=>3, "red"=>1}
+# {"black"=>1, "green"=>3, "red"=>1}
 ```
 
+## Wiki Docs
+* [Create migration](https://github.com/kostyantyn/hydra_attribute/wiki/Create-migration)
+* [Create attributes in runtime](https://github.com/kostyantyn/hydra_attribute/wiki/Create-attributes-in-runtime)
+* [Create sets of attributes](https://github.com/kostyantyn/hydra_attribute/wiki/Create-sets-of-attributes)
+* [Query methods](https://github.com/kostyantyn/hydra_attribute/wiki/Query-methods)
+* [Database schema](https://github.com/kostyantyn/hydra_attribute/wiki/Database-schema)
+* [Helper methods](https://github.com/kostyantyn/hydra_attribute/wiki/Helper-methods)
+
 ## Notice
 
 The each new minor version doesn't guarantee back compatibility with previous one 

data/features/entity/create.feature

@@ -53,6 +53,23 @@ Feature: create models with hydra attributes
       | info    | b                 |
       | started | [date:2012-05-05] |
 
+  Scenario: create hydra attribute in runtime
+    # create product to cache all hydra attributes
+    Given create "Product" model
+    And create hydra attributes for "Product" with role "admin" as "hashes":
+      | name     | backend_type | default_value | white_list |
+      | quantity | integer      | [nil:]        | [bool:t]   |
+    And create "Product" model with attributes as "rows_hash":
+      | quantity | 5 |
+    Then last created "Product" should have the following attributes:
+      | code     | [nil:]            |
+      | info     | [str:]            |
+      | price    | [float:0]         |
+      | total    | [int:0]           |
+      | active   | [bool:f]          |
+      | started  | [date:2012-01-01] |
+      | quantity | [int:5]           |
+
   Scenario: pass only hydra_set_id
     Given create hydra sets for "Product" as "hashes":
       | name    |

data/features/relation/query_methods/where.feature

@@ -67,4 +67,49 @@ Feature: hydra attribute where conditions
     And records should have the following attributes:
       | field | value |
       | code  | 2     |
-      | code  | 3     |
+      | code  | 3     |
+
+  Scenario: select entity if it has attribute in attribute set
+    Given  create hydra set "Default" for "Product"
+    And set hydra attributes "[array:code,title]" to hydra set "Default" for entity "Product"
+    And create "Product" models with attributes as "hashes":
+      | hydra_set_id                           | code | title |
+      |                                        | abc1 | book  |
+      | [eval:Product.hydra_set('Default').id] | abc2 | book  |
+    When filter "Product" by:
+      | field | value |
+      | title | book  |
+    Then total records should be "2"
+    And records should have the following attributes:
+      | field | value |
+      | code  | abc1  |
+      | code  | abc2  |
+
+  Scenario: when filter attribute by nil value then entities without this attribute in attribute set should not be selected
+    Given create hydra set "Default" for "Product"
+    And create "Product" model
+    And create "Product" model with attributes as "rows_hash":
+      | hydra_set_id | [eval:Product.hydra_set('Default').id] |
+    When filter "Product" by:
+      | field | value  |
+      | code  | [nil:] |
+    Then total records should be "1"
+    And records should have the following attributes:
+      | field        | value  |
+      | hydra_set_id | [nil:] |
+
+  Scenario: when filter attribute by value then entities which don't have this attribute in attribute set any more should not be selected
+    Given create hydra set "Default" for "Product"
+    And add hydra attribute "code" to hydra set "Default" for entity "Product"
+    And create "Product" models with attributes as "hashes":
+      | hydra_set_id                           | code |
+      |                                        | abc  |
+      | [eval:Product.hydra_set('Default').id] | abc  |
+    And set hydra attributes "title" to hydra set "Default" for entity "Product"
+    When filter "Product" by:
+      | field | value |
+      | code  | abc   |
+    Then total records should be "1"
+    And records should have the following attributes:
+      | field        | value  |
+      | hydra_set_id | [nil:] |

data/features/step_definitions/model_steps.rb

@@ -66,6 +66,19 @@ Given /^add "([^"]+)" hydra attributes to hydra set:$/ do |klass, table|
   end
 end
 
+Given /^add hydra attribute "([^"]+)" to hydra set "([^"]+)" for entity "([^"]+)"$/ do |hydra_attribute, hydra_set, entity_class|
+  entity = entity_class.constantize
+  entity.hydra_set(type_cast_value(hydra_set)).hydra_attributes << entity.hydra_attribute(type_cast_value(hydra_attribute))
+end
+
+Given /^set hydra attributes? "([^"]+)" to hydra set "([^"]+)" for entity "([^"]+)"$/ do |hydra_attributes, hydra_set, entity_class|
+  entity    = entity_class.constantize
+  hydra_set = entity.hydra_set(type_cast_value(hydra_set))
+
+  hydra_attributes = Array(type_cast_value(hydra_attributes)).map { |attr| entity.hydra_attribute(attr) }
+  hydra_set.hydra_attributes = hydra_attributes
+end
+
 Given /^(load and )?(save|create|update(?: all| attributes)?|destroy(?: all)?|delete(?: all)?)(?: for)? "([^"]+)" models? with attributes as "([^"]+)":$/ do |load, action, klass, format, table|
   action = action.gsub(' ', '_')
   klass  = klass.constantize

data/gemfiles/3.1.gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: /Users/kostyantyn/Sites/github/gems/hydra_attribute
   specs:
-    hydra_attribute (0.4.0.beta)
+    hydra_attribute (0.4.0.rc1)
       activerecord (>= 3.1.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.1.7)
-      activesupport (= 3.1.7)
+    activemodel (3.1.8)
+      activesupport (= 3.1.8)
       builder (~> 3.0.0)
       i18n (~> 0.6)
-    activerecord (3.1.7)
-      activemodel (= 3.1.7)
-      activesupport (= 3.1.7)
+    activerecord (3.1.8)
+      activemodel (= 3.1.8)
+      activesupport (= 3.1.8)
       arel (~> 2.2.3)
       tzinfo (~> 0.3.29)
-    activesupport (3.1.7)
+    activesupport (3.1.8)
       multi_json (>= 1.0, < 1.3)
     appraisal (0.4.1)
       bundler
       rake
     arel (2.2.3)
-    builder (3.0.0)
+    builder (3.0.3)
     cucumber (1.2.1)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
@@ -30,10 +30,10 @@ GEM
       json (>= 1.4.6)
     database_cleaner (0.8.0)
     diff-lcs (1.1.3)
-    gherkin (2.11.1)
+    gherkin (2.11.2)
       json (>= 1.4.6)
-    i18n (0.6.0)
-    json (1.7.4)
+    i18n (0.6.1)
+    json (1.7.5)
     multi_json (1.2.0)
     rake (0.9.2.2)
     rspec (2.11.0)
@@ -41,9 +41,9 @@ GEM
       rspec-expectations (~> 2.11.0)
       rspec-mocks (~> 2.11.0)
     rspec-core (2.11.1)
-    rspec-expectations (2.11.2)
+    rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.1)
+    rspec-mocks (2.11.2)
     sqlite3 (1.3.6)
     tzinfo (0.3.33)
 

data/gemfiles/3.2.gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: /Users/kostyantyn/Sites/github/gems/hydra_attribute
   specs:
-    hydra_attribute (0.4.0.beta)
+    hydra_attribute (0.4.0.rc1)
       activerecord (>= 3.1.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.7)
-      activesupport (= 3.2.7)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
       builder (~> 3.0.0)
-    activerecord (3.2.7)
-      activemodel (= 3.2.7)
-      activesupport (= 3.2.7)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.7)
+    activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     appraisal (0.4.1)
       bundler
       rake
     arel (3.0.2)
-    builder (3.0.0)
+    builder (3.0.3)
     cucumber (1.2.1)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
@@ -30,10 +30,10 @@ GEM
       json (>= 1.4.6)
     database_cleaner (0.8.0)
     diff-lcs (1.1.3)
-    gherkin (2.11.1)
+    gherkin (2.11.2)
       json (>= 1.4.6)
-    i18n (0.6.0)
-    json (1.7.4)
+    i18n (0.6.1)
+    json (1.7.5)
     multi_json (1.3.6)
     rake (0.9.2.2)
     rspec (2.11.0)
@@ -41,9 +41,9 @@ GEM
       rspec-expectations (~> 2.11.0)
       rspec-mocks (~> 2.11.0)
     rspec-core (2.11.1)
-    rspec-expectations (2.11.2)
+    rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.1)
+    rspec-mocks (2.11.2)
     sqlite3 (1.3.6)
     tzinfo (0.3.33)
 

data/lib/hydra_attribute/active_record/attribute_methods.rb

@@ -53,7 +53,7 @@ module HydraAttribute
             generated_hydra_attribute_methods.module_eval <<-EOS, __FILE__, __LINE__ + 1
               #{defn}
                 if hydra_set_id? and self.class.hydra_set_attribute_ids(hydra_set_id).exclude?(#{hydra_attribute.id})
-                  raise MissingAttributeInHydraSetError, 'Attribute "#{hydra_attribute.name}" does not exist in hydra set "\#{hydra_set(hydra_set_id).name}"'
+                  raise MissingAttributeInHydraSetError, %(Hydra attribute "#{hydra_attribute.name}" does not exist in hydra set "\#{self.class.hydra_set(hydra_set_id).name}")
                 end
 
                 if value_model = hydra_value_model(#{hydra_attribute.id})
@@ -99,7 +99,7 @@ module HydraAttribute
           attr_name = self.class.send(:attribute_method_matcher, name).attr_name
         end
 
-        if hydra_attribute?(attr_name)
+        if self.class.hydra_attribute_names.include?(attr_name)
           self.class.hydra_set_attribute_names(hydra_set_id).include?(attr_name)
         else
           super
@@ -136,9 +136,8 @@ module HydraAttribute
       end
 
       def inspect
-        attrs  = self.class.column_names.map { |name| "#{name}: #{attribute_for_inspect(name)}" }
-        attrs += hydra_value_models.map { |model| "#{model.hydra_attribute_name}: #{model.attribute_for_inspect('value')}" }
-        "#<#{self.class} #{attrs.join(', ')}>"
+        attrs = hydra_value_models.map { |model| "#{model.hydra_attribute_name}: #{model.attribute_for_inspect('value')}" }
+        super.gsub(/>$/, ", #{attrs.join(', ')}>")
       end
 
       private

data/lib/hydra_attribute/active_record/relation/query_methods.rb

@@ -4,7 +4,7 @@ module HydraAttribute
       module QueryMethods
         extend ActiveSupport::Concern
 
-        MULTI_VALUE_METHODS = [:hydra_joins_aliases, :hydra_select_values]
+        MULTI_VALUE_METHODS = [:hydra_joins_aliases, :hydra_select_values, :hydra_attributes]
 
         included do
           attr_writer *MULTI_VALUE_METHODS
@@ -25,6 +25,7 @@ module HydraAttribute
             opts.inject(self) do |relation, (name, value)|
               if klass.hydra_attribute_names.include?(name.to_s)
                 relation, name = relation.clone, name.to_s
+                relation.hydra_attributes    << name
                 relation.hydra_joins_aliases << hydra_helper.ref_alias(name, value)
                 relation.joins_values += hydra_helper.build_joins(name, value)
                 relation.where_values += build_where(hydra_helper.where_options(name, value))
@@ -58,6 +59,11 @@ module HydraAttribute
             @select_values << hydra_helper.prepend_table_name('hydra_set_id')
           end
 
+          if hydra_attributes.any?
+            hydra_sets = klass.hydra_sets.select { |hydra_set| hydra_set.hydra_attributes.any? { |attr| attr.name.in?(hydra_attributes) } }
+            @where_values << table[:hydra_set_id].in(hydra_sets.map(&:id)).or(table[:hydra_set_id].eq(nil))
+          end
+
           super
         end
 

data/lib/hydra_attribute/builder.rb

@@ -20,7 +20,7 @@ module HydraAttribute
 
     def build
       build_associations
-      build_white_list
+      update_mass_assignment_security
     end
 
     private
@@ -30,8 +30,8 @@ module HydraAttribute
         end
       end
 
-      def build_white_list
-        klass.hydra_attributes.each(&:toggle_white_list!)
+      def update_mass_assignment_security
+        klass.hydra_attributes.each(&:update_mass_assignment_security)
       end
   end
 end

data/lib/hydra_attribute/hydra_attribute.rb

@@ -19,17 +19,17 @@ module HydraAttribute
 
     before_destroy :delete_dependent_values
     after_commit   :clear_entity_cache
-    after_commit   :toggle_white_list!
+    after_commit   :update_mass_assignment_security
 
     # @COMPATIBILITY with 3.1.x association module is directly added to the class instead of including module
     def hydra_sets_with_clearing_cache=(value)
       self.hydra_sets_without_clearing_cache = value
-      clear_entity_cache
+      entity_type.constantize.clear_hydra_method_cache!
       value
     end
     alias_method_chain :hydra_sets=, :clearing_cache
 
-    def toggle_white_list!
+    def update_mass_assignment_security
       if destroyed? or !white_list?
         remove_from_white_list
       else
@@ -44,7 +44,7 @@ module HydraAttribute
       end
 
       def clear_entity_cache
-        entity_type.constantize.clear_hydra_method_cache!
+        entity_type.constantize.reset_hydra_attribute_methods!
       end
 
       def add_to_white_list