trackzor 0.1.3 → 0.1.5

data/Manifest

@@ -6,3 +6,4 @@ generators/trackzor_migration/templates/migration.rb
 generators/trackzor_migration/trackzor_migration_generator.rb
 init.rb
 lib/trackzor.rb
+tasks/trackzor.rake

data/README.rdoc

@@ -22,3 +22,19 @@ Or, if you're also using acts_as_audited, its as_user method is supported:
   end
 
 For each trackzored [ATTR]_updated_by column, a belongs_to association (:[ATTR]_source) is added to link to the user.
+
+== Sharing and Merging Tables
+
+Trackzor provides rake tasks for consolidating development databases.
+When using Trackzor as a gem, copy trackzor.rake from the gem's tasks directory to your application's tasks directory.
+
+Merging from Person A to Person B:
+  Person A: > rake trackzor_merge:dump TABLE=users
+            /path/printed/to/dump/users_for_merge.sql
+
+  Person B: > rake trackzor_merge:load CLASS=User FILE=users_for_merge.sql COLUMN=email
+            Merging joe@bob.com {:zip_code => ['12345', '54321']}
+            Creating new@guy.com
+            ...
+
+Trackzor will load the DB dump into a temporary table and merge data that is newer (based on ATTR_updated_at if available, otherwise updated_at).

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('trackzor', '0.1.3') do |gem|
+Echoe.new('trackzor', '0.1.5') do |gem|
   gem.description = "Track ATTR_updated_at and ATTR_updated_by"
   gem.url = "http://github.com/corneldm/trackzor"
   gem.author = "David Cornelius"

data/lib/trackzor.rb

@@ -6,6 +6,8 @@ module Trackzor
   module ClassMethods
     def trackzored(options = {})
       class_inheritable_reader :trackzor_exempt_columns
+      class_inheritable_reader :trackzor_maintained_columns
+      class_inheritable_reader :trackzored_columns
 
       if options[:only]
         except = self.column_names - options[:only].flatten.map(&:to_s)
@@ -14,14 +16,34 @@ module Trackzor
         except |= Array(options[:except]).collect(&:to_s) if options[:except]
       end
       write_inheritable_attribute :trackzor_exempt_columns, except
-      aaa_present = self.respond_to?(:non_audited_columns)
+
+      the_trackzored_columns = []
+      the_trackzor_maintained_columns = []
 
       # create ATTR_source associations
-      (self.column_names - self.trackzor_exempt_columns).select{|column| column =~ /(_updated_by|_updated_at)$/ }.each do |col|
-        if col =~ /_updated_by$/
-          belongs_to col.sub(/_updated_by$/, '_source').to_sym, :class_name => 'User', :foreign_key => col
+      (self.column_names - self.trackzor_exempt_columns).each do |column|
+        has_updated_by_col = self.column_names.include?("#{column}_updated_by")
+        has_updated_at_col = self.column_names.include?("#{column}_updated_at")
+
+        if has_updated_by_col || has_updated_at_col
+          the_trackzored_columns << column
+          
+          if has_updated_by_col
+            belongs_to "#{column}_source".to_sym, :class_name => 'User', :foreign_key => "#{column}_updated_by"
+            the_trackzor_maintained_columns << "#{column}_updated_by"
+          end
+
+          if has_updated_at_col
+            the_trackzor_maintained_columns << "#{column}_updated_at"
+          end
         end
-        self.non_audited_columns << col if aaa_present
+      end
+      write_inheritable_attribute :trackzored_columns, the_trackzored_columns
+      write_inheritable_attribute :trackzor_maintained_columns, the_trackzor_maintained_columns
+
+      if self.respond_to?(:non_audited_columns)
+        nac = self.non_audited_columns + the_trackzor_maintained_columns
+        write_inheritable_attribute :non_audited_columns, nac
       end
 
       validate :trackzor_assign_and_validate
@@ -54,7 +76,7 @@ module Trackzor
       end
     end
 
-    # force update of multiple attributes
+    # update multiple attributes and force update of trackzored attributes
     def will_update_attributes!(new_attributes, guard_protected_attributes = true)
       return if new_attributes.nil?
       attributes = new_attributes.dup
@@ -69,7 +91,7 @@ module Trackzor
         else
           if respond_to?("#{k}=")
             send("#{k}=", v)
-            send("#{k}_will_change!")
+            send("#{k}_will_change!") if self.trackzored_columns.include?(k)
           else
             raise "unknown attribute: #{k}"
           end
@@ -79,6 +101,42 @@ module Trackzor
       assign_multiparameter_attributes(multi_parameter_attributes)
       save!
     end
+
+    # merge record with another, accepting the latest values available
+    def merge_with(other, unique_id_col = 'id')
+      raise "unmergable objects" if other.class.column_names != self.class.column_names || self.send(unique_id_col.to_sym) != other.send(unique_id_col.to_sym)
+
+      column_names = self.class.column_names
+
+      self.trackzored_columns.each do |tc|
+        has_updated_by_col = column_names.include?("#{tc}_updated_by")
+        has_updated_at_col = column_names.include?("#{tc}_updated_at")
+        
+        if has_updated_at_col
+          self_time = self.send("#{tc}_updated_at".to_sym)
+          other_time = other.send("#{tc}_updated_at".to_sym)
+        else
+          self_time = self.updated_at
+          other_time = other.updated_at
+        end
+
+        if self_time.nil? || (!other_time.nil? && other_time > self_time)
+          self.send("#{tc}_updated_at=".to_sym, other_time) if has_updated_at_col
+          self.send("#{tc}_updated_by=".to_sym, other.send("#{tc}_updated_by".to_sym)) if has_updated_by_col
+          self.send("#{tc}=".to_sym, other.send(tc.to_sym))
+        end
+      end
+
+      if other.updated_at > self.updated_at
+        (column_names - self.trackzored_columns - self.trackzor_maintained_columns).each do |c|
+          self.send("#{c}=".to_sym, other.send(c.to_sym))
+        end
+      end
+
+      puts "Merged #{self.send(unique_id_col.to_sym)}: #{self.changes.inspect}" unless self.changes.empty?
+      self.send(:update_without_callbacks)
+    end
+
   end # InstanceMethods
 
   # All X attribute changes where X_updated_by exists will be recorded as made by +user+.

data/tasks/trackzor.rake

@@ -0,0 +1,40 @@
+namespace :trackzor_merge do
+  MERGE_TABLE_SUFFIX = "_for_merge"
+
+  task :dump do
+    raise ArgumentError, "must provide TABLE to dump, id is assumed PK unless TABLE_PK is set" unless ENV['TABLE']
+    pk = ENV['TABLE_PK'] || 'id'
+    config = YAML::load(File.open("#{RAILS_ROOT}/config/database.yml"))
+    sub_file = "#{RAILS_ROOT}/tmp/#{ENV['TABLE']}#{MERGE_TABLE_SUFFIX}.sql"
+    system "mysqldump --user=#{config[RAILS_ENV]['username']} --password=#{config[RAILS_ENV]['password']} #{config[RAILS_ENV]['database']} #{ENV['TABLE']} > #{sub_file}_1"
+    system "sed 's/`#{ENV['TABLE']}`/`#{ENV['TABLE']}#{MERGE_TABLE_SUFFIX}`/g' #{sub_file}_1 > #{sub_file}_2"
+    system "sed 's/PRIMARY KEY (`#{pk}`),/PRIMARY KEY (`#{pk}`)/g' #{sub_file}_2 > #{sub_file}_3"
+    system "grep -Ev 'index_#{ENV['TABLE']}_on' #{sub_file}_3 > #{sub_file}"
+    system "rm #{sub_file}_*"
+    puts sub_file
+  end
+
+  task :load => :environment do
+    raise ArgumentError, "must provide target CLASS to merge into, FILE for sql dump, unique identifying column assumed to be id unless COLUMN is set" unless ENV['CLASS'] && ENV['FILE']
+
+    col = ENV['COLUMN'] || 'id'
+    model = ENV['CLASS'].camelize.constantize
+    merge_model = model.clone
+    merge_model.table_name += MERGE_TABLE_SUFFIX
+
+    config = YAML::load(File.open("#{RAILS_ROOT}/config/database.yml"))
+    system "mysql --user=#{config[RAILS_ENV]['username']} --password=#{config[RAILS_ENV]['password']} #{config[RAILS_ENV]['database']} < #{ENV['FILE']}"
+    
+    merge_model.find(:all).each do |record_to_merge|
+      if record = model.send("find_by_#{col}".to_sym, record_to_merge.send(col.to_sym))
+        record.merge_with(record_to_merge)
+      else
+        new_record = model.new(record_to_merge.attributes)
+        # set unique id expliciting in case it's the PK
+        new_record.send("#{col}=".to_sym, record_to_merge.send(col.to_sym))
+        new_record.send(:create_without_callbacks)
+        puts "Created #{new_record.send(col.to_sym)}"
+      end
+    end
+  end
+end

data/trackzor.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{trackzor}
-  s.version = "0.1.3"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Cornelius"]
-  s.date = %q{2010-01-22}
+  s.date = %q{2010-01-25}
   s.description = %q{Track ATTR_updated_at and ATTR_updated_by}
   s.email = %q{david.cornelius@bluefishwireless.net}
-  s.extra_rdoc_files = ["CHANGELOG", "README.rdoc", "lib/trackzor.rb"]
-  s.files = ["CHANGELOG", "Manifest", "README.rdoc", "Rakefile", "generators/trackzor_migration/templates/migration.rb", "generators/trackzor_migration/trackzor_migration_generator.rb", "init.rb", "lib/trackzor.rb", "trackzor.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG", "README.rdoc", "lib/trackzor.rb", "tasks/trackzor.rake"]
+  s.files = ["CHANGELOG", "Manifest", "README.rdoc", "Rakefile", "generators/trackzor_migration/templates/migration.rb", "generators/trackzor_migration/trackzor_migration_generator.rb", "init.rb", "lib/trackzor.rb", "tasks/trackzor.rake", "trackzor.gemspec"]
   s.homepage = %q{http://github.com/corneldm/trackzor}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Trackzor", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: trackzor
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors: 
 - David Cornelius
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-22 00:00:00 -05:00
+date: 2010-01-25 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -23,6 +23,7 @@ extra_rdoc_files:
 - CHANGELOG
 - README.rdoc
 - lib/trackzor.rb
+- tasks/trackzor.rake
 files: 
 - CHANGELOG
 - Manifest
@@ -32,6 +33,7 @@ files:
 - generators/trackzor_migration/trackzor_migration_generator.rb
 - init.rb
 - lib/trackzor.rb
+- tasks/trackzor.rake
 - trackzor.gemspec
 has_rdoc: true
 homepage: http://github.com/corneldm/trackzor