legacy_migrations 0.3.2 → 0.3.5

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.3.5

data/legacy_migrations.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{legacy_migrations}
-  s.version = "0.3.2"
+  s.version = "0.3.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bernie Telles"]
-  s.date = %q{2010-05-31}
+  s.date = %q{2010-06-12}
   s.description = %q{Rails plugin for transferring or updating data between two db structures.}
   s.email = %q{bernardo.telles@dms.myflorida.com}
   s.extra_rdoc_files = [
@@ -47,21 +47,21 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/btelles/legacy_migrations}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Rails plugin for transferring or updating data between two db structures.}
   s.test_files = [
     "spec/lib/transformations_spec.rb",
-     "spec/db/schema.rb",
      "spec/models.rb",
      "spec/legacy_migrations_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "spec/db/schema.rb"
   ]
 
   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
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])

data/lib/legacy_migrations.rb

@@ -12,17 +12,20 @@ module LegacyMigrations
   #   This is useful when you're trying to find faulty data in the source
   #   table, and don't want to run the entire dataset.
   # * <tt>:validate</tt> - Default = true. Use ActiveRecord validations
-  #   when saving destination data.
+  #   when saving the destination rows.
   # * <tt>:source_type</tt> - Default = :active_record. Sets the source
   #   destination type.
   #   Options:
-  #   _:active_record_: Assumes the From option is a class that inherits
+  #   _:active\_record_: Assumes the From option is a class that inherits
   #   from ActiveRecord::Base, then iterates through each record of From
   #   table by using *From*.all.each...
   #   _:other_: Assumes the From option is an iterable 'collection' whose 
-  #   elements/items can respond to all columns speficied in the given block.
+  #   elements/items can respond to all source methods speficied in the given block.
   # * <tt>:store_as</tt> - Stores the generated destination record as a key
-  #   that is retrievable in other transformations
+  #   that is retrievable in other transformations. Note that for this to work, the 
+  #   source object must respond to the method <tt>id</tt> which returns
+  #   a value that is unique for all rows within the table (usually 
+  #   this is just a primary key).
   #
   #   _Example_
   #   <tt>
@@ -50,6 +53,52 @@ module LegacyMigrations
     @status_report
   end
 
+  # Define a source and destination table with which to update data
+  #
+  # This method accepts all of the same options as <tt>transfer_from</tt>.
+  #
+  # In addition, you'll need to use a series of columns that match data
+  # from the source to the destination. For example, if your source  and 
+  # destination data have a social security number, then you'd use the
+  # social security number to match records from the two rows. The following
+  # is how you would do that.
+  #
+  # <tt>
+  # update_from SourceTable, :to => DestinationTable do 
+  #   based_on do
+  #     ssn == from.social_security_number
+  #   end
+  #
+  #   from :last_name, :to => :last_name
+  # end
+  # </tt>
+  #
+  # Note that when using the 'based_on' method, the left-hannd item always
+  # corresponds to a column method on the destination table.
+  # 
+  # The methods available in the based_on block correspond to the well-known
+  # squirrel plugin's syntax. Here's a quick review of the possible operators:
+  #
+  # Handles comparisons in the query. This class is analagous to the columns in the database.
+  # When comparing the Condition to a value, the operators are used as follows:
+  # * ==, === : Straight-up Equals. Can also be used as the "IN" operator if the operand is an Array.
+  # Additionally, when the oprand is +nil+, the comparison is correctly generates as "IS NULL"."
+  # * =~ : The LIKE and REGEXP operators. If the operand is a String, it will generate a LIKE
+  # comparison. If it is a Regexp, the REGEXP operator will be used. NOTE: MySQL regular expressions
+  # are NOT the same as Ruby regular expressions. Also NOTE: No wildcards are inserted into the LIKE
+  # comparison, so you may add them where you wish.
+  # * <=> : Performs a BETWEEN comparison, as long as the operand responds to both #first and #last,
+  # which both Ranges and Arrays do.
+  # * > : A simple greater-than comparison.
+  # * >= : Greater-than or equal-to.
+  # * < : A simple less-than comparison.
+  # * <= : Less-than or equal-to.
+  # * contains? : Like =~, except automatically surrounds the operand in %s, which =~ does not do.
+  # * nil? : Works exactly like "column == nil", but in a nicer syntax, which is what Squirrel is all about.
+  #
+  # ==== Options
+  #
+  # 
   def update_from(from_table, *args, &block)
 
     configure_transfer(from_table, *args) { yield }

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: legacy_migrations
 version: !ruby/object:Gem::Version 
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - Bernie Telles
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-31 00:00:00 -04:00
+date: 2010-06-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -77,29 +80,33 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Rails plugin for transferring or updating data between two db structures.
 test_files: 
 - spec/lib/transformations_spec.rb
-- spec/db/schema.rb
 - spec/models.rb
 - spec/legacy_migrations_spec.rb
 - spec/spec_helper.rb
+- spec/db/schema.rb