hstore_attributes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 396066b7fdc41c0c1039d85ebad2b42e5d04355b
+  data.tar.gz: eb91ce7217c92ef41ff6f953304da15d9143d31e
+SHA512:
+  metadata.gz: 159f4b7ce845ba685475e02bf293422bc985cbcfc8a9da3655f6a5c74180d64114879cebaedb82c1381d0b92d0190feb3aaa2709623a141411de7df05dcae4df
+  data.tar.gz: b2bea8c6b9b38134e8d416ec5e1ce096738ee19989fe30aeb9385c170657951cc2fd24019c53893e793870dba450db9ff6f35dffd8934c233d845202ac5af862

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hstore_attributes.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kuba Kuźma
+
+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,31 @@
+# HstoreAttributes
+
+Provides methods like `hstore_reader` or `hstore_writer` for accessing
+your Hstore data like any other attributes. It also gives you a
+possibility to typecast the value.
+
+## Usage
+
+    class Product < ActiveRecord::Base
+      extend HstoreAttributes
+
+      # The hstore column is named 'data'
+      hstore_accessor :data, :description
+      hstore_accessor :data, :price, :tax, type_cast: :to_i
+      hstore_accessor :data, :available_from, type_cast: ->(value) { value.to_s.to_date }
+    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
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end
+
+task :default => :test

data/hstore_attributes.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hstore_attributes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hstore_attributes"
+  spec.version       = HstoreAttributes::VERSION
+  spec.authors       = ["Kuba Kuźma"]
+  spec.email         = ["kuba@jah.pl"]
+  spec.description   = %q{Provides methods like hstore_reader or hstore_writer for accessing your Hstore data like any other attributes.}
+  spec.summary       = %q{Easy accessors for Hstore data.}
+  spec.homepage      = "https://github.com/qoobaa/hstore_attributes"
+  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 "activesupport"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/hstore_attributes/version.rb

@@ -0,0 +1,3 @@
+module HstoreAttributes
+  VERSION = "1.0.0"
+end

data/lib/hstore_attributes.rb

@@ -0,0 +1,29 @@
+require "hstore_attributes/version"
+
+module HstoreAttributes
+  def hstore_reader(hstore, *symbols)
+    options = symbols.extract_options!
+    symbols.each do |symbol|
+      define_method(symbol) do
+        value = (send(hstore) || {})[symbol.to_s]
+        value = options[:type_cast].to_proc.call(value) if options[:type_cast]
+        value
+      end
+    end
+  end
+
+  def hstore_writer(hstore, *symbols)
+    options = symbols.extract_options!
+    symbols.each do |symbol|
+      define_method("#{symbol}=") do |value|
+        value = options[:type_cast].to_proc.call(value) if options[:type_cast]
+        send("#{hstore}=", (send(hstore) || {}).merge(symbol.to_s => value.to_s))
+      end
+    end
+  end
+
+  def hstore_accessor(hstore, *symbols)
+    hstore_reader(hstore, *symbols)
+    hstore_writer(hstore, *symbols)
+  end
+end

data/test/hstore_accessor_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+
+class Product < DummyModel
+  extend HstoreAttributes
+
+  hstore_accessor :data, :name, :description, type_cast: ->(value) { value.to_s.upcase }
+end
+
+describe "hstore_writer" do
+  def setup
+    @product = Product.new
+  end
+
+  it "sets and gets name properly" do
+    @product.name = "zomg"
+    assert_equal "ZOMG", @product.name
+  end
+
+  it "sets and gets description properly" do
+    @product.description = "trolololo"
+    assert_equal "TROLOLOLO", @product.description
+  end
+end

data/test/hstore_reader_test.rb

@@ -0,0 +1,70 @@
+require "test_helper"
+
+class Product < DummyModel
+  extend HstoreAttributes
+
+  hstore_reader :data, :price, :price_2, type_cast: :to_i
+  hstore_reader :data, :name, type_cast: ->(value) { value.to_s.upcase }
+  hstore_reader :data, :description
+
+  def data
+    @data
+  end
+
+  def data=(data)
+    @data = data
+  end
+end
+
+describe "hstore_reader" do
+  def setup
+    @product = Product.new
+  end
+
+  it "returns price 0 if no hstore" do
+    assert_equal 0, @product.price
+  end
+
+  it "returns price 0 if no price in hstore" do
+    @product.data = {}
+    assert_equal 0, @product.price
+  end
+
+  it "returns price if already in hstore" do
+    @product.data = {"price" => "100"}
+    assert_equal 100, @product.price
+  end
+
+  it "returns price_2 if already in hstore" do
+    @product.data = {"price" => 100, "price_2" => "500"}
+    assert_equal 500, @product.price_2
+  end
+
+  it "returns description nil if no hstore" do
+    assert_equal nil, @product.description
+  end
+
+  it "returns description nil if description in hstore" do
+    @product.data = {}
+    assert_equal nil, @product.description
+  end
+
+  it "returns description if already in hstore" do
+    @product.data = {"description" => "zomg"}
+    assert_equal "zomg", @product.description
+  end
+
+  it "returns empty name if no hstore" do
+    assert_equal "", @product.name
+  end
+
+  it "returns empty name if name in hstore" do
+    @product.data = {}
+    assert_equal "", @product.name
+  end
+
+  it "returns upcased name if already in hstore" do
+    @product.data = {"name" => "zomg"}
+    assert_equal "ZOMG", @product.name
+  end
+end

data/test/hstore_writer_test.rb

@@ -0,0 +1,51 @@
+require "test_helper"
+
+class Product < DummyModel
+  extend HstoreAttributes
+
+  hstore_writer :data, :name, :name_2
+  hstore_writer :data, :price, type_cast: :to_i
+  hstore_writer :data, :cents, type_cast: ->(value) { (value.to_f * 100).to_i }
+end
+
+describe "hstore_writer" do
+  def setup
+    @product = Product.new
+  end
+
+  it "sets name if no hstore" do
+    @product.name = "zomg"
+    assert_equal({"name" => "zomg"}, @product.data)
+  end
+
+  it "sets name if empty hstore" do
+    hstore = {}
+    @product.data = hstore
+    @product.name = "zomg"
+    assert_equal({"name" => "zomg"}, @product.data)
+    refute_same hstore, @product.data
+  end
+
+  it "sets name if already in hstore" do
+    hstore = {"name" => "trolololo"}
+    @product.data = hstore
+    @product.name = "zomg"
+    assert_equal({"name" => "zomg"}, @product.data)
+    refute_same hstore, @product.data
+  end
+
+  it "sets name_2 if no hstore" do
+    @product.name_2 = "lolo"
+    assert_equal({"name_2" => "lolo"}, @product.data)
+  end
+
+  it "sets price if no hstore" do
+    @product.price = 0
+    assert_equal({"price" => "0"}, @product.data)
+  end
+
+  it "sets cents using type_cast function" do
+    @product.cents = "1"
+    assert_equal({"cents" => "100"}, @product.data)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require "minitest/autorun"
+require "active_support"
+require "hstore_attributes"
+
+# DummyModel emulates an ActiveRecord model with hstore "data"
+
+class DummyModel
+  def data
+    @data
+  end
+
+  def data=(data)
+    @data = data
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: hstore_attributes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kuba Kuźma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: Provides methods like hstore_reader or hstore_writer for accessing your
+  Hstore data like any other attributes.
+email:
+- kuba@jah.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hstore_attributes.gemspec
+- lib/hstore_attributes.rb
+- lib/hstore_attributes/version.rb
+- test/hstore_accessor_test.rb
+- test/hstore_reader_test.rb
+- test/hstore_writer_test.rb
+- test/test_helper.rb
+homepage: https://github.com/qoobaa/hstore_attributes
+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.0
+signing_key: 
+specification_version: 4
+summary: Easy accessors for Hstore data.
+test_files:
+- test/hstore_accessor_test.rb
+- test/hstore_reader_test.rb
+- test/hstore_writer_test.rb
+- test/test_helper.rb