declare_schema 0.6.4 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 523660550181d173c4ff4d6dc181b6d790419a3fdfb1e956076eed2d4c9f7f3b
-  data.tar.gz: '0380d2f800fd64c770c87631090ee792875034211b6ba9d18f5acc34e5ba9f0b'
+  metadata.gz: 640e3580d2babdce916a3127b95cd1c84eb8d87b89ca67116496cd3729eea33c
+  data.tar.gz: 30b86c95f516f37ce979ac558e64ac84f0150493392a0626495e83e68b5dc14d
 SHA512:
-  metadata.gz: 824d98b6bb3b30d0eebf594db7cead5e954fed227eefdb8f627811da3a7f8c9bc76f62552c3c3a87b0ff3adf51a95a1e666e903d6993430aaa3521607b6ee260
-  data.tar.gz: e8b45fb7dd6df1b314b3ada7e3da6223c631911ce88233165dff486ddb0bfc4a09e42255c018e7d00a456f95d0c1a8af010fe5531f6c2d64516cf3a09f51eb19
+  metadata.gz: 60e109345bc7d2551e441a7c5618f69b3e4df28551bc6c7807329f8831eb3090770fc70c2692487495935bd7c3394f83ccb77cfff1370afccb5a33105229f790
+  data.tar.gz: 5f4cf408c53d963995795786ea847f6e5e4c7319fe91fd95d8eb6d4c05348ddb6cf1fcbbded15764e9b80af0e0903ec26b984d82c467a3a0a6956e421f7d5ace

data/CHANGELOG.md

@@ -4,6 +4,11 @@ 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.7.0] - 2020-02-14
+### Changed
+- Use `schema_attributes` for generating both up and down change migrations, so they are guaranteed to be symmetrical.
+  Note: Rails schema dumper is still used for the down migration to replace a model that has been dropped.
+
 ## [0.6.4] - 2020-02-08
 - Fixed a bug where the generated call to add_foreign_key() was not setting `column:`,
   so it only worked in cases where Rails could infer the foreign key by convention.
@@ -114,6 +119,7 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.7.0]: https://github.com/Invoca/declare_schema/compare/v0.6.3...v0.7.0
 [0.6.4]: https://github.com/Invoca/declare_schema/compare/v0.6.3...v0.6.4
 [0.6.3]: https://github.com/Invoca/declare_schema/compare/v0.6.2...v0.6.3
 [0.6.2]: https://github.com/Invoca/declare_schema/compare/v0.6.1...v0.6.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.6.4)
+    declare_schema (0.7.0)
       rails (>= 4.2)
 
 GEM
@@ -54,7 +54,7 @@ GEM
       thor (>= 0.14.0)
     arel (9.0.0)
     ast (2.4.1)
-    bootsnap (1.5.1)
+    bootsnap (1.7.2)
       msgpack (~> 1.0)
     builder (3.2.4)
     byebug (11.1.3)
@@ -84,7 +84,7 @@ GEM
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.14.2)
-    msgpack (1.3.3)
+    msgpack (1.4.2)
     nio4r (2.5.4)
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
@@ -175,7 +175,7 @@ GEM
     websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    yard (0.9.25)
+    yard (0.9.26)
 
 PLATFORMS
   ruby

data/lib/declare_schema/model/column.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module DeclareSchema
+  class UnknownSqlTypeError < RuntimeError; end
+
+  module Model
+    # This class is a wrapper for the ActiveRecord::...::Column class
+    class Column
+      class << self
+        def native_type?(type)
+          type != :primary_key && native_types.has_key?(type)
+        end
+
+        # MySQL example:
+        # { primary_key: "bigint auto_increment PRIMARY KEY",
+        #   string: { name: "varchar", limit: 255 },
+        #   text: { name: "text", limit: 65535},
+        #   integer: {name: "int", limit: 4 },
+        #   float: {name: "float", limit: 24 },
+        #   decimal: { name: "decimal" },
+        #   datetime: { name: "datetime" },
+        #   timestamp: { name: "timestamp" },
+        #   time: { name: "time" },
+        #   date: { name: "date" },
+        #   binary: { name>: "blob", limit: 65535 },
+        #   boolean: { name: "tinyint", limit: 1 },
+        #   json: { name: "json" } }
+        #
+        # SQLite example:
+        # { primary_key: "integer PRIMARY KEY AUTOINCREMENT NOT NULL",
+        #  string: { name: "varchar" },
+        #  text: { name: "text"},
+        #  integer: { name: "integer" },
+        #  float: { name: "float" },
+        #  decimal: { name: "decimal" },
+        #  datetime: { name: "datetime" },
+        #  time: { name: "time" },
+        #  date: { name: "date" },
+        #  binary: { name: "blob" },
+        #  boolean: { name: "boolean" },
+        #  json: { name: "json" } }
+        def native_types
+          @native_types ||= ActiveRecord::Base.connection.native_database_types.tap do |types|
+            if ActiveRecord::Base.connection.class.name.match?(/mysql/i)
+              types[:text][:limit]    ||= 0xffff
+              types[:binary][:limit]  ||= 0xffff
+            end
+          end
+        end
+
+        def sql_type(type)
+          if native_type?(type)
+            type
+          else
+            if (field_class = DeclareSchema.to_class(type))
+              field_class::COLUMN_TYPE
+            end or raise UnknownSqlTypeError, "#{type.inspect} for type #{type.inspect}"
+          end
+        end
+
+        def deserialize_default_value(column, sql_type, default_value)
+          sql_type or raise ArgumentError, "must pass sql_type; got #{sql_type.inspect}"
+
+          case Rails::VERSION::MAJOR
+          when 4
+            # TODO: Delete this Rails 4 support ASAP! This could be wrong, since it's using the type of the old column...which
+            # might be getting migrated to a new type. We should be using just sql_type as below. -Colin
+            column.type_cast_from_database(default_value)
+          else
+            cast_type = ActiveRecord::Base.connection.send(:lookup_cast_type, sql_type) or
+              raise "cast_type not found for #{sql_type}"
+            cast_type.deserialize(default_value)
+          end
+        end
+
+        # Normalizes schema attributes for the specific database adapter that is currently running
+        # Note that the un-normalized attributes are still useful for generating migrations because those
+        # may be run with a different adapter.
+        # This method never mutates its argument. In fact it freezes it to be certain.
+        def normalize_schema_attributes(schema_attributes)
+          schema_attributes[:type] or raise ArgumentError, ":type key not found; keys: #{schema_attributes.keys.inspect}"
+          schema_attributes.freeze
+
+          case ActiveRecord::Base.connection.class.name
+          when /mysql/i
+            schema_attributes
+          when /sqlite/i
+            case schema_attributes[:type]
+            when :text
+              schema_attributes = schema_attributes.merge(limit: nil)
+            when :integer
+              schema_attributes = schema_attributes.dup
+              schema_attributes[:limit] ||= 8
+            end
+            schema_attributes
+          else
+            schema_attributes
+          end
+        end
+
+        def equivalent_schema_attributes?(schema_attributes_lhs, schema_attributes_rhs)
+          normalize_schema_attributes(schema_attributes_lhs) == normalize_schema_attributes(schema_attributes_rhs)
+        end
+      end
+
+      def initialize(model, current_table_name, column)
+        @model = model or raise ArgumentError, "must pass model"
+        @current_table_name = current_table_name or raise ArgumentError, "must pass current_table_name"
+        @column = column or raise ArgumentError, "must pass column"
+      end
+
+      def sql_type
+        @sql_type ||= self.class.sql_type(@column.type)
+      end
+
+      SCHEMA_KEYS = [:type, :limit, :precision, :scale, :null, :default].freeze
+
+      # omits keys with nil values
+      def schema_attributes
+        SCHEMA_KEYS.each_with_object({}) do |key, result|
+          value =
+            case key
+            when :default
+              self.class.deserialize_default_value(@column, sql_type, @column.default)
+            else
+              col_value = @column.send(key)
+              if col_value.nil? && (native_type = self.class.native_types[@column.type])
+                native_type[key]
+              else
+                col_value
+              end
+            end
+
+          result[key] = value unless value.nil?
+        end.tap do |result|
+          if ActiveRecord::Base.connection.class.name.match?(/mysql/i) && @column.type.in?([:string, :text])
+            result.merge!(collation_and_charset_for_column(@current_table_name, @column.name))
+          end
+        end
+      end
+
+      private
+
+      def collation_and_charset_for_column(current_table_name, column_name)
+        connection    = ActiveRecord::Base.connection
+        connection.class.name.match?(/mysql/i) or raise ArgumentError, "only supported for MySQL"
+
+        database_name = connection.current_database
+
+        defaults = connection.select_one(<<~EOS)
+          SELECT C.character_set_name, C.collation_name
+          FROM information_schema.`COLUMNS` C
+          WHERE C.table_schema = '#{connection.quote_string(database_name)}' AND
+                C.table_name = '#{connection.quote_string(current_table_name)}' AND
+                C.column_name = '#{connection.quote_string(column_name)}';
+        EOS
+
+        defaults && defaults["character_set_name"] or raise "character_set_name missing from #{defaults.inspect} from #{database_name}.#{current_table_name}.#{column_name}"
+        defaults && defaults["collation_name"]     or raise "collation_name missing from #{defaults.inspect}"
+
+        {
+          charset:   defaults["character_set_name"],
+          collation: defaults["collation_name"]
+        }
+      end
+    end
+  end
+end

data/lib/declare_schema/model/field_spec.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require_relative 'column'
+
 module DeclareSchema
+  class MysqlTextMayNotHaveDefault < RuntimeError; end
+
   module Model
     class FieldSpec
-      class UnknownSqlTypeError < RuntimeError; end
 
       MYSQL_TINYTEXT_LIMIT    = 0xff
       MYSQL_TEXT_LIMIT        = 0xffff
@@ -30,7 +33,18 @@ module DeclareSchema
         end
       end
 
-      attr_reader :model, :name, :type, :position, :options
+      attr_reader :model, :name, :type, :sql_type, :position, :options, :sql_options
+
+      TYPE_SYNONYMS = { timestamp: :datetime }.freeze # TODO: drop this synonym. -Colin
+
+      SQL_OPTIONS     = [:limit, :precision, :scale, :null, :default, :charset, :collation].freeze
+      NON_SQL_OPTIONS = [:ruby_default, :validates].freeze
+      VALID_OPTIONS   = (SQL_OPTIONS + NON_SQL_OPTIONS).freeze
+      OPTION_INDEXES  = Hash[VALID_OPTIONS.each_with_index.to_a].freeze
+
+      VALID_OPTIONS.each do |option|
+        define_method(option) { @options[option] }
+      end
 
       def initialize(model, name, type, position: 0, **options)
         # TODO: TECH-5116
@@ -42,170 +56,72 @@ module DeclareSchema
         @model = model
         @name = name.to_sym
         type.is_a?(Symbol) or raise ArgumentError, "type must be a Symbol; got #{type.inspect}"
-        @type = type
+        @type = TYPE_SYNONYMS[type] || type
         @position = position
-        @options = options
+        @options = options.dup
+
+        @options.has_key?(:null) or @options[:null] = false
+
         case type
         when :text
-          @options[:default] and raise "default may not be given for :text field #{model}##{@name}"
           if self.class.mysql_text_limits?
+            @options[:default].nil? or raise MysqlTextMayNotHaveDefault, "when using MySQL, non-nil default may not be given for :text field #{model}##{@name}"
             @options[:limit] = self.class.round_up_mysql_text_limit(@options[:limit] || MYSQL_LONGTEXT_LIMIT)
+          else
+            @options[:limit] = nil
           end
         when :string
-          @options[:limit] or raise "limit must be given for :string field #{model}##{@name}: #{@options.inspect}; do you want `limit: 255`?"
+          @options[:limit] or raise "limit: must be given for :string field #{model}##{@name}: #{@options.inspect}; do you want `limit: 255`?"
         when :bigint
           @type = :integer
-          @options = options.merge(limit: 8)
+          @options[:limit] = 8
         end
 
-        if type.in?([:text, :string])
-          if ActiveRecord::Base.connection.class.name.match?(/mysql/i)
-            @options[:charset]   ||= model.table_options[:charset]   || Generators::DeclareSchema::Migration::Migrator.default_charset
-            @options[:collation] ||= model.table_options[:collation] || Generators::DeclareSchema::Migration::Migrator.default_collation
-          end
+        # TODO: Do we really need to support a :sql_type option? Ideally, drop it. -Colin
+        @sql_type = @options.delete(:sql_type) || Column.sql_type(@type)
+
+        if @sql_type.in?([:string, :text, :binary, :varbinary, :integer, :enum])
+          @options[:limit] ||= Column.native_types[@sql_type][:limit]
         else
-          @options[:charset]   and raise "charset may only given for :string and :text fields"
-          @options[:collation] and raise "collation may only given for :string and :text fields"
+          @sql_type != :decimal && @options.has_key?(:limit) and warn("unsupported limit: for SQL type #{@sql_type} in field #{model}##{@name}")
+          @options.delete(:limit)
         end
-      end
 
-      TYPE_SYNONYMS = { timestamp: :datetime }.freeze
-
-      SQLITE_COLUMN_CLASS =
-        begin
-          ActiveRecord::ConnectionAdapters::SQLiteColumn
-        rescue NameError
-          NilClass
+        if @sql_type == :decimal
+          @options[:precision] or warn("precision: required for :decimal type in field #{model}##{@name}")
+          @options[:scale] or warn("scale: required for :decimal type in field #{model}##{@name}")
+        else
+          if @sql_type != :datetime
+            @options.has_key?(:precision) and warn("precision: only allowed for :decimal type or :datetime for SQL type #{@sql_type} in field #{model}##{@name}")
+          end
+          @options.has_key?(:scale) and warn("scale: only allowed for :decimal type for SQL type #{@sql_type} in field #{model}##{@name}")
         end
 
-      def sql_type
-        @options[:sql_type] || begin
-                                if native_type?(type)
-                                  type
-                                else
-                                  field_class = DeclareSchema.to_class(type)
-                                  field_class && field_class::COLUMN_TYPE or raise UnknownSqlTypeError, "#{type.inspect} for #{model}##{@name}"
-                                end
-                              end
-      end
-
-      def sql_options
-        @options.except(:ruby_default, :validates)
-      end
-
-      def limit
-        @options[:limit] || native_types[sql_type][:limit]
-      end
-
-      def precision
-        @options[:precision]
-      end
-
-      def scale
-        @options[:scale]
-      end
-
-      def null
-        !:null.in?(@options) || @options[:null]
-      end
-
-      def default
-        @options[:default]
-      end
-
-      def charset
-        @options[:charset]
-      end
-
-      def collation
-        @options[:collation]
-      end
-
-      def same_type?(col_spec)
-        type = sql_type
-        normalized_type           = TYPE_SYNONYMS[type] || type
-        normalized_col_spec_type  = TYPE_SYNONYMS[col_spec.type] || col_spec.type
-        normalized_type == normalized_col_spec_type
-      end
-
-      def different_to?(table_name, col_spec)
-        !same_as(table_name, col_spec)
-      end
-
-      def same_as(table_name, col_spec)
-        same_type?(col_spec) &&
-          same_attributes?(col_spec) &&
-          (!type.in?([:text, :string]) || same_charset_and_collation?(table_name, col_spec))
-      end
-
-      private
-
-      def same_attributes?(col_spec)
-        native_type = native_types[type]
-        check_attributes = [:null, :default]
-        check_attributes += [:precision, :scale] if sql_type == :decimal && !col_spec.is_a?(SQLITE_COLUMN_CLASS)  # remove when rails fixes https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/2872
-        check_attributes -= [:default] if sql_type == :text && col_spec.class.name =~ /mysql/i
-        check_attributes << :limit if sql_type.in?([:string, :binary, :varbinary, :integer, :enum]) ||
-                                      (sql_type == :text && self.class.mysql_text_limits?)
-        check_attributes.all? do |k|
-          if k == :default
-            case Rails::VERSION::MAJOR
-            when 4
-              col_spec.type_cast_from_database(col_spec.default) == col_spec.type_cast_from_database(default)
-            else
-              cast_type = ActiveRecord::Base.connection.lookup_cast_type_from_column(col_spec) or raise "cast_type not found for #{col_spec.inspect}"
-              cast_type.deserialize(col_spec.default) == cast_type.deserialize(default)
-            end
+        if @type.in?([:text, :string])
+          if ActiveRecord::Base.connection.class.name.match?(/mysql/i)
+            @options[:charset]   ||= model.table_options[:charset]   || Generators::DeclareSchema::Migration::Migrator.default_charset
+            @options[:collation] ||= model.table_options[:collation] || Generators::DeclareSchema::Migration::Migrator.default_collation
           else
-            col_value = col_spec.send(k)
-            if col_value.nil? && native_type
-              col_value = native_type[k]
-            end
-            col_value == send(k)
+            @options.delete(:charset)
+            @options.delete(:collation)
           end
-        end
-      end
-
-      def same_charset_and_collation?(table_name, col_spec)
-        current_collation_and_charset = collation_and_charset_for_column(table_name, col_spec)
-
-        collation == current_collation_and_charset[:collation] &&
-          charset == current_collation_and_charset[:charset]
-      end
-
-      def collation_and_charset_for_column(table_name, col_spec)
-        column_name   = col_spec.name
-        connection    = ActiveRecord::Base.connection
-
-        if connection.class.name.match?(/mysql/i)
-          database_name = connection.current_database
-
-          defaults = connection.select_one(<<~EOS)
-            SELECT C.character_set_name, C.collation_name
-            FROM information_schema.`COLUMNS` C
-            WHERE C.table_schema = '#{connection.quote_string(database_name)}' AND
-                  C.table_name = '#{connection.quote_string(table_name)}' AND
-                  C.column_name = '#{connection.quote_string(column_name)}';
-          EOS
-
-          defaults["character_set_name"] or raise "character_set_name missing from #{defaults.inspect}"
-          defaults["collation_name"]     or raise "collation_name missing from #{defaults.inspect}"
-
-          {
-            charset:   defaults["character_set_name"],
-            collation: defaults["collation_name"]
-          }
         else
-          {}
+          @options[:charset]   and warn("charset may only given for :string and :text fields for SQL type #{@sql_type} in field #{model}##{@name}")
+          @options[:collation] and warne("collation may only given for :string and :text fields for SQL type #{@sql_type} in field #{model}##{@name}")
         end
-      end
 
-      def native_type?(type)
-        type.to_sym != :primary_key && native_types.has_key?(type)
+        @options = Hash[@options.sort_by { |k, _v| OPTION_INDEXES[k] || 9999 }]
+
+        @sql_options = @options.except(*NON_SQL_OPTIONS)
       end
 
-      def native_types
-        Generators::DeclareSchema::Migration::Migrator.native_types
+      # returns the attributes for schema migrations as a Hash
+      # omits name and position since those are meta-data above the schema
+      # omits keys with nil values
+      def schema_attributes(col_spec)
+        @options.merge(type: @type).tap do |attrs|
+          attrs[:default] = Column.deserialize_default_value(col_spec, @sql_type, attrs[:default])
+        end.compact
       end
     end
   end