hydra_attribute 0.1.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+.rvmrc
+bin/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/Appraisals

@@ -0,0 +1,7 @@
+appraise '3.1' do
+  gem "activerecord", '~> 3.1.0'
+end
+
+appraise '3.2' do
+  gem 'activerecord', '~> 3.2.0'
+end

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+**0.1.0 (June 6, 2012)** (initial release)
+* define EAV attributes
+* "where" condition
+* "order" condition
+* "reverse_order" condition
+* "select" condition

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kostyantyn Stepanyuk
+
+MIT License
+
+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,122 @@
+# hydra_attribute
+
+hydra_attribute is an implementation of
+[EAV pattern](http://en.wikipedia.org/wiki/Entity–attribute–value_model) for ActiveRecord models.
+
+## Requirements
+* ruby >= 1.9.2
+* active_record >= 3.1
+
+## Installation
+
+Add the following line to Gemfile:
+```ruby
+gem 'hydra_attribute'
+```
+and run `bundle install` from your shell.
+    
+After successful installation run rails generator:
+```shell
+rails generate hydra_attribute:install
+```
+
+This command generates hydra_attribute initializer:
+```ruby    
+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
+```
+
+And the last step is to generate db:migration:
+```shell
+rails generate migration create_hydra_attrubute_tables
+```    
+Migration should look like this:
+```ruby    
+class CreateHydraAttributeTables < ActiveRecord::Migration
+  def up
+    HydraAttribute::Migration.new(self).migrate
+  end
+      
+  def down
+    HydraAttribute::Migration.new(self).rollback
+  end
+end
+```
+## Usage
+
+##### Generate model
+```shell
+rails generate model Product type:string name:string
+rails generate model SimpleProduct --migration=false --parent=Product
+rake db:migrate
+```
+
+##### Describe EAV attributes
+```ruby
+class SimpleProduct < Product
+  attr_accessible :name, :title, :code, :quantity, :price, :active, :description
+  
+  define_hydra_attributes do |hydra|
+    hydra.string  :title, :code
+    hydra.integer :quantity 
+    hydra.float   :price
+    hydra.boolean :active
+    hydra.text    :description
+  end
+end
+```
+
+##### Create some products
+```shell
+SimpleProduct.create(name: 'Book', title: 'book', code: '100', quantity: 5, price: 2.75, active: true,  description: '...')
+SimpleProduct.create(name: 'Book', title: 'book', code: '101', quantity: 5, price: 3.75, active: true,  description: '...')
+SimpleProduct.create(name: 'Book', title: 'book', code: '102', quantity: 4, price: 4.50, active: false, description: '...')
+SimpleProduct.create(name: 'Book', title: nil,    code: '103', quantity: 3, price: 4.50, active: true,  description: '...')
+SimpleProduct.create(name: 'Book',                code: '104', quantity: 2, price: 5.00, active: true,  description: '...')
+```
+
+##### "where"
+```shell
+SimpleProduct.where(name: 'Book', quantity: 5, price: 2.75).first.attributes
+=> {"id"=>1, "type"=>"SimpleProduct", "name"=>"Book", "created_at"=>Tue, 05 Jun 2012 23:13:21 UTC +00:00, "updated_at"=>Tue, 05 Jun 2012 23:13:21 UTC +00:00, "title"=>"book", "code"=>"100", "quantity"=>5, "price"=>2.75, "active"=>true, "description"=>"..."} 
+
+SimpleProduct.where(title: 'book', active: false).first.attributes
+=> {"id"=>3, "type"=>"SimpleProduct", "name"=>"Book", "created_at"=>Tue, 05 Jun 2012 23:13:50 UTC +00:00, "updated_at"=>Tue, 05 Jun 2012 23:13:50 UTC +00:00, "title"=>"book", "code"=>"102", "quantity"=>4, "price"=>4.5, "active"=>false, "description"=>"..."}
+
+SimpleProduct.where(title: nil).first.attributes
+=> {"id"=>4, "type"=>"SimpleProduct", "name"=>"Book", "created_at"=>Tue, 05 Jun 2012 23:13:50 UTC +00:00, "updated_at"=>Tue, 05 Jun 2012 23:13:50 UTC +00:00, "title"=>nil, "code"=>"103", "quantity"=>3, "price"=>4.5, "active"=>true, "description"=>"..."} 
+
+SimpleProduct.where(title: nil).last.attributes
+=> {"id"=>5, "type"=>"SimpleProduct", "name"=>"Book", "created_at"=>Tue, 05 Jun 2012 23:13:51 UTC +00:00, "updated_at"=>Tue, 05 Jun 2012 23:13:51 UTC +00:00, "title"=>nil, "code"=>"104", "quantity"=>2, "price"=>5.0, "active"=>true, "description"=>"..."}
+```
+
+##### "order" and "reverse_order"
+```shell
+SimpleProduct.order(:code).first.attributes
+=> {"id"=>1, "type"=>"SimpleProduct", "name"=>"Book", "created_at"=>Tue, 05 Jun 2012 23:30:48 UTC +00:00, "updated_at"=>Tue, 05 Jun 2012 23:30:49 UTC +00:00, "title"=>"book", "code"=>"100", "quantity"=>5, "price"=>2.75, "active"=>true, "description"=>"..."} 
+
+SimpleProduct.order(:code).reverse_order.first.attributes
+=> {"id"=>5, "type"=>"SimpleProduct", "name"=>"Book", "created_at"=>Tue, 05 Jun 2012 23:30:51 UTC +00:00, "updated_at"=>Tue, 05 Jun 2012 23:30:51 UTC +00:00, "title"=>nil, "code"=>"104", "quantity"=>2, "price"=>5.0, "active"=>true, "description"=>"..."} 
+```
+
+##### "select"
+```shell
+SimpleProduct.select([:code, :price]).map(&:attributes)
+=> [{"code"=>"100", "price"=>2.75}, {"code"=>"101", "price"=>3.75}, {"code"=>"102", "price"=>4.5}, {"code"=>"103", "price"=>4.5}, {"code"=>"104", "price"=>5.0}]
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'appraisal'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new('spec')
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = '--format pretty'
+end
+
+task default: :spec

data/features/attribute_methods.feature

@@ -0,0 +1,151 @@
+Feature: helper methods for hydra attributes
+  When class calls hydra_attributes
+  Then symbolize hash with hydra attribute names and their types should be returned
+
+  When class calls hydra_attribute_names
+  Then array with symbolize hydra attribute names should be returned
+
+  When class calls hydra_attribute_types
+  Then array with symbolize hydra attribute types should be returned
+
+  When model calls hydra_attributes
+  Then stringify hash with hydra attribute names and their values should be returned
+
+  When model calls attributes
+  Then stringify hash with both native and hydra attributes should be returned
+
+  When model calls attributes_before_type_cast
+  Then stringify hash with both native and hydra attributes should be returned with values before type cast
+
+  When model calls read_attribute on hydra attribute
+  Then hydra attribute value should be returned
+
+  When model calls read_attribute_before_type_cast
+  Then hydra attribute value before type cast should be returned
+
+  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  |
+      | float  | price |
+      | text   | note  |
+    And create model class "GroupProduct" as "Product" with hydra attributes:
+      | type     | name   |
+      | integer  | price  |
+      | string   | title  |
+      | boolean  | active |
+      | datetime | launch |
+
+  Scenario Outline: class hydra_attributes
+    Then class "<class>"::"<method>" "<behavior>" have "<param>" hash
+
+    Scenarios: hydra attributes
+      | class         | method           | behavior | param                                                     |
+      | SimpleProduct | hydra_attributes | should   | code=string price=float note=text                         |
+      | GroupProduct  | hydra_attributes | should   | price=integer title=string active=boolean launch=datetime |
+
+  Scenario Outline: class hydra_attribute_names
+    Then class "<class>"::"<method>" "<behavior>" have string "<params>" in array
+
+    Scenarios: hydra attribute names
+      | class         | method                | behavior   | params                    |
+      | SimpleProduct | hydra_attribute_names | should     | code price note           |
+      | SimpleProduct | hydra_attribute_names | should_not | title active launch       |
+      | GroupProduct  | hydra_attribute_names | should     | price title active launch |
+      | GroupProduct  | hydra_attribute_names | should_not | code note                 |
+
+  Scenario Outline: class hydra_attribute_types
+    Then class "<class>"::"<method>" "<behavior>" have symbol "<params>" in array
+
+    Scenarios: hydra attribute types
+      | class         | method                | behavior   | params                          |
+      | SimpleProduct | hydra_attribute_types | should     | string float text               |
+      | SimpleProduct | hydra_attribute_types | should_not | integer boolean datetime        |
+      | GroupProduct  | hydra_attribute_types | should     | integer string boolean datetime |
+      | GroupProduct  | hydra_attribute_types | should_not | text float                      |
+
+  Scenario Outline: model hydra_attributes
+    Given create models:
+      | model         | attributes                                                                                                        |
+      | SimpleProduct | name=[string:a] info=[string:i] code=[string:c] price=[float:2] note=[string:n]                                   |
+      | GroupProduct  | name=[string:a] info=[string:i] price=[float:2] title=[string:t] active=[boolean:true] launch=[string:2012-06-03] |
+    When select "first" "<model>" record
+    Then model "<model>" should have only the following hydra attributes "<attributes>"
+    And record should have the following hydra attributes "<values>" in attribute hash
+
+    Scenarios: required hydra attributes
+      | model         | attributes                | values                                                                            |
+      | SimpleProduct | code price note           | code=[string:c] price=[float:2] note=[string:n]                                   |
+      | GroupProduct  | price title active launch | price=[float:2] title=[string:t] active=[boolean:true] launch=[string:2012-06-03] |
+
+  Scenario Outline: model attributes
+    Given create models:
+      | model         | attributes                                                                                                        |
+      | SimpleProduct | name=[string:a] info=[string:i] code=[string:c] price=[float:2] note=[string:n]                                   |
+      | GroupProduct  | name=[string:a] info=[string:i] price=[float:2] title=[string:t] active=[boolean:true] launch=[string:2012-06-03] |
+    When select "first" "<model>" record
+    Then model "<model>" should have only the following attributes "<attributes>"
+    And record should have the following attributes "<values>" in attribute hash
+
+    Scenarios: required attributes
+      | model         | attributes                                                        | values                                                                                                            |
+      | SimpleProduct | id type name info created_at updated_at code price note           | name=[string:a] info=[string:i] code=[string:c] price=[float:2] note=[string:n]                                   |
+      | GroupProduct  | id type name info created_at updated_at price title active launch | name=[string:a] info=[string:i] price=[float:2] title=[string:t] active=[boolean:true] launch=[string:2012-06-03] |
+
+  Scenario Outline: model attributes_before_type_cast
+    Given create models:
+      | model         | attributes                                                                                                        |
+      | SimpleProduct | name=[string:a] info=[string:i] code=[string:c] price=[float:2] note=[string:n]                                   |
+      | GroupProduct  | name=[string:a] info=[string:i] price=[float:2] title=[string:t] active=[boolean:true] launch=[string:2012-06-07] |
+    When select "first" "<model>" record
+    Then model "<model>" should have only the following attributes before type cast "<attributes>"
+    And record should have the following attributes before type cast "<before type cast values>" in attribute hash
+
+    Scenarios: required before type cast attributes
+      | model         | attributes                                                        | before type cast values                                                                                                       |
+      | SimpleProduct | id type name info created_at updated_at code price note           | name=[string:a] info=[string:i] code=[string:c] price=[float:2] note=[string:n]                                               |
+      | GroupProduct  | id type name info created_at updated_at price title active launch | name=[string:a] info=[string:i] price=[float:2] title=[string:t] active=[string:t] launch=[string:2012-06-07 00:00:00.000000] |
+
+  Scenario Outline: model read_attributes
+    Given create models:
+      | model         | attributes                                                                                    |
+      | SimpleProduct | name=[string:a] info=[string:i] code=[string:c] price=[nil:]                                  |
+      | GroupProduct  | name=[string:a] info=[string:i] price=[nil:] active=[boolean:true] launch=[string:2012-06-03] |
+    When select "first" "<model>" record
+    Then record read attribute "<attribute>" and value should be "<value>"
+
+    Scenarios: read attributes
+      | model         | attribute | value                 |
+      | SimpleProduct | name      | [string:a]            |
+      | SimpleProduct | info      | [string:i]            |
+      | SimpleProduct | code      | [string:c]            |
+      | SimpleProduct | price     | [nil:]                |
+      | SimpleProduct | note      | [nil:]                |
+      | GroupProduct  | name      | [string:a]            |
+      | GroupProduct  | info      | [string:i]            |
+      | GroupProduct  | price     | [nil:]                |
+      | GroupProduct  | title     | [nil:]                |
+      | GroupProduct  | active    | [boolean:true]        |
+      | GroupProduct  | launch    | [datetime:2012-06-03] |
+
+  Scenario Outline: model read_attributes_before_type_cast
+    Given create models:
+      | model         | attributes                                                        |
+      | SimpleProduct | name=[string:a] price=[float:2]                                   |
+      | GroupProduct  | name=[string:a] active=[boolean:false] launch=[string:2012-06-03] |
+    When select "first" "<model>" record
+    Then record read attribute before type cast "<attribute>" and value should be "<value>"
+
+    Scenarios: read attributes
+      | model         | attribute | value                               |
+      | SimpleProduct | name      | [string:a]                          |
+      | SimpleProduct | price     | [float:2]                           |
+      | GroupProduct  | name      | [string:a]                          |
+      | GroupProduct  | active    | [string:f]                          |
+      | GroupProduct  | launch    | [string:2012-06-03 00:00:00.000000] |

data/features/define_attributes.feature

@@ -0,0 +1,61 @@
+Feature: define hydra attributes
+  Models should respond to hydra attributes
+
+  Model should respond to hydra attributes if they are described in the class.
+  Model should not respond to hydra attribute if it isn't described in it class.
+
+  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 |
+    And create model class "GroupProduct" as "Product" with hydra attributes:
+      | type    | name  |
+      | float   | price |
+
+  Scenario Outline: models should respond to hydra attributes
+    Then model "<model>" should "<respond>" to "<attributes>"
+
+    Scenarios: model should respond to own hydra attributes
+      | model         | respond    | attributes              |
+      | SimpleProduct | should     | code                    |
+      | SimpleProduct | should     | code=                   |
+      | SimpleProduct | should     | code?                   |
+      | SimpleProduct | should     | code_before_type_cast   |
+      | SimpleProduct | should     | code_changed?           |
+      | SimpleProduct | should     | code_change             |
+      | SimpleProduct | should     | code_will_change!       |
+      | SimpleProduct | should     | code_was                |
+      | SimpleProduct | should     | reset_code!             |
+      | SimpleProduct | should_not | price                   |
+      | SimpleProduct | should_not | price=                  |
+      | SimpleProduct | should_not | price?                  |
+      | SimpleProduct | should_not | price_before_type_cast  |
+      | SimpleProduct | should_not | price_changed?          |
+      | SimpleProduct | should_not | price_change            |
+      | SimpleProduct | should_not | price_will_change!      |
+      | SimpleProduct | should_not | price_was               |
+      | SimpleProduct | should_not | reset_price!            |
+      | GroupProduct  | should     | price                   |
+      | GroupProduct  | should     | price=                  |
+      | GroupProduct  | should     | price?                  |
+      | GroupProduct  | should     | price_before_type_cast  |
+      | GroupProduct  | should     | price_changed?          |
+      | GroupProduct  | should     | price_change            |
+      | GroupProduct  | should     | price_will_change!      |
+      | GroupProduct  | should     | price_was               |
+      | GroupProduct  | should     | reset_price!            |
+      | GroupProduct  | should_not | code                    |
+      | GroupProduct  | should_not | code=                   |
+      | GroupProduct  | should_not | code?                   |
+      | GroupProduct  | should_not | code_before_type_cast   |
+      | GroupProduct  | should_not | code_changed?           |
+      | GroupProduct  | should_not | code_change             |
+      | GroupProduct  | should_not | code_will_change!       |
+      | GroupProduct  | should_not | code_was                |
+      | GroupProduct  | should_not | reset_code!             |

data/features/load_associations.feature

@@ -0,0 +1,45 @@
+Feature: hydra attribute associations
+  When loaded collection has more than one record
+  Then all hydra attribute associations should be loaded
+
+  When loaded collection hasn't records or has only one
+  Then hydra attribute association should not be loaded automatically
+
+  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  |
+      | float  | price |
+    And create model class "GroupProduct" as "Product" with hydra attributes:
+      | type    | name   |
+      | float   | price  |
+      | string  | title  |
+      | boolean | active |
+
+  Scenario: hydra attribute associations should be included for collection with more then one record
+    Given create models:
+      | model         | attributes       |
+      | SimpleProduct | code=[integer:1] |
+      | SimpleProduct | code=[integer:2] |
+    When load all "SimpleProduct" records
+    Then records "should" have loaded associations:
+      | association             |
+      | hydra_string_attributes |
+      | hydra_float_attributes  |
+
+  Scenario: hydra attribute associations should not be included for collection with one record
+    Given create models:
+      | model        | attributes         |
+      | GroupProduct | price=[float:2.75] |
+    When load all "GroupProduct" records
+    Then records "should_not" have loaded associations:
+      | association              |
+      | hydra_float_attributes   |
+      | hydra_string_attributes  |
+      | hydra_boolean_attributes |