ridgepole 0.8.12 → 0.9.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91c51bf51596b61eff43704847bd41b9f8035ceafd1f1e05e1cd72fc6632e582
-  data.tar.gz: 32aff893209c48b839286b7efe24d465e3dd808d3b8820f52a5fb4eb9ecbf606
+  metadata.gz: df81adabc9afddf2d409c647190e217dd71a3948b8d3b9c3753f36c8519df701
+  data.tar.gz: 3df1478fbdaa3ef5ac2ac192cf1a022901753f1f4adac72f20b93f17b49dcb2d
 SHA512:
-  metadata.gz: 92c24eca95293b83ab73871c9baaff349e8d28be8ddc5583746d3beecf0b6986eb58127361654fc0742c95b68f9ac2c060ca689af98a9ca6558b78c960b2a35b
-  data.tar.gz: 6864c16bbd8723436219540b7a3ab0f5eccfb32ae5301ac827957b9671c8cf83d7a91ea13a9a364f3b94ef236d2b3334742adce0524f7cb22801d298757cb0cd
+  metadata.gz: ae3fa69120a6ba5103f512092694abd151073ae3e7ed27c23677aa9f617b4a986565c29e6088fbb0f4ae1a0da0cfc425b5c67c8e8b1b19b956164dd8c7fcdf87
+  data.tar.gz: bce34561a3ac8489bbc3466e7d63fd0c4c4a557659e28751bfc06fe3f058d3725493c34426cab2a1171ea86e1e35d4fdde8be3b1e31186599a73748a3a2563a3

data/.github/workflows/test.yml

@@ -20,13 +20,15 @@ jobs:
           - MYSQL57=1
           - POSTGRESQL=1
         gemfile:
-          - gemfiles/activerecord_5.0.gemfile
           - gemfiles/activerecord_5.1.gemfile
           - gemfiles/activerecord_5.2.gemfile
           - gemfiles/activerecord_6.0.gemfile
+          - gemfiles/activerecord_6.1.gemfile
         exclude:
           - ruby: 2.4
             gemfile: gemfiles/activerecord_6.0.gemfile
+          - ruby: 2.4
+            gemfile: gemfiles/activerecord_6.1.gemfile
 
     steps:
       - uses: actions/checkout@v2

data/Appraisals

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-appraise 'activerecord-5.0' do
-  gem 'activerecord', '~> 5.0.1'
-  gem 'pg', '< 1.0.0'
-end
-
 appraise 'activerecord-5.1' do
   gem 'activerecord', '~> 5.1.0'
 end
@@ -17,3 +12,7 @@ end
 appraise 'activerecord-6.0' do
   gem 'activerecord', '~> 6.0.0'
 end
+
+appraise 'activerecord-6.1' do
+  gem 'activerecord', '~> 6.1.0'
+end

data/README.md

@@ -6,8 +6,8 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
 (like Chef/Puppet)
 
 [![Gem Version](https://badge.fury.io/rb/ridgepole.svg)](http://badge.fury.io/rb/ridgepole)
-[![Build Status](https://github.com/winebarrel/ridgepole/workflows/test/badge.svg?branch=0.8)](https://github.com/winebarrel/ridgepole/actions)
-[![Coverage Status](https://coveralls.io/repos/github/winebarrel/ridgepole/badge.svg?branch=0.8)](https://coveralls.io/github/winebarrel/ridgepole?branch=0.8)
+[![Build Status](https://github.com/winebarrel/ridgepole/workflows/test/badge.svg?branch=0.9)](https://github.com/winebarrel/ridgepole/actions)
+[![Coverage Status](https://coveralls.io/repos/github/winebarrel/ridgepole/badge.svg?branch=0.9)](https://coveralls.io/github/winebarrel/ridgepole?branch=0.8)
 
 <details><summary>ChangeLog</summary>
 
@@ -127,8 +127,22 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
   * Support t.reference() foreign_key option ([pull#316](https://github.com/winebarrel/ridgepole/pull/316))
 * `>= 0.8.12`
   * Pluralize column specified by `references` ([pull#317](https://github.com/winebarrel/ridgepole/pull/317))
+* `>= 0.9.0`
+  * Remove `--mysql-alter-index` option ([pull#330](https://github.com/winebarrel/ridgepole/pull/330))
+  * Add `--table-hash-options` option ([pull#331](https://github.com/winebarrel/ridgepole/pull/331))
+  * Support Rails 6.1 ([pull#323](https://github.com/winebarrel/ridgepole/pull/323))
+  * Disable Rails 5.0 support([pull#335](https://github.com/winebarrel/ridgepole/pull/335))
+  * Fix PK AUTO_INCREMENT change bug([pull#334](https://github.com/winebarrel/ridgepole/pull/334))
 </details>
 
+**Notice**
+
+ActiveRecord 6.1 is supported in ridgepole v0.9, but the ActiveRecord dump has been changed, so there is a difference between ActiveRecord 5.x/6.0 format.
+
+**If you use ActiveRecord 6.1, please modify Schemafile format**.
+
+cf. https://github.com/winebarrel/ridgepole/pull/323
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -174,6 +188,7 @@ Usage: ridgepole [options]
     -f, --file SCHEMAFILE
         --dry-run
         --table-options OPTIONS
+        --table-hash-options OPTIONS
         --alter-extra ALTER_SPEC
         --external-script SCRIPT
         --bulk-change
@@ -194,7 +209,6 @@ Usage: ridgepole [options]
     -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
@@ -404,20 +418,6 @@ Apply `Schemafile`
    -> 0.0471s
 ```
 
-## Use ALTER instead of CREATE/DROP INDEX
-
-```sh
-$ ridgepole -a -c database.yml --mysql-use-alter --debug
-Apply `Schemafile`
-...
--- remove_index("dept_manager", {:name=>"emp_no"})
-   (19.2ms)  ALTER TABLE `dept_manager` DROP INDEX `emp_no`
-   -> 0.0200s
--- add_index("dept_manager", ["emp_no"], {:name=>"emp_no2", :using=>:btree})
-   (23.4ms)  ALTER TABLE `dept_manager` ADD  INDEX `emp_no2` USING btree (`emp_no`)
-   -> 0.0243s
-```
-
 ## Relation column type check
 
 ```ruby

data/bin/ridgepole

@@ -86,6 +86,19 @@ ARGV.options do |opt|
     opt.on('-f', '--file SCHEMAFILE') { |v| file = v }
     opt.on('',   '--dry-run') { options[:dry_run] = true }
     opt.on('',   '--table-options OPTIONS') { |v| options[:table_options] = v }
+    opt.on('',   '--table-hash-options OPTIONS') do |v|
+      # NOTE: Ruby2.4 doesn't support `symbolize_names: true`
+      hash = YAML.safe_load(v).deep_symbolize_keys
+
+      case hash[:id]
+      when String
+        hash[:id] = hash[:id].to_sym
+      when Hash
+        hash[:id][:type] = hash[:id][:type].to_sym if hash[:id][:type]
+      end
+
+      options[:table_hash_options] = hash
+    end
     opt.on('',   '--alter-extra ALTER_SPEC') { |v| options[:alter_extra] = v }
     opt.on('',   '--external-script SCRIPT') { |v| options[:external_script] = v }
     opt.on('',   '--bulk-change') do
@@ -121,7 +134,6 @@ ARGV.options do |opt|
     opt.on('-o', '--output SCHEMAFILE') { |v| output_file = v }
     opt.on('-t', '--tables TABLES', Array) { |v| options[:tables] = v }
     opt.on('',   '--ignore-tables REGEX_LIST', Array) { |v| options[:ignore_tables] = v.map { |i| Regexp.new(i) } }
-    opt.on('',   '--mysql-use-alter') { options[:mysql_use_alter] = true }
     opt.on('',   '--dump-without-table-options') { options[:dump_without_table_options] = true }
     opt.on('',   '--dump-with-default-fk-name') { options[:dump_with_default_fk_name] = true }
     opt.on('',   '--index-removed-drop-column') { options[:index_removed_drop_column] = true }

data/gemfiles/{activerecord_5.0.gemfile → activerecord_6.1.gemfile}

@@ -2,7 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 5.0.1"
-gem "pg", "< 1.0.0"
+gem "activerecord", "~> 6.1.0"
 
 gemspec path: "../"

data/lib/ridgepole/client.rb

@@ -15,8 +15,6 @@ module Ridgepole
       @parser = Ridgepole::DSLParser.new(@options)
       @diff = Ridgepole::Diff.new(@options)
 
-      require 'ridgepole/ext/abstract_mysql_adapter/use_alter_index' if @options[:mysql_use_alter]
-
       require 'ridgepole/ext/abstract_mysql_adapter/dump_auto_increment' if @options[:mysql_dump_auto_increment]
     end
 
@@ -32,7 +30,7 @@ module Ridgepole
       logger.verbose_info('# Parse DSL')
       expected_definition, expected_execute = @parser.parse(dsl, opts)
       expected_definition.each do |_table, definition|
-        definition[:options][:options] ||= @options[:table_options] if @options[:table_options]
+        merge_table_options(definition)
       end
       logger.verbose_info('# Load tables')
       current_definition, _current_execute = @parser.parse(@dumper.dump, opts)
@@ -40,6 +38,13 @@ module Ridgepole
       @diff.diff(current_definition, expected_definition, execute: expected_execute)
     end
 
+    private
+
+    def merge_table_options(definition)
+      definition[:options].reverse_merge!(@options[:table_hash_options]) if @options[:table_hash_options]
+      definition[:options][:options] ||= @options[:table_options] if @options[:table_options]
+    end
+
     class << self
       def diff(dsl_or_config1, dsl_or_config2, options = {})
         logger = Ridgepole::Logger.instance

data/lib/ridgepole/default_limit.rb

@@ -23,7 +23,7 @@ module Ridgepole
       end
 
       def adapter
-        ActiveRecord::Base.connection_config.fetch(:adapter).to_sym
+        ActiveRecord::Base.connection.adapter_name.downcase.to_sym
       rescue ActiveRecord::ConnectionNotEstablished
         nil
       end

data/lib/ridgepole/delta.rb

@@ -292,6 +292,19 @@ execute "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name
       buf.puts
     end
 
+    def append_change_table_raw_options(table_name, raw_table_options, table_charset, table_collation, buf)
+      if raw_table_options.blank? && ActiveRecord.gem_version >= Gem::Version.new('6.1.0')
+        # Implicit engine is InnoDB in 6.1.0
+        # related: https://github.com/rails/rails/pull/39365/files#diff-868f1dccfcbed26a288bf9f3fd8a39c863a4413ab0075e12b6805d9798f556d1R441
+        raw_table_options = +'ENGINE=InnoDB'
+      end
+
+      raw_table_options << " DEFAULT CHARSET=#{table_charset}" if table_charset
+      raw_table_options << " COLLATE=#{table_collation}" if table_collation
+
+      append_change_table_options(table_name, raw_table_options, buf)
+    end
+
     def append_change_table_comment(table_name, table_comment, buf)
       comment_literal = "COMMENT=#{ActiveRecord::Base.connection.quote(table_comment)}"
       append_change_table_options(table_name, comment_literal, buf)
@@ -303,6 +316,8 @@ execute "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name
       indices = attrs[:indices] || {}
       foreign_keys = attrs[:foreign_keys] || {}
       table_options = attrs[:table_options]
+      table_charset = attrs[:table_charset]
+      table_collation = attrs[:table_collation]
       table_comment = attrs[:table_comment]
 
       if !definition.empty? || !indices.empty? || !primary_key_definition.empty?
@@ -316,7 +331,7 @@ execute "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name
 
       append_change_foreign_keys(table_name, foreign_keys, pre_buf_for_fk, post_buf_for_fk, @options) unless foreign_keys.empty?
 
-      append_change_table_options(table_name, table_options, buf) if table_options
+      append_change_table_raw_options(table_name, table_options, table_charset, table_collation, buf) if table_options || table_charset || table_collation
 
       append_change_table_comment(table_name, table_comment, buf) if table_comment
 

data/lib/ridgepole/diff.rb

@@ -114,23 +114,33 @@ module Ridgepole
 
       normalize_default_proc_options!(from, to)
 
-      from_options = from[:options] || {}
-      to_options = to[:options] || {}
-
       if @options[:ignore_table_comment]
         from.delete(:comment)
         to.delete(:comment)
       end
 
-      [from, to].each do |table_attrs|
-        table_attrs.delete(:default) if table_attrs.key?(:default) && table_attrs[:default].nil?
-      end
-
       if Ridgepole::ConnectionAdapters.mysql?
-        if @options[:mysql_change_table_options] && (from_options != to_options)
-          from.delete(:options)
-          to.delete(:options)
-          table_delta[:table_options] = to_options
+        if @options[:mysql_change_table_options]
+          from_options = from[:options] || {}
+          to_options = to[:options] || {}
+
+          if from_options != to_options
+            table_delta[:table_options] = to_options
+            from.delete(:options)
+            to.delete(:options)
+          end
+
+          if from[:charset] != to[:charset]
+            table_delta[:table_charset] = to[:charset]
+            from.delete(:charset)
+            to.delete(:charset)
+          end
+
+          if from[:collation] != to[:collation]
+            table_delta[:table_collation] = to[:collation]
+            from.delete(:collation)
+            to.delete(:collation)
+          end
         end
 
         if @options[:mysql_change_table_comment] && (from[:comment] != to[:comment])
@@ -142,7 +152,11 @@ module Ridgepole
 
       if @options[:dump_without_table_options]
         from.delete(:options)
+        from.delete(:charset)
+        from.delete(:collation)
         to.delete(:options)
+        to.delete(:charset)
+        to.delete(:collation)
       end
 
       pk_attrs = build_primary_key_attrs_if_changed(from, to, table_name)
@@ -177,13 +191,16 @@ module Ridgepole
     end
 
     def convert_to_primary_key_attrs(column_options)
-      options = column_options.dup
-
-      type = if options[:id]
-               options.delete(:id)
-             else
-               Ridgepole::DSLParser::TableDefinition::DEFAULT_PRIMARY_KEY_TYPE
-             end
+      type = Ridgepole::DSLParser::TableDefinition::DEFAULT_PRIMARY_KEY_TYPE
+      options = column_options.deep_dup
+
+      if options[:id].is_a?(Hash)
+        options_id = options.delete(:id)
+        type = options_id.delete(:type) if options_id[:type]
+        options.merge!(options_id.slice(*PRIMARY_KEY_OPTIONS))
+      elsif options[:id]
+        type = options.delete(:id)
+      end
 
       options[:auto_increment] = true if %i[integer bigint].include?(type) && !options.key?(:default) && !Ridgepole::ConnectionAdapters.postgresql?
 
@@ -551,9 +568,15 @@ module Ridgepole
           table_options = parent_table_info.fetch(:options)
           next if table_options[:id] == false
 
+          options_id = table_options[:id]
+          parent_type, parent_unsigned = if options_id.is_a?(Hash)
+                                           [options_id[:type], options_id[:unsigned]]
+                                         else
+                                           [table_options[:id], table_options[:unsigned]]
+                                         end
           parent_column_info = {
-            type: table_options[:id] || @options[:check_relation_type].to_sym,
-            unsigned: table_options[:unsigned],
+            type: parent_type || @options[:check_relation_type].to_sym,
+            unsigned: parent_unsigned,
           }
 
           child_column_info = {

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

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