o_patch 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2EzZDY2NDZjYWM5NTFmMzA1OWVjNmE0MmU4YTE3NzQzZmZiNzA2YQ==
+  data.tar.gz: !binary |-
+    MTBmOTIzNmQ0NjhlMzcyY2I4ZGI2NWM1MjE4YThkYTM4ZTc1NTk2MA==
+SHA512:
+  metadata.gz: !binary |-
+    ZDFmM2Q2OTJkZTgzNTFiNTM1ZmMzZTFlMTQ3ZGNhYTFkZWIxOGQ1NDQ1YmIy
+    NTRhMDY0NjliYTI1MzgxZDk4NjNhMzQ1MzI3NzFiYjRiMzU5ZDk4MTc5MDU0
+    ODFkMjI5MmVjMWMxZGZlODMxODVjOWU0ZTE4OWQyN2VjNDE0NmE=
+  data.tar.gz: !binary |-
+    NGRmYTFiZDEyYWVkN2E0ZDlkYTEwMTdkZmNlYTkxYWM2ZDZkZWExZTVmODVk
+    YjllZTI3YzY5NTYxMzU5Nzk4ZTBjNzQ3MmNiMjcyYzAxZDkyZTBlY2JhMWQ5
+    NTIxYmU2NjBkNzQ1MWMzZjQ5ZmZlNWY4ZTFkMDg1NjYxMzI2MTk=

data/.gitignore

@@ -0,0 +1,3 @@
+/.bundle
+/vendor/bundle
+.DS_Store

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    o_patch (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  o_patch!
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Albert Gazizov
+
+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,4 @@
+opatch
+======
+
+Declarative ruby objects patcher

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/o_patch.rb

@@ -0,0 +1,7 @@
+module OPatch
+  require 'o_patch/patcher'
+
+  def self.patch(entity, attributes, &block)
+    Patcher.patch(entity, attributes, &block)
+  end
+end

data/lib/o_patch/patcher.rb

@@ -0,0 +1,88 @@
+class OPatch::Patcher
+  attr_reader :entity, :attributes
+
+  def initialize(entity, attributes, &block)
+    @entity     = entity
+    @attributes = attributes
+  end
+
+  private :initialize
+
+  def self.patch(entity, attributes, &block)
+    new(entity, attributes).instance_exec(&block)
+  end
+
+  private
+
+  def field(field_name, block = nil)
+    raise ArgumentError, "field name should be a symbol" unless field_name.is_a?(Symbol)
+    if attributes.has_key?(field_name)
+      value = attributes[field_name]
+      if block
+        block.call(entity, value)
+      else
+        entity.send("#{field_name}=", value)
+      end
+    end
+  end
+
+  def object(field_name, options = {}, &block)
+    if attributes.has_key?(field_name)
+      if attributes[field_name].nil?
+        entity.send("#{field_name}=", nil)
+      else
+        child_entity = entity.send(field_name)
+        if child_entity
+          self.class.patch(entity.send(field_name), attributes[field_name], &block)
+        else
+          build_block = options[:build]
+          # Todo: ensure block is proc
+          raise ArgumentError, "#{field_name} build block should be specified" unless build_block
+          build_block.call(entity, attributes[field_name])
+        end
+      end
+    end
+  end
+
+  def collection(collection_name, options = {}, &block)
+    raise ArgumentError, "#{collection_name} collection key should be specified" unless options[:key]
+    raise ArgumentError, "#{collection_name} build block should be specified" unless options[:build]
+    # Todo: ensure key is a symbol or array of symbols, block is proc
+    key         = options[:key]
+    build_block = options[:build]
+    if attributes.has_key?(collection_name)
+      collection = entity.send(collection_name)
+      collection_hash = collection.group_by { |item| object_key_value(item, key) }
+      attributes[collection_name].each do |child_attributes|
+        key_value = attributes_key_value(child_attributes, key)
+        if key_value
+          child_object = collection_hash[key_value].first
+          raise "#{collection_name} don't have an object with key: #{key_value}" unless child_object
+          if child_attributes[:_destroy]
+            collection.delete(child_object)
+          else
+            self.class.patch(child_object, child_attributes, &block)
+          end
+        else
+          build_block.call(entity, child_attributes)
+        end
+      end
+    end
+  end
+
+  def object_key_value(object, key)
+    if key.is_a?(Array)
+      key.map { |k| object.send(k) }
+    else
+      object.send(key)
+    end
+  end
+
+  def attributes_key_value(attributes, key)
+    if key.is_a?(Array)
+      key.map { |k| attributes[:k] }
+    else
+      attributes[key]
+    end
+  end
+end

data/o_patch.gemspec

@@ -0,0 +1,18 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "o_patch"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Albert Gazizov"]
+  spec.description   = %q{Declarative ruby objects patcher}
+  spec.summary       = %q{Declarative ruby objects patcher}
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/o_patch/o_patch_spec.rb

@@ -0,0 +1,226 @@
+require 'spec_helper'
+
+describe OPatch do
+
+  context "simple fields" do
+    before do
+      Person = Struct.new(:name)
+    end
+
+    it "should patch simple field" do
+      person = Person.new('Ivan')
+
+      OPatch.patch(person, name: 'Vasya') do
+        field :name
+      end
+
+      person.name.should == 'Vasya'
+    end
+
+    it "should patch field using given block" do
+      person = Person.new('Ivan')
+
+      OPatch.patch(person, name: 'Vasya') do
+        field :name, proc { |person, new_name| person.name = new_name }
+      end
+
+      person.name.should == 'Vasya'
+    end
+  end
+
+  context "nested object" do
+    before do
+      Address = Struct.new(:country, :city)
+      Person = Struct.new(:name, :address)
+      class Person
+        def build_address(attrs)
+          self.address = Address.new(attrs[:country], attrs[:city])
+        end
+      end
+    end
+
+    it "should patch nested object fields" do
+      person = Person.new('Ivan', Address.new('Russia', 'Kazan'))
+
+      OPatch.patch(person, name: 'Vasya', address: { country: 'USA', city: 'New York'}) do
+        field  :name
+        object :address do
+          field :country
+          field :city
+        end
+      end
+
+      person.address.country.should == 'USA'
+      person.address.city.should == 'New York'
+    end
+
+    it "should nullify nested object if nil was given" do
+      person = Person.new('Ivan', Address.new('Russia', 'Kazan'))
+
+      OPatch.patch(person, name: 'Vasya', address: nil) do
+        field  :name
+        object :address do
+          field :country
+          field :city
+        end
+      end
+
+      person.address.should be_nil
+    end
+
+    it "should build nested object if it was nil before" do
+      person = Person.new('Ivan')
+
+      OPatch.patch(person, name: 'Vasya', address: { country: 'Russia', city: 'Kazan' }) do
+        field  :name
+        object :address, build: proc { |person, attributes| person.build_address(attributes) } do
+          field :country
+          field :city
+        end
+      end
+
+      person.address.should_not be_nil
+      person.address.country.should == 'Russia'
+      person.address.city.should == 'Kazan'
+    end
+
+    it "should raise error if build block wasn't specified but attributes were given" do
+      person = Person.new('Ivan')
+
+      expect do
+        OPatch.patch(person, name: 'Vasya', address: { country: 'Russia', city: 'Kazan' }) do
+          field  :name
+          object :address do
+            field :country
+            field :city
+          end
+        end
+      end.to raise_error(ArgumentError, "address build block should be specified")
+    end
+  end
+
+  context "nested collection" do
+    before do
+      Person = Struct.new(:name, :emails)
+      Email  = Struct.new(:id, :address, :type)
+      class Person
+        def build_email(attrs)
+          self.emails << Email.new(nil, attrs[:address], attrs[:type])
+        end
+      end
+    end
+
+    it "should patch collection objects" do
+      person = Person.new(
+        'Ivan',
+        [
+          Email.new(1, 'work@example.com', :work),
+          Email.new(2, 'work2@example.com', :work)
+        ]
+      )
+
+      attributes = {
+        emails: [
+          { id: 1, address: 'home@example.com',  type: :home },
+          { id: 2, address: 'home2@example.com', type: :home }
+        ]
+      }
+      OPatch.patch(person, attributes) do
+        collection :emails, key: :id, build: proc { |person, attrs| person.build_email(attrs) } do
+          field :address
+          field :type
+        end
+      end
+
+      person.emails.count.should == 2
+
+      email = person.emails[0]
+      email.address.should == 'home@example.com'
+      email.type.should == :home
+
+      email = person.emails[1]
+      email.address.should == 'home2@example.com'
+      email.type.should == :home
+    end
+
+    it "should add new object to collection" do
+      person = Person.new(
+        'Ivan',
+        [
+          Email.new(1, 'work@example.com', :work),
+        ]
+      )
+
+      attributes = {
+        emails: [
+          { address: 'home@example.com', type: :home }
+        ]
+      }
+      OPatch.patch(person, attributes) do
+        collection :emails, key: :id, build: proc { |person, attrs| person.build_email(attrs) } do
+          field :address
+          field :type
+        end
+      end
+
+      person.emails.count.should == 2
+
+      email = person.emails[0]
+      email.address.should == 'work@example.com'
+      email.type.should == :work
+
+      email = person.emails[1]
+      email.address.should == 'home@example.com'
+      email.type.should == :home
+    end
+
+    it "should remove collection object if _destroy: true was specified" do
+      person = Person.new(
+        'Ivan',
+        [
+          Email.new(1, 'work@example.com', :work),
+          Email.new(2, 'work2@example.com', :work)
+        ]
+      )
+
+      attributes = {
+        emails: [
+          { id: 2, _destroy: true },
+        ]
+      }
+      OPatch.patch(person, attributes) do
+        collection :emails, key: :id, build: proc { |person, attrs| person.build_email(attrs) } do
+          field :address
+          field :type
+        end
+      end
+
+      person.emails.count.should == 1
+      person.emails.first.id.should == 1
+    end
+
+    it "should raise error if non existing key was specified" do
+
+    end
+
+    it "should build new object with key if assign_key is true" do
+
+    end
+  end
+
+  it "should raise error if undeclared attributes were specified" do
+  end
+
+  context "errors" do
+    it "should raise error if non symbol argument was given to the field method" do
+      Person = Struct.new(:name)
+      person = Person.new('Ivan')
+
+      expect do
+        OPatch.patch(person, name: 'Vasya') do
+          field 'name'
+        end
+      end.to raise_error(ArgumentError, "field name should be a symbol")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'o_patch'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: o_patch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Albert Gazizov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+description: Declarative ruby objects patcher
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/o_patch.rb
+- lib/o_patch/patcher.rb
+- o_patch.gemspec
+- spec/o_patch/o_patch_spec.rb
+- spec/spec_helper.rb
+homepage: 
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Declarative ruby objects patcher
+test_files:
+- spec/o_patch/o_patch_spec.rb
+- spec/spec_helper.rb