ridgepole 0.8.4 → 0.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a09a114ad24ead5072a479593d757ea2dad1d0f42ebf9ae84febad36db8ba78
-  data.tar.gz: e4e14f15a869ac1b66cff3b869f4ca5d246975e4b62e4a8f5e8ecf040efe9d9c
+  metadata.gz: b4a820687bccfcbcfaa3290b28536a0ea3599d32a35a16e897f37a20a4e1ef75
+  data.tar.gz: c25c8a48b003aa297f7b1a979f609898b776c3393628d42c2dc2a0897d87be0e
 SHA512:
-  metadata.gz: a664d190502ef67c91b9dc96f95cf4289812195939f8193354fea005de1bb83a31e479758dc0c64115dae02b6c7d62588fcd89f9129ebc2664c0bf8eef5906c1
-  data.tar.gz: ac81928fe43c71c13542686361af7d54868782728a1d02731f431827dba66204098baf6b2a674cf817b239f285b94b5e2edf48d842997e7cdf47b238234aac71
+  metadata.gz: d58fae0cd35607eb2980be9600b0d31b04605c559445932d7f73ab7cec066267bb45da5ef783c0ab577fec2272f664214afd190d088c1976f299fcfb30a6c54a
+  data.tar.gz: 498c6a55c4d7480a7ac019e58ddc63a8212961bda3d587f9d30d860be1d04d8a8f33e5bcbac72044d759919a3abba46f36750cc4cf2bcd44b87d4af352f7318d

data/.rubocop.yml

@@ -6,7 +6,7 @@ AllCops:
 Bundler/OrderedGems:
   Include:
     - 'Appraisals'
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Enabled: false
 Metrics/AbcSize:
   Enabled: false
@@ -18,7 +18,7 @@ Metrics/ClassLength:
   Enabled: false
 Metrics/CyclomaticComplexity:
   Enabled: false
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 Metrics/MethodLength:
   Enabled: false
@@ -30,8 +30,6 @@ Style/Documentation:
   Enabled: false
 Style/GuardClause:
   Enabled: false
-Style/MethodMissingSuper:
-  Enabled: false
 Style/MixinUsage:
   Exclude:
     - 'spec/**/*'
@@ -41,3 +39,39 @@ Layout/ClosingHeredocIndentation:
   Enabled: false
 Style/NumericPredicate:
   Enabled: false
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MissingSuper:
+  Enabled: false
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true

data/.travis.yml

@@ -4,11 +4,11 @@ group: edge
 language: ruby
 cache:
   - bundler
-  - apt
 rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - 2.7.1
 before_script:
   - sudo service mysql stop
   - sudo service postgresql stop
@@ -41,7 +41,5 @@ addons:
       - postgresql-client-9.4
 matrix:
   exclude:
-    - rvm: 2.3.8
-      gemfile: gemfiles/activerecord_6.0.gemfile
-    - rvm: 2.4.6
+    - rvm: 2.4.9
       gemfile: gemfiles/activerecord_6.0.gemfile

data/README.md

@@ -109,6 +109,17 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
   * Fix "topological sort failed" error ([pull#287](https://github.com/winebarrel/ridgepole/pull/287))
 * `>= 0.8.4`
   * Display a warning if an InnoDB table doesn't have any indexes on a column where it has a foreign key ([pull#290](https://github.com/winebarrel/ridgepole/pull/290))
+* `>= 0.8.5`
+  * Improve warning message on table options ([pull#291](https://github.com/winebarrel/ridgepole/pull/291))
+* `>= 0.8.6`
+  * Support multiple databases feature ([pull#297](https://github.com/winebarrel/ridgepole/pull/297))
+* `>= 0.8.7`
+  * Support `require_relative` ([pull#298](https://github.com/winebarrel/ridgepole/pull/298))
+* `>= 0.8.8`
+  * Fix keyword arguments warnings in Ruby 2.7 ([pull#303](https://github.com/winebarrel/ridgepole/pull/303))
+* `>= 0.8.9`
+  * Fix unexpected differences on text types and blob types on Rails 6 ([pull#306](https://github.com/winebarrel/ridgepole/pull/306))
+  * Fix unexpected warning when a foreign key is added on the primary key ([pull#307](https://github.com/winebarrel/ridgepole/pull/307))
 </details>
 
 ## Installation
@@ -150,6 +161,7 @@ sudo /opt/ridgepole/embedded/bin/gem install mysql2
 Usage: ridgepole [options]
     -c, --config CONF_OR_FILE
     -E, --env ENVIRONMENT
+    -s, --spec-name SPEC_NAME
     -a, --apply
     -m, --merge
     -f, --file SCHEMAFILE
@@ -186,6 +198,7 @@ Usage: ridgepole [options]
         --ignore-table-comment
         --skip-column-comment-change
         --create-table-with-index
+        --allow-pk-change
         --mysql-dump-auto-increment
     -r, --require LIBS
         --log-file LOG_FILE
@@ -302,7 +315,6 @@ end
 ```
 
 ## Collation/Charset
-You can use the column collation by passing `--enable-mysql-awesome` ([activerecord-mysql-awesome](https://github.com/kamipo/activerecord-mysql-awesome) is required)
 
 ```ruby
 create_table "articles", force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|

data/bin/ridgepole

@@ -38,6 +38,7 @@ split = false
 diff_files = nil
 diff_with_apply = false
 exit_code = 0
+spec_name = ''
 
 options = {
   dry_run: false,
@@ -76,6 +77,7 @@ ARGV.options do |opt|
   begin
     opt.on('-c', '--config CONF_OR_FILE') { |v| config = v }
     opt.on('-E', '--env ENVIRONMENT') { |v| env = v }
+    opt.on('-s', '--spec-name SPEC_NAME') { |v| spec_name = v }
     opt.on('-a', '--apply') { set_mode[:apply] }
     opt.on('-m', '--merge') do
       set_mode[:apply]
@@ -168,7 +170,7 @@ begin
   logger = Ridgepole::Logger.instance
   logger.debug = options[:debug]
 
-  client = Ridgepole::Client.new(Ridgepole::Config.load(config, env), options) if config
+  client = Ridgepole::Client.new(Ridgepole::Config.load(config, env, spec_name), options) if config
 
   ActiveRecord::Base.logger = logger
   ActiveSupport::LogSubscriber.colorize_logging = options[:color]
@@ -247,7 +249,7 @@ begin
         file_ext = File.extname(diff_file)
 
         if %w[.yml .yaml].include?(file_ext)
-          Ridgepole::Config.load(diff_file, env)
+          Ridgepole::Config.load(diff_file, env, spec_name)
         else
           File.open(diff_file)
         end

data/lib/ridgepole/cli/config.rb

@@ -6,7 +6,7 @@ require 'yaml'
 module Ridgepole
   class Config
     class << self
-      def load(config, env = 'development')
+      def load(config, env = 'development', spec_name = '')
         config = ENV.fetch(Regexp.last_match(1)) if config =~ /\Aenv:(.+)\z/
 
         parsed_config = if File.exist?(config)
@@ -26,8 +26,10 @@ module Ridgepole
 
         parsed_config = parse_database_url(config) unless parsed_config.is_a?(Hash)
 
-        if parsed_config.key?(env.to_s)
-          parsed_config.fetch(env.to_s)
+        parsed_config = parsed_config.fetch(env.to_s) if parsed_config.key?(env.to_s)
+
+        if parsed_config.key?(spec_name.to_s)
+          parsed_config.fetch(spec_name.to_s)
         else
           parsed_config
         end

data/lib/ridgepole/delta.rb

@@ -246,7 +246,7 @@ create_table(#{table_name.inspect}, #{inspect_options_include_default_proc(optio
       end
 
       buf.puts(<<-RUBY)
-  end
+end
       RUBY
 
       if !(@options[:create_table_with_index]) && !indices.empty?
@@ -326,7 +326,7 @@ execute "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name
     end
 
     def append_change_table(table_name, buf)
-      buf.puts "change_table(#{table_name.inspect}, {:bulk => true}) do |t|" if @options[:bulk_change]
+      buf.puts "change_table(#{table_name.inspect}, bulk: true) do |t|" if @options[:bulk_change]
       yield
       buf.puts 'end' if @options[:bulk_change]
     end
@@ -429,11 +429,11 @@ remove_column(#{table_name.inspect}, #{column_name.inspect})
 
       if force_bulk_change || @options[:bulk_change]
         buf.puts(<<-RUBY)
-  t.index(#{column_name.inspect}, #{options.inspect})
+  t.index(#{column_name.inspect}, **#{options.inspect})
       RUBY
       else
         buf.puts(<<-RUBY)
-add_index(#{table_name.inspect}, #{column_name.inspect}, #{options.inspect})
+add_index(#{table_name.inspect}, #{column_name.inspect}, **#{options.inspect})
       RUBY
       end
     end
@@ -441,15 +441,20 @@ add_index(#{table_name.inspect}, #{column_name.inspect}, #{options.inspect})
     def append_remove_index(table_name, _index_name, attrs, buf)
       column_name = attrs.fetch(:column_name)
       options = attrs[:options] || {}
-      target = options[:name] ? { name: options[:name] } : column_name
+      target =
+        if options[:name]
+          "name: #{options[:name].inspect}"
+        else
+          column_name.inspect
+        end
 
       if @options[:bulk_change]
         buf.puts(<<-RUBY)
-  t.remove_index(#{target.inspect})
+  t.remove_index(#{target})
       RUBY
       else
         buf.puts(<<-RUBY)
-remove_index(#{table_name.inspect}, #{target.inspect})
+remove_index(#{table_name.inspect}, #{target})
       RUBY
       end
     end
@@ -469,7 +474,7 @@ remove_index(#{table_name.inspect}, #{target.inspect})
       attrs_options = attrs[:options] || {}
 
       buf.puts(<<-RUBY)
-add_foreign_key(#{table_name.inspect}, #{to_table.inspect}, #{attrs_options.inspect})
+add_foreign_key(#{table_name.inspect}, #{to_table.inspect}, **#{attrs_options.inspect})
     RUBY
     end
 
@@ -478,13 +483,13 @@ add_foreign_key(#{table_name.inspect}, #{to_table.inspect}, #{attrs_options.insp
       fk_name = attrs_options[:name]
 
       target = if fk_name
-                 { name: fk_name }
+                 "name: #{fk_name.inspect}"
                else
-                 attrs.fetch(:to_table)
+                 attrs.fetch(:to_table).inspect
                end
 
       buf.puts(<<-RUBY)
-remove_foreign_key(#{table_name.inspect}, #{target.inspect})
+remove_foreign_key(#{table_name.inspect}, #{target})
     RUBY
     end
 
@@ -500,17 +505,19 @@ remove_foreign_key(#{table_name.inspect}, #{target.inspect})
     def inspect_options_include_default_proc(options)
       options = options.dup
 
-      if options[:default].is_a?(Proc)
-        proc_default = options.delete(:default)
-        proc_default = ":default=>proc{#{proc_default.call.inspect}}"
-        options_inspect = options.inspect
-        options_inspect.sub!(/\}\z/, '')
-        options_inspect << ', ' if options_inspect !~ /\{\z/
-        options_inspect << proc_default << '}'
-        options_inspect
-      else
-        options.inspect
-      end
+      kwargs =
+        if options[:default].is_a?(Proc)
+          proc_default = options.delete(:default)
+          proc_default = ":default=>proc{#{proc_default.call.inspect}}"
+          options_inspect = options.inspect
+          options_inspect.sub!(/\}\z/, '')
+          options_inspect << ', ' if options_inspect !~ /\{\z/
+          options_inspect << proc_default << '}'
+          options_inspect
+        else
+          options.inspect
+        end
+      "**#{kwargs}"
     end
   end
 end

data/lib/ridgepole/diff.rb

@@ -169,7 +169,7 @@ module Ridgepole
 
       unless from == to
         @logger.warn(<<-MSG)
-[WARNING] No difference of schema configuration for table `#{table_name}` but table options differ.
+[WARNING] Table option changes are ignored on `#{table_name}`.
   from: #{from}
     to: #{to}
       MSG
@@ -386,6 +386,18 @@ module Ridgepole
           attrs[:type] = :bigint
           opts.delete(:limit)
         end
+
+        if opts[:size] && (attrs[:type] == :text || attrs[:type] == :blob || attrs[:type] == :binary)
+          case opts.delete(:size)
+          when :tiny
+            attrs[:type] = :blob if attrs[:type] == :binary
+            opts[:limit] = 255
+          when :medium
+            opts[:limit] = 16_777_215
+          when :long
+            opts[:limit] = 4_294_967_295
+          end
+        end
       end
     end
 

data/lib/ridgepole/dsl_parser.rb

@@ -37,10 +37,11 @@ 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 }
+        next if attrs[:options][:primary_key] == 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.
+          Although an index will be added automatically by InnoDB, please add an index explicitly before the next operation.
         MSG
       end
     end

data/lib/ridgepole/dsl_parser/context.rb

@@ -3,8 +3,7 @@
 module Ridgepole
   class DSLParser
     class Context
-      attr_reader :__definition
-      attr_reader :__execute
+      attr_reader :__definition, :__execute
 
       def initialize(opts = {})
         @__working_dir = File.expand_path(opts[:path] ? File.dirname(opts[:path]) : Dir.pwd)
@@ -104,6 +103,10 @@ module Ridgepole
         end
       end
 
+      def require_relative(relative_path)
+        require(File.expand_path(relative_path, File.dirname(caller[0])))
+      end
+
       def execute(sql, _name = nil, &cond)
         @__execute << {
           sql: sql,

data/lib/ridgepole/external_sql_executer.rb

@@ -41,7 +41,7 @@ module Ridgepole
               end
             end
           end
-        rescue EOFError # rubocop:disable Lint/HandleExceptions
+        rescue EOFError
           # nothing to do
         end
 

data/lib/ridgepole/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ridgepole
-  VERSION = '0.8.4'
+  VERSION = '0.8.9'
 end

data/spec/dsl_parser/context_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+describe Ridgepole::DSLParser::Context do
+  describe '#require_relative' do
+    subject { context.require_relative(relative_path) }
+
+    let!(:context) do
+      Ridgepole::DSLParser::Context.new
+    end
+    let!(:relative_path) do
+      '../fixtures/for_require_relative_spec.rb'
+    end
+
+    it { is_expected.to be_truthy }
+  end
+end

data/spec/fixtures/for_require_relative_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+'This file is used by dsl_parser/context_spec.'

data/spec/mysql/cli/config_spec.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 describe Ridgepole::Config do
-  subject { Ridgepole::Config.load(config, env) }
+  subject { Ridgepole::Config.load(config, env, spec_name) }
+
+  let(:spec_name) { '' }
 
   context 'when passed toplevel yaml' do
     let(:config) do
@@ -154,4 +156,55 @@ describe Ridgepole::Config do
       expect(subject['port']).to eq 3307
     }
   end
+
+  context 'when passed rails database.yml multiple databases style yaml' do
+    let(:config) do
+      <<-YAML.strip_heredoc
+        development:
+          primary:
+            adapter: sqlspecifye
+            database: db/sample.db
+        production:
+          primary:
+            adapter: mysql2
+            encoding: utf8
+            database: blog
+            username: root
+          primary_replica:
+            adapter: mysql2
+            encoding: utf8
+            database: blog
+            username: readonly
+      YAML
+    end
+
+    context 'in development env with primary spec name' do
+      let(:env) { 'development' }
+      let(:spec_name) { 'primary' }
+      specify do
+        expect(subject['adapter']).to eq 'sqlspecifye'
+        expect(subject['database']).to eq 'db/sample.db'
+        expect(subject['username']).to be_nil
+      end
+    end
+
+    context 'in production env with primary spec name' do
+      let(:env) { 'production' }
+      let(:spec_name) { 'primary' }
+      specify do
+        expect(subject['adapter']).to eq 'mysql2'
+        expect(subject['encoding']).to eq 'utf8'
+        expect(subject['database']).to eq 'blog'
+        expect(subject['username']).to eq 'root'
+      end
+    end
+
+    context 'in production env with primary_replica spec name' do
+      let(:env) { 'production' }
+      let(:spec_name) { 'primary_replica' }
+      specify do
+        expect(subject['username']).to eq 'readonly'
+      end
+    end
+  end
 end