store_complex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7dd6dd5f9bad33c4202a6da557a89a36e836d97a
+  data.tar.gz: 90fcf9af2d65ac867c0aaa2c6de0fedd15644b6f
+SHA512:
+  metadata.gz: 5250ee091d440fd8b308949b7d40f10e1c3e4cbb862924c5063d7e91238ce45d209c2b213b9f4f2e875e1ed10ffd396da3b97d5bf80b1a4315c9668475c6739b
+  data.tar.gz: 46ad2e8d03bb125f52883a0fba0ff4dcf66603a5685800415a969138b8fdc860db5c2fe12ed86592ebda1338e6f44304dc6a19443da537040729bd445750557f

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.env
+.rspec
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+**/.DS_Store

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.1.2
+
+branches:
+  only:
+    - master
+
+script: bundle exec rake spec
+
+before_install:
+  - gem update --system
+  - gem --version

data/CONTRIBUTORS.md

@@ -0,0 +1 @@
+* Andrey Pronin <moonfly.msk@gmail.com> aka moonfly (https://github.com/moonfly)

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2014 [CONTRIBUTORS.md](https://github.com/moonfly/store_complex/master/CONTRIBUTORS.md)
+
+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,178 @@
+# StoreComplex
+
+Stores complex data that includes Arrays and Hashes (possibly nested) in an attribute inside hstore field. The most typical usage scenario is storing arrays in hstore, but it can handle more complex cases. 
+
+[![Build Status](https://travis-ci.org/moonfly/store_complex.svg?branch=master)](https://travis-ci.org/moonfly/store_complex)
+[![Coverage Status](https://img.shields.io/coveralls/moonfly/store_complex.svg)](https://coveralls.io/r/moonfly/store_complex?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'store_complex'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install store_complex
+
+## Usage
+
+### Reminder: What Rails already has
+
+ActiveRecord in Rails 4 already provides methods for dealing with individual attributes inside [PostgresSQL hstore and json](http://www.postgresql.org/docs/9.3/static/hstore.html) fields.
+
+Let's consider an example. There is a database table (and a corresponding ActiveRecord model) that describes some blog authors.
+Among other data, it has an hstore field called `properties` that captures various optional bits of information about an author: 
+email, facebook account, personal blog address, etc.
+
+In Rails 4 you can get convenient access to the individual attributes inside `properties` using [`store_accessor`](http://api.rubyonrails.org/classes/ActiveRecord/Store.html):
+
+```ruby
+class Author < ActiveRecord::Base
+  store_accessor :properties, :email, :facebook, :blog
+end
+
+author = Author.new(name:'Uber Guru')
+author.properties                       # => nil
+author.email = 'somebody@example.org'   # will store this email in properties
+author.properties                       # => {"email"=>"somebody@example.org"}
+
+author.save!
+
+author = Author.find_by_name('Uber Guru')
+author.properties                       # => {"email"=>"somebody@example.org"}
+author.email                            # => 'somebody@example.org'
+```
+
+But what if we want to let tha authors specify more than a single email. OK, simple, the `email` property will now be an array. Not, so fast...
+
+```ruby
+author = Author.new(name:'Uber Guru')
+author.properties                       # => nil
+author.email = ['somebody@example.org','somebody@example.com']
+author.properties                       # => {"email"=>["somebody@example.org", "somebody@example.com"]} 
+
+author.save!
+
+author = Author.find_by_name('Uber Guru')
+author.properties                       # => {"email"=>"[\"somebody@example.org\", \"somebody@example.com\"]"}
+author.email                            # => "[\"somebody@example.org\", \"somebody@example.com\"]"
+# Oh-oh! :(
+```
+
+And instead of an array we got back a string representation of that array.
+
+So, can we do something about it? Yes, meet `store_complex`...
+
+### How to use `store_complex`
+
+In your model, use `store_complex` in place of `store_accessor`. That's it!
+
+```ruby
+class Author < ActiveRecord::Base
+  store_complex :properties, :email
+end
+
+author = Author.new(name:'Uber Guru')
+author.properties                       # => nil
+author.email = ['somebody@example.org','somebody@example.com']
+author.properties                       # => {"email"=>["somebody@example.org", "somebody@example.com"]} 
+
+author.save!
+
+author = Author.find_by_name('Uber Guru')
+author.properties                       # => {"email"=>"[\"somebody@example.org\", \"somebody@example.com\"]"}
+author.email                            # => ["somebody@example.org","somebody@example.com"]
+# Success! :)
+```
+
+
+### What `store_complex` does
+
+`store_complex` allows to store arrays and hashes in hstore attributes. Those arrays and hashes can contain as their values or keys (for hashes):
+
+- strings, numbers, booleans, nils - will be stored 'as is';
+- other arrays and hashes - yes, nesting is possible;
+- symbols - will be converted to strings;
+- other data types if they can be converted to strings using `String(value)` - and yes, they **will** be converted to strings.
+
+One important note: If you store something but array or hash, it will be wrapped into an array. `store_complex` is not for simple data types, use 'store_accessor' for that. The only exception is `nil`, which deletes the attribute from hstore. And if there is no attribute in hstore, the `store_complex` accessor will return an empty array: `[]`.
+
+Example:
+
+```ruby
+class Author < ActiveRecord::Base
+  store_complex :properties, :email
+end
+
+author = Author.new(name:'Uber Guru')
+
+author.properties                       # => nil
+author.email                            # => []
+
+author.email = 'somebody@example.org'   #
+author.email                            # => ["somebody@example.org"]
+
+author.email = nil                      #
+author.email                            # => []
+```
+
+Another awesome feature of `store_complex` is that it tracks not only assignments to the "complex" attribute, but also all operations on the hash or array (inlcuding those nested within!) that change the object (all those `sort!` and `delete` calls). Thanks to [observable_object gem](https://github.com/moonfly/observable_object) (and me as its author ;-) ) for that awesome behavior. 
+
+To get you excited, here is an example below:
+
+```ruby
+class Author < ActiveRecord::Base
+  store_complex :properties, :email
+end
+
+author = Author.new(name:'Uber Guru')
+
+author.properties                             # => nil
+author.email                                  # => []
+
+author.email = { 
+  "somebody@example.org" => "personal", 
+  "somebody@example.com" => "work", 
+  "somebody@business.nowhere" => "work"
+}
+
+author.email.delete_if { |k,v| v == 'work' }  # delete all work emails
+
+author.save!
+
+author = Author.find_by_name('Uber Guru')
+author.email                                  # => {"somebody@example.org"=>"personal"} 
+# Perfect!
+```
+
+## Versioning
+
+Semantic versioning (http://semver.org/spec/v2.0.0.html) is used. 
+
+For a version number MAJOR.MINOR.PATCH, unless MAJOR is 0:
+
+1. MAJOR version is incremented when incompatible API changes are made,
+2. MINOR version is incremented when functionality is added in a backwards-compatible manner, 
+3. PATCH version is incremented when backwards-compatible bug fixes are made.
+
+Major version "zero" (0.y.z) is for initial development. Anything may change at any time. 
+The public API should not be considered stable. 
+
+## Dependencies
+
+- Ruby >= 2.1
+- Rails >= 4.0
+- observable_object
+
+## Contributing
+
+1. Fork it ( https://github.com/moonfly/store_complex/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc "Run RSpec tests (use rake spec SPEC_OPTS='...' to pass rspec options)"
+RSpec::Core::RakeTask.new(:spec)

data/lib/store_complex/version.rb

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

data/lib/store_complex.rb

@@ -0,0 +1,35 @@
+require 'store_complex/version'
+require 'observable_object'
+require 'json'
+
+module StoreComplex
+  def self.obj_to_store(value)
+    return nil if value.nil?
+    JSON.generate(value.is_a?(Hash) ? value : Array(value))
+  end
+  def self.store_to_obj(value)
+    return [] if value.nil?
+    JSON.parse(value)
+  end
+  
+  module Accessor
+    def store_complex(store_name,*attr_names)
+      attr_names.each do |name|
+        attr_set = name.to_s+'='
+        
+        define_method(name) do
+          value = (self.send(store_name) || {})[name.to_s]
+          ObservableObject::deep_wrap( StoreComplex::store_to_obj(value) ) { |obj| self.send(attr_set, obj) }
+        end
+        
+        define_method(attr_set) do |value|
+          store = self.send(store_name) || {}
+          store[name.to_s] = StoreComplex::obj_to_store(value)
+          self.send(store_name.to_s+'=',store)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord.extend StoreComplex::Accessor

data/store_complex.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'store_complex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'store_complex'
+  spec.version       = StoreComplex::VERSION
+  spec.authors       = ['moonfly (Andrey Pronin)']
+  spec.email         = ['moonfly.msk@gmail.com']
+  spec.summary       = %q{Store complex data (arrays, hashes) in hstore attributes}
+  spec.description   = <<-EOF
+  Stores complex data that includes Arrays and Hashes (possibly nested) in an attribute inside hstore field. 
+  The most typical usage scenario is storing arrays in hstore, but it can handle more complex cases.
+  EOF
+  spec.homepage      = 'https://github.com/moonfly/store_complex'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.rdoc_options = ['--charset=UTF-8']
+  spec.extra_rdoc_files = %w[README.md CONTRIBUTORS.md LICENSE.md]
+  
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_dependency 'rails', '>= 4.0'
+  spec.add_dependency 'observable_object'
+
+  spec.add_development_dependency 'bundler', '>= 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'dotenv'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: store_complex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- moonfly (Andrey Pronin)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: observable_object
+  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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: dotenv
+  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: "  Stores complex data that includes Arrays and Hashes (possibly nested)
+  in an attribute inside hstore field. \n  The most typical usage scenario is storing
+  arrays in hstore, but it can handle more complex cases.\n"
+email:
+- moonfly.msk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CONTRIBUTORS.md
+- LICENSE.md
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTORS.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/store_complex.rb
+- lib/store_complex/version.rb
+- store_complex.gemspec
+homepage: https://github.com/moonfly/store_complex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Store complex data (arrays, hashes) in hstore attributes
+test_files: []