tricycle-model_sync 0.2.0

data/Manifest

@@ -0,0 +1,4 @@
+lib/model_sync.rb
+Rakefile
+README.rdoc
+Manifest

data/README.rdoc

@@ -0,0 +1,51 @@
+= model_sync
+
+model_sync is a simple gem for pushing changes to one of your rails models to another.
+
+	class User < ActiveRecord::Base
+	  model_sync :sync_to => :student,
+	             :relationship => { :student_id => :s_stno },
+	             :mappings => { :forename => :s_forename },
+	             :mapping_block => Proc.new do |master, slave|
+	                                 slave.update_attribute(:s_sex, master.gender ? master.gender.code : nil)
+	                               end
+	end
+	
+Assuming we have a Student model, the above code will add an after_save callback to the User model which will push changes to the forename value into the s_forename value of Student. The correct Student instance is found using the :relationship hash - student_id in User must equal s_stno in Student.
+
+Although the above example only pushes changes to forename, you can add more mappings to the :mappings hash to push over as many values as you like.
+
+When things are a bit more complicated than a simple like for like mapping you can use the :mapping_block option to pass a block which has access to the master and slave objects. Using these objects you can perform more complicated tasks than just making one value equal another.
+
+== Why use it?
+
+I developed this gem as part of a web front end which I'm building for an old legacy system. The legacy system is a student records system which holds students which are booked on courses. However I don't want to add users of the website into the system as students until they have actually booked a course. So there needs to be a certain amount of separation between the online element and the legacy system, mainly because I can't make changes to the database structure of the legacy system.
+
+Once a user books a course and becomes a student as well we've got a user and a student record we need to keep in sync because the user could change their address through the website, for example, which then needs feeding into the main system.
+
+The model_sync gem will do all the syncing for me in a totally transparent way.
+
+== Installation
+
+This gem lives at gemcutter.org (which is amazing by the way!). To use gemcutter is simplicity itself:
+
+  sudo gem install gemcutter
+  sudo gem tumble
+
+And now with gemcutter as your preferred gem source you can type:
+
+  sudo gem install model_sync
+
+== Limitations
+
+Currently the changes are pushed over with an after_save hook using update_attribute on the :sync_to model. This bypasses validations and any failures on update_attribute are currently not handled.
+
+Also the instance methods which model_sync adds to a class are not available through associations. So if we did something like...
+
+  post.user.synced_with_student?
+
+... it won't work because we are going through an association which actually uses a proxy behind the scenes. Instead you need to force the instantiation of the target:
+
+  post.user.target.synced_with_student?
+
+I'm not totally sure how to get around that yet. It's something to do with an ActiveRecord association proxy being used instead of an actual instance of the target class (in this case the User class). If anyone knows how to fix that then please feel free to fork the project and patch.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('model_sync', '0.1.4') do |p|
+  p.description    = "Sync changes to an ActiveRecord model to another model"
+  p.url            = "http://github.com/antonjenkins/model_sync"
+  p.author         = "Anton Jenkins"
+  p.email          = "info@pixellatedvisions.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/model_sync.rb

@@ -0,0 +1,83 @@
+module ModelSync
+  module Base
+    def self.included(klass)
+      klass.class_eval do
+        extend Config
+      end
+    end
+
+    module Config
+      attr_reader :slave_model_name, :slave_model_class, :relationship, :mappings, :mapping_block
+
+      def model_sync(options)
+        @slave_model_name = options[:sync_to].to_s.downcase
+        @slave_model_class = Kernel.const_get(@slave_model_name.classify)
+        @relationship = options[:relationship]
+        @mappings = options[:mappings]
+        @mapping_block = options[:mapping_block]
+
+        # Add a callback to sync_changes on every save
+        self.after_save :sync_changes
+        self.after_destroy :destroy_slave
+      end
+    end
+
+    def sync_changes
+      # If we can find a slave instance...
+      if slave_instance = find_slave_instance
+        # ... then sync the changes over
+        perform_sync(slave_instance)
+        slave_instance.save
+      end
+    end
+
+    def method_missing(id, *args, &block)
+      case(id.to_s)
+      when /^create_#{self.class.slave_model_name}$/
+        # Only create a new slave if one doesn't already exist
+        unless find_slave_instance
+          # If we've received a create_{slave_model} call then create a new instance of it and sync to it
+          new_instance = self.class.slave_model_class.new
+          perform_sync(new_instance)
+          new_instance.id = self.id
+          new_instance.save
+        end
+      when /^synch?ed_with_#{self.class.slave_model_name}\?$/
+        !!find_slave_instance
+      else
+        super
+      end
+    end
+
+  private
+    def find_slave_instance
+      # return nil if we don't have a value for the foreign key
+      return nil unless foreign_key_value = self.read_attribute(self.class.relationship.keys.first)
+      # find the instance of the slave class using the relationship hash
+      self.class.slave_model_class.find(:first,
+                                        :conditions => "#{self.class.relationship.values.first.to_s} = #{foreign_key_value}")
+    end
+
+    def perform_sync(slave_instance)
+      # Update all the attributes which we've mapped
+      self.class.mappings.each do |source, dest|
+        slave_instance.write_attribute(dest, self.read_attribute(source))
+      end
+      # Call the mapping_block if one is supplied
+      self.class.mapping_block.call(self, slave_instance) if self.class.mapping_block
+    end
+
+    def destroy_slave
+      return unless find_slave_instance
+      find_slave_instance.destroy
+    end
+  end
+end
+
+if defined?(::ActiveRecord)
+  module ::ActiveRecord
+    class Base
+      include ModelSync::Base
+    end
+  end
+end

data/model_sync.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tricycle-model_sync}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anton Jenkins"]
+  s.date = %q{2009-07-20}
+  s.description = %q{Fork of the model_sync gem by Anton Jenkins}
+  s.email = %q{info@pixellatedvisions.com}
+  s.extra_rdoc_files = ["lib/model_sync.rb", "README.rdoc"]
+  s.files = ["lib/model_sync.rb", "Rakefile", "README.rdoc", "Manifest", "model_sync.gemspec"]
+  s.homepage = %q{http://github.com/antonjenkins/model_sync}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Model_sync", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{model_sync}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Sync changes to an ActiveRecord model to another model}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: tricycle-model_sync
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Anton Jenkins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-20 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: Fork of the model_sync gem by Anton Jenkins
+email: info@pixellatedvisions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/model_sync.rb
+- README.rdoc
+files: 
+- lib/model_sync.rb
+- Rakefile
+- README.rdoc
+- Manifest
+- model_sync.gemspec
+has_rdoc: true
+homepage: http://github.com/antonjenkins/model_sync
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Model_sync
+- --main
+- README.rdoc
+require_paths: 
+- lib
+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: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: model_sync
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Sync changes to an ActiveRecord model to another model
+test_files: []
+