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. 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 has_sti_column?(remote_object) local_type = to_local_class_name(remote_object.type) base_class = local_type.constantize rescue base_class end base_class end def to_local_class_name(remote_class_name) remote_class_name.gsub('Forceps::Remote::', '') end def has_sti_column?(object) object.respond_to?(:type) && object.type.present? && object.type.is_a?(String) 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) make_type_attribute_point_to_local_class_if_needed(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 make_type_attribute_point_to_local_class_if_needed(attributes_map) if attributes_map['type'].is_a?(String) attributes_map['type'] = to_local_class_name(attributes_map['type']) 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