declare_schema 0.8.0.pre.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32f8ca5dee3bd43f6fc2250904ba539cdeee30f0bb10a6f5f69f5782c282a5a4
-  data.tar.gz: 4326ccc969837a6e74979a4b1fe60dff834e32afea2406c417b4ac18d4cdc582
+  metadata.gz: ae6f3f47d3ad4fa0b1d2e30d8f34b7ac5825b690838492ac57846dcd53396e9a
+  data.tar.gz: 129d77729c08d2fb41e506571ead2a82dd76c0c1675c18556bc3811e0adf3362
 SHA512:
-  metadata.gz: 9548f216b1992826bad36409a370678483743e10270cf35f56447e2873cb64bf48b3ad1c695585bbcc52c37d0327c0a340e0cf8f73ebf6fe09c4af739de0e2fe
-  data.tar.gz: b7b9cad07de9fe0d54db96359c3f97a5c7150d12728dfe189dc66ab8574f6b19ff378826a09ef3ed233e439e6034b487e05b656537b147215e459a07621cc727
+  metadata.gz: 5b145fdd60646c467772034afa2a29e30d29a4d35445c7e769bab731c043cb38c8e0b365ac7f6dc416e93fafdc1edd6e77724085054a6a442934cc191e335fdf
+  data.tar.gz: 1356d29f00f1eb4a72b567c48c57c6683bcc56852dfb68a3252b521a74c6c0afcfdf5765d94a31d3322ee297465c3ca60ec611090cf3ad5dd935e2bc343285ed

data/CHANGELOG.md

@@ -4,8 +4,9 @@ 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
+## [0.8.0] - 2021-02-22
 ### Removed
+- Removed assumption that primary key is named 'id'.
 - 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)'`).
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.8.0.pre.2)
+    declare_schema (0.8.0)
       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
@@ -36,7 +38,7 @@ module DeclareSchema
 
           # eval avoids the ruby 1.9.2 "super from singleton method ..." error
 
-          eval %(
+          eval <<~EOS
             def self.inherited(klass)
               unless klass.field_specs.has_key?(inheritance_column)
                 fields do |f|
@@ -46,14 +48,14 @@ module DeclareSchema
               end
               super
             end
-          )
+          EOS
         end
       end
     end
 
     module ClassMethods
       def index(fields, options = {})
-        # don't double-index fields
+        # make index idempotent
         index_fields_s = Array.wrap(fields).map(&:to_s)
         unless index_definitions.any? { |index_spec| index_spec.fields == index_fields_s }
           index_definitions << ::DeclareSchema::Model::IndexDefinition.new(self, fields, options)
@@ -72,7 +74,7 @@ module DeclareSchema
       end
 
       # tell the migration generator to ignore the named index. Useful for existing indexes, or for indexes
-      # that can't be automatically generated (for example: an prefix index in MySQL)
+      # that can't be automatically generated (for example: a prefix index in MySQL)
       def ignore_index(index_name)
         ignore_indexes << index_name.to_s
       end
@@ -83,10 +85,10 @@ module DeclareSchema
       # declarations.
       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)
-        add_validations_for_field(name, type, args, options)
-        add_index_for_field(name, args, options)
+        _add_serialize_for_field(name, type, options)
+        _add_formatting_for_field(name, type)
+        _add_validations_for_field(name, type, args, options)
+        _add_index_for_field(name, args, options)
         field_specs[name] = ::DeclareSchema::Model::FieldSpec.new(self, name, type, position: field_specs.size, **options)
         attr_order << name unless attr_order.include?(name)
       end
@@ -95,20 +97,10 @@ module DeclareSchema
         if index_definitions.any?(&:primary_key?)
           index_definitions
         else
-          index_definitions + [rails_default_primary_key]
+          index_definitions + [_rails_default_primary_key]
         end
       end
 
-      def primary_key
-        super || 'id'
-      end
-
-      private
-
-      def rails_default_primary_key
-        ::DeclareSchema::Model::IndexDefinition.new(self, [primary_key.to_sym], unique: true, name: DeclareSchema::Model::IndexDefinition::PRIMARY_KEY_NAME)
-      end
-
       # Extend belongs_to so that it creates a FieldSpec for the foreign key
       def belongs_to(name, scope = nil, **options)
         column_options = {}
@@ -149,7 +141,7 @@ module DeclareSchema
         declare_field(fkey.to_sym, :integer, column_options)
         if refl.options[:polymorphic]
           foreign_type = options[:foreign_type] || "#{name}_type"
-          declare_polymorphic_type_field(foreign_type, column_options)
+          _declare_polymorphic_type_field(foreign_type, column_options)
           index([foreign_type, fkey], index_options) if index_options[:name] != false
         else
           index(fkey, index_options) if index_options[:name] != false
@@ -157,26 +149,49 @@ module DeclareSchema
         end
       end
 
+      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
+
+      private
+
+      # 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
+
+      def _rails_default_primary_key
+        ::DeclareSchema::Model::IndexDefinition.new(self, [_defined_primary_key.to_sym], unique: true, name: DeclareSchema::Model::IndexDefinition::PRIMARY_KEY_NAME)
+      end
+
       # Declares the "foo_type" field that accompanies the "foo_id"
       # field for a polymorphic belongs_to
-      def declare_polymorphic_type_field(foreign_type, column_options)
+      def _declare_polymorphic_type_field(foreign_type, column_options)
         declare_field(foreign_type, :string, column_options.merge(limit: 255))
         # FIXME: Before declare_schema was extracted, this used to now do:
         # never_show(type_col)
         # That needs doing somewhere
       end
 
-      # Declare a rich-type for any attribute (i.e. getter method). This
-      # does not effect the attribute in any way - it just records the
-      # metadata.
-      def declare_attr_type(name, type, options = {})
-        attr_types[name] = klass = DeclareSchema.to_class(type)
-        klass.try(:declared, self, name, options)
-      end
-
       # Add field validations according to arguments in the
       # field declaration
-      def add_validations_for_field(name, type, args, options)
+      def _add_validations_for_field(name, type, args, options)
         validates_presence_of   name if :required.in?(args)
         validates_uniqueness_of name, allow_nil: !:required.in?(args) if :unique.in?(args)
 
@@ -195,18 +210,18 @@ module DeclareSchema
         end
       end
 
-      def add_serialize_for_field(name, type, options)
+      def _add_serialize_for_field(name, type, options)
         if (serialize_class = options.delete(:serialize))
           type == :string || type == :text or raise ArgumentError, "serialize field type must be :string or :text"
           serialize_args = Array((serialize_class unless serialize_class == true))
           serialize(name, *serialize_args)
           if options.has_key?(:default)
-            options[:default] = serialized_default(name, serialize_class == true ? Object : serialize_class, options[:default])
+            options[:default] = _serialized_default(name, serialize_class == true ? Object : serialize_class, options[:default])
           end
         end
       end
 
-      def serialized_default(attr_name, class_name_or_coder, default)
+      def _serialized_default(attr_name, class_name_or_coder, default)
         # copied from https://github.com/rails/rails/blob/7d6cb950e7c0e31c2faaed08c81743439156c9f5/activerecord/lib/active_record/attribute_methods/serialization.rb#L70-L76
         coder = if class_name_or_coder == ::JSON
                   ActiveRecord::Coders::JSON
@@ -225,7 +240,7 @@ module DeclareSchema
         end
       end
 
-      def add_formatting_for_field(name, type)
+      def _add_formatting_for_field(name, type)
         if (type_class = DeclareSchema.to_class(type))
           if "format".in?(type_class.instance_methods)
             before_validation do |record|
@@ -235,7 +250,7 @@ module DeclareSchema
         end
       end
 
-      def add_index_for_field(name, args, options)
+      def _add_index_for_field(name, args, options)
         if (to_name = options.delete(:index))
           index_opts =
             {
@@ -264,13 +279,13 @@ module DeclareSchema
               refl
             end
           end ||
-          if (col = column(name.to_s))
+          if (col = _column(name.to_s))
             DeclareSchema::PLAIN_TYPES[col.type] || col.klass
           end
       end
 
       # Return the entry from #columns for the named column
-      def column(name)
+      def _column(name)
         defined?(@table_exists) or @table_exists = table_exists?
         if @table_exists
           columns_hash[name.to_s]

data/lib/declare_schema/model/column.rb

@@ -8,7 +8,7 @@ module DeclareSchema
     class Column
       class << self
         def native_type?(type)
-          type != :primary_key && native_types[type]
+          type != :primary_key && (native_types.empty? || native_types[type]) # empty will happen with NullDBAdapter used in assets:precompile
         end
 
         # MySQL example:
@@ -44,6 +44,8 @@ module DeclareSchema
             if ActiveRecord::Base.connection.class.name.match?(/mysql/i)
               types[:text][:limit]    ||= 0xffff
               types[:binary][:limit]  ||= 0xffff
+
+              types[:varbinary] ||= { name: "varbinary" } # TODO: :varbinary is an Invoca addition to Rails; make it a configurable option
             end
           end
         end

data/lib/declare_schema/model/field_spec.rb

@@ -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
@@ -80,7 +78,7 @@ module DeclareSchema
         Column.native_type?(@type) or raise UnknownTypeError, "#{@type.inspect} not found in #{Column.native_types.inspect} for adapter #{ActiveRecord::Base.connection.class.name}"
 
         if @type.in?([:string, :text, :binary, :varbinary, :integer, :enum])
-          @options[:limit] ||= Column.native_types[@type][:limit]
+          @options[:limit] ||= Column.native_types.dig(@type, :limit)
         else
           @type != :decimal && @options.has_key?(:limit) and warn("unsupported limit: for SQL type #{@type} in field #{model}##{@name}")
           @options.delete(:limit)

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.8.0.pre.2"
+  VERSION = "0.8.0"
 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
 
@@ -348,12 +285,13 @@ module Generators
         end
 
         def create_table_options(model, disable_auto_increment)
-          if model.primary_key.blank? || disable_auto_increment
+          primary_key = model._defined_primary_key
+          if primary_key.blank? || disable_auto_increment
             "id: false"
-          elsif model.primary_key == "id"
+          elsif primary_key == "id"
             "id: :bigint"
           else
-            "primary_key: :#{model.primary_key}"
+            "primary_key: :#{primary_key}"
           end
         end
 
@@ -386,18 +324,18 @@ module Generators
           new_table_name = model.table_name
 
           db_columns = model.connection.columns(current_table_name).index_by(&:name)
-          key_missing = db_columns[model.primary_key].nil? && model.primary_key.present?
-          if model.primary_key.present?
-            db_columns.delete(model.primary_key)
+          key_missing = db_columns[model._defined_primary_key].nil? && model._defined_primary_key.present?
+          if model._defined_primary_key.present?
+            db_columns.delete(model._defined_primary_key)
           end
 
           model_column_names = model.field_specs.keys.map(&:to_s)
           db_column_names = db_columns.keys.map(&:to_s)
 
           to_add = model_column_names - db_column_names
-          to_add += [model.primary_key] if key_missing && model.primary_key.present?
+          to_add += [model._defined_primary_key] if key_missing && model._defined_primary_key.present?
           to_remove = db_column_names - model_column_names
-          to_remove -= [model.primary_key.to_sym] if model.primary_key.present?
+          to_remove -= [model._defined_primary_key.to_sym] if model._defined_primary_key.present?
 
           to_rename = extract_column_renames!(to_add, to_remove, new_table_name)
 

data/spec/lib/declare_schema/field_spec_spec.rb

@@ -6,7 +6,7 @@ rescue LoadError
 end
 
 RSpec.describe DeclareSchema::Model::FieldSpec do
-  let(:model) { double('model', table_options: {}) }
+  let(:model) { double('model', table_options: {}, _defined_primary_key: 'id') }
   let(:col_spec) { double('col_spec', type: :string) }
 
   before do
@@ -83,37 +83,46 @@ RSpec.describe DeclareSchema::Model::FieldSpec do
           expect(subject.schema_attributes(col_spec)).to eq(type: :text, null: true, default: 'none')
         end
       end
+    end
 
-      describe 'decimal' do
-        it 'allows precision: and scale:' do
-          subject = described_class.new(model, :quantity, :decimal, precision: 8, scale: 10, null: true, position: 3)
-          expect(subject.schema_attributes(col_spec)).to eq(type: :decimal, precision: 8, scale: 10, null: true)
+    if defined?(Mysql2)
+      describe 'varbinary' do # TODO: :varbinary is an Invoca addition to Rails; make it a configurable option
+        it 'is supported' do
+          subject = described_class.new(model, :binary_dump, :varbinary, limit: 200, null: false, position: 2)
+          expect(subject.schema_attributes(col_spec)).to eq(type: :varbinary, limit: 200, null: false)
         end
+      end
+    end
 
-        it 'requires precision:' do
-          expect_any_instance_of(described_class).to receive(:warn).with(/precision: required for :decimal type/)
-          described_class.new(model, :quantity, :decimal, scale: 10, null: true, position: 3)
-        end
+    describe 'decimal' do
+      it 'allows precision: and scale:' do
+        subject = described_class.new(model, :quantity, :decimal, precision: 8, scale: 10, null: true, position: 3)
+        expect(subject.schema_attributes(col_spec)).to eq(type: :decimal, precision: 8, scale: 10, null: true)
+      end
 
-        it 'requires scale:' do
-          expect_any_instance_of(described_class).to receive(:warn).with(/scale: required for :decimal type/)
-          described_class.new(model, :quantity, :decimal, precision: 8, null: true, position: 3)
-        end
+      it 'requires precision:' do
+        expect_any_instance_of(described_class).to receive(:warn).with(/precision: required for :decimal type/)
+        described_class.new(model, :quantity, :decimal, scale: 10, null: true, position: 3)
+      end
+
+      it 'requires scale:' do
+        expect_any_instance_of(described_class).to receive(:warn).with(/scale: required for :decimal type/)
+        described_class.new(model, :quantity, :decimal, precision: 8, null: true, position: 3)
       end
+    end
 
-      [:integer, :bigint, :string, :text, :binary, :datetime, :date, :time].each do |t|
-        describe t.to_s do
-          let(:extra) { t == :string ? { limit: 100 } : {} }
+    [:integer, :bigint, :string, :text, :binary, :datetime, :date, :time, (:varbinary if defined?(Mysql2))].compact.each do |t|
+      describe t.to_s do
+        let(:extra) { t == :string ? { limit: 100 } : {} }
 
-          it 'does not allow precision:' do
-            expect_any_instance_of(described_class).to receive(:warn).with(/precision: only allowed for :decimal type/)
-            described_class.new(model, :quantity, t, { precision: 8, null: true, position: 3 }.merge(extra))
-          end unless t == :datetime
+        it 'does not allow precision:' do
+          expect_any_instance_of(described_class).to receive(:warn).with(/precision: only allowed for :decimal type/)
+          described_class.new(model, :quantity, t, { precision: 8, null: true, position: 3 }.merge(extra))
+        end unless t == :datetime
 
-          it 'does not allow scale:' do
-            expect_any_instance_of(described_class).to receive(:warn).with(/scale: only allowed for :decimal type/)
-            described_class.new(model, :quantity, t, { scale: 10, null: true, position: 3 }.merge(extra))
-          end
+        it 'does not allow scale:' do
+          expect_any_instance_of(described_class).to receive(:warn).with(/scale: only allowed for :decimal type/)
+          described_class.new(model, :quantity, t, { scale: 10, null: true, position: 3 }.merge(extra))
         end
       end
     end

data/spec/lib/declare_schema/interactive_primary_key_spec.rb

@@ -19,7 +19,7 @@ RSpec.describe 'DeclareSchema Migration Generator interactive primary key' do
     end
 
     generate_migrations '-n', '-m'
-    expect(Foo.primary_key).to eq('foo_id')
+    expect(Foo._defined_primary_key).to eq('foo_id')
 
     ### migrate from
     # rename from custom primary_key
@@ -31,7 +31,7 @@ RSpec.describe 'DeclareSchema Migration Generator interactive primary key' do
 
     puts "\n\e[45m Please enter 'id' (no quotes) at the next prompt \e[0m"
     generate_migrations '-n', '-m'
-    expect(Foo.primary_key).to eq('id')
+    expect(Foo._defined_primary_key).to eq('id')
 
     nuke_model_class(Foo)
 
@@ -47,7 +47,7 @@ RSpec.describe 'DeclareSchema Migration Generator interactive primary key' do
 
       puts "\n\e[45m Please enter 'drop id' (no quotes) at the next prompt \e[0m"
       generate_migrations '-n', '-m'
-      expect(Foo.primary_key).to eq('foo_id')
+      expect(Foo._defined_primary_key).to eq('foo_id')
 
       ### ensure it doesn't cause further migrations
 

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

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._defined_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.8.0.pre.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-02-22 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