declare_schema 0.6.1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0108465514c80103fc934c550e911b563d4f3ebe8a1ebfb3a95c7fa10ed3ee8
-  data.tar.gz: 60b586c698f62017311bef429896f79312314a61e918a1d6fb60dca60e4f6d15
+  metadata.gz: 6317ef2d7c038120278bbff6547c042a3418369d1e0bd8527f10ab57d58aef62
+  data.tar.gz: 66ce3ad03f6fde8365b287deb682d85b4fd7e983d283447af769aed0ade61571
 SHA512:
-  metadata.gz: 2167096015bc12def6ed7f5ab3c45b1de223e79c9b3828d6a322c9a849d08534ac0551033058de9c6059733e344e7f9ab97ff152a11a67227e2490bc1726f022
-  data.tar.gz: 173f38d4d7f7aa50904422624ddcec7a65f6f2b5e534b3eab5dd6894056d6166859a332d8ad9f021d5cc14306a6c0503c6a0308491bd5cede23c01934bd7c488
+  metadata.gz: 1a87ecf0479b94324f43c42d309f254e8a3ca10f3766cc90a756b94505cb559406871eee47a58fa376640ad85acda3e81d771cb03ab92dc08f5253d81bd88079
+  data.tar.gz: 4cd449cb9543819dd78e51267357f676a7439c89f2ad021f59a5d0f49664a8c8b8141eeebde4184e3eaf1f3f616dfef8a7092f59cc6382c73504de5ffeb41dc3

data/CHANGELOG.md

@@ -4,6 +4,39 @@ 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.1] - 2021-02-17
+### Fixed
+- Exclude unknown options from FieldSpec#sql_options and #schema_attributes.
+- Fixed a bug where fk_field_options were getting merged into spec_attrs after checking for equivalence,
+  leading to phantom migrations with no changes, or missing migrations when just the fk_field_options changed.
+
+## [0.7.0] - 2021-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] - 2021-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.
+
+## [0.6.3] - 2021-01-21
+### Added
+- Added `add_foreign_key` native rails call in `DeclareSchema::Model::ForeignKeyDefinition#to_add_statement`.
+
+### Fixed
+- Fixed a bug in migration generation caused by `DeclareSchema::Migration#create_constraints`
+  calling `DeclareSchema::Model::ForeignKeyDefinition#to_add_statement` with unused parameters.
+ 
+- Fixed a bug in `DeclareSchema::Migration#remove_foreign_key` where special characters would not be quoted properly.
+
+## [0.6.2] - 2021-01-06
+### Added
+- Added `sqlite3` as dev dependency for local development
+
+### Fixed
+- Fixed a bug in migration generation caused by `DeclareSchema::Model::ForeignKeyDefinition#to_add_statement`
+  not being passed proper arguments.
+
 ## [0.6.1] - 2021-01-06
 ### Added
 - Added Appraisals for MySQL as well as SQLite.
@@ -92,6 +125,11 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.7.1]: https://github.com/Invoca/declare_schema/compare/v0.7.0...v0.7.1
+[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
 [0.6.1]: https://github.com/Invoca/declare_schema/compare/v0.6.0...v0.6.1
 [0.6.0]: https://github.com/Invoca/declare_schema/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/Invoca/declare_schema/compare/v0.4.2...v0.5.0

data/Gemfile

@@ -19,3 +19,4 @@ gem 'responders'
 gem 'rspec'
 gem 'rubocop'
 gem 'yard'
+gem 'sqlite3',           '~> 1.4'

data/Gemfile.lock

@@ -1,49 +1,49 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.6.1)
+    declare_schema (0.7.1)
       rails (>= 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.4.4)
-      actionpack (= 5.2.4.4)
+    actioncable (5.2.4.5)
+      actionpack (= 5.2.4.5)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.4.4)
-      actionpack (= 5.2.4.4)
-      actionview (= 5.2.4.4)
-      activejob (= 5.2.4.4)
+    actionmailer (5.2.4.5)
+      actionpack (= 5.2.4.5)
+      actionview (= 5.2.4.5)
+      activejob (= 5.2.4.5)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.4.4)
-      actionview (= 5.2.4.4)
-      activesupport (= 5.2.4.4)
+    actionpack (5.2.4.5)
+      actionview (= 5.2.4.5)
+      activesupport (= 5.2.4.5)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.4.4)
-      activesupport (= 5.2.4.4)
+    actionview (5.2.4.5)
+      activesupport (= 5.2.4.5)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.4.4)
-      activesupport (= 5.2.4.4)
+    activejob (5.2.4.5)
+      activesupport (= 5.2.4.5)
       globalid (>= 0.3.6)
-    activemodel (5.2.4.4)
-      activesupport (= 5.2.4.4)
-    activerecord (5.2.4.4)
-      activemodel (= 5.2.4.4)
-      activesupport (= 5.2.4.4)
+    activemodel (5.2.4.5)
+      activesupport (= 5.2.4.5)
+    activerecord (5.2.4.5)
+      activemodel (= 5.2.4.5)
+      activesupport (= 5.2.4.5)
       arel (>= 9.0)
-    activestorage (5.2.4.4)
-      actionpack (= 5.2.4.4)
-      activerecord (= 5.2.4.4)
+    activestorage (5.2.4.5)
+      actionpack (= 5.2.4.5)
+      activerecord (= 5.2.4.5)
       marcel (~> 0.3.1)
-    activesupport (5.2.4.4)
+    activesupport (5.2.4.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -54,25 +54,25 @@ 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)
     climate_control (0.2.0)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     crass (1.0.6)
     diff-lcs (1.4.4)
-    erubi (1.9.0)
-    ffi (1.13.1)
+    erubi (1.10.0)
+    ffi (1.14.2)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.8.5)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
-    listen (3.3.1)
+    listen (3.4.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    loofah (2.7.0)
+    loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -82,12 +82,13 @@ GEM
     method_source (1.0.0)
     mimemagic (0.3.5)
     mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.2)
-    msgpack (1.3.3)
-    nio4r (2.5.4)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    mini_portile2 (2.5.0)
+    minitest (5.14.3)
+    msgpack (1.4.2)
+    nio4r (2.5.5)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
@@ -97,35 +98,36 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.4.4)
-      actioncable (= 5.2.4.4)
-      actionmailer (= 5.2.4.4)
-      actionpack (= 5.2.4.4)
-      actionview (= 5.2.4.4)
-      activejob (= 5.2.4.4)
-      activemodel (= 5.2.4.4)
-      activerecord (= 5.2.4.4)
-      activestorage (= 5.2.4.4)
-      activesupport (= 5.2.4.4)
+    rails (5.2.4.5)
+      actioncable (= 5.2.4.5)
+      actionmailer (= 5.2.4.5)
+      actionpack (= 5.2.4.5)
+      actionview (= 5.2.4.5)
+      activejob (= 5.2.4.5)
+      activemodel (= 5.2.4.5)
+      activerecord (= 5.2.4.5)
+      activestorage (= 5.2.4.5)
+      activesupport (= 5.2.4.5)
       bundler (>= 1.3.0)
-      railties (= 5.2.4.4)
+      railties (= 5.2.4.5)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (5.2.4.4)
-      actionpack (= 5.2.4.4)
-      activesupport (= 5.2.4.4)
+    railties (5.2.4.5)
+      actionpack (= 5.2.4.5)
+      activesupport (= 5.2.4.5)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
-    rake (13.0.1)
+    rake (13.0.3)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -166,15 +168,16 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (1.0.1)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
     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
@@ -192,6 +195,7 @@ DEPENDENCIES
   responders
   rspec
   rubocop
+  sqlite3 (~> 1.4)
   yard
 
 BUNDLED WITH

data/lib/declare_schema/field_declaration_dsl.rb

@@ -28,13 +28,12 @@ module DeclareSchema
       field(:lock_version, :integer, default: 1, null: false)
     end
 
-    def field(name, type, *args)
-      options = args.extract_options!
-      @model.declare_field(name, type, *(args + [@options.merge(options)]))
+    def field(name, type, *args, **options)
+      @model.declare_field(name, type, *[*args, @options.merge(options)])
     end
 
     def method_missing(name, *args)
-      field(name, args.first, *args[1..-1])
+      field(name, *args)
     end
   end
 end

data/lib/declare_schema/model.rb

@@ -81,8 +81,7 @@ module DeclareSchema
       # arguments. The arguments are forwarded to the #field_added
       # callback, allowing custom metadata to be added to field
       # declarations.
-      def declare_field(name, type, *args)
-        options = args.extract_options!
+      def declare_field(name, type, *args, **options)
         try(:field_added, name, type, args, options)
         add_serialize_for_field(name, type, options)
         add_formatting_for_field(name, type)

data/lib/declare_schema/model/column.rb

@@ -0,0 +1,167 @@
+# 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 given database adapter name.
+        # 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.
+        def normalize_schema_attributes(schema_attributes, db_adapter_name)
+          case schema_attributes[:type]
+          when :boolean
+            schema_attributes.reverse_merge(limit: 1)
+          when :integer
+            schema_attributes.reverse_merge(limit: 8) if db_adapter_name.match?(/sqlite/i)
+          when :float
+            schema_attributes.except(:limit)
+          when :text
+            schema_attributes.except(:limit)          if db_adapter_name.match?(/sqlite/i)
+          when :datetime
+            schema_attributes.reverse_merge(precision: 0)
+          when NilClass
+            raise ArgumentError, ":type key not found; keys: #{schema_attributes.keys.inspect}"
+          end || schema_attributes
+        end
+
+        def equivalent_schema_attributes?(schema_attributes_lhs, schema_attributes_rhs)
+          db_adapter_name = ActiveRecord::Base.connection.class.name
+          normalized_lhs = normalize_schema_attributes(schema_attributes_lhs, db_adapter_name)
+          normalized_rhs = normalize_schema_attributes(schema_attributes_rhs, db_adapter_name)
+
+          normalized_lhs == normalized_rhs
+        end
+      end
+
+      attr_reader :sql_type
+
+      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"
+        @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