forceps 0.5.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Forceps'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/forceps/acts_as_copyable_model.rb

@@ -0,0 +1,245 @@
+module Forceps
+  module ActsAsCopyableModel
+    extend ActiveSupport::Concern
+
+    def copy_to_local
+      without_record_timestamps do
+        DeepCopier.new(forceps_options).copy(self)
+      end
+    end
+
+    private
+
+    def without_record_timestamps
+      self.class.base_class.record_timestamps = false
+      yield
+    ensure
+      self.class.base_class.record_timestamps = true
+    end
+
+    def forceps_options
+      Forceps.client.options
+    end
+
+    class DeepCopier
+      attr_accessor :copied_remote_objects, :options, :level, :reused_local_objects
+
+      def initialize(options)
+        @copied_remote_objects = {}
+        @reused_local_objects = Set.new
+        @options = options
+        @level = 0
+      end
+
+      def copy(remote_object)
+        cached_local_copy(remote_object) || perform_copy(remote_object)
+      end
+
+      private
+
+      def cached_local_copy(remote_object)
+        cached_object = copied_remote_objects[remote_object]
+        debug "#{as_trace(remote_object)} from cache..." if cached_object
+        cached_object
+      end
+
+      def perform_copy(remote_object)
+        copied_object = local_copy_with_simple_attributes(remote_object)
+        copied_remote_objects[remote_object] = copied_object
+        copy_associated_objects(copied_object, remote_object) unless was_reused?(copied_object)
+        copied_object
+      end
+
+      def local_copy_with_simple_attributes(remote_object)
+        if should_reuse_local_copy?(remote_object)
+          find_or_clone_local_copy_with_simple_attributes(remote_object)
+        else
+          create_local_copy_with_simple_attributes(remote_object)
+        end
+      end
+
+      def should_reuse_local_copy?(remote_object)
+        finders_for_reusing_classes.include?(remote_object.class.base_class)
+      end
+
+      def finders_for_reusing_classes
+        options[:reuse] || {}
+      end
+
+      def find_or_clone_local_copy_with_simple_attributes(remote_object)
+        found_local_object = finder_for_remote_object(remote_object).call(remote_object)
+        if found_local_object
+          copy_simple_attributes(found_local_object, remote_object)
+          reused_local_objects << found_local_object
+          found_local_object
+        else
+          create_local_copy_with_simple_attributes(remote_object)
+        end
+      end
+
+      def was_reused?(local_object)
+        reused_local_objects.include? local_object
+      end
+
+      def find_local_copy_with_simple_attributes(remote_object)
+        finder_for_remote_object(remote_object).call(remote_object)
+      end
+
+      def finder_for_remote_object(remote_object)
+        finder = finders_for_reusing_classes[remote_object.class.base_class]
+        finder = build_attribute_finder(remote_object, finder) if finder.is_a? Symbol
+        finder
+      end
+
+      def build_attribute_finder(remote_object, attribute_name)
+        value = remote_object.send(attribute_name)
+        lambda do |object|
+          object.class.base_class.where(attribute_name => value).first
+        end
+      end
+
+      def create_local_copy_with_simple_attributes(remote_object)
+        # 'self.dup.becomes(Invoice)' won't work because of different  AR connections.
+        # todo: prepare for rails 3 and attribute protection
+        debug "#{as_trace(remote_object)} copying..."
+
+        # todo: pending test for STI scenario
+        base_class = base_local_class_for(remote_object)
+
+        disable_all_callbacks_for(base_class)
+
+        cloned_object = base_class.new
+        copy_attributes(cloned_object, simple_attributes_to_copy(remote_object))
+        cloned_object.save!(validate: false)
+        invoke_callbacks(:after_each, cloned_object, remote_object)
+        cloned_object
+      end
+
+      def base_local_class_for(remote_object)
+        base_class = remote_object.class.base_class
+        if remote_object.respond_to?(:type)
+          base_class = remote_object.type.constantize rescue base_class
+        end
+        base_class
+      end
+
+      def invoke_callbacks(callback_name, copied_object, remote_object)
+        callback = callbacks_for(callback_name)[copied_object.class]
+        return unless callback
+        callback.call(copied_object, remote_object)
+      end
+
+      def callbacks_for(callback_name)
+        options[callback_name] || {}
+      end
+
+      # Using setters explicitly to avoid having to mess with disabling mass protection in Rails 3
+      def copy_attributes(target_object, attributes_map)
+        attributes_map.each do |attribute_name, attribute_value|
+          target_object.send("#{attribute_name}=", attribute_value) rescue debug("The method '#{attribute_name}=' does not exist. Different schemas in the remote and local databases?")
+        end
+      end
+
+      def disable_all_callbacks_for(base_class)
+        [:create, :save, :update, :validate, :touch].each { |callback| base_class.reset_callbacks callback }
+      end
+
+      def simple_attributes_to_copy(remote_object)
+        remote_object.attributes.except('id').reject do |attribute_name|
+          attributes_to_exclude(remote_object).include? attribute_name.to_sym
+        end
+      end
+
+      def attributes_to_exclude(remote_object)
+        @attributes_to_exclude_map ||= {}
+        @attributes_to_exclude_map[remote_object.class.base_class] ||= calculate_attributes_to_exclude(remote_object)
+      end
+
+      def calculate_attributes_to_exclude(remote_object)
+        ((options[:exclude] && options[:exclude][remote_object.class.base_class]) || []).collect(&:to_sym)
+      end
+
+      def copy_simple_attributes(target_local_object, source_remote_object)
+        debug "#{as_trace(source_remote_object)} reusing..."
+        # update_columns skips callbacks too but not available in Rails 3
+        copy_attributes(target_local_object, simple_attributes_to_copy(source_remote_object))
+        target_local_object.save!(validate: false)
+      end
+
+      def logger
+        Forceps.logger
+      end
+
+      def increase_level
+        @level += 1
+      end
+
+      def decrease_level
+        @level -= 1
+      end
+
+      def as_trace(remote_object)
+        "<#{remote_object.class.base_class.name} - #{remote_object.id}>"
+      end
+
+      def debug(message)
+        left_margin = "  "*level
+        logger.debug "#{left_margin}#{message}"
+      end
+
+      def copy_associated_objects(local_object, remote_object)
+        with_nested_logging do
+          [:has_many, :has_one, :belongs_to, :has_and_belongs_to_many].each do |association_kind|
+            copy_objects_associated_by_association_kind(local_object, remote_object, association_kind)
+          end
+        end
+      end
+
+      def with_nested_logging
+        increase_level
+        yield
+        decrease_level
+      end
+
+      def copy_objects_associated_by_association_kind(local_object, remote_object, association_kind)
+        associations_to_copy(remote_object, association_kind).collect(&:name).each do |association_name|
+          send "copy_associated_objects_in_#{association_kind}", local_object, remote_object, association_name
+        end
+      end
+
+      def associations_to_copy(remote_object, association_kind)
+        excluded_attributes = attributes_to_exclude(remote_object)
+        remote_object.class.reflect_on_all_associations(association_kind).reject do |association|
+          association.options[:through] || excluded_attributes.include?(:all_associations) || excluded_attributes.include?(association.name)
+        end
+      end
+
+      def copy_associated_objects_in_has_many(local_object, remote_object, association_name)
+        remote_object.send(association_name).find_each do |remote_associated_object|
+          local_object.send(association_name) << copy(remote_associated_object)
+        end
+      end
+
+      def copy_associated_objects_in_has_one(local_object, remote_object, association_name)
+        remote_associated_object = remote_object.send(association_name)
+        local_object.send "#{association_name}=", remote_associated_object && copy(remote_associated_object)
+        local_object.save!(validate: false)
+      end
+
+      def copy_associated_objects_in_belongs_to(local_object, remote_object, association_name)
+        copy_associated_objects_in_has_one local_object, remote_object, association_name
+      end
+
+      def copy_associated_objects_in_has_and_belongs_to_many(local_object, remote_object, association_name)
+        remote_object.send(association_name).find_each do |remote_associated_object|
+          # TODO: Review dirty way to avoid copying objects related by has_and_belong_to_many in both extremes twice
+          cloned_local_associated_object = copy(remote_associated_object)
+          unless local_object.send(association_name).where(id: cloned_local_associated_object.id).exists?
+            local_object.send(association_name) << cloned_local_associated_object
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/forceps/client.rb

@@ -0,0 +1,126 @@
+module Forceps
+  class Client
+    attr_reader :options
+
+    def configure(options={})
+      @options = options.merge(default_options)
+
+      declare_remote_model_classes
+      make_associations_reference_remote_classes
+
+      logger.debug "Classes handled by Forceps: #{model_classes.collect(&:name).inspect}"
+    end
+
+    private
+
+    def logger
+      Forceps.logger
+    end
+
+    def default_options
+      {}
+    end
+
+    def model_classes
+      @model_classes ||= ActiveRecord::Base.descendants - model_classes_to_exclude
+    end
+
+    def model_classes_to_exclude
+      if Rails::VERSION::MAJOR >= 4
+        [ActiveRecord::SchemaMigration]
+      else
+        []
+      end
+    end
+
+    def declare_remote_model_classes
+      return if @remote_classes_defined
+      model_classes.each { |remote_class| declare_remote_model_class(remote_class) }
+      @remote_classes_defined = true
+    end
+
+    def declare_remote_model_class(klass)
+      class_name = remote_class_name_for(klass.name)
+      new_class = build_new_remote_class klass, class_name
+      Forceps::Remote.const_set(class_name, new_class)
+      remote_class_for(class_name).establish_connection 'remote'
+    end
+
+    def build_new_remote_class(local_class, class_name)
+	    needs_type_condition = (local_class.base_class != ActiveRecord::Base) && local_class.finder_needs_type_condition?
+	    Class.new(local_class) do
+		    self.table_name = local_class.table_name
+
+        include Forceps::ActsAsCopyableModel
+
+        # We don't want to include STI condition automatically (the base class extends the original one)
+		    unless needs_type_condition
+			    def self.finder_needs_type_condition?
+				    false
+			    end
+		    end
+	    end
+    end
+
+    def remote_class_name_for(local_class_name)
+      local_class_name.gsub('::', '_')
+    end
+
+    def remote_class_for(class_name)
+      Forceps::Remote::const_get(remote_class_name_for(class_name))
+    end
+
+    def make_associations_reference_remote_classes
+      model_classes.each do |model_class|
+        make_associations_reference_remote_classes_for(model_class)
+      end
+    end
+
+    def make_associations_reference_remote_classes_for(model_class)
+      model_class.reflect_on_all_associations.each do |association|
+        next if association.class_name =~ /Forceps::Remote/ rescue next
+        reference_remote_class(model_class, association)
+      end
+    end
+
+    def reference_remote_class(model_class, association)
+      remote_model_class = remote_class_for(model_class.name)
+
+      if association.options[:polymorphic]
+        reference_remote_class_in_polymorfic_association(association, remote_model_class)
+      else
+        reference_remote_class_in_normal_association(association, remote_model_class)
+      end
+    end
+
+    def reference_remote_class_in_polymorfic_association(association, remote_model_class)
+      # todo: test
+      foreign_type_attribute_name = association.foreign_type
+
+      remote_model_class.send(:define_method, association.foreign_type) do
+        "Forceps::Remote::#{super()}"
+      end
+
+      remote_model_class.send(:define_method, "[]") do |attribute_name|
+        if (attribute_name.to_s==foreign_type_attribute_name)
+          "Forceps::Remote::#{super(attribute_name)}"
+        else
+          super(attribute_name)
+        end
+      end
+    end
+
+    def reference_remote_class_in_normal_association(association, remote_model_class)
+      related_remote_class = remote_class_for(association.klass.name)
+
+      cloned_association = association.dup
+      cloned_association.instance_variable_set("@klass", related_remote_class)
+
+      cloned_reflections = remote_model_class.reflections.dup
+      cloned_reflections[cloned_association.name.to_sym] = cloned_association
+      remote_model_class.reflections = cloned_reflections
+    end
+  end
+end
+
+

data/lib/forceps/version.rb

@@ -0,0 +1,3 @@
+module Forceps
+  VERSION = "0.5.0"
+end

data/lib/forceps.rb

@@ -0,0 +1,30 @@
+require "forceps/client"
+require "forceps/acts_as_copyable_model"
+require 'logging'
+
+module Forceps
+  def self.configure(options={})
+    client.configure(options)
+  end
+
+  def self.client
+    @@client ||= Forceps::Client.new
+  end
+
+  def self.logger
+    @@logger ||= begin
+      logger = Logging.logger(STDOUT)
+      logger.level = :debug
+      logger
+    end
+  end
+
+  def self.logger=(logger)
+    @@logger = logger
+  end
+
+  module Remote
+
+  end
+end
+

data/lib/tasks/forceps_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :forceps do
+#   # Task goes here
+# end

data/test/callbacks_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class CallbacksTest < ActiveSupport::TestCase
+  def setup
+    @remote_product = RemoteProduct.create!(name: 'MBP', price: '2000', id: 123456).tap{|product| product.update_column :type, nil}
+  end
+
+  test "should invoke the configured 'after_each' callback" do
+    after_each_callback_mock = MiniTest::Mock.new
+    after_each_callback_mock.expect(:call, nil) do |args|
+      assert_equal Product.find_by_name('MBP'), args[0]
+      assert_identical @remote_product, args[1]
+    end
+
+    Forceps.configure :after_each => {Product => after_each_callback_mock}
+
+    Forceps::Remote::Product.find(@remote_product).copy_to_local
+
+    assert after_each_callback_mock.verify
+  end
+end

data/test/clone_structures_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+class CloneStructuresTest < ActiveSupport::TestCase
+
+  def setup
+    @remote_invoice = RemoteInvoice.create! number: 123, date: Time.now
+    @remote_user = RemoteUser.create! name: 'Jorge'
+    Forceps.configure
+  end
+
+  test "should download a single record" do
+    Forceps::Remote::Invoice.find_by_number(@remote_invoice.number).copy_to_local
+    assert_identical @remote_invoice.becomes(Invoice), Invoice.find_by_number(123)
+  end
+
+  test "should download object with 'has_many'" do
+    2.times { |index| @remote_user.invoices.create! number: index+1, date: "2014-1-#{index+1}" }
+
+    Forceps::Remote::User.find(@remote_user).copy_to_local
+
+    copied_user = User.find_by_name('Jorge')
+    assert_identical @remote_user, copied_user
+    2.times { |index| assert_identical @remote_user.invoices[index], copied_user.invoices[index] }
+  end
+
+  test "should download object with 'belongs_to'" do
+    @remote_invoice = @remote_user.invoices.create! number: 1234, date: "2014-1-3"
+
+    Forceps::Remote::Invoice.find(@remote_invoice).copy_to_local
+
+    copied_invoice = Invoice.find_by_number(1234)
+    assert_identical @remote_invoice, copied_invoice
+  end
+
+  test "should download objects with 'has_and_belongs_to_many'" do
+    remote_tags = 2.times.collect { |index| RemoteTag.create name: "tag #{index}" }
+    remote_products = 2.times.collect do |index|
+      RemoteProduct.create(name: "product #{index}").tap do |product|
+        product.update_column :type, nil # we don't STI here
+      end
+    end
+    remote_products.each { |remote_product| remote_tags.each {|remote_tag| remote_product.tags << remote_tag} }
+
+    Forceps::Remote::Tag.find(remote_tags[0]).copy_to_local
+
+    assert_equal 2, Product.count
+    assert_equal 2, Tag.count
+
+    2.times do |index|
+      assert_not_nil tag = Tag.find_by_name("tag #{index}")
+      assert_not_nil Product.find_by_name("product #{index}")
+      assert_equal 2, tag.products.count
+    end
+  end
+
+  test "should download object with 'has_one'" do
+    remote_address = RemoteAddress.create!(street: 'Uria', city: 'Oviedo', country: 'Spain', user: @remote_user)
+
+    Forceps::Remote::User.find(@remote_user).copy_to_local
+
+    copied_user = User.find_by_name('Jorge')
+    assert_identical remote_address, copied_user.address
+  end
+
+  test "should download child objects when using single table inheritance" do
+    remote_car = RemoteProduct.create!(name: 'audi')
+    remote_car.update_column :type, 'Car'
+
+    Forceps::Remote::Product.find_by_name('audi').becomes(Forceps::Remote::Product).copy_to_local
+    assert_not_nil Product.find_by_name('CAR: audi')
+  end
+
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/address.rb

@@ -0,0 +1,3 @@
+class Address < ActiveRecord::Base
+  belongs_to :user
+end

data/test/dummy/app/models/car.rb

@@ -0,0 +1,5 @@
+class Car < Product
+  def name=(new_name)
+    super("CAR: #{new_name}")
+  end
+end

data/test/dummy/app/models/invoice.rb

@@ -0,0 +1,7 @@
+class Invoice < ActiveRecord::Base
+  belongs_to :user
+
+  has_many :line_items
+
+  has_one :address, through: :user
+end

data/test/dummy/app/models/line_item.rb

@@ -0,0 +1,4 @@
+class LineItem < ActiveRecord::Base
+  belongs_to :product
+  belongs_to :invoice
+end

data/test/dummy/app/models/product.rb

@@ -0,0 +1,4 @@
+class Product < ActiveRecord::Base
+  has_many :line_items
+  has_and_belongs_to_many :tags
+end

data/test/dummy/app/models/tag.rb

@@ -0,0 +1,3 @@
+class Tag < ActiveRecord::Base
+  has_and_belongs_to_many :products
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  has_many :invoices
+  has_one :address
+end