schemacop 3.0.37 → 3.0.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56a24074bd3792c20ee7e2f0bb1a8c3f4aa6d411a9a4c8010c9a52f0e828e6a3
-  data.tar.gz: ca4a752be493fe721122a77c5fb6844098c968dddf860fdcb0e33ef9a98880c3
+  metadata.gz: 4a3a54c489ac60b4a01424d7a4949724c15fdec793de16a4375e3097f691128b
+  data.tar.gz: 48390b41d456f5362ecabf0e97ed37fdc035247ec3d8335d105e97ab0d858378
 SHA512:
-  metadata.gz: da3e3672206befe40e6487677c6c879192a3fdaf450e3621566be86dd1ccc9c487571a70cf7f1933294d5de9cd86094791e22cd659109a97baa432917138f296
-  data.tar.gz: 69d79cf5ad0702b80f930a9227f9279c2f758b3cb51965596145d82ec735b0fe8bb6648f219b6c1858d82f8a339ccdc388db71c3767573a074562a063eefcade
+  metadata.gz: 911a618277694321833a85cc051ff139b14e9a1117dab7380bcc4c9ebc08e87a258f131224e1f3cef40d5b6495de6142f1b6f23009ce62917c8a07bf75960678
+  data.tar.gz: 1add721c851198435cf89b0b9d95d94c607bc443df180072fda1b35d4b956a4a2bdab429252f630fca8e4ddf09baf13153278d60f401318e0ad591bbc7c481b8

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change log
 
+## 3.0.38 (2026-02-25)
+
+* Fix namespaced schema `$ref` paths in generated JSON. For OpenAPI (swagger)
+  output, `/` and `~` in schema paths are replaced with `.` (e.g.
+  `namespaced/user` becomes `namespaced.user`) to comply with the OpenAPI schema
+  name format. For plain JSON Schema output, paths are escaped per RFC 6901
+  (`~0` for `~`, `~1` for `/`).
+
+  Internal reference: `#146922`.
+
+* Fix `CombinationNode` (`one_of`, `any_of`, `all_of`) not exposing its items
+  via `children`. This caused `used_external_schemas` to miss any `ref` nodes
+  nested inside combination nodes, leading to missing entries in
+  `components.schemas` in OpenAPI output.
+
+* Normalize `ReferenceNode` path to symbol. When a schema reference is created
+  with a string path (e.g. `ref 'foo'`), the path is now converted to a symbol
+  to match the keys used by `GlobalContext`.
+
+  Internal reference: `#146922`.
+
 ## 3.0.37 (2026-02-24)
 
 * Add inline ref support for hash nodes via `ref! nil, :SchemaName`. This

data/VERSION

@@ -1 +1 @@
-3.0.37
+3.0.38

data/lib/schemacop/v3/combination_node.rb

@@ -23,6 +23,10 @@ module Schemacop
         return item.cast(value)
       end
 
+      def children
+        @items
+      end
+
       def add_child(node)
         @items << node
       end

data/lib/schemacop/v3/reference_node.rb

@@ -1,6 +1,8 @@
 module Schemacop
   module V3
     class ReferenceNode < Node
+      RFC6901_ESCAPE = { '~' => '~0', '/' => '~1' }.freeze
+
       def self.allowed_options
         super + %i[path]
       end
@@ -12,9 +14,16 @@ module Schemacop
 
       def as_json
         if context.swagger_json?
-          process_json([], '$ref': "#/components/schemas/#{@path}")
+          # OpenAPI schema names must match ^[a-zA-Z0-9._-]+$, so we replace
+          # all non-conforming characters: `/` and `~` become `.`.
+          sanitized = @path.to_s.gsub(%r{[~/]}, '.')
+          process_json([], '$ref': "#/components/schemas/#{sanitized}")
         else
-          process_json([], '$ref': "#/definitions/#{@path}")
+          # Plain JSON Schema: use RFC 6901 JSON Pointer escaping in $ref.
+          # gsub with a hash is a single-pass substitution, so the RFC 6901
+          # order-of-escaping concern (~ before /) does not apply here.
+          escaped = @path.to_s.gsub(%r{[~/]}, RFC6901_ESCAPE)
+          process_json([], '$ref': "#/definitions/#{escaped}")
         end
       end
 
@@ -56,7 +65,7 @@ module Schemacop
       protected
 
       def init
-        @path = options.delete(:path)
+        @path = options.delete(:path)&.to_sym
       end
     end
   end

data/schemacop.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: schemacop 3.0.37 ruby lib
+# stub: schemacop 3.0.38 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "schemacop".freeze
-  s.version = "3.0.37".freeze
+  s.version = "3.0.38".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sitrox".freeze]
-  s.date = "2026-02-24"
+  s.date = "2026-02-25"
   s.files = [".github/workflows/ruby.yml".freeze, ".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, ".yardopts".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "README_V2.md".freeze, "README_V3.md".freeze, "RUBY_VERSION".freeze, "Rakefile".freeze, "VERSION".freeze, "lib/schemacop.rb".freeze, "lib/schemacop/base_schema.rb".freeze, "lib/schemacop/exceptions.rb".freeze, "lib/schemacop/railtie.rb".freeze, "lib/schemacop/schema.rb".freeze, "lib/schemacop/schema2.rb".freeze, "lib/schemacop/schema3.rb".freeze, "lib/schemacop/scoped_env.rb".freeze, "lib/schemacop/v2.rb".freeze, "lib/schemacop/v2/caster.rb".freeze, "lib/schemacop/v2/collector.rb".freeze, "lib/schemacop/v2/dupper.rb".freeze, "lib/schemacop/v2/field_node.rb".freeze, "lib/schemacop/v2/node.rb".freeze, "lib/schemacop/v2/node_resolver.rb".freeze, "lib/schemacop/v2/node_supporting_field.rb".freeze, "lib/schemacop/v2/node_supporting_type.rb".freeze, "lib/schemacop/v2/node_with_block.rb".freeze, "lib/schemacop/v2/validator/array_validator.rb".freeze, "lib/schemacop/v2/validator/boolean_validator.rb".freeze, "lib/schemacop/v2/validator/float_validator.rb".freeze, "lib/schemacop/v2/validator/hash_validator.rb".freeze, "lib/schemacop/v2/validator/integer_validator.rb".freeze, "lib/schemacop/v2/validator/nil_validator.rb".freeze, "lib/schemacop/v2/validator/number_validator.rb".freeze, "lib/schemacop/v2/validator/object_validator.rb".freeze, "lib/schemacop/v2/validator/string_validator.rb".freeze, "lib/schemacop/v2/validator/symbol_validator.rb".freeze, "lib/schemacop/v3.rb".freeze, "lib/schemacop/v3/all_of_node.rb".freeze, "lib/schemacop/v3/any_of_node.rb".freeze, "lib/schemacop/v3/array_node.rb".freeze, "lib/schemacop/v3/boolean_node.rb".freeze, "lib/schemacop/v3/combination_node.rb".freeze, "lib/schemacop/v3/context.rb".freeze, "lib/schemacop/v3/dsl_scope.rb".freeze, "lib/schemacop/v3/global_context.rb".freeze, "lib/schemacop/v3/hash_node.rb".freeze, "lib/schemacop/v3/integer_node.rb".freeze, "lib/schemacop/v3/is_not_node.rb".freeze, "lib/schemacop/v3/node.rb".freeze, "lib/schemacop/v3/node_registry.rb".freeze, "lib/schemacop/v3/number_node.rb".freeze, "lib/schemacop/v3/numeric_node.rb".freeze, "lib/schemacop/v3/object_node.rb".freeze, "lib/schemacop/v3/one_of_node.rb".freeze, "lib/schemacop/v3/reference_node.rb".freeze, "lib/schemacop/v3/result.rb".freeze, "lib/schemacop/v3/string_node.rb".freeze, "lib/schemacop/v3/symbol_node.rb".freeze, "schemacop.gemspec".freeze, "test/lib/test_helper.rb".freeze, "test/schemas/nested/group.rb".freeze, "test/schemas/user.rb".freeze, "test/unit/schemacop/v2/casting_test.rb".freeze, "test/unit/schemacop/v2/collector_test.rb".freeze, "test/unit/schemacop/v2/custom_check_test.rb".freeze, "test/unit/schemacop/v2/custom_if_test.rb".freeze, "test/unit/schemacop/v2/defaults_test.rb".freeze, "test/unit/schemacop/v2/empty_test.rb".freeze, "test/unit/schemacop/v2/nil_dis_allow_test.rb".freeze, "test/unit/schemacop/v2/node_resolver_test.rb".freeze, "test/unit/schemacop/v2/short_forms_test.rb".freeze, "test/unit/schemacop/v2/types_test.rb".freeze, "test/unit/schemacop/v2/validator_array_test.rb".freeze, "test/unit/schemacop/v2/validator_boolean_test.rb".freeze, "test/unit/schemacop/v2/validator_float_test.rb".freeze, "test/unit/schemacop/v2/validator_hash_test.rb".freeze, "test/unit/schemacop/v2/validator_integer_test.rb".freeze, "test/unit/schemacop/v2/validator_nil_test.rb".freeze, "test/unit/schemacop/v2/validator_number_test.rb".freeze, "test/unit/schemacop/v2/validator_object_test.rb".freeze, "test/unit/schemacop/v2/validator_string_test.rb".freeze, "test/unit/schemacop/v2/validator_symbol_test.rb".freeze, "test/unit/schemacop/v3/all_of_node_test.rb".freeze, "test/unit/schemacop/v3/any_of_node_test.rb".freeze, "test/unit/schemacop/v3/array_node_test.rb".freeze, "test/unit/schemacop/v3/boolean_node_test.rb".freeze, "test/unit/schemacop/v3/global_context_test.rb".freeze, "test/unit/schemacop/v3/hash_node_test.rb".freeze, "test/unit/schemacop/v3/integer_node_test.rb".freeze, "test/unit/schemacop/v3/is_not_node_test.rb".freeze, "test/unit/schemacop/v3/node_test.rb".freeze, "test/unit/schemacop/v3/number_node_test.rb".freeze, "test/unit/schemacop/v3/object_node_test.rb".freeze, "test/unit/schemacop/v3/one_of_node_test.rb".freeze, "test/unit/schemacop/v3/reference_node_test.rb".freeze, "test/unit/schemacop/v3/string_node_test.rb".freeze, "test/unit/schemacop/v3/symbol_node_test.rb".freeze]
   s.homepage = "https://github.com/sitrox/schemacop".freeze
   s.licenses = ["MIT".freeze]

data/test/unit/schemacop/v3/reference_node_test.rb

@@ -706,6 +706,104 @@ module Schemacop
         end
       end
 
+      def test_namespaced_schema_reference
+        context = Context.new
+
+        context.schema :'namespaced/user' do
+          str! :name
+        end
+
+        Schemacop.with_context context do
+          schema do
+            ref! :user, :'namespaced/user'
+          end
+
+          assert_json({
+                        properties:           {
+                          user: {
+                            '$ref' => '#/definitions/namespaced~1user'
+                          }
+                        },
+                        additionalProperties: false,
+                        required:             %w[user],
+                        type:                 :object
+                      })
+
+          assert_swagger_json({
+                                properties:           {
+                                  user: {
+                                    '$ref' => '#/components/schemas/namespaced.user'
+                                  }
+                                },
+                                additionalProperties: false,
+                                required:             %w[user],
+                                type:                 :object
+                              })
+
+          assert_validation(user: { name: 'John' })
+          assert_validation(user: { name: 42 }) do
+            error '/user/name', 'Invalid type, got type "Integer", expected "string".'
+          end
+        end
+      end
+
+      def test_namespaced_schema_reference_with_tilde
+        context = Context.new
+
+        context.schema :'config~item/sub' do
+          str! :value
+        end
+
+        Schemacop.with_context context do
+          schema do
+            ref! :item, :'config~item/sub'
+          end
+
+          assert_json({
+                        properties:           {
+                          item: {
+                            '$ref' => '#/definitions/config~0item~1sub'
+                          }
+                        },
+                        additionalProperties: false,
+                        required:             %w[item],
+                        type:                 :object
+                      })
+
+          assert_swagger_json({
+                                properties:           {
+                                  item: {
+                                    '$ref' => '#/components/schemas/config.item.sub'
+                                  }
+                                },
+                                additionalProperties: false,
+                                required:             %w[item],
+                                type:                 :object
+                              })
+
+          assert_validation(item: { value: 'hello' })
+        end
+      end
+
+      def test_ref_inside_one_of_used_external_schemas
+        context = Context.new
+
+        context.schema :Nested do
+          str! :value
+        end
+
+        Schemacop.with_context context do
+          schema do
+            one_of! :item do
+              ref :Nested
+              str
+            end
+          end
+
+          assert_includes @schema.root.used_external_schemas, :Nested
+        end
+      end
+
       def test_inline_ref_property_name_collision
         schema do
           scm :BasicInfo do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: schemacop
 version: !ruby/object:Gem::Version
-  version: 3.0.37
+  version: 3.0.38
 platform: ruby
 authors:
 - Sitrox
 bindir: bin
 cert_chain: []
-date: 2026-02-24 00:00:00.000000000 Z
+date: 2026-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport