hstore-attributes 0.0.2

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
+config.yml

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hstore-attributes.gemspec
+gemspec
+
+gem 'activerecord'
+gem 'activerecord-postgres-hstore'
+gem 'rake'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Christoph Sassenberg
+
+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,47 @@
+# HstoreAttributes
+
+HstoreAttributes is a small extension on top of `activerecord-postgres-hstore`, which creates "fake" attributes that map into the hstore hash. By defining these attributes you get automatic validations and type casting.
+The approach is very similar to the `ActiveRecord::Store` feature, yielding better query and index performance in comparison to simple hash-to-yml-string usage.
+
+
+A small example:
+
+    class Product < ActiveRecord::Base
+      # hstore column is named 'properties'
+      hstore :properties, :accessors => { :width => :integer, :height => :integer, :color => :string }
+      
+      # if you want to dump strings only:
+      hstore :properties, :accessors => [:color, :other_property, :third_property]
+      
+      validates_numericality_of :weight
+      
+      #  ...
+    end
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hstore-attributes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hstore-attributes
+
+## Usage
+
+Usage should be pretty straightforward as shown in the example. Be sure to create a hstore column that takes the mapped attributes. Please note that this works for postgresql databses only.
+
+See: https://github.com/softa/activerecord-postgres-hstore
+
+## 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,22 @@
+#!/usr/bin/env rake
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList[File.expand_path('../test/**/*_test.rb', __FILE__)]
+  t.verbose = true
+end
+
+require 'bundler/gem_tasks'

data/config.yml.example

@@ -0,0 +1,4 @@
+# adapter is set to postgresql anyway, as this is a pg only feature.
+database: hstore_test
+user: postgres
+password:

data/hstore-attributes.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.authors       = ["Christoph Sassenberg"]
+  gem.email         = ["christoph.sassenberg@googlemail.com"]
+  gem.description   = %q{ActiveRecord meta attributes that are mapped to a single (or multiple) hstore columns in postgres}
+  gem.summary       = %q{ActiveRecord meta attributes that are mapped to a single (or multiple) hstore columns in postgres}
+  gem.homepage      = "http://github.com/defsprite/hstore-attributes"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "hstore-attributes"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.2"
+  
+  gem.add_dependency('pg')
+  gem.add_dependency('activerecord', '>= 3.0')
+  gem.add_dependency('activerecord-postgres-hstore')
+  
+end

data/lib/hstore-attributes.rb

@@ -0,0 +1,6 @@
+require "active_support"
+
+ActiveSupport.on_load :active_record do
+  require "hstore-attributes/hstore_columns"
+  require "hstore-attributes/activerecord"
+end

data/lib/hstore-attributes/activerecord.rb

@@ -0,0 +1,8 @@
+# Extends AR to add meta-columns for easy Hstore usage.
+module ActiveRecord
+
+  class Base
+    include HstoreColumns
+
+  end
+end

data/lib/hstore-attributes/hstore_columns.rb

@@ -0,0 +1,43 @@
+require 'active_support/concern'
+
+module HstoreColumns
+  extend ActiveSupport::Concern
+
+
+  def read_hstore(key, hstore_column)
+    new_value = send(hstore_column) || {}
+    new_value.fetch(key.to_s, nil)
+  end
+
+  def write_hstore(key, value, hstore_column)
+    new_value = send(hstore_column) || {}
+    new_value.store(key.to_s, value)
+    send("#{hstore_column}=", new_value)
+    send("#{hstore_column}_will_change!")
+  end
+
+
+  module ClassMethods
+
+    def hstore_accessor(hstore_column, attr_name, type = :string)
+      column                      = ActiveRecord::ConnectionAdapters::Column.new(attr_name, nil, "#{type}")
+      columns_hash[attr_name.to_s]= column
+      cast_code                   = column.type_cast_code('v')
+      access_code                 = "(v=read_hstore('#{attr_name}', '#{hstore_column}')) && #{cast_code}"
+
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{attr_name}; #{access_code}; end
+            def #{attr_name}= value; write_hstore('#{attr_name}', value, '#{hstore_column}'); end
+      RUBY
+    end
+
+    def hstore(store_attribute, options = {})
+      accessors = options[:accessors]
+      accessors.each do |key, value|
+        hstore_accessor store_attribute, key, value.nil? ? :string : value
+      end
+    end
+
+  end
+
+end

data/test/hstore_test.rb

@@ -0,0 +1,114 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class HstoreModel < ActiveRecord::Base
+  hstore :data, accessors: {:color => :string, :homepage => :string, :available_on => :date}
+  hstore :data, accessors: [:other_color, :other_homepage]
+
+  hstore :data, accessors: {:string_test => :string, :date_test => :date, :datetime_test => :datetime, :integer_test => :integer}
+
+end
+
+class HstoreTest < MiniTest::Unit::TestCase
+
+  def setup
+    @connection = ActiveRecord::Base.connection
+    puts @connection.native_database_types
+
+    begin
+      @connection.execute 'drop table if exists hstore_models'
+      @connection.transaction do
+        @connection.create_table('hstore_models') do |t|
+          t.string :name
+          t.hstore :data, :default => ''
+        end
+      end
+
+    rescue ActiveRecord::StatementInvalid => e
+      skip "ActiveRecord::StatementInvalid during table setup. Is your DB hstore capable at all? Error was: #{e}"
+    rescue NoMethodError => e
+      skip "NoMethodError during table setup. Is your DB hstore capable at all? Error was: #{e}"
+    end
+  end
+
+  def teardown
+    @connection.execute 'drop table if exists hstore_models'
+  end
+
+  describe "the hstore attribute mapper" do
+
+    before do
+      @record = HstoreModel.create(:name => 'John Doe')
+    end
+
+    after do
+      HstoreModel.delete_all
+    end
+
+    it "should have the right column type" do
+      column = HstoreModel.columns.find { |c| c.name == 'data' }
+      assert_equal :hstore, column.type
+    end
+
+    it "should read attributes through accessors" do
+      assert_equal 'John Doe', @record.name
+      assert_nil @record.string_test
+      assert_nil @record.date_test
+      assert_nil @record.datetime_test
+      assert_nil @record.integer_test
+    end
+
+    it "should write attributes through accessors" do
+      datetime = Time.parse(Time.now.to_s) # why? see http://blog.kyleshipley.com/post/9415090497/a-ruby-time-idiosyncrasy
+      date     = datetime.to_date
+
+      @record.string_test   = 'red'
+      @record.integer_test  = 42
+      @record.date_test     = date
+      @record.datetime_test = datetime
+
+      assert_equal 'red', @record.string_test
+      assert_equal 42, @record.integer_test
+      assert_equal datetime, @record.datetime_test
+      assert_equal date, @record.date_test
+
+    end
+
+    it "should restore old types after persisting" do
+      datetime = Time.parse(Time.now.to_s)
+      date     = datetime.to_date
+
+      @record.string_test   = 'red'
+      @record.integer_test  = 42
+      @record.date_test     = date
+      @record.datetime_test = datetime
+
+      @record.save
+      @record.reload
+
+      assert_equal 'red', @record.string_test
+      assert_equal 42, @record.integer_test
+      assert_equal datetime, @record.datetime_test
+      assert_equal date, @record.date_test
+    end
+
+    it "should write hstore data directly" do
+
+      @record.data = {'icecream' => 'graeters'}
+      @record.save
+      assert_equal({'icecream' => 'graeters'}, @record.reload.data)
+    end
+
+
+    it "should update the store and mark it as changed" do
+      @record.string_test = 'blue'
+      assert @record.data_changed?
+    end
+
+    it "should assign data assigned via new or create" do
+      @record = HstoreModel.new(:string_test => "Dame Edna")
+      assert_equal "Dame Edna", @record.string_test
+    end
+
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+require 'active_record'
+
+ActiveSupport.on_load :active_record do
+  require 'active_record/connection_adapters/postgresql_adapter'
+  require "activerecord-postgres-hstore/activerecord"
+end
+
+require 'activerecord-postgres-hstore/hash'
+require 'activerecord-postgres-hstore/string'
+
+require 'minitest/autorun'
+require File.expand_path('../lib/hstore-attributes', File.dirname(__FILE__))
+
+require 'yaml'
+ActiveRecord::Base.establish_connection(YAML::load(File.open(File.expand_path('../config.yml', File.dirname(__FILE__)))))

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: hstore-attributes
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Christoph Sassenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-postgres-hstore
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecord meta attributes that are mapped to a single (or multiple)
+  hstore columns in postgres
+email:
+- christoph.sassenberg@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config.yml.example
+- hstore-attributes.gemspec
+- lib/hstore-attributes.rb
+- lib/hstore-attributes/activerecord.rb
+- lib/hstore-attributes/hstore_columns.rb
+- test/hstore_test.rb
+- test/test_helper.rb
+homepage: http://github.com/defsprite/hstore-attributes
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1370101062646711657
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1370101062646711657
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: ActiveRecord meta attributes that are mapped to a single (or multiple) hstore
+  columns in postgres
+test_files:
+- test/hstore_test.rb
+- test/test_helper.rb