declare_schema 1.4.0.colin.9 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e20de5eeec8ea9436d2fd674f5ff33f20888cfb87e17456fd278a38504bbede
-  data.tar.gz: 259d8dd463292836e40d3fe07261743e714d588440d8a988183daa32f0c8a4d9
+  metadata.gz: a00635546beea8512ef5678ea8d182612f6a6e5b099d6a13c4287e52312e8490
+  data.tar.gz: f5ba19f1fd2dc5d3c66923dda796e413f4a3bcd4586764b254c4345602ebb984
 SHA512:
-  metadata.gz: 18dc843b60c81ace18bc692f1e8d76038d50695081ab846b14f0653aa4d6a755666417f4d7190429aa83e9eb9fffba02d61c71b2a5c44ef7dbf69baf401e7e31
-  data.tar.gz: 94bf1af85ecdc252e08f6453018edc6a2f216e65aa6d7fce0ab7399058097d6a0e1a834e02d350789e8e6fb3485050979dde543e2036e048cc914dd6ffb5cdad
+  metadata.gz: 4cd37d8cf76460b9af36e1f05c7e5c42f370eae8fec0936e563a6dcd74e7176d1d8c66e6fa464d7e58429be220be0dbb5b6a7f5bf7c19dfb0ff834e53771e806
+  data.tar.gz: '0870d0173821829d81c8033fda33921c8de00f7b1ec5aa2b9da56fb15b7d73b716a14058be0dc2ad595bc2bf2a6b9b66c8cdcbb612dd91fd21d88c0992b0e057'

data/CHANGELOG.md

@@ -4,12 +4,21 @@ 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).
 
-## [1.4] - Unreleased
+## [1.4.0] - 2024-01-24
 ### Added
 - Added support for partial indexes with `length:` option.
 ### Changed
 - Deprecate index: 'name' and unique: true|false in favor of index: { name: 'name', unique: true|false }.
 
+## [1.3.6] - 2024-01-22
+### Fixed
+- Add missing commits around connection: and Array check for composite declared primary key.
+
+## [1.3.5] - 2024-01-22
+### Fixed
+- Make `default_charset=` and `default_collation=` lazy so they don't use the database connection to check the
+  MySQL version. Instead, that is checked the first time `default_charset` or `default_collation` is called.
+
 ## [1.3.4] - 2024-01-18
 ### Fixed
 - Add test for migrating `has_and_belongs_to_many` associations and fix them to properly declare their

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (1.4.0.colin.9)
+    declare_schema (1.4.0)
       rails (>= 5.0)
 
 GEM

data/lib/declare_schema/model/index_definition.rb

@@ -18,7 +18,7 @@ module DeclareSchema
 
       def initialize(columns, table_name:, name: nil, allow_equivalent: false, unique: false, where: nil, length: nil)
         @table_name = table_name
-        @name = name || self.class.default_index_name(table_name, columns)
+        @name = (name || self.class.default_index_name(table_name, columns)).to_s
         @columns = Array.wrap(columns).map(&:to_s)
         @explicit_name = @name if !allow_equivalent
         unique.in?([false, true]) or raise ArgumentError, "unique must be true or false: got #{unique.inspect}"

data/lib/declare_schema/model.rb

@@ -50,10 +50,23 @@ module DeclareSchema
 
     module ClassMethods
       def index(columns, name: nil, allow_equivalent: false, unique: false, where: nil, length: nil)
-        index_definitions << ::DeclareSchema::Model::IndexDefinition.new(
+        index_definition = ::DeclareSchema::Model::IndexDefinition.new(
           columns,
           name: name, table_name: table_name, allow_equivalent: allow_equivalent, unique: unique, where: where, length: length
         )
+
+        if (equivalent = index_definitions.find { index_definition.equivalent?(_1) }) # differs only by name
+          if equivalent == index_definition
+            # identical is always idempotent
+          else
+            # equivalent is idempotent iff allow_equivalent: true passed
+            allow_equivalent or
+              raise ArgumentError, "equivalent index definition found (pass allow_equivalent: true to ignore):\n" \
+                                   "#{index_definition.inspect}\n#{equivalent.inspect}"
+          end
+        else
+          index_definitions << index_definition
+        end
       end
 
       def primary_key_index(*columns)
@@ -61,11 +74,13 @@ module DeclareSchema
       end
 
       def constraint(foreign_key_column, parent_table_name: nil, constraint_name: nil, parent_class_name: nil, dependent: nil)
-        constraint_definitions << ::DeclareSchema::Model::ForeignKeyDefinition.new(
+        constraint_definition = ::DeclareSchema::Model::ForeignKeyDefinition.new(
           foreign_key_column.to_s,
           constraint_name: constraint_name,
           child_table_name: table_name, parent_table_name: parent_table_name, parent_class_name: parent_class_name, dependent: dependent
         )
+
+        constraint_definitions << constraint_definition # Set<> implements idempotent insert.
       end
 
       # tell the migration generator to ignore the named index. Useful for existing indexes, or for indexes
@@ -100,7 +115,37 @@ module DeclareSchema
       # 1. creates a FieldSpec for the foreign key
       # 2. declares an index on the foreign key (optional)
       # 3. declares a foreign_key constraint (optional)
+      # @param name [Symbol] the name of the association to pass to super
+      # @param scope [Proc] the scope of the association to pass to super
+      # @option options [Boolean] :optional (default: false) whether the foreign key column should be nullable and whether
+      #   ActiveRecord should validate presence of the foreign key (passed through to super)
+      # @option options [Boolean] :null (default: inferred from options[:optional]) whether the foreign key column should be nullable
+      #   (`null:` should only be passed if it is the inverse of `optional:`; otherwise it is redundant)
+      # @option options [Integer] :limit (default: inferred from the primary key limit:) the limit of the foreign key column size (4 or 8)
+      # @option options [Boolean|Hash<Symbol>] :index (default: true) whether to create an index on the foreign key; can be true or false
+      #   or a hash of options to pass to the index declaration, with keys like { name: ..., unique: ... }
+      # @option options [Boolean] :allow_equivalent (default: false) whether to allow an existing index with a different name
+      # @option options [Boolean|String] :constraint (default: true) whether to create a foreign key constraint on the foreign key;
+      #   may be true or false or a string to use as the constraint name
+      # @option options [Boolean] :polymorphic (default: false) whether this is a polymorphic belongs_to with a _type column next to
+      #   the foreign key _id column (also passed through to super)
+      # @option options [Boolean] :far_end_dependent (default: nil) whether to add a dependent: :delete to the far end of the foreign key
+      #   constraint
+      # @option options [String] :foreign_type (default: "#{name}_type") the name prefix for the _type column for a polymorphic belongs_to
+      #   (passed through to super)
+      # Other options are passed through to super
       def belongs_to(name, scope = nil, **options)
+        if options[:null].in?([true, false]) && options[:optional] == options[:null]
+          STDERR.puts("[declare_schema warning] belongs_to #{name.inspect}, null: with the same value as optional: is redundant; omit null: #{options[:null]} (called from #{caller[0]})")
+        elsif !options.has_key?(:optional)
+          case options[:null]
+          when true
+            STDERR.puts("[declare_schema] belongs_to #{name.inspect}, null: true is deprecated in favor of optional: true (called from #{caller[0]})")
+          when false
+            STDERR.puts("[declare_schema] belongs_to #{name.inspect}, null: false is implied and can be omitted (called from #{caller[0]})")
+          end
+        end
+
         column_options = {}
 
         column_options[:null] = if options.has_key?(:null)
@@ -125,18 +170,18 @@ module DeclareSchema
           index_options = {} # create an index
           case index_value
           when String, Symbol
-            ActiveSupport::Deprecation.warn("belongs_to #{name.inspect}, index: 'name' is deprecated; use index: { name: 'name' } instead (in #{self.name})")
+            ActiveSupport::Deprecation.warn("[declare_schema] belongs_to #{name.inspect}, index: 'name' is deprecated; use index: { name: 'name' } instead (in #{self.name})")
             index_options[:name] = index_value.to_s
           when true
           when nil
           when Hash
             index_options = index_value
           else
-            raise ArgumentError, "belongs_to #{name.inspect}, index: must be true or false or a Hash; got #{index_value.inspect} (in #{self.name})"
+            raise ArgumentError, "[declare_schema] belongs_to #{name.inspect}, index: must be true or false or a Hash; got #{index_value.inspect} (in #{self.name})"
           end
 
           if options.has_key?(:unique)
-            ActiveSupport::Deprecation.warn("belongs_to #{name.inspect}, unique: true|false is deprecated; use index: { unique: true|false } instead (in #{self.name})")
+            ActiveSupport::Deprecation.warn("[declare_schema] belongs_to #{name.inspect}, unique: true|false is deprecated; use index: { unique: true|false } instead (in #{self.name})")
             index_options[:unique] = options.delete(:unique)
           end
 

data/lib/declare_schema/schema_change/column_add.rb

@@ -6,8 +6,10 @@ module DeclareSchema
   module SchemaChange
     class ColumnAdd < Base
       def initialize(table_name, column_name, column_type, **column_options)
-        @table_name = table_name or raise ArgumentError, "must provide table_name"
-        @column_name = column_name or raise ArgumentError, "must provide column_name"
+        table_name.is_a?(String) || table_name.is_a?(Symbol) or raise ArgumentError, "must provide String|Symbol table_name; got #{table_name.inspect}"
+        column_name.is_a?(String) || column_name.is_a?(Symbol) or raise ArgumentError, "must provide String|Symbol column_name; got #{column_name.inspect}"
+        @table_name = table_name
+        @column_name = column_name
         @column_type = column_type or raise ArgumentError, "must provide column_type"
         @column_options = column_options
       end

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "1.4.0.colin.9"
+  VERSION = "1.4.0"
 end

data/lib/declare_schema.rb

@@ -36,7 +36,7 @@ module DeclareSchema
 
   class << self
     attr_writer :mysql_version
-    attr_reader :default_charset, :default_collation, :default_text_limit, :default_string_limit, :default_null,
+    attr_reader :default_text_limit, :default_string_limit, :default_null,
                 :default_generate_foreign_keys, :default_generate_indexing, :db_migrate_command,
                 :max_index_and_constraint_name_length
 
@@ -81,12 +81,22 @@ module DeclareSchema
 
     def default_charset=(charset)
       charset.is_a?(String) or raise ArgumentError, "charset must be a string (got #{charset.inspect})"
-      @default_charset = normalize_charset(charset)
+      @default_charset_before_normalization = charset
+      @default_charset = nil
+    end
+
+    def default_charset
+      @default_charset ||= normalize_charset(@default_charset_before_normalization)
     end
 
     def default_collation=(collation)
       collation.is_a?(String) or raise ArgumentError, "collation must be a string (got #{collation.inspect})"
-      @default_collation = normalize_collation(collation)
+      @default_collation_before_normalization = collation
+      @default_collation = nil
+    end
+
+    def default_collation
+      @default_collation ||= normalize_collation(@default_collation_before_normalization)
     end
 
     def default_text_limit=(text_limit)

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

@@ -352,7 +352,7 @@ module Generators
 
           db_columns = model.connection.columns(current_table_name).index_by(&:name)
           if (pk = model._declared_primary_key.presence)
-            pk_was_in_db_columns = db_columns.delete(pk)
+            pk_was_in_db_columns = pk.is_a?(Array) || db_columns.delete(pk)
           end
 
           model_column_names = model.field_specs.keys.map(&:to_s)

data/spec/lib/declare_schema/migration_generator_spec.rb

@@ -1437,5 +1437,53 @@ RSpec.describe 'DeclareSchema Migration Generator' do
         end
       end
     end
+
+    context 'index' do
+      before do
+        class Advert < active_record_base_class.constantize
+          declare_schema { }
+          belongs_to :ad_category
+        end
+      end
+
+      it "is idempotent and doesn't raise" do
+        expect do
+          Advert.index [:ad_category_id], name: :index_adverts_on_ad_category_id
+        end.to_not change { Advert.index_definitions.size }
+      end
+
+      it "when equivalent but not marked to allow, it raises" do
+        expect do
+          Advert.index [:ad_category_id], name: :on_ad_category_id
+        end.to raise_exception(ArgumentError, /equivalent index definition found/i)
+      end
+
+      it "when equivalent and marked to allow, it is idempotent and doesn't raise" do
+        expect do
+          Advert.index [:ad_category_id], name: :on_ad_category_id, allow_equivalent: true
+        end.to_not change { Advert.index_definitions.size }
+      end
+
+      context 'constraint' do
+        before do
+          class Advert < active_record_base_class.constantize
+            declare_schema { }
+            belongs_to :ad_category
+          end
+        end
+
+        it "when exactly equal, it is idempotent and doesn't raise" do
+          expect do
+            Advert.constraint :ad_category_id, parent_table_name: 'ad_categories', constraint_name: :index_adverts_on_ad_category_id, parent_class_name: 'AdCategory'
+          end.to_not change { Advert.index_definitions.size }
+        end
+
+        it "when equivalent, it is idempotent and doesn't raise" do
+          expect do
+            Advert.constraint :ad_category_id, parent_table_name: 'ad_categories', constraint_name: :constraint_1, parent_class_name: 'AdCategory'
+          end.to_not change { Advert.index_definitions.size }
+        end
+      end
+    end
   end
 end

data/spec/lib/declare_schema_spec.rb

@@ -37,6 +37,26 @@ RSpec.describe DeclareSchema do
         it     { is_expected.to eq("utf8mb3") }
       end
     end
+
+    context 'when MySQL version not known yet' do
+      before { described_class.remove_instance_variable('@mysql_version') rescue nil }
+      after { described_class.remove_instance_variable('@mysql_version') rescue nil }
+
+      context 'when set' do
+        let(:connection) { double("connection", select_value: "8.0.21") }
+
+        it "is lazy, so it doesn't use the database connection until read" do
+          expect(ActiveRecord::Base).to receive(:connection) do
+            @connection_called = true
+            connection
+          end
+          described_class.default_charset = "utf8"
+          expect(@connection_called).to be_falsey
+          described_class.default_charset
+          expect(@connection_called).to be_truthy
+        end
+      end
+    end
   end
 
   describe '#default_collation' do
@@ -81,6 +101,26 @@ RSpec.describe DeclareSchema do
         it     { is_expected.to eq("utf8mb3_general_ci") }
       end
     end
+
+    context 'when MySQL version not known yet' do
+      before { described_class.remove_instance_variable('@mysql_version') rescue nil }
+      after { described_class.remove_instance_variable('@mysql_version') rescue nil }
+
+      context 'when set' do
+        let(:connection) { double("connection", select_value: "8.0.21") }
+
+        it "is lazy, so it doesn't use the database connection until read" do
+          expect(ActiveRecord::Base).to receive(:connection) do
+            @connection_called = true
+            connection
+          end
+          described_class.default_collation = "utf8_general_ci"
+          expect(@connection_called).to be_falsey
+          described_class.default_collation
+          expect(@connection_called).to be_truthy
+        end
+      end
+    end
   end
 
   describe '#default_text_limit' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 1.4.0.colin.9
+  version: 1.4.0
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-20 00:00:00.000000000 Z
+date: 2024-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails