jbuilder-schema 2.6.8 → 2.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f75cc13caa4465745a822b1bd1d7e66899fa1bb2387457d1e638ba1df9e360a
-  data.tar.gz: 6ec03326e02493379e9e97e2c9d50eac1f1bfb4a4cc340c1e3941774cddde6c6
+  metadata.gz: dc6b74ad43767a8a12d27263b224beb94b8a3aa4deab865e81fb2753ff367718
+  data.tar.gz: 03243e798c0e28991c926b52b90d448b79d7f66aa0f59b997d9fd384b5d4bd28
 SHA512:
-  metadata.gz: 9704440704b61701c9b3852a97b86b4dbed7e4456e8fbf37934cab3978690d41fe4fd9c7fa786ef1479da9c3b8be53e67cc0a05516073481f21eaabeb864921a
-  data.tar.gz: b875004bb14f11ba6eed4a8f1ca77675bb7b2484e5c97676943fb21fe1023aedb8b263476191517b45f89ab7c15bd2c2f1a1e97e1a2082bc002f7734454ed310
+  metadata.gz: aaa65e842309918131ba5ae7f01f2063dcd9312505d9677a1037bab01801b8eab1865b8cd00daeca3712cbf367dd5494526939468623b4b1af706c86ac6c5751
+  data.tar.gz: a12318b8132a8a6edca71fcfe746dc6a757afe7a105405c17ca9ba22683ad7ebd51c4978bad692ab90c81f14d242ebf0dba016d6ff4e9fc039cc9b816ed007e5

data/README.md

@@ -1,6 +1,6 @@
 # Jbuilder::Schema
 
-Easily Generate JSON Schemas from Jbuilder Templates for OpenAPI 3.1
+Easily Generate OpenAPI 3.1 Schemas from Jbuilder Templates
 
 ## Quick Start
 
@@ -321,14 +321,18 @@ en:
 
 Configure Jbuilder::Schema in `config/initializers/jbuilder_schema.rb`:
 
+The `title_name` and `description_name` parameters can accept either a single string or an array of strings. This feature provides the flexibility to specify fallback keys.
+
 ```ruby
 Jbuilder::Schema.configure do |config|
-  config.components_path = "components/schemas"   # could be "definitions/schemas"
-  config.title_name = "title"                     # could be "label"
-  config.description_name = "description"         # could be "heading"
+  config.components_path = "components/schemas" # could be "definitions/schemas"
+  config.title_name = "title" # could be "label", or an array to support fallbacks, like
+  config.description_name = %w[api_description description] # could be just string as well like "heading"
 end
 ```
 
+With this configuration, the system will first try to find a translation for <underscored_plural_model_name>.fields.<field_name>.api_description. If it doesn't find a translation for this key, it will then attempt to find a translation for <underscored_plural_model_name>.fields.<field_name>.description.
+
 ### Integration with RSwag
 
 Use `yaml`/`json` methods in your `swagger_helper.rb` for Swagger documentation:

data/lib/jbuilder/schema/template.rb

@@ -30,25 +30,39 @@ class Jbuilder::Schema
       end
 
       def title
-        super || translate(Jbuilder::Schema.title_name)
+        super || translate(title_keys)
       end
 
       def description
-        super || translate(Jbuilder::Schema.description_name)
+        super || translate(description_keys)
       end
 
       def translate_title(key)
-        translate("fields.#{key}.#{Jbuilder::Schema.title_name}")
+        translate(title_keys.map { |k| "fields.#{key}.#{k}" })
       end
 
       def translate_description(key)
-        translate("fields.#{key}.#{Jbuilder::Schema.description_name}")
+        translate(description_keys.map { |k| "fields.#{key}.#{k}" })
       end
 
       private
 
-      def translate(key)
-        I18n.t(key, scope: @scope ||= object&.class&.name&.underscore&.pluralize)
+      def translate(keys)
+        keys.each do |key|
+          translation = I18n.t(key, scope: @scope ||= object&.class&.name&.underscore&.pluralize, default: nil)
+          return translation if translation.present?
+        end
+        # FIXME: This produces `addresses/countries` for namespaced models.
+        # Should be probably `addresses.countries`
+        I18n.t(keys.first, scope: @scope ||= object&.class&.model_name&.collection)
+      end
+
+      def title_keys
+        Array(Jbuilder::Schema.title_name)
+      end
+
+      def description_keys
+        Array(Jbuilder::Schema.description_name)
       end
     end
 
@@ -197,7 +211,7 @@ class Jbuilder::Schema
       overrides = @schema_overrides&.dig(key)&.to_h || {}
       return unless overrides.any? || @configuration.object
 
-      value[:title] ||= overrides[:title] if overrides&.key?(:title)
+      value[:title] ||= overrides[:title] if overrides.key?(:title)
       value[:description] ||= overrides[:description] || @configuration.translate_description(key)
     end
 

data/lib/jbuilder/schema/version.rb

@@ -1,4 +1,4 @@
 # We can't use the standard `Jbuilder::Schema::VERSION =` because
 # `Jbuilder` isn't a regular module namespace, but a class …which also loads Active Support.
 # So we use trickery, and assign the proper version once `jbuilder/schema.rb` is loaded.
-JBUILDER_SCHEMA_VERSION = "2.6.8"
+JBUILDER_SCHEMA_VERSION = "2.6.9"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder-schema
 version: !ruby/object:Gem::Version
-  version: 2.6.8
+  version: 2.6.9
 platform: ruby
 authors:
 - Yuri Sidorov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-06 00:00:00.000000000 Z
+date: 2024-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jbuilder
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Generate JSON Schema from Jbuilder files