alterity 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61d1573038462b1d92925a95f8b67d8c0d53ffc250c429a742bb9a3e19fe715a
-  data.tar.gz: e6cf943aae6b2ead8e6c04d335a63c1c1438c296381e066c513d0aefb99e6d13
+  metadata.gz: b468009cfd8631b397ea59fcb1750aada7238d5b8910f6cc492cf4778bdc2fa6
+  data.tar.gz: 02e17258c42233d8198ad62cf15841d6c3fe78b4b2730f64100e1771693686a1
 SHA512:
-  metadata.gz: ea2e19e99394e1cacd831855e509363c4d164dabfe564ef7ac47945c61c9fc94071d965a3bc16efdd80530108fecd50ee582900d962f3fd63571ae1e6d71203f
-  data.tar.gz: bd8f34566ced8252a587804d966c02e850d41a4d0faaf88bd0279886ea58286c4d70a7ca15b7ceafc17934bdce34f69b459b7546a1603acaee4b91ab26f89933
+  metadata.gz: 8929653022fbcec5f31c5583c619d252547928319276b020021404ad38cdbf2a2fae1861f9748009fcc97f99c0bc7a07f698397d6c8d20d41bbd96251b7a3693
+  data.tar.gz: ec349e1dfee9361ef937e55fe8911da437fad1c7dfc74446ff7f7ce2608943e0755f238297e5073f8786b2a6a0d9dc71c6785a1b91f1d7b04efe4b4a548a1b46

data/lib/alterity.rb

@@ -8,14 +8,14 @@ require "alterity/railtie"
 class Alterity
   class << self
     def process_sql_query(sql, &block)
-      case sql.strip
-      when /^alter table (?<table>.+?) (?<updates>.+)/i
+      case sql.tr("\n", " ").strip
+      when /^alter\s+table\s+(?<table>.+?)\s+(?<updates>.+)/i
         execute_alter($~[:table], $~[:updates])
-      when /^create index (?<index>.+?) on (?<table>.+?) (?<updates>.+)/i
+      when /^create\s+index\s+(?<index>.+?)\s+on\s+(?<table>.+?)\s+(?<updates>.+)/i
         execute_alter($~[:table], "ADD INDEX #{$~[:index]} #{$~[:updates]}")
-      when /^create unique index (?<index>.+?) on (?<table>.+?) (?<updates>.+)/i
+      when /^create\s+unique\s+index\s+(?<index>.+?)\s+on\s+(?<table>.+?)\s+(?<updates>.+)/i
         execute_alter($~[:table], "ADD UNIQUE INDEX #{$~[:index]} #{$~[:updates]}")
-      when /^drop index (?<index>.+?) on (?<table>.+)/i
+      when /^drop\s+index\s+(?<index>.+?)\s+on\s+(?<table>.+)/i
         execute_alter($~[:table], "DROP INDEX #{$~[:index]}")
       else
         block.call
@@ -38,9 +38,9 @@ class Alterity
     def execute_alter(table, updates)
       altered_table = table.delete("`")
       alter_argument = %("#{updates.gsub('"', '\\"').gsub('`', '\\\`')}")
-      prepared_command = config.command.call(config, altered_table, alter_argument).gsub(/\n/, "\\\n")
+      prepared_command = config.command.call(altered_table, alter_argument).to_s.gsub(/\n/, "\\\n")
       puts "[Alterity] Will execute: #{prepared_command}"
-      system(prepared_command)
+      system(prepared_command) || raise("[Alterity] Command failed")
     end
 
     def set_database_config
@@ -70,7 +70,7 @@ class Alterity
       return if config.replicas_dsns.empty?
 
       connection.execute <<~SQL
-        INSERT INTO #{table} (dsn)
+        INSERT INTO #{table} (dsn) VALUES
          #{config.replicas_dsns.map { |dsn| "('#{dsn}')" }.join(',')}
       SQL
     end

data/lib/alterity/configuration.rb

@@ -13,46 +13,36 @@ class Alterity
   class << self
     def reset_state_and_configuration
       self.config = Configuration.new
-      self.state = CurrentState.new
+      class << config
+        def replicas(database:, table:, dsns:)
+          return ArgumentError.new("database & table must be present") if database.blank? || table.blank?
+
+          self.replicas_dsns_database = database
+          self.replicas_dsns_table = table
+          self.replicas_dsns = dsns.uniq.map do |dsn|
+            parts = dsn.split(",")
+            # automatically add default port
+            parts << "P=3306" unless parts.any? { |part| part.start_with?("P=") }
+            # automatically remove master
+            next if parts.include?("h=#{host}") && parts.include?("P=#{port}")
+
+            parts.join(",")
+          end.compact
+        end
+      end
 
-      config.command = lambda { |config, altered_table, alter_argument|
-        <<~SHELL.squish
-          pt-online-schema-change
-            -h #{config.host}
-            -P #{config.port}
-            -u #{config.username}
-            --password=#{config.password}
-            --execute
-            D=#{config.database},t=#{altered_table}
-            --alter #{alter_argument}
-        SHELL
-      }
+      self.state = CurrentState.new
+      load "#{__dir__}/default_configuration.rb"
     end
 
     def configure
-      yield self
+      yield config
     end
 
     def command=(new_command)
       config.command = new_command
     end
 
-    def replicas_dsns_table(database:, table:, dsns:)
-      return ArgumentError.new("database & table must be present") if database.blank? || table.blank?
-
-      config.replicas_dsns_database = database
-      config.replicas_dsns_table = table
-      config.replicas_dsns = dsns.uniq.map do |dsn|
-        parts = dsn.split(",")
-        # automatically add default port
-        parts << "P=3306" unless parts.any? { |part| part.start_with?("P=") }
-        # automatically remove master
-        next if parts.include?("h=#{config.host}") && parts.include?("P=#{config.port}")
-
-        parts.join(",")
-      end.compact
-    end
-
     def disable
       state.disabled = true
       yield

data/lib/alterity/default_configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+Alterity.configure do |config|
+  config.command = lambda { |altered_table, alter_argument|
+    parts = ["pt-online-schema-change"]
+    parts << %(-h "#{config.host}") if config.host.present?
+    parts << %(-P "#{config.port}") if config.port.present?
+    parts << %(-u "#{config.username}") if config.username.present?
+    parts << %(--password "#{config.password.gsub('"', '\\"')}") if config.password.present?
+    parts << "--execute"
+    parts << "D=#{config.database},t=#{altered_table}"
+    parts << "--alter #{alter_argument}"
+    parts.join(" ")
+  }
+end

data/lib/alterity/mysql_client_additions.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "mysql2"
+
 class Alterity
   module MysqlClientAdditions
     def query(sql, options = {})

data/lib/alterity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Alterity
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

data/spec/alterity_spec.rb

@@ -9,8 +9,10 @@ RSpec.describe Alterity do
         ["CREATE INDEX `idx_users_on_col` ON `users` (col)", "`users`", "ADD INDEX `idx_users_on_col` (col)"],
         ["CREATE UNIQUE INDEX `idx_users_on_col` ON `users` (col)", "`users`", "ADD UNIQUE INDEX `idx_users_on_col` (col)"],
         ["DROP INDEX `idx_users_on_col` ON `users`", "`users`", "DROP INDEX `idx_users_on_col`"],
-        ["alter table users drop col", "users", "drop col"]
+        ["alter table users drop col", "users", "drop col"],
+        ["  ALTER TABLE\n   users\n   DROP col", "users", "DROP col"]
       ].each do |(query, expected_table, expected_updates)|
+        puts query.inspect
         expected_block = proc {}
         expect(expected_block).not_to receive(:call)
         expect(Alterity).to receive(:execute_alter).with(expected_table, expected_updates)

data/spec/bin/custom_config.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+Alterity.configure do |config|
+  config.command = lambda { |altered_table, alter_argument|
+    string = config.to_h.slice(
+      *%i[host port username database replicas_dsns_database replicas_dsns_table replicas_dsns]
+    ).to_s
+    system("echo '#{string}' > /tmp/custom_command_result.txt")
+    system("echo '#{altered_table}' >> /tmp/custom_command_result.txt")
+    system("echo '#{alter_argument}' >> /tmp/custom_command_result.txt")
+  }
+
+  config.replicas(
+    database: "percona",
+    table: "replicas_dsns",
+    dsns: [
+      "h=host1",
+      "h=host2"
+    ]
+  )
+end

data/spec/bin/rails_app_migration_test.sh

@@ -1,7 +1,68 @@
 #!/usr/bin/env bash
 
-set -euo pipefail
+set -euox pipefail
+
+unset BUNDLE_GEMFILE # because we're going to create a new rails app here and use bundler
 
-printenv
-sudo apt update
 sudo apt install percona-toolkit
+
+# Fixes: `Cannot connect to MySQL: Cannot get MySQL var character_set_server: DBD::mysql::db selectrow_array failed: Table 'performance_schema.session_variables' doesn't exist [for Statement "SHOW VARIABLES LIKE 'character_set_server'"] at /usr/local/Cellar/percona-toolkit/3.3.0/libexec/bin/pt-online-schema-change line 2415.`
+mysql -h $MYSQL_HOST -u $MYSQL_USERNAME -e 'set @@global.show_compatibility_56=ON'
+
+gem install rails -v $RAILS_VERSION
+
+rails new testapp \
+  --skip-action-mailer \
+  --skip-action-mailbox \
+  --skip-action-text \
+  --skip-active-job \
+  --skip-active-storage \
+  --skip-puma \
+  --skip-action-cable \
+  --skip-sprockets \
+  --skip-spring \
+  --skip-listen--skip-javascript \
+  --skip-turbolinks \
+  --skip-jbuilder--skip-test \
+  --skip-system-test \
+  --skip-bootsnap \
+  --skip-javascript \
+  --skip-webpack-install
+
+cd testapp
+
+# Sanity check:
+# echo 'gem "mysql2"' >> Gemfile
+
+echo 'gem "alterity", path: "../"' >> Gemfile
+
+bundle
+
+# Local machine test
+# echo 'development:
+#   adapter: mysql2
+#   database: alterity_test' > config/database.yml
+# bundle e rails db:drop db:create
+
+echo 'development:
+  adapter: mysql2
+  database: <%= ENV.fetch("MYSQL_DATABASE") %>
+  host: <%= ENV.fetch("MYSQL_HOST") %>
+  username: <%= ENV.fetch("MYSQL_USERNAME") %>' > config/database.yml
+
+bundle e rails g model shirt
+
+bundle e rails g migration add_color_to_shirts color:string
+
+# Test default configuration works as expected
+bundle e rails db:migrate --trace
+rails runner 'Shirt.columns.map(&:name).include?("color") || exit(1)'
+
+# Now test custom command and replication setup
+cp ../spec/bin/custom_config.rb config/initializers/alterity.rb
+
+bundle e rails g migration add_color2_to_shirts color2:string
+
+bundle e rails db:migrate --trace
+
+ruby ../spec/bin/test_custom_config_result.rb

data/spec/bin/test_custom_config_result.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+result = File.read("/tmp/custom_command_result.txt").downcase.strip
+
+expected_result = %({:host=>"127.0.0.1", :port=>nil, :username=>"root", :database=>"alterity_test", :replicas_dsns_database=>"percona", :replicas_dsns_table=>"replicas_dsns", :replicas_dsns=>["h=host1,P=3306", "h=host2,P=3306"]}
+shirts
+"ADD \\`color2\\` VARCHAR(255)").downcase.strip
+
+puts "Expected custom config result:"
+puts expected_result
+p expected_result.chars.map(&:hex)
+
+puts "Custom config result:"
+puts result
+p result.chars.map(&:hex)
+
+if result != expected_result
+  puts "=> mismatch"
+  exit(1)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alterity
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Maximin
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6.1'
 description: Execute your ActiveRecord migrations with Percona's pt-online-schema-change.
 email:
 - gems@chrismaximin.com
@@ -47,11 +47,14 @@ extra_rdoc_files: []
 files:
 - lib/alterity.rb
 - lib/alterity/configuration.rb
+- lib/alterity/default_configuration.rb
 - lib/alterity/mysql_client_additions.rb
 - lib/alterity/railtie.rb
 - lib/alterity/version.rb
 - spec/alterity_spec.rb
+- spec/bin/custom_config.rb
 - spec/bin/rails_app_migration_test.sh
+- spec/bin/test_custom_config_result.rb
 - spec/spec_helper.rb
 homepage: https://github.com/gumroad/alterity
 licenses:
@@ -81,5 +84,7 @@ specification_version: 4
 summary: Execute your ActiveRecord migrations with Percona's pt-online-schema-change.
 test_files:
 - spec/alterity_spec.rb
+- spec/bin/custom_config.rb
 - spec/bin/rails_app_migration_test.sh
+- spec/bin/test_custom_config_result.rb
 - spec/spec_helper.rb