schema_migration_monitor 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.2-p290@schema_migration_monitor

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in schema_migration_monitor.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Vita Rara (dba Enable Labs)
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,42 @@
+# SchemaMigrationMonitor
+
+This gem is used to warn developers of pending schema migrations.  Each time your development or test environment is loaded, a migration check will occur.  If a pending migration is found, the following example output will be in sent to your console output:
+
+
+    ********************************************************
+    ** The following migration(s) need to be run:         **
+    **   - ./db/migrate/20120627151108_create_examples.rb **
+    ********************************************************
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'schema_migration_monitor', :group => [:development, :test]
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install schema_migration_monitor
+
+## Usage
+
+  Require the gem!
+
+## Custom Migration Path
+
+The gem uses the path './db/migrate' by default to find your migrations. If your project is using a custom path for migrations you must put a '.schema_migration_monitor.yml' in your project's root path. A sample '.schema_migration_monitor.yml' file would be written as follows:
+
+    migration_path: './custom_migration_path'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/schema_migration_monitor/migration_path_service.rb

@@ -0,0 +1,25 @@
+require 'pathname'
+
+class MigrationPathService
+
+  DEFAULT_MIGRATION_PATH = './db/migrate'
+  USER_CONFIG_PATH = '.schema_migration_monitor.yml'
+
+  class MigrationPathNotFoundError < StandardError; end
+
+  class << self
+    def execute
+      return get_user_config_path if Pathname.new(USER_CONFIG_PATH).exist?
+      return DEFAULT_MIGRATION_PATH if Pathname.new(DEFAULT_MIGRATION_PATH).exist?
+      raise MigrationPathNotFoundError
+    end
+
+    def get_user_config_path
+      YAML::load(user_config_file)['migration_path']
+    end
+
+    def user_config_file
+      File.open(USER_CONFIG_PATH)
+    end
+  end
+end

data/lib/schema_migration_monitor/monitor.rb

@@ -0,0 +1,83 @@
+require 'active_record'
+require File.dirname(__FILE__) + '/migration_path_service'
+
+module ActiveRecord
+  module ConnectionAdapters
+    class ConnectionHandler
+
+      alias_method :establish_connection_without_monitor, :establish_connection
+
+      def establish_connection(name, spec)
+        result = establish_connection_without_monitor(name,spec)
+        monitor_migrations
+        result
+      end
+
+      def monitor_migrations
+        SchemaMigrationMonitor::Monitor.new.execute
+      end
+    end
+  end
+end
+
+module SchemaMigrationMonitor
+  class Monitor
+    
+    def initialize(output_stream = $stdout)
+      @migration_path = MigrationPathService.execute
+      @output_stream = output_stream
+    end
+
+    def execute
+      @pending_migrations = get_pending_migrations
+      return if @pending_migrations.empty?
+      output_report
+    end
+
+    def output_report
+      write_boxed_output(report_text.split("\n"))
+    end
+
+    def report_text
+      res = "The following migration(s) need to be run:"
+      res << @pending_migrations.map { |migration| "\n  - #{migration.filename}" }.join
+    end
+
+    def write_boxed_output(text_lines)
+      longest_line = get_longest_line(text_lines)
+
+      wrap_output_in_red do
+        @output_stream.write("*" * (longest_line + 6) + "\n")
+
+        text_lines.each do |line|
+          @output_stream.write "** #{line}#{ " " * (longest_line - line.to_s.length) } **\n"
+        end
+
+        @output_stream.write("*" * (longest_line + 6) + "\n")
+      end
+    end
+
+    def wrap_output_in_red
+      @output_stream.write("\e[1;31m\n")
+      yield if block_given?
+      @output_stream.write("\n\e[0m") 
+    end
+
+    def get_longest_line(text_lines)
+      text_lines.inject(0) do |memo, arg|
+        line_length = arg.to_s.length
+        memo = line_length if line_length > memo
+        memo
+      end
+    end
+
+    def get_pending_migrations
+      migrator.pending_migrations
+    end
+
+    def migrator
+      @migrator ||= ActiveRecord::Migrator.new(:up, @migration_path)
+    end
+
+  end
+end

data/lib/schema_migration_monitor/version.rb

@@ -0,0 +1,3 @@
+module SchemaMigrationMonitor
+  VERSION = "0.0.1"
+end

data/lib/schema_migration_monitor.rb

@@ -0,0 +1,2 @@
+require 'schema_migration_monitor/version'
+require 'schema_migration_monitor/monitor'

data/schema_migration_monitor.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/schema_migration_monitor/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Enable Labs"]
+  gem.email         = ["info@enablelabs.com"]
+  gem.description   = %q{Make sure the test environment schema is up to date.}
+  gem.summary       = %q{Make sure the test environment schema is up to date.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "schema_migration_monitor"
+  gem.require_paths = ["lib"]
+  gem.version       = SchemaMigrationMonitor::VERSION
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency 'sqlite3'
+
+  gem.add_dependency "activerecord"
+end

data/spec/migration_path_service_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'pathname'
+
+describe MigrationPathService do
+  describe ".execute" do
+    describe "when no .schema_migration_monitor config exists" do
+      before(:each) do
+        Pathname.expects(:new).with(MigrationPathService::USER_CONFIG_PATH).returns( mock(exist?:false) )
+      end
+
+      it "should verify a ./db/migrate directory exists" do
+        Pathname.expects(:new).with('./db/migrate').returns( mock(exist?:true) )
+        MigrationPathService.execute
+      end
+
+      describe "when a ./db/migrate directory exists" do
+        it "should return the string './db/migrate'" do
+          Pathname.expects(:new).with('./db/migrate').returns( mock(exist?:true) )
+          MigrationPathService.execute.should == './db/migrate'
+        end
+      end
+
+      describe "when a ./db/migrate directory does not exist" do
+        it "should raise an exception" do
+          Pathname.expects(:new).with('./db/migrate').returns( mock(exist?:false) )
+
+          expect do
+            MigrationPathService.execute
+          end.should raise_error(MigrationPathService::MigrationPathNotFoundError)
+        end
+      end
+    end
+
+    describe "when .schema_migration_monitor config exists" do
+      let(:user_config_file_contents) do
+        contents=<<-EOF
+          migration_path: ./custom/migrate
+        EOF
+      end
+
+      before(:each) do
+        Pathname.expects(:new).with(MigrationPathService::USER_CONFIG_PATH).returns( mock(exist?:true) )
+        MigrationPathService.expects(:user_config_file).returns(user_config_file_contents)
+      end
+
+      it "should return the path contained in the .schema_migration_monitor config" do
+        MigrationPathService.execute.should == './custom/migrate'
+      end
+    end
+
+  end
+end

data/spec/monitor_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe SchemaMigrationMonitor::Monitor do
+  before(:each) do
+    MigrationPathService.stubs(:execute).returns(MigrationPathService::DEFAULT_MIGRATION_PATH)
+  end
+
+  describe "when ActiveRecord establishes a connection" do
+    it "should also execute the schema migration monitor" do
+      SchemaMigrationMonitor::Monitor.expects(:new).returns(mock(execute: nil))
+      ActiveRecord::Base.establish_connection({:adapter => 'sqlite3', database: ":memory:"})
+    end
+  end
+
+  describe "when there are no pending migrations" do
+    let!(:mock_migrator) do
+      mock('migrator').tap do |migrator|
+        migrator.expects(:pending_migrations).returns([])
+      end
+    end
+
+    before(:each) do
+      SchemaMigrationMonitor::Monitor.any_instance.expects(:migrator).returns(mock_migrator)
+    end
+
+    it "should do nothing" do
+      output_stream = mock('output_stream')
+      output_stream.expects(:write).never
+      SchemaMigrationMonitor::Monitor.new(output_stream).execute
+    end
+  end
+
+  describe "when there are pending migrations" do
+    let(:migrations) { [mock('migration1', filename:'20120101000000_fake_migration')] }
+
+    let!(:mock_migrator) do
+      mock('migrator').tap do |migrator|
+        migrator.expects(:pending_migrations).returns(migrations)
+      end
+    end
+
+    before(:each) do
+      SchemaMigrationMonitor::Monitor.any_instance.expects(:migrator).returns(mock_migrator)
+    end
+        
+    it "should print a message to stdout" do
+      read_io, write_io = IO.pipe
+      SchemaMigrationMonitor::Monitor.new(write_io).execute
+      write_io.close_write
+      read_io.read.should match(/The following migration\(s\) need to be run/)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+Dir['./lib/**/*.rb'].map { |f| require f }
+
+require 'mocha'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: schema_migration_monitor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Enable Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-27 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2165800900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165800900
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2165800480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165800480
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2165800060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165800060
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2165799640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165799640
+description: Make sure the test environment schema is up to date.
+email:
+- info@enablelabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/schema_migration_monitor.rb
+- lib/schema_migration_monitor/migration_path_service.rb
+- lib/schema_migration_monitor/monitor.rb
+- lib/schema_migration_monitor/version.rb
+- schema_migration_monitor.gemspec
+- spec/migration_path_service_spec.rb
+- spec/monitor_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Make sure the test environment schema is up to date.
+test_files:
+- spec/migration_path_service_spec.rb
+- spec/monitor_spec.rb
+- spec/spec_helper.rb