dry-types-json-schema 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33b4fa74b0afcb773080ea49a615812cb32e2d23fc0a498a5f5f8e3a5d729532
-  data.tar.gz: d3cddcc29c63e0cdbef859ce7259155cc038e40374690b58c9e5eafaa103dd08
+  metadata.gz: b3c596c245aad8cb72bc10fbe904078ac01c7522d14c135b4a6645a7b7f5c769
+  data.tar.gz: 5fc2b32368fdcb1135b32fdb7d3db27c2104966ff371f020eea750df08588b4f
 SHA512:
-  metadata.gz: 8b10cc09ab9ff064cf2d1fabaa859e1ca4442e247b368f3aa2c73c8f54f46e2b958898549d91c5bdf0884b97914249646a76280deddec3e0a1d7aa9243961bed
-  data.tar.gz: 380965c43395d6742b673f9926d092fe746a593277b027edf4c90ee3f3995893ce94c838d1257d8e9eaa573dfc26ae78f304075e93d4ad4375c753c1a9397668
+  metadata.gz: 50ed4c3ca20040b4d88ae5ecf107c6ccfad7ae7242a724f1c3afd9f015f63a7b203966571af8699614881f7848a657d322554bbb541ff48244194662a73c40e1
+  data.tar.gz: 4810a8578cfecb91df93f66b4a9ad6748db42ef0ebd219c1dfce4eeb52c9fd6992027925579dea2f545b57b38f851eca600ef1eb898ba0a5f114e8d42c14537f

data/.github/workflows/test.yml

@@ -0,0 +1,12 @@
+name: Test
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+    - run: bundle exec make test

data/.gitignore

@@ -1 +1,2 @@
 coverage
+*.gem

data/Gemfile.lock

@@ -1,17 +1,19 @@
 PATH
   remote: .
   specs:
-    dry-types-json-schema (0.0.1)
+    dry-types-json-schema (0.0.3)
       dry-types (~> 1.7.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    attr_extras (7.1.0)
     base64 (0.2.0)
     bigdecimal (3.1.7)
     coderay (1.1.3)
     concurrent-ruby (1.2.3)
+    diff-lcs (1.5.1)
     docile (1.4.0)
     dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
@@ -45,10 +47,13 @@ GEM
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
     minitest (5.22.3)
+    optimist (3.1.0)
     parallel (1.24.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
+    patience_diff (1.2.0)
+      optimist (~> 3.0)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -81,6 +86,10 @@ GEM
     simplecov_json_formatter (0.1.4)
     simpleidn (0.2.1)
       unf (~> 0.1.4)
+    super_diff (0.11.0)
+      attr_extras (>= 6.2.4)
+      diff-lcs
+      patience_diff
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.9.1)
@@ -100,6 +109,7 @@ DEPENDENCIES
   rubocop (~> 1.62.1)
   rubocop-minitest (~> 0.35.0)
   simplecov (~> 0.22.0)
+  super_diff (~> 0.11.0)
 
 BUNDLED WITH
    2.5.3

data/dry-types-json-schema.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name              = "dry-types-json-schema"
-  s.version           = "0.0.1"
+  s.version           = "0.0.3"
   s.summary           = "Generate JSON Schema from dry-types"
   s.authors           = ["elcuervo"]
   s.licenses          = %w[MIT]
@@ -20,4 +20,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency("simplecov", "~> 0.22.0")
   s.add_development_dependency("rubocop", "~> 1.62.1")
   s.add_development_dependency("rubocop-minitest", "~> 0.35.0")
+  s.add_development_dependency("super_diff", "~> 0.11.0")
 end

data/lib/dry/types/extensions/json_schema.rb

@@ -71,14 +71,13 @@ module Dry
         lt?:          { exclusiveMaximum: IDENTITY },
         lteq?:        { maximum: IDENTITY },
         format?:      { format: INSPECT },
-        included_in?: { enum: TO_ARRAY },
+        included_in?: { enum: TO_ARRAY }
       }.freeze
 
       # @return [Set] the set of required keys for the JSON Schema.
       #
       attr_reader :required
 
-
       # Initializes a new instance of the JSONSchema class.
       # @param root [Boolean] whether this schema is the root schema.
       # @param loose [Boolean] whether to ignore unknown predicates.
@@ -141,10 +140,7 @@ module Dry
         type, meta = node
 
         if opts.fetch(:key, false)
-          if meta.any?
-            @keys[opts[:key]] ||= {}
-            @keys[opts[:key]].merge!(meta.slice(*ALLOWED_TYPES_META_OVERRIDES))
-          end
+          visit_nominal_with_key(node, opts)
         else
           @keys.merge!(type: CLASS_TO_TYPE[type.to_s.to_sym])
           @keys.merge!(meta.slice(*ALLOWED_TYPES_META_OVERRIDES)) if meta.any?
@@ -175,20 +171,20 @@ module Dry
         @keys[ctx].merge!(definition)
       end
 
-      def visit_sum(node, opts = EMPTY_HASH)
+      def visit_intersection(node, opts = EMPTY_HASH)
         *types, _ = node
 
-        # FIXME: cleaner way to generate individual types
-        #
-        process = -> (type) do
-          self.class.new
-            .tap { |target| target.visit(type, opts) }
-            .to_hash
-            .values
-            .first
-        end
+        result = types.map { |type| compile_type(type) }
 
-        result = types.map(&process).uniq
+        @keys[opts[:key]] = deep_merge_items(result)
+      end
+
+      def visit_sum(node, opts = EMPTY_HASH)
+        *types, _ = node
+
+        result = types
+          .map { |type| compile_value(type, opts.merge(sum: true)) }
+          .uniq
 
         return @keys[opts[:key]] = result.first if result.count == 1
 
@@ -216,7 +212,10 @@ module Dry
 
       def visit_struct(node, opts = EMPTY_HASH)
         _, schema = node
-        visit(schema, opts)
+
+        return visit(schema, opts) unless opts[:key]
+
+        @keys[opts[:key]] = compile_type(schema)
       end
 
       def visit_array(node, opts = EMPTY_HASH)
@@ -254,6 +253,49 @@ module Dry
 
         visit(rest, opts.merge(key: name))
       end
+
+      private
+
+      def deep_merge_items(items)
+        items.reduce({}) do |current, target|
+          current.merge(target) do |_, from, to|
+            case [from.class, to.class]
+            when [::Hash, ::Hash]
+              deep_merge_items([from, to])
+            when [::Array, ::Array]
+              from | to
+            else
+              to
+            end
+          end
+        end
+      end
+
+      def compile_type(type, opts = EMPTY_HASH)
+        self.class.new
+          .tap { |target| target.visit(type, opts) }
+          .to_hash
+      end
+
+      def compile_value(type, opts = EMPTY_HASH)
+        compile_type(type, opts)
+          .values
+          .first
+      end
+
+      def visit_nominal_with_key(node, opts = EMPTY_HASH)
+        type, meta = node
+
+        if opts[:array] && !opts[:sum]
+          @keys[opts[:key]] ||= {}
+          @keys[opts[:key]].merge!(items: { type: CLASS_TO_TYPE[type.to_s.to_sym] })
+        end
+
+        if meta.any?
+          @keys[opts[:key]] ||= {}
+          @keys[opts[:key]].merge!(meta.slice(*ALLOWED_TYPES_META_OVERRIDES))
+        end
+      end
     end
 
     # The `Builder` module provides a method to generate a JSON Schema hash from dry-types definitions.
@@ -263,8 +305,8 @@ module Dry
       #   @param options [Hash] Initialization options passed to `JSONSchema.new`
       #   @return [Hash] The generated JSON Schema as a hash.
       #
-      def json_schema(**)
-        compiler = JSONSchema.new(**)
+      def json_schema(root: false, loose: false)
+        compiler = JSONSchema.new(root: root, loose: loose)
         compiler.call(to_ast)
         compiler.to_hash
       end

data/spec/extensions/json_schema_spec.rb

@@ -66,6 +66,13 @@ describe Dry::Types::JSONSchema do
         .constrained(format: /\A[\w+\-.]+@[a-z\d-]+(\.[a-z]+)*\.[a-z]+\z/i)
         .meta(description: "The internally used pattern")
 
+      ArrayOfStrings = Types::Array
+        .of(Types::String)
+        .constrained(min_size: 1)
+
+      BasicHash = Types::Hash.schema(name: Types::String)
+      ExtendedHash = Types::Hash.schema(age: Types::Integer) & BasicHash
+
       attribute  :data,   Types::String | Types::Hash
       attribute  :string, Types::String.constrained(min_size: 1, max_size: 255)
       attribute  :list,   VariableList
@@ -76,6 +83,12 @@ describe Dry::Types::JSONSchema do
       attribute? :epoch,  Types::Time
       attribute? :meta,   Types::String.meta(format: :email)
       attribute? :enum,   Types::String.enum(*%w[draft published archived])
+      attribute? :array,  ArrayOfStrings
+      attribute? :inter,  ExtendedHash
+
+      attribute? :nested do
+        attribute :deep, Types::Integer
+      end
     end
 
     let(:type) { StructTest }
@@ -146,6 +159,31 @@ describe Dry::Types::JSONSchema do
             enum: {
               type: :string,
               enum: %w[draft published archived]
+            },
+
+            array: {
+              type: :array,
+              minItems: 1,
+              items: { type: :string }
+            },
+
+            inter: {
+              type: :object,
+              properties: {
+                age: { type: :integer },
+                name: { type: :string }
+              },
+              required: %i[age name]
+            },
+
+            nested: {
+              type: :object,
+              properties: {
+                deep: { type: :integer }
+              },
+              required: [:deep],
+              title: "Title",
+              description: "description"
             }
           },
 

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ SimpleCov.start
 
 require "minitest/autorun"
 require "json_schemer"
+require "super_diff"
 
 require "dry/struct"
 require "dry/types"
@@ -13,13 +14,22 @@ require "dry/types/extensions"
 
 Dry::Types.load_extensions(:json_schema)
 
+module Minitest::Assertions
+  def assert_equal_diff(expected, actual, msg = nil)
+    assert_equal(expected, actual, msg)
+  rescue Minitest::Assertion => e
+    puts SuperDiff::Differs::Main.call(expected, actual)
+    raise e
+  end
+end
+
 class Minitest::Spec
   class << self
     def it_conforms_definition(&block)
       instance_exec(&block) if block
 
       describe "conforms the schema definition" do
-        it { assert_equal type.json_schema, definition }
+        it { assert_equal_diff type.json_schema, definition }
         it { assert JSONSchemer.schema(type.json_schema.to_json).valid_schema? }
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-types-json-schema
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - elcuervo
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.35.0
+- !ruby/object:Gem::Dependency
+  name: super_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 description:
 email:
 - elcuervo@elcuervo.net
@@ -129,6 +143,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile