mlins-godwit 1.0.0

data/lib/godwit/base.rb

@@ -0,0 +1,43 @@
+module Godwit
+  # Godwit Base class.
+  #
+  # When this class is initialized, the Godwit environment is booted.
+  #
+  class Base
+
+    def initialize #:nodoc:
+      Godwit::Bootloader.boot
+    end
+    
+    # Starts Godwit.
+    #
+    def run
+      Godwit::Buffer.puts "\nLoading Migrations..." unless Godwit::Config[:silence]
+      unless Godwit::Config[:specific_migration]
+        run_all
+      else
+        run_single
+      end
+      Godwit::Buffer.puts "\nDone." unless Godwit::Config[:silence]
+    end
+
+    protected
+
+    def run_single #:nodoc:
+      migration = Godwit::Config[:specific_migration].camelize.constantize
+      migration.new.run(Godwit::Config[:skip_dependencies])
+    end
+
+    def run_all #:nodoc:
+      Dir.foreach(File.join(Godwit::Config[:godwit_root], 'app', 'migrations')) do |file|
+        next unless file.ends_with?('migration.rb')
+        migration = file[0..-4].camelize.constantize
+        unless migration.completed? || Godwit::Config[:skip_migrations].include?(migration.to_s.underscore)
+          migration.new.run(Godwit::Config[:skip_dependencies])
+          migration.is_completed
+        end
+      end
+    end
+
+  end
+end

data/lib/godwit/bootloader.rb

@@ -0,0 +1,79 @@
+module Godwit
+  module Bootloader
+  
+    class << self
+  
+      attr_accessor :booted
+  
+      def boot(argv=ARGV) #:nodoc:
+        return if booted?
+        load_config(argv)
+        display_init unless Godwit::Config[:silence]
+        load_rails
+        set_load_path
+        set_logger
+        init_db
+        init_am
+        load_plugins
+        @booted = true
+      end
+      
+      def display_init #:nodoc:
+        system('clear')
+        Godwit::Buffer.puts "Godwit " + Godwit::VERSION::STRING
+        Godwit::Buffer.puts "\nInitializaing..."
+      end
+      
+      def booted? #:nodoc:
+        @booted ||= false
+      end
+      
+      def load_rails #:nodoc:
+        unless Godwit::Config[:rails_root].nil?
+          require "#{Godwit::Config[:rails_root]}/config/environment"
+        end
+      end
+      
+      def load_config(argv=ARGV) #:nodoc:
+        Godwit::Config.setup
+        require File.join(Godwit::Config[:godwit_root], 'config', 'environment.rb')
+        Godwit::Config.parse_args(argv)
+      end
+      
+      def set_load_path #:nodoc:
+        $:.concat [File.join(Godwit::Config[:godwit_root], 'app', 'models'),
+                   File.join(Godwit::Config[:godwit_root], 'app', 'migrations'),
+                   File.join(Godwit::Config[:godwit_root], 'lib')]
+        Dir[File.join(Godwit::Config[:godwit_root], 'vendor', 'plugins', '*', 'lib')].each do |dir|
+          $:.push dir
+        end
+        ActiveSupport::Dependencies.load_paths.concat $:           
+      end
+      
+      def set_logger #:nodoc:
+        ActiveRecord::Base.logger = Godwit::Config[:active_record_log]
+        ActiveRecord::Base.logger.level = Godwit::Config[:active_record_log_level]
+        ActiveMigration::Base.logger = Godwit::Config[:active_migration_log]
+        ActiveMigration::Base.logger.level = Godwit::Config[:active_migration_log_level]
+      end
+      
+      def init_db #:nodoc:
+        db_conf = YAML::load(File.open(File.join(Godwit::Config[:godwit_root], 'config', 'database.yml')))
+        LegacyRecord::Base.establish_connection(db_conf['legacy'])
+        ActiveRecord::Base.establish_connection(db_conf['active']) if Godwit::Config[:rails_root].nil?
+      end
+      
+      def init_am #:nodoc:
+        ActiveMigration::KeyMapper.storage_path = Godwit::Config[:key_mapper_path]
+      end
+      
+      def load_plugins #:nodoc:
+        Dir[File.join(Godwit::Config[:godwit_root], 'vendor', 'plugins', '*', 'init.rb')].each do |init|
+          require init
+        end
+      end
+      
+    end
+  
+  end
+end

data/lib/godwit/buffer.rb

@@ -0,0 +1,46 @@
+module Godwit
+  # This class is used to buffer output.  It's used to help out with view
+  # switching in the console.
+  #
+  class Buffer
+
+    class << self
+
+      # Returns the buffer.
+      #
+      def buffer
+        @buffer ||= ""
+        @buffer
+      end
+
+      # Sets the buffer
+      #
+      def buffer=(string)
+        @buffer ||= ""
+        @buffer = string
+      end
+
+      # Outputs text with Kernel#print and stores it in the buffer.
+      #
+      def print(string)
+        self.buffer += string
+        Kernel.print string
+      end
+
+      # Outputs text with Kernel#puts and stores it in the buffer.
+      #
+      def puts(string)
+        self.buffer += (string + "\n")
+        Kernel.puts string
+      end
+
+      # Clears the buffer.
+      #
+      def clear
+        self.buffer = ""
+      end
+
+    end
+
+  end
+end

data/lib/godwit/callbacks.rb

@@ -0,0 +1,34 @@
+module Godwit
+  # Callbacks for before and after run.
+  #
+  module Callbacks
+
+    CALLBACKS = %w(before_run after_run)
+
+    def self.included(base)
+      base.send :alias_method_chain, :run, :callbacks
+      base.send :include, ActiveSupport::Callbacks
+      base.define_callbacks *CALLBACKS
+    end
+
+    # This is called before you anything actually starts.
+    #
+    def before_run() end
+    # This is called after everything else finishes.
+    #
+    def after_run() end
+    def run_with_callbacks #:nodoc:
+      callback(:before_run)
+      run_without_callbacks
+      callback(:after_run)
+    end
+
+    private
+
+    def callback(method) #:nodoc:
+      run_callbacks(method)
+      send(method)
+    end
+
+  end
+end

data/lib/godwit/config.rb

@@ -0,0 +1,120 @@
+require 'optparse'
+
+module Godwit
+  
+  # Application configuration.
+  #
+  class Config
+
+    class << self
+
+      attr_accessor :configuration
+
+      # Default configuration details.
+      def defaults
+        @defaults ||= {
+          :godwit_root                => Dir.pwd,
+          :active_record_log          => nil,
+          :active_record_log_level    => nil,
+          :active_migration_log       => nil,
+          :active_migration_log_level => nil,
+          :rails_root                 => nil,
+          :key_mapper_path            => File.join(Dir.pwd, 'data', 'keymaps'),
+          :skip_dependencies          => false,
+          :skip_migrations            => [],
+          :specific_migration         => nil,
+          :silence                    => false,
+          :debug                      => false
+        }
+      end
+
+      # Yields the configuration.
+      #
+      #   Godwit::Config.use do |config|
+      #     config[:keymapper_path] = 'some/other/path'
+      #   end
+      #
+      def use
+        @configuration ||= {}
+        yield @configuration
+      end
+
+      # Returns the config value at the specified key.
+      #
+      def [](key)
+        (@configuration||={})[key]
+      end
+
+      # Set the config value at the specified key.
+      #
+      def []=(key,val)
+        @configuration[key] = val
+      end
+
+      # Deletes the config element by key.
+      #
+      def delete(key)
+        @configuration.delete(key)
+      end
+
+      # Sets up the configuration by storing the given settings.
+      #
+      def setup(settings = {})
+        @configuration ||= {}
+        if @configuration == {}
+          @configuration = defaults.merge(settings)
+        else
+          @configuration.merge!(settings)
+        end
+      end
+
+      # Parses command line arguments and stores them in the config.
+      #
+      def parse_args(argv = ARGV)
+        options = {}
+        opts = OptionParser.new do |opts|
+
+          opts.program_name = "Godwit"
+          opts.version = Godwit::VERSION::STRING
+          opts.banner  = "Usage: migrate [OPTIONS]\n"
+          opts.separator ""
+
+          opts.on("-D", "--debug", "Debug mode.") do |n|
+            options[:debug] = true
+          end
+
+          opts.on("-s", "--silent", "Silence, no output, good for scripts. Silence overrides Debug(you can't debug silently)") do |n|
+            options[:silence] = true
+          end
+
+          opts.on("-m", "--skip-migrations X,Y,Z", Array, "Use underscores. Won't skip it if it's a dependency, make sure you use -d too if you need that.") do |migrations|
+            options[:skip_migrations] = migrations
+          end
+
+          opts.on("-d", "--skip-dependencies", "Skip Dependencies") do |n|
+            options[:skip_dependencies] = true
+          end
+
+          opts.on("-S", "--specific-migration MIGRATION", "Specific Migration. Use underscores. Ex. products_migration.") do |migration|
+            options[:specific_migration] = migration
+          end
+
+          opts.on_tail("-h", "--help", "Show this message") do
+            puts opts
+            exit
+          end
+
+          opts.on_tail("-v", "--version", "Show version") do
+            puts 'Godwit ' + Godwit::VERSION::STRING
+            exit
+          end
+
+        end
+        opts.parse!(argv)
+        Godwit::Config.setup(options)
+      end
+
+    end
+
+  end
+end

data/lib/godwit/irb.rb

@@ -0,0 +1,33 @@
+require 'irb'
+
+module IRB #:nodoc:
+  module ExtendCommand #:nodoc:
+    class Continue # :nodoc:
+      def self.execute(conf) #:nodoc:
+        throw :IRB_EXIT, :cont
+      end
+    end
+  end
+  ExtendCommandBundle.def_extend_command "cont", :Continue
+
+  def self.start_session(binding) #:nodoc:
+    unless @__initialized
+      args = ARGV
+      ARGV.replace(ARGV.dup)
+      IRB.setup(nil)
+      ARGV.replace(args)
+      @__initialized = true
+    end
+
+    workspace = WorkSpace.new(binding)
+
+    irb = Irb.new(workspace)
+
+    @CONF[:IRB_RC].call(irb.context) if @CONF[:IRB_RC]
+    @CONF[:MAIN_CONTEXT] = irb.context
+
+    catch(:IRB_EXIT) do
+      irb.eval_input
+    end
+  end
+end

data/lib/godwit/legacy_record.rb

@@ -0,0 +1,11 @@
+# Namespace for legacy records.
+#
+module Legacy
+end
+
+# Extend ActiveRecord for the legacy database.
+#
+module LegacyRecord
+  class Base < ActiveRecord::Base
+  end
+end

data/lib/godwit/version.rb

@@ -0,0 +1,9 @@
+module Godwit #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/godwit.rb

@@ -0,0 +1,44 @@
+#--
+# Copyright (c) 2008 Matt Lins
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'active_support'
+require 'active_record'
+require 'active_migration'
+
+require 'godwit/active_migration'
+require 'godwit/base'
+require 'godwit/bootloader'
+require 'godwit/buffer'
+require 'godwit/config'
+require 'godwit/legacy_record'
+require 'godwit/irb'
+require 'godwit/callbacks'
+require 'godwit/version'
+
+Godwit::Base.class_eval do
+  include Godwit::Callbacks
+end

data/spec/active_migration_generator_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'ActiveMigrationGenerator' do
+  
+  include GeneratorSpecHelper
+  
+  before do
+    source = RubiGen::PathSource.new(:component, File.join(File.dirname(__FILE__), "../godwit_generators"))
+    RubiGen::Base.reset_sources
+    RubiGen::Base.prepend_sources source
+    @generator = RubiGen::Scripts::Generate.new
+  end
+  
+  it "should generate a migration in the migrations directory" do
+    silence_generator { @generator.run(['blah', '1', '2'], :generator => 'active_migration') }
+    File.file?(File.join(APP_ROOT, 'app', 'migrations', 'blah_migration.rb')).should be_true
+  end
+  
+  after do
+    FileUtils.rm_rf(File.join(APP_ROOT, 'app'))
+  end
+  
+end

data/spec/active_model_generator_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'ActiveModelGenerator' do
+  
+  include GeneratorSpecHelper
+  
+  before do
+    source = RubiGen::PathSource.new(:component, File.join(File.dirname(__FILE__), "../godwit_generators"))
+    RubiGen::Base.reset_sources
+    RubiGen::Base.prepend_sources source
+    @generator = RubiGen::Scripts::Generate.new
+  end
+  
+  it "should generate an active model" do
+    silence_generator { @generator.run(['blah'], :generator => 'active_model') }
+    File.file?(File.join(APP_ROOT, 'app', 'models', 'blah.rb')).should be_true
+  end
+  
+  after do
+    FileUtils.rm_rf(File.join(APP_ROOT, 'app'))
+  end
+  
+end

data/spec/buffer_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'godwit')
+
+describe 'Godwit::Buffer' do
+  
+  before do
+    Kernel.stub!(:print).and_return(nil)
+    Kernel.stub!(:puts).and_return(nil)
+  end
+  
+  it "should be '' at the first time it's accessed" do
+    Godwit::Buffer.buffer.should == ''
+  end
+  
+  it "should allow the buffer to be set with =" do
+    Godwit::Buffer.buffer='blah'
+    Godwit::Buffer.buffer.should == 'blah'
+  end
+  
+  it "should allow the buffer to be cleared" do
+    Godwit::Buffer.buffer = "blah"
+    Godwit::Buffer.clear
+    Godwit::Buffer.buffer.should == ''
+  end
+  
+  it "should print to the screen with #print" do
+    Kernel.should_receive(:print).with('blah')
+    Godwit::Buffer.print('blah')
+  end
+  
+  it "should store the value in the buffer when calling #print" do
+    Godwit::Buffer.print('blah')
+    Godwit::Buffer.buffer.should == 'blah'
+  end
+  
+  it "should print to the screen with #puts" do
+    Kernel.should_receive(:puts).with('blah')
+    Godwit::Buffer.puts('blah')
+  end
+  
+  it "should store the value in the buffer when calling #puts" do
+    Godwit::Buffer.puts('blah')
+    Godwit::Buffer.buffer.should == "blah\n"
+  end
+  
+  after do
+    Godwit::Buffer.clear
+  end
+  
+end

data/spec/callbacks_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'godwit')
+
+describe 'Godwit::Callbacks' do
+
+  before do
+    Godwit::Config.setup
+    Godwit::Config[:silence] = true
+    Godwit::Bootloader.stub!(:boot).and_return(nil)
+    @godwit = Godwit::Base.new
+    @godwit.stub!(:run_all).and_return(nil)
+  end
+
+  it "should call #before_run" do
+    @godwit.should_receive(:before_run).once
+    @godwit.run
+  end
+  
+  it "should call #after_run" do
+    @godwit.should_receive(:after_run).once
+    @godwit.run
+  end
+  
+  after do
+    Godwit::Config.configuration = nil
+  end
+
+end

data/spec/config_spec.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'godwit') 
+
+describe 'Godwit::Config' do
+  
+  before do
+    Godwit::Config.configuration = nil
+    Godwit::Config.setup
+  end
+  
+  it "should be able to yield the configuration via #use" do
+    res = nil
+    Godwit::Config.use {|c| res = c}
+    res.should == Godwit::Config.defaults
+  end
+  
+  it "should be able to get a configuration key" do
+    Godwit::Config[:bar] = "foo"
+    Godwit::Config[:bar].should == "foo"
+  end
+  
+  it "should be able to delete a configuration key" do
+    Godwit::Config[:bar] = "foo"
+    Godwit::Config.delete(:bar)
+    Godwit::Config[:bar].should be_nil
+  end
+  
+  it "should support -d to debug" do
+    Godwit::Config.parse_args(["-D"])
+    Godwit::Config[:debug].should be_true
+  end
+  
+  it "should support -s to silence output" do
+    Godwit::Config.parse_args(["-s"])
+    Godwit::Config[:silence].should be_true
+  end
+  
+  it "should support -d to skip dependencies" do
+    Godwit::Config.parse_args(["-d"])
+    Godwit::Config[:skip_dependencies].should be_true
+  end
+  
+  it "should support -m to skip migrations" do
+    Godwit::Config.parse_args(["-m", "products_migration,manufacturer_migration"])
+    Godwit::Config[:skip_migrations].should == ["products_migration","manufacturer_migration"]
+  end
+  
+  it "should support -S to run a specific migration" do
+    Godwit::Config.parse_args(['-S', 'products_migration'])
+    Godwit::Config[:specific_migration].should == 'products_migration'
+  end
+  
+end

data/spec/godwit_generator_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'GodwitGenerator' do
+  
+  include GeneratorSpecHelper
+
+  before do
+    source = RubiGen::PathSource.new(:application, File.join(File.dirname(__FILE__), "../app_generators"))
+    RubiGen::Base.reset_sources
+    RubiGen::Base.prepend_sources source
+    @generator = RubiGen::Scripts::Generate.new
+    @test_path = File.join(File.dirname(__FILE__), '..', 'tmp', 'test')
+  end
+
+  %w(tmp script log config app/models/legacy app/migrations lib vendor vendor/plugins data).each do |dir| 
+    it "should create the '#{dir}' directory" do
+      silence_generator { @generator.run(['tmp/test'], :generator => 'godwit') }
+      File.directory?(File.join(@test_path, dir)).should be_true
+    end
+  end
+
+  %w(Rakefile config/database.yml config/environment.rb log/active_migration.log log/active_record.log
+  script/console script/migrate script/generate script/destroy script/lib/console.rb).each do |file|
+    it "should create the '#{file}' file" do
+      silence_generator { @generator.run(['tmp/test'], :generator => 'godwit') }
+      File.file?(File.join(@test_path, file)).should be_true
+    end
+  end
+
+  after do
+    FileUtils.rm_rf(@test_path)
+  end
+
+end

data/spec/legacy_model_generator_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'LegacyModelGenerator' do
+  
+  include GeneratorSpecHelper
+  
+  before do
+    source = RubiGen::PathSource.new(:component, File.join(File.dirname(__FILE__), "../godwit_generators"))
+    RubiGen::Base.reset_sources
+    RubiGen::Base.prepend_sources source
+    @generator = RubiGen::Scripts::Generate.new
+  end
+  
+  it "should generate a legacy model in the legacy models directory" do
+    silence_generator { @generator.run(['blah'], :generator => 'legacy_model') }
+    File.file?(File.join(APP_ROOT, 'app', 'models', 'legacy', 'blah.rb')).should be_true
+  end
+  
+  after do
+    FileUtils.rm_rf(File.join(APP_ROOT, 'app'))
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour