amoeba 1.0.0 → 1.1.0

data/README.md

@@ -25,14 +25,16 @@ Rails 3.2 compatible.
     - `has_and_belongs_to_many`
 - A simple DSL for configuration of which fields to copy. The DSL can be applied to your rails models or used on the fly.
 - Multiple configuration styles such as inclusive, exclusive and indiscriminate (aka copy everything).
-- Supports cloning of the children of Many-to-Many records as well as not cloning the child records but merely maintaining original associations
+- Supports cloning of the children of Many-to-Many records or merely maintaining original associations
 - Supports recursive copying of child and grandchild records.
 - Supports preprocessing of fields to help indicate uniqueness and ensure the integrity of your data depending on your business logic needs, e.g. prepending "Copy of " or similar text.
+- Supports preprocessing of fields with custom lambda blocks so you can basically whatever you want, for example if you need some custom logic while making copies.
 - Amoeba can perform the following preprocessing operations on fields of copied records
     - set
     - prepend
     - append
     - nullify
+    - customize
     - regex
 
 ## Installation
@@ -309,6 +311,44 @@ You may run a search and replace query on a copied object's field during the cop
       end
     end
 
+#### Custom Methods
+
+You may run a custom method or methods to do basically anything you like, simply pass a lambda block, or an array of lambda blocks to the `customize` directive. Each block must have the same form, meaning that each block must accept two parameters, the original object and the newly copied object. You may then do whatever you wish, like this:
+
+    class Post < ActiveRecord::Base
+      amoeba do
+        prepend :title => "Hello world! "
+
+        customize(lambda { |original_post,new_post|
+          if original_post.foo == "bar"
+            new_post.baz = "qux"
+          end
+        })
+
+        append :comments => "... know what I'm sayin?"
+      end
+    end
+
+or this, using an array:
+
+    class Post < ActiveRecord::Base
+      has_and_belongs_to_many :tags
+
+      amoeba do
+        include_field :tags
+
+        customize([
+          lambda do |orig_obj,copy_of_obj|
+            # good stuff goes here
+          end,
+
+          lambda do |orig_obj,copy_of_obj|
+            # more good stuff goes here
+          end
+        ])
+      end
+    end
+
 #### Chaining
 
 You may apply a preprocessor to multiple fields at once.
@@ -516,6 +556,8 @@ You may control how amoeba copies your object, on the fly, by passing a configur
 
 Here is a static reference to the available configuration methods, usable within the amoeba block on your rails models.
 
+#### Controlling Associations
+
 `enable`
 
 Enables amoeba in the default style of copying all known associated child records. Using the enable method is only required if you wish to enable amoeba but you are not using either the `include_field` or `exclude_field` directives. If you use either inclusive or exclusive style, amoeba is automatically enabled for you, so calling `enable` would be redundant, though it won't hurt.
@@ -528,6 +570,12 @@ Adds a field to the list of fields which should be copied. All associations not
 
 Adds a field to the list of fields which should not be copied. Only the associations that are not in this list will be copied. This method may be called multiple times, once per desired field, or you may pass an array of field names. Passing a single symbol will add to the list of excluded fields. Passing an array will empty the list and replace it with the array you pass.
 
+`clone`
+
+Adds a field to the list of associations which should have their associated children actually cloned. This means for example, that instead of just maintaining original associations with previously existing tags, a copy will be made of each tag, and the new record will be associated with these new tag copies rather than the old tag copies. This method may be called multiple times, once per desired field, or you may pass an array of field names. Passing a single symbol will add to the list of excluded fields. Passing an array will empty the list and replace it with the array you pass.
+
+#### Pre-Processing Fields
+
 `nullify`
 
 Adds a field to the list of non-association based fields which should be set to nil during copy. All fields in this list will be set to `nil` - note that any nullified field will be given its default value if a default value exists on this model's migration. This method may be called multiple times, once per desired field, or you may pass an array of field names. Passing a single symbol will add to the list of null fields. Passing an array will empty the list and replace it with the array you pass.
@@ -540,17 +588,27 @@ Prefix a field with some text. This only works for string fields. Accepts a hash
 
 Append some text to a field. This only works for string fields. Accepts a hash of fields to prepend. The keys are the field names and the values are the prefix strings. An example would be to add " (copied version)" to your description field. Don't forget to add a leading space if you want it. Passing a hash will add each key value pair to the list of append directives. If you wish to empty the list of directives, you may pass the hash inside of an array like this `[{:contents => " (copied version)"}]`.
 
+`set`
+
+Set a field to a given value. This sould work for almost any type of field. Accepts a hash of fields and the values you want them set to.. The keys are the field names and the values are the prefix strings. An example would be to add " (copied version)" to your description field. Don't forget to add a leading space if you want it. Passing a hash will add each key value pair to the list of append directives. If you wish to empty the list of directives, you may pass the hash inside of an array like this `[{:approval_state => "open_for_editing"}]`.
+
 `regex`
 
 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"}]`.
 
-## Known Limitations and Issues
+`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
+
+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.
 
-Amoeba does not copy the actual HABMT child records but rather simply adds records to the M:M breakout table to associate the new parent copy with the same records that the original parent were associated with. In other words, it doesn't duplicate your tags or categories, but merely reassociates your parent copy with the same tags or categories that the old parent had.
+## Known Limitations and Issues
 
 The regular expression preprocessor uses case-sensitive `String#gsub`. Given the performance decreases inherrent in using regular expressions already, the fact that character classes can essentially account for case-insensitive searches, the desire to keep the DSL simple and the general use cases for this gem, I don't see a good reason to add yet more decision based conditional syntax to accommodate using case-insensitive searches or singular replacements with `String#sub`. If you find yourself wanting either of these features, by all means fork the code base and if you like your changes, submit a pull request.
 
-The behavior when copying nested hierarchical models is undefined. Copying a category model which has a `parent_id` field pointing to the parent category, for example, is currently undefined. The behavior when copying polymorphic `has_many` associations is also undefined. Support for these types of associations is planned for a future release.
+The behavior when copying nested hierarchical models is undefined. Copying a category model which has a `parent_id` field pointing to the parent category, for example, is currently undefined.
+
+The behavior when copying polymorphic `has_many` associations is also undefined. Support for these types of associations is planned for a future release.
 
 ### For Developers
 
@@ -558,10 +616,6 @@ You may run the rspec tests like this:
 
     bundle exec rspec spec
 
-## TODO
-
-Write more tests.... anyone?
-
 ## License
 
 [The BSD License](http://www.opensource.org/licenses/bsd-license.php)

data/lib/amoeba.rb

@@ -41,6 +41,11 @@ module Amoeba
         @clones
       end
 
+      def customizations
+        @customizations ||= []
+        @customizations
+      end
+
       def null_fields
         @null_fields ||= []
         @null_fields
@@ -109,6 +114,17 @@ module Amoeba
         @clones
       end
 
+      def customize(value=nil)
+        @do_preproc ||= true
+        @customizations ||= []
+        if value.is_a?(Array)
+          @customizations = value
+        else
+          @customizations << value if value
+        end
+        @customizations
+      end
+
       def recognize(value=nil)
         @enabled ||= true
         @known_macros ||= []
@@ -245,6 +261,7 @@ module Amoeba
           # actually copy  and reassociate the  new children
           # rather than only maintaining the associations
           self.send(relation_name).each do |old_obj|
+
             copy_of_obj = old_obj.dup
 
             # associate this new child to the new parent object
@@ -334,6 +351,11 @@ module Amoeba
         @result[n] = nil
       end
 
+      # prepend any extra strings to indicate uniqueness of the new record(s)
+      amoeba_conf.customizations.each do |block|
+        block.call(self, @result)
+      end
+
       # prepend any extra strings to indicate uniqueness of the new record(s)
       amoeba_conf.coercions.each do |field,coercion|
         @result[field] = "#{coercion}"

data/lib/amoeba/version.rb

@@ -1,3 +1,3 @@
 module Amoeba
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/lib/amoeba_spec.rb

@@ -57,7 +57,7 @@ describe "amoeba" do
       end_history_count.should     == start_history_count * 2
       end_supercat_count.should    == start_supercat_count * 2
       end_post_count.should        == start_post_count * 2
-      end_comment_count.should     == start_comment_count * 2
+      end_comment_count.should     == (start_comment_count * 2) + 2
       end_rating_count.should      == start_rating_count * 2
       end_postconfig_count.should  == start_postconfig_count * 2
       end_posttag_count.should     == start_posttag_count * 2
@@ -72,6 +72,11 @@ describe "amoeba" do
       new_post.supercats.map(&:other_ramblings).uniq.include?("La la la").should be true
       new_post.title.should == "Copy of #{old_post.title}"
       new_post.contents.should == "Here's a copy: #{old_post.contents.gsub(/dog/, 'cat')} (copied version)"
+      new_post.comments.length.should == 5
+      new_post.comments.select{ |c| c.nerf == 'ratatat' && c.contents.nil? }.length.should == 1
+      new_post.comments.select{ |c| c.nerf == 'ratatat' }.length.should == 2
+      new_post.comments.select{ |c| c.nerf == 'bonk' }.length.should == 1
+      new_post.comments.select{ |c| c.nerf == 'bonkers' && c.contents.nil? }.length.should == 1
 
       new_post.widgets.map(&:id).each do |id|
         old_post.widgets.map(&:id).include?(id).should_not be true

data/spec/support/data.rb

@@ -8,7 +8,7 @@ p1 = t.posts.create(:author => u1, :title => "My little pony", :contents => "Lor
 f1 = p1.create_post_config(:is_visible => true, :is_open => false, :password => 'abcdefg123')
 a1 = p1.create_account(:title => "Foo")
 h1 = p1.account.create_history(:some_stuff => "Bar")
-c1 = p1.comments.create(:contents => "I love it!")
+c1 = p1.comments.create(:contents => "I love it!", :nerf => "ratatat")
 c1.ratings.create(:num_stars => 5)
 c1.ratings.create(:num_stars => 5)
 c1.ratings.create(:num_stars => 4)
@@ -16,7 +16,7 @@ c1.ratings.create(:num_stars => 3)
 c1.ratings.create(:num_stars => 5)
 c1.ratings.create(:num_stars => 5)
 
-c2 = p1.comments.create(:contents => "I hate it!")
+c2 = p1.comments.create(:contents => "I hate it!", :nerf => "whapaow")
 c2.ratings.create(:num_stars => 3)
 c2.ratings.create(:num_stars => 1)
 c2.ratings.create(:num_stars => 4)
@@ -24,7 +24,7 @@ c2.ratings.create(:num_stars => 1)
 c2.ratings.create(:num_stars => 1)
 c2.ratings.create(:num_stars => 2)
 
-c3 = p1.comments.create(:contents => "kthxbbq!!11!!!1!eleven!!")
+c3 = p1.comments.create(:contents => "kthxbbq!!11!!!1!eleven!!", :nerf => "bonk")
 c3.ratings.create(:num_stars => 0)
 c3.ratings.create(:num_stars => 0)
 c3.ratings.create(:num_stars => 1)

data/spec/support/models.rb

@@ -23,9 +23,44 @@ class Post < ActiveRecord::Base
     prepend :title => "Copy of "
     append :contents => " (copied version)"
     regex :contents => {:replace => /dog/, :with => 'cat'}
+    customize([
+      lambda do |orig_obj,copy_of_obj|
+        orig_obj.comments.each do |oc|
+          if oc.nerf == "ratatat"
+            hash = oc.attributes
+            hash[:id]       = nil
+            hash[:post_id]  = nil
+            hash[:contents] = nil
+
+            cc = Comment.new(hash)
+
+            copy_of_obj.comments << cc
+          end
+        end
+      end,
+      lambda do |orig_obj,copy_of_obj|
+        orig_obj.comments.each do |oc|
+          if oc.nerf == "bonk"
+            hash = oc.attributes
+            hash[:id]       = nil
+            hash[:post_id]  = nil
+            hash[:contents] = nil
+            hash[:nerf]     = "bonkers"
+
+            cc = Comment.new(hash)
+
+            copy_of_obj.comments << cc
+          end
+        end
+      end
+    ])
   end
 end
 
+class CustomThing < ActiveRecord::Base
+  belongs_to :post
+end
+
 class Account < ActiveRecord::Base
   belongs_to :post
   has_one :history

data/spec/support/schema.rb

@@ -29,9 +29,15 @@ ActiveRecord::Schema.define do
     t.timestamps
   end
 
+  create_table :custom_things, :force => true do |t|
+    t.string :value
+    t.timestamps
+  end
+
   create_table :comments, :force => true do |t|
     t.integer :post_id
     t.string :contents
+    t.string :nerf
     t.timestamps
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amoeba
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-21 00:00:00.000000000 Z
+date: 2012-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &12789100 !ruby/object:Gem::Requirement
+  requirement: &8806100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *12789100
+  version_requirements: *8806100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &12788540 !ruby/object:Gem::Requirement
+  requirement: &8805580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.3'
   type: :development
   prerelease: false
-  version_requirements: *12788540
+  version_requirements: *8805580
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &12788080 !ruby/object:Gem::Requirement
+  requirement: &8805180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12788080
+  version_requirements: *8805180
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &12787380 !ruby/object:Gem::Requirement
+  requirement: &8804640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *12787380
+  version_requirements: *8804640
 description: ! 'An extension to ActiveRecord to allow the duplication method to also
   copy associated children, with recursive support for nested of grandchildren. The
   behavior is controllable with a simple DSL both on your rails models and on the