migratrix 0.0.5 → 0.0.6

data/lib/migratrix.rb

@@ -5,12 +5,15 @@ module Migratrix
   APP=Pathname.new(__FILE__).dirname + "migratrix"
   EXT=Pathname.new(__FILE__).dirname + "patches"
 
-  DEFAULT_MIGRATIONS_PATH = Rails.root + 'lib/migrations'
-
+  def self.default_migrations_path
+    Rails.root + 'lib/migrations'
+  end
 
   require EXT + 'string_ext'
   require EXT + 'object_ext'
   require EXT + 'andand'
+  require APP + 'logger'
+  require APP + 'loggable'
   require APP + 'exceptions'
   require APP + 'migration'
   require APP + 'migratrix'

data/lib/migratrix/loggable.rb

@@ -0,0 +1,14 @@
+module Migratrix
+  module Loggable
+    module ClassMethods
+      def logger
+        ::Migratrix::Logger.logger
+      end
+    end
+
+    def logger
+      ::Migratrix::Logger.logger
+    end
+
+  end
+end

data/lib/migratrix/logger.rb

@@ -0,0 +1,56 @@
+module Migratrix
+  class Logger
+    attr_accessor :level, :stream
+
+    FATAL = 0
+    ERROR = 1
+    WARN = 2
+    DEBUG = 3
+    INFO = 4
+
+    @@singleton_instance = new
+
+    def self.logger
+      @@singleton_instance
+    end
+
+    def self.set_logger(stream=$stdout, level=INFO)
+      self.logger.stream=stream
+      self.logger.level=level
+    end
+
+    def initialize(stream, level)
+       # :nocov: SimpleCov can't see into this method.
+      @stream, @level = stream, level
+    end
+
+    def fatal(msg)
+      log(msg, FATAL)
+    end
+
+    def error(msg)
+      log(msg, ERROR)
+    end
+
+    def warn(msg)
+      log(msg, WARN)
+    end
+
+    def debug(msg)
+      log(msg, DEBUG)
+    end
+
+    def info(msg)
+      log(msg, INFO)
+    end
+
+    def log(msg, level)
+      if level <= @level
+        @stream.puts "%c %s: %s" % ["FEWDI"[level], Time.now.strftime("%F %T"), msg]
+        @stream.flush
+      end
+    end
+
+    private_class_method :new
+  end
+end

data/lib/migratrix/migration.rb

@@ -2,21 +2,14 @@ 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
-    attr_accessor :options, :logger
+    include ::Migratrix::Loggable
+    extend ::Migratrix::Loggable::ClassMethods
+
+    attr_accessor :options
 
     def initialize(options={})
       # cannot make a deep copy of an IO stream (e.g. logger) so make a shallow copy of it and move it out of the way
-      @options = options.dup.tap {|h| @logger = h.delete("logger")}.deep_copy
-
-#       if options["logger"]
-#         @logger = options["logger"]
-#         options = options.dup
-#         options.delete["logger"]
-#       end
-#       @options = options.deep_copy
-      # This should only be loaded if a) the Migration uses the AR
-      # extract strategy and b) it's not already loaded
-#      ::ActiveRecord::Base.send(:include, MigrationHelpers) unless ::ActiveRecord::Base.const_defined?("MigrationHelpers")
+      @options = options.deep_copy
     end
 
     # Load this data from source
@@ -41,12 +34,6 @@ module Migratrix
       transform
       load
     end
-
-    def self.log(msg="", level=:info)
-      return unless logger
-      level = :info unless level.in? [:debug, :info, :warn, :error, :fatal, :unknown]
-      logger.send level, "#{Time.now.strftime('%T')}: #{msg}"
-    end
   end
 end
 

data/lib/migratrix/migratrix.rb

@@ -2,12 +2,25 @@
 # and integrating all the parts of a migration.
 
 module Migratrix
-
-  def migrate(name, options={})
+  def self.migrate!(name, options={})
     ::Migratrix::Migratrix.migrate(name, options)
   end
 
+  def self.logger
+    ::Migratrix::Migratrix.logger
+  end
+
+  def self.logger=(new_logger)
+    ::Migratrix::Migratrix.logger= new_logger
+  end
+
   class Migratrix
+    include ::Migratrix::Loggable
+    extend ::Migratrix::Loggable::ClassMethods
+
+    def initialize
+    end
+
     def self.migrate(name, options={})
       migratrix = self.new()
       migration = migratrix.create_migration(name, options)
@@ -46,7 +59,7 @@ module Migratrix
     end
 
     def valid_options
-      %w(limit where logger)
+      %w(limit where)
     end
 
     # ----------------------------------------------------------------------
@@ -69,30 +82,12 @@ module Migratrix
     # End MigrationRegistry
     # ----------------------------------------------------------------------
 
-    # ----------------------------------------------------------------------
-    # Migration path class accessors. Defaults to lib/migrations.
     def migrations_path
-      @migrations_path ||= ::Migratrix::DEFAULT_MIGRATIONS_PATH
+      @migrations_path ||= ::Migratrix.default_migrations_path
     end
 
     def migrations_path=(new_path)
       @migrations_path = Pathname.new new_path
     end
-
-#     def self.migrations_path
-#       @@migrations_path ||= ::Migratrix::DEFAULT_MIGRATIONS_PATH
-#     end
-
-#     def self.migrations_path=(new_path)
-#       @@migrations_path = Pathname.new new_path
-#     end
-    # End Migration path management
-    # ----------------------------------------------------------------------
-
-#     def self.log(msg="", level=:info)
-#       return if quiet
-#       level = :info unless level.in? [:debug, :info, :warn, :error, :fatal, :unknown]
-#       logger.send level, "#{Time.now.strftime('%T')}: #{msg}"
-#     end
   end
 end

data/spec/lib/logger_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Migratrix::Logger do
+  let(:logger) { Migratrix::Logger.logger }
+
+  describe "sanity check kitty" do
+    it "is sanity checked" do
+      Migratrix::Logger.should_not be_nil
+      Migratrix::Logger.class.should == Class
+    end
+  end
+
+  describe "singleton-ness" do
+    it "is singleton-y" do
+      Migratrix::Logger.logger.class.should == Migratrix::Logger
+    end
+
+    it "cannot be new'ed" do
+      lambda { Migratrix::Logger.new }.should raise_error(NoMethodError)
+    end
+  end
+
+  describe "default" do
+    it "logs to $stdout" do
+      logger.stream == $stdout
+    end
+  end
+
+
+  describe "logging" do
+    let(:buffer) { StringIO.new }
+
+    before do
+      Timecop.freeze(Time.local(2011, 6, 28, 3, 14, 15))
+    end
+
+    after do
+      Timecop.return
+    end
+
+    it "formats info message with level and timestamp" do
+      with_logger_streaming_to(buffer) do
+        logger.info("Test Message")
+        buffer.string.should == "I 2011-06-28 03:14:15: Test Message\n"
+      end
+    end
+
+    it "formats debug message with level and timestamp" do
+      with_logger_streaming_to(buffer) do
+        logger.debug("Test Message")
+        buffer.string.should == "D 2011-06-28 03:14:15: Test Message\n"
+      end
+    end
+
+    it "formats warning message with level and timestamp" do
+      with_logger_streaming_to(buffer) do
+        logger.warn("Test Message")
+        buffer.string.should == "W 2011-06-28 03:14:15: Test Message\n"
+      end
+    end
+
+    it "formats error message with level and timestamp" do
+      with_logger_streaming_to(buffer) do
+        logger.error("Test Message")
+        buffer.string.should == "E 2011-06-28 03:14:15: Test Message\n"
+      end
+    end
+
+    it "formats fatal message with level and timestamp" do
+      with_logger_streaming_to(buffer) do
+        logger.fatal("Test Message")
+        buffer.string.should == "F 2011-06-28 03:14:15: Test Message\n"
+      end
+    end
+
+    it "rejects messages below logger level" do
+      with_logger_streaming_to(buffer, Migratrix::Logger::ERROR) do
+        logger.info("Test Message")
+        logger.debug("Test Message")
+        logger.warn("Test Message")
+        buffer.size.should == 0
+        logger.error("Test Error")
+        logger.fatal("Test Fatal")
+        buffer.string.should == "E 2011-06-28 03:14:15: Test Error\nF 2011-06-28 03:14:15: Test Fatal\n"
+      end
+    end
+  end
+
+end

data/spec/lib/migration_spec.rb

@@ -17,18 +17,6 @@ describe Migratrix::Migration do
       migration.options["where"].should == ["id=? AND approved=? AND pants=?", 42, true, false]
       conditions.should == ["id=? AND approved=?", 42, true]
     end
-
-    it "safely moves logger option out of its options and into logger attribute" do
-      conditions = ["id=? AND approved=?", 42, true]
-      logger = Logger.new(StringIO.new)
-      options = { "where" => conditions, "logger" => logger }
-
-      migration = Migratrix::TestMigration.new(options)
-
-      migration.options.should_not have_key("logger")
-      migration.logger.should == logger
-      options.should == { "where" => conditions, "logger" => logger }
-    end
   end
 
   describe "#migrate" do

data/spec/lib/migratrix_spec.rb

@@ -1,19 +1,5 @@
 require 'spec_helper'
 
-# Migatrix loads Migration classes into its namespace. In order to
-# test collision prevention, I needed to reach into Migratrix and
-# mindwipe it of any migrations. Here's the shiv to do that. I
-# originally put an API to do this on Migratrix but these specs are
-# the only clients of it so I removed it again. If you find a
-# legitimate use for it, feel free to re-add a remove_migration
-# method and send me a patch.
-def reset_migratrix!(migratrix)
-  Migratrix.constants.map(&:to_s).select {|m| m =~ /.+Migration$/}.each do |migration|
-    Migratrix.send(:remove_const, migration.to_sym)
-  end
-  migratrix.registered_migrations.clear
-end
-
 describe Migratrix::Migratrix do
   let (:migratrix) { Migratrix::Migratrix.new }
 
@@ -60,7 +46,7 @@ describe Migratrix::Migratrix do
 
   describe "#valid_options" do
     it "returns the valid set of option keys" do
-      migratrix.valid_options.should == ["limit", "where", "logger"]
+      migratrix.valid_options.should == ["limit", "where"]
     end
   end
 
@@ -110,7 +96,31 @@ describe Migratrix::Migratrix do
     it "loads migration and migrates it" do
       Migratrix::Migratrix.stub!(:new).and_return(migratrix)
       Migratrix::Migratrix.migrate :marbles
-      Migratrix::MarblesMigration.should be_migrated
+    end
+  end
+
+  describe ".logger" do
+    it "sets up a default logger to stdout" do
+      migratrix.logger.class.should == ::Migratrix::Logger
+    end
+  end
+
+  describe ".logger=" do
+    let (:migration) { migratrix.create_migration :marbles }
+    let (:buffer) { StringIO.new }
+
+    before do
+      reset_migratrix! migratrix
+      migratrix.migrations_path = SPEC + "fixtures/migrations"
+    end
+
+    it "sets logger globally across all Migratrices, the Migratrix module, Migrators and Models" do
+      with_logger_streaming_to(buffer) do
+        Migratrix.logger.stream.should == buffer
+        Migratrix::Migratrix.logger.stream.should == buffer
+        migratrix.logger.stream.should == buffer
+        migration.logger.stream.should == buffer
+      end
     end
   end
 end

data/spec/migratrix_module_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Migratrix do
+  describe "sanity check kitty" do
+    it "is sanity checked" do
+      Migratrix.should_not be_nil
+      Migratrix.class.should == Module
+    end
+  end
+
+  describe ".migrate!" do
+    let (:migratrix) { Migratrix::Migratrix.new }
+
+    before do
+      reset_migratrix! migratrix
+      Migratrix::Migratrix.stub!(:new).and_return(migratrix)
+      migratrix.migrations_path = SPEC + "fixtures/migrations"
+    end
+
+    it "delegates to Migratrix::Migratrix" do
+      Migratrix.migrate! :marbles
+      Migratrix::MarblesMigration.should be_migrated
+    end
+  end
+
+  describe ".logger" do
+    it "delegates to Migratrix::Migratrix" do
+      Migratrix::Migratrix.should_receive(:logger).and_return nil
+      Migratrix.logger
+    end
+  end
+
+  describe ".logger=" do
+    let (:logger) { Logger.new(StringIO.new) }
+    it "delegates to Migratrix::Migratrix" do
+      Migratrix::Migratrix.should_receive(:logger=).with(logger).and_return nil
+      Migratrix.logger = logger
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ end
 require 'pathname'
 require 'ruby-debug'
 require 'rails'
+require 'timecop'
 require 'logger'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
@@ -26,6 +27,36 @@ Dir[SPEC + "support/**/*.rb"].each {|f| require f}
 
 require LIB + 'migratrix'
 
+# Migatrix loads Migration classes into its namespace. In order to
+# test collision prevention, I needed to reach into Migratrix and
+# mindwipe it of any migrations. Here's the shiv to do that. I
+# originally put an API to do this on Migratrix but these specs are
+# the only clients of it so I removed it again. If you find a
+# legitimate use for it, feel free to re-add a remove_migration
+# method and send me a patch.
+def reset_migratrix!(migratrix)
+  Migratrix.constants.map(&:to_s).select {|m| m =~ /.+Migration$/}.each do |migration|
+    Migratrix.send(:remove_const, migration.to_sym)
+  end
+  migratrix.registered_migrations.clear
+end
+
+# Redirect singleton logger to stream and level of our choice, then
+# release it after the spec finishes or crashes.
+def with_logger_streaming_to(stream, level=Migratrix::Logger::INFO, &block)
+  begin
+    old_stream, old_level = Migratrix::Logger.logger.stream, Migratrix::Logger.logger.level
+    Migratrix::Logger.set_logger(stream, level)
+    yield
+  ensure
+    Migratrix::Logger.set_logger old_stream, old_level
+  end
+end
+
+
+
+
+
 RSpec.configure do |config|
   # == Mock Framework
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: migratrix
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-10-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &2153520180 !ruby/object:Gem::Requirement
+  requirement: &2161683820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153520180
+  version_requirements: *2161683820
 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
@@ -38,15 +38,19 @@ files:
 - lib/migratrix.rb
 - lib/migratrix/active_record_migration_helpers.rb
 - lib/migratrix/exceptions.rb
+- lib/migratrix/loggable.rb
+- lib/migratrix/logger.rb
 - lib/migratrix/migration.rb
 - lib/migratrix/migratrix.rb
 - lib/patches/andand.rb
 - lib/patches/object_ext.rb
 - lib/patches/string_ext.rb
 - spec/fixtures/migrations/marbles_migration.rb
+- spec/lib/logger_spec.rb
 - spec/lib/migration_spec.rb
 - spec/lib/migrator_spec.rb
 - spec/lib/migratrix_spec.rb
+- spec/migratrix_module_spec.rb
 - spec/patches/object_ext_spec.rb
 - spec/patches/string_ext_spec.rb
 - spec/spec_helper.rb