pt-osc 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.3
+
+- `defaults-file` flag can be specified as either an absolute path (has a leading `/`) or a relative path.
+
 ## 0.0.2
 
 - fixed bug when `percona` config is not defined in `database.yml`

data/README.md

@@ -35,7 +35,8 @@ environment:
     recursion-method: "'dsn=D=percona,t=slaves'"
 ```
 
-Additional options for the `percona` hash include:
+Additional/modified options for the `percona` hash include:
+  - `defaults-file`: Can be specified as an absolute path (with leading `/`) or relative (without). Relative paths will be treated as relative to your project's working directory.
   - `run_mode`: Specify `'execute'` to actually run `pt-online-schema-change` when the migration runs. Specify `'print'` to output the commands to run to STDOUT instead. Default is `'print'`.
 
 ## Caveats

data/lib/active_record/pt_osc_migration.rb

@@ -1,12 +1,21 @@
 module ActiveRecord
   class PtOscMigration < Migration
     # @TODO whitelist all valid pt-osc flags
-    DEFAULT_FLAGS = {
-      'defaults-file' => nil,
-      'recursion-method' => nil,
-      'execute' => false,
+    PERCONA_FLAGS = {
+      'defaults-file' => {
+        mutator: :make_path_absolute,
+      },
+      'recursion-method' => {
+      },
+      'execute' => {
+        default: false,
+      },
     }.freeze
 
+    def self.percona_flags
+      PERCONA_FLAGS
+    end
+
     def migrate(direction)
       return unless respond_to?(direction)
 
@@ -113,25 +122,26 @@ module ActiveRecord
 
       # Whitelist
       options = HashWithIndifferentAccess.new(options)
-      options = options.slice(*DEFAULT_FLAGS.keys)
+      options = options.slice(*self.class.percona_flags.keys)
 
       # Merge config
       config = percona_config
       if config
-        config.slice(*DEFAULT_FLAGS.keys).each do |key, value|
+        config.slice(*self.class.percona_flags.keys).each do |key, value|
           options[key] ||= value
         end
       end
 
       # Set defaults
-      DEFAULT_FLAGS.each do |key, value|
-        options[key] ||= value unless value.nil?
+      self.class.percona_flags.each do |flag, flag_config|
+        options[flag] ||= flag_config[:default] if flag_config.key?(:default)
       end
 
       # Determine run mode
       command += options.delete(:execute) ? ' --execute' : ' --dry-run'
 
       options.each do |key, value|
+        value = send(self.class.percona_flags[key][:mutator], value) if self.class.percona_flags[key].try(:key?, :mutator)
         command += " --#{key} #{value}"
       end
 
@@ -146,5 +156,13 @@ module ActiveRecord
     def percona_config
       database_config[:percona] || {}
     end
+
+    private
+    # Flag mutators
+    def make_path_absolute(path)
+      return path if path[0] == '/'
+      # If path is not already absolute, treat it as relative to the app root
+      File.expand_path(path, Dir.getwd)
+    end
   end
 end

data/lib/pt-osc/version.rb

@@ -1,5 +1,5 @@
 module Pt
   module Osc
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/test/unit/pt_osc_migration_unit_test.rb

@@ -13,16 +13,46 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
           @migration.instance_variable_set(:@connection, ActiveRecord::Base.connection)
         end
 
-        should 'only include flags in DEFAULT_FLAGS' do
-          flag = ActiveRecord::PtOscMigration::DEFAULT_FLAGS.first
+        should 'only include flags in PERCONA_FLAGS' do
+          flag = ActiveRecord::PtOscMigration.percona_flags.first
           begin
             flag = Faker::Lorem.words.join('-')
-          end while flag.in? ActiveRecord::PtOscMigration::DEFAULT_FLAGS
+          end while flag.in? ActiveRecord::PtOscMigration.percona_flags
 
           command = @migration.send(:percona_command, '', '', '', flag => nil)
           assert_equal false, command.include?(flag), "Flag #{flag} was given but should not have been."
         end
 
+        context 'with flags having defaults' do
+          setup do
+            # add some dummy flags
+            dummy_flags = 3.times.inject({}) do |hash|
+              dummy_flag = Faker::Lorem.words.join('-')
+              hash[dummy_flag] = { default: Faker::Lorem.word }
+              hash
+            end
+
+            standard_flags = ActiveRecord::PtOscMigration.percona_flags
+            ActiveRecord::PtOscMigration.stubs(:percona_flags).returns(standard_flags.merge(dummy_flags))
+          end
+
+          teardown do
+            ActiveRecord::PtOscMigration.unstub(:percona_flags)
+          end
+
+          should 'set missing flags to default values' do
+            flags_with_defaults = ActiveRecord::PtOscMigration.percona_flags.select do |flag, config|
+              config.key?(:default) && flag != 'execute'
+            end
+
+            command = @migration.send(:percona_command, '', '', '')
+            flags_with_defaults.each do |flag, config|
+              assert command.include?("--#{flag} #{config[:default]}"),
+                     "Default value #{config[:default]} for flag #{flag} was not present in command: #{command}"
+            end
+          end
+        end
+
         should 'perform a dry run if execute not specified' do
           command = @migration.send(:percona_command, '', '', '')
           assert command.include?('--dry-run')
@@ -33,6 +63,40 @@ class PtOscMigrationUnitTest < Test::Unit::TestCase
           assert_equal false, command.include?('--dry-run')
           assert command.include?('--execute')
         end
+
+        context 'given a defaults-file' do
+          setup do
+            @path = Faker::Lorem.words.join('/')
+            @options = { :'defaults-file' => @path }
+          end
+
+          should 'call #make_path_absolute' do
+            @migration.expects(:make_path_absolute).with(@path)
+            @migration.send(:percona_command, '', '', '', @options)
+          end
+        end
+      end
+    end
+
+    context '#make_path_absolute' do
+      context 'with an absolute path' do
+        setup do
+          @path = "/#{Faker::Lorem.words.join('/')}"
+        end
+
+        should 'return the path unmodified' do
+          assert_equal @path, @migration.send(:make_path_absolute, @path)
+        end
+      end
+
+      context 'with a relative path' do
+        setup do
+          @path = Faker::Lorem.words.join('/')
+        end
+
+        should 'return an absolute path' do
+          assert_equal '/', @migration.send(:make_path_absolute, @path)[0]
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pt-osc
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -229,7 +229,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 109718066691379397
+      hash: 3199925404506680095
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -238,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 109718066691379397
+      hash: 3199925404506680095
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23