statham 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b874caa4c2b43695d5b4df17ba6afe935cea0b2
+  data.tar.gz: f021b56b8ec690530247373a3a549c785b2fdab3
+SHA512:
+  metadata.gz: f2be195a49962c4d8ca0e40e3e124802d568900ca2f87e20619cf77719cbdc16741a6c68ad4f72765f5a993f7f5d196bfbd4c4003a5daaabed10537b13649bd3
+  data.tar.gz: 82b4bac5b759c7ff0db07cb1508d212102b9aba218a86c4ac335db95e0d036bfb98c902d07b27526f689cb819af9a31484b7d1a4501f1140885ecf0899267866

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 statham.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Inbeom Hwang
+
+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,58 @@
+# Statham
+
+Do serialization like boss.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'statham'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Mix in `Statham::Document` in models you want:
+
+    class Post < ActiveRecord::Base
+      include Statham::Document
+    end
+
+Do migration:
+
+    change_table :post do |t|
+      t.text :metadata
+    end
+
+Define schema for serialization:
+
+    class Post < ActiveRecord::Base
+      include Statham::Document
+
+      statham :metadata do |json|
+        json.attribute :transporter, type: :string, default: 'frank'
+        json.attribute :italian_job, type: :integer
+        json.attribute :the_expandables, type: :boolean
+      end
+    end
+
+That's it.
+
+The attributes defined in the JSON behaves like regular attributes. Thus You can
+use them on forms and views:
+
+    <%= form_for @post do |f| %>
+      <%= f.checkbox :the_expandables %>
+      <%= f.input :transporter %>
+      <%= f.input :italian_job %>
+    <% end %>
+
+## 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/lib/statham/attribute.rb

@@ -0,0 +1,61 @@
+module Statham
+  # Internal: Attributes serialized inside JSON.
+  class Attribute
+    # Internal: Type of the attribute.
+    attr_accessor :type
+    # Internal: Default value for the attribute.
+    attr_accessor :default
+
+    # Internal: Initialize the attribute.
+    #
+    # options - The hash options used for defining new attributes:
+    #           type    - Type of the attribute.
+    #           default - Default value for the attribute.
+    #
+    # Returns new Statham::Attribute object.
+    def initialize(options = {})
+      @type = options[:type]
+      @default = options[:default]
+    end
+
+    # Internal: Serializes value to be JSON-compatible.
+    #
+    # value - Value to serialize.
+    #
+    # Returns serialized value.
+    def serialize(value)
+      serialized = value.nil? ? nil : casted_to_type(value)
+
+      serialized.nil? && !@default.nil? ? @default : serialized
+    end
+
+    # Internal: Deserializes JSON-compatible value to native one.
+    #
+    # value - Value to deserialize.
+    #
+    # Returns deserialized value.
+    def deserialize(value)
+      deserialized = value.nil? ? nil : casted_to_type(value)
+
+      deserialized.nil? && !@default.nil? ? @default : deserialized
+    end
+
+    protected
+
+    # Internal: Casts value to type defined for the attribute.
+    #
+    # value - Value to cast type.
+    #
+    # Returns value with type casted.
+    def casted_to_type(value)
+      case @type
+      when :boolean
+        ActiveRecord::ConnectionAdapters::Column.value_to_boolean(value)
+      when :integer
+        value.to_i
+      else
+        value.to_s
+      end
+    end
+  end
+end

data/lib/statham/attribute_set.rb

@@ -0,0 +1,47 @@
+module Statham
+  # Public: Collection of definition of child attributes inside JSON.
+  class AttributeSet
+    # Public: Name of the parent JSON attribute.
+    attr_reader :name
+    # Public: AttributeSet defined in the parent class of the owner of the
+    # AttributeSet.
+    attr_reader :parent
+
+    # Internal: Initialize an AttributeSet.
+    #
+    # options - The hash options used to define AttributeSets:
+    #           :name - Name of the parent attribute.
+    #
+    # Returns new AttributeSet.
+    def initialize(options = {})
+      @name = options[:name]
+      @parent = options[:parent]
+      @attributes = {}
+    end
+
+    # Public: Define an attribute serialized inside JSON.
+    #
+    # name    - Name of the attribute.
+    # options - The hash options used to define new attribute:
+    #           :type    - Type of the attribute.
+    #           :default - Default value for the attribute.
+    #
+    # Returns nothing.
+    def attribute(name, options = {})
+      @attributes[name] = Statham::Attribute.new(options)
+    end
+
+    # Public: Collection of attributes definition. If parent AttributeSet
+    # exists, it merges attributes on the AttributeSet with attributes of
+    # parent.
+    #
+    # Returns Hash collection of attributes.
+    def attributes
+      if @parent
+        @attributes.reverse_merge @parent.attributes
+      else
+        @attributes
+      end
+    end
+  end
+end

data/lib/statham/document.rb

@@ -0,0 +1,92 @@
+module Statham
+  # Public: Mixin for ActiveRecord models which enables defining attributes
+  # serialized into a JSON attribute.
+  #
+  # Examples
+  #
+  #   class Foo < ActiveRecord::Base
+  #     include Statham::Document
+  #
+  #     statham :metdata do |json|
+  #       json.attribute :foo, type: :integer
+  #       json.attribute :bar
+  #     end
+  #   end
+  #
+  # Each attribute is given name and options including type and default value.
+  module Document
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Public: Initializes and creates JSON attribute with specified name
+      # containing defined child attributes.
+      #
+      # column_name - Symbol object containing name of parent JSON column.
+      # block       - Required block containing definitions for child
+      #               attributes.
+      #
+      # Returns Statham::AttributeSet object for newly defined parent JSON.
+      def statham(column_name, &block)
+        parent = parent_statham_attribute_set_for(column_name)
+        attribute_set = statham_attribute_sets[column_name] ||= Statham::AttributeSet.new(name: column_name, parent: parent)
+
+        yield attribute_set if block_given?
+
+        apply_statham_attribute_set(attribute_set)
+      end
+
+      # Internal: Collection of JSON attributes used as parent attributes for a
+      # class.
+      #
+      # Returns hash object for the collection.
+      def statham_attribute_sets
+        statham_attribute_sets_collection[self] ||= {}
+      end
+
+      # Internal: Collection of statham_attribute_sets for related classes.
+      #
+      # Returns hash object for the collection.
+      def statham_attribute_sets_collection
+        @@attribute_sets_collection ||= {}
+      end
+
+      # Internal: Find AttributeSets defined in parent classes and return the
+      # nearest AttributeSet if it exists.
+      #
+      # column_name - Name of the column to find.
+      #
+      # Returns AttributeSet with parent set.
+      def parent_statham_attribute_set_for(column_name)
+        parent = statham_attribute_sets_collection.inject({}) do |parents, (klass, attribute_sets)|
+          if klass > self && parent_attribute_set = attribute_sets[column_name]
+            parents.merge(klass => parent_attribute_set)
+          else
+            parents
+          end
+        end.sort.first
+
+        parent && parent.last
+      end
+
+      # Internal: Define required getter/setter methods for child attributes
+      # in JSON and set up ActiveRecord serialization with the set.
+      #
+      # set - AttributeSet object to apply.
+      #
+      # Returns attributes in AttributeSet object.
+      def apply_statham_attribute_set(attribute_set)
+        serialize attribute_set.name, Statham::Serializer.new(attribute_set)
+
+        attribute_set.attributes.each do |name, attribute|
+          define_method(name) do
+            attribute.deserialize(send(attribute_set.name)[name])
+          end
+
+          define_method("#{name}=") do |value|
+            send(attribute_set.name)[name] = attribute.serialize(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/statham/serializer.rb

@@ -0,0 +1,59 @@
+module Statham
+  # Internal: Serializes/deserializes collection of attributes into/from JSON.
+  class Serializer
+    # Internal: Initializes Serializer.
+    #
+    # attribute_set - AttributeSet object for definition of the attributes.
+    #
+    # Returns new Serializer object.
+    def initialize(attribute_set)
+      @attribute_set = attribute_set
+    end
+
+    # Internal: Serializes object.
+    #
+    # object - Object to serialize.
+    #
+    # Returns JSON string for the object.
+    def dump(object)
+      ActiveSupport::JSON.encode(serialize_with_attributes(object))
+    end
+
+    # Internal: Deserializes JSON string into object.
+    #
+    # json - JSON string to deserialize.
+    #
+    # Returns Hash object deserialized from the JSON.
+    def load(json)
+      object = json ? ActiveSupport::HashWithIndifferentAccess.new(ActiveSupport::JSON.decode(json)) : Hash.new
+
+      deserialize_with_attributes(object)
+    end
+
+    protected
+
+    # Internal: Serialize values in specified hash object using options used to
+    # define attributes.
+    #
+    # object - Object to serialize.
+    #
+    # Returns Hash containing serialized values.
+    def serialize_with_attributes(object)
+      @attribute_set.attributes.inject(object) do |serialized, (name, attribute)|
+        serialized.merge name => attribute.serialize(object[name])
+      end
+    end
+
+    # Internal: Deserialize values in specified hash object using options used
+    # to define attributes.
+    #
+    # object - Object to deserialize.
+    #
+    # Returns Hash containing deserialized values.
+    def deserialize_with_attributes(object)
+      @attribute_set.attributes.inject(object) do |serialized, (name, attribute)|
+        serialized.merge name => attribute.deserialize(object[name])
+      end
+    end
+  end
+end

data/lib/statham/version.rb

@@ -0,0 +1,3 @@
+module Statham
+  VERSION = '0.1.1'
+end

data/lib/statham.rb

@@ -0,0 +1,8 @@
+require 'active_support'
+require 'active_support/hash_with_indifferent_access'
+
+require 'statham/version'
+require 'statham/document'
+require 'statham/attribute'
+require 'statham/attribute_set'
+require 'statham/serializer'

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+
+require 'bundler/setup'
+require 'active_record'
+require 'statham'

data/spec/support/active_record.rb

@@ -0,0 +1,5 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+ActiveRecord::Migration.verbose = false
+require File.join(File.dirname(__FILE__), 'schema')

data/spec/support/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define(version: 20131213121829) do
+  create_table "attributes_test_model", force: true do |t|
+    t.text     "foo"
+  end
+end

data/spec/unit/attribute_set_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Statham::AttributeSet do
+  describe '#attribute' do
+    let(:attribute_set) { Statham::AttributeSet.new }
+
+    it { expect { attribute_set.attribute(:foo) }.to change { attribute_set.attributes } }
+  end
+end

data/spec/unit/attribute_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Statham::Attribute do
+  describe '#serialize' do
+    context 'when type is boolean' do
+      let(:attribute) { Statham::Attribute.new(type: :boolean) }
+
+      it { expect(attribute.serialize(nil)).to be_nil }
+      it { expect(attribute.serialize(true)).to be_true }
+      it { expect(attribute.serialize(false)).to be_false }
+      it { expect(attribute.serialize('1')).to be_true }
+      it { expect(attribute.serialize('0')).to be_false }
+    end
+
+    context 'when default value is set' do
+      let(:default) { 'hello' }
+      let(:value) { 'world' }
+      let(:attribute) { Statham::Attribute.new(default: default) }
+
+      it { expect(attribute.serialize(nil)).to eq(default) }
+      it { expect(attribute.serialize(value)).to eq(value) }
+    end
+  end
+end

data/spec/unit/document_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+class AttributesTestModel < ActiveRecord::Base
+  include Statham::Document
+
+  statham :foo do |json|
+    json.attribute :bar
+  end
+end
+
+class ChildTestModel < AttributesTestModel
+  statham :foo do |json|
+    json.attribute :baz
+  end
+end
+
+class ChildChildTestModel < ChildTestModel
+  statham :foo do |json|
+    json.attribute :qux
+  end
+end
+
+describe Statham::Document do
+  describe '.statham_attribute_sets' do
+    it { expect(AttributesTestModel.statham_attribute_sets).to be_a(Hash) }
+    it { expect(AttributesTestModel.statham_attribute_sets.keys).to eq([:foo]) }
+    it { expect(ChildTestModel.statham_attribute_sets).to be_a(Hash) }
+    it { expect(ChildTestModel.statham_attribute_sets.keys).to eq([:foo]) }
+  end
+
+  describe '.parent_statham_attribute_set_for' do
+    it { expect(ChildTestModel.parent_statham_attribute_set_for(:foo)).to eq(AttributesTestModel.statham_attribute_sets[:foo]) }
+    it { expect(ChildChildTestModel.parent_statham_attribute_set_for(:foo)).to eq(ChildTestModel.statham_attribute_sets[:foo]) }
+  end
+end

data/spec/unit/serializer_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Statham::Serializer do
+  let(:attribute_set) { Statham::AttributeSet.new(name: :foobar) }
+
+  describe '#dump' do
+    let(:statham_column) { Statham::Serializer.new(attribute_set) }
+    let(:object) { { foo: 'bar' } }
+
+    it { expect(statham_column.dump(object)).to eq('{"foo":"bar"}') }
+    it { expect(ActiveSupport::JSON.decode(statham_column.dump(object))).to eq({ 'foo' => 'bar' }) }
+
+    context 'when attribute_set has attributes' do
+      let(:baz_default) { 'bazbaz' }
+
+      before do
+        attribute_set.attribute :baz, default: baz_default
+      end
+
+      it { expect(ActiveSupport::JSON.decode(statham_column.dump(object))).to eq({ 'foo' => 'bar', 'baz' => baz_default }) }
+    end
+  end
+
+  describe '#load' do
+    let(:statham_column) { Statham::Serializer.new(attribute_set) }
+    let(:object_json) { ActiveSupport::JSON.encode({ foo: 'bar' }) }
+
+    it { expect(statham_column.load(object_json)).to eq({ 'foo' => 'bar' }) }
+    it { expect(statham_column.load(object_json)[:foo]).to eq('bar') }
+  end
+end

data/statham.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'statham/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'statham'
+  spec.version       = Statham::VERSION
+  spec.authors       = ['Inbeom Hwang']
+  spec.email         = ['hwanginbeom@gmail.com']
+  spec.description   = %q{Manage JSON object in string typed attributes for ActiveRecord models}
+  spec.summary       = %q{JSON objects for attributes}
+  spec.homepage      = ''
+  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_dependency 'activerecord'
+
+  spec.add_development_dependency 'bundler', "~> 1.3"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: statham
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Inbeom Hwang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-16 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: activerecord
+  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'
+- !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: Manage JSON object in string typed attributes for ActiveRecord models
+email:
+- hwanginbeom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/statham.rb
+- lib/statham/attribute.rb
+- lib/statham/attribute_set.rb
+- lib/statham/document.rb
+- lib/statham/serializer.rb
+- lib/statham/version.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/support/schema.rb
+- spec/unit/attribute_set_spec.rb
+- spec/unit/attribute_spec.rb
+- spec/unit/document_spec.rb
+- spec/unit/serializer_spec.rb
+- statham.gemspec
+homepage: ''
+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.6
+signing_key: 
+specification_version: 4
+summary: JSON objects for attributes
+test_files:
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/support/schema.rb
+- spec/unit/attribute_set_spec.rb
+- spec/unit/attribute_spec.rb
+- spec/unit/document_spec.rb
+- spec/unit/serializer_spec.rb
+has_rdoc: