strong_migrations 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08eb5f509b5fb98501eb6f83840c414c331c989b7d92bd29825cbaa0e2312177'
-  data.tar.gz: 0fc4b64d44609ff2f6bbbf48d53730e35551654d3a1aaf629b7305ab8ac92caf
+  metadata.gz: bbb45da961375e9a3499c6b651da754c164f05b0e33f9b5061a856ce508663b6
+  data.tar.gz: 1718eb87c7eb8b60553b1e800e8a4866cdbc134ae9c062e012caa6e8f3d4be6b
 SHA512:
-  metadata.gz: fc5cbfa0dbcdc47b8f5e42c18c64d77cabcc01deac0e92077d9d034bff6a47145354da066c70d2eb2906c60c895f5639de40ee9a1c00e015f80d54242f8bcb4c
-  data.tar.gz: 5dfcdd45c56da317a83509c6f79c3d81b8c35e3f6e8aaf0af32c8144e134b919da481b2f501a87dbb581f4c61db96bccc4103cf285210f7777f0258020e1c6f3
+  metadata.gz: 63dde3000e42dbe433914159a815a1dc4a1ebca89e78f3f342e9aa664bd1e921bbb3a1ee33140d6e56d50aef400b171e27a24509fd369da0350b0f548a108a25
+  data.tar.gz: d187c338c085b86ad7498ea09253a9d2015415740b4c09d78ec1f9f37abbc20261255b1590210d7bbf473fcb2ecfa1bad57a9e356a9e2480ec2f90d9fb355404

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.1
+
+- Fixed error with `remove_column` and `type` argument
+- Improved message customization
+
 ## 0.3.0
 
 - Added support for custom checks

data/lib/strong_migrations.rb

@@ -20,12 +20,12 @@ Instead, add the column without a default value, then change the default.
 
 class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
   def up
-    add_column %{table}, %{column}, %{type}%{options}
-    change_column_default %{table}, %{column}, %{default}
+    %{add_command}
+    %{change_command}
   end
 
   def down
-    remove_column %{table}, %{column}
+    %{remove_command}
   end
 end
 
@@ -107,8 +107,8 @@ class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
   disable_ddl_transaction!
 
   def change
-    %{command} %{table}, %{reference}, index: false%{options}
-    add_index %{table}, %{column}, algorithm: :concurrently
+    %{reference_command}
+    %{index_command}
   end
 end",
 
@@ -119,7 +119,7 @@ class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
   disable_ddl_transaction!
 
   def change
-    add_index %{table}, %{column}, algorithm: :concurrently%{options}
+    %{command}
   end
 end",
 

data/lib/strong_migrations/migration.rb

@@ -14,11 +14,8 @@ module StrongMigrations
     end
 
     def method_missing(method, *args, &block)
-      table = args[0].to_s
-
       unless @safe || ENV["SAFETY_ASSURED"] || is_a?(ActiveRecord::Schema) || @direction == :down || version_safe?
         ar5 = ActiveRecord::VERSION::MAJOR >= 5
-        model = table.classify
 
         case method
         when :remove_column, :remove_columns, :remove_timestamps, :remove_reference, :remove_belongs_to
@@ -41,20 +38,10 @@ module StrongMigrations
 
           code = ar5 ? "self.ignored_columns = #{columns.inspect}" : "def self.columns\n    super.reject { |c| #{columns.inspect}.include?(c.name) }\n  end"
 
-          command = String.new("#{method} #{sym_str(table)}")
-          case method
-          when :remove_column, :remove_reference, :remove_belongs_to
-            command << ", #{sym_str(args[1])}#{options_str(args[2] || {})}"
-          when :remove_columns
-            columns.each do |c|
-              command << ", #{sym_str(c)}"
-            end
-          end
-
           raise_error :remove_column,
-            model: model,
+            model: args[0].to_s.classify,
             code: code,
-            command: command,
+            command: command_str(method, args),
             column_suffix: columns.size > 1 ? "s" : ""
         when :change_table
           raise_error :change_table, header: "Possibly dangerous operation"
@@ -63,31 +50,26 @@ module StrongMigrations
         when :rename_column
           raise_error :rename_column
         when :add_index
-          columns = args[1]
-          options = args[2] || {}
+          table, columns, options = args
+          options ||= {}
+
           if columns.is_a?(Array) && columns.size > 3 && !options[:unique]
             raise_error :add_index_columns, header: "Best practice"
           end
-          if postgresql? && options[:algorithm] != :concurrently && !@new_tables.to_a.include?(table)
-            raise_error :add_index,
-              table: sym_str(table),
-              column: column_str(columns),
-              options: options_str(options.except(:algorithm))
+          if postgresql? && options[:algorithm] != :concurrently && !@new_tables.to_a.include?(table.to_s)
+            raise_error :add_index, command: command_str("add_index", [table, columns, options.merge(algorithm: :concurrently)])
           end
         when :add_column
-          column = args[1]
-          type = args[2]
-          options = args[3] || {}
+          table, column, type, options = args
+          options ||= {}
           default = options[:default]
 
           if !default.nil? && !(postgresql? && postgresql_version >= 110000)
             raise_error :add_column_default,
-              table: sym_str(table),
-              column: sym_str(column),
-              type: sym_str(type),
-              options: options_str(options.except(:default)),
-              default: default.inspect,
-              code: backfill_code(model, column, default)
+              add_command: command_str("add_column", [table, column, type, options.except(:default)]),
+              change_command: command_str("change_column_default", [table, column, default]),
+              remove_command: command_str("remove_column", [table, column]),
+              code: backfill_code(table, column, default)
           end
 
           if type.to_s == "json" && postgresql?
@@ -95,44 +77,47 @@ module StrongMigrations
               raise_error :add_column_json
             else
               raise_error :add_column_json_legacy,
-                model: model,
-                table: connection.quote_table_name(table)
+                model: table.to_s.classify,
+                table: connection.quote_table_name(table.to_s)
             end
           end
         when :change_column
+          table, column, type = args
+
           safe = false
           # assume Postgres 9.1+ since previous versions are EOL
-          if postgresql? && args[2].to_s == "text"
-            column = connection.columns(table).find { |c| c.name.to_s == args[1].to_s }
-            safe = column && column.type == :string
+          if postgresql? && type.to_s == "text"
+            found_column = connection.columns(table).find { |c| c.name.to_s == column.to_s }
+            safe = found_column && found_column.type == :string
           end
           raise_error :change_column unless safe
         when :create_table
-          options = args[1] || {}
+          table, options = args
+          options ||= {}
+
           raise_error :create_table if options[:force]
-          (@new_tables ||= []) << table
+
+          # keep track of new tables of add_index check
+          (@new_tables ||= []) << table.to_s
         when :add_reference, :add_belongs_to
-          options = args[2] || {}
+          table, reference, options = args
+          options ||= {}
+
           index_value = options.fetch(:index, ar5)
           if postgresql? && index_value
-            reference = args[1]
-            columns = []
-            columns << "#{reference}_type" if options[:polymorphic]
-            columns << "#{reference}_id"
+            columns = options[:polymorphic] ? [:"#{reference}_type", :"#{reference}_id"] : :"#{reference}_id"
+
             raise_error :add_reference,
-              command: method,
-              table: sym_str(table),
-              reference: sym_str(reference),
-              column: column_str(columns),
-              options: options_str(options.except(:index))
+              reference_command: command_str(method, [table, reference, options.merge(index: false)]),
+              index_command: command_str("add_index", [table, columns, {algorithm: :concurrently}])
           end
         when :execute
           raise_error :execute, header: "Possibly dangerous operation"
         when :change_column_null
-          _, column, null, default = args
+          table, column, null, default = args
           if !null && !default.nil?
             raise_error :change_column_null,
-              code: backfill_code(model, column, default)
+              code: backfill_code(table, column, default)
           end
         end
 
@@ -144,7 +129,7 @@ module StrongMigrations
       result = super
 
       if StrongMigrations.auto_analyze && @direction == :up && postgresql? && method == :add_index
-        connection.execute "ANALYZE VERBOSE #{connection.quote_table_name(table)}"
+        connection.execute "ANALYZE VERBOSE #{connection.quote_table_name(args[0].to_s)}"
       end
 
       result
@@ -176,25 +161,24 @@ module StrongMigrations
       stop!(message.gsub(/%(?!{)/, "%%") % vars, header: header || "Dangerous operation detected")
     end
 
-    def sym_str(v)
-      v.to_sym.inspect
-    end
-
-    def column_str(columns)
-      columns = Array(columns).map(&:to_sym)
-      columns = columns.first if columns.size == 1
-      columns.inspect
-    end
+    def command_str(command, args)
+      str_args = args[0..-2].map { |a| a.inspect }
 
-    def options_str(options)
-      str = String.new("")
-      options.each do |k, v|
-        str << ", #{k}: #{v.inspect}"
+      # prettier last arg
+      last_arg = args[-1]
+      if last_arg.is_a?(Hash)
+        if last_arg.any?
+          str_args << last_arg.map { |k, v| "#{k}: #{v.inspect}" }.join(", ")
+        end
+      else
+        str_args << last_arg.inspect
       end
-      str
+
+      "#{command} #{str_args.join(", ")}"
     end
 
-    def backfill_code(model, column, default)
+    def backfill_code(table, column, default)
+      model = table.to_s.classify
       if ActiveRecord::VERSION::MAJOR >= 5
         "#{model}.in_batches.update_all #{column}: #{default.inspect}"
       else

data/lib/strong_migrations/version.rb

@@ -1,3 +1,3 @@
 module StrongMigrations
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Andrew Kane
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2018-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord