declare_schema 1.4.0.colin.11 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13075fb086e36e6be6818fd28620cb9015c257083e994f68c216ca790e463896
-  data.tar.gz: 4668a054c8d87a7612ba739e3937a4faf817b3ac558083c8e0af59668aa1c42a
+  metadata.gz: a00635546beea8512ef5678ea8d182612f6a6e5b099d6a13c4287e52312e8490
+  data.tar.gz: f5ba19f1fd2dc5d3c66923dda796e413f4a3bcd4586764b254c4345602ebb984
 SHA512:
-  metadata.gz: 86d9f02bb9cabbb23ecec2eb68098b625b753b04890811858e4a43963d111ac54e5d2e10cd5468dfbdc2c6af39d1cab779002b033dbcbc05e869e4f0bc11f151
-  data.tar.gz: fbc233f25183279a309a23dc9afb395b4c4a47e52a95661126c99d9a9109100c5bd5ac3b200171fca479bd9c569f1a9aa34dbe15c79e8cfe50a95387f683ab7e
+  metadata.gz: 4cd37d8cf76460b9af36e1f05c7e5c42f370eae8fec0936e563a6dcd74e7176d1d8c66e6fa464d7e58429be220be0dbb5b6a7f5bf7c19dfb0ff834e53771e806
+  data.tar.gz: '0870d0173821829d81c8033fda33921c8de00f7b1ec5aa2b9da56fb15b7d73b716a14058be0dc2ad595bc2bf2a6b9b66c8cdcbb612dd91fd21d88c0992b0e057'

data/CHANGELOG.md

@@ -4,7 +4,7 @@ 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

data/Gemfile.lock

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

data/lib/declare_schema/model.rb

@@ -115,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)
@@ -140,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/version.rb

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

metadata

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