pt-osc 0.2.2 → 0.2.3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.3
+
+- a warning will be issued if an `ALTER` command is called outside of a PtOscMigration
+
 ## 0.2.2
 
 - fix bugs with string quoting, use shellwords instead

data/README.md

@@ -1,7 +1,8 @@
-[![Travis CI](https://travis-ci.org/steverice/pt-osc.svg)](https://travis-ci.org/steverice/pt-osc)
-[![Code Climate](https://codeclimate.com/github/steverice/pt-osc.png)](https://codeclimate.com/github/steverice/pt-osc)
-[![Code Coverage](https://codeclimate.com/github/steverice/pt-osc/coverage.png)](https://codeclimate.com/github/steverice/pt-osc)
-[![Gem Version](https://badge.fury.io/rb/pt-osc.svg)](http://badge.fury.io/rb/pt-osc)
+[![Travis CI](https://img.shields.io/travis/steverice/pt-osc.svg)](https://travis-ci.org/steverice/pt-osc)
+[![Code Climate](https://img.shields.io/codeclimate/github/steverice/pt-osc.svg)](https://codeclimate.com/github/steverice/pt-osc)
+[![Code Coverage](https://img.shields.io/codeclimate/coverage/github/steverice/pt-osc.svg)](https://codeclimate.com/github/steverice/pt-osc)
+[![Gem Version](https://img.shields.io/gem/v/pt-osc.svg)](http://badge.fury.io/rb/pt-osc)
+[![Dependencies](https://img.shields.io/gemnasium/steverice/pt-osc.svg)](https://gemnasium.com/steverice/pt-osc)
 
 ## `pt-online-schema-change` migrations
 

data/lib/active_record/connection_adapters/mysql_pt_osc_adapter.rb

@@ -123,10 +123,24 @@ module ActiveRecord
 
       protected
       def add_command(table_name, command)
+        warn (<<-WARN
+        You are trying to ALTER table "#{table_name}" with the mysql_pt_osc adapter without using an PtOscMigration.
+        Be aware that ALTER commands will only be executed via pt-online-schema-change inside of an ActiveRecord::PtOscMigration.
+        It is likely that although your migration will complete, no schema alterations have been made.
+        WARN
+        ) if caller.any? { |c| c.include? 'active_record/migration.rb' } && caller.none? { |c| c.include? 'active_record/pt_osc_migration.rb' }
         get_commands[table_name] ||= []
         get_commands[table_name] << command
       end
 
+      # Provides the opportunity to handle warnings in a custom way
+      # @param [String] message
+      def warn(message)
+        # Rake tasks loaded through Railties had warnings silenced before Rails 4.1
+        # @see https://github.com/rails/rails/pull/11601
+        defined?(Rails) && Rails.version < '4.1' ? enable_warnings { super } : super
+      end
+
       def get_commands(table_name = nil)
         @osc_commands ||= {}
         table_name.nil? ? @osc_commands : @osc_commands[table_name]

data/lib/active_record/pt_osc_migration.rb

@@ -88,6 +88,11 @@ module ActiveRecord
       end
     end
 
+    def method_missing(method, *arguments, &block) # :nodoc:
+      # Putting this here ensures that pt_osc_migration shows up in the caller trace
+      super
+    end
+
     protected
     def execute_pt_osc
       return unless @connection.is_a? ActiveRecord::ConnectionAdapters::MysqlPtOscAdapter

data/lib/pt-osc/version.rb

@@ -1,5 +1,5 @@
 module Pt
   module Osc
-    VERSION = '0.2.2'
+    VERSION = '0.2.3'
   end
 end

data/test/functional/mysql_pt_osc_adapter_test.rb

@@ -3,6 +3,8 @@ require 'yaml'
 
 class MysqlPtOscAdapterTest < Test::Unit::TestCase
   class TestConnection < ActiveRecord::Base; end
+  class TestArMigration < ActiveRecord::Migration; end
+  class TestPtOscMigration < ActiveRecord::PtOscMigration; end
 
   def test_connection
     # Test that we can open a connection with the pt_osc adapter
@@ -18,4 +20,78 @@ class MysqlPtOscAdapterTest < Test::Unit::TestCase
     # Test that the adapter can be loaded when using the activerecord-import gem
     assert_nothing_raised { require 'activerecord-import' }
   end
+
+  context 'connected using stubbed pt-osc adapter' do
+    setup do
+      ActiveRecord::Base.establish_connection(test_spec)
+      ActiveRecord::ConnectionAdapters::MysqlPtOscAdapter.stubs(:execute)
+    end
+
+    teardown do
+      ActiveRecord::ConnectionAdapters::MysqlPtOscAdapter.unstub(:execute)
+    end
+
+    context 'an ActiveRecord::Migration' do
+      setup do
+        @migration = TestArMigration.new
+        @migration.instance_variable_set(:@connection, ActiveRecord::Base.connection)
+        @migration.stubs(:write)
+        @migration.stubs(:announce)
+      end
+
+      teardown do
+        @migration.unstub(:write, :announce)
+      end
+
+      should 'raise a warning when adding columns' do
+        add_column_fixtures.each do |fixture|
+          fixture_command = sprintf(fixture[:command], table: 'a', column: 'b', default: 0, nullable: true)
+          @migration.class.class_eval "def change; #{fixture_command}; end"
+          ActiveRecord::ConnectionAdapters::MysqlPtOscAdapter.any_instance.expects(:warn).once
+          @migration.migrate(:up)
+          @migration.class.send(:remove_method, :change)
+        end
+      end
+
+      should 'explicitly enable warnings for Rails versions before 4.1' do
+        fixture = add_column_fixtures.first
+        fixture_command = sprintf(fixture[:command], table: 'a', column: 'b', default: 0, nullable: true)
+        @migration.class.class_eval "def change; #{fixture_command}; end"
+        %w(3.1 3.1.8 3.2 3.2.20 4.0 4.0.12).each do |rails_version|
+          Rails.stubs(:version).returns(rails_version)
+          Object.any_instance.expects(:enable_warnings).once.yields
+          silence_warnings { @migration.migrate(:up) }
+        end
+        %w(4.1 4.1.9 4.2 4.2.0.beta4 4.2.1 5 5.0).each do |rails_version|
+          Rails.stubs(:version).returns(rails_version)
+          Object.any_instance.expects(:enable_warnings).never
+          silence_warnings { @migration.migrate(:up) }
+        end
+        @migration.class.send(:remove_method, :change)
+      end
+    end
+
+    context 'an ActiveRecord::PtOscMigration' do
+      setup do
+        @migration = TestPtOscMigration.new
+        @migration.instance_variable_set(:@connection, ActiveRecord::Base.connection)
+        @migration.stubs(:write)
+        @migration.stubs(:announce)
+      end
+
+      teardown do
+        @migration.unstub(:write, :announce)
+      end
+
+      should 'not raise a warning when adding columns' do
+        add_column_fixtures.each do |fixture|
+          fixture_command = sprintf(fixture[:command], table: 'a', column: 'b', default: 0, nullable: true)
+          @migration.class.class_eval "def change; #{fixture_command}; end"
+          ActiveRecord::ConnectionAdapters::MysqlPtOscAdapter.any_instance.expects(:warn).never
+          @migration.migrate(:up)
+          @migration.class.send(:remove_method, :change)
+        end
+      end
+    end
+  end
 end

data/test/functional/pt_osc_migration_functional_test.rb

@@ -22,7 +22,7 @@ class PtOscMigrationFunctionalTest < ActiveRecord::TestCase
       context 'on an existing table with an existing column' do
         setup do
           @table_name = Faker::Lorem.word
-          @column_name = Faker::Lorem.word
+          @column_name = 'foobar'
           @index_name = Faker::Lorem.words.join('_')
 
           ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS `#{@table_name}`;"
@@ -40,8 +40,8 @@ class PtOscMigrationFunctionalTest < ActiveRecord::TestCase
 
         context 'a migration with only ALTER statements' do
           setup do
-            @renamed_column_name = Faker::Lorem.word
-            @new_column_name = Faker::Lorem.word
+            @renamed_column_name = 'foobar'
+            @new_column_name = 'bazqux'
             @new_table_name = Faker::Lorem.word
             @index_name_2 = "#{@index_name}_2"
             @index_name_3 = "#{@index_name}_3"

data/test/integration/pt_osc_migration_integration_test.rb

@@ -46,32 +46,14 @@ class PtOscMigrationIntegrationTest < ActiveRecord::TestCase
             ]
           end
 
-          # Rails' "magic" time, for Time columns
-          # https://github.com/rails/rails/blob/fcf9b712b1dbbcb8f48644e6f20676ad9480ba66/activerecord/lib/active_record/type/time.rb#L16
-          base_date = Time.utc(2000, 1, 1, 0, 0, 0)
-
-          datetime_value = Time.at(Time.now.to_i).utc # Date types we're testing don't have sub-second precision
-          date_value = Time.utc(datetime_value.year, datetime_value.month, datetime_value.day)
-          rails_time_value = Time.utc(base_date.year, base_date.month, base_date.day, datetime_value.hour, datetime_value.min, datetime_value.sec)
-
-          [
-            { type: :integer, default: 42 },
-            { type: :string, default: ["'foobar'", ':bazqux'], expected_default: ['foobar', 'bazqux'] },
-            { type: :text, default: nil }, # TEXT columns cannot have a default http://dev.mysql.com/doc/refman/5.7/en/blob.html#idm140380410069472
-            { type: :float, default: 3.14159 },
-            { type: :datetime, default: "'#{datetime_value.strftime('%F %T')}'", expected_default: datetime_value },
-            { type: :time, default: "'#{datetime_value.strftime('%T')}'", expected_default: rails_time_value },
-            { type: :date, default: "'#{datetime_value.strftime('%F')}'", expected_default: date_value },
-            { type: :binary, default: nil }, # BLOB columns cannot have a default http://dev.mysql.com/doc/refman/5.7/en/blob.html#idm140380410069472
-            { type: :boolean, default: [false, true] },
-          ].each do |test|
+          add_column_fixtures.each do |test|
 
             defaults = [test[:default]].flatten(1).compact # remove nils for columns that can't have a default
             expected_defaults = test[:expected_default] ? [test[:expected_default]].flatten(1) : defaults
 
             should "add a nullable #{test[:type]} column with default null" do
               column_name = "#{@new_column_name}_#{test[:type]}"
-              @arguments[0] = "add_column :#{@table_name}, :#{column_name}, :#{test[:type]}, default: nil, null: true"
+              @arguments[0] = sprintf(test[:command], table: @table_name, column: column_name, default: nil, nullable: true)
               @arguments[-2] = column_name
               @arguments[-1] = { type: test[:type], null: true, default: nil }
               migrate_and_test_field *@arguments
@@ -80,7 +62,7 @@ class PtOscMigrationIntegrationTest < ActiveRecord::TestCase
             defaults.each_with_index do |default, index|
               should "add a nullable #{test[:type]} column with default value #{default}" do
                 column_name = "#{@new_column_name}_#{test[:type]}"
-                @arguments[0] = "add_column :#{@table_name}, :#{column_name}, :#{test[:type]}, default: #{default}, null: true"
+                @arguments[0] = sprintf(test[:command], table: @table_name, column: column_name, default: default, nullable: true)
                 @arguments[-2] = column_name
                 @arguments[-1] = { type: test[:type], null: true, default: expected_defaults[index] }
                 migrate_and_test_field *@arguments
@@ -88,7 +70,7 @@ class PtOscMigrationIntegrationTest < ActiveRecord::TestCase
 
               should "add a not-nullable #{test[:type]} column with default value #{default}" do
                 column_name = "#{@new_column_name}_#{test[:type]}"
-                @arguments[0] = "add_column :#{@table_name}, :#{column_name}, :#{test[:type]}, default: #{default}, null: false"
+                @arguments[0] = sprintf(test[:command], table: @table_name, column: column_name, default: default, nullable: false)
                 @arguments[-2] = column_name
                 @arguments[-1] = { type: test[:type], null: false, default: expected_defaults[index] }
                 migrate_and_test_field *@arguments

data/test/test_helper.rb

@@ -41,6 +41,33 @@ def migrate_and_test_field(command, migration, table_name, field_name, assertion
   migration.class.send(:remove_method, :change)
 end
 
+# @return [Array<Hash>] Fixtures containing :type, :default, :expected_default, and :command for use with sprintf
+def add_column_fixtures
+  # Rails' "magic" time, for Time columns
+  # https://github.com/rails/rails/blob/fcf9b712b1dbbcb8f48644e6f20676ad9480ba66/activerecord/lib/active_record/type/time.rb#L16
+  base_date = Time.utc(2000, 1, 1, 0, 0, 0)
+
+  datetime_value = Time.at(Time.now.to_i).utc # Date types we're testing don't have sub-second precision
+  date_value = Time.utc(datetime_value.year, datetime_value.month, datetime_value.day)
+  rails_time_value = Time.utc(base_date.year, base_date.month, base_date.day, datetime_value.hour, datetime_value.min, datetime_value.sec)
+
+  fixtures = [
+    { type: :integer, default: 42 },
+    { type: :string, default: ['foobar', :bazqux], expected_default: ['foobar', 'bazqux'] },
+    { type: :text, default: nil }, # TEXT columns cannot have a default http://dev.mysql.com/doc/refman/5.7/en/blob.html#idm140380410069472
+    { type: :float, default: 3.14159 },
+    { type: :datetime, default: datetime_value.strftime('%F %T'), expected_default: datetime_value },
+    { type: :time, default: datetime_value.strftime('%T'), expected_default: rails_time_value },
+    { type: :date, default: datetime_value.strftime('%F'), expected_default: date_value },
+    { type: :binary, default: nil }, # BLOB columns cannot have a default http://dev.mysql.com/doc/refman/5.7/en/blob.html#idm140380410069472
+    { type: :boolean, default: [false, true] },
+  ]
+  fixtures.map do |fixture|
+    fixture[:command] = "add_column :%{table}, :%{column}, :#{fixture[:type]}, default: %<default>p, null: %{nullable}"
+    fixture
+  end
+end
+
 # SQLCounter is part of ActiveRecord but is not distributed with the gem (used for internal tests only)
 # see https://github.com/rails/rails/blob/3-2-stable/activerecord/test/cases/helper.rb#L59
 module ActiveRecord

data/test/unit/mysql_pt_osc_adapter_test.rb

@@ -7,6 +7,13 @@ class MysqlPtOscAdapterTest < Test::Unit::TestCase
     setup do
       TestConnection.establish_connection(test_spec)
       @adapter = TestConnection.connection
+      # Silence warnings about not using an ActiveRecord::PtOscMigration
+      # @see Kernel#suppress_warnings
+      @original_verbosity, $VERBOSE = $VERBOSE, nil
+    end
+
+    teardown do
+      $VERBOSE = @original_verbosity
     end
 
     context '#rename_table' do
@@ -32,7 +39,7 @@ class MysqlPtOscAdapterTest < Test::Unit::TestCase
 
         should 'add an ADD command to the commands hash' do
           table_name = Faker::Lorem.word
-          column_name = Faker::Lorem.word
+          column_name = 'foobar'
           @adapter.add_column(table_name, column_name, :string, default: 0, null: false)
           assert_equal "ADD `#{column_name}` varchar(255) DEFAULT 0 NOT NULL", @adapter.send(:get_commands, table_name).first
         end
@@ -48,7 +55,7 @@ class MysqlPtOscAdapterTest < Test::Unit::TestCase
         context 'with an existing table and column' do
           setup do
             @table_name = Faker::Lorem.word
-            @column_name = Faker::Lorem.word
+            @column_name = 'foobar'
             @adapter.create_table @table_name, force: true do |t|
               t.string @column_name
             end
@@ -71,14 +78,14 @@ class MysqlPtOscAdapterTest < Test::Unit::TestCase
         context 'with an existing table and column' do
           setup do
             @table_name = Faker::Lorem.word
-            @column_name = Faker::Lorem.word
+            @column_name = 'foobar'
             @adapter.create_table @table_name, force: true do |t|
               t.string @column_name, default: nil
             end
           end
 
           should 'add a CHANGE command to the commands hash' do
-            new_column_name = Faker::Lorem.word
+            new_column_name = 'foobar'
             @adapter.rename_column(@table_name, @column_name, new_column_name)
             assert_equal "CHANGE `#{@column_name}` `#{new_column_name}` varchar(255) DEFAULT NULL", @adapter.send(:get_commands, @table_name).first
           end
@@ -94,14 +101,14 @@ class MysqlPtOscAdapterTest < Test::Unit::TestCase
 
         should 'add a DROP COLUMN command to the commands hash' do
           table_name = Faker::Lorem.word
-          column_name = Faker::Lorem.word
+          column_name = 'foobar'
           @adapter.remove_column(table_name, column_name)
           assert_equal "DROP COLUMN `#{column_name}`", @adapter.send(:get_commands, table_name).first
         end
 
         should 'add multiple DROP COLUMN commands to the commands hash' do
           table_name = Faker::Lorem.word
-          column_names = 3.times.map { Faker::Lorem.word }
+          column_names = %w(foo bar baz)
           @adapter.remove_column(table_name, *column_names)
           commands = @adapter.send(:get_commands, table_name)
           column_names.each_with_index do |column_name, index|
@@ -120,7 +127,7 @@ class MysqlPtOscAdapterTest < Test::Unit::TestCase
         context 'with an existing table and columns' do
           setup do
             @table_name = Faker::Lorem.word
-            @column_names = Faker::Lorem.words
+            @column_names = %w(foo bar baz)
             @adapter.create_table @table_name, force: true do |t|
               @column_names.each do |column_name|
                 t.string(column_name, default: nil)
@@ -157,7 +164,7 @@ class MysqlPtOscAdapterTest < Test::Unit::TestCase
 
         should 'add a DROP COLUMN command to the commands hash' do
           table_name = Faker::Lorem.word
-          index_name = Faker::Lorem.word
+          index_name = Faker::Lorem.words.join('_')
           @adapter.remove_index!(table_name, index_name)
           assert_equal "DROP INDEX `#{index_name}`", @adapter.send(:get_commands, table_name).first
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pt-osc
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-14 00:00:00.000000000 Z
+date: 2015-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -248,7 +248,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 999232518907264640
+      hash: 3650568307132967926
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -257,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 999232518907264640
+      hash: 3650568307132967926
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23