replicate 1.3 → 1.4

data/README.md

@@ -18,7 +18,7 @@ Synopsis
 
 ### Dumping objects
 
-Evaluate a Ruby expression, dumping all resulting to standard output:
+Evaluate a Ruby expression, dumping all resulting objects to standard output:
 
     $ replicate -r ./config/environment -d "User.find(1)" > user.dump
     ==> dumped 4 total objects:
@@ -163,6 +163,21 @@ end
 Multiple attribute names may be specified to define a compound key. Foreign key
 column attributes (`user_id`) are often included in natural keys.
 
+### Omission of attributes and associations
+
+You might want to exclude some attributes or associations from being dumped. For
+this, use the replicate_omit_attributes macro:
+
+```ruby
+class User < ActiveRecord::Base
+  has_one    :profile
+
+  replicate_omit_attributes :created_at, :profile
+end
+```
+
+You can omit belongs_to associations by omitting the foreign key column.
+
 ### Validations and Callbacks
 
 __IMPORTANT:__ All ActiveRecord validations and callbacks are disabled on the
@@ -206,8 +221,8 @@ class User
   attr_accessor :name, :email
 
   def dump_replicant(dumper)
-    attributes { 'name' => name, 'email' => email }
-    dumper.write self.class, id, attributes
+    attributes = { 'name' => name, 'email' => email }
+    dumper.write self.class, id, attributes, self
   end
 end
 ```

data/bin/replicate

@@ -23,6 +23,8 @@
 #/   -v, --verbose        Write more status output.
 #/   -q, --quiet          Write less status output.
 $stderr.sync = true
+$stdout = $stderr
+
 require 'optparse'
 
 # default options
@@ -30,7 +32,7 @@ mode     = nil
 verbose  = false
 quiet    = false
 keep_id  = false
-out      = $stdout
+out      = STDOUT
 force    = false
 
 # parse arguments
@@ -67,6 +69,9 @@ if mode == :dump
     ARGV.each do |code|
       if File.exist?(code)
         dumper.load_script code
+      elsif code == '-'
+        code = $stdin.read
+        objects = dumper.instance_eval(code, '<stdin>', 0)
       else
         objects = dumper.instance_eval(code, '<argv>', 0)
         dumper.dump objects

data/lib/replicate/active_record.rb

@@ -35,10 +35,25 @@ module Replicate
       # version of the same object.
       def replicant_attributes
         attributes = self.attributes.dup
-        self.class.reflect_on_all_associations(:belongs_to).each do |reflection|
-          foreign_key = (reflection.options[:foreign_key] || "#{reflection.name}_id").to_s
-          if id = attributes[foreign_key]
-            attributes[foreign_key] = [:id, reflection.klass.to_s, id]
+        self.class.replicate_omit_attributes.each do |omit|
+          attributes.delete(omit.to_s)
+        end
+        self.class.reflect_on_all_associations(:belongs_to).select {|association|
+          association.options[:polymorphic] != true
+        }.each do |reflection|
+          klass = reflection.klass
+          options = reflection.options
+          primary_key = (options[:primary_key] || klass.primary_key).to_s
+          foreign_key = (options[:foreign_key] || "#{reflection.name}_id").to_s
+          if primary_key == klass.primary_key
+            if id = attributes[foreign_key]
+              attributes[foreign_key] = [:id, reflection.klass.to_s, id]
+            else
+              # nil value in association reference
+            end
+          else
+            # association uses non-primary-key foreign key. no special key
+            # conversion needed.
           end
         end
         attributes
@@ -59,6 +74,7 @@ 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 (dependent = __send__(reflection.name)).nil?
           case dependent
           when ActiveRecord::Base, Array
@@ -141,6 +157,23 @@ module Replicate
         @replicate_id = boolean
       end
 
+      # Set which, if any, attributes should not be dumped. Also works for
+      # associations.
+      #
+      # attribute_names - Macro style setter.
+      def replicate_omit_attributes(*attribute_names)
+        self.replicate_omit_attributes = attribute_names if attribute_names.any?
+        @replicate_omit_attributes || superclass.replicate_omit_attributes
+      end
+
+      # Set which, if any, attributes should not be dumped. Also works for
+      # associations.
+      # 
+      # attribute_names - Array of attribute name symbols
+      def replicate_omit_attributes=(attribute_names)
+        @replicate_omit_attributes = attribute_names
+      end
+
       # Load an individual record into the database. If the models defines a
       # replicate_natural_key then an existing record will be updated if found
       # instead of a new record being created.
@@ -276,6 +309,7 @@ module Replicate
     ::ActiveRecord::Base.send :extend,  ClassMethods
     ::ActiveRecord::Base.replicate_associations = []
     ::ActiveRecord::Base.replicate_natural_key  = []
+    ::ActiveRecord::Base.replicate_omit_attributes  = []
     ::ActiveRecord::Base.replicate_id           = false
   end
 end

data/lib/replicate/dumper.rb

@@ -49,11 +49,16 @@ module Replicate
       use Replicate::Status, 'dump', out, verbose, quiet
     end
 
-    # Load a dump script. This just evals the source of the file in the context
-    # of the dumper. Dump scripts are useful when you want to dump a lot of
-    # stuff.
+    # Load a dump script. This evals the source of the file in the context
+    # of a special object with a #dump method that forwards to this instance.
+    # Dump scripts are useful when you want to dump a lot of stuff. Call the
+    # dump method as many times as necessary to dump all objects.
     def load_script(file)
-      instance_eval File.read(file), file, 0
+      dumper = self
+      object = ::Object.new
+      meta = (class<<object;self;end)
+      meta.send(:define_method, :dump) { |*args| dumper.dump(*args) }
+      object.instance_eval File.read(file), file, 0
     end
 
     # Dump one or more objects to the internal array or provided dump

data/lib/replicate/loader.rb

@@ -71,7 +71,7 @@ module Replicate
     # Returns the new object instance.
     def load(type, id, attributes)
       model_class = constantize(type)
-      translate_ids attributes
+      translate_ids type, id, attributes
       begin
         new_id, instance = model_class.load_replicant(type, id, attributes)
       rescue => boom
@@ -91,16 +91,17 @@ module Replicate
     #       ... }
     # These values are translated to local system ids. All object
     # references must be loaded prior to the referencing object.
-    def translate_ids(attributes)
+    def translate_ids(type, id, attributes)
       attributes.each do |key, value|
         next unless value.is_a?(Array) && value[0] == :id
-        type, value = value[1].to_s, value[2]
+        referenced_type, value = value[1].to_s, value[2]
         local_ids =
           Array(value).map do |remote_id|
-            if local_id = @keymap[type][remote_id]
+            if local_id = @keymap[referenced_type][remote_id]
               local_id
             else
-              warn "error: #{type} #{remote_id} missing from keymap"
+              warn "warn: #{referenced_type}(#{remote_id}) not in keymap, " +
+                   "referenced by #{type}(#{id})##{key}"
             end
           end
         if value.is_a?(Array)
@@ -122,12 +123,30 @@ module Replicate
       end
     end
 
-
-    # Turn a string into an object by traversing constants.
-    def constantize(string)
-      namespace = Object
-      string.split('::').each { |name| namespace = namespace.const_get(name) }
-      namespace
+    # Turn a string into an object by traversing constants. Identical to
+    # ActiveSupport's String#constantize implementation.
+    if Module.method(:const_get).arity == 1
+      # 1.8 implementation doesn't have the inherit argument to const_defined?
+      def constantize(string)
+        string.split('::').inject ::Object do |namespace, name|
+          if namespace.const_defined?(name)
+            namespace.const_get(name)
+          else
+            namespace.const_missing(name)
+          end
+        end
+      end
+    else
+      # 1.9 implement has the inherit argument to const_defined?. Use it!
+      def constantize(string)
+        string.split('::').inject ::Object do |namespace, name|
+          if namespace.const_defined?(name, false)
+            namespace.const_get(name)
+          else
+            namespace.const_missing(name)
+          end
+        end
+      end
     end
   end
 end

data/lib/replicate/status.rb

@@ -27,10 +27,7 @@ module Replicate
     end
 
     def normal_log(type, id, attrs, object)
-      message = "  %sing: %4d objects" % [@prefix, @count]
-      dots = '.' * (@count % 50)
-      dots = ' ' * 50 if dots.empty?
-      @out.write "#{message} #{dots}\r"
+      @out.write "  %sing: %4d objects    \r" % [@prefix, @count]
     end
 
     def complete

data/test/active_record_test.rb

@@ -6,7 +6,8 @@ version = ENV['AR_VERSION']
 gem 'activerecord', "~> #{version}" if version
 require 'active_record'
 require 'active_record/version'
-warn "Using activerecord #{ActiveRecord::VERSION::STRING}"
+version = ActiveRecord::VERSION::STRING
+warn "Using activerecord #{version}"
 
 # replicate must be loaded after AR
 require 'replicate'
@@ -36,12 +37,28 @@ ActiveRecord::Schema.define do
     t.string   "email"
     t.datetime "created_at"
   end
+
+  if version[0,3] > '2.2'
+    create_table "domains", :force => true do |t|
+      t.string "host"
+    end
+
+    create_table "web_pages", :force => true do |t|
+      t.string "url"
+      t.string "domain_host"
+    end
+  end
+
+  create_table "notes", :force => true do |t|
+    t.integer "notable_id"
+  end
 end
 
 # models
 class User < ActiveRecord::Base
   has_one  :profile, :dependent => :destroy
   has_many :emails,  :dependent => :destroy, :order => 'id'
+  has_many :notes,   :as => :notable
   replicate_natural_key :login
 end
 
@@ -55,6 +72,20 @@ class Email < ActiveRecord::Base
   replicate_natural_key :user_id, :email
 end
 
+if version[0,3] > '2.2'
+  class WebPage < ActiveRecord::Base
+    belongs_to :domain, :foreign_key => 'domain_host', :primary_key => 'host'
+  end
+
+  class Domain < ActiveRecord::Base
+    replicate_natural_key :host
+  end
+end
+
+class Note < ActiveRecord::Base
+  belongs_to :notable, :polymorphic => true
+end
+
 # The test case loads some fixture data once and uses transaction rollback to
 # reset fixture state for each test's setup.
 class ActiveRecordTest < Test::Unit::TestCase
@@ -92,6 +123,11 @@ class ActiveRecordTest < Test::Unit::TestCase
 
     user = User.create! :login => 'tmm1'
     user.create_profile :name => 'tmm1', :homepage => 'https://github.com/tmm1'
+
+    if defined?(Domain)
+      github = Domain.create! :host => 'github.com'
+      github_about_page = WebPage.create! :url => 'http://github.com/about', :domain => github
+    end
   end
 
   def test_extension_modules_loaded
@@ -122,6 +158,55 @@ class ActiveRecordTest < Test::Unit::TestCase
     assert_equal rtomayko.profile, obj
   end
 
+  def test_omit_dumping_of_attribute
+    objects = []
+    @dumper.listen { |type, id, attrs, obj| objects << [type, id, attrs, obj] }
+
+    User.replicate_omit_attributes :created_at
+    rtomayko = User.find_by_login('rtomayko')
+    @dumper.dump rtomayko
+
+    assert_equal 2, objects.size
+
+    type, id, attrs, obj = objects.shift
+    assert_equal nil, attrs['created_at']
+  end
+
+  def test_omit_dumping_of_association
+    objects = []
+    @dumper.listen { |type, id, attrs, obj| objects << [type, id, attrs, obj] }
+
+    User.replicate_omit_attributes :profile
+    rtomayko = User.find_by_login('rtomayko')
+    @dumper.dump rtomayko
+
+    assert_equal 1, objects.size
+
+    type, id, attrs, obj = objects.shift
+    assert_equal 'User', type
+  end
+
+  if ActiveRecord::VERSION::STRING[0, 3] > '2.2'
+    def test_dump_and_load_non_standard_foreign_key_association
+      objects = []
+      @dumper.listen { |type, id, attrs, obj| objects << [type, id, attrs, obj] }
+
+      github_about_page = WebPage.find_by_url('http://github.com/about')
+      assert_equal "github.com", github_about_page.domain.host
+      @dumper.dump github_about_page
+
+      WebPage.delete_all
+      Domain.delete_all
+
+      # load everything back up
+      objects.each { |type, id, attrs, obj| @loader.feed type, id, attrs }
+
+      github_about_page = WebPage.find_by_url('http://github.com/about')
+      assert_equal "github.com", github_about_page.domain_host
+      assert_equal "github.com", github_about_page.domain.host
+    end
+  end
+
   def test_auto_dumping_has_one_associations
     objects = []
     @dumper.listen { |type, id, attrs, obj| objects << [type, id, attrs, obj] }
@@ -146,6 +231,31 @@ class ActiveRecordTest < Test::Unit::TestCase
     assert_equal rtomayko.profile, obj
   end
 
+  def test_auto_dumping_does_not_fail_on_polymorphic_associations
+    objects = []
+    @dumper.listen { |type, id, attrs, obj| objects << [type, id, attrs, obj] }
+
+    rtomayko = User.find_by_login('rtomayko')
+    note = Note.create!(:notable => rtomayko)
+    @dumper.dump note
+
+    assert_equal 3, objects.size
+
+    type, id, attrs, obj = objects.shift
+    assert_equal 'User', type
+    assert_equal rtomayko.id, id
+
+    type, id, attrs, obj = objects.shift
+    assert_equal 'Profile', type
+
+    type, id, attrs, obj = objects.shift
+    assert_equal 'Note', type
+    assert_equal note.id, id
+    assert_equal note.notable_type, attrs['notable_type']
+    assert_equal attrs["notable_id"], rtomayko.id
+    assert_equal note, obj
+  end
+
   def test_dumping_has_many_associations
     objects = []
     @dumper.listen { |type, id, attrs, obj| objects << [type, id, attrs, obj] }

metadata

@@ -1,45 +1,55 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: replicate
-version: !ruby/object:Gem::Version
-  version: '1.3'
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 4
+  version: "1.4"
 platform: ruby
-authors:
+authors: 
 - Ryan Tomayko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-10 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-10-19 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: activerecord
-  requirement: &70344083570000 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.1'
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
   type: :development
-  prerelease: false
-  version_requirements: *70344083570000
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: sqlite3
-  requirement: &70344083569500 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: *70344083569500
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 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
@@ -57,31 +67,37 @@ 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
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.3.6
 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