ridgepole 0.8.8 → 0.9.0.beta

data/lib/ridgepole/dsl_parser.rb

@@ -37,11 +37,10 @@ module Ridgepole
       attrs[:foreign_keys].each do |_, foreign_key_attrs|
         fk_index = foreign_key_attrs[:options][:column] || "#{foreign_key_attrs[:to_table].singularize}_id"
         next if attrs[:indices]&.any? { |_k, v| v[:column_name].first == fk_index }
+        # NOTE: For composite primary keys, the first column of the primary key is used as the foreign key index
+        next if Array(attrs[:options][:primary_key]).first == fk_index
 
-        Ridgepole::Logger.instance.warn(<<-MSG)
-[WARNING] Table `#{table_name}` has a foreign key on `#{fk_index}` column, but doesn't have any indexes on the column.
-          Although an index will be added automatically by InnoDB, please add an index explicitly for your future operations.
-        MSG
+        raise "The column `#{fk_index}` of the table `#{table_name}` has a foreign key but no index. Although InnoDB creates an index automatically, please add one explicitly in order for ridgepole to manage it."
       end
     end
   end

data/lib/ridgepole/dsl_parser/context.rb

@@ -27,7 +27,7 @@ module Ridgepole
         table_name = table_name.to_s
         table_definition = TableDefinition.new(table_name, self)
 
-        options[:primary_key] = options[:primary_key].to_s if options[:primary_key]&.is_a?(Symbol)
+        options[:primary_key] = options[:primary_key].to_s if options[:primary_key].is_a?(Symbol)
         if options[:id] && TableDefinition::ALIAS_TYPES.key?(options[:id])
           type, type_default_opts = TableDefinition::ALIAS_TYPES[options[:id]]
           options[:id] = type

data/lib/ridgepole/dsl_parser/table_definition.rb

@@ -22,57 +22,60 @@ module Ridgepole
 
       DEFAULT_PRIMARY_KEY_TYPE = Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new('5.1') ? :bigint : :integer
 
-      TYPES = [
+      TYPES = {
         # https://github.com/rails/rails/blob/v4.2.1/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb#L274
-        :string,
-        :text,
-        :integer,
-        :bigint,
-        :float,
-        :decimal,
-        :datetime,
-        :timestamp,
-        :time,
-        :date,
-        :binary,
-        :boolean,
+        string: {},
+        text: {},
+        integer: {},
+        bigint: {},
+        float: {},
+        decimal: {},
+        datetime: {},
+        timestamp: {},
+        time: {},
+        date: {},
+        binary: {},
+        boolean: {},
 
         # https://github.com/rails/rails/blob/v4.2.1/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L79
-        :daterange,
-        :numrange,
-        :tsrange,
-        :tstzrange,
-        :int4range,
-        :int8range,
-        :binary,
-        :boolean,
-        :bigint,
-        :xml,
-        :tsvector,
-        :hstore,
-        :inet,
-        :cidr,
-        :macaddr,
-        :uuid,
-        :json,
-        :jsonb,
-        :ltree,
-        :citext,
-        :point,
-        :bit,
-        :bit_varying,
-        :money,
+        serial: { null: false },
+        bigserial: { null: false },
+        daterange: {},
+        numrange: {},
+        tsrange: {},
+        tstzrange: {},
+        int4range: {},
+        int8range: {},
+        # binary: {}, # dup key
+        # boolean: {}, # dup key
+        # bigint: {}, # dup key
+        xml: {},
+        tsvector: {},
+        hstore: {},
+        inet: {},
+        cidr: {},
+        macaddr: {},
+        uuid: {},
+        json: {},
+        jsonb: {},
+        ltree: {},
+        citext: {},
+        point: {},
+        bit: {},
+        bit_varying: {},
+        money: {},
 
         # https://github.com/rails/rails/blob/v5.1.1/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb#L184
-        :virtual,
+        virtual: {},
 
         # https://github.com/rails/rails/blob/v5.0.4/activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb#L53
-        :json
-      ].uniq
+        # json: {}, # dup key
+      }.freeze
 
-      TYPES.each do |column_type|
+      TYPES.each do |column_type, default_options|
         define_method column_type do |*args|
           options = args.extract_options!
+          options = default_options.merge(options)
           column_names = args
           column_names.each { |name| column(name, column_type, options) }
         end
@@ -131,6 +134,7 @@ module Ridgepole
         polymorphic_options.merge!(options.slice(:null, :first, :after))
         index_options = options.key?(:index) ? options.delete(:index) : true
         type = options.delete(:type) || DEFAULT_PRIMARY_KEY_TYPE
+        foreign_key_options = options.delete(:foreign_key)
 
         args.each do |col|
           column("#{col}_id", type, options)
@@ -139,6 +143,12 @@ module Ridgepole
             columns = polymorphic ? ["#{col}_type", "#{col}_id"] : ["#{col}_id"]
             index(columns, index_options.is_a?(Hash) ? index_options : {})
           end
+          if foreign_key_options # rubocop:disable Style/Next
+            fk_opts = foreign_key_options.is_a?(Hash) ? foreign_key_options.dup : {}
+            fk_opts.update(column: "#{col}_id") if col.to_s.singularize != col.to_s
+            to_table = fk_opts.delete(:to_table) || col.to_s.pluralize
+            @base.add_foreign_key(@table_name, to_table, fk_opts)
+          end
         end
       end
       alias belongs_to references

data/lib/ridgepole/execute_expander.rb

@@ -46,7 +46,16 @@ module Ridgepole
       private
 
       def append_alter_extra(sql)
-        sql = sql + ',' + Ridgepole::ExecuteExpander.alter_extra if Ridgepole::ExecuteExpander.alter_extra && sql =~ /\AALTER\b/i
+        if Ridgepole::ExecuteExpander.alter_extra
+          case sql
+          when /\AALTER\b/i
+            sql += ',' + Ridgepole::ExecuteExpander.alter_extra
+          when /\A(CREATE|DROP)\s+INDEX\b/i
+            # https://dev.mysql.com/doc/refman/5.6/en/create-index.html
+            # https://dev.mysql.com/doc/refman/5.6/en/drop-index.html
+            sql += ' ' + Ridgepole::ExecuteExpander.alter_extra.tr(',', ' ')
+          end
+        end
 
         sql
       end

data/lib/ridgepole/ext/abstract_adapter/disable_table_options.rb

@@ -15,7 +15,15 @@ module Ridgepole
 
         def table_options(table_name)
           options = super
-          options.delete(:options) if options && @__without_table_options
+
+          if options && @__without_table_options
+            options.delete(:options)
+
+            # For >= AR 6.1.0
+            options.delete(:charset)
+            options.delete(:collation)
+          end
+
           options
         end
       end

data/lib/ridgepole/external_sql_executer.rb

@@ -8,7 +8,7 @@ module Ridgepole
     end
 
     def execute(sql)
-      cmd = Shellwords.join([@script, sql, JSON.dump(ActiveRecord::Base.connection_config)])
+      cmd = Shellwords.join([@script, sql, JSON.dump(connection_configuration_hash)])
       @logger.info("Execute #{@script}")
       script_basename = File.basename(@script)
 
@@ -48,5 +48,16 @@ module Ridgepole
         raise "`#{@script}` execution failed" unless wait_thr.value.success?
       end
     end
+
+    private
+
+    def connection_configuration_hash
+      if ActiveRecord.gem_version < Gem::Version.new('6.1.0')
+        # NOTE: Remove code when stopping support for versions below 6.1
+        ActiveRecord::Base.connection_config
+      else
+        ActiveRecord::Base.connection_db_config.configuration_hash
+      end
+    end
   end
 end

data/lib/ridgepole/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ridgepole
-  VERSION = '0.8.8'
+  VERSION = '0.9.0.beta'
 end

data/ridgepole.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.2.7')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.2.7') # rubocop:disable Gemspec/RequiredRubyVersion
 
-  spec.add_dependency 'activerecord', '>= 5.0.1', '< 6.1'
+  spec.add_dependency 'activerecord', '>= 5.1', '< 6.2'
   spec.add_dependency 'diffy'
 
   spec.add_development_dependency 'appraisal', '>= 2.2.0'
@@ -36,5 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '>= 3.0.0'
   spec.add_development_dependency 'rspec-match_fuzzy', '>= 0.1.3'
   spec.add_development_dependency 'rspec-match_ruby', '>= 0.1.3'
-  spec.add_development_dependency 'rubocop', '>= 0.57.1'
+  spec.add_development_dependency 'rubocop', '>= 1.7.0'
+  spec.add_development_dependency 'rubocop-rake', '>= 0.5.1'
+  spec.add_development_dependency 'rubocop-rspec', '>= 2.1.0'
 end

data/spec/erb_helper.rb

@@ -14,13 +14,17 @@ ERBh.define_method(:i) do |obj|
 end
 
 ERBh.define_method(:cond) do |conds, m, e = nil|
-  if condition(*Array(conds))
+  if conds.is_a?(Hash)
+    conds.find do |c, _|
+      condition(c)
+    end&.last || m
+  elsif condition(conds)
     m
   else
     e || (begin
-            m.class.new
-          rescue StandardError
-            nil
-          end)
+      m.class.new
+    rescue StandardError
+      nil
+    end)
   end
 end

data/spec/mysql/_migrate/migrate_change_table_option_spec.rb

@@ -4,7 +4,7 @@ describe 'Ridgepole::Client#diff -> migrate' do
   context 'when change mysql table options' do
     let(:actual_dsl) do
       erbh(<<-ERB)
-        create_table "employees", primary_key: "emp_no", force: :cascade, options: "ENGINE=MyISAM DEFAULT CHARSET=utf8" do |t|
+        create_table "employees", primary_key: "emp_no", force: :cascade, <%= i cond(">= 6.1", { charset: "utf8", options: "ENGINE=MyISAM" }, { options: "ENGINE=MyISAM DEFAULT CHARSET=utf8" }) %> do |t|
           t.date   "birth_date", null: false
           t.string "first_name", limit: 14, null: false
           t.string "last_name", limit: 16, null: false
@@ -16,7 +16,7 @@ describe 'Ridgepole::Client#diff -> migrate' do
 
     let(:expected_dsl) do
       erbh(<<-ERB)
-        create_table "employees", primary_key: "emp_no", force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=ascii" do |t|
+        create_table "employees", primary_key: "emp_no", force: :cascade, <%= i cond(">= 6.1", { charset: "ascii" }, { options: "ENGINE=InnoDB DEFAULT CHARSET=ascii" }) %> do |t|
           t.date   "birth_date", null: false
           t.string "first_name", limit: 14, null: false, <%= i cond('>= 5.2', collation: "utf8_general_ci") %>
           t.string "last_name", limit: 16, null: false, <%= i cond('>= 5.2', collation: "utf8_general_ci") %>

data/spec/mysql/cli/ridgepole_spec.rb

@@ -23,6 +23,7 @@ describe 'ridgepole' do
         -f, --file SCHEMAFILE
             --dry-run
             --table-options OPTIONS
+            --table-hash-options OPTIONS
             --alter-extra ALTER_SPEC
             --external-script SCRIPT
             --bulk-change
@@ -43,7 +44,6 @@ describe 'ridgepole' do
         -o, --output SCHEMAFILE
         -t, --tables TABLES
             --ignore-tables REGEX_LIST
-            --mysql-use-alter
             --dump-without-table-options
             --dump-with-default-fk-name
             --index-removed-drop-column
@@ -192,6 +192,40 @@ describe 'ridgepole' do
       end
     end
 
+    context 'apply with --table-hash-options' do
+      context 'given flatten json' do
+        it 'parses string to hash' do
+          out, status = run_cli(args: ['-c', conf, '-a', '--table-hash-options', %('{ id: "bigint", unsigned: true }')])
+
+          expect(status.success?).to be_truthy
+          expect(out).to match_fuzzy <<-MSG
+            Ridgepole::Client#initialize([#{conn_spec_str('ridgepole_test')}, {:dry_run=>false, :debug=>false, :color=>false, :table_hash_options=>{:id=>:bigint, :unsigned=>true}}])
+            Apply `Schemafile`
+            Ridgepole::Client#diff
+            Ridgepole::Delta#differ?
+            Ridgepole::Delta#migrate
+            No change
+          MSG
+        end
+      end
+
+      context 'given nested json' do
+        it 'parses string to nested hash' do
+          out, status = run_cli(args: ['-c', conf, '-a', '--table-hash-options', %('id: { type: "bigint", unsigned: true }')])
+
+          expect(status.success?).to be_truthy
+          expect(out).to match_fuzzy <<-MSG
+            Ridgepole::Client#initialize([#{conn_spec_str('ridgepole_test')}, {:dry_run=>false, :debug=>false, :color=>false, :table_hash_options=>{:id=>{:type=>:bigint, :unsigned=>true}}}])
+            Apply `Schemafile`
+            Ridgepole::Client#diff
+            Ridgepole::Delta#differ?
+            Ridgepole::Delta#migrate
+            No change
+          MSG
+        end
+      end
+    end
+
     specify 'dry-run' do
       out, status = run_cli(args: ['-c', conf, '-a', '--dry-run'])
 

data/spec/mysql/collation/collation_spec.rb

@@ -4,7 +4,7 @@ describe 'Ridgepole::Client#diff -> migrate' do
   context 'when change column (add collation)' do
     let(:actual_dsl) do
       erbh(<<-ERB)
-        create_table "employee_clubs", <%= i cond('>= 5.1', id: :bigint) %>, unsigned: true, force: :cascade do |t|
+        create_table "employee_clubs", <%= i cond({ ">= 5.1, < 6.1" => { id: :bigint, unsigned: true }, ">= 6.1" => { id: { type: :bigint, unsigned: true } } }, { unsigned: true }) %>, force: :cascade do |t|
           t.integer "emp_no", null: false
           t.integer "club_id", null: false, unsigned: true
           t.string  "string", null: false, collation: "ascii_bin"
@@ -15,7 +15,7 @@ describe 'Ridgepole::Client#diff -> migrate' do
 
     let(:expected_dsl) do
       erbh(<<-ERB)
-        create_table "employee_clubs", <%= i cond('>= 5.1', id: :bigint) %>, unsigned: true, force: :cascade do |t|
+        create_table "employee_clubs", <%= i cond({ ">= 5.1, < 6.1" => { id: :bigint, unsigned: true }, ">= 6.1" => { id: { type: :bigint, unsigned: true } } }, { unsigned: true }) %>, force: :cascade do |t|
           t.integer "emp_no", null: false
           t.integer "club_id", null: false, unsigned: true
           t.string  "string", null: false, collation: "ascii_bin"
@@ -39,7 +39,7 @@ describe 'Ridgepole::Client#diff -> migrate' do
   context 'when change column (delete collation)' do
     let(:actual_dsl) do
       erbh(<<-ERB)
-        create_table "employee_clubs", <%= i cond('>= 5.1', id: :bigint) %>, unsigned: true, force: :cascade do |t|
+        create_table "employee_clubs", <%= i cond({ ">= 5.1, < 6.1" => { id: :bigint, unsigned: true }, ">= 6.1" => { id: { type: :bigint, unsigned: true } } }, { unsigned: true }) %>, force: :cascade do |t|
           t.integer "emp_no", null: false
           t.integer "club_id", null: false, unsigned: true
           t.string  "string", null: false, collation: "ascii_bin"
@@ -50,7 +50,7 @@ describe 'Ridgepole::Client#diff -> migrate' do
 
     let(:expected_dsl) do
       erbh(<<-ERB)
-        create_table "employee_clubs", <%= i cond('>= 5.1', id: :bigint) %>, unsigned: true, force: :cascade do |t|
+        create_table "employee_clubs", <%= i cond({ ">= 5.1, < 6.1" => { id: :bigint, unsigned: true }, ">= 6.1" => { id: { type: :bigint, unsigned: true } } }, { unsigned: true }) %>, force: :cascade do |t|
           t.integer "emp_no", null: false
           t.integer "club_id", null: false, unsigned: true
           t.string  "string", null: false, collation: "ascii_bin"
@@ -74,7 +74,7 @@ describe 'Ridgepole::Client#diff -> migrate' do
   context 'when change column (change collation)' do
     let(:actual_dsl) do
       erbh(<<-ERB)
-        create_table "employee_clubs", <%= i cond('>= 5.1', id: :bigint) %>, unsigned: true, force: :cascade do |t|
+        create_table "employee_clubs", <%= i cond({ ">= 5.1, < 6.1" => { id: :bigint, unsigned: true }, ">= 6.1" => { id: { type: :bigint, unsigned: true } } }, { unsigned: true }) %>, force: :cascade do |t|
           t.integer "emp_no", null: false
           t.integer "club_id", null: false, unsigned: true
           t.string  "string", null: false, collation: "ascii_bin"
@@ -85,7 +85,7 @@ describe 'Ridgepole::Client#diff -> migrate' do
 
     let(:expected_dsl) do
       erbh(<<-ERB)
-        create_table "employee_clubs", <%= i cond('>= 5.1', id: :bigint) %>, unsigned: true, force: :cascade do |t|
+        create_table "employee_clubs", <%= i cond({ ">= 5.1, < 6.1" => { id: :bigint, unsigned: true }, ">= 6.1" => { id: { type: :bigint, unsigned: true } } }, { unsigned: true }) %>, force: :cascade do |t|
           t.integer "emp_no", null: false
           t.integer "club_id", null: false, unsigned: true
           t.string  "string", null: false, collation: "utf8mb4_bin"
@@ -109,7 +109,7 @@ describe 'Ridgepole::Client#diff -> migrate' do
   context 'when change column (no change collation)' do
     let(:actual_dsl) do
       erbh(<<-ERB)
-        create_table "employee_clubs", <%= i cond('>= 5.1', id: :bigint) %>, unsigned: true, force: :cascade do |t|
+        create_table "employee_clubs", <%= i cond({ ">= 5.1, < 6.1" => { id: :bigint, unsigned: true }, ">= 6.1" => { id: { type: :bigint, unsigned: true } } }, { unsigned: true }) %>, force: :cascade do |t|
           t.integer "emp_no", null: false
           t.integer "club_id", null: false, unsigned: true
           t.string  "string", null: false, collation: "ascii_bin"
@@ -141,7 +141,7 @@ describe 'Ridgepole::Client#diff -> migrate' do
           # v6.0.3 is the oldest version that doesn't produce any kwargs warnings with Ruby 2.7
           if condition('< 6.0.3')
             # https://github.com/jeremyevans/ruby-warning/blob/1.1.0/lib/warning.rb#L18
-            out = out.lines.grep_v(/: warning: (?:Using the last argument (?:for `.+' )?as keyword parameters is deprecated; maybe \*\* should be added to the call|Passing the keyword argument (?:for `.+' )?as the last hash parameter is deprecated|Splitting the last argument (?:for `.+' )?into positional and keyword parameters is deprecated|The called method (?:`.+' )?is defined here)\n\z/).join('')
+            out = out.lines.grep_v(/: warning: (?:Using the last argument (?:for `.+' )?as keyword parameters is deprecated; maybe \*\* should be added to the call|Passing the keyword argument (?:for `.+' )?as the last hash parameter is deprecated|Splitting the last argument (?:for `.+' )?into positional and keyword parameters is deprecated|The called method (?:`.+' )?is defined here)\n\z/).join
           end
 
           expect(out).to be_empty

data/spec/mysql/dump/dump_class_method_spec.rb

@@ -7,12 +7,12 @@ describe 'Ridgepole::Client.dump' do
 
     it {
       expect(subject.dump(conn_spec, dump_without_table_options: true)).to match_fuzzy erbh(<<-ERB)
-        create_table "clubs", <%= i cond('>= 5.1', id: :integer) %>, unsigned: true, force: :cascade do |t|
+        create_table "clubs", <%= i cond({ '>= 5.1, < 6.1' => { id: :integer, unsigned: true }, ">= 6.1" => { id: { type: :integer, unsigned: true } } }, { unsigned: true }) %>, force: :cascade do |t|
           t.string "name", default: "", null: false
           t.index ["name"], name: "idx_name", unique: true, <%= i cond(5.0, using: :btree) %>
         end
 
-        create_table "departments", primary_key: "dept_no", id: :string, limit: 4, force: :cascade do |t|
+        create_table "departments", primary_key: "dept_no", <%= i cond(">= 6.1", { id: { type: :string, limit: 4 } }, { id: :string, limit: 4 }) %>, force: :cascade do |t|
           t.string "dept_name", limit: 40, null: false
           t.index ["dept_name"], name: "dept_name", unique: true, <%= i cond(5.0, using: :btree) %>
         end
@@ -35,7 +35,7 @@ describe 'Ridgepole::Client.dump' do
           t.index ["emp_no"], name: "emp_no", <%= i cond(5.0, using: :btree) %>
         end
 
-        create_table "employee_clubs", <%= i cond('>= 5.1', id: :integer) %>, unsigned: true, force: :cascade do |t|
+        create_table "employee_clubs", <%= i cond({ '>= 5.1, < 6.1' => { id: :integer, unsigned: true }, ">= 6.1" => { id: { type: :integer, unsigned: true }} }, { unsigned: true }) %>, force: :cascade do |t|
           t.integer "emp_no", null: false, unsigned: true
           t.integer "club_id", null: false, unsigned: true
           t.index ["emp_no", "club_id"], name: "idx_emp_no_club_id", <%= i cond(5.0, using: :btree) %>

data/spec/mysql/dump/dump_spec.rb

@@ -7,12 +7,12 @@ describe 'Ridgepole::Client#dump' do
 
     it {
       expect(subject.dump).to match_fuzzy erbh(<<-ERB)
-        create_table "clubs", <%= i cond('>= 5.1',id: :integer) %>, unsigned: true, force: :cascade do |t|
+        create_table "clubs", <%= i cond({ '>= 5.1, < 6.1' => { id: :integer, unsigned: true }, ">= 6.1" => { id: { type: :integer, unsigned: true } } }, { unsigned: true }) %>, force: :cascade do |t|
           t.string "name", default: "", null: false
           t.index ["name"], name: "idx_name", unique: true, <%= i cond(5.0, using: :btree) %>
         end
 
-        create_table "departments", primary_key: "dept_no", id: :string, limit: 4, force: :cascade do |t|
+        create_table "departments", primary_key: "dept_no", <%= i cond(">= 6.1", { id: { type: :string, limit: 4 } }, { id: :string, limit: 4 }) %>, force: :cascade do |t|
           t.string "dept_name", limit: 40, null: false
           t.index ["dept_name"], name: "dept_name", unique: true, <%= i cond(5.0, using: :btree) %>
         end
@@ -35,7 +35,7 @@ describe 'Ridgepole::Client#dump' do
           t.index ["emp_no"], name: "emp_no", <%= i cond(5.0, using: :btree) %>
         end
 
-        create_table "employee_clubs", <%= i cond('>= 5.1',id: :integer) %>, unsigned: true, force: :cascade do |t|
+        create_table "employee_clubs", <%= i cond({ '>= 5.1, < 6.1' => { id: :integer, unsigned: true }, ">= 6.1" => { id: { type: :integer, unsigned: true } } }, { unsigned: true }) %>, force: :cascade do |t|
           t.integer "emp_no", null: false, unsigned: true
           t.integer "club_id", null: false, unsigned: true
           t.index ["emp_no", "club_id"], name: "idx_emp_no_club_id", <%= i cond(5.0, using: :btree) %>