jbuilder-schema 2.3.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e54563767a015e7b3cb32a86f99155d08c90d317ad6c89f79d7634b3a428993
-  data.tar.gz: d65a34bc554e7d1416b5e9cb0fd0d32b1c26454506ec5148ad7343f001c0bce4
+  metadata.gz: 7b91da7438556fc92910dbf0f50ac15c54f62593985f1baacb9d1cda87c09e2e
+  data.tar.gz: bd9e173ce9473d32ca6c3a62d0af33411e76782a927c6ec6b0542a23a8f340dc
 SHA512:
-  metadata.gz: 11a516b42e9d28a515e504a59b5f51916d5e8ba74211dda0bad5eea11e0fae80af546e442e4b71274efce5bb555d2c5d6fd453ee342a966c03fa2f50f72e6fe0
-  data.tar.gz: a1f2a4c564bdb28b6a8ef72b5fc345fcaac03885cc8819763b9a61139b2ab468472a9ec7494b7a3c2bcab311092a754e8f30521ebbcd2c1807bc515814d371f1
+  metadata.gz: d5be408235c5190215d78d4d5946f4bb3a28becd80ccbb3a727225efc5f9c48f48903b8ed719296b344bcbf648f9a0d9a2e93ccedf4e475e4e874ca7142b6fa0
+  data.tar.gz: 89775b8f6a5819561eb33c8e0af6847167db2de6c0f719981de6bf393e072234fd36baf763dace85e773c5cd761dc93781c81c2a7548f19811111cefa24114e6

data/Gemfile

@@ -12,3 +12,13 @@ gem "sqlite3"
 gem "standard", "~> 1.3"
 
 gem "mocha"
+
+rails_version = ENV.fetch("RAILS_VERSION", "7.0")
+
+rails_constraint = if rails_version == "main"
+  {github: "rails/rails"}
+else
+  "~> #{rails_version}.0"
+end
+
+gem "rails", rails_constraint

data/lib/jbuilder/schema/renderer.rb

@@ -37,7 +37,9 @@ class Jbuilder::Schema::Renderer
     options[:locals].merge! @default_locals if @default_locals
     options[:locals][:__jbuilder_schema_options] = {json: json, object: object, title: title, description: description}
 
-    @view_renderer.render(options)
+    @view_renderer.render(options).then do |result|
+      result.respond_to?(:unwrap_target!) ? result.unwrap_target! : result
+    end
   end
 
   # Thin wrapper around the regular Jbuilder JSON output render, which also parses it into a hash.

data/lib/jbuilder/schema/template.rb

@@ -2,6 +2,7 @@
 
 require "jbuilder/jbuilder_template"
 require "active_support/inflections"
+require "method_source"
 
 class Jbuilder::Schema
   class Template < ::JbuilderTemplate
@@ -52,18 +53,28 @@ class Jbuilder::Schema
       @configuration = Configuration.new(**options)
       super(context)
       @ignore_nil = false
+      @within_block = false
+    end
+
+    class TargetWrapper
+      def initialize(object)
+        @object = object
+      end
+
+      # Rails 7.1 calls `to_s` on our `target!` (the return value from our templates).
+      # To get around that and let our inner Hash through, we add this override.
+      # `unwrap_target!` is added for backwardscompatibility so we get the inner Hash on Rails < 7.1.
+      def to_s
+        @object
+      end
+      alias_method :unwrap_target!, :to_s
     end
 
     def target!
-      schema!
+      TargetWrapper.new(schema!)
     end
 
     def schema!
-      # TODO: Not sure why it was like that, when it was meant to be used,
-      # but that seems to fix the problem with disappearance of root properties
-      # https://github.com/bullet-train-co/jbuilder-schema/issues/46
-      # if ([@attributes] + @attributes.each_value.grep(::Hash)).any? { _1[:type] == :array && _1.key?(:items) }
-
       if [@attributes, *@attributes.first].select { |a| a.is_a?(::Hash) && a[:type] == :array && a.key?(:items) }.any?
         @attributes
       else
@@ -73,6 +84,7 @@ class Jbuilder::Schema
 
     def set!(key, value = BLANK, *args, schema: nil, **options, &block)
       old_configuration, @configuration = @configuration, Configuration.build(**schema) if schema&.dig(:object)
+      @within_block = _within_block?(&block)
 
       _with_schema_overrides(key => schema) do
         keys = args.presence || _extract_possible_keys(value)
@@ -88,6 +100,7 @@ class Jbuilder::Schema
       end
     ensure
       @configuration = old_configuration if old_configuration
+      @within_block = false
     end
 
     alias_method :method_missing, :set! # TODO: Remove once Jbuilder passes keyword arguments along to `set!` in its `method_missing`.
@@ -96,10 +109,14 @@ class Jbuilder::Schema
       if _partial_options?(options)
         partial!(collection: collection, **options)
       else
+        @within_block = _within_block?(&block)
+
         _with_schema_overrides(schema) do
           _attributes.merge! type: :array, items: _scope { super(collection, *args, &block) }
         end
       end
+    ensure
+      @within_block = false
     end
 
     def extract!(object, *attributes, schema: nil)
@@ -114,7 +131,12 @@ class Jbuilder::Schema
         local = options.except(:partial, :as, :collection, :cached, :schema).first
         as = options[:as] || ((local.is_a?(::Array) && local.size == 2 && local.first.is_a?(::Symbol) && local.last.is_a?(::Object)) ? local.first.to_s : nil)
 
-        _set_ref(as&.to_s || partial || model, array: collection&.any?)
+        if @within_block || collection.present?
+          _set_ref(as&.to_s || partial || model, array: collection&.any?)
+        else
+          json = ::Jbuilder::Schema.renderer.original_render partial: model || partial, locals: options
+          json.each { |key, value| set!(key, value) }
+        end
       end
     end
 
@@ -240,5 +262,15 @@ class Jbuilder::Schema
       value = _object(value, _required!(value.keys)) unless value[:type] == :array || value.key?(:$ref)
       _merge_values(current_value, value)
     end
+
+    def _within_block?(&block)
+      block.present? && _one_line?(block.source)
+    end
+
+    def _one_line?(text)
+      text = text.gsub("{", " do\n").gsub("}", "\nend").tr(";", "\n")
+      lines = text.lines[1..-2].reject { |line| line.strip.empty? || line.strip.start_with?("#") }
+      lines.size == 1
+    end
   end
 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.3.1"
+JBUILDER_SCHEMA_VERSION = "2.5.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder-schema
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Yuri Sidorov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-06 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jbuilder
@@ -31,9 +31,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,9 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
-    - - "<"
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Generate JSON Schema from Jbuilder files
 email:
 - hey@yurisidorov.com
@@ -53,7 +61,6 @@ extra_rdoc_files: []
 files:
 - ".standard.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,215 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jbuilder-schema (2.3.1)
-      jbuilder
-      rails (>= 5.0.0, < 7.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (7.0.8)
-      actionpack (= 7.0.8)
-      activesupport (= 7.0.8)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.8)
-      actionpack (= 7.0.8)
-      activejob (= 7.0.8)
-      activerecord (= 7.0.8)
-      activestorage (= 7.0.8)
-      activesupport (= 7.0.8)
-      mail (>= 2.7.1)
-      net-imap
-      net-pop
-      net-smtp
-    actionmailer (7.0.8)
-      actionpack (= 7.0.8)
-      actionview (= 7.0.8)
-      activejob (= 7.0.8)
-      activesupport (= 7.0.8)
-      mail (~> 2.5, >= 2.5.4)
-      net-imap
-      net-pop
-      net-smtp
-      rails-dom-testing (~> 2.0)
-    actionpack (7.0.8)
-      actionview (= 7.0.8)
-      activesupport (= 7.0.8)
-      rack (~> 2.0, >= 2.2.4)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.8)
-      actionpack (= 7.0.8)
-      activerecord (= 7.0.8)
-      activestorage (= 7.0.8)
-      activesupport (= 7.0.8)
-      globalid (>= 0.6.0)
-      nokogiri (>= 1.8.5)
-    actionview (7.0.8)
-      activesupport (= 7.0.8)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.8)
-      activesupport (= 7.0.8)
-      globalid (>= 0.3.6)
-    activemodel (7.0.8)
-      activesupport (= 7.0.8)
-    activerecord (7.0.8)
-      activemodel (= 7.0.8)
-      activesupport (= 7.0.8)
-    activestorage (7.0.8)
-      actionpack (= 7.0.8)
-      activejob (= 7.0.8)
-      activerecord (= 7.0.8)
-      activesupport (= 7.0.8)
-      marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
-    activesupport (7.0.8)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    base64 (0.1.1)
-    builder (3.2.4)
-    concurrent-ruby (1.2.2)
-    crass (1.0.6)
-    date (3.3.3)
-    erubi (1.12.0)
-    globalid (1.2.1)
-      activesupport (>= 6.1)
-    i18n (1.14.1)
-      concurrent-ruby (~> 1.0)
-    jbuilder (2.11.5)
-      actionview (>= 5.0.0)
-      activesupport (>= 5.0.0)
-    json (2.6.3)
-    language_server-protocol (3.17.0.3)
-    lint_roller (1.1.0)
-    loofah (2.21.3)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.12.0)
-    mail (2.8.1)
-      mini_mime (>= 0.1.1)
-      net-imap
-      net-pop
-      net-smtp
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.5)
-    mini_portile2 (2.8.4)
-    minitest (5.20.0)
-    mocha (2.1.0)
-      ruby2_keywords (>= 0.0.5)
-    net-imap (0.4.0)
-      date
-      net-protocol
-    net-pop (0.1.2)
-      net-protocol
-    net-protocol (0.2.1)
-      timeout
-    net-smtp (0.4.0)
-      net-protocol
-    nio4r (2.5.9)
-    nokogiri (1.15.4)
-      mini_portile2 (~> 2.8.2)
-      racc (~> 1.4)
-    parallel (1.23.0)
-    parser (3.2.2.4)
-      ast (~> 2.4.1)
-      racc
-    racc (1.7.1)
-    rack (2.2.8)
-    rack-test (2.1.0)
-      rack (>= 1.3)
-    rails (7.0.8)
-      actioncable (= 7.0.8)
-      actionmailbox (= 7.0.8)
-      actionmailer (= 7.0.8)
-      actionpack (= 7.0.8)
-      actiontext (= 7.0.8)
-      actionview (= 7.0.8)
-      activejob (= 7.0.8)
-      activemodel (= 7.0.8)
-      activerecord (= 7.0.8)
-      activestorage (= 7.0.8)
-      activesupport (= 7.0.8)
-      bundler (>= 1.15.0)
-      railties (= 7.0.8)
-    rails-dom-testing (2.2.0)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.0)
-      loofah (~> 2.21)
-      nokogiri (~> 1.14)
-    railties (7.0.8)
-      actionpack (= 7.0.8)
-      activesupport (= 7.0.8)
-      method_source
-      rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.1)
-    rexml (3.2.6)
-    rubocop (1.56.4)
-      base64 (~> 0.1.1)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.2.2.3)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.19.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    sqlite3 (1.6.6)
-      mini_portile2 (~> 2.8.0)
-    standard (1.31.1)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.56.2)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.2)
-    standard-custom (1.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.50)
-    standard-performance (1.2.0)
-      lint_roller (~> 1.1)
-      rubocop-performance (~> 1.19.0)
-    thor (1.2.2)
-    timeout (0.4.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
-    websocket-driver (0.7.6)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.6.12)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  jbuilder-schema!
-  mocha
-  rake (~> 13.0)
-  sqlite3
-  standard (~> 1.3)
-
-BUNDLED WITH
-   2.4.10