declare_schema 1.2.1 → 1.2.2.pre.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ba6099c2cfd605309415e3a14d53ba36aecad45285c4babdc385fa3576225ff
-  data.tar.gz: 60c009064977df314115e0bd1db8e811ba05866e24ac652a31b3ec4bc25291f5
+  metadata.gz: 845f78b84a0a36a5d218c35351b1445d669b512b96745ee7bf7ab6a2a0a97277
+  data.tar.gz: d983c4fb5d5e3bb123854a8dada61c02970de010331770f77ab3630c084c8a04
 SHA512:
-  metadata.gz: 9a7308b18a3a38c4713a2effb7f7f9dcf6b75702703152292061d4e266ada35b7be47e4ab43322965f9bfb0c88886ee138bea984bf0e09a9d37dde8bd1fe2da5
-  data.tar.gz: 10c67731046059b1ae1ff483ae979f4b649805deac4559ae2e4533082fa4e4a66e237814ff5873c638543ed533a5f660bf1dd204a5e3a8356fe377da1769d388
+  metadata.gz: 4bcf9de4ccb29f0679ebe15f3892858e628bda5ed4eb30b7d7860d687a2233df7b24d7a913772b8b4d312ab378bcdc4b2fa1675b17f9d69e20d166d1eb0f0dba
+  data.tar.gz: 8e21e6bc2a9d5dd6f3ab40b971cf6f31de66901049f28b17f927d40ae247ecd6c7af60bfe300f9f27b15af0e58df205a3de7e9f97a5dc4a94c8c5bf7b5602a8c

data/.github/workflows/declare_schema_build.yml

@@ -16,11 +16,6 @@ jobs:
         - gemfiles/rails_5_sqlite.gemfile
         - gemfiles/rails_6_mysql.gemfile
         - gemfiles/rails_6_sqlite.gemfile
-        include:
-        - gemfile: gemfiles/rails_5_mysql.gemfile
-          ruby: 2.5
-        - gemfile: gemfiles/rails_5_sqlite.gemfile
-          ruby: 2.5
         exclude:
         - ruby: '3.0'
           gemfile: gemfiles/rails_5_mysql.gemfile

data/CHANGELOG.md

@@ -4,6 +4,17 @@ 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.2.2] - Unreleased
+### Changed
+- Documented `belongs_to` and `has_and_belongs_to_many` behavior
+- Documented configurable ignored tables behavior
+
+### Fixed
+- Ruby 3.x kwargs issue when calling `validates`
+
+### Removed
+- Ruby 2.5 from test matrix
+
 ## [1.2.1] - 2022-09-25
 ### Fixed
 - If Rails is defined, raise if `Rails.application` is `nil`.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (1.2.1)
+    declare_schema (1.2.2.pre.0)
       rails (>= 5.0)
 
 GEM

data/README.md

@@ -224,6 +224,40 @@ If your repo has a different command to run for migrations, you can configure it
 `DeclareSchema.db_migrate_command = "bundle exec rails db:migrate_immediate"`
 ```
 
+## The `belongs_to` Association
+The foreign key for a `belongs_to` association refers to the primary key of the associated model. The `belongs_to`
+association is outside of the `declare_schema do` block, so `declare_schema` intercepts the `belongs_to` macro to
+infer the foreign key column.
+
+By default, `declare_schema` creates an index for `belongs_to` relations. If this default index is not desired,
+you can use `index: false` in the `belongs_to` expression. This may be the case if for example a different index
+already accounts for it.
+
+## The `has_and_belongs_to_many` Association
+Like the `belongs_to` association, `has_and_belongs_to_many` is outside of the `declare_schema ` block. `declare_schema` similarly
+infers foreign keys (and the intersection table).
+
+## Ignored Tables
+If a table's schema or metadata are managed elsewhere, `declare_schema` probably should not alter it. Accordingly,
+`declare_schema` can be configured to ignore tables.
+
+`declare_schema` by default ignores these tables:
+- The ActiveRecord `schema_info` table
+- The ActiveRecord schema migrations table (generally named `schema_migrations`)
+- The ActiveRecord internal metadata table (generally named `ar_internal_metadata`)
+- If defined/configured, the CGI ActiveRecordStore session table
+
+Additional tables can be ignored by configuring `Generators::DeclareSchema::Migration::Migrator.ignore_tables`.
+For example:
+
+```ruby
+::Generators::DeclareSchema::Migration::Migrator.ignore_tables = [
+  "delayed_jobs",
+  "my_snowflake_table",
+  ...
+]
+```
+
 ## Declaring Character Set and Collation
 _Note: This feature currently only works for MySQL database configurations._
 

data/lib/declare_schema/model.rb

@@ -227,7 +227,7 @@ module DeclareSchema
         validates_uniqueness_of name, allow_nil: !:required.in?(args) if :unique.in?(args)
 
         if (validates_options = options[:validates])
-          validates name, validates_options
+          validates(name, **validates_options)
         end
 
         # Support for custom validations

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "1.2.1"
+  VERSION = "1.2.2.pre.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2.pre.0
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-25 00:00:00.000000000 Z
+date: 2023-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -127,7 +127,7 @@ homepage: https://github.com/Invoca/declare_schema
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Database schema declaration and migration generator for Rails
 test_files: []