agnostic-duplicate 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32cdc91880b4712356cc059c8460a991cd79d39e
-  data.tar.gz: 79d5fb7a6d55d51ece7ee459b5fd95fdb164cacd
+  metadata.gz: 0f1eab323490625f666f5be5cb411b804541d471
+  data.tar.gz: e51eb8409624bdb8ac8819b20056fe06686ddecf
 SHA512:
-  metadata.gz: 8dab11d2925bb2e145230cd2ff3cb4e341f4cfaf68a7bca55d11805d712f257979a8d0d19b61e975ec13cfffb28e47293f9a0b614bce5aed13c0bcd9a2b52e7c
-  data.tar.gz: 74020d056b6f1493a9788281476fa52b4e743a1aa9466be38137e8522b4cda172eac53fc67973de2a3177f716bd0a1893d3d0dee96676763cd2fbaa49af36c94
+  metadata.gz: 61853c9158efa07ca9a8ff3d8f5791655a6269d692f1bbb4c6ecd823ca1bdd6ac569443fde5813420566a1d7ee679c5d41490094ea6e07508fbb2d47e3cf6993
+  data.tar.gz: 0d073b672d0f70242e7b24ef5f0f9802efded6ca751ec49fb92a9cde4772f734f9eb4b2b676eb045b9e546287e5139df839020d7d4748edb591ecbab10491a4d

data/.travis.yml

@@ -1,8 +1,11 @@
 language: ruby
 rvm:
-  - 2.1.2
-  - 2.1.1
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
+- 2.1.2
+- 2.1.1
+- 2.1.0
+- 2.0.0
+- 1.9.3
 script: rspec spec
+addons:
+  code_climate:
+    repo_token: 11404e3572fdb6bae4c9e45cb6effc8c294a8f9d7ec3f5d581e189eae6008912

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 1.0.1 
+
+* Added custom handling exception: 
+  - Agnostic::Duplicate::ChangeSet::AttributeNotFound
+  - Agnostic::Duplicate::ChangeSet::CopyError
+* Added option `dup_template` for duplicating fields over a custom template 
+  object. Updated documentation

data/README.md

@@ -1,3 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/agnostic-duplicate.svg)](http://badge.fury.io/rb/agnostic-duplicate)
+[![Build Status](https://travis-ci.org/dsaenztagarro/agnostic-duplicate.png)](https://travis-ci.org/dsaenztagarro/agnostic-duplicate)
+[![Code Climate](https://codeclimate.com/github/dsaenztagarro/agnostic-duplicate/badges/gpa.svg)](https://codeclimate.com/github/dsaenztagarro/agnostic-duplicate)
+[![Coverage Status](https://coveralls.io/repos/dsaenztagarro/agnostic-duplicate/badge.png?branch=master)](https://coveralls.io/r/dsaenztagarro/agnostic-duplicate?branch=master)
+[![Dependency Status](https://gemnasium.com/dsaenztagarro/agnostic-duplicate.svg)](https://gemnasium.com/dsaenztagarro/agnostic-duplicate)
+
 # Agnostic::Duplicate
 
 Duplicate objects are provided with an additional method `duplicate` that
@@ -99,9 +105,26 @@ set this configuration through `duplicable_config` method:
  end
 ```
 
+If you want to apply the `duplicate` over a custom instance object instead
+of the default template for the current configuration, then you can pass a
+`dup_template` option on the method call
+
+```ruby
+otherobject  # => Object sharing duplicable attributes with 'myobject'
+myobject.duplicate dup_template: otherobject
+```
+
+As the object passed to dup_template should be compliant with the duplicable
+attribute list, if there is an error during the process an exception will
+be raise according to the type of error:
+
+  - Agnostic::Duplicate::ChangeSet::AttributeNotFound
+  - Agnostic::Duplicate::ChangeSet::CopyError
+
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/agnostic-duplicate/fork )
+1. Fork it ( https://github.com/dsaenztagarro/agnostic-duplicate/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`)

data/Rakefile.rb

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rspec'
+end
+
+RSpec::Core::RakeTask.new :specs do |task|
+  task.pattern = Dir['spec/**/*_spec.rb']
+end
+
+task default: ['specs']

data/agnostic-duplicate.gemspec

@@ -12,10 +12,10 @@ Gem::Specification.new do |spec|
 Duplicate library provides additional support for deep copy or shallow copy of
 specific fields in your models while you are `dupping` an instance.)
 summary
-  spec.description   = <<-description
+  spec.description   = <<-desc
 The advantage of using Duplicate module reside in support for fields that
 are not duplicated by default for any reason by calling `dup`.)
-description
+desc
   spec.homepage      = 'https://github.com/dsaenztagarro/agnostic-duplicate'
   spec.license       = 'MIT'
 
@@ -27,7 +27,9 @@ description
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'codeclimate-test-reporter'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'reek'
   spec.add_development_dependency 'cane'

data/lib/agnostic/duplicate.rb

@@ -84,6 +84,22 @@ module Agnostic
   #    # ...
   #  end
   # ```
+  #
+  # If you want to apply the `duplicate` over a custom instance object instead
+  # of the default template for the current configuration, then you can pass a
+  # `dup_template` option on the method call
+  #
+  # ```ruby
+  # otherobject  # => Object sharing duplicable attributes with 'myobject'
+  # myobject.duplicate dup_template: otherobject
+  # ```
+  #
+  # As the object passed to dup_template should be compliant with the duplicable
+  # attribute list, if there is an error during the process an exception will
+  # be raise according to the type of error:
+  #   - Agnostic::Duplicate::ChangeSet::AttributeNotFound
+  #   - Agnostic::Duplicate::ChangeSet::CopyError
+  #
   module Duplicate
     def self.included(base)
       base.extend(ClassMethods)
@@ -93,8 +109,11 @@ module Agnostic
 
     # Duplicates the object
     # @return [Duplicate] the new instance object
-    def duplicate
-      dup_template.tap do |model|
+    # @return opts [Hash] the options for duplicating
+    # @option [Object] dup_template The object over attributes are going to be
+    #   copied
+    def duplicate(opts = {})
+      (opts[:dup_template] || dup_template).tap do |model|
         apply_changesets!(model)
         hook_after_duplicate!(model) if respond_to? :hook_after_duplicate!
       end
@@ -113,6 +132,13 @@ module Agnostic
     # Contains all kinds of changesets that can be applied to a duplicable
     # object
     module ChangeSet
+      # Raised when there is an error while trying to copy an attribute
+      class CopyError < StandardError
+      end
+      # Raised when a non existing attribute is tried to be duplicated
+      class AttributeNotFound < StandardError
+      end
+
       # Base class for all changesets. Subclasses should implement method
       # `apply` (see #apply)
       class Base
@@ -120,6 +146,13 @@ module Agnostic
         def initialize(attributes)
           @attributes = attributes
         end
+
+        private
+
+        def raise_copy_error_for(attribute)
+          msg = "It wasn't possible to copy attribute '#{attribute}'"
+          fail CopyError, msg, caller
+        end
       end
 
       # Defines a changeset where a deep copy wants to be applied to all
@@ -130,17 +163,25 @@ module Agnostic
         # @param model [Duplicate] the duplicated new instance object
         def apply(parent, model)
           attributes.each do |attribute|
-            setter_method = "#{attribute}="
-            if model.respond_to?(setter_method)
-              model.send(setter_method, dup_attribute(parent, attribute))
-            else
-              fail "Invalid duplicable attribute '#{attribute}'"
+            unless model.respond_to? "#{attribute}="
+              fail AttributeNotFound, "Attribute: '#{attribute}'", caller
             end
+            deep_copy = dup_attribute(parent, attribute)
+            copy_attribute(attribute, model, deep_copy)
           end
         end
 
         private
 
+        # @param attribute [Symbol] attribute to be copied
+        # @param parent [Duplicable] the original object to be duplicated
+        # @param model [Duplicable] the duplicated new instance object
+        def copy_attribute(attribute, model, deep_copy)
+          model.send("#{attribute}=", deep_copy)
+        rescue
+          raise_copy_error_for(attribute)
+        end
+
         # @param parent [Duplicate] the original object to be duplicated
         # @param attribute [Symbol] the attribute to be duplicated
         # @return from a duplicable object the duplicated value for the
@@ -177,19 +218,30 @@ module Agnostic
       # of the primitive type.
       class ShallowCopy < Base
         # Applies changes needed on the duplicated new instance object
-        # @param parent [Duplicate] the original object to be duplicated
-        # @param model [Duplicate] the duplicated new instance object
+        # @param parent [Duplicable] the original object to be duplicated
+        # @param model [Duplicable] the duplicated new instance object
         def apply(parent, model)
           attributes.each do |attribute|
-            model.send("#{attribute}=", parent.send(attribute))
+            copy_attribute(attribute, parent, model)
           end
         end
+
+        private
+
+        # @param attribute [Symbol] attribute to be copied
+        # @param parent [Duplicable] the original object to be duplicated
+        # @param model [Duplicable] the duplicated new instance object
+        def copy_attribute(attribute, parent, model)
+          model.send("#{attribute}=", parent.send(attribute))
+        rescue
+          raise_copy_error_for(attribute)
+        end
       end
     end
 
     private
 
-    # @return [Duplicate] a new instance object based on global duplicable
+    # @return [Duplicable] a new instance object based on global duplicable
     #   configuration
     def dup_template
       klass = self.class
@@ -200,7 +252,7 @@ module Agnostic
       end
     end
 
-    # Methods added to classes including Duplicate module
+    # Methods added to classes including Duplicable module
     module ClassMethods
       attr_accessor :duplicable_changesets, :duplicable_options
 
@@ -220,15 +272,14 @@ module Agnostic
 
       # Sets global options for applying changesets
       #
-      # ## Options available:
-      # - `new_instance`: if `true` the duplicated instance is created calling
-      # in first place `new` method over the class. if `false` the duplicated
-      # instance is created calling to `dup` method over the instance object.
-      #
-      # @param options [Hash]
-      def duplicable_config(options)
-        if options.is_a? Hash
-          @duplicable_options.merge! options
+      # @param opts [Hash] The options for duplicable configuration
+      # @option opts [Boolean] :new_instance If `true` the duplicated instance
+      #   is created calling in first place `new` method over the class. if
+      #   `false` the duplicated instance is created calling to `dup` method
+      #   over the instance object.
+      def duplicable_config(opts)
+        if opts.is_a? Hash
+          @duplicable_options.merge! opts
           keep_valid_options
         else
           fail ArgumentError, 'Invalid options configuration'

data/lib/agnostic/duplicate/version.rb

@@ -1,5 +1,6 @@
 module Agnostic
+  #:nodoc:
   module Duplicate
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

data/spec/agnostic_duplicate_spec.rb

@@ -213,7 +213,7 @@ describe Agnostic::Duplicate do
     end
     context 'when invalid settings' do
       context "when attribute doesn't exist" do
-        it 'raises an exception' do
+        it 'raises an attribute not found error' do
           expect do
             #:nodoc
             module DuplicateSpec
@@ -224,7 +224,47 @@ describe Agnostic::Duplicate do
               end
               InvalidAttributeTest.new.duplicate
             end
-          end.to raise_error("Invalid duplicable attribute 'name'")
+          end.to raise_error Agnostic::Duplicate::ChangeSet::AttributeNotFound
+        end
+      end
+      context 'when custom dup_template lacks of duplicable attribute' do
+        it 'raises a copy error on deep copy' do
+          expect do
+            #:nodoc
+            module DuplicateSpec
+              #:nodoc
+              class InvalidDupTemplateTest < Base
+                include Agnostic::Duplicate
+                attr_duplicable :name
+              end
+
+              obj = Object.new
+              obj.define_singleton_method('name=') do
+                fail 'Internal error'
+              end
+
+              InvalidDupTemplateTest.new.duplicate dup_template: obj
+            end
+          end.to raise_error Agnostic::Duplicate::ChangeSet::CopyError
+        end
+        it 'raises a copy error on shallow copy' do
+          expect do
+            #:nodoc
+            module DuplicateSpec
+              #:nodoc
+              class InvalidDupTemplateTest < Base
+                include Agnostic::Duplicate
+                attr_duplicable :name, strategy: :shallow_copy
+              end
+
+              obj = Object.new
+              obj.define_singleton_method('name=') do
+                fail 'Internal error'
+              end
+
+              InvalidDupTemplateTest.new.duplicate dup_template: obj
+            end
+          end.to raise_error Agnostic::Duplicate::ChangeSet::CopyError
         end
       end
       context 'when duplicable config is invalid' do

data/spec/spec_helper.rb

@@ -1,4 +1,12 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
 require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
 SimpleCov.start
 
 require_relative '../lib/agnostic/duplicate'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agnostic-duplicate
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - David Saenz Tagarro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2014-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -122,10 +150,11 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
+- Rakefile.rb
 - agnostic-duplicate.gemspec
 - lib/agnostic/duplicate.rb
 - lib/agnostic/duplicate/version.rb

data/Rakefile

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