departure-next 6.7.1.pre.pre

data/lib/departure/version.rb

@@ -0,0 +1,3 @@
+module Departure
+  VERSION = '6.7.1-pre'.freeze
+end

data/lib/departure.rb

@@ -0,0 +1,40 @@
+require 'active_record'
+require 'active_support/all'
+
+require 'active_record/connection_adapters/for_alter'
+
+require 'departure/version'
+require 'departure/log_sanitizers/password_sanitizer'
+require 'departure/runner'
+require 'departure/cli_generator'
+require 'departure/logger'
+require 'departure/null_logger'
+require 'departure/logger_factory'
+require 'departure/configuration'
+require 'departure/errors'
+require 'departure/command'
+require 'departure/connection_base'
+require 'departure/migration'
+require 'departure/rails_adapter'
+
+require 'departure/railtie' if defined?(Rails)
+
+# We need the OS not to buffer the IO to see pt-osc's output while migrating
+$stdout.sync = true
+
+Departure::RailsAdapter.for_current.register_integrations
+
+module Departure
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.load
+    # No-op left for compatibility
+  end
+end

data/lib/lhm/adapter.rb

@@ -0,0 +1,107 @@
+require 'lhm/column_with_sql'
+require 'lhm/column_with_type'
+
+module Lhm
+  # Translates Lhm DSL to ActiveRecord's one, so Lhm migrations will now go
+  # through Percona as well, without any modification on the migration's
+  # code
+  class Adapter
+    # Constructor
+    #
+    # @param migration [ActiveRecord::Migtration]
+    # @param table_name [String, Symbol]
+    def initialize(migration, table_name)
+      @migration = migration
+      @table_name = table_name
+    end
+
+    # Adds the specified column through ActiveRecord
+    #
+    # @param column_name [String, Symbol]
+    # @param definition [String, Symbol]
+    def add_column(column_name, definition)
+      attributes = column_attributes(column_name, definition)
+      migration.add_column(*attributes)
+    end
+
+    # Removes the specified column through ActiveRecord
+    #
+    # @param column_name [String, Symbol]
+    def remove_column(column_name)
+      migration.remove_column(table_name, column_name)
+    end
+
+    # Adds an index in the specified columns through ActiveRecord. Note you
+    # can provide a name as well
+    #
+    # @param columns [Array<String>, Array<Symbol>, String, Symbol]
+    # @param index_name [String]
+    def add_index(columns, index_name = nil)
+      options = { name: index_name } if index_name
+      migration.add_index(table_name, columns, options || {})
+    end
+
+    # Removes the index in the given columns or by its name
+    #
+    # @param columns [Array<String>, Array<Symbol>, String, Symbol]
+    # @param index_name [String]
+    def remove_index(columns, index_name = nil)
+      options = if index_name
+                  { name: index_name }
+                else
+                  { column: columns }
+                end
+      migration.remove_index(table_name, options)
+    end
+
+    # Change the column to use the provided definition, through ActiveRecord
+    #
+    # @param column_name [String, Symbol]
+    # @param definition [String, Symbol]
+    def change_column(column_name, definition)
+      attributes = column_attributes(column_name, definition)
+      migration.change_column(*attributes)
+    end
+
+    # Renames the old_name column to new_name by using ActiveRecord
+    #
+    # @param old_name [String, Symbol]
+    # @param new_name [String, Symbol]
+    def rename_column(old_name, new_name)
+      migration.rename_column(table_name, old_name, new_name)
+    end
+
+    # Adds a unique index on the given columns, with the provided name if passed
+    #
+    # @param columns [Array<String>, Array<Symbol>, String, Symbol]
+    # @param index_name [String]
+    def add_unique_index(columns, index_name = nil)
+      options = { unique: true }
+      options.merge!(name: index_name) if index_name # rubocop:disable Performance/RedundantMerge
+
+      migration.add_index(table_name, columns, options)
+    end
+
+    private
+
+    attr_reader :migration, :table_name
+
+    # Returns the instance of ActiveRecord column with the given name and
+    # definition
+    #
+    # @param name [String, Symbol]
+    # @param definition [String]
+    def column(name, definition)
+      @column ||= if definition.is_a?(Symbol)
+                    ColumnWithType.new(name, definition)
+                  else
+                    ColumnWithSql.new(name, definition)
+                  end
+    end
+
+    def column_attributes(name, definition)
+      attributes = column(name, definition).attributes
+      [table_name, name].concat(attributes)
+    end
+  end
+end

data/lib/lhm/column_with_sql.rb

@@ -0,0 +1,89 @@
+require 'forwardable'
+
+module Lhm
+  # Abstracts the details of a table column definition when specified with a MySQL
+  # column definition string
+  class ColumnWithSql
+    extend Forwardable
+
+    # Constructor
+    #
+    # @param name [String, Symbol]
+    # @param definition [String]
+    def initialize(name, definition)
+      @name = name
+      @definition = definition
+    end
+
+    # Returns the column data as an Array to be used with the splat operator.
+    # See Lhm::Adaper#add_column
+    #
+    # @return [Array]
+    def attributes
+      [type, column_options]
+    end
+
+    private
+
+    def_delegators :column, :limit, :type, :default, :null
+
+    attr_reader :name, :definition
+
+    # TODO: investigate
+    #
+    # Rails doesn't take into account lenght argument of INT in the
+    # definition, as an integer it will default it to 4 not an integer
+    #
+    # Returns the columns data as a Hash
+    #
+    # @return [Hash]
+    def column_options
+      { limit: column.limit, default: column.default, null: column.null }
+    end
+
+    # Returns the column instance with the provided data
+    #
+    # @return [column_factory]
+    def column
+      cast_type = ActiveRecord::Base.connection.send(:lookup_cast_type, definition)
+      metadata = ActiveRecord::ConnectionAdapters::SqlTypeMetadata.new(
+        type: cast_type.type,
+        sql_type: definition,
+        limit: cast_type.limit
+      )
+      mysql_metadata = ActiveRecord::ConnectionAdapters::MySQL::TypeMetadata.new(metadata)
+      @column ||= Departure::RailsAdapter.for_current.sql_column.new(
+        name,
+        default_value,
+        mysql_metadata,
+        null_value
+      )
+    end
+
+    # Gets the DEFAULT value the column takes as specified in the
+    # definition, if any
+    #
+    # @return [String, NilClass]
+    def default_value
+      match = if definition.match?(/timestamp|datetime/i)
+                /default '?(.+[^'])'?/i.match(definition)
+              else
+                /default '?(\w+)'?/i.match(definition)
+              end
+
+      return unless match
+
+      match[1].downcase != 'null' ? match[1] : nil
+    end
+
+    # Checks whether the column accepts NULL as specified in the definition
+    #
+    # @return [Boolean]
+    def null_value
+      match = /((NOT)? NULL)/i.match(definition)
+      return true unless match
+
+      match[2]&.downcase == 'not' ? false : true
+    end
+  end
+end

data/lib/lhm/column_with_type.rb

@@ -0,0 +1,29 @@
+module Lhm
+  # Abstracts the details of a table column definition when specified with a type
+  # as a symbol. This is the regular ActiveRecord's #add_column syntax:
+  #
+  #   add_column :tablenames, :field, :string
+  #
+  class ColumnWithType
+    # Constructor
+    #
+    # @param name [String, Symbol]
+    # @param definition [Symbol]
+    def initialize(name, definition)
+      @name = name
+      @definition = definition
+    end
+
+    # Returns the column data as an Array to be used with the splat operator.
+    # See Lhm::Adaper#add_column
+    #
+    # @return [Array]
+    def attributes
+      [definition]
+    end
+
+    private
+
+    attr_reader :definition
+  end
+end

data/lib/lhm.rb

@@ -0,0 +1,23 @@
+require 'lhm/adapter'
+
+# Defines the same global namespace as LHM's gem does to mimic its API
+# while providing a different behaviour. We delegate all LHM's methods to
+# ActiveRecord so that you don't need to modify your old LHM migrations
+module Lhm
+  # Yields an adapter instance so that Lhm migration Dsl methods get
+  # delegated to ActiveRecord::Migration ones instead
+  #
+  # @param table_name [String]
+  # @param _options [Hash]
+  # @param block [Block]
+  def self.change_table(table_name, _options = {}, &block) # rubocop:disable Lint/UnusedMethodArgument
+    yield Adapter.new(@migration, table_name)
+  end
+
+  # Sets the migration to apply the adapter to
+  #
+  # @param migration [ActiveRecord::Migration]
+  def self.migration=(migration)
+    @migration = migration
+  end
+end

data/test_database.rb

@@ -0,0 +1,76 @@
+require 'active_record'
+require 'active_record/connection_adapters/mysql2_adapter'
+require 'departure'
+
+# Setups the test database with the schema_migrations table that ActiveRecord
+# requires for the migrations, plus a table for the Comment model used throught
+# the tests.
+#
+class TestDatabase
+  # Constructor
+  #
+  # @param config [Hash]
+  def initialize(config)
+    @config = config
+    @database = config['database']
+  end
+
+  # Creates the test database, the schema_migrations and the comments tables.
+  # It drops any of them if they already exist
+  def setup
+    setup_test_database
+    drop_and_create_schema_migrations_table
+  end
+
+  # Creates the #{@database} database and the comments table in it.
+  # Before, it drops both if they already exist
+  def setup_test_database
+    drop_and_create_test_database
+    drop_and_create_comments_table
+  end
+
+  # Creates the ActiveRecord's schema_migrations table required for
+  # migrations to work. Before, it drops the table if it already exists
+  def drop_and_create_schema_migrations_table
+    sql = [
+      "USE #{@database}",
+      'DROP TABLE IF EXISTS schema_migrations',
+      'CREATE TABLE schema_migrations ( version varchar(255) COLLATE utf8_unicode_ci NOT NULL, UNIQUE KEY unique_schema_migrations (version)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci'
+    ]
+
+    run_commands(sql)
+  end
+
+  private
+
+  attr_reader :config, :database
+
+  def drop_and_create_test_database
+    sql = [
+      "DROP DATABASE IF EXISTS #{@database}",
+      "CREATE DATABASE #{@database} DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_unicode_ci"
+    ]
+
+    run_commands(sql)
+  end
+
+  def drop_and_create_comments_table
+    sql = [
+      "USE #{@database}",
+      'DROP TABLE IF EXISTS comments',
+      'CREATE TABLE comments ( id bigint(20) NOT NULL AUTO_INCREMENT, PRIMARY KEY (id)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci'
+    ]
+
+    run_commands(sql)
+  end
+
+  def run_commands(sql)
+    conn.execute('START TRANSACTION')
+    sql.each { |str| conn.execute(str) }
+    conn.execute('COMMIT')
+  end
+
+  def conn
+    ActiveRecord::Base.connection
+  end
+end

metadata

@@ -0,0 +1,282 @@
+--- !ruby/object:Gem::Specification
+name: departure-next
+version: !ruby/object:Gem::Version
+  version: 6.7.1.pre.pre
+platform: ruby
+authors:
+- Ilya Zayats
+- Pau Pérez
+- Fran Casas
+- Jorge Morante
+- Enrico Stano
+- Adrian Serafin
+- Kirk Haines
+- Guillermo Iguaran
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.3.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.3.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+description: Execute your ActiveRecord migrations with Percona's pt-online-schema-change.
+  Formerly known as Percona Migrator.
+email:
+- ilya.zayats@redbooth.com
+- pau.perez@redbooth.com
+- nflamel@gmail.com
+- jorge.morante@redbooth.com
+- adrian@softmad.pl
+- wyhaines@gmail.com
+- guilleiguaran@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".pryrc"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- 20250312235906_add_deleted_reason_to_newsfeed_activities.rb
+- Appraisals
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- RELEASING.md
+- Rakefile
+- bin/console
+- bin/rails
+- bin/rspec
+- bin/setup
+- config.yml.erb
+- configuration.rb
+- departure-next.gemspec
+- docker-compose.yml
+- gemfiles/rails_6_1.gemfile
+- gemfiles/rails_6_1.gemfile.lock
+- gemfiles/rails_7_0.gemfile
+- gemfiles/rails_7_0.gemfile.lock
+- gemfiles/rails_7_1.gemfile
+- gemfiles/rails_7_1.gemfile.lock
+- gemfiles/rails_7_2.gemfile
+- gemfiles/rails_7_2.gemfile.lock
+- lib/active_record/connection_adapters/for_alter.rb
+- lib/active_record/connection_adapters/patch_connection_handling.rb
+- lib/active_record/connection_adapters/percona_adapter.rb
+- lib/active_record/connection_adapters/rails_7_2_departure_adapter.rb
+- lib/departure.rb
+- lib/departure/alter_argument.rb
+- lib/departure/cli_generator.rb
+- lib/departure/command.rb
+- lib/departure/configuration.rb
+- lib/departure/connection_base.rb
+- lib/departure/connection_details.rb
+- lib/departure/dsn.rb
+- lib/departure/errors.rb
+- lib/departure/log_sanitizers/password_sanitizer.rb
+- lib/departure/logger.rb
+- lib/departure/logger_factory.rb
+- lib/departure/migration.rb
+- lib/departure/null_logger.rb
+- lib/departure/option.rb
+- lib/departure/rails_adapter.rb
+- lib/departure/railtie.rb
+- lib/departure/runner.rb
+- lib/departure/user_options.rb
+- lib/departure/version.rb
+- lib/lhm.rb
+- lib/lhm/adapter.rb
+- lib/lhm/column_with_sql.rb
+- lib/lhm/column_with_type.rb
+- test_database.rb
+homepage: https://github.com/departurerb/departure
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: pt-online-schema-change runner for ActiveRecord migrations
+test_files: []