model_driven_api 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f0f44e2c1015c731953af0fd3f2e05128e5e8d2493775a7788bd8ecab306f49
-  data.tar.gz: 2fd0bb9b281db660563a58890d7c287e5589043e32e5d5b1b30a828b6103f563
+  metadata.gz: d0955834f57dc25b51a326caf3a64d2da728c635eacb2b01cf1e9f656e559ea5
+  data.tar.gz: 677af97d19ed54c6cba486f0d99bce4736e4e06e3f916c4d0c896a13eef8c865
 SHA512:
-  metadata.gz: 5498cd511a63b1a8ac368015b4e10786518a80d030aa9b9c93656a1870bda7c677076559e3b1061fec1a557dcab9faecc77a064b4b250f52598b1249dade435c
-  data.tar.gz: d3d2be5de0a1a2cc35a7db37b9cee0d8eaf8dbcb594e7b557bccda62354df909ba4258b70e9dd59f03ded31b73631a288e1acbdb1d0bd07c106847867cab7f8d
+  metadata.gz: 07f3a5338e772e90baf5687dc38b6b038b55b97da94bae909d544408767b67927da667507f3e84e52a80f4cc7ff26c275757d9700f1bbfb0ce8914784da206fd
+  data.tar.gz: ec926ebae3447ad6ba9f8231dd60b2992f75b2838b2b49be14378390fe63f99b0af3085f9759ea0e2d580477463fa10d092b651dc29452597f0801c420b4eb18

data/README.md

@@ -449,6 +449,22 @@ When composing `json_attrs` across multiple concerns, use `ModelDrivenApi.smart_
 self.json_attrs = ModelDrivenApi.smart_merge((json_attrs || {}), { only: [:id, :name] })
 ```
 
+### Default `json_attrs` — no `Api::ModelName` concern required
+
+A model doesn't need an explicit `Api::ModelName` concern just to get a working API shape.
+`ModelDrivenApiDefaultJsonAttrs` is registered into
+[`ThecoreBackendCommons::DefaultModuleRegistry`](../thecore_backend_commons/README.md#defaultmoduleregistry--shared-applicationrecordinherited-hook)
+and automatically `include`d into every `ApplicationRecord` subclass as it's defined, setting
+`self.json_attrs = { except: [] }` (every column, no `methods`, no sideloaded `include`) — the
+simplest safe default. A model with its own `Api::ModelName` concern (or `ModelDrivenApiUser`/
+`ModelDrivenApiRole`) is unaffected: that concern's `include` always runs after the default and
+freely overrides or merges on top of it via `ModelDrivenApi.smart_merge`. Only a model with no
+concern at all keeps the bare default.
+
+**Temporary dependency note**: this currently requires `thecore_backend_commons` from a Gemfile
+`git:` pin to its `release/3` branch, since the RubyGems release hasn't caught up with the
+registry yet — see this repo's `CLAUDE.md` for the exact commit/removal condition.
+
 ---
 
 ## Raw SQL endpoint

data/config/initializers/default_json_attrs_registration.rb

@@ -0,0 +1,18 @@
+require "concerns/model_driven_api_default_json_attrs"
+
+# Registers the generic default `json_attrs` module (ADR 0001) into
+# ThecoreBackendCommons's shared DefaultModuleRegistry so it is `include`d
+# into every `ApplicationRecord` subclass as it is defined.
+#
+# Installed from `config.to_prepare` -- not `config.after_initialize` -- for
+# the same reason `ThecoreBackendCommons::DefaultModuleRegistry.install!` is:
+# Rails runs `to_prepare` callbacks *before* `eager_load!`, so the module must
+# already be registered before eager loading defines every model class in
+# production. `to_prepare` also re-runs on every class reload in development;
+# `DefaultModuleRegistry.register` is idempotent for the same module object,
+# so re-running this block on reload is safe.
+Rails.application.configure do
+  config.to_prepare do
+    ThecoreBackendCommons::DefaultModuleRegistry.register(ModelDrivenApiDefaultJsonAttrs)
+  end
+end

data/lib/concerns/model_driven_api_default_json_attrs.rb

@@ -0,0 +1,51 @@
+# Registered into ThecoreBackendCommons::DefaultModuleRegistry (see
+# config/initializers/default_json_attrs_registration.rb) so it is
+# automatically `include`d into *every* `ApplicationRecord` subclass at
+# class-definition time -- not just the handful of named classes
+# (ModelDrivenApiUser, ModelDrivenApiRole, ...) that get a bespoke concern.
+#
+# See vendor/external/thecore/docs/adr/0001-application-record-defaults-over-generated-concerns.md
+# in the host app for the design rationale: default model behavior should
+# not require a generated per-model `Api::ModelName` concern file for the
+# no-customization case.
+#
+# A model that *does* need custom serialization still gets (or keeps) an
+# explicit `Api::ModelName` concern, `include`d directly in the model file
+# exactly as today -- because `ApplicationRecord.inherited` (which applies
+# this default) fires *before* the subclass's own body executes, that later
+# explicit `include` always runs after this default has already set
+# `json_attrs`, so it freely overrides (or, via `ModelDrivenApi.smart_merge`,
+# merges on top of) the default's value. See `ModelDrivenApiUser`/
+# `ModelDrivenApiRole` for that pattern.
+module ModelDrivenApiDefaultJsonAttrs
+  extend ActiveSupport::Concern
+
+  included do
+    ## DSL (AKA what to show in the returned JSON)
+    # Use self.json_attrs to drive json rendering for
+    # API model responses (index, show and update ones).
+    # For reference:
+    # https://api.rubyonrails.org/classes/ActiveModel/Serializers/JSON.html
+    # The object passed accepts only these keys:
+    # - only: list [] of model field names in symbol notation to be shown in JSON
+    #       serialization.
+    # - except: exclude these fields from the JSON serialization, is a list []
+    #        of model field names in symbol notation.
+    # - methods: include the result of some methods defined in the model (virtual
+    #       fields).
+    # - include: include associated models, it's a list [] of hashes {} which also
+    #       accepts the [:only, :except, :methods, :include] keys.
+    #
+    # Default shape: no `only`/`except` restriction beyond the empty array
+    # below (so every column is serialized), no `methods`, no `include` (no
+    # associations sideloaded) -- the simplest safe default for a model that
+    # has no customization needs. `cattr_accessor` (not a plain method
+    # definition) is required so `json_attrs` lands as an *own* method on
+    # each concrete model class -- `Api::V2::InfoController#schema`/`#dsl`
+    # check `instance_methods(false).include?(:json_attrs)` while walking
+    # `ApplicationRecord.subclasses`, and a merely-inherited method would
+    # silently fail that check and drop the model from introspection output.
+    cattr_accessor :json_attrs
+    self.json_attrs = { except: [] }
+  end
+end

data/lib/model_driven_api/version.rb

@@ -1,3 +1,3 @@
 module ModelDrivenApi
-  VERSION = "3.8.0".freeze
+  VERSION = "3.9.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: model_driven_api
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.9.0
 platform: ruby
 authors:
 - Gabriele Tassoni
@@ -195,6 +195,7 @@ files:
 - config/initializers/after_initialize_for_model_driven_api.rb
 - config/initializers/auto_include_json.rb
 - config/initializers/cors_api_thecore.rb
+- config/initializers/default_json_attrs_registration.rb
 - config/initializers/knock.rb
 - config/initializers/time_with_zone.rb
 - config/initializers/wrap_parameters.rb
@@ -210,6 +211,7 @@ files:
 - lib/api/v3/serializer_factory.rb
 - lib/concerns/api_exception_management.rb
 - lib/concerns/model_driven_api_application_record.rb
+- lib/concerns/model_driven_api_default_json_attrs.rb
 - lib/concerns/model_driven_api_push_message.rb
 - lib/concerns/model_driven_api_push_subscriber.rb
 - lib/concerns/model_driven_api_role.rb