amoeba 1.2.1 → 2.0.0

data/.rvmrc

@@ -1 +1 @@
-rvm use --create 1.9.3-p125@amoeba
+rvm use --create 1.9.3-p194@amoeba

data/README.md

@@ -1,4 +1,8 @@
-# Amoeba
+# IMPORTANT NEWS
+
+* As of December 11th, 2012 Amoeba no longer overrides the built in `ActiveRecord::Base#dup` method and instead implements its own method called `amoeba_dup`. Make sure to update your code if you do a bundle update and or double check that your gemfile has a version restriction bound to v1.x e.g. '~> 1.2' listed for amoeba.
+
+## Amoeba
 
 Easy copying of rails associations such as `has_many`.
 
@@ -12,7 +16,7 @@ This gem is named "Amoeba" because amoebas are (small life forms that are) good
 
 ### Technical Details
 
-An ActiveRecord extension gem to allow the duplication of associated child record objects when duplicating an active record model. This gem overrides and adds to the built in `ActiveRecord::Base#dup` method.
+An ActiveRecord extension gem to allow the duplication of associated child record objects when duplicating an active record model.
 
 Rails 3.2 compatible.
 
@@ -50,7 +54,7 @@ or just add it to your Gemfile:
 
     gem 'amoeba'
 
-Configure your models with one of the styles below and then just run the `dup` method on your model as you normally would:
+Configure your models with one of the styles below and then just run the `amoeba_dup` method on your model where you would run the `dup` method normally:
 
     p = Post.create(:title => "Hello World!", :content => "Lorum ipsum dolor")
     p.comments.create(:content => "I love it!")
@@ -58,7 +62,7 @@ Configure your models with one of the styles below and then just run the `dup` m
 
     puts Comment.all.count # should be 2
 
-    my_copy = p.dup
+    my_copy = p.amoeba_dup
     my_copy.save
 
     puts Comment.all.count # should be 4
@@ -99,7 +103,7 @@ simply add the amoeba configuration block to your model and call the enable meth
       belongs_to :post
     end
 
-Child records will be automatically copied when you run the dup method.
+Child records will be automatically copied when you run the `amoeba_dup` method.
 
 #### Inclusive Style
 
@@ -212,7 +216,7 @@ If you are using a Many-to-Many relationship, you may tell amoeba to actually ma
 
 This example will actually duplicate the warnings and widgets in the database. If there were originally 3 warnings in the database then, upon duplicating a post, you will end up with 6 warnings in the database. This is in contrast to the default behavior where your new post would merely be re-associated with any previously existing warnings and those warnings themselves would not be duplicated.
 
-### Limiting Association Types
+#### Limiting Association Types
 
 By default, amoeba recognizes and attemps to copy any children of the following association types:
 
@@ -242,90 +246,6 @@ You may control which association types amoeba applies itself to by using the `r
 
 This example will copy the post's configuration data and keep tags associated with the new post, but will not copy the post's comments because amoeba will only recognize and copy children of `has_one` and `has_and_belongs_to_many` associations and in this example, comments are not an `has_and_belongs_to_many` association.
 
-### Nested Association Validation
-
-If you end up with some validation issues when trying to validate the presence of a child's `belongs_to` association, just be sure to include the `:inverse_of` declaration on your relationships and all should be well.
-
-For example this will throw a validation error saying that your posts are invalid:
-
-    class Author < ActiveRecord::Base
-      has_many :posts
-
-      amoeba do
-        enable
-      end
-    end
-
-    class Post < ActiveRecord::Base
-      belongs_to :author
-      validates_presence_of :author
-
-      amoeba do
-        enable
-      end
-    end
-
-    author = Author.find(1)
-    author.dup
-
-    author.save # this will fail validation
-
-Wheras this will work fine:
-
-    class Author < ActiveRecord::Base
-      has_many :posts, :inverse_of => :author
-
-      amoeba do
-        enable
-      end
-    end
-
-    class Post < ActiveRecord::Base
-      belongs_to :author, :inverse_of => :posts
-      validates_presence_of :author
-
-      amoeba do
-        enable
-      end
-    end
-
-    author = Author.find(1)
-    author.dup
-
-    author.save # this will pass validation
-
-This issue is not amoeba specific and also occurs when creating new objects using `accepts_nested_attributes_for`, like this:
-
-    class Author < ActiveRecord::Base
-      has_many :posts
-      accepts_nested_attributes_for :posts
-    end
-
-    class Post < ActiveRecord::Base
-      belongs_to :author
-      validates_presence_of :author
-    end
-
-    # this will fail validation
-    author = Author.create({:name => "Jim Smith", :posts => [{:title => "Hello World", :contents => "Lorum ipsum dolor}]})
-
-This issue with `accepts_nested_attributes_for` can also be solved by using `:inverse_of`, like this:
-
-    class Author < ActiveRecord::Base
-      has_many :posts, :inverse_of => :author
-      accepts_nested_attributes_for :posts
-    end
-
-    class Post < ActiveRecord::Base
-      belongs_to :author, :inverse_of => :posts
-      validates_presence_of :author
-    end
-
-    # this will pass validation
-    author = Author.create({:name => "Jim Smith", :posts => [{:title => "Hello World", :contents => "Lorum ipsum dolor}]})
-
-The crux of the issue is that upon duplication, the new `Author` instance does not yet have an ID because it has not yet been persisted, so the `:posts` do not yet have an `:author_id` either, and thus no `:author` and thus they will fail validation. This issue may likely affect amoeba usage so if you get some validation failures, be sure to add `:inverse_of` to your models.
-
 ### Field Preprocessors
 
 #### Nullify
@@ -488,7 +408,7 @@ This example should result in something like this:
       :contents =>  "I like dogs, dogs are awesome."
     )
 
-    new_post = post.dup
+    new_post = post.amoeba_dup
 
     new_post.title # "Copy of Hello world"
     new_post.contents # "Original contents: I like cats, cats are awesome. (copied version)"
@@ -612,7 +532,7 @@ Copying of `has_many :through` associations works automatically. They perform th
       belongs_to :part
 
       amoeba do
-        prefix :notes => "Copy of "
+        prepend :notes => "Copy of "
       end
     end
 
@@ -653,7 +573,7 @@ You may control how amoeba copies your object, on the fly, by passing a configur
           prepend :contents => "Here's a copy: "
         end
 
-        new_post = old_post.dup
+        new_post = old_post.amoeba_dup
 
         new_post.title # should be "Copy of Hello world"
         new_post.contents # should be "Here's a copy: Lorum ipsum"
@@ -700,7 +620,7 @@ If you are using the Single Table Inheritance provided by ActiveRecord, you may
     class ProductsController
       def some_method
         my_shirt = Shirt.find(1)
-        my_shirt.dup
+        my_shirt.amoeba_dup
         my_shirt.save
 
         # this shirt should now:
@@ -843,6 +763,90 @@ The next version will use only the parent settings because passing an array will
       include_field :sections
     end
 
+### Validating Nested Attributes
+
+If you end up with some validation issues when trying to validate the presence of a child's `belongs_to` association, just be sure to include the `:inverse_of` declaration on your relationships and all should be well.
+
+For example this will throw a validation error saying that your posts are invalid:
+
+    class Author < ActiveRecord::Base
+      has_many :posts
+
+      amoeba do
+        enable
+      end
+    end
+
+    class Post < ActiveRecord::Base
+      belongs_to :author
+      validates_presence_of :author
+
+      amoeba do
+        enable
+      end
+    end
+
+    author = Author.find(1)
+    author.amoeba_dup
+
+    author.save # this will fail validation
+
+Wheras this will work fine:
+
+    class Author < ActiveRecord::Base
+      has_many :posts, :inverse_of => :author
+
+      amoeba do
+        enable
+      end
+    end
+
+    class Post < ActiveRecord::Base
+      belongs_to :author, :inverse_of => :posts
+      validates_presence_of :author
+
+      amoeba do
+        enable
+      end
+    end
+
+    author = Author.find(1)
+    author.amoeba_dup
+
+    author.save # this will pass validation
+
+This issue is not amoeba specific and also occurs when creating new objects using `accepts_nested_attributes_for`, like this:
+
+    class Author < ActiveRecord::Base
+      has_many :posts
+      accepts_nested_attributes_for :posts
+    end
+
+    class Post < ActiveRecord::Base
+      belongs_to :author
+      validates_presence_of :author
+    end
+
+    # this will fail validation
+    author = Author.create({:name => "Jim Smith", :posts => [{:title => "Hello World", :contents => "Lorum ipsum dolor}]})
+
+This issue with `accepts_nested_attributes_for` can also be solved by using `:inverse_of`, like this:
+
+    class Author < ActiveRecord::Base
+      has_many :posts, :inverse_of => :author
+      accepts_nested_attributes_for :posts
+    end
+
+    class Post < ActiveRecord::Base
+      belongs_to :author, :inverse_of => :posts
+      validates_presence_of :author
+    end
+
+    # this will pass validation
+    author = Author.create({:name => "Jim Smith", :posts => [{:title => "Hello World", :contents => "Lorum ipsum dolor}]})
+
+The crux of the issue is that upon duplication, the new `Author` instance does not yet have an ID because it has not yet been persisted, so the `:posts` do not yet have an `:author_id` either, and thus no `:author` and thus they will fail validation. This issue may likely affect amoeba usage so if you get some validation failures, be sure to add `:inverse_of` to your models.
+
 ## Configuration Reference
 
 Here is a static reference to the available configuration methods, usable within the amoeba block on your rails models.
@@ -915,9 +919,15 @@ Here is a static reference to the available configuration methods, usable within
 
   Globally search and replace the field for a given pattern. Accepts a hash of fields to run search and replace upon. The keys are the field names and the values are each a hash with information about what to find and what to replace it with. in the form of . An example would be to replace all occurrences of the word "dog" with the word "cat", the parameter hash would look like this `:contents => {:replace => /dog/, :with => "cat"}`. Passing a hash will add each key value pair to the list of regex directives. If you wish to empty the list of directives, you may pass the hash inside of an array like this `[{:contents => {:replace => /dog/, :with => "cat"}]`.
 
+#### override
+
+  Runs a custom method so you can do basically whatever you want. All you need to do is pass a lambda block or an array of lambda blocks that take two parameters, the original object and the new object copy. These blocks will run before any other duplication or field processing.
+
+  This method may be called multiple times, once per desired customizer block, or you may pass an array of lambdas. Passing a single lambda will add to the list of processing directives. Passing an array will empty the list and replace it with the array you pass.
+
 #### customize
 
-  Runs a custom method so you can do basically whatever you want. All you need to do is pass a lambda block or an array of lambda blocks that take two parameters, the original object and the new object copy
+  Runs a custom method so you can do basically whatever you want. All you need to do is pass a lambda block or an array of lambda blocks that take two parameters, the original object and the new object copy. These blocks will run after all copying and field processing.
 
   This method may be called multiple times, once per desired customizer block, or you may pass an array of lambdas. Passing a single lambda will add to the list of processing directives. Passing an array will empty the list and replace it with the array you pass.
 

data/lib/amoeba.rb

@@ -323,8 +323,8 @@ module Amoeba
     end
     # }}}
 
-    def dup(options={})
-      @result = super()
+    def amoeba_dup(options={})
+      @result = self.dup()
 
       # Inherit Parent Settings {{{
       if !amoeba_conf.enabled && parent_amoeba_conf.inherit
@@ -422,7 +422,7 @@ module Amoeba
         old_obj = self.send(relation_name)
 
         if not old_obj.nil?
-          copy_of_obj = old_obj.dup
+          copy_of_obj = old_obj.amoeba_dup
           copy_of_obj[:"#{settings.foreign_key}"] = nil
 
           @result.send(:"#{relation_name}=", copy_of_obj)
@@ -439,7 +439,7 @@ module Amoeba
           # rather than only maintaining the associations
           self.send(relation_name).each do |old_obj|
 
-            copy_of_obj = old_obj.dup
+            copy_of_obj = old_obj.amoeba_dup
 
             # associate this new child to the new parent object
             @result.send(relation_name) << copy_of_obj
@@ -454,7 +454,7 @@ module Amoeba
           return if settings.is_a?(ActiveRecord::Reflection::ThroughReflection)
 
           self.send(relation_name).each do |old_obj|
-            copy_of_obj = old_obj.dup
+            copy_of_obj = old_obj.amoeba_dup
             copy_of_obj[:"#{settings.foreign_key}"] = nil
 
             # associate this new child to the new parent object
@@ -467,7 +467,7 @@ module Amoeba
 
         if clone
           self.send(relation_name).each do |old_obj|
-            copy_of_obj = old_obj.dup
+            copy_of_obj = old_obj.amoeba_dup
 
             # associate this new child to the new parent object
             @result.send(relation_name) << copy_of_obj

data/lib/amoeba/version.rb

@@ -1,3 +1,3 @@
 module Amoeba
-  VERSION = "1.2.1"
+  VERSION = "2.0.0"
 end

data/spec/lib/amoeba_spec.rb

@@ -12,7 +12,7 @@ describe "amoeba" do
         prepend :contents => "Here's a copy: "
       end
 
-      new_post = old_post.dup
+      new_post = old_post.amoeba_dup
 
       start_account_count = Account.all.count
       start_history_count = History.all.count
@@ -83,12 +83,21 @@ describe "amoeba" do
       new_post.widgets.map(&:id).each do |id|
         old_post.widgets.map(&:id).include?(id).should_not be true
       end
+
+      new_post.custom_things.length.should == 3
+      new_post.custom_things.select{ |ct| ct.value == [] }.length.should == 1
+      new_post.custom_things.select{ |ct| ct.value == [1,2]}.length.should == 1
+      new_post.custom_things.select{ |ct| ct.value == [78]}.length.should == 1
       # }}}
       # Author {{{
       old_author = Author.find(1)
-      new_author = old_author.dup
+      new_author = old_author.amoeba_dup
       new_author.save
       new_author.errors.messages.length.should == 0
+      new_author.posts.first.custom_things.length.should == 3
+      new_author.posts.first.custom_things.select{ |ct| ct.value == [] }.length.should == 1
+      new_author.posts.first.custom_things.select{ |ct| ct.value == [1,2]}.length.should == 1
+      new_author.posts.first.custom_things.select{ |ct| ct.value == [78]}.length.should == 1
       # }}}
       # Products {{{
       # Base Class {{{
@@ -99,7 +108,7 @@ describe "amoeba" do
       rs = ActiveRecord::Base.connection.select_one('SELECT COUNT(*) AS section_count FROM products_sections WHERE product_id = ?', old_product.id)
       start_prodsection_count = rs["section_count"]
 
-      new_product = old_product.dup
+      new_product = old_product.amoeba_dup
       new_product.save
       new_product.errors.messages.length.should == 0
 
@@ -127,7 +136,7 @@ describe "amoeba" do
       rs = ActiveRecord::Base.connection.select_one('SELECT COUNT(*) AS section_count FROM products_sections WHERE product_id = ?', old_product.id)
       start_prodsection_count = rs["section_count"]
 
-      new_product = old_product.dup
+      new_product = old_product.amoeba_dup
       new_product.save
       new_product.errors.messages.length.should == 0
 
@@ -154,7 +163,7 @@ describe "amoeba" do
       rs = ActiveRecord::Base.connection.select_one('SELECT COUNT(*) AS section_count FROM products_sections WHERE product_id = ?', old_product.id)
       start_prodsection_count = rs["section_count"]
 
-      new_product = old_product.dup
+      new_product = old_product.amoeba_dup
       new_product.save
       new_product.errors.messages.length.should == 0
 

data/spec/support/data.rb

@@ -81,6 +81,8 @@ s2.superkittens.create(:value => "Spot")
 s3.superkittens.create(:value => "Dopey")
 s3.superkittens.create(:value => "Sneezy")
 s3.superkittens.create(:value => "Sleepy")
+
+p1.custom_things.create([{:value => [1,2]}, {:value => []}, {:value => [78]}])
 # }}}
 
 # Product {{{

data/spec/support/models.rb

@@ -25,6 +25,7 @@ class Post < ActiveRecord::Base
   has_many :categories, :through => :supercats
   has_many :post_widgets
   has_many :widgets, :through => :post_widgets
+  has_many :custom_things
   has_and_belongs_to_many :tags
   has_and_belongs_to_many :notes
 
@@ -73,6 +74,30 @@ end
 
 class CustomThing < ActiveRecord::Base
   belongs_to :post
+  class ArrayPack
+    def self.load(str)
+      unless str.present? && str.length > 0
+        return []
+      end
+      if str.is_a?(Array)
+        return str
+      end
+      str.split(',').collect(&:to_i)
+    end
+    def self.dump(int_array)
+      unless int_array.present? && int_array.length > 0
+        return ""
+      end
+      int_array.join(',')
+    end
+  end
+
+  serialize :value, ArrayPack
+
+  before_create :hydrate_me
+  def hydrate_me
+    self.value = self.value
+  end
 end
 
 class Account < ActiveRecord::Base

data/spec/support/schema.rb

@@ -82,6 +82,7 @@ ActiveRecord::Schema.define do
   end
 
   create_table :custom_things, :force => true do |t|
+    t.integer :post_id
     t.string :value
     t.timestamps
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amoeba
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-08 00:00:00.000000000 Z
+date: 2013-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,8 +143,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: amoeba
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Easy copying of rails models and their child associations.
-test_files: []
+test_files:
+- spec/lib/amoeba_spec.rb
+- spec/spec_helper.rb
+- spec/support/data.rb
+- spec/support/models.rb
+- spec/support/schema.rb