replicate 1.5 → 1.5.1

data/README.md

@@ -137,6 +137,12 @@ class User < ActiveRecord::Base
 end
 ```
 
+You may also do this by passing an option in your dump script:
+
+```ruby
+dump User.all, :associations => [:email_addresses]
+```
+
 ### Natural Keys
 
 By default, the loader attempts to create a new record with a new primary key id
@@ -178,6 +184,12 @@ end
 
 You can omit belongs_to associations by omitting the foreign key column.
 
+You may also do this by passing an option in your dump script:
+
+```ruby
+dump User.all, :omit => [:profile]
+```
+
 ### Validations and Callbacks
 
 __IMPORTANT:__ All ActiveRecord validations and callbacks are disabled on the
@@ -211,7 +223,7 @@ the `dump_replicant` and `load_replicant` methods.
 
 ### dump_replicant
 
-The dump side calls `#dump_replicant(dumper)` on each object. The method must
+The dump side calls `#dump_replicant(dumper, opts={})` on each object. The method must
 call `dumper.write()` with the class name, id, and hash of primitively typed
 attributes for the object:
 
@@ -220,7 +232,7 @@ class User
   attr_reader   :id
   attr_accessor :name, :email
 
-  def dump_replicant(dumper)
+  def dump_replicant(dumper, opts={})
     attributes = { 'name' => name, 'email' => email }
     dumper.write self.class, id, attributes, self
   end

data/lib/replicate/active_record.rb

@@ -19,15 +19,28 @@ module Replicate
       #          type, id, and attributes hash.
       #
       # Returns nothing.
-      def dump_replicant(dumper)
+      def dump_replicant(dumper, opts={})
+        @replicate_opts = opts
+        @replicate_opts[:associations] ||= []
+        @replicate_opts[:omit] ||= []
         dump_all_association_replicants dumper, :belongs_to
         dumper.write self.class.to_s, id, replicant_attributes, self
         dump_all_association_replicants dumper, :has_one
-        self.class.replicate_associations.each do |association|
+        included_associations.each do |association|
           dump_association_replicants dumper, association
         end
       end
 
+      # List of associations to explicitly include when dumping this object.
+      def included_associations
+        (self.class.replicate_associations + @replicate_opts[:associations]).uniq
+      end
+
+      # List of attributes and associations to omit when dumping this object.
+      def omitted_attributes
+        (self.class.replicate_omit_attributes + @replicate_opts[:omit]).uniq
+      end
+
       # Attributes hash used to persist this object. This consists of simply
       # typed values (no complex types or objects) with the exception of special
       # foreign key values. When an attribute value is [:id, "SomeClass:1234"],
@@ -35,39 +48,68 @@ module Replicate
       # version of the same object.
       def replicant_attributes
         attributes = self.attributes.dup
-        self.class.replicate_omit_attributes.each do |omit|
-          attributes.delete(omit.to_s)
-        end
+
+        omitted_attributes.each { |omit| attributes.delete(omit.to_s) }
         self.class.reflect_on_all_associations(:belongs_to).each do |reflection|
-          options = reflection.options
-          if options[:polymorphic]
-            if ::ActiveRecord::VERSION::MAJOR == 3 && ::ActiveRecord::VERSION::MINOR > 0
-              reference_class = attributes[reflection.foreign_type]
-            else
-              reference_class = attributes[options[:foreign_type]]
+          if info = replicate_reflection_info(reflection)
+            if replicant_id = info[:replicant_id]
+              foreign_key = info[:foreign_key].to_s
+              attributes[foreign_key] = [:id, *replicant_id]
             end
-            next if reference_class.nil?
-
-            klass = Kernel.const_get(reference_class)
-            primary_key = klass.primary_key
-            foreign_key = "#{reflection.name}_id"
-          else
-            klass = reflection.klass
-            primary_key = (options[:primary_key] || klass.primary_key).to_s
-            foreign_key = (options[:foreign_key] || "#{reflection.name}_id").to_s
           end
-          if primary_key == klass.primary_key
-            if id = attributes[foreign_key]
-              attributes[foreign_key] = [:id, klass.to_s, id]
+        end
+
+        attributes
+      end
+
+      # Retrieve information on a reflection's associated class and various
+      # keys.
+      #
+      # Returns an info hash with these keys:
+      #   :class - The class object the association points to.
+      #   :primary_key  - The string primary key column name.
+      #   :foreign_key  - The string foreign key column name.
+      #   :replicant_id - The [classname, id] tuple identifying the record.
+      #
+      # Returns nil when the reflection can not be linked to a model.
+      def replicate_reflection_info(reflection)
+        options = reflection.options
+        if options[:polymorphic]
+          reference_class =
+            if ::ActiveRecord::VERSION::MAJOR == 3 && ::ActiveRecord::VERSION::MINOR > 0
+              attributes[reflection.foreign_type]
             else
-              # nil value in association reference
+              attributes[options[:foreign_type]]
             end
+          return if reference_class.nil?
+
+          klass = Kernel.const_get(reference_class)
+          primary_key = klass.primary_key
+          foreign_key = "#{reflection.name}_id"
+        else
+          klass = reflection.klass
+          primary_key = (options[:primary_key] || klass.primary_key).to_s
+          foreign_key = (options[:foreign_key] || "#{reflection.name}_id").to_s
+        end
+
+        info = {
+          :class       => klass,
+          :primary_key => primary_key,
+          :foreign_key => foreign_key
+        }
+
+        if primary_key == klass.primary_key
+          if id = attributes[foreign_key]
+            info[:replicant_id] = [klass.to_s, id]
           else
-            # association uses non-primary-key foreign key. no special key
-            # conversion needed.
+            # nil value in association reference
           end
+        else
+          # association uses non-primary-key foreign key. no special key
+          # conversion needed.
         end
-        attributes
+
+        info
       end
 
       # The replicant id is a two tuple containing the class and object id. This
@@ -85,11 +127,25 @@ module Replicate
       # Returns nothing.
       def dump_all_association_replicants(dumper, association_type)
         self.class.reflect_on_all_associations(association_type).each do |reflection|
-          next if self.class.replicate_omit_attributes.include?(reflection.name)
+          next if omitted_attributes.include?(reflection.name)
+
+          # bail when this object has already been dumped
+          next if (info = replicate_reflection_info(reflection)) &&
+            (replicant_id = info[:replicant_id]) &&
+            dumper.dumped?(replicant_id)
+
           next if (dependent = __send__(reflection.name)).nil?
+
           case dependent
           when ActiveRecord::Base, Array
             dumper.dump(dependent)
+
+            # clear reference to allow GC
+            if respond_to?(:association)
+              association(reflection.name).reset
+            elsif respond_to?(:association_instance_set, true)
+              association_instance_set(reflection.name, nil)
+            end
           else
             warn "warn: #{self.class}##{reflection.name} #{association_type} association " \
                  "unexpectedly returned a #{dependent.class}. skipping."
@@ -110,6 +166,7 @@ module Replicate
           if reflection.macro == :has_and_belongs_to_many
             dump_has_and_belongs_to_many_replicant(dumper, reflection)
           end
+          __send__(reflection.name).reset # clear to allow GC
         else
           warn "error: #{self.class}##{association} is invalid"
         end
@@ -284,7 +341,7 @@ module Replicate
         }
       end
 
-      def dump_replicant(dumper)
+      def dump_replicant(dumper, opts={})
         type = self.class.name
         id   = "#{@object.class.to_s}:#{@reflection.name}:#{@object.id}"
         dumper.write type, id, attributes, self

data/lib/replicate/dumper.rb

@@ -69,11 +69,18 @@ module Replicate
     #
     # Returns nothing.
     def dump(*objects)
+      opts = if objects.last.is_a? Hash
+        objects.pop
+      else
+        {}
+      end
       objects = objects[0] if objects.size == 1 && objects[0].respond_to?(:to_ary)
       objects.each do |object|
         next if object.nil? || dumped?(object)
         if object.respond_to?(:dump_replicant)
-          object.dump_replicant(self)
+          args = [self]
+          args << opts unless object.method(:dump_replicant).arity == 1
+          object.dump_replicant(*args)
         else
           raise NoMethodError, "#{object.class} must respond to #dump_replicant"
         end

data/lib/replicate/object.rb

@@ -40,7 +40,7 @@ module Replicate
       value
     end
 
-    def dump_replicant(dumper)
+    def dump_replicant(dumper, opts={})
       dumper.write self.class, @id, @attributes, self
     end
 

data/test/active_record_test.rb

@@ -293,6 +293,59 @@ class ActiveRecordTest < Test::Unit::TestCase
     assert_equal rtomayko.emails.last, obj
   end
 
+  def test_dumping_associations_at_dump_time
+    objects = []
+    @dumper.listen { |type, id, attrs, obj| objects << [type, id, attrs, obj] }
+
+    rtomayko = User.find_by_login('rtomayko')
+    @dumper.dump rtomayko, :associations => [:emails], :omit => [:profile]
+
+    assert_equal 3, objects.size
+
+    type, id, attrs, obj = objects.shift
+    assert_equal 'User', type
+    assert_equal rtomayko.id, id
+    assert_equal 'rtomayko', attrs['login']
+    assert_equal rtomayko.created_at, attrs['created_at']
+    assert_equal rtomayko, obj
+
+    type, id, attrs, obj = objects.shift
+    assert_equal 'Email', type
+    assert_equal 'ryan@github.com', attrs['email']
+    assert_equal [:id, 'User', rtomayko.id], attrs['user_id']
+    assert_equal rtomayko.emails.first, obj
+
+    type, id, attrs, obj = objects.shift
+    assert_equal 'Email', type
+    assert_equal 'rtomayko@gmail.com', attrs['email']
+    assert_equal [:id, 'User', rtomayko.id], attrs['user_id']
+    assert_equal rtomayko.emails.last, obj
+  end
+
+  def test_dumping_many_associations_at_dump_time
+    objects = []
+    @dumper.listen { |type, id, attrs, obj| objects << [type, id, attrs, obj] }
+
+    users = User.all(:conditions => {:login => %w[rtomayko kneath]})
+    @dumper.dump users, :associations => [:emails], :omit => [:profile]
+
+    assert_equal 5, objects.size
+    assert_equal ['Email', 'Email', 'Email', 'User', 'User'], objects.map { |type,_,_| type }.sort
+  end
+
+  def test_omit_attributes_at_dump_time
+    objects = []
+    @dumper.listen { |type, id, attrs, obj| objects << [type, id, attrs, obj] }
+
+    rtomayko = User.find_by_login('rtomayko')
+    @dumper.dump rtomayko, :omit => [:created_at]
+
+    type, id, attrs, obj = objects.shift
+    assert_equal 'User', type
+    assert attrs['updated_at']
+    assert_nil attrs['created_at']
+  end
+
   def test_dumping_polymorphic_associations
     objects = []
     @dumper.listen { |type, id, attrs, obj| objects << [type, id, attrs, obj] }

metadata

@@ -1,60 +1,55 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: replicate
-version: !ruby/object:Gem::Version 
-  hash: 5
+version: !ruby/object:Gem::Version
+  version: 1.5.1
   prerelease: 
-  segments: 
-  - 1
-  - 5
-  version: "1.5"
 platform: ruby
-authors: 
+authors:
 - Ryan Tomayko
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-19 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 3
-        - 1
-        version: "3.1"
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Dump and load relational objects between Ruby environments.
 email: ryan@github.com
-executables: 
+executables:
 - replicate
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - COPYING
 - HACKING
 - README.md
@@ -72,41 +67,31 @@ files:
 - test/dumpscript.rb
 - test/loader_test.rb
 - test/replicate_test.rb
-has_rdoc: true
 homepage: http://github.com/rtomayko/replicate
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 2
 summary: Dump and load relational objects between Ruby environments.
-test_files: 
+test_files:
 - test/active_record_test.rb
 - test/dumper_test.rb
 - test/loader_test.rb