embeds_many 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df5b6c590bea371b92b51fcc0d997179a9a31f79
+  data.tar.gz: 822d11065876bd3721db8ff8d5ea42161eab83da
+SHA512:
+  metadata.gz: edb630f9cec39da2062f0fe599074357d0427a071f8e489cf0a07ecadad47d52cf84f4f35d606f5a365a62f5f27efbb502dc833d1e3fee017169b76c8204529d
+  data.tar.gz: f026f9f1796fa051ddd02f2d42afec6f8b37a9e47568b7de09fab2910b0b51f230e744c92d78602b3701fd09c9ee0f3faa99ccc2ae0bf995c18be9167c15aa02

data/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+/doc
+/.yardoc
+/Gemfile.lock
+spec/*.log
+*.swp
+*.bak
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1.1
+
+script: "bundle exec rake spec"
+
+before_script:
+  - psql -c 'create database embeds_many_test;' -U postgres
+  - psql embeds_many_test -c 'create extension hstore;' -U postgres
+
+addons:
+  postgresql: '9.3'

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Notion Labs
+
+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.markdown

@@ -0,0 +1,106 @@
+EmbedsMany
+==============
+
+[![Build Status](https://travis-ci.org/NotionLabs/embeds_many.svg)](https://travis-ci.org/NotionLabs/embeds_many)
+
+EmbedsMany allows programmers to work with embedded records the same way as activerecord objects, with the power of PostgreSQL's hstore and array.
+
+**NOTE**: EmbedsMany only works with Rails/ActiveRecord `4.0.4` or above. To use EmbedsMany, you must use PostgreSQL.
+
+## Usage
+
+### Installation
+
+To use the gem, add following to your Gemfile:
+
+``` ruby
+gem 'embeds_many'
+```
+
+### Setup Database
+
+You need a `hstor array` column to hold the embedded records.
+
+When creating a new table, use following:
+
+```ruby
+  create_table "users", force: true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.hstore   "tags",       default: [], array: true
+  end
+```
+
+When adding a column to existing table, use following:
+
+```ruby
+add_column :users, :tags, :hstore, array: true, default: []
+```
+
+### Setup Model
+
+```ruby
+class User < ActiveRecord::Base
+  # many embedded tags
+  embeds_many :tags
+
+  # validation tags
+  embedded :tags do
+    embedded_fields :name, :color
+
+    validates :name, uniqueness: true, presence: true
+    validates :color, presence: true
+
+    def as_json
+      {
+        id: id,
+        name: name,
+        color: color
+      }
+    end
+  end
+end
+```
+
+### Work with embedded tags
+
+```ruby
+# create new tag
+@tag = user.tags.new(tag_params)
+unless @tag.save
+  render json: { success: false, message: @tag.errors.full_messages.join('. ') }
+end
+
+# update
+@tag = user.tags.find(params['id'])
+
+if @tag.update(tag_params)
+  # do something
+end
+
+# destroy
+@tag = user.tags.find(params['id'])
+
+@tag.destroy
+```
+
+## Development
+
+All pull requests are welcome.
+
+### Setup development environment
+
+1. Run `bundle install`
+2. Run `rake db:create` to create database
+3. Run `rake spec` to run specs
+
+### Development Guide
+
+- Follow established and good convention
+- Write code and specs
+- Send pull request
+
+## License
+
+Copyright (c) 2014 Notion Labs, released under the MIT license

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+namespace :db do
+  task :create_user do
+    `createuser -s -r postgres`
+  end
+
+  task :create do
+    `psql -c 'create database embeds_many_test;' -U postgres`
+    `psql embeds_many_test -c 'create extension hstore;' -U postgres`
+  end
+
+  task :drop do
+    `dropdb 'embeds_many_test'`
+  end
+end

data/embeds_many.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "embeds_many/version"
+
+Gem::Specification.new do |s|
+  s.name        = "embeds_many"
+  s.version     = EmbedsMany::VERSION
+  s.authors     = ["liufengyun"]
+  s.email       = ["liufengyunchina@gmail.com"]
+  s.homepage    = "https://github.com/notionlabs/embeds_many"
+  s.summary     = %q{Embedded records based on the power of PostgreSQL's hstore and array}
+  s.description = %q{EmbedsMany allows programmers to work with embedded records the same way as activerecord objects}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('activerecord','>= 4.0.4')
+
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('database_cleaner')
+  s.add_development_dependency('pg')
+  s.add_development_dependency('rake')
+end

data/lib/embeds_many.rb

@@ -0,0 +1,9 @@
+require "active_record"
+require "active_model"
+
+require "embeds_many/version"
+require "embeds_many/base"
+require "embeds_many/child"
+require "embeds_many/child_collection"
+
+ActiveRecord::Base.extend(EmbedsMany::Base)

data/lib/embeds_many/base.rb

@@ -0,0 +1,20 @@
+module EmbedsMany
+  module Base
+    def embeds_many(field)
+      child_klass = instance_variable_set "@#{field}_klass", EmbedsMany::Child.clone
+      child_klass.instance_variable_set "@field_name", field
+
+      # rewrite association
+      define_method field do
+        instance_variable_get("@#{field}_collection") ||
+          instance_variable_set("@#{field}_collection", ChildrenCollection.new(self, field, child_klass))
+      end
+    end
+
+    # define validations and helper instance methods
+    def embedded(field, &block)
+      child_klass = instance_variable_get "@#{field}_klass"
+      child_klass.class_eval(&block)
+    end
+  end
+end

data/lib/embeds_many/child.rb

@@ -0,0 +1,131 @@
+module EmbedsMany
+  class Child
+    extend ActiveModel::Validations::ClassMethods
+    include ActiveModel::Dirty
+    include ActiveModel::Validations
+
+    # add accessors for fields
+    def self.embedded_fields(*fields)
+      fields.each do |field_name|
+        define_method(field_name) do
+          @attributes[field_name]
+        end
+
+        define_method("#{field_name}=") do |val|
+          @attributes[field_name] = val
+        end
+      end
+    end
+
+    attr_accessor :parent
+    embedded_fields :id
+
+    class UniquenessValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        if record.exists_in_parent? {|item| item.key?(attribute.to_s) && item[attribute.to_s] == value && record.id.to_s != item['id'] }
+          record.errors.add attribute, "#{value} is already taken"
+        end
+      end
+    end
+
+    # validation requires model name
+    def self.model_name
+      ActiveModel::Name.new(self, nil, @field_name.to_s.classify)
+    end
+
+    def initialize(attrs)
+      @attributes = ActiveSupport::HashWithIndifferentAccess.new
+
+      attrs.each do |name, value|
+        if respond_to? "#{name}="
+          send("#{name}=", value)
+        else
+          @attributes[name] = value
+        end
+      end
+    end
+
+    def save
+      return false unless self.valid?
+
+      if new_record?
+        save_new_record!
+      else
+        save_existing_record!
+      end
+    end
+
+    def destroy
+      # tell rails the field will change
+      parent.send "#{field_name}_will_change!"
+
+      parent.read_attribute(field_name).delete_if {|t| t['id'] == self.id}
+
+      if parent.save
+        true
+      else
+        parent.send "#{field_name}=", parent.send("#{field_name}_was")
+        false
+      end
+    end
+
+    def update(attrs)
+      @attributes.update(attrs)
+
+      save
+    end
+
+    def new_record?
+      self.id.nil?
+    end
+
+    def exists_in_parent?(&block)
+      parent.read_attribute(field_name).any? &block
+    end
+
+    private
+
+    def save_new_record!
+      @attributes[:id] = generate_id!
+
+      # tell rails the field will change
+      parent.send "#{field_name}_will_change!"
+
+      parent.read_attribute(field_name) << @attributes.to_hash
+
+      if parent.save
+        true
+      else
+        @attributes.id = nil
+        # restore old value
+        parent.send "#{field_name}=", parent.send("#{field_name}_was")
+        false
+      end
+    end
+
+    def save_existing_record!
+      # tell rails the field will change
+      parent.send "#{field_name}_will_change!"
+
+      record = parent.read_attribute(field_name).detect {|t| t['id'].to_i == self.id.to_i }
+      record.merge!(@attributes)
+
+      if parent.save
+        true
+      else
+        # restore old value
+        parent.send "#{field_name}=", parent.send("#{field_name}_was")
+        false
+      end
+    end
+
+    def generate_id!
+      max_id = parent.read_attribute(field_name).inject(0) {|max, t| if t['id'].to_i > max then t['id'].to_i else max end }
+      max_id + 1
+    end
+
+    def field_name
+      self.class.instance_variable_get("@field_name")
+    end
+  end
+end

data/lib/embeds_many/child_collection.rb

@@ -0,0 +1,39 @@
+module EmbedsMany
+  class ChildrenCollection
+    def new(attrs)
+      @child_klass.new(attrs.merge(parent: @obj))
+    end
+
+    def create(attrs)
+      record = @child_klass.new(attrs.merge(parent: @obj))
+
+      record.save
+
+      record
+    end
+
+    def initialize(obj, field, child_klass)
+      @obj = obj
+      @field = field
+      @child_klass = child_klass
+    end
+
+    def find(id)
+      attrs = @obj.read_attribute(@field).find {|child| child['id'].to_i == id.to_i }
+
+      attrs && @child_klass.new(attrs.merge(parent: @obj))
+    end
+
+    # all records
+    def all
+      @obj.read_attribute(@field).map do |attrs|
+        @child_klass.new(attrs.merge(parent: @obj))
+      end
+    end
+
+    # pass unhandled message to children array
+    def method_missing(symbol, *args, &block)
+      all.send(symbol, *args, &block)
+    end
+  end
+end

data/lib/embeds_many/version.rb

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

data/spec/database.yml

@@ -0,0 +1,4 @@
+test:
+  adapter: postgresql
+  database: embeds_many_test
+  username: postgres

data/spec/embeds_many/user_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe User do
+  let(:user) { User.create(name: 'test') }
+
+  it "should has no tags" do
+    user.read_attribute(:tags).should eq([])
+  end
+
+  describe "tags" do
+    describe "create" do
+      it "should be able to create one tag" do
+        tag = user.tags.new(name: 'bug', color: 'red')
+
+        tag.save.should be_true
+        tag.id.should_not be_nil
+
+        user.reload.tags.any? {|t| t.name == 'bug'}.should be_true
+      end
+
+      it "should be unable to create tags with duplicate name" do
+        user.tags.new(name: 'bug', color: 'red').save.should be_true
+
+        tag = user.tags.new(name: 'bug', color: 'green')
+
+        tag.save.should be_false
+        tag.errors[:name].should_not be_empty
+      end
+
+      it "should be unable to create tags without color" do
+        tag = user.tags.new(name: 'bug')
+
+        tag.save.should be_false
+        tag.errors[:color].should_not be_empty
+      end
+    end
+
+    it "should be able to update record" do
+      tag = user.tags.create(name: 'bug', color: 'red')
+
+      user.reload.tags.any? {|t| t.name == 'bug'}.should be_true
+
+      tag.update(color: 'yellow').should be_true
+
+      user.reload.tags.any? {|t| t.color == 'yellow'}.should be_true
+    end
+
+    it "should be able to destroy" do
+      tag = user.tags.create(name: 'bug', color: 'red')
+
+      tag.destroy.should be_true
+
+      user.reload.tags.any? {|t| t.name == 'bug'}.should be_false
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,30 @@
+# Setup the db
+ActiveRecord::Schema.define(:version => 1) do
+  create_table "users", force: true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.hstore   "tags",       default: [], array: true
+  end
+end
+
+class User < ActiveRecord::Base
+  # many embedded tags
+  embeds_many :tags
+
+  # validation tags
+  embedded :tags do
+    embedded_fields :name, :color
+
+    validates :name, uniqueness: true, presence: true
+    validates :color, presence: true
+
+    def as_json
+      {
+        id: id,
+        name: name,
+        color: color
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'database_cleaner'
+require 'embeds_many'
+
+# connect to db
+config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'database.yml')))
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'test'])
+
+# setup database
+require 'schema'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: embeds_many
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- liufengyun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+- !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: database_cleaner
+  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: pg
+  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: 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: EmbedsMany allows programmers to work with embedded records the same
+  way as activerecord objects
+email:
+- liufengyunchina@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- embeds_many.gemspec
+- lib/embeds_many.rb
+- lib/embeds_many/base.rb
+- lib/embeds_many/child.rb
+- lib/embeds_many/child_collection.rb
+- lib/embeds_many/version.rb
+- spec/database.yml
+- spec/embeds_many/user_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+homepage: https://github.com/notionlabs/embeds_many
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: Embedded records based on the power of PostgreSQL's hstore and array
+test_files:
+- spec/database.yml
+- spec/embeds_many/user_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb