nested-hstore 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Tom Benner
+
+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,68 @@
+Nested Hstore
+=============
+Store nested hashes and other types in ActiveRecord hstores
+
+Overview
+--------
+
+Postgres hstores offer a number of benefits, but they don't natively support multi-level data. Nested Hstore adds this support to ActiveRecord, letting you treat an hstore like a NoSQL-like document.
+
+[Hstore functions](http://www.postgresql.org/docs/9.1/static/hstore.html) are still supported at the root level.
+
+It also lets you store data types other than hashes in an hstore. All of the following values will be returned verbatim:
+
+```ruby
+# Nested hash
+post.my_hstore = {
+  'title' => 'My Post',
+  'comment_ids' => [34, 67, 82],
+  'user' => {
+    'id' => 15,
+    'username' => 'janedoe',
+  }
+}
+
+# Array
+post.my_hstore = [34, 67, 82]
+
+# Array of nested hashes
+post.my_hstore = [
+  {
+    'id' => 15,
+    'username' => 'janedoe'
+  },
+  {
+    'id' => 16,
+    'username' => 'johndoe'
+  }
+]
+
+# Integer
+post.my_hstore = 43
+
+# Float
+post.my_hstore = 43.1
+
+# String
+post.my_hstore = 'janedoe'
+```
+
+Installation
+------------
+
+Include it in your Gemfile:
+
+    gem 'nested-hstore'
+
+Set up [activerecord-postgres-hstore](https://github.com/diogob/activerecord-postgres-hstore) if you haven't already. Instead of using ActiveRecord::Coders::Hstore, use:
+
+```ruby
+class Post < ActiveRecord::Base
+  serialize :my_store, ActiveRecord::Coders::NestedHstore
+end
+```
+
+License
+-------
+
+Nested Hstore is released under the MIT License. Please see the MIT-LICENSE file for details.

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/lib/active_record/coders/nested_hstore.rb

@@ -0,0 +1,20 @@
+module ActiveRecord
+  module Coders
+    class NestedHstore < Hstore
+      def initialize(default=nil)
+        super(default)
+        @nested_serializer = ::NestedHstore::Serializer.new
+      end
+
+      private
+
+      def to_hstore obj
+        super(@nested_serializer.serialize(obj))
+      end
+
+      def from_hstore hstore
+        @nested_serializer.deserialize(super)
+      end
+    end
+  end
+end

data/lib/nested-hstore.rb

@@ -0,0 +1,8 @@
+# Dependencies
+require 'activerecord-postgres-hstore'
+require 'active_support/all'
+
+# Self
+require 'active_record/coders/nested_hstore'
+require 'nested_hstore/serializer'
+require 'nested_hstore/version'

data/lib/nested_hstore/serializer.rb

@@ -0,0 +1,117 @@
+module NestedHstore
+  class Serializer
+
+    def initialize
+      @type_key = '__TYPE__'
+      @types_map = {
+        array: '__ARRAY__',
+        float: '__FLOAT__',
+        hash: '__HASH__',
+        integer: '__INTEGER__',
+        string: '__STRING__'
+      }
+      @types_map_inverted = @types_map.invert
+      @value_key = '__VALUE__'
+    end
+
+    def serialize(value)
+      return nil if value.nil?
+      if value.is_a?(Array)
+        type = :array
+        hash = array_to_hash(value)
+      elsif value.is_a?(Float)
+        type = :float
+        hash = { @value_key => value }
+      elsif value.is_a?(Hash)
+        type = :hash
+        hash = standardize_value(value)
+      elsif value.is_a?(Integer)
+        type = :integer
+        hash = { @value_key => value }
+      elsif value.is_a?(String)
+        type = :string
+        hash = { @value_key => value }
+      else
+        raise "Unsupported hstore type: #{value.class}"
+      end
+      hash_to_hstore(type, hash)
+    end
+
+    def deserialize(hash)
+      return nil if hash.nil?
+      raise 'Hstore value should be a hash' unless hash.is_a?(Hash)
+      type_value = hash.delete(@type_key)
+      type = @types_map_inverted[type_value]
+      deserialized = case type
+        when :array
+          hash.values.map { |v| decode_json_if_json(v) }
+        when :float
+          hash[@value_key].to_f
+        when :hash
+          hash.each do |k, v|
+            hash[k] = decode_json_if_json(v)
+          end
+          hash
+        when :integer
+          hash[@value_key].to_i
+        when :string
+          hash[@value_key]
+      end
+      deserialized
+    end
+
+    private
+
+    def hash_to_hstore(type, hash)
+      return {} if type == :hash && hash.blank?
+      
+      hstore = hash.dup
+      hstore.each do |k, v|
+        if v.is_a?(Array) || v.is_a?(Hash)
+          hstore[k] = encode_json(v)
+        else
+          hstore[k] = v.to_s
+        end
+      end
+      hstore.merge(@type_key => @types_map[type])
+    end
+
+    def standardize_value(value)
+      if value.is_a?(Array)
+        value.map! do |v|
+          standardize_value(v)
+        end
+      elsif value.is_a?(Hash)
+        value.each do |k, v|
+          value[k] = standardize_value(v)
+        end
+      # Standardize Times to an ISO string, as that's what DateTime#to_s evaluates to
+      elsif value.is_a?(Time) || value.is_a?(ActiveSupport::TimeWithZone)
+        value = value.iso8601
+      end
+      value
+    end
+
+    def array_to_hash(array)
+      hash = {}
+      array.each_with_index do |value, index|
+        hash[index.to_s] = standardize_value(value)
+      end
+      hash
+    end
+
+    # This isn't ideal: how do we know whether each value in an hstore is JSON or a
+    # string/integer/etc?
+    def decode_json_if_json(value)
+      begin
+        ActiveSupport::JSON.decode(value)
+      rescue
+        value
+      end
+    end
+
+    def encode_json(value)
+      ActiveSupport::JSON.encode(value)
+    end
+  end
+end

data/lib/nested_hstore/version.rb

@@ -0,0 +1,3 @@
+module NestedHstore
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: nested-hstore
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tom Benner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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-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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: Store nested hashes and other types in ActiveRecord hstores
+email:
+- tombenner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_record/coders/nested_hstore.rb
+- lib/nested-hstore.rb
+- lib/nested_hstore/serializer.rb
+- lib/nested_hstore/version.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/tombenner/nested-hstore
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Store nested hashes and other types in ActiveRecord hstores
+test_files: []