migratrix 0.8.1 → 0.8.2

data/lib/migratrix.rb

@@ -9,9 +9,12 @@ module Migratrix
   require EXT + 'string_ext'
   require EXT + 'object_ext'
   require EXT + 'andand'
+  require APP + 'exceptions'
+
+  require APP + 'callbacks'
   require APP + 'loggable'
+  require APP + 'migration_strategy'
   require APP + 'valid_options'
-  require APP + 'exceptions'
   require APP + 'registry'
   require APP + 'migration'
   require APP + 'migratrix'

data/lib/migratrix/callbacks.rb

@@ -0,0 +1,57 @@
+require 'active_support/concern'
+
+module Migratrix
+  # = Migratrix Callbacks
+  #
+  # Callbacks are hooks into the life cycle of a Migratrix Migration
+  # or Component object that allow you to trigger logic before or
+  # after an alteration of the object state. This can be used to do
+  # extra preparation or cleanup at each step along the way.  Consider
+  # the <tt>Migration#migrate</tt> call:
+  #
+  # * (1) <tt>before_migrate</tt>
+  # * (2) <tt>before_extract</tt>
+  # * (-) <tt>extract</tt>
+  # * (3) <tt>after_extract</tt>
+  # * (4) <tt>before_transform</tt>
+  # * (-) <tt>transform</tt>
+  # * (5) <tt>after_transform</tt>
+  # * (6) <tt>before_load</tt>
+  # * (-) <tt>load</tt>
+  # * (7) <tt>after_load</tt>
+  # * (8) <tt>after_migrate</tt>
+  #
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    CALLBACKS = [ :after_extract, :after_load, :after_migrate,
+      :after_transform, :around_extract, :around_load,
+      :around_migrate, :around_transform, :before_extract,
+      :before_load, :before_migrate, :before_transform
+    ]
+
+    included do
+      extend ActiveModel::Callbacks
+    #  include ActiveModel::Validations::Callbacks
+
+      define_model_callbacks :migrate, :extract, :load, :transform
+    end
+
+    def migrate #:nodoc:
+      run_callbacks(:migrate) { super }
+    end
+
+    def extract #:nodoc:
+      run_callbacks(:extract) { super }
+    end
+
+    def transform(*) #:nodoc:
+      run_callbacks(:transform) { super }
+    end
+
+    def load(*) #:nodoc:
+      run_callbacks(:load) { super }
+    end
+  end
+end
+

data/lib/migratrix/migration.rb

@@ -4,9 +4,11 @@ module Migratrix
   # Superclass for all migrations. Migratrix COULD check to see that a
   # loaded migration inherits from this class, but hey, duck typing.
   class Migration
-    include ::Migratrix::Loggable
+    include Migratrix::Loggable
     include ActiveModel::AttributeMethods
     include Migratrix::ValidOptions
+    include Migratrix::MigrationStrategy
+    include Migratrix::Callbacks
 
     attr_accessor :options
     set_valid_options :console
@@ -101,54 +103,6 @@ module Migratrix
     def loads
       self.class.loads
     end
-
-    def extract
-      extracted_items = {}
-      extractions.each do |name, extraction|
-        extracted_items[name] = extraction.extract(options)
-      end
-      extracted_items
-    end
-
-    # Transforms source data into outputs. @transformed_items is a
-    # hash of name => transformed_items.
-    #
-    def transform(extracted_items)
-      transformed_items = { }
-      transforms.each do |name, transform|
-        transformed_items[transform.name] = transform.transform extracted_items[transform.extraction]
-      end
-      transformed_items
-    end
-
-    # Saves the migrated data by "loading" it into our database or
-    # other data sink. Loaders have their own names, and by default
-    # they depend on a transformed_items key of the same name, but you
-    # may override this behavior by setting :source => :name or
-    # possibly :source => [:name1, :name2, etc].
-    def load(transformed_items)
-      loaded_items = { }
-      loads.each do |name, load|
-        loaded_items[load.name] = load.load transformed_items[load.transform]
-      end
-      loaded_items
-    end
-
-    # Perform the migration
-    # TODO: turn this into a strategy object. This pattern migrates
-    # everything in all one go, while the user may want to do a batch
-    # strategy. YAGNI: Rails 3 lets us defer the querying until we get
-    # to the transform step, and then it's batched for us under the
-    # hood. ...assuming, of course, we change the ActiveRecord
-    # extraction's execute_extract method to return source instead of
-    # all, but now the
-    def migrate
-      # This fn || @var API lets you write a method and either set the
-      # @var or return the value.
-      @extracted_items = extract || @extracted_items
-      @transformed_items = transform(@extracted_items) || @transformed_items
-      load @transformed_items
-    end
   end
 end
 

data/lib/migratrix/migration_strategy.rb

@@ -0,0 +1,53 @@
+module Migratrix
+  # TODO: blatant asymmetry here: extraction.extract gets options, but
+  # transform and load do not--and they should.
+  #
+  # = MigrationStrategy
+  #
+  # This module defines the basic strategy for a generic migration:
+  # extract gets a collection of items, transform transforms each
+  # item, then load calls save on that final transformed object.
+  module MigrationStrategy
+    def extract
+      extracted_items = {}
+      extractions.each do |name, extraction|
+        extracted_items[name] = extraction.extract(options)
+      end
+      extracted_items
+    end
+
+    # Transforms source data into outputs. @transformed_items is a
+    # hash of name => transformed_items.
+    #
+    def transform(extracted_items)
+      transformed_items = { }
+      transforms.each do |name, transform|
+        transformed_items[transform.name] = transform.transform extracted_items[transform.extraction]
+      end
+      transformed_items
+    end
+
+    # Saves the migrated data by "loading" it into our database or
+    # other data sink. Loaders have their own names, and by default
+    # they depend on a transformed_items key of the same name, but you
+    # may override this behavior by setting :source => :name or
+    # possibly :source => [:name1, :name2, etc].
+    def load(transformed_items)
+      loaded_items = { }
+      loads.each do |name, load|
+        loaded_items[load.name] = load.load transformed_items[load.transform]
+      end
+      loaded_items
+    end
+
+    # Perform the migration
+    def migrate
+      # This fn || @var API lets you write a method and either set the
+      # @var or return the value.
+      @extracted_items = extract || @extracted_items
+      @transformed_items = transform(@extracted_items) || @transformed_items
+      load @transformed_items
+    end
+  end
+end
+

data/spec/lib/migratrix/callbacks_spec.rb

@@ -0,0 +1,218 @@
+class NoOpExtraction < Migratrix::Extractions::Extraction
+  def extract(options={})
+    []
+  end
+end
+
+class NoOpTransform < Migratrix::Transforms::Transform
+  def transform(exts, options={})
+    []
+  end
+end
+
+class NoOpLoad < Migratrix::Loads::Load
+  def load(trans, options={})
+    []
+  end
+end
+
+Migratrix::Migratrix.register_extraction :no_op, NoOpExtraction
+Migratrix::Migratrix.register_transform :no_op, NoOpTransform
+Migratrix::Migratrix.register_load :no_op, NoOpLoad
+
+
+class TestCallbackMigration < Migratrix::Migration
+  set_extraction :test, :no_op
+  set_transform :test, :no_op
+  set_load :test, :no_op
+end
+
+class MethodCallbackMigration < TestCallbackMigration
+  extend_extraction :test, {}
+  extend_transform :test, {}
+  extend_load :test, {}
+
+  attr_reader :before_migrate_called, :after_migrate_called, :around_migrate_called
+  attr_reader :before_extract_called, :after_extract_called, :around_extract_called
+  attr_reader :before_transform_called, :after_transform_called, :around_transform_called
+  attr_reader :before_load_called, :after_load_called, :around_load_called
+
+  before_migrate :before_migrate_method
+  after_migrate :after_migrate_method
+  around_migrate :around_migrate_method
+
+  def before_migrate_method
+    @before_migrate_called = true
+  end
+
+  def after_migrate_method
+    @after_migrate_called = true
+  end
+
+  def around_migrate_method
+    yield
+    @around_migrate_called = true
+  end
+
+  before_extract :before_extract_method
+  after_extract :after_extract_method
+  around_extract :around_extract_method
+
+  def before_extract_method
+    @before_extract_called = true
+  end
+
+  def after_extract_method
+    @after_extract_called = true
+  end
+
+  def around_extract_method
+    yield
+    @around_extract_called = true
+  end
+
+  before_transform :before_transform_method
+  after_transform :after_transform_method
+  around_transform :around_transform_method
+
+  def before_transform_method
+    @before_transform_called = true
+  end
+
+  def after_transform_method
+    @after_transform_called = true
+  end
+
+  def around_transform_method
+    yield
+    @around_transform_called = true
+  end
+
+  before_load :before_load_method
+  after_load :after_load_method
+  around_load :around_load_method
+
+  def before_load_method
+    @before_load_called = true
+  end
+
+  def after_load_method
+    @after_load_called = true
+  end
+
+  def around_load_method
+    yield
+    @around_load_called = true
+  end
+end
+
+class BlockCallbackMigration < TestCallbackMigration
+  attr_reader :before_migrate_called, :after_migrate_called
+  attr_reader :before_extract_called, :after_extract_called
+  attr_reader :before_transform_called, :after_transform_called
+  attr_reader :before_load_called, :after_load_called
+
+  before_migrate do
+    @before_migrate_called = true
+  end
+
+  after_migrate do
+    @after_migrate_called = true
+  end
+
+  before_extract do
+    @before_extract_called = true
+  end
+
+  after_extract do
+    @after_extract_called = true
+  end
+
+  before_transform do
+    @before_transform_called = true
+  end
+
+  after_transform do
+    @after_transform_called = true
+  end
+
+  before_load do
+    @before_load_called = true
+  end
+
+  after_load do
+    @after_load_called = true
+  end
+end
+
+describe "callbacks" do
+  describe "sanity check cat" do
+    it "is sanity checked" do
+      NoOpExtraction.should_not be_nil
+      NoOpTransform.should_not be_nil
+      NoOpLoad.should_not be_nil
+      TestCallbackMigration.should_not be_nil
+      MethodCallbackMigration.should_not be_nil
+    end
+  end
+
+  describe "with named callback methods" do
+    let(:migration) { MethodCallbackMigration.new }
+    before do
+      migration.migrate
+    end
+
+    it "calls migrate callbacks" do
+      migration.before_migrate_called.should be_true
+      migration.after_migrate_called.should be_true
+      migration.around_migrate_called.should be_true
+    end
+
+    it "calls extract callbacks" do
+      migration.before_extract_called.should be_true
+      migration.after_extract_called.should be_true
+      migration.around_extract_called.should be_true
+    end
+
+    it "calls transform callbacks" do
+      migration.before_transform_called.should be_true
+      migration.after_transform_called.should be_true
+      migration.around_transform_called.should be_true
+    end
+
+    it "calls load callbacks" do
+      migration.before_load_called.should be_true
+      migration.after_load_called.should be_true
+      migration.around_load_called.should be_true
+    end
+  end
+
+  describe "with block callbacks" do
+    let(:migration) { BlockCallbackMigration.new }
+    before do
+      migration.migrate
+    end
+
+    it "calls migrate callbacks" do
+      migration.before_migrate_called.should be_true
+      migration.after_migrate_called.should be_true
+    end
+
+    it "calls extract callbacks" do
+      migration.before_extract_called.should be_true
+      migration.after_extract_called.should be_true
+    end
+
+    it "calls transform callbacks" do
+      migration.before_transform_called.should be_true
+      migration.after_transform_called.should be_true
+    end
+
+    it "calls load callbacks" do
+      migration.before_load_called.should be_true
+      migration.after_load_called.should be_true
+    end
+  end
+end
+
+

data/spec/lib/migratrix/migratrix_spec.rb

@@ -108,6 +108,5 @@ describe Migratrix::Migratrix do
       end
     end
   end
-
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: migratrix
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-24 00:00:00.000000000Z
+date: 2011-10-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &2164512960 !ruby/object:Gem::Requirement
+  requirement: &2152828360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164512960
+  version_requirements: *2152828360
 description: Migratrix, a Rails legacy database migration tool supporting multiple
   strategies, including arbitrary n-ary migrations (1->n, n->1, n->m), arbitrary inputs
   and outputs (ActiveRecord, bare SQL, CSV) and migration logging
@@ -37,6 +37,7 @@ files:
 - bin/migratrix
 - lib/migratrix.rb
 - lib/migratrix/active_record_migration_helpers.rb
+- lib/migratrix/callbacks.rb
 - lib/migratrix/exceptions.rb
 - lib/migratrix/extractions/active_record.rb
 - lib/migratrix/extractions/extraction.rb
@@ -44,6 +45,7 @@ files:
 - lib/migratrix/loads/yaml.rb
 - lib/migratrix/loggable.rb
 - lib/migratrix/migration.rb
+- lib/migratrix/migration_strategy.rb
 - lib/migratrix/migratrix.rb
 - lib/migratrix/registry.rb
 - lib/migratrix/transforms/map.rb
@@ -54,6 +56,7 @@ files:
 - lib/patches/string_ext.rb
 - spec/fixtures/migrations/marbles_migration.rb
 - spec/lib/migratrix/_loggable_spec.rb
+- spec/lib/migratrix/callbacks_spec.rb
 - spec/lib/migratrix/extractions/active_record_spec.rb
 - spec/lib/migratrix/extractions/extraction_spec.rb
 - spec/lib/migratrix/loads/load_spec.rb