ridgepole 0.8.11 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 367dff4faf9fd7e94588cdefe290cf13953cf82b9dc5110e91cfd5d4ee2507a3
-  data.tar.gz: 20ad65390cd7b12fe97e8fbae409aa5bc0d86a6c73c79a9916bfc55f46f03cb6
+  metadata.gz: 3aa2d123eaa04d61f3b9c602714abb2c2b8f8a8c26fe98a4179972a999544781
+  data.tar.gz: 1bed7b6f6caab7b80c86eb885cbe462db3a8970f558cc8a9fbd6bad6d5a728f5
 SHA512:
-  metadata.gz: 94039eb4e75e2f0b218275ffec9b8a1b4c28ae5b9c93ad64b584793acbabc1ece9eb8ddde4e6d3097ffc6a9346ef36a6318334048d99c8e85050e0b9ef3088bd
-  data.tar.gz: 5e4837104ea5b6b69e42fdcc82e29b71a33835ce8371b959c16f3c00b014047a88b3c01ecba74ab8d6e591fd3357d15019a1dc41c425ff4c10b49fcec6bbdc48
+  metadata.gz: 2455d86f97127f948c38ff7a86ff436008729defcc560dc81eb05e41647c65f4def830ee2f0f522ba0e235d879ac88876254d0edbab27be0c5b58189e978522f
+  data.tar.gz: 8cfdf0654b03655332dfe06b70cadda456dc9300360342ba4a47c3703d1dca25ca1bf93908c08febc556d8b75820b35198aabed497410e6ab1fa2ad67391fb09

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
@@ -44,6 +46,7 @@ jobs:
         run: |
           for i in {1..60}; do docker-compose up -d && break; sleep 1; done
 
+          gem install bundler
           bundle config path vendor/bundle
           bundle install --jobs 4 --retry 3
 
@@ -57,6 +60,24 @@ jobs:
         env:
           BUNDLE_GEMFILE: ${{ matrix.gemfile }}
 
-      - run: ${{ matrix.env }} bundle exec rake
+      - name: Run tests
+        run: ${{ matrix.env }} bundle exec rake
         env:
           BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@v1.1.2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: run-${{ matrix.ruby }}-${{ matrix.env }}-${{ matrix.gemfile }}
+          parallel: true
+
+  finish:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@v1.1.2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true

data/.simplecov

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+SimpleCov.start do
+  # exclude directories and files
+  add_filter '/spec/'
+end

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.9)
 
 <details><summary>ChangeLog</summary>
 
@@ -125,8 +125,26 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
 * `>= 0.8.11`
   * Fix FK index check support multiple PK ([pull#315](https://github.com/winebarrel/ridgepole/pull/315))
   * 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.8.13`
+  * Support `serial` and `bigserial` column types  ([pull#321](https://github.com/winebarrel/ridgepole/pull/321))
+* `>= 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:
@@ -141,26 +159,6 @@ Or install it yourself as:
 
     $ gem install ridgepole
 
-## Omnibus Package (deb/rpm)
-
-see https://github.com/winebarrel/ridgepole/releases.
-
-### Install from deb
-
-```sh
-sudo dpkg -i ridgepole_x.x.x+xxx-x_amd64.deb
-sudo apt install build-essential libmysqlclient-dev
-sudo /opt/ridgepole/embedded/bin/gem install mysql2
-```
-
-### Install from rpm
-
-```sh
-sudo yum install ridgepole-x.x.x+xxx-x.el7.x86_64.rpm
-sudo yum install make gcc mariadb-devel
-sudo /opt/ridgepole/embedded/bin/gem install mysql2
-```
-
 ## Help
 ```
 Usage: ridgepole [options]
@@ -172,6 +170,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
@@ -192,7 +191,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
@@ -351,7 +349,7 @@ add_index "books", ["author_id"], name: "idx_author_id", using: :btree
 
 execute("ALTER TABLE books ADD CONSTRAINT fk_author FOREIGN KEY (author_id) REFERENCES authors (id)") do |c|
   # Execute SQL only if there is no foreign key
-  c.raw_connection.query(<<-SQL).each.length.zero?
+  c.raw_connection.query(<<-SQL).each.size.zero?
     SELECT 1 FROM information_schema.key_column_usage
      WHERE TABLE_SCHEMA = 'bookshelf'
        AND CONSTRAINT_NAME = 'fk_author' LIMIT 1
@@ -402,20 +400,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
@@ -464,6 +448,3 @@ bundle exec appraisal activerecord-5.1 rake
 * https://github.com/winebarrel/ridgepole-example
   * https://github.com/winebarrel/ridgepole-example/pull/1
   * https://github.com/winebarrel/ridgepole-example/pull/2
-
-## Similar tools
-* [Codenize.tools](http://codenize.tools/)

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 }
@@ -135,8 +147,6 @@ ARGV.options do |opt|
     opt.on('',   '--create-table-with-index') { options[:create_table_with_index] = true }
 
     opt.on('',   '--mysql-dump-auto-increment') do
-      raise OptionParser::InvalidOption, '`mysql-dump-auto-increment` is not available in `activerecord < 5.1`' if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new('5.1')
-
       options[:mysql_dump_auto_increment] = true
     end
 

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,10 +152,14 @@ 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)
+      pk_attrs = build_primary_key_attrs_if_changed(from, to)
       if pk_attrs
         if @options[:allow_pk_change]
           if from[:id] == false
@@ -177,33 +191,36 @@ 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?
 
       { type: type, options: options }
     end
 
-    def build_attrs_if_changed(to_attrs, from_attrs, table_name, primary_key: false)
+    def build_attrs_if_changed(to_attrs, from_attrs, primary_key: false)
       normalize_column_options!(from_attrs, primary_key)
       normalize_column_options!(to_attrs, primary_key)
 
-      new_to_attrs = fix_change_column_options(table_name, from_attrs, to_attrs) unless compare_column_attrs(from_attrs, to_attrs)
+      new_to_attrs = fix_change_column_options(from_attrs, to_attrs) unless compare_column_attrs(from_attrs, to_attrs)
       new_to_attrs
     end
 
-    def build_primary_key_attrs_if_changed(from, to, table_name)
+    def build_primary_key_attrs_if_changed(from, to)
       from_column_attrs = convert_to_primary_key_attrs(from.slice(*PRIMARY_KEY_OPTIONS))
       to_column_attrs = convert_to_primary_key_attrs(to.slice(*PRIMARY_KEY_OPTIONS))
       return if from_column_attrs == to_column_attrs
 
-      build_attrs_if_changed(to_column_attrs, from_column_attrs, table_name, primary_key: true)
+      build_attrs_if_changed(to_column_attrs, from_column_attrs, primary_key: true)
     end
 
     def scan_definition_change(from, to, from_indices, table_name, table_options, table_delta)
@@ -225,7 +242,7 @@ module Ridgepole
         next if ignore_column
 
         if from_attrs
-          to_attrs = build_attrs_if_changed(to_attrs, from_attrs, table_name)
+          to_attrs = build_attrs_if_changed(to_attrs, from_attrs)
           if to_attrs
             definition_delta[:change] ||= {}
             definition_delta[:change][column_name] = to_attrs
@@ -454,7 +471,7 @@ module Ridgepole
     # XXX: MySQL only?
     # https://github.com/rails/rails/blob/v4.2.1/activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb#L760
     # https://github.com/rails/rails/blob/v4.2.1/activerecord/lib/active_record/connection_adapters/abstract/schema_creation.rb#L102
-    def fix_change_column_options(table_name, from_attrs, to_attrs)
+    def fix_change_column_options(from_attrs, to_attrs)
       # default: 0, null: false -> default: nil, null: false | default: nil
       # default: 0, null: false ->               null: false | default: nil
       # default: 0, null: false -> default: nil, null: true  | default: nil, null: true
@@ -469,10 +486,6 @@ module Ridgepole
         to_attrs[:options].delete(:null)
       end
 
-      if Ridgepole::ConnectionAdapters.mysql? && ActiveRecord::VERSION::STRING.start_with?('5.0.')
-        Ridgepole::Logger.instance.warn("[WARNING] Table `#{table_name}`: `default: nil` is ignored when `null: false`. Please apply twice") if to_attrs[:options][:default].nil? && (to_attrs[:options][:null] == false)
-      end
-
       to_attrs
     end
 
@@ -551,9 +564,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 = {