amoeba 0.1.2 → 1.0.0

data/README.md

@@ -25,9 +25,11 @@ 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 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.
 - Amoeba can perform the following preprocessing operations on fields of copied records
+    - set
     - prepend
     - append
     - nullify
@@ -133,7 +135,7 @@ Using the inclusive style within the amoeba block actually implies that you wish
       belongs_to :post
     end
 
-You may also specify fields to be copied by passing an array.
+You may also specify fields to be copied by passing an array. If you call the `include_field` with a single value, it will be appended to the list of already included fields. If you pass an array, your array will overwrite the original values.
 
     class Post < ActiveRecord::Base
       has_many :comments
@@ -171,6 +173,38 @@ If you have more fields to include than to exclude, you may wish to shorten the
 
 This example does the same thing as the inclusive style example, it will copy the post's tags and authors but not its comments. As with inclusive style, there is no need to explicitly enable amoeba when specifying fields to exclude.
 
+### Cloning
+
+If you are using a Many-to-Many relationship, you may tell amoeba to actually make duplicates of the original related records rather than merely maintaining association with the original records. Cloning is easy, merely tell amoeba which fields to clone in the same way you tell it which fields to include or exclude.
+
+    class Post < ActiveRecord::Base
+      has_and_belongs_to_many :warnings
+
+      has_many :post_widgets
+      has_many :widgets, :through => :post_widgets
+
+      amoeba do
+        enable
+        clone [:widgets, :tags]
+      end
+    end
+
+    class Warning < ActiveRecord::Base
+      has_and_belongs_to_many :posts
+    end
+
+    class PostWidget < ActiveRecord::Base
+      belongs_to :widget
+      belongs_to :post
+    end
+
+    class Widget < ActiveRecord::Base
+      has_many :post_widgets
+      has_many :posts, :through => :post_widgets
+    end
+
+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
 
 By default, amoeba recognizes and attemps to copy any children of the following association types:
@@ -230,6 +264,18 @@ This example will copy all of a post's comments. It will also nullify the publis
 
 Unlike inclusive and exclusive styles, specifying null fields will not automatically enable amoeba to copy all child records. As with any active record object, the default field value will be used instead of `nil` if a default value exists on the migration.
 
+#### Set
+
+If you wish to just set a field to an aribrary value on all duplicated objects you may use the `set` directive. For example, if you wanted to copy an object that has some kind of approval process associated with it, you likely may wish to set the new object's state to be open or "in progress" again.
+
+    class Post < ActiveRecord::Base
+      amoeba do
+        set :state_tracker => "open_for_editing"
+      end
+    end
+
+In this example, when a post is duplicated, it's `state_tracker` field will always be given a value of `open_for_editing` to start.
+
 #### Prepend
 
 You may add a string to the beginning of a copied object's field during the copy phase:

data/lib/amoeba.rb

@@ -1,3 +1,4 @@
+require "active_record"
 require "amoeba/version"
 
 module Amoeba
@@ -20,6 +21,11 @@ module Amoeba
         @do_preproc
       end
 
+      def known_macros
+        @known_macros ||= [:has_one, :has_many, :has_and_belongs_to_many]
+        @known_macros
+      end
+
       def includes
         @includes ||= []
         @includes
@@ -30,9 +36,9 @@ module Amoeba
         @excludes
       end
 
-      def known_macros
-        @known_macros ||= [:has_one, :has_many, :has_and_belongs_to_many]
-        @known_macros
+      def clones
+        @clones ||= []
+        @clones
       end
 
       def null_fields
@@ -40,6 +46,11 @@ module Amoeba
         @null_fields
       end
 
+      def coercions
+        @coercions ||= {}
+        @coercions
+      end
+
       def prefixes
         @prefixes ||= {}
         @prefixes
@@ -87,6 +98,17 @@ module Amoeba
         @excludes
       end
 
+      def clone(value=nil)
+        @enabled ||= true
+        @clones ||= []
+        if value.is_a?(Array)
+          @clones = value
+        else
+          @clones << value if value
+        end
+        @clones
+      end
+
       def recognize(value=nil)
         @enabled ||= true
         @known_macros ||= []
@@ -109,6 +131,25 @@ module Amoeba
         @null_fields
       end
 
+      def set(defs=nil)
+        @do_preproc ||= true
+        @coercions ||= {}
+        if defs.is_a?(Array)
+          @coercions = {}
+
+          defs.each do |d|
+            d.each do |k,v|
+              @coercions[k] = v if v
+            end
+          end
+        else
+          defs.each do |k,v|
+            @coercions[k] = v if v
+          end
+        end
+        @coercions
+      end
+
       def prepend(defs=nil)
         @do_preproc ||= true
         @prefixes ||= {}
@@ -194,25 +235,54 @@ module Amoeba
           @result.send(:"#{relation_name}=", copy_of_obj)
         end
       when :has_many
-        # copying the children of the regular has many will
-        # effectively do what is desired anyway, the through
-        # association is really just for convenience usage
-        # on the model
-        if settings.is_a?(ActiveRecord::Reflection::ThroughReflection)
-          return
+        clone = amoeba_conf.clones.include?(:"#{relation_name}")
+
+        # this could  be DRYed up for  better readability by
+        # duplicating the loop code, but I'm duplicating the
+        # loops to avoid that extra check on each iteration
+        if clone
+          # This  is  a  M:M  "has many  through"  where  we
+          # 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
+            @result.send(relation_name) << copy_of_obj
+          end
+        else
+          # This is a regular 1:M "has many"
+          #
+          # copying the children of the regular has many will
+          # effectively do what is desired anyway, the through
+          # association is really just for convenience usage
+          # on the model
+          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[:"#{settings.foreign_key}"] = nil
+
+            # associate this new child to the new parent object
+            @result.send(relation_name) << copy_of_obj
+          end
         end
 
-        self.send(relation_name).each do |old_obj|
-          copy_of_obj = old_obj.dup
-          copy_of_obj[:"#{settings.foreign_key}"] = nil
-
-          # associate this new child to the new parent object
-          @result.send(relation_name) << copy_of_obj
-        end
       when :has_and_belongs_to_many
-        self.send(relation_name).each do |old_obj|
-          # associate this new child to the new parent object
-          @result.send(relation_name) << old_obj
+        clone = amoeba_conf.clones.include?(relation_name)
+
+        if clone
+          self.send(relation_name).each do |old_obj|
+            copy_of_obj = old_obj.dup
+
+            # associate this new child to the new parent object
+            @result.send(relation_name) << copy_of_obj
+          end
+        else
+          self.send(relation_name).each do |old_obj|
+            # associate this new child to the new parent object
+            @result.send(relation_name) << old_obj
+          end
         end
       end
     end
@@ -220,6 +290,18 @@ module Amoeba
     def dup(options={})
       @result = super()
 
+      amoeba_conf.clones.each do |clone_field|
+        r = self.class.reflect_on_association clone_field
+
+        # if this is a has many through and we're gonna deep
+        # copy the  child records, exclude the  regular join
+        # table from copying so we don't end up with the new
+        # and old children on the copy
+        if r.macro == :has_many && r.is_a?(ActiveRecord::Reflection::ThroughReflection)
+          amoeba_conf.exclude_field r.options[:through]
+        end
+      end
+
       if amoeba_conf.enabled
         if amoeba_conf.includes.count > 0
           amoeba_conf.includes.each do |i|
@@ -252,6 +334,11 @@ module Amoeba
         @result[n] = nil
       end
 
+      # prepend any extra strings to indicate uniqueness of the new record(s)
+      amoeba_conf.coercions.each do |field,coercion|
+        @result[field] = "#{coercion}"
+      end
+
       # prepend any extra strings to indicate uniqueness of the new record(s)
       amoeba_conf.prefixes.each do |field,prefix|
         @result[field] = "#{prefix}#{@result[field]}"

data/lib/amoeba/version.rb

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

data/spec/lib/amoeba_spec.rb

@@ -18,12 +18,18 @@ describe "amoeba" do
       start_cat_count = Category.all.count
       start_supercat_count = Supercat.all.count
       start_tag_count = Tag.all.count
+      start_note_count = Note.all.count
+      start_widget_count = Widget.all.count
       start_post_count = Post.all.count
       start_comment_count = Comment.all.count
       start_rating_count = Rating.all.count
       start_postconfig_count = PostConfig.all.count
+      start_postwidget_count = PostWidget.all.count
+      start_superkitten_count = Superkitten.all.count
       rs = ActiveRecord::Base.connection.select_one('SELECT COUNT(*) AS tag_count FROM posts_tags')
       start_posttag_count = rs["tag_count"]
+      rs = ActiveRecord::Base.connection.select_one('SELECT COUNT(*) AS note_count FROM notes_posts')
+      start_postnote_count = rs["note_count"]
 
       new_post.save
 
@@ -32,12 +38,18 @@ describe "amoeba" do
       end_cat_count = Category.all.count
       end_supercat_count = Supercat.all.count
       end_tag_count = Tag.all.count
+      end_note_count = Note.all.count
+      end_widget_count = Widget.all.count
       end_post_count = Post.all.count
       end_comment_count = Comment.all.count
       end_rating_count = Rating.all.count
       end_postconfig_count = PostConfig.all.count
+      end_postwidget_count = PostWidget.all.count
+      end_superkitten_count = Superkitten.all.count
       rs = ActiveRecord::Base.connection.select_one('SELECT COUNT(*) AS tag_count FROM posts_tags')
       end_posttag_count = rs["tag_count"]
+      rs = ActiveRecord::Base.connection.select_one('SELECT COUNT(*) AS note_count FROM notes_posts')
+      end_postnote_count = rs["note_count"]
 
       end_tag_count.should         == start_tag_count
       end_cat_count.should         == start_cat_count
@@ -49,10 +61,21 @@ describe "amoeba" do
       end_rating_count.should      == start_rating_count * 2
       end_postconfig_count.should  == start_postconfig_count * 2
       end_posttag_count.should     == start_posttag_count * 2
+      end_widget_count.should      == start_widget_count * 2
+      end_postwidget_count.should  == start_postwidget_count * 2
+      end_note_count.should        == start_note_count * 2
+      end_postnote_count.should    == start_postnote_count * 2
+      end_superkitten_count.should == start_superkitten_count * 2
 
       new_post.supercats.map(&:ramblings).include?("Copy of zomg").should be true
+      new_post.supercats.map(&:other_ramblings).uniq.length.should == 1
+      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.widgets.map(&:id).each do |id|
+        old_post.widgets.map(&:id).include?(id).should_not be true
+      end
     end
   end
 end

data/spec/support/data.rb

@@ -41,11 +41,41 @@ p1.tags << t2
 p1.tags << t3
 p1.save
 
+w1 = Widget.create(:value => "My Sidebar")
+w2 = Widget.create(:value => "Photo Gallery")
+w3 = Widget.create(:value => "Share & Like")
+
+p1.widgets << w1
+p1.widgets << w2
+p1.widgets << w3
+p1.save
+
+n1 = Note.create(:value => "This is important")
+n2 = Note.create(:value => "You've been warned")
+n3 = Note.create(:value => "Don't forget")
+
+p1.notes << n1
+p1.notes << n2
+p1.notes << n3
+p1.save
+
 c1 = Category.create(:title => "Umbrellas", :description => "Clown fart")
 c2 = Category.create(:title => "Widgets", :description => "Humpty dumpty")
 c3 = Category.create(:title => "Wombats", :description => "Slushy mushy")
 
-Supercat.create(:post => p1, :category => c1, :ramblings => "zomg")
-Supercat.create(:post => p1, :category => c2, :ramblings => "why")
-Supercat.create(:post => p1, :category => c3, :ramblings => "ohnoes")
+s1 = Supercat.create(:post => p1, :category => c1, :ramblings => "zomg", :other_ramblings => "nerp")
+s2 = Supercat.create(:post => p1, :category => c2, :ramblings => "why", :other_ramblings => "narp")
+s3 = Supercat.create(:post => p1, :category => c3, :ramblings => "ohnoes", :other_ramblings => "blap")
+
+s1.superkittens.create(:value => "Fluffy")
+s1.superkittens.create(:value => "Buffy")
+s1.superkittens.create(:value => "Fuzzy")
+
+s2.superkittens.create(:value => "Hairball")
+s2.superkittens.create(:value => "Crosseye")
+s2.superkittens.create(:value => "Spot")
+
+s3.superkittens.create(:value => "Dopey")
+s3.superkittens.create(:value => "Sneezy")
+s3.superkittens.create(:value => "Sleepy")
 # }}}

data/spec/support/models.rb

@@ -11,10 +11,15 @@ class Post < ActiveRecord::Base
   has_many :comments
   has_many :supercats
   has_many :categories, :through => :supercats
+  has_many :post_widgets
+  has_many :widgets, :through => :post_widgets
   has_and_belongs_to_many :tags
+  has_and_belongs_to_many :notes
+  #has_and_belongs_to_many :tags
 
   amoeba do
     enable
+    clone [:widgets, :notes]
     prepend :title => "Copy of "
     append :contents => " (copied version)"
     regex :contents => {:replace => /dog/, :with => 'cat'}
@@ -37,17 +42,30 @@ end
 class Category < ActiveRecord::Base
   has_many :supercats
   has_many :posts, :through => :supercats
+
+  amoeba do
+    enable
+    prepend :ramblings => "Copy of "
+    set :other_ramblings => "La la la"
+  end
 end
 
 class Supercat < ActiveRecord::Base
   belongs_to :post
   belongs_to :category
+  has_many :superkittens
 
   amoeba do
+    include_field :superkittens
     prepend :ramblings => "Copy of "
+    set :other_ramblings => "La la la"
   end
 end
 
+class Superkitten < ActiveRecord::Base
+  belongs_to :supercat
+end
+
 class PostConfig < ActiveRecord::Base
   belongs_to :post
 end
@@ -55,20 +73,39 @@ end
 class Comment < ActiveRecord::Base
   belongs_to :post
   has_many :ratings
+  has_many :reviews
 
   amoeba do
-    enable
+    exclude_field :reviews
   end
 end
 
+class Review < ActiveRecord::Base
+  belongs_to :comment
+end
+
 class Rating < ActiveRecord::Base
   belongs_to :comment
 end
 
+class Widget < ActiveRecord::Base
+  has_many :post_widgets
+  has_many :posts, :through => :post_widgets
+end
+
+class PostWidget < ActiveRecord::Base
+  belongs_to :post
+  belongs_to :widget
+end
+
 class Tag < ActiveRecord::Base
   has_and_belongs_to_many :posts
 end
 
+class Note < ActiveRecord::Base
+  has_and_belongs_to_many :posts
+end
+
 class User < ActiveRecord::Base
   has_many :posts
 end

data/spec/support/schema.rb

@@ -42,7 +42,6 @@ ActiveRecord::Schema.define do
   end
 
   create_table :tags, :force => true do |t|
-    t.integer :post_id
     t.string :value
     t.timestamps
   end
@@ -59,6 +58,25 @@ ActiveRecord::Schema.define do
     t.integer :tag_id
   end
 
+  create_table :notes, :force => true do |t|
+    t.string :value
+    t.timestamps
+  end
+
+  create_table :notes_posts, :force => true do |t|
+    t.integer :post_id
+    t.integer :note_id
+  end
+
+  create_table :widgets, :force => true do |t|
+    t.string :value
+  end
+
+  create_table :post_widgets, :force => true do |t|
+    t.integer :post_id
+    t.integer :widget_id
+  end
+
   create_table :categories, :force => true do |t|
     t.string :title
     t.string :description
@@ -68,6 +86,13 @@ ActiveRecord::Schema.define do
     t.integer :post_id
     t.integer :category_id
     t.string :ramblings
+    t.string :other_ramblings
+    t.timestamps
+  end
+
+  create_table :superkittens, :force => true do |t|
+    t.integer :supercat_id
+    t.string :value
     t.timestamps
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amoeba
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-28 00:00:00.000000000 Z
+date: 2012-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &22165920 !ruby/object:Gem::Requirement
+  requirement: &12789100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *22165920
+  version_requirements: *12789100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &22165380 !ruby/object:Gem::Requirement
+  requirement: &12788540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.3'
   type: :development
   prerelease: false
-  version_requirements: *22165380
+  version_requirements: *12788540
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &22164980 !ruby/object:Gem::Requirement
+  requirement: &12788080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22164980
+  version_requirements: *12788080
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &22164300 !ruby/object:Gem::Requirement
+  requirement: &12787380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *22164300
+  version_requirements: *12787380
 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