hstore_accessor 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b556f080454175cefffda39846659bbc7eb676ea
-  data.tar.gz: c3b7cecfc960a65db15944e4f8579d941f59a708
+  metadata.gz: ed6227f16f31ca2c856584b8e72ae0fb9065f659
+  data.tar.gz: f08a8c2cdf12a47e7ed620289fdbf9fa1677e46b
 SHA512:
-  metadata.gz: a96e5670fc7ff405146da7f0560bb67af29738ffbae2c209db60d6231cdea90624f8b61c2d8936d88d3c8688a7229ebbd07f6169b9e9816a8583e2a44c066a72
-  data.tar.gz: fde2a6addc657fe910ff609c087e90673855a88de590256481c36c3a69a797ae2dbc563b8dbf0afa2af259efb2fe53689e4336fedb86d5ed44240e911d2e3299
+  metadata.gz: 9617209ac08dd3fbc9a48fdd56866396bb3098e127f66e51c9182f09f565f21f2e9cd084917c9e31f3b60c0e99aec11b312f70d1213df4e80f995d41479267db
+  data.tar.gz: fd258525d2f42d3fc42604d000b1302938459d5ad3d65c5d994c11a3209932b0c9181a4058c4144bcbb54c14fcdd3d45aeadd9431655ad3d6a4cf94b4f020819

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+logfile

data/README.md

@@ -27,7 +27,7 @@ Or install it yourself as:
 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`, `array`, and `hash`.
+are: `string`, `integer`, `float`, `time`, `boolean`, `array`, and `hash`.
 
 ```ruby
 class Product < ActiveRecord::Base
@@ -51,6 +51,7 @@ 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 }
 ```
@@ -58,14 +59,14 @@ p.ratings = { user_a: 3, user_b: 4 }
 Reading these fields works as well.
 
 ```ruby
-p.color #=> "green
+p.color #=> "green"
 p.tags #=> ["housewares", "kitchen"] 
 ```
 
 ### Scopes
 
 The `hstore_accessor` macro also creates scopes for `string`, `integer`,
-`float`, `time`, and `array` fields.
+`float`, `time`, `boolean`, and `array` fields.
 
 #### String Fields
 
@@ -108,6 +109,15 @@ Product.tags_contains("kitchen")                  # tags containing a single val
 Product.tags_contains(["housewares", "kitchen"])  # tags containing a number of values
 ```
 
+#### 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
+```
+
 ### Single-table Inheritance
 
 One of the big issues with `ActiveRecord` single-table inheritance (STI)
@@ -165,6 +175,7 @@ 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).
 
+
 ## Contributing
 
 1. Fork it

data/lib/hstore_accessor.rb

@@ -6,7 +6,7 @@ module HstoreAccessor
 
   InvalidDataTypeError = Class.new(StandardError)
 
-  VALID_TYPES = [:string, :integer, :float, :time, :array, :hash]
+  VALID_TYPES = [:string, :integer, :float, :time, :boolean, :array, :hash]
 
   SEPARATOR = ";|;"
 
@@ -14,17 +14,19 @@ module HstoreAccessor
   DEFAULT_DESERIALIZER = ->(value) { value.to_s }
 
   SERIALIZERS = {
-    :array => ->(value) { value.join(SEPARATOR) },
-    :hash => ->(value) { value.to_json },
-    :time => ->(value) { value.to_i }
+    :array    => -> value { (value && value.join(SEPARATOR)) || "" },
+    :hash     => -> value { (value && value.to_json) || {} },
+    :time     => -> value { value.to_i },
+    :boolean  => -> value { (value == true).to_s }
   }
 
   DESERIALIZERS = {
-    :array => ->(value) { value.split(SEPARATOR) },
-    :hash => ->(value) { JSON.parse(value) },
-    :integer => ->(value) { value.to_i },
-    :float => ->(value) { value.to_f },
-    :time => ->(value) { Time.at(value.to_i) }
+    :array    => -> value { (value && value.split(SEPARATOR)) || [] },
+    :hash     => -> value { JSON.parse(value) },
+    :integer  => -> value { value.to_i },
+    :float    => -> value { value.to_f },
+    :time     => -> value { Time.at(value.to_i) },
+    :boolean  => -> value { value == "true" }
   }
 
   def self.included(base)
@@ -59,23 +61,28 @@ module HstoreAccessor
           deserialize(type, value)
         end
 
+        query_field = "#{hstore_attribute} -> '#{key}'"
+
         case type
         when :string
-          send(:scope, "with_#{key}", -> value { where("#{hstore_attribute} -> '#{key}' = ?", value.to_s) })
+          send(:scope, "with_#{key}", -> value { where("#{query_field} = ?", value.to_s) })
         when :integer, :float
-          send(:scope, "#{key}_lt",  -> value { where("#{hstore_attribute} -> '#{key}' < ?", value.to_s) })
-          send(:scope, "#{key}_lte", -> value { where("#{hstore_attribute} -> '#{key}' <= ?", value.to_s) })
-          send(:scope, "#{key}_eq",  -> value { where("#{hstore_attribute} -> '#{key}' = ?", value.to_s) })
-          send(:scope, "#{key}_gte", -> value { where("#{hstore_attribute} -> '#{key}' >= ?", value.to_s) })
-          send(:scope, "#{key}_gt",  -> value { where("#{hstore_attribute} -> '#{key}' > ?", value.to_s) })
+          send(:scope, "#{key}_lt",  -> value { where("(#{query_field})::#{type} < ?", value.to_s) })
+          send(:scope, "#{key}_lte", -> value { where("(#{query_field})::#{type} <= ?", value.to_s) })
+          send(:scope, "#{key}_eq",  -> value { where("(#{query_field})::#{type} = ?", value.to_s) })
+          send(:scope, "#{key}_gte", -> value { where("(#{query_field})::#{type} >= ?", value.to_s) })
+          send(:scope, "#{key}_gt",  -> value { where("(#{query_field})::#{type} > ?", value.to_s) })
         when :time
-          send(:scope, "#{key}_before", -> value { where("to_number(#{hstore_attribute} -> '#{key}', '99999999999') < ?", value.to_i) })
-          send(:scope, "#{key}_eq",     -> value { where("to_number(#{hstore_attribute} -> '#{key}', '99999999999') = ?", value.to_i) })
-          send(:scope, "#{key}_after",  -> value { where("to_number(#{hstore_attribute} -> '#{key}', '99999999999') > ?", value.to_i) })
+          send(:scope, "#{key}_before", -> value { where("(#{query_field})::integer < ?", value.to_i) })
+          send(:scope, "#{key}_eq",     -> value { where("(#{query_field})::integer = ?", value.to_i) })
+          send(:scope, "#{key}_after",  -> value { where("(#{query_field})::integer > ?", value.to_i) })
+        when :boolean
+          send(:scope, "is_#{key}", -> { where("#{query_field} = 'true'") })
+          send(:scope, "not_#{key}", -> { where("#{query_field} = 'false'") })
         when :array
-          send(:scope, "#{key}_eq",        -> value { where("#{hstore_attribute} -> '#{key}' = ?", value.join(SEPARATOR)) })
+          send(:scope, "#{key}_eq",        -> value { where("#{query_field} = ?", value.join(SEPARATOR)) })
           send(:scope, "#{key}_contains",  -> value do
-            where("string_to_array(#{hstore_attribute} -> '#{key}', '#{SEPARATOR}') @> string_to_array(?, '#{SEPARATOR}')", Array[value].flatten)
+            where("string_to_array(#{query_field}, '#{SEPARATOR}') @> string_to_array(?, '#{SEPARATOR}')", Array[value].flatten)
           end)
         end
       end

data/lib/hstore_accessor/version.rb

@@ -1,3 +1,3 @@
 module HstoreAccessor
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/hstore_accessor_spec.rb

@@ -6,9 +6,10 @@ class Product < ActiveRecord::Base
     color: :string,
     price: :integer,
     weight: :float,
+    popular: :boolean,
+    build_timestamp: :time,
     tags: :array,
-    reviews: :hash,
-    build_timestamp: :time
+    reviews: :hash
 end
 
 describe HstoreAccessor do
@@ -43,9 +44,9 @@ describe HstoreAccessor do
   describe "scopes" do
 
     let!(:timestamp) { Time.now }
-    let!(:product_a) { Product.create(color: "green",  price: 10, weight: 10.1, tags: ["tag1", "tag2", "tag3"], build_timestamp: (timestamp - 10.days)) }
-    let!(:product_b) { Product.create(color: "orange", price: 20, weight: 20.2, tags: ["tag2", "tag3", "tag4"], build_timestamp: (timestamp - 5.days)) }
-    let!(:product_c) { Product.create(color: "blue",   price: 30, weight: 30.3, tags: ["tag3", "tag4", "tag5"], build_timestamp: timestamp) }
+    let!(:product_a) { Product.create(color: "green",  price: 10, weight: 10.1, tags: ["tag1", "tag2", "tag3"], popular: true,  build_timestamp: (timestamp - 10.days)) }
+    let!(:product_b) { Product.create(color: "orange", price: 20, weight: 20.2, tags: ["tag2", "tag3", "tag4"], popular: false, build_timestamp: (timestamp - 5.days)) }
+    let!(:product_c) { Product.create(color: "blue",   price: 30, weight: 30.3, tags: ["tag3", "tag4", "tag5"], popular: true,  build_timestamp: timestamp) }
 
     context "for string fields support" do
 
@@ -132,6 +133,18 @@ describe HstoreAccessor do
 
     end
 
+    context "for boolean field support" do
+
+      it "true" do
+        expect(Product.is_popular).to eq [product_a, product_c]
+      end
+
+      it "false" do
+        expect(Product.not_popular).to eq [product_b]
+      end
+
+    end
+
   end
 
   context "when assigning values it" do
@@ -166,6 +179,13 @@ describe HstoreAccessor do
       expect(product.tags).to eq ["household", "living room", "kitchen"]
     end
 
+    it "returns an empty array if an array value is not set" do
+      product.tags = nil
+      product.save
+      product.reload
+      expect(product.tags).to eq []
+    end
+
     it "correctly stores hash values" do
       product.reviews = { "user_123" => "4 stars", "user_994" => "3 stars" }
       product.save
@@ -173,6 +193,13 @@ describe HstoreAccessor do
       expect(product.reviews).to eq({ "user_123" => "4 stars", "user_994" => "3 stars" })
     end
 
+    it "returns an empty hash if a hash value is not set" do
+      product.reviews = nil
+      product.save
+      product.reload
+      expect(product.reviews).to eq({})
+    end
+
     it "correctly stores time values" do
       timestamp = Time.now - 10.days
       product.build_timestamp = timestamp

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hstore_accessor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Joe Hirn
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-11 00:00:00.000000000 Z
+date: 2013-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg