hstore_accessor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f427874b1399b9aadd39910014acf1374ed8665f
+  data.tar.gz: 6801a29b56e216ffb63de7ce1484ee76c20ba7b3
+SHA512:
+  metadata.gz: 8702aed6b3f57de15f2175da5e50cbfabe60373b41492ff034196224f08494dc6763ac96d9cca7d21c51d6a1e56a2580d5e96803d675a6f10d59ce2f938bc3b4
+  data.tar.gz: 977817e66627297cb37f84f901644db7a2a2d5ecb995864eb68da7d24ebeba8d7fb6db6c87b0309936538eb2ed1ca92f84b5785474fc216dff8b63b4096bcbd8

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 JC Grubbs
+
+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,42 @@
+# HstoreAccessor
+
+PostgreSQL provides an hstore data type for storing arbitrarily complex
+structures in a column.  ActiveRecord 4.0 supports Hstore but casts all
+valus 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hstore_accessor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hstore_accessor
+
+## Usage
+
+```ruby
+class Product < ActiveRecord::Base
+
+  hstore_accessor :options,
+    color: :string,
+    weight: :integer,
+    
+
+end
+```
+
+## Contributing
+
+1. Fork it
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hstore_accessor.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.homepage      = "http://github.com/devmynd/hstore_accessor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pg", ">= 0.14.1"
+  spec.add_dependency "activesupport", ">= 3.2.0"
+  
+  spec.add_development_dependency "activerecord", ">= 4.0.0.rc1"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/hstore_accessor/version.rb

@@ -0,0 +1,3 @@
+module HstoreAccessor
+  VERSION = "0.1.0"
+end

data/lib/hstore_accessor.rb

@@ -0,0 +1,85 @@
+require "hstore_accessor/version"
+require "active_support"
+require "active_record"
+
+module HstoreAccessor
+
+  InvalidDataTypeError = Class.new(StandardError)
+
+  VALID_TYPES = [:string, :integer, :float, :array, :hash]
+
+  SEPARATOR = ";|;"
+
+  DEFAULT_SERIALIZER = ->(val) { val.to_s }
+  DEFAULT_DESERIALIZER = ->(val) { val.to_s }
+
+  SERIALIZERS = {
+    :array => ->(val) { val.join(SEPARATOR) },
+    :hash => ->(val) { val.to_json }
+  }
+
+  DESERIALIZERS = {
+    :array => ->(val) { val.split(SEPARATOR) },
+    :hash => ->(val) { JSON.parse(val) },
+    :integer => ->(val) { val.to_i },
+    :float => ->(val) { val.to_f }
+  }
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def serialize(type, value, serializer=nil)
+    serializer ||= (SERIALIZERS[type] || DEFAULT_SERIALIZER)
+    serializer.call(value)
+  end
+
+  def deserialize(type, value, deserializer=nil)
+    deserializer ||= (DESERIALIZERS[type] || DEFAULT_DESERIALIZER)
+    deserializer.call(value)
+  end
+
+  module ClassMethods
+
+    def hstore_accessor(hstore_attribute, fields)
+
+      fields.each do |key, type|
+
+        raise InvalidDataTypeError unless VALID_TYPES.include?(type)
+
+        define_method("#{key}=") do |value|
+          send("#{hstore_attribute}=", (send(hstore_attribute) || {}).merge(key.to_s => serialize(type, value)))
+          send("#{hstore_attribute}_will_change!")
+        end
+
+        define_method(key) do
+          value = send(hstore_attribute) && send(hstore_attribute)[key.to_s]
+          deserialize(type, value)
+        end
+
+        case type
+        when :string
+          send(:scope, "with_#{key}", -> value { where("#{hstore_attribute} -> '#{key}' = ?", 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)})
+        when :array
+          send(:scope, "#{key}_eq",        -> value { where("#{hstore_attribute} -> '#{key}' = ?", value.join(SEPARATOR))})
+          send(:scope, "#{key}_contains",  -> value do
+            where("string_to_array(#{hstore_attribute} -> '#{key}', '#{SEPARATOR}') @> string_to_array(?, '#{SEPARATOR}')", Array[value].flatten)
+          end)
+        end
+      end
+
+    end
+
+  end
+
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.send(:include, HstoreAccessor)
+end

data/spec/hstore_accessor_spec.rb

@@ -0,0 +1,165 @@
+require "spec_helper"
+require "active_support/all"
+
+class Product < ActiveRecord::Base
+  hstore_accessor :options,
+    color: :string,
+    price: :integer,
+    weight: :float,
+    tags: :array,
+    reviews: :hash
+end
+
+describe HstoreAccessor do
+
+  context "macro" do
+
+    let(:product) { Product.new }
+
+    it "creates getters for the hstore fields" do
+      [:color, :price, :weight, :tags, :reviews].each do |field|
+        expect(product).to respond_to(field)
+      end
+    end
+
+    it "creates setters for the hstore fields" do
+      [:color, :price, :weight, :tags, :reviews].each do |field|
+        expect(product).to respond_to(:"#{field}=")
+      end
+    end
+
+    it "raises an InvalidDataTypeError if an invalid type is specified" do
+      expect do
+        class FakeModel
+          include HstoreAccessor
+          hstore_accessor :foo, bar: :baz
+        end
+      end.to raise_error(HstoreAccessor::InvalidDataTypeError)
+    end
+
+  end
+
+  describe "scopes" do
+
+    let!(:product_a) { Product.create(color: "green",  price: 10, weight: 10.1, tags: ["tag1", "tag2", "tag3"]) }
+    let!(:product_b) { Product.create(color: "orange", price: 20, weight: 20.2, tags: ["tag2", "tag3", "tag4"]) }
+    let!(:product_c) { Product.create(color: "blue",   price: 30, weight: 30.3, tags: ["tag3", "tag4", "tag5"]) }
+
+    context "for string fields support" do
+
+      it "equality" do
+        expect(Product.with_color("orange").to_a).to eq [product_b]
+      end
+
+    end
+
+    context "for integer fields support" do
+
+      it "less than" do
+        expect(Product.price_lt(20).to_a).to eq [product_a]
+      end
+
+      it "less than or equal" do
+        expect(Product.price_lte(20).to_a).to eq [product_a, product_b]
+      end
+
+      it "equality" do
+        expect(Product.price_eq(10).to_a).to eq [product_a]
+      end
+
+      it "greater than or equal" do
+        expect(Product.price_gte(20).to_a).to eq [product_b, product_c]
+      end
+
+      it "greater than" do
+        expect(Product.price_gt(20).to_a).to eq [product_c]
+      end
+
+    end
+
+    context "for float fields" do
+
+      it "less than" do
+        expect(Product.weight_lt(20.0).to_a).to eq [product_a]
+      end
+
+      it "less than or equal" do
+        expect(Product.weight_lte(20.2).to_a).to eq [product_a, product_b]
+      end
+
+      it "equality" do
+        expect(Product.weight_eq(10.1).to_a).to eq [product_a]
+      end
+
+      it "greater than or equal" do
+        expect(Product.weight_gte(20.2).to_a).to eq [product_b, product_c]
+      end
+
+      it "greater than" do
+        expect(Product.weight_gt(20.5).to_a).to eq [product_c]
+      end
+
+    end
+
+    context "for array fields" do
+
+      it "equality" do
+        expect(Product.tags_eq(["tag1", "tag2", "tag3"]).to_a).to eq [product_a]
+      end
+
+      it "contains" do
+        expect(Product.tags_contains("tag2").to_a).to eq [product_a, product_b]
+        expect(Product.tags_contains(["tag2", "tag3"]).to_a).to eq [product_a, product_b]
+      end
+
+    end 
+
+  end
+
+  context "when assigning values it" do
+
+    let(:product) { Product.new }
+
+    it "correctly stores string values" do
+      product.color = "blue"
+      product.save
+      product.reload
+      expect(product.color).to eq "blue"
+    end
+
+    it "correctly stores integer values" do
+      product.price = 468
+      product.save
+      product.reload
+      expect(product.price).to eq 468
+    end
+
+    it "correctly stores float values" do
+      product.weight = 93.45
+      product.save
+      product.reload
+      expect(product.weight).to eq 93.45
+    end
+
+    it "correctly stores array values" do
+      product.tags = ["household", "living room", "kitchen"]
+      product.save
+      product.reload
+      expect(product.tags).to eq ["household", "living room", "kitchen"]
+    end
+
+    it "correctly stores hash values" do
+      product.reviews = { "user_123" => "4 stars", "user_994" => "3 stars" }
+      product.save
+      product.reload
+      expect(product.reviews).to eq({ "user_123" => "4 stars", "user_994" => "3 stars" })
+    end
+
+    it "setters call the _will_change! method of the store attribute" do
+      product.should_receive(:options_will_change!)
+      product.color = "green"
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require "hstore_accessor"
+
+ActiveRecord::Base.establish_connection(
+  adapter: "postgresql",
+  database: "hstore_accessor",
+  username: "root"
+)
+
+ActiveRecord::Base.connection.execute("CREATE EXTENSION hstore;") rescue PG::Error
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS products;")
+
+ActiveRecord::Base.connection.create_table(:products) do |t|
+  t.hstore :options
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.after do
+    Product.delete_all
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: hstore_accessor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Hirn
+- Cory Stephenson
+- JC Grubbs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds typed hstore backed fields to an ActiveRecord model.
+email:
+- joe@devmynd.com
+- cory@devmynd.com
+- jc@devmynd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hstore_accessor.gemspec
+- lib/hstore_accessor.rb
+- lib/hstore_accessor/version.rb
+- spec/hstore_accessor_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/devmynd/hstore_accessor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Adds typed hstore backed fields to an ActiveRecord model.
+test_files:
+- spec/hstore_accessor_spec.rb
+- spec/spec_helper.rb