dynamic-active-model-rails 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43872099a56630aa1567fb6248215698f2da52769fb0141ee6456c7d7e2fed9e
-  data.tar.gz: af832465a2d51f2f719b6ca1ad5c47bd2a41645c7b194fc6b3809bcfdea41984
+  metadata.gz: 2df8e51695a6a96f2fc32f697985e96e6ae201bf52af9acffad5877d25128751
+  data.tar.gz: 3ac8715b733383d6160bf229cb234b0df74e6edb1c9220d2caeb95132e1292db
 SHA512:
-  metadata.gz: 82234b92ca1348e4b2e2465832484e15a6986a6079d175714a473b8b74393bb415ac68450d96c9664fec28f549ead1f7a49914aa6570bb61927aef3d63e304bd
-  data.tar.gz: c4b8cb05fcc0d1a5bcfed45788351064cb2d693e4e2013245ee4bd18d177cbd558e6ee9b4b50d80e719d5d1a1c0e75ddc01b309a20509ef86e322bd1d35671b1
+  metadata.gz: b605039cf58e47a07283d309dcc0dcbabe890314f94ee6c881b1825c26d6714ecbbc00814e119d14fcf7f3ca54b082a4ec7a1592005e39e556b57a155f5337e7
+  data.tar.gz: 660965617e683a0ae03a1b1f053590262953d5ea6cb664eeff623c6daeff5b16ed6ab41eb8b7eacdbc07c072657ee6e18fc532254a60c50258397ae721f121b5

data/README.md

@@ -78,6 +78,8 @@ The `cars_db` → `CarsDB` mapping is registered with the Rails autoloader only,
 | `module_name:` | `"<Name>DB"` | Namespace override. |
 | `parent_class:` | `'ApplicationRecord'` | Superclass of the generated abstract base class, given as a name so it can be reloaded. |
 | `connects_to:` | `nil` | Roles for Rails multi-database support, such as `{ writing: :cars, reading: :cars_replica }`, or `connects_to`'s own arguments (`{ database: ..., shards: ... }`). Can't be combined with a `connection`. |
+| `foreign_key_constraints:` | `false` | Also derive associations from the database's foreign key constraints. This catches columns like `posts.author_id → users` and self-references, and costs one query per table at build time. See the core README. |
+| `has_many_through:` | `false` | Add `has_many :through` across join models: tables with a unique index on two foreign keys, such as `user_roles`. See the core README. |
 | `extensions_path:` | `app/models/<folder>` | Directory of extension files, absolute or relative to `Rails.root`. The default folder may be absent; a configured path must exist. |
 | `extensions_suffix:` | `'.ext.rb'` | Suffix of extension files. The autoloader ignores files with this suffix. |
 

data/lib/dynamic-active-model/rails/database_definition.rb

@@ -29,6 +29,12 @@ module DynamicActiveModel
       # @return [Hash, nil] Keyword arguments for the base class's connects_to
       attr_reader :connects_to
 
+      # @return [Boolean] Whether to also relate columns through foreign key constraints
+      attr_reader :foreign_key_constraints
+
+      # @return [Boolean] Whether to also add has_many :through across join models
+      attr_reader :has_many_through
+
       # @return [Hash] Custom relationship names by table and foreign key
       attr_reader :relationships
 
@@ -44,13 +50,19 @@ module DynamicActiveModel
       # @param extensions_suffix [String] File suffix of extension files
       # @param connects_to [Hash, nil] Roles ({ writing: :cars, reading: :cars_replica }) or
       #   connects_to's own arguments ({ database: ..., shards: ... })
+      # @param foreign_key_constraints [Boolean] Also relate columns through the database's
+      #   foreign key constraints
+      # @param has_many_through [Boolean] Also add has_many :through across join models
       # @raise [ArgumentError] If both a connection and connects_to are given
       def initialize(name, connection = nil, module_name: nil, parent_class: 'ApplicationRecord',
-                     extensions_path: nil, extensions_suffix: '.ext.rb', connects_to: nil)
+                     extensions_path: nil, extensions_suffix: '.ext.rb', connects_to: nil,
+                     foreign_key_constraints: false, has_many_through: false)
         raise ArgumentError, 'pass either a connection or connects_to:, not both' if connection && connects_to
 
         @connection = connection
         @connects_to = connects_to && normalize_connects_to(connects_to)
+        @foreign_key_constraints = foreign_key_constraints
+        @has_many_through = has_many_through
         @module_name = module_name || default_module_name(name)
         @parent_class_name = parent_class.to_s
         @extensions_path = extensions_path&.to_s

data/lib/dynamic-active-model/rails/database_loader.rb

@@ -61,7 +61,9 @@ module DynamicActiveModel
       def build
         @database = new_database
         @database.create_models!
-        Explorer.build_relationships!(@database, definition.relationships)
+        Explorer.build_relationships!(@database, definition.relationships,
+                                      foreign_key_constraints: definition.foreign_key_constraints,
+                                      has_many_through: definition.has_many_through)
         load_extensions
         ActiveSupport.run_load_hooks(definition.load_hook, @database)
       rescue StandardError

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamic-active-model-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Doug Youch
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement