declare_schema 0.7.1 → 0.8.0.pre.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6317ef2d7c038120278bbff6547c042a3418369d1e0bd8527f10ab57d58aef62
-  data.tar.gz: 66ce3ad03f6fde8365b287deb682d85b4fd7e983d283447af769aed0ade61571
+  metadata.gz: c8a020c30e79336f89851e73eaabbb8dcdfd2affed27883e7d4fe06944f76436
+  data.tar.gz: e17f1fe94f3dc8188469df87679ee09c955765f2a5ac45354928e6664c026bae
 SHA512:
-  metadata.gz: 1a87ecf0479b94324f43c42d309f254e8a3ca10f3766cc90a756b94505cb559406871eee47a58fa376640ad85acda3e81d771cb03ab92dc08f5253d81bd88079
-  data.tar.gz: 4cd449cb9543819dd78e51267357f676a7439c89f2ad021f59a5d0f49664a8c8b8141eeebde4184e3eaf1f3f616dfef8a7092f59cc6382c73504de5ffeb41dc3
+  metadata.gz: ccf0846c28e2e0a7d20db08d3ad925fc22d7ed1d5a3cb2f75df3585ce4b42a00663f2550b17ce648d9a86e7e58a7d0a367f43ef21138f6fc838ea8f4b39ec8db
+  data.tar.gz: a5fa4637da88f364ec303ebe0d615e6e0e99caef81e7965d753cf04d8cb33b787efef874ef5b71db3e6a0f1f850087b617a7f6f811cc9fc8d307f7d01562da25

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.8.0] - UNRELEASED
+### Removed
+- Removed `sql_type` that was confusing because it was actually the same as `type` (ex: :string) and not
+  in fact the SQL type (ex: ``varchar(255)'`).
+
 ## [0.7.1] - 2021-02-17
 ### Fixed
 - Exclude unknown options from FieldSpec#sql_options and #schema_attributes.
@@ -125,6 +130,7 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.8.0]: https://github.com/Invoca/declare_schema/compare/v0.7.1...v0.8.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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.7.1)
+    declare_schema (0.8.0.pre.5)
       rails (>= 4.2)
 
 GEM

data/lib/declare_schema/model.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rails'
+
 require 'declare_schema/extensions/module'
 
 module DeclareSchema
@@ -99,8 +101,29 @@ module DeclareSchema
         end
       end
 
-      def primary_key
-        super || 'id'
+      if ::Rails::VERSION::MAJOR < 5
+        def primary_key
+          super || 'id'
+        end
+      end
+
+      # returns the primary key (String) as declared with primary_key =
+      # unlike the `primary_key` method, DOES NOT query the database to find the actual primary key in use right now
+      # if no explicit primary key set, returns the default_defined_primary_key
+      def defined_primary_key
+        if defined?(@primary_key)
+          @primary_key&.to_s
+        end || default_defined_primary_key
+      end
+
+      # if this is a derived class, returns the base class's defined_primary_key
+      # otherwise, returns 'id'
+      def default_defined_primary_key
+        if self == base_class
+          'id'
+        else
+          base_class.defined_primary_key
+        end
       end
 
       private

data/lib/declare_schema/model/column.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  class UnknownSqlTypeError < RuntimeError; end
+  class UnknownTypeError < 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)
+          type != :primary_key && (native_types.empty? || native_types[type]) # empty will happen with NullDBAdapter used in assets:precompile
         end
 
         # MySQL example:
@@ -48,27 +48,17 @@ module DeclareSchema
           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}"
+        def deserialize_default_value(column, type, default_value)
+          type or raise ArgumentError, "must pass type; got #{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
+            # might be getting migrated to a new type. We should be using just 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 = ActiveRecord::Base.connection.send(:lookup_cast_type, type) or
+              raise "cast_type not found for #{type}"
             cast_type.deserialize(default_value)
           end
         end
@@ -103,13 +93,14 @@ module DeclareSchema
         end
       end
 
-      attr_reader :sql_type
+      attr_reader :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)
+        @type = @column.type
+        self.class.native_type?(@type) or raise UnknownTypeError, "#{@type.inspect}"
       end
 
       SCHEMA_KEYS = [:type, :limit, :precision, :scale, :null, :default].freeze
@@ -120,7 +111,7 @@ module DeclareSchema
           value =
             case key
             when :default
-              self.class.deserialize_default_value(@column, @sql_type, @column.default)
+              self.class.deserialize_default_value(@column, @type, @column.default)
             else
               col_value = @column.send(key)
               if col_value.nil? && (native_type = self.class.native_types[@column.type])

data/lib/declare_schema/model/field_spec.rb

@@ -33,7 +33,7 @@ module DeclareSchema
         end
       end
 
-      attr_reader :model, :name, :type, :sql_type, :position, :options, :sql_options
+      attr_reader :model, :name, :type, :position, :options, :sql_options
 
       TYPE_SYNONYMS = { timestamp: :datetime }.freeze # TODO: drop this synonym. -Colin
 
@@ -47,11 +47,9 @@ module DeclareSchema
       end
 
       def initialize(model, name, type, position: 0, **options)
-        # TODO: TECH-5116
-        # Invoca change - searching for the primary key was causing an additional database read on every model load.  Assume
-        # "id" which works for invoca.
-        # raise ArgumentError, "you cannot provide a field spec for the primary key" if name == model.primary_key
-        name == "id" and raise ArgumentError, "you cannot provide a field spec for the primary key"
+        defined_primary_key = model.defined_primary_key
+
+        name.to_s == defined_primary_key and raise ArgumentError, "you may not provide a field spec for the primary key #{name.inspect}"
 
         @model = model
         @name = name.to_sym
@@ -62,13 +60,13 @@ module DeclareSchema
 
         @options.has_key?(:null) or @options[:null] = false
 
-        case type
+        case @type
         when :text
           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
+            @options.delete(:limit)
           end
         when :string
           @options[:limit] or raise "limit: must be given for :string field #{model}##{@name}: #{@options.inspect}; do you want `limit: 255`?"
@@ -77,24 +75,23 @@ module DeclareSchema
           @options[:limit] = 8
         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)
+        Column.native_type?(@type) or raise UnknownTypeError, "#{@type.inspect} not found in #{Column.native_types.inspect} for adapter #{ActiveRecord::Base.connection.class.name}"
 
-        if @sql_type.in?([:string, :text, :binary, :varbinary, :integer, :enum])
-          @options[:limit] ||= Column.native_types[@sql_type][:limit]
+        if @type.in?([:string, :text, :binary, :varbinary, :integer, :enum])
+          @options[:limit] ||= Column.native_types.dig(@type, :limit)
         else
-          @sql_type != :decimal && @options.has_key?(:limit) and warn("unsupported limit: for SQL type #{@sql_type} in field #{model}##{@name}")
+          @type != :decimal && @options.has_key?(:limit) and warn("unsupported limit: for SQL type #{@type} in field #{model}##{@name}")
           @options.delete(:limit)
         end
 
-        if @sql_type == :decimal
+        if @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}")
+          if @type != :datetime
+            @options.has_key?(:precision) and warn("precision: only allowed for :decimal type or :datetime for SQL type #{@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}")
+          @options.has_key?(:scale) and warn("scale: only allowed for :decimal type for SQL type #{@type} in field #{model}##{@name}")
         end
 
         if @type.in?([:text, :string])
@@ -106,8 +103,8 @@ module DeclareSchema
             @options.delete(:collation)
           end
         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}")
+          @options[:charset]   and warn("charset may only given for :string and :text fields for SQL type #{@type} in field #{model}##{@name}")
+          @options[:collation] and warne("collation may only given for :string and :text fields for SQL type #{@type} in field #{model}##{@name}")
         end
 
         @options = Hash[@options.sort_by { |k, _v| OPTION_INDEXES[k] || 9999 }]
@@ -120,7 +117,7 @@ module DeclareSchema
       # omits keys with nil values
       def schema_attributes(col_spec)
         @sql_options.merge(type: @type).tap do |attrs|
-          attrs[:default] = Column.deserialize_default_value(col_spec, @sql_type, attrs[:default])
+          attrs[:default] = Column.deserialize_default_value(col_spec, @type, attrs[:default])
         end.compact
       end
     end

data/lib/declare_schema/model/foreign_key_definition.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'index_definition'
+
 module DeclareSchema
   module Model
     class ForeignKeyDefinition
@@ -15,10 +17,10 @@ module DeclareSchema
         @child_table = 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
-        @index_name = options[:index_name]&.to_s || model.connection.index_name(model.table_name, column: @foreign_key_name)
 
-        # Empty constraint lets mysql generate the name
-        @constraint_name = options[:constraint_name]&.to_s || @index_name&.to_s || ''
+        @constraint_name = options[:constraint_name]&.to_s ||
+                             options[:index_name]&.to_s ||
+                             IndexDefinition.index_name(@foreign_key_name)
         @on_delete_cascade = options[:dependent] == :delete
       end
 

data/lib/declare_schema/model/habtm_model_shim.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module DeclareSchema
+  module Model
+    class HabtmModelShim
+      class << self
+        def from_reflection(refl)
+          join_table = refl.join_table
+          foreign_keys_and_classes = [
+            [refl.foreign_key.to_s, refl.active_record],
+            [refl.association_foreign_key.to_s, refl.class_name.constantize]
+          ].sort { |a, b| a.first <=> b.first }
+          foreign_keys = foreign_keys_and_classes.map(&:first)
+          foreign_key_classes = foreign_keys_and_classes.map(&:last)
+          # this may fail in weird ways if HABTM is running across two DB connections (assuming that's even supported)
+          # figure that anybody who sets THAT up can deal with their own migrations...
+          connection = refl.active_record.connection
+
+          new(join_table, foreign_keys, foreign_key_classes, connection)
+        end
+      end
+
+      attr_reader :join_table, :foreign_keys, :foreign_key_classes, :connection
+
+      def initialize(join_table, foreign_keys, foreign_key_classes, connection)
+        @join_table = join_table
+        @foreign_keys = foreign_keys
+        @foreign_key_classes = foreign_key_classes
+        @connection = connection
+      end
+
+      def table_options
+        {}
+      end
+
+      def table_name
+        join_table
+      end
+
+      def field_specs
+        foreign_keys.each_with_index.each_with_object({}) do |(v, position), result|
+          result[v] = ::DeclareSchema::Model::FieldSpec.new(self, v, :integer, position: position, null: false)
+        end
+      end
+
+      def primary_key
+        false # no single-column primary key in database
+      end
+
+      def defined_primary_key
+        false # no single-column primary key declared
+      end
+
+      def index_definitions_with_primary_key
+        [
+          IndexDefinition.new(self, foreign_keys, unique: true, name: ::DeclareSchema::Model::IndexDefinition::PRIMARY_KEY_NAME),
+          IndexDefinition.new(self, foreign_keys.last) # not unique by itself; combines with primary key to be unique
+        ]
+      end
+
+      alias_method :index_definitions, :index_definitions_with_primary_key
+
+      def ignore_indexes
+        []
+      end
+
+      def constraint_specs
+        [
+          ForeignKeyDefinition.new(self, foreign_keys.first, parent_table: foreign_key_classes.first.table_name, constraint_name: "#{join_table}_FK1", dependent: :delete),
+          ForeignKeyDefinition.new(self, foreign_keys.last, parent_table: foreign_key_classes.last.table_name, constraint_name: "#{join_table}_FK2", dependent: :delete)
+        ]
+      end
+    end
+  end
+end

data/lib/declare_schema/model/index_definition.rb

@@ -19,7 +19,7 @@ module DeclareSchema
         @table = options.delete(:table_name) || model.table_name
         @fields = Array.wrap(fields).map(&:to_s)
         @explicit_name = options[:name] unless options.delete(:allow_equivalent)
-        @name = options.delete(:name) || model.connection.index_name(table, column: @fields).gsub(/index.*_on_/, 'on_')
+        @name = options.delete(:name) || self.class.index_name(@fields)
         @unique = options.delete(:unique) || name == PRIMARY_KEY_NAME || false
 
         if @name.length > MYSQL_INDEX_NAME_MAX_LENGTH
@@ -60,6 +60,10 @@ module DeclareSchema
           index_definitions
         end
 
+        def index_name(columns)
+          "on_#{Array(columns).join("_and_")}"
+        end
+
         private
 
         # This is the old approach which is still needed for MySQL in Rails 4 and SQLite

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "0.7.1"
+  VERSION = "0.8.0.pre.5"
 end

data/lib/generators/declare_schema/migration/migration_generator.rb

@@ -96,7 +96,7 @@ module DeclareSchema
           end
         end
       end
-    rescue ::DeclareSchema::UnknownSqlTypeError => ex
+    rescue ::DeclareSchema::UnknownTypeError => ex
       say "Invalid field type: #{ex}"
     end
 

data/lib/generators/declare_schema/migration/migrator.rb

@@ -6,69 +6,6 @@ require 'active_record/connection_adapters/abstract_adapter'
 module Generators
   module DeclareSchema
     module Migration
-      HabtmModelShim = Struct.new(:join_table, :foreign_keys, :foreign_key_classes, :connection) do
-        class << self
-          def from_reflection(refl)
-            join_table = refl.join_table
-            foreign_keys_and_classes = [
-              [refl.foreign_key.to_s, refl.active_record],
-              [refl.association_foreign_key.to_s, refl.class_name.constantize]
-            ].sort { |a, b| a.first <=> b.first }
-            foreign_keys = foreign_keys_and_classes.map(&:first)
-            foreign_key_classes = foreign_keys_and_classes.map(&:last)
-            # this may fail in weird ways if HABTM is running across two DB connections (assuming that's even supported)
-            # figure that anybody who sets THAT up can deal with their own migrations...
-            connection = refl.active_record.connection
-
-            new(join_table, foreign_keys, foreign_key_classes, connection)
-          end
-        end
-
-        def table_options
-          {}
-        end
-
-        def table_name
-          join_table
-        end
-
-        def table_exists?
-          ActiveRecord::Migration.table_exists? table_name
-        end
-
-        def field_specs
-          i = 0
-          foreign_keys.each_with_object({}) do |v, result|
-            result[v] = ::DeclareSchema::Model::FieldSpec.new(self, v, :integer, position: i, null: false)
-            i += 1
-          end
-        end
-
-        def primary_key
-          false # no single-column primary key
-        end
-
-        def index_definitions_with_primary_key
-          [
-            ::DeclareSchema::Model::IndexDefinition.new(self, foreign_keys, unique: true, name: ::DeclareSchema::Model::IndexDefinition::PRIMARY_KEY_NAME),
-            ::DeclareSchema::Model::IndexDefinition.new(self, foreign_keys.last) # not unique by itself; combines with primary key to be unique
-          ]
-        end
-
-        alias_method :index_definitions, :index_definitions_with_primary_key
-
-        def ignore_indexes
-          []
-        end
-
-        def constraint_specs
-          [
-            ::DeclareSchema::Model::ForeignKeyDefinition.new(self, foreign_keys.first, parent_table: foreign_key_classes.first.table_name, constraint_name: "#{join_table}_FK1", dependent: :delete),
-            ::DeclareSchema::Model::ForeignKeyDefinition.new(self, foreign_keys.last, parent_table: foreign_key_classes.last.table_name, constraint_name: "#{join_table}_FK2", dependent: :delete)
-          ]
-        end
-      end
-
       class Migrator
         class Error < RuntimeError; end
 
@@ -266,7 +203,7 @@ module Generators
           end
           # generate shims for HABTM models
           habtm_tables.each do |name, refls|
-            models_by_table_name[name] = HabtmModelShim.from_reflection(refls.first)
+            models_by_table_name[name] = ::DeclareSchema::Model::HabtmModelShim.from_reflection(refls.first)
           end
           model_table_names = models_by_table_name.keys
 
@@ -328,7 +265,7 @@ module Generators
         end
 
         def create_table(model)
-          longest_field_name       = model.field_specs.values.map { |f| f.sql_type.to_s.length }.max
+          longest_field_name       = model.field_specs.values.map { |f| f.type.to_s.length }.max
           disable_auto_increment   = model.respond_to?(:disable_auto_increment) && model.disable_auto_increment
           table_options_definition = ::DeclareSchema::Model::TableOptionsDefinition.new(model.table_name, table_options_for_model(model))
           field_definitions        = [
@@ -379,7 +316,7 @@ module Generators
         def create_field(field_spec, field_name_width)
           options = field_spec.sql_options.merge(fk_field_options(field_spec.model, field_spec.name))
           args = [field_spec.name.inspect] + format_options(options.compact)
-          format("t.%-*s %s", field_name_width, field_spec.sql_type, args.join(', '))
+          format("t.%-*s %s", field_name_width, field_spec.type, args.join(', '))
         end
 
         def change_table(model, current_table_name)
@@ -417,7 +354,7 @@ module Generators
             args =
               if (spec = model.field_specs[c])
                 options = spec.sql_options.merge(fk_field_options(model, c))
-                [":#{spec.sql_type}", *format_options(options.compact)]
+                [":#{spec.type}", *format_options(options.compact)]
               else
                 [":integer"]
               end

data/spec/lib/declare_schema/field_spec_spec.rb

@@ -6,8 +6,8 @@ rescue LoadError
 end
 
 RSpec.describe DeclareSchema::Model::FieldSpec do
-  let(:model) { double('model', table_options: {}) }
-  let(:col_spec) { double('col_spec', sql_type: 'varchar') }
+  let(:model) { double('model', table_options: {}, defined_primary_key: 'id') }
+  let(:col_spec) { double('col_spec', type: :string) }
 
   before do
     load File.expand_path('prepare_testapp.rb', __dir__)
@@ -22,6 +22,12 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
       subject = described_class.new(model, :price, :integer, anonymize_using: 'x', null: false, position: 0, limit: 4)
       expect(subject.options.keys).to eq([:limit, :null, :anonymize_using])
     end
+
+    it 'raises exception on unknown field type' do
+      expect do
+        described_class.new(model, :location, :lat_long, position: 0)
+      end.to raise_exception(::DeclareSchema::UnknownTypeError, /:lat_long not found in /)
+    end
   end
 
   describe '#schema_attributes' do
@@ -127,7 +133,7 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
     end
 
     describe 'default:' do
-      let(:col_spec) { double('col_spec', sql_type: :integer) }
+      let(:col_spec) { double('col_spec', type: :integer) }
 
       it 'typecasts default value' do
         allow(col_spec).to receive(:type_cast_from_database) { |default| Integer(default) }

data/spec/lib/declare_schema/migration_generator_spec.rb

@@ -372,14 +372,14 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:category_id], name: 'on_category_id'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" if defined?(Mysql2)}
       EOS
       .and migrate_down(<<~EOS.strip)
         remove_column :adverts, :category_id
 
         remove_index :adverts, name: :on_category_id rescue ActiveRecord::StatementInvalid
 
-        #{"remove_foreign_key(\"adverts\", name: \"index_adverts_on_category_id\")\n" if defined?(Mysql2)}
+        #{"remove_foreign_key(\"adverts\", name: \"on_category_id\")\n" if defined?(Mysql2)}
       EOS
     )
 
@@ -400,8 +400,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:c_id], name: 'on_c_id'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -420,8 +420,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
       migrate_up(<<~EOS.strip)
         add_column :adverts, :category_id, :integer, limit: 8, null: false
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -442,8 +442,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:category_id], name: 'my_index'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -468,16 +468,16 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         add_column :adverts, :updated_at, :datetime, null: true
         add_column :adverts, :lock_version, :integer#{lock_version_limit}, null: false, default: 1
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
       .and migrate_down(<<~EOS.strip)
         remove_column :adverts, :created_at
         remove_column :adverts, :updated_at
         remove_column :adverts, :lock_version
 
-        #{"remove_foreign_key(\"adverts\", name: \"index_adverts_on_category_id\")\n" +
-          "remove_foreign_key(\"adverts\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"remove_foreign_key(\"adverts\", name: \"on_category_id\")\n" +
+          "remove_foreign_key(\"adverts\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -501,8 +501,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], name: 'on_title'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -522,8 +522,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], unique: true, name: 'on_title'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -543,8 +543,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], name: 'my_index'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -562,8 +562,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], name: 'on_title'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -581,8 +581,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title], unique: true, name: 'my_index'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -600,8 +600,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
 
         add_index :adverts, [:title, :category_id], name: 'on_title_and_category_id'
 
-        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")" if defined?(Mysql2)}
+        #{"add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+          "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")" if defined?(Mysql2)}
       EOS
     )
 
@@ -637,8 +637,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
             "add_index :ads, [:id], unique: true, name: 'PRIMARY'\n"
           elsif defined?(Mysql2)
             "execute \"ALTER TABLE ads DROP PRIMARY KEY, ADD PRIMARY KEY (id)\"\n\n" +
-            "add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"index_adverts_on_category_id\")\n" +
-            "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"index_adverts_on_c_id\")"
+            "add_foreign_key(\"adverts\", \"categories\", column: \"category_id\", name: \"on_category_id\")\n" +
+            "add_foreign_key(\"adverts\", \"categories\", column: \"c_id\", name: \"on_c_id\")"
           end}
       EOS
       .and migrate_down(<<~EOS.strip)
@@ -651,8 +651,8 @@ RSpec.describe 'DeclareSchema Migration Generator' do
             "add_index :adverts, [:id], unique: true, name: 'PRIMARY'\n"
           elsif defined?(Mysql2)
             "execute \"ALTER TABLE adverts DROP PRIMARY KEY, ADD PRIMARY KEY (id)\"\n\n" +
-            "remove_foreign_key(\"adverts\", name: \"index_adverts_on_category_id\")\n" +
-            "remove_foreign_key(\"adverts\", name: \"index_adverts_on_c_id\")"
+            "remove_foreign_key(\"adverts\", name: \"on_category_id\")\n" +
+            "remove_foreign_key(\"adverts\", name: \"on_c_id\")"
           end}
       EOS
     )

data/spec/lib/declare_schema/model/column_spec.rb

@@ -37,6 +37,11 @@ RSpec.describe DeclareSchema::Model::Column do
           expect(described_class.native_type?(type)).to be_falsey
         end
       end
+
+      it "is truthy when there's a NullDbAdapter (like for assets:precompile) that doesn't have any native types" do
+        allow(described_class).to receive(:native_types).and_return({})
+        expect(described_class.native_type?(:integer)).to be_truthy
+      end
     end
 
     describe '.native_types' do
@@ -59,26 +64,6 @@ RSpec.describe DeclareSchema::Model::Column do
       end
     end
 
-    describe '.sql_type' do
-      it 'returns the sql type for :string' do
-        expect(described_class.sql_type(:string)).to eq(:string)
-      end
-
-      it 'returns the sql type for :integer' do
-        expect(described_class.sql_type(:integer)).to match(:integer)
-      end
-
-      it 'returns the sql type for :datetime' do
-        expect(described_class.sql_type(:datetime)).to eq(:datetime)
-      end
-
-      it 'raises UnknownSqlType' do
-        expect do
-          described_class.sql_type(:email)
-        end.to raise_exception(::DeclareSchema::UnknownSqlTypeError, /:email for type :email/)
-      end
-    end
-
     describe '.deserialize_default_value' do
       require 'rails'
 
@@ -109,10 +94,11 @@ RSpec.describe DeclareSchema::Model::Column do
       end
     end
     let(:model) { ColumnTestModel }
+    let(:type) { :integer }
     let(:current_table_name) { model.table_name }
     let(:column) { double("ActiveRecord Column",
                           name: 'count',
-                          type: :integer,
+                          type: type,
                           limit: nil,
                           precision: nil,
                           scale: nil,
@@ -122,9 +108,9 @@ RSpec.describe DeclareSchema::Model::Column do
                           sql_type_metadata: {}) }
     subject { described_class.new(model, current_table_name, column) }
 
-    describe '#sql_type' do
-      it 'returns sql type' do
-        expect(subject.sql_type).to match(/int/)
+    describe '#type' do
+      it 'returns type' do
+        expect(subject.type).to eq(type)
       end
     end
 

data/spec/lib/declare_schema/model/habtm_model_shim_spec.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+begin
+  require 'mysql2'
+rescue LoadError
+end
+
+require_relative '../../../../lib/declare_schema/model/habtm_model_shim'
+
+RSpec.describe DeclareSchema::Model::HabtmModelShim do
+  let(:join_table) { "parent_1_parent_2" }
+  let(:foreign_keys) { ["parent_1_id", "parent_2_id"] }
+  let(:foreign_key_classes) { [Parent1, Parent2] }
+
+  before do
+    load File.expand_path('../prepare_testapp.rb', __dir__)
+
+    class Parent1 < ActiveRecord::Base
+      self.table_name = "parent_1s"
+    end
+
+    class Parent2 < ActiveRecord::Base
+      self.table_name = "parent_2s"
+    end
+  end
+
+  describe 'class methods' do
+    describe '.from_reflection' do
+      let(:reflection) { double("reflection", join_table: join_table,
+                                              foreign_key: foreign_keys.first,
+                                              association_foreign_key: foreign_keys.last,
+                                              active_record: foreign_key_classes.first,
+                                              class_name: 'Parent1') }
+      it 'returns a new object' do
+        result = described_class.from_reflection(reflection)
+
+        expect(result).to be_a(described_class)
+      end
+    end
+  end
+
+  describe 'instance methods' do
+    let(:connection) { instance_double(ActiveRecord::Base.connection.class, "connection") }
+
+    subject { described_class.new(join_table, foreign_keys, foreign_key_classes, connection) }
+
+    describe '#initialize' do
+      it 'stores initialization attributes' do
+        expect(subject.join_table).to eq(join_table)
+        expect(subject.foreign_keys).to eq(foreign_keys)
+        expect(subject.foreign_key_classes).to be(foreign_key_classes)
+        expect(subject.connection).to be(connection)
+      end
+    end
+
+    describe '#table_options' do
+      it 'returns empty hash' do
+        expect(subject.table_options).to eq({})
+      end
+    end
+
+    describe '#table_name' do
+      it 'returns join_table' do
+        expect(subject.table_name).to eq(join_table)
+      end
+    end
+
+    describe '#field_specs' do
+      it 'returns 2 field specs' do
+        result = subject.field_specs
+        expect(result.size).to eq(2), result.inspect
+
+        expect(result[foreign_keys.first]).to be_a(::DeclareSchema::Model::FieldSpec)
+        expect(result[foreign_keys.first].model).to eq(subject)
+        expect(result[foreign_keys.first].name.to_s).to eq(foreign_keys.first)
+        expect(result[foreign_keys.first].type).to eq(:integer)
+        expect(result[foreign_keys.first].position).to eq(0)
+
+        expect(result[foreign_keys.last]).to be_a(::DeclareSchema::Model::FieldSpec)
+        expect(result[foreign_keys.last].model).to eq(subject)
+        expect(result[foreign_keys.last].name.to_s).to eq(foreign_keys.last)
+        expect(result[foreign_keys.last].type).to eq(:integer)
+        expect(result[foreign_keys.last].position).to eq(1)
+      end
+    end
+
+    describe '#primary_key' do
+      it 'returns false' do
+        expect(subject.primary_key).to eq(false)
+      end
+    end
+
+    describe '#defined_primary_key' do
+      it 'returns false' do
+        expect(subject.defined_primary_key).to eq(false)
+      end
+    end
+
+    describe '#index_definitions_with_primary_key' do
+      it 'returns 2 index definitions' do
+        result = subject.index_definitions_with_primary_key
+        expect(result.size).to eq(2), result.inspect
+
+        expect(result.first).to be_a(::DeclareSchema::Model::IndexDefinition)
+        expect(result.first.name).to eq('PRIMARY')
+        expect(result.first.fields).to eq(['parent_1_id', 'parent_2_id'])
+        expect(result.first.unique).to be_truthy
+
+        expect(result.last).to be_a(::DeclareSchema::Model::IndexDefinition)
+        expect(result.last.name).to eq('on_parent_2_id')
+        expect(result.last.unique).to be_falsey
+        expect(result.last.fields).to eq(['parent_2_id'])
+      end
+    end
+
+    describe '#index_definitions' do
+      it 'returns index_definitions_with_primary_key' do
+        result = subject.index_definitions
+        expect(result.size).to eq(2), result.inspect
+      end
+    end
+
+    describe 'ignore_indexes' do
+      it 'returns empty array' do
+        expect(subject.ignore_indexes).to eq([])
+      end
+    end
+
+    describe '#constraint_specs' do
+      it 'returns 2 foreign keys' do
+        result = subject.constraint_specs
+        expect(result.size).to eq(2), result.inspect
+
+        expect(result.first).to be_a(::DeclareSchema::Model::ForeignKeyDefinition)
+        expect(result.first.foreign_key).to eq(foreign_keys.first)
+        expect(result.first.parent_table_name).to be(Parent1.table_name)
+        expect(result.first.on_delete_cascade).to be_truthy
+
+        expect(result.last).to be_a(::DeclareSchema::Model::ForeignKeyDefinition)
+        expect(result.last.foreign_key).to eq(foreign_keys.last)
+        expect(result.last.parent_table_name).to be(Parent2.table_name)
+        expect(result.last.on_delete_cascade).to be_truthy
+      end
+    end
+  end
+end

data/spec/lib/declare_schema/model/index_definition_spec.rb

@@ -58,7 +58,17 @@ RSpec.describe DeclareSchema::Model::IndexDefinition do
     end
   end
 
-  describe 'class << self' do
+  describe 'class methods' do
+    describe 'index_name' do
+      it 'works with a single column' do
+        expect(described_class.index_name('parent_id')).to eq('on_parent_id')
+      end
+
+      it 'works with many columns' do
+        expect(described_class.index_name(['a', 'b', 'c'])).to eq('on_a_and_b_and_c')
+      end
+    end
+
     context 'with a migrated database' do
       before do
         ActiveRecord::Base.connection.execute <<~EOS

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0.pre.5
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -64,6 +64,7 @@ files:
 - lib/declare_schema/model/column.rb
 - lib/declare_schema/model/field_spec.rb
 - lib/declare_schema/model/foreign_key_definition.rb
+- lib/declare_schema/model/habtm_model_shim.rb
 - lib/declare_schema/model/index_definition.rb
 - lib/declare_schema/model/table_options_definition.rb
 - lib/declare_schema/railtie.rb
@@ -85,6 +86,7 @@ files:
 - spec/lib/declare_schema/migration_generator_spec.rb
 - spec/lib/declare_schema/model/column_spec.rb
 - spec/lib/declare_schema/model/foreign_key_definition_spec.rb
+- spec/lib/declare_schema/model/habtm_model_shim_spec.rb
 - spec/lib/declare_schema/model/index_definition_spec.rb
 - spec/lib/declare_schema/model/table_options_definition_spec.rb
 - spec/lib/declare_schema/prepare_testapp.rb