declare_schema 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e993cfd0cf72aa7610f32743ce838d6c7e6ec07370cd3427649ab80cce7e9ac2
-  data.tar.gz: 273de3135fa09049b57a598342a36c283dc956498016dbc98297910233b1b5bb
+  metadata.gz: 4a529991bad5ab16728f11b3f6c165b62853c3b68713e0ec69d6370d7d3c0e5b
+  data.tar.gz: 6a131f8af82b018b843f639e501371cf0db9a65b91a4acb99aea44d3eb1674d9
 SHA512:
-  metadata.gz: 1f28b92b3614dc61323b386eeb67c681873c983acd66869b705e6c920c906c9429f26030135e916726fa0b068c6b68e5cce57902f64c230c0a5cf289fdec9645
-  data.tar.gz: 2d23d69ffedf63881a3d33bbde3f2bcc62ed9e12938e981bb7388400a3f4dec28aa3ade8714a3c352c93b743496e70777f6a54e710d91d7e6adb2ca66fc23954
+  metadata.gz: 655ab291337bf8f11fb249de1b97608e7ff73b14ff543f9248e3f92d9bf1770553b8bc2f962c72e8763d27ae559c35bdff1f12f4b6b460a1d46abfab00e931c0
+  data.tar.gz: b67d3340bb42b91bddd0940e0a9e5a895bd57f2017ef8d4712e1e4331ba46e78b17d9f7e9b0e60de9f921232897c0edeffe37621060632ecb18267db1ce15dc0

data/CHANGELOG.md

@@ -4,9 +4,15 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.10.1] - 2021-03-18
+### Fixed
+- Migration steps are now generated in a defined dependency order, so that--for example--indexes that depend
+ on columns are deleted first, before the columns themselves are deleted (since the latter implicitly does the former, which would break the migration when run).
+- Related to the above, down migration steps are now always generated in exactly the reverse order of the up migration steps.
+
 ## [0.10.0] - 2021-03-17
 ### Deprecated
-- The `fields` dsl method is being deprecated.
+- Deprecated the `fields` DSL method in favor of `declare_schema`.
 
 ### Added
 - Added the `declare_schema` method to replace `fields`. We now expect a column's type to come before the name
@@ -148,6 +154,7 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.10.1]: https://github.com/Invoca/declare_schema/compare/v0.10.0...v0.10.1
 [0.10.0]: https://github.com/Invoca/declare_schema/compare/v0.9.0...v0.10.0
 [0.9.0]: https://github.com/Invoca/declare_schema/compare/v0.8.0...v0.9.0
 [0.8.0]: https://github.com/Invoca/declare_schema/compare/v0.7.1...v0.8.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.10.0)
+    declare_schema (0.10.1)
       rails (>= 4.2)
 
 GEM

data/lib/declare_schema/model/foreign_key_definition.rb

@@ -7,14 +7,15 @@ module DeclareSchema
     class ForeignKeyDefinition
       include Comparable
 
-      attr_reader :constraint_name, :model, :foreign_key, :foreign_key_name, :options, :on_delete_cascade
+      attr_reader :constraint_name, :model, :foreign_key, :foreign_key_name, :parent_table_name, :child_table_name, :options, :on_delete_cascade
+
 
       def initialize(model, foreign_key, options = {})
         @model = model
         @foreign_key = foreign_key.to_s.presence
         @options = options
 
-        @child_table = model.table_name # unless a table rename, which would happen when a class is renamed??
+        @child_table_name = model.table_name # unless a table rename, which would happen when a class is renamed??
         @parent_table_name = options[:parent_table]&.to_s
         @foreign_key_name = options[:foreign_key]&.to_s || @foreign_key
 
@@ -61,11 +62,6 @@ module DeclareSchema
             foreign_key.sub(/_id\z/, '').camelize.constantize.table_name
       end
 
-      def to_add_statement
-        "add_foreign_key(#{@child_table.inspect}, #{parent_table_name.inspect}, " +
-          "column: #{@foreign_key_name.inspect}, name: #{@constraint_name.inspect})"
-      end
-
       def <=>(rhs)
         key <=> rhs.send(:key)
       end
@@ -75,7 +71,7 @@ module DeclareSchema
       private
 
       def key
-        @key ||= [@child_table, parent_table_name, @foreign_key_name, @on_delete_cascade].map(&:to_s)
+        @key ||= [@child_table_name, parent_table_name, @foreign_key_name, @on_delete_cascade].map(&:to_s)
       end
 
       def hash

data/lib/declare_schema/model/index_definition.rb

@@ -93,25 +93,6 @@ module DeclareSchema
         name == PRIMARY_KEY_NAME
       end
 
-      def to_add_statement(new_table_name, existing_primary_key = nil)
-        if primary_key? && !ActiveRecord::Base.connection.class.name.match?(/SQLite3Adapter/)
-          to_add_primary_key_statement(new_table_name, existing_primary_key)
-        else
-          # Note: + below keeps that interpolated string from being frozen, so we can << into it.
-          r = +"add_index #{new_table_name.to_sym.inspect}, #{fields.map(&:to_sym).inspect}"
-          r << ", unique: true"      if unique
-          r << ", where: '#{where}'" if where.present?
-          r << ", name: '#{name}'"
-          r
-        end
-      end
-
-      def to_add_primary_key_statement(new_table_name, existing_primary_key)
-        drop = "DROP PRIMARY KEY, " if existing_primary_key
-        statement = "ALTER TABLE #{new_table_name} #{drop}ADD PRIMARY KEY (#{fields.join(', ')})"
-        "execute #{statement.inspect}"
-      end
-
       def to_key
         @key ||= [table, fields, name, unique, where].map(&:to_s)
       end

data/lib/declare_schema/schema_change/all.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DeclareSchema
+  module SchemaChange
+    module All
+    end
+    autoload :Base, 'declare_schema/schema_change/base'
+    autoload :ColumnAdd, 'declare_schema/schema_change/column_add'
+    autoload :ColumnChange, 'declare_schema/schema_change/column_change'
+    autoload :ColumnRename, 'declare_schema/schema_change/column_rename'
+    autoload :ForeignKeyAdd, 'declare_schema/schema_change/foreign_key_add'
+    autoload :ForeignKeyRemove, 'declare_schema/schema_change/foreign_key_remove'
+    autoload :IndexAdd, 'declare_schema/schema_change/index_add'
+    autoload :IndexRemove, 'declare_schema/schema_change/index_remove'
+    autoload :PrimaryKeyChange, 'declare_schema/schema_change/primary_key_change'
+    autoload :TableAdd, 'declare_schema/schema_change/table_add'
+    autoload :TableChange, 'declare_schema/schema_change/table_change'
+    autoload :TableRemove, 'declare_schema/schema_change/table_remove'
+    autoload :TableRename, 'declare_schema/schema_change/table_rename'
+  end
+end
+

data/lib/declare_schema/schema_change/base.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class Base
+      class << self
+        def format_options(options)
+          options.map do |k, v|
+            value =
+              if v.is_a?(Hash)
+                "{ #{format_options(v).join(', ')} }"
+              else
+                v.inspect
+              end
+            if k.is_a?(Symbol)
+              "#{k}: #{value}"
+            else
+              "#{k.inspect} => #{value}"
+            end
+          end
+        end
+      end
+
+      def up
+        up_command + spacing(up_command)
+      end
+
+      def down
+        down_command + spacing(down_command)
+      end
+
+      private
+
+      def spacing(command)
+        if command["\n"]
+          "\n\n"
+        else
+          "\n"
+        end
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/column_add.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class ColumnAdd < Base
+      def initialize(table_name, column_name, column_type, **column_options)
+        @table_name = table_name
+        @column_name = column_name
+        @column_type = column_type
+        @column_options = column_options
+      end
+
+      def up_command
+        "add_column #{[@table_name.to_sym.inspect,
+                       @column_name.to_sym.inspect,
+                       @column_type.to_sym.inspect,
+                       *self.class.format_options(@column_options)].join(", ")}"
+      end
+
+      def down_command
+        "remove_column #{@table_name.to_sym.inspect}, #{@column_name.to_sym.inspect}"
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/column_change.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class ColumnChange < Base
+      def initialize(table_name, column_name, old_type:, old_options:, new_type:, new_options:)
+        @table_name = table_name
+        @column_name = column_name
+        @old_type = old_type
+        @old_options = old_options
+        @new_type = new_type
+        @new_options = new_options
+      end
+
+      def up_command
+        "change_column #{[@table_name.to_sym.inspect,
+                          @column_name.to_sym.inspect,
+                          @new_type.to_sym.inspect,
+                          *self.class.format_options(@new_options)].join(", ")}"
+      end
+
+      def down_command
+        "change_column #{[@table_name.to_sym.inspect,
+                          @column_name.to_sym.inspect,
+                          @old_type.to_sym.inspect,
+                          *self.class.format_options(@old_options)].join(", ")}"
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/column_remove.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'column_add'
+
+module DeclareSchema
+  module SchemaChange
+    class ColumnRemove < ColumnAdd
+      alias column_add_up_command up_command
+      alias column_add_down_command down_command
+
+      def up_command
+        column_add_down_command
+      end
+
+      def down_command
+        column_add_up_command
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/column_rename.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class ColumnRename < Base
+      def initialize(table_name, old_name, new_name)
+        @table_name = table_name
+        @old_name = old_name
+        @new_name = new_name
+      end
+
+      def up_command
+        "rename_column #{@table_name.to_sym.inspect}, #{@old_name.to_sym.inspect}, #{@new_name.to_sym.inspect}"
+      end
+
+      def down_command
+        "rename_column #{@table_name.to_sym.inspect}, #{@new_name.to_sym.inspect}, #{@old_name.to_sym.inspect}"
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/foreign_key_add.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class ForeignKeyAdd < Base
+      def initialize(table_name, parent_table_name, column_name:, name:)
+        @table_name = table_name
+        @parent_table_name = parent_table_name
+        @column_name = column_name
+        @name = name
+      end
+
+      def up_command
+        "add_foreign_key #{@table_name.to_sym.inspect}, #{@parent_table_name.to_sym.inspect}, " +
+          "column: #{@column_name.to_sym.inspect}, name: #{@name.to_sym.inspect}"
+      end
+
+      def down_command
+        "remove_foreign_key #{@table_name.to_sym.inspect}, name: #{@name.to_sym.inspect}"
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/foreign_key_remove.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'foreign_key_add'
+
+module DeclareSchema
+  module SchemaChange
+    class ForeignKeyRemove < ForeignKeyAdd
+      alias index_add_up_command up_command
+      alias index_add_down_command down_command
+
+      def up_command
+        index_add_down_command
+      end
+
+      def down_command
+        index_add_up_command
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/index_add.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class IndexAdd < Base
+      def initialize(table_name, column_names, name:, unique:, where: nil)
+        @table_name = table_name
+        @column_names = column_names
+        @name = name
+        @unique = unique
+        @where = where.presence
+      end
+
+      def up_command
+        options = {
+          name: @name.to_sym,
+        }
+        options[:unique] = true if @unique
+        options[:where] = @where if @where
+
+        "add_index #{[@table_name.to_sym.inspect,
+                      @column_names.map(&:to_sym).inspect,
+                      *self.class.format_options(options)].join(', ')}"
+      end
+
+      def down_command
+        "remove_index #{@table_name.to_sym.inspect}, name: #{@name.to_sym.inspect}"
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/index_remove.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'index_add'
+
+module DeclareSchema
+  module SchemaChange
+    class IndexRemove < IndexAdd
+      alias index_add_up_command up_command
+      alias index_add_down_command down_command
+
+      def up_command
+        index_add_down_command
+      end
+
+      def down_command
+        index_add_up_command
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/primary_key_change.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class PrimaryKeyChange < Base
+      def initialize(table_name, old_column_names, new_column_names)
+        @table_name = table_name
+        @old_column_names = old_column_names.presence
+        @new_column_names = new_column_names.presence
+      end
+
+      def up_command
+        alter_primary_key(@old_column_names, @new_column_names)
+      end
+
+      def down_command
+        alter_primary_key(@new_column_names, @old_column_names)
+      end
+
+      private
+
+      def alter_primary_key(old_col_names, new_col_names)
+        drop_command = "DROP PRIMARY KEY" if old_col_names
+        add_command = "ADD PRIMARY KEY (#{new_col_names.join(', ')})" if new_col_names
+        commands = [drop_command, add_command].compact.join(', ')
+        statement = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(@table_name)} #{commands}"
+        "execute #{statement.inspect}"
+      end
+    end
+  end
+end

data/lib/declare_schema/schema_change/table_add.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module DeclareSchema
+  module SchemaChange
+    class TableAdd < Base
+      def initialize(table_name, fields, create_table_options, sql_options: nil)
+        @table_name = table_name
+        fields.all? do |type, name, options|
+          type.is_a?(Symbol) && name.is_a?(Symbol) && options.is_a?(Hash)
+        end or raise ArgumentError, "fields must be Array(Array(Symbol, Symbol, Hash)); got #{fields.inspect}"
+        @fields = fields
+        @create_table_options = create_table_options
+        @create_table_options = @create_table_options.merge(options: sql_options) if sql_options.present?
+      end
+
+      def up_command
+        longest_field_type_length = @fields.map { |type, _name, _option| type.to_s.length }.max
+
+        <<~EOS.strip
+          create_table #{[@table_name.to_sym.inspect, *self.class.format_options(@create_table_options)].join(', ')} do |t|
+          #{@fields.map do |type, name, options|
+              padded_type = format("%-*s", longest_field_type_length, type)
+              args = [name.inspect, *self.class.format_options(options)].join(', ')
+              "  t.#{padded_type} #{args}"
+            end.join("\n")}
+          end
+        EOS
+      end
+
+      def down_command
+        "drop_table #{@table_name.to_sym.inspect}"
+      end
+    end
+  end
+end