hstore_accessor 0.6.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c01e590bd0c9ae91fc49ddc4dc1c2b687292d6e
-  data.tar.gz: cca0f9e8ff8bcb3ab3081123e43568393b6006b4
+  metadata.gz: be6414ac167ae2ee47c461f887f5e38557e9bc1f
+  data.tar.gz: 30c0619e2c650ab109adc4a47af914326dc6a699
 SHA512:
-  metadata.gz: 10e8633baf66a5119571d8d47d1e1617cdb223529671596ac84e8547240fd2cc004f9620795ad3166965fe69d4afe4f482eff5429a0a692bea7cb828895dff37
-  data.tar.gz: a241e6f63c92b4e3e11d8677c8846fd274a94b7bffeacf45c7294fc92fa3ce473ff2318d910fe164765d11945f2cead9fbe681c24c5367bbfdae27bef8f9529d
+  metadata.gz: cc93bf29866e627e137c90b557acbe22f360ba6f1c3dcf847fc1aa1187beee2d68d8dc40cd80d81c052f6742afc8d8bb76c8b320b12d6859521965f4d8aa05d2
+  data.tar.gz: 00c0d0fbecbb399f0553128ff1dc5686a9d022031783db4faa4aa4b60860aa554433050f623bc01381885cbe0fcf689d999a7f9e6c9a34d17c6c4d7e8eaa407a

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 logfile
+gemfiles/*.gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  Include:
+    - Rakefile
+Lint/SpaceBeforeFirstArg:
+  Enabled: false
+Lint/UnusedBlockArgument:
+  Enabled: false
+Lint/UnusedMethodArgument:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Style/AlignParameters:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/FileName:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/IndentHash:
+  Enabled: false
+Style/RescueModifier:
+  Enabled: false
+Style/SignalException:
+  Enabled: false
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "activerecord-4.2" do
+  gem "activerecord", "4.2.0"
+end
+
+appraise "activerecord-4.1" do
+  gem "activerecord", "4.1.0"
+end
+
+appraise "activerecord-4.0" do
+  gem "activerecord", "4.0.0"
+end

data/Gemfile

@@ -3,9 +3,5 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
-
-  platform :ruby do
-    gem "pg", ">= 0.14.1"
-  end
-
+  gem "pg", ">= 0.14.1"
 end

data/README.md

@@ -2,17 +2,33 @@
 
 # HstoreAccessor
 
-PostgreSQL provides an hstore data type for storing arbitrarily complex
-structures in a column.  ActiveRecord 4.0 supports Hstore but casts all
-values in the store to a string.  Further, ActiveRecord does not provide
-discrete fields to access values directly in the hstore column.  The
-HstoreAccessor gem solves both of these issues.
+Hstore Accessor allows you to treat fields on an hstore column as though they were actual columns being picked up by ActiveRecord. This is especially handy when trying to avoid sparse columns while making use of [single table inheritence](#single-table-inheritance). Hstore Accessor currently supports ActiveRecord versions 4.0, 4.1, and 4.2.
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Setup](#setup)
+* [ActiveRecord methods generated for fields](#activerecord-methods-generated-for-fields)
+* [Scopes](#scopes)
+  * [String Fields](#string-fields)
+  * [Integer, Float, and Decimal Fields](#integer-float-decimal-fields)
+  * [Datetime Fields](#datetime-fields)
+  * [Date Fields](#date-fields)
+  * [Array Fields](#array-fields)
+  * [Boolean Fields](#boolean-fields)
+* [Single Table Inheritence](#single-table-inheritance)
+* [Upgrading](#upgrading)
+* [Contributing](#contributing)
+  - [Basics](#basics)
+  - [Developing Locally](#developing-locally)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'hstore_accessor'
+```ruby
+gem "hstore_accessor"
+```
 
 And then execute:
 
@@ -22,47 +38,47 @@ Or install it yourself as:
 
     $ gem install hstore_accessor
 
-## Usage
-
-### Setup
+## Setup
 
 The `hstore_accessor` method accepts the name of the hstore column you'd
 like to use and a hash with keys representing fields and values
 indicating the type to be stored in that field.  The available types
-are: `string`, `integer`, `float`, `time`, `boolean`, `array`, and `hash`.
+are: `string`, `integer`, `float`, `decimal`, `datetime`, `date`, `boolean`, `array`, and `hash`. It is available on an class that inherits from `ActiveRecord::Base`.
 
 ```ruby
 class Product < ActiveRecord::Base
-
   hstore_accessor :options,
     color: :string,
     weight: :integer,
     price: :float,
-    built_at: :time,
-    tags: :array,
-    ratings: :hash
-
+    built_at: :datetime,
+    build_date: :date,
+    tags: :array, # deprecated
+    ratings: :hash # deprecated
+    miles: :decimal
 end
 ```
 
 Now you can interact with the fields stored in the hstore directly.
 
 ```ruby
-p = Product.new
-p.color = "green"
-p.weight = 34
-p.price = 99.95
-p.built_at = Time.now - 10.days
-p.popular = true
-p.tags = ["housewares", "kitchen"]
-p.ratings = { user_a: 3, user_b: 4 }
+product = Product.new
+product.color = "green"
+product.weight = 34
+product.price = 99.95
+product.built_at = Time.now - 10.days
+product.build_date = Date.today
+product.popular = true
+product.tags = %w(housewares kitchen) # deprecated
+product.ratings = { user_a: 3, user_b: 4 } # deprecated
+product.miles = 3.14
 ```
 
 Reading these fields works as well.
 
 ```ruby
-p.color #=> "green"
-p.tags #=> ["housewares", "kitchen"] 
+product.color # => "green"
+product.price  # => 99.95
 ```
 
 In order to reduce the storage overhead of hstore keys (especially when
@@ -82,20 +98,42 @@ Additionally, dirty tracking is implemented in the same way that normal
 `ActiveRecord` fields work.
 
 ```ruby
-p.color           #=> "green"
-p.color = "blue"
-p.changed?        #=> true
-p.color_changed?  #=> true
-p.color_was       #=> "green"
-p.color_changes   #=> ["green", "blue"]
-``` 
+product.color          #=> "green"
+product.color = "blue"
+product.changed?       #=> true
+product.color_changed? #=> true
+product.color_was      #=> "green"
+product.color_change  #=> ["green", "blue"]
+```
+
+## ActiveRecord methods generated for fields
+
+```ruby
+class Product < ActiveRecord::Base
+  hstore_accessor :data, field: :string
+end
+```
+
+* `field`
+* `field=`
+* `field?`
+* `field_changed?`
+* `field_was`
+* `field_change`
+* `reset_field!`
+* `restore_field!`
+* `field_will_change!`
 
-### Scopes
+Overriding methods is supported, with access to the original Hstore Accessor implementation available via `super`.
+
+Additionally, there is also `hstore_metadata_for_<fields>` on both the class and instances. `column_for_attribute` will also return a column object for an Hstore Accessor defined field. If you're using ActiveRecord 4.2, `type_for_attribute` will return a type object for Hstore Accessor defined fields the same as it does for actual columns. 
+
+## Scopes
 
 The `hstore_accessor` macro also creates scopes for `string`, `integer`,
-`float`, `time`, `boolean`, and `array` fields.
+`float`, `decimal`, `time`, `date`, `boolean`, and `array` fields.
 
-#### String Fields
+### String Fields
 
 For `string` types, a `with_<key>` scope is created which checks for
 equality.
@@ -104,21 +142,21 @@ equality.
 Product.with_color("green")
 ```
 
-#### Integer and Float Fields
+### Integer, Float, Decimal Fields
 
-For `integer` and `float` types five scopes are created:
+For `integer`, `float` and `decimal` types five scopes are created:
 
 ```ruby
-Product.price_lt(240.00)    # price less than
-Product.price_lte(240.00)   # price less than or equal to
-Product.price_eq(240.00)    # price equal to
-Product.price_gte(240.00)   # price greater than or equal to
-Product.price_gt(240.00)    # price greater than
+Product.price_lt(240.00)  # price less than
+Product.price_lte(240.00) # price less than or equal to
+Product.price_eq(240.00)  # price equal to
+Product.price_gte(240.00) # price greater than or equal to
+Product.price_gt(240.00)  # price greater than
 ```
 
-#### Time Fields
+### Datetime Fields
 
-For `time` fileds, three scopes are provided:
+For `datetime` fields, three scopes are created:
 
 ```ruby
 Product.built_at_before(Time.now)         # built before the given time
@@ -126,30 +164,42 @@ Product.built_at_eq(Time.now - 10.days)   # built at an exact time
 Product.built_at_after(Time.now - 4.days) # built after the given time
 ```
 
-#### Array Fields
+### Date Fields
+
+For `date` fields, three scopes are created:
+
+```ruby
+Product.build_date_before(Date.today)         # built before the given date
+Product.build_date_eq(Date.today - 10.days)   # built at an exact date
+Product.built_date_after(Date.today - 4.days) # built after the given date
+```
+
+### Array Fields
+
+*Note: the array field type is deprecated. It is available in version 0.9.0 but not > 1.0.0*
 
 For `array` types, two scopes are created:
 
 ```ruby
-Product.tags_eq(["housewares", "kitchen"])        # tags equaling
-Product.tags_contains("kitchen")                  # tags containing a single value
-Product.tags_contains(["housewares", "kitchen"])  # tags containing a number of values
+Product.tags_eq(%w(housewares kitchen))       # tags equaling
+Product.tags_contains("kitchen")              # tags containing a single value
+Product.tags_contains(%w(housewares kitchen)) # tags containing a number of values
 ```
 
-#### Boolean Fields
+### Boolean Fields
 
 Two scopes are created for `boolean` fields:
 
 ```ruby
-Product.is_popular    # => when populer is set to true
-Product.not_popular   # => when populer is set to false
+Product.is_popular  # => when populer is set to true
+Product.not_popular # => when populer is set to false
 ```
 
 Predicate methods are also available on instances:
 
 ```ruby
 product = Product.new(popular: true)
-product.popular?  #=> true
+product.popular? # => true
 ```
 
 ### Single-table Inheritance
@@ -209,11 +259,32 @@ individual fields in an `hstore` column.
 This approach was originally concieved by Joe Hirn in [this blog
 post](http://www.devmynd.com/blog/2013-3-single-table-inheritance-hstore-lovely-combination).
 
+## Upgrading
+Upgrading from version 0.6.0 to 0.9.0 should be fairly painless. If you were previously using a `time` type fields, simply change it to `datetime` like so:
 
-## Contributing
+```ruby
+# Before...
+hstore_accessor :data, published_at: :time
+# After...
+hstore_accessor :data, published_at: :datetime
+```
+
+While the `array` and `hash` types are available in version 0.9.0, they are deprecated and are not available in 1.0.0.
 
-1. Fork it
+## Contributing
+### Basics
+1. [Fork it](https://github.com/devmynd/hstore_accessor/fork) 
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Write code _and_ tests
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+### Developing Locally
+Before you make your pull requests, please make sure you style is in line with our Rubocop settings and that all of the tests pass.
+
+1. `bundle install`
+2. `appraisal install`
+3. Make sure Postgres is installed and running
+4. `appraisal rspec` to run all the tests
+5. `rubocop` to check for style

data/Rakefile

@@ -1,4 +1,10 @@
+require "rubygems"
+require "bundler/setup"
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-task default: :spec
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
 RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
+
+task(default: [:rubocop, :spec])

data/gemfiles/activerecord_4.0.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "4.0.0"
+
+group :test do
+  gem "pg", ">= 0.14.1"
+end
+
+gemspec :path => "../"

data/gemfiles/activerecord_4.1.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "4.1.0"
+
+group :test do
+  gem "pg", ">= 0.14.1"
+end
+
+gemspec :path => "../"

data/gemfiles/activerecord_4.2.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "4.2.0"
+
+group :test do
+  gem "pg", ">= 0.14.1"
+end
+
+gemspec :path => "../"

data/hstore_accessor.gemspec

@@ -6,10 +6,10 @@ require "hstore_accessor/version"
 Gem::Specification.new do |spec|
   spec.name          = "hstore_accessor"
   spec.version       = HstoreAccessor::VERSION
-  spec.authors       = ["Joe Hirn", "Cory Stephenson", "JC Grubbs"]
-  spec.email         = ["joe@devmynd.com", "cory@devmynd.com", "jc@devmynd.com"]
-  spec.description   = %q{Adds typed hstore backed fields to an ActiveRecord model.}
-  spec.summary       = %q{Adds typed hstore backed fields to an ActiveRecord model.}
+  spec.authors       = ["Joe Hirn", "Cory Stephenson", "JC Grubbs", "Tony Coconate", "Michael Crismali"]
+  spec.email         = ["joe@devmynd.com", "cory@devmynd.com", "jc@devmynd.com", "me@tonycoconate.com", "michael@devmynd.com"]
+  spec.description   = "Adds typed hstore backed fields to an ActiveRecord model."
+  spec.summary       = "Adds typed hstore backed fields to an ActiveRecord model."
   spec.homepage      = "http://github.com/devmynd/hstore_accessor"
   spec.license       = "MIT"
 
@@ -18,12 +18,18 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", ">= 3.2.0"
+  spec.add_dependency "activerecord", ">= 4.0.0"
 
-  spec.add_development_dependency "activerecord", ">= 4.0.0"
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "shoulda-matchers"
+
+  spec.post_install_message = "Please note that the `array` and `hash` types will no longer be supported in version 1.0.0"
 end