belongs_to_hstore 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf262a9e10ec75ac8d7e1a153833ef61f07545de
+  data.tar.gz: a3e34610c95272553f3bbb2d7a31a2ed8b46783c
+SHA512:
+  metadata.gz: d2e28a32db4fc0078d5cb99f043768bf76022760ec20b894cfb7de8b9a1679c88679e07ee8c39a6ab956c54b0aaa2e83dedec73ccfe77b21e8639b3160202ec3
+  data.tar.gz: 27e19494aba2c3d9053132154dc2c8ee4899c18f34b98631e290f4d1c37929723c7089ac8c16dfa02b150b3b00efc721212026a30b256f31c4030d29333089fe

data/.gitignore

@@ -0,0 +1,18 @@
+*.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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+belongs_to_hstore

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in belongs_to_hstore.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Evan Lok
+
+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,56 @@
+# BelongsToHstore
+
+Create ActiveRecord belongs_to associations using postgresql hstore columns. Compatible with polymorphic associations
+and supports eager loading.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-postgres-hstore' # Rails 3 only
+    gem 'belongs_to_hstore'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install belongs_to_hstore
+
+## Usage
+
+Create an association using an hstore column:
+```ruby
+class Audit < ActiveRecord::Base
+  belongs_to_hstore :properties, :item
+end
+```
+
+Works for polymorphic associations too:
+```ruby
+class Audit < ActiveRecord::Base
+  serialize :properties, ActiveRecord::Coders::Hstore # Rails 3 only
+
+  belongs_to_hstore :properties, :item, :polymorphic => true
+end
+```
+
+Eager load hstore associations to eliminate N+1 querying:
+```ruby
+Audit.includes(:item).all
+```
+
+Use hstore query helpers to find records:
+```ruby
+Audit.where_properties(:item_id => 123)
+Audit.where_properties(:item_id => [123, 456, 789])
+```
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/belongs_to_hstore.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'belongs_to_hstore/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "belongs_to_hstore"
+  spec.version       = BelongsToHstore::VERSION
+  spec.authors       = ["Evan Lok"]
+  spec.email         = ["elok45@gmail.com"]
+  spec.description   = %q{Allows hstore columns to store belongs_to association foreign keys with the same functionality as the default belongs_to}
+  spec.summary       = %q{Allows hstore columns to store belongs_to associations}
+  spec.homepage      = "https://github.com/evanlok/belongs_to_hstore"
+  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 "activerecord", ">= 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/belongs_to_hstore.rb

@@ -0,0 +1,17 @@
+require 'belongs_to_hstore/version'
+require 'belongs_to_hstore/hstore_query_helper'
+require 'belongs_to_hstore/association'
+
+module BelongsToHstore
+  if defined?(Rails)
+    class Railtie < Rails::Railtie
+      initializer "belongs_to_hstore.active_record" do
+        ActiveSupport.on_load :active_record do
+          ActiveRecord::Base.send :include, BelongsToHstore::Association
+        end
+      end
+    end
+  else
+    ActiveRecord::Base.send :include, BelongsToHstore::Association
+  end
+end

data/lib/belongs_to_hstore/association.rb

@@ -0,0 +1,47 @@
+module BelongsToHstore
+  module Association
+    extend ActiveSupport::Concern
+    include BelongsToHstore::HstoreQueryHelper
+
+    module ClassMethods
+      def belongs_to_hstore(store_attribute, name, options={})
+        @belongs_to_hstore_attributes ||= Set.new
+        key = options[:foreign_key] || "#{name}_id"
+        key_type = key.gsub(/_id$/, '_type')
+        store_accessor store_attribute, key.to_s
+        @belongs_to_hstore_attributes.add(key.to_s)
+
+        if options[:polymorphic]
+          store_accessor store_attribute, key_type
+          @belongs_to_hstore_attributes.add(key_type)
+        end
+        belongs_to name, options
+
+        define_singleton_method("where_#{store_attribute}") do |options|
+          where_hstore(store_attribute, options)
+        end
+      end
+
+      def belongs_to_hstore_attributes
+        attrs = @belongs_to_hstore_attributes || Set.new
+        superclass.respond_to?(:belongs_to_hstore_attributes) ? superclass.belongs_to_hstore_attributes + attrs : attrs
+      end
+    end
+
+    def read_attribute(attr_name)
+      if self.class.belongs_to_hstore_attributes.include?(attr_name.to_s)
+        send(attr_name)
+      else
+        super
+      end
+    end
+
+    def write_attribute(attr_name, attr_value)
+      if self.class.belongs_to_hstore_attributes.include?(attr_name.to_s)
+        send("#{attr_name}=", attr_value.to_s)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/belongs_to_hstore/hstore_query_helper.rb

@@ -0,0 +1,24 @@
+module BelongsToHstore
+  module HstoreQueryHelper
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def where_hstore(hstore_attribute, opts)
+        opts.inject(self) do |scope, opt|
+          if opt[1].is_a?(Array)
+            values = opt[1].map { |val| val.respond_to?(:id) ? val.id.to_s : val.to_s }
+            scope.where("#{table_name}.#{hstore_attribute} -> '#{opt[0]}' IN (?)", values)
+          else
+            if opt[1].nil?
+              value = 'NULL'
+            else
+              value = opt[1].respond_to?(:id) ? opt[1].id : opt[1]
+            end
+
+            scope.where("#{table_name}.#{hstore_attribute} @> '#{opt[0]} => #{value}'")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/belongs_to_hstore/version.rb

@@ -0,0 +1,3 @@
+module BelongsToHstore
+  VERSION = "0.0.1"
+end

data/spec/belongs_to_hstore_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+class Widget < ActiveRecord::Base
+  serialize :properties, Hash
+
+  belongs_to_hstore :properties, :item
+  belongs_to_hstore :properties, :poly_item, :polymorphic => true
+end
+
+class Item < ActiveRecord::Base
+end
+
+describe BelongsToHstore do
+  let(:item) { Item.create }
+  let(:widget) { Widget.new }
+
+  it 'sets properties from object' do
+    widget.item = item
+    widget.item_id.should == item.id.to_s
+    widget.properties['item_id'].should == item.id.to_s
+  end
+
+  it 'returns associated object' do
+    widget = Widget.create(:item => item)
+    widget.reload.item.should == item
+  end
+
+  it 'sets properties from setter method' do
+    widget.item_id = item.id
+    widget.properties['item_id'].should == item.id
+    widget.item.should == item
+  end
+
+  context 'polymorphic' do
+    it 'sets type and id from object' do
+      widget.poly_item = item
+      widget.properties['poly_item_id'].should == item.id.to_s
+      widget.properties['poly_item_type'].should == item.class.to_s
+    end
+
+    it 'returns correct type' do
+      widget = Widget.create(:poly_item => item)
+      widget.reload.poly_item.class.should == item.class
+    end
+  end
+end

data/spec/db/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :widgets do |t|
+    t.string :name
+    t.string :properties
+    t.timestamps
+  end
+
+  create_table :items do |t|
+    t.string :name
+    t.timestamps
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+Dir[File.expand_path("spec/support/**/*.rb")].each { |f| require f }
+require 'belongs_to_hstore'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/active_record.rb

@@ -0,0 +1,4 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+load File.expand_path("spec/db/schema.rb")

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: belongs_to_hstore
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Evan Lok
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Allows hstore columns to store belongs_to association foreign keys with
+  the same functionality as the default belongs_to
+email:
+- elok45@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- belongs_to_hstore.gemspec
+- lib/belongs_to_hstore.rb
+- lib/belongs_to_hstore/association.rb
+- lib/belongs_to_hstore/hstore_query_helper.rb
+- lib/belongs_to_hstore/version.rb
+- spec/belongs_to_hstore_spec.rb
+- spec/db/schema.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+homepage: https://github.com/evanlok/belongs_to_hstore
+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.3
+signing_key: 
+specification_version: 4
+summary: Allows hstore columns to store belongs_to associations
+test_files:
+- spec/belongs_to_hstore_spec.rb
+- spec/db/schema.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb