jbuilder-schema 2.0.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aea259ba4965ec62874b56ab4267ddc2f4cd2967babe536726397c53599c922
-  data.tar.gz: 71c9f200fb4cc481055ec0790e514b9a46108a6ae4cb0c0aad1ed09eba5f384e
+  metadata.gz: 8e69ae6e6726679110d135c34a461a2bfc176f967bfa1777b73989ae107fdabc
+  data.tar.gz: 63fc234f84fe96195c6cc849bf26f4bea6d5e60808a0363e4fdddfe778497292
 SHA512:
-  metadata.gz: d0ac95a76f5630daad73debfd74f6056dd3e6b4f30e4075779a41306585d211c918d16140de6f32b01a60db3303ac21e1ccdf8c52b9ea4292e32c38a134e1e21
-  data.tar.gz: d88181a3d13d3748cfca995bbcc9de741bb9d5ecf98bd34af452b499aaeae2c0a6c44c5fc57ea88ee3892a2b6c2579f65a3310f1b59a83805067422ea20956c3
+  metadata.gz: 2fcc3260655ff07670c2a8be5175c801f29af27790e0675c680fc861bae3a2a48dcd30170cb5468e595ec647d58c9abe92d2177f7c5dc77acdb8569f8ab7997e
+  data.tar.gz: ca344a595d3ed5c43c602e5d24ca154c4e0b9872388bd055422c957af93891be133618651e423f560ccc419b66c8b068828202f68929161d0790c4efbf71c8cb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jbuilder-schema (2.0.4)
+    jbuilder-schema (2.1.0)
       jbuilder
       rails (>= 5.0.0)
 
@@ -77,7 +77,7 @@ GEM
     builder (3.2.4)
     concurrent-ruby (1.1.10)
     crass (1.0.6)
-    erubi (1.11.0)
+    erubi (1.12.0)
     globalid (1.0.0)
       activesupport (>= 5.0)
     i18n (1.12.0)
@@ -86,7 +86,7 @@ GEM
       actionview (>= 5.0.0)
       activesupport (>= 5.0.0)
     json (2.6.2)
-    loofah (2.19.0)
+    loofah (2.19.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.8.0)
@@ -98,13 +98,13 @@ GEM
     method_source (1.0.0)
     mini_mime (1.1.2)
     mini_portile2 (2.8.0)
-    minitest (5.16.3)
+    minitest (5.17.0)
     mocha (1.14.0)
     net-imap (0.3.1)
       net-protocol
     net-pop (0.1.2)
       net-protocol
-    net-protocol (0.2.0)
+    net-protocol (0.2.1)
       timeout
     net-smtp (0.3.3)
       net-protocol
@@ -115,8 +115,8 @@ GEM
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
-    racc (1.6.1)
-    rack (2.2.4)
+    racc (1.6.2)
+    rack (2.2.5)
     rack-test (2.0.2)
       rack (>= 1.3)
     rails (7.0.4)
@@ -136,8 +136,8 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
+    rails-html-sanitizer (1.4.4)
+      loofah (~> 2.19, >= 2.19.1)
     railties (7.0.4)
       actionpack (= 7.0.4)
       activesupport (= 7.0.4)

data/lib/jbuilder/schema/renderer.rb

@@ -3,6 +3,7 @@ require_relative "template"
 
 class Jbuilder::Schema::Renderer
   @@view_renderer = ActionView::Base.with_empty_template_cache
+  @@view_renderer.prefix_partial_path_with_controller_namespace = false
 
   def initialize(paths, default_locals = nil)
     @view_renderer = @@view_renderer.with_view_paths(paths)
@@ -18,19 +19,25 @@ class Jbuilder::Schema::Renderer
   end
 
   def render(object = nil, title: nil, description: nil, assigns: nil, **options)
-    if object
-      partial_path = object.respond_to?(:to_partial_path_for_jbuilder_schema) ? object.to_partial_path_for_jbuilder_schema : object.to_partial_path
-      options.merge! partial: partial_path, object: object
-    end
+    @view_renderer.assign assigns if assigns
+
+    json = original_render(object || options.dup, options.dup)
+
+    partial_path = %i[to_partial_path_for_jbuilder_schema to_partial_path].map { object.public_send(_1) if object.respond_to?(_1) }.compact.first
+    options.merge! partial: partial_path, object: object if partial_path
 
     options[:locals] ||= {}
     options[:locals].merge! @default_locals if @default_locals
-    options[:locals][:__jbuilder_schema_options] = { model: object&.class, title: title, description: description }
+    options[:locals][:__jbuilder_schema_options] = { json: json, object: object, title: title, description: description }
 
-    @view_renderer.assign assigns if assigns
     @view_renderer.render(options)
   end
 
+  # Thin wrapper around the regular Jbuilder JSON output render, which also parses it into a hash.
+  def original_render(options = {}, locals = {})
+    JSON.parse @view_renderer.render(options, locals)
+  end
+
   private
 
   def normalize(schema)

data/lib/jbuilder/schema/template.rb

@@ -5,9 +5,6 @@ require "active_support/inflections"
 
 class Jbuilder::Schema
   class Template < ::JbuilderTemplate
-    attr_reader :attributes, :type
-    attr_reader :model_scope
-
     class Handler < ::JbuilderHandler
       def self.call(template, source = nil)
         super.sub("JbuilderTemplate.new(self", "Jbuilder::Schema::Template.build(self, local_assigns")
@@ -26,34 +23,33 @@ class Jbuilder::Schema
       end
     end
 
-    ModelScope = ::Struct.new(:model, :title, :description, keyword_init: true) do
-      def initialize(**)
-        super
-        @scope = model&.name&.underscore&.pluralize
+    class Configuration < ::Struct.new(:object, :title, :description, keyword_init: true)
+      def self.build(object: nil, object_title: nil, object_description: nil, **)
+        new(object: object, title: object_title, description: object_description)
       end
 
-      def i18n_title
-        title || ::I18n.t(::Jbuilder::Schema.title_name, scope: @scope)
+      def title
+        super || translate(Jbuilder::Schema.title_name)
       end
 
-      def i18n_description
-        description || ::I18n.t(::Jbuilder::Schema.description_name, scope: @scope)
+      def description
+        super || translate(Jbuilder::Schema.description_name)
       end
 
       def translate_field(key)
-        ::I18n.t("fields.#{key}.#{::Jbuilder::Schema.description_name}", scope: @scope)
+        translate("fields.#{key}.#{Jbuilder::Schema.description_name}")
       end
-    end
 
-    def initialize(context, **options)
-      @type = :object
-      @inline_array = false
-      @collection = false
-
-      @model_scope = ModelScope.new(**options)
+      private
+      def translate(key)
+        I18n.t(key, scope: @scope ||= object&.class&.name&.underscore&.pluralize)
+      end
+    end
 
+    def initialize(context, json: nil, **options)
+      @json = json
+      @configuration = Configuration.new(**options)
       super(context)
-
       @ignore_nil = false
     end
 
@@ -62,176 +58,112 @@ class Jbuilder::Schema
     end
 
     def schema!
-      {type: type}.merge(type == :object ? _object(**attributes.merge) : attributes)
+      if ([@attributes] + @attributes.each_value.grep(::Hash)).any? { _1[:type] == :array && _1.key?(:items) }
+        @attributes
+      else
+        _object(@attributes)
+      end.merge(example: @json).compact
     end
 
-    def set!(key, value = BLANK, *args, schema: {}, **options, &block)
-      result = if block
-        if !_blank?(value)
-          # OBJECTS ARRAY:
-          # json.comments @article.comments { |comment| ... }
-          # { "comments": [ { ... }, { ... } ] }
-          _scope { array! value, &block }
-        else
-          # BLOCK:
-          # json.comments { ... }
-          # { "comments": ... }
-          @inline_array = true
-
-          _with_model_scope(**schema) do
-            _merge_block(key) { yield self }
-          end
-        end
-      elsif args.empty?
-        if ::Jbuilder === value
-          # ATTRIBUTE1:
-          # json.age 32
-          # json.person another_jbuilder
-          # { "age": 32, "person": { ...  }
-          _schema(key, _format_keys(value.attributes!), **schema)
-        elsif _is_collection_array?(value)
-          # ATTRIBUTE2:
-          _scope { array! value }
-        # json.articles @articles
-        else
-          # json.age 32
-          # { "age": 32 }
-          _schema(key, _format_keys(value), **schema)
-        end
-      elsif _is_collection?(value)
-        # COLLECTION:
-        # json.comments @article.comments, :content, :created_at
-        # { "comments": [ { "content": "hello", "created_at": "..." }, { "content": "world", "created_at": "..." } ] }
-        @inline_array = true
-        @collection = true
-
-        _scope { array! value, *args }
-      else
-        # EXTRACT!:
-        # json.author @article.creator, :name, :email_address
-        # { "author": { "name": "David", "email_address": "david@loudthinking.com" } }
-        _with_model_scope(**schema) do
-          _merge_block(key) { extract! value, *args, schema: schema }
-        end
-      end
+    def set!(key, value = BLANK, *args, schema: nil, **options, &block)
+      old_configuration, @configuration = @configuration, Configuration.build(**schema) if schema&.dig(:object)
 
-      result = _set_description key, result if model_scope.model
-      _set_value key, result
-    end
+      _with_schema_overrides(key => schema) do
+        keys = args.presence || _extract_possible_keys(value)
 
-    def extract!(object, *attributes, schema: {})
-      if ::Hash === object
-        _extract_hash_values(object, attributes, schema: schema)
-      else
-        _extract_method_values(object, attributes, schema: schema)
+        # Detect `json.articles user.articles` to override Jbuilder's logic, which wouldn't hit `array!` and set a `type: :array, items: {"$ref": "#/components/schemas/article"}` ref.
+        if block.nil? && keys.blank? && _is_collection?(value) && (value.empty? || value.all? { _is_active_model?(_1) })
+          _set_value(key, _scope { _set_ref(key.to_s.singularize, array: true) })
+        else
+          super(key, value, *keys, **options, &block)
+        end
       end
+    ensure
+      @configuration = old_configuration if old_configuration
     end
+    alias_method :method_missing, :set! # TODO: Remove once Jbuilder passes keyword arguments along to `set!` in its `method_missing`.
 
-    def array!(collection = [], *args, schema: {}, **options, &block)
+    def array!(collection = [], *args, schema: nil, **options, &block)
       if _partial_options?(options)
-        @collection = true
-        _set_ref(options[:partial].split("/").last)
+        partial!(collection: collection, **options)
       else
-        array = _make_array(collection, *args, schema: schema, &block)
-
-        if @inline_array
-          @attributes = {}
-          _set_value(:type, :array)
-          _set_value(:items, array)
-        elsif _is_collection_array?(array)
-          @attributes = {}
-          @inline_array = true
-          @collection = true
-          array! array, *array.first&.attribute_names(&:to_sym)
-        else
-          @type = :array
-          @attributes = {}
-          _set_value(:items, array)
+        _with_schema_overrides(schema) do
+          _attributes.merge! type: :array, items: _scope { super(collection, *args, &block) }
         end
       end
     end
 
-    def partial!(*args)
-      if args.one? && _is_active_model?(args.first)
+    def extract!(object, *attributes, schema: nil)
+      _with_schema_overrides(schema) { super(object, *attributes) }
+    end
+
+    def partial!(model = nil, *args, partial: nil, collection: nil, **options)
+      if args.none? && _is_active_model?(model)
         # TODO: Find where it is being used
-        _render_active_model_partial args.first
-      elsif args.first.is_a?(::Hash)
-        _set_ref(args.first[:partial].split("/").last)
+        _render_active_model_partial model
       else
-        @collection = true if args[1].key?(:collection)
-        _set_ref(args.first&.split("/")&.last)
+        _set_ref(partial || model, array: collection&.any?)
       end
     end
 
     def merge!(object)
-      hash_or_array = ::Jbuilder === object ? object.attributes! : object
-      hash_or_array = _format_keys(hash_or_array)
-      if hash_or_array.is_a?(::Hash)
-        hash_or_array = hash_or_array.each_with_object({}) do |(key, value), a|
-          result = _schema(key, value)
-          result = _set_description(key, result) if model_scope.model
-          a[key] = result
-        end
-      end
-      @attributes = _merge_values(@attributes, hash_or_array)
+      object = object.to_h { [_1, _schema(_1, _2)] } if object.is_a?(::Hash)
+      super
     end
 
     def cache!(key = nil, **options)
       yield # TODO: Our schema generation breaks Jbuilder's fragment caching.
     end
 
-    def method_missing(*args, **options, &block) # standard:disable Style/MissingRespondToMissing
-      # TODO: Remove once Jbuilder passes keyword arguments along to `set!` in its `method_missing`.
-      set!(*args, **options, &block)
-    end
-
     private
 
-    def _with_model_scope(object: nil, object_title: nil, object_description: nil, **)
-      old_model_scope, @model_scope = @model_scope, ModelScope.new(model: object.class, title: object_title, description: object_description) if object
+    def _extract_possible_keys(value)
+      value.first.as_json.keys if _is_collection?(value) && _is_active_model?(value.first)
+    end
+
+    def _with_schema_overrides(overrides)
+      old_schema_overrides, @schema_overrides = @schema_overrides, overrides if overrides
       yield
     ensure
-      @model_scope = old_model_scope if object
+      @schema_overrides = old_schema_overrides if overrides
     end
 
-    def _object(**attributes)
+    def _object(attributes)
       {
         type: :object,
-        title: model_scope.i18n_title,
-        description: model_scope.i18n_description,
+        title: @configuration.title,
+        description: @configuration.description,
         required: _required!(attributes.keys),
         properties: attributes
       }
     end
 
     def _set_description(key, value)
-      unless value.key?(:description)
-        description = model_scope.translate_field(key)
-        value = {description: description}.merge! value
+      if !value.key?(:description) && @configuration.object
+        value[:description] = @configuration.translate_field(key)
       end
-      value
     end
 
-    def _set_ref(component)
-      component_path = "#/#{::Jbuilder::Schema.components_path}/#{component}"
+    def _set_ref(part, array: false)
+      ref = {"$ref": "#/#{::Jbuilder::Schema.components_path}/#{part.split("/").last}"}
 
-      if @inline_array
-        if @collection
-          _set_value(:type, :array)
-          _set_value(:items, {:$ref => component_path})
-        else
-          _set_value(:type, :object)
-          _set_value(:$ref, component_path)
-        end
+      if array
+        _attributes.merge! type: :array, items: ref
       else
-        @type = :array
-        _set_value(:items, {:$ref => component_path})
+        _attributes.merge! type: :object, **ref
       end
     end
 
+    def _attributes
+      @attributes = {} if _blank?
+      @attributes
+    end
+
     FORMATS = {::DateTime => "date-time", ::ActiveSupport::TimeWithZone => "date-time", ::Date => "date", ::Time => "time"}
 
     def _schema(key, value, **options)
+      options = @schema_overrides&.dig(key).to_h if options.empty?
+
       unless options[:type]
         options[:type] = _primitive_type value
 
@@ -243,10 +175,11 @@ class Jbuilder::Schema
         format = FORMATS[value.class] and options[:format] ||= format
       end
 
-      if (model = model_scope.model) && (defined_enum = model.try(:defined_enums)&.dig(key.to_s))
+      if (klass = @configuration.object&.class) && (defined_enum = klass.try(:defined_enums)&.dig(key.to_s))
         options[:enum] = defined_enum.keys
       end
 
+      _set_description key, options
       options
     end
 
@@ -261,24 +194,14 @@ class Jbuilder::Schema
       end
     end
 
-    def _make_array(collection, *args, schema: {}, &block)
-      if collection.nil?
-        []
-      elsif block
-        _map_collection(collection, &block)
-      elsif args.any?
-        _map_collection(collection) { |element| extract! element, *args, schema: schema }
-      else
-        _format_keys(collection.to_a)
-      end
-    end
-
-    def _is_collection_array?(object)
-      object.is_a?(::Array) && object.all? { _is_active_model? _1 }
+    def _set_value(key, value)
+      value = _schema(key, value) unless value.is_a?(::Hash) && value.key?(:type)
+      _set_description(key, value)
+      super
     end
 
     def _required!(keys)
-      presence_validated_attributes = model_scope.model.try(:validators).to_a.flat_map { _1.attributes if _1.is_a?(::ActiveRecord::Validations::PresenceValidator) }
+      presence_validated_attributes = @configuration.object&.class.try(:validators).to_a.flat_map { _1.attributes if _1.is_a?(::ActiveRecord::Validations::PresenceValidator) }
       keys & [_key(:id), *presence_validated_attributes.map { _key _1 }]
     end
 
@@ -286,22 +209,6 @@ class Jbuilder::Schema
     # Jbuilder methods
     ###
 
-    def _extract_hash_values(object, attributes, schema:)
-      attributes.each do |key|
-        result = _schema(key, _format_keys(object.fetch(key)), **schema[key] || {})
-        result = _set_description(key, result) if model_scope.model
-        _set_value key, result
-      end
-    end
-
-    def _extract_method_values(object, attributes, schema:)
-      attributes.each do |key|
-        result = _schema(key, _format_keys(object.public_send(key)), **schema[key] || {})
-        result = _set_description(key, result) if model_scope.model
-        _set_value key, result
-      end
-    end
-
     def _map_collection(collection)
       super.first
     end
@@ -311,20 +218,8 @@ class Jbuilder::Schema
       raise NullError.build(key) if current_value.nil?
 
       value = _scope { yield self }
-      value = _object(**value) unless value.values_at("type", :type).any?(:array) || value.key?(:$ref) || value.key?("$ref")
+      value = _object(value) unless value[:type] == :array || value.key?(:$ref)
       _merge_values(current_value, value)
     end
   end
 end
-
-class Jbuilder
-  module SkipFormatting
-    SCHEMA_KEYS = %i[type items properties]
-
-    def format(key)
-      SCHEMA_KEYS.include?(key) ? key : super
-    end
-  end
-
-  KeyFormatter.prepend SkipFormatting
-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.0.4"
+JBUILDER_SCHEMA_VERSION = "2.1.0"

data/lib/jbuilder/schema.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/module/delegation"
+require "jbuilder"
 require "jbuilder/schema/version"
+require "active_support/core_ext/module/delegation"
 
 class Jbuilder::Schema
-  VERSION = "2.0.3" # TODO Fix this. It's throwing errors when including the Ruby gem in downstream projects.
+  VERSION = JBUILDER_SCHEMA_VERSION # See `jbuilder/schema/version.rb`
 
   module IgnoreSchemaMeta
     ::Jbuilder.prepend self
@@ -12,6 +13,18 @@ class Jbuilder::Schema
     def method_missing(*args, schema: nil, **options, &block) # standard:disable Style/MissingRespondToMissing
       super(*args, **options, &block)
     end
+
+    def set!(*args, schema: nil, **options, &block)
+      super(*args, **options, &block)
+    end
+
+    def array!(*args, schema: nil, **options, &block)
+      super(*args, **options, &block)
+    end
+
+    def extract!(*args, schema: nil, **options, &block)
+      super(*args, **options, &block)
+    end
   end
 
   singleton_class.alias_method :configure, :tap

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder-schema
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Yuri Sidorov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-07 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jbuilder
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.16
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Generate JSON Schema from Jbuilder files