dry-schema-extensions 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f043a132971608919006d6b21f62bb0f057b56511b9bc35c25d3eaa5000d0b19
+  data.tar.gz: b50c68c80aba6e494769c28cfdf10bacd77b5a777426c899cee91006671b6470
+SHA512:
+  metadata.gz: 0acd59392bd0db95ad17013191e7610f21823ef9f5748d822ec89eca1e1bdc4a5e2570e2a6c820797a2736aec02b571bf211ef3504da853926b32474fdfc685d
+  data.tar.gz: 75c8127d2c0b38d08bf7da60dd30d339c3df4776ed01fbc3de6f5dfcf16cba88f8b90f305ab1dcd021a8507b270bb072827dc771d87b620ebe5cfb4f71ae31fb

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2021 dry-rb team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,20 @@
+# dry-schema-extensions 
+
+[![Gem Version](https://badge.fury.io/rb/dry-schema-extensions.svg)][gem]
+[![CI Status](https://github.com/ianks/dry-schema-extensions/workflows/CI/badge.svg)][actions]
+
+## Extensions Provided
+
+* [Open API Extension](docsite/source/extensions/open_api.html.md)
+* [JSON Schema Extension](docsite/source/extensions/json_schema.html.md)
+
+## Supported Ruby versions
+
+This library officially supports the following Ruby versions:
+
+* MRI `>= 2.6.0`
+* ~~jruby~~ `>= 9.3` (we are waiting for [2.6 support](https://github.com/jruby/jruby/issues/6161))
+
+## License
+
+See `LICENSE` file.

data/dry-schema-extensions.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# this file is synced from dry-rb/template-gem project
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "dry-schema-extensions"
+  spec.authors       = ["Ian Ker-Seymer"]
+  spec.email         = ["i.kerseymer@gmail.com"]
+  spec.license       = "MIT"
+  spec.version       = "1.0.0" 
+
+  spec.summary       = "OpenAPI and JSON Schema extension for dry-schema"
+  spec.description   = <<~TEXT
+    Enhances dry-schema with the ability to export convert dry-schemas to OpenAPI definitions.
+  TEXT
+  spec.homepage      = "https://dry-rb.org/gems/dry-schema"
+  spec.files         = Dir["LICENSE", "README.md", "dry-schema-extensions.gemspec", "lib/**/*"]
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.add_runtime_dependency "dry-schema", ">= 1.6.1"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/dry/schema/extensions/json_schema/schema_compiler.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+require "dry/schema/constants"
+
+module Dry
+  module Schema
+    # @api private
+    module JSONSchema
+      # @api private
+      class SchemaCompiler
+        # An error raised when a predicate cannot be converted
+        UnknownConversionError = Class.new(StandardError)
+
+        IDENTITY = ->(v, _) { v }.freeze
+        TO_INTEGER = ->(v, _) { v.to_i }.freeze
+
+        PREDICATE_TO_TYPE = {
+          array?: {type: "array"},
+          bool?: {type: "boolean"},
+          date?: {type: "string", format: "date"},
+          date_time?: {type: "string", format: "date-time"},
+          decimal?: {type: "number"},
+          float?: {type: "number"},
+          hash?: {type: "object"},
+          int?: {type: "integer"},
+          nil?: {type: "null"},
+          str?: {type: "string"},
+          time?: {type: "string", format: "time"},
+          min_size?: {minLength: TO_INTEGER},
+          max_size?: {maxLength: TO_INTEGER},
+          included_in?: {enum: ->(v, _) { v.to_a }},
+          filled?: EMPTY_HASH,
+          uri?: {format: "uri"},
+          uuid_v1?: {
+            pattern: "^[0-9A-F]{8}-[0-9A-F]{4}-1[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$"
+          },
+          uuid_v2?: {
+            pattern: "^[0-9A-F]{8}-[0-9A-F]{4}-2[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$"
+          },
+          uuid_v3?: {
+            pattern: "^[0-9A-F]{8}-[0-9A-F]{4}-3[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$"
+          },
+          uuid_v4?: {
+            pattern: "^[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}$"
+          },
+          uuid_v5?: {
+            pattern: "^[0-9A-F]{8}-[0-9A-F]{4}-5[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$"
+          },
+          gt?: {exclusiveMinimum: IDENTITY},
+          gteq?: {mininum: IDENTITY},
+          lt?: {exclusiveMaximum: IDENTITY},
+          lteq?: {maximum: IDENTITY},
+          odd?: {type: "integer", not: {multipleOf: 2}},
+          even?: {type: "integer", multipleOf: 2}
+        }.freeze
+
+        # @api private
+        attr_reader :keys, :required
+
+        # @api private
+        def initialize(root: false, loose: false)
+          @keys = EMPTY_HASH.dup
+          @required = Set.new
+          @root = root
+          @loose = loose
+        end
+
+        # @api private
+        def to_hash
+          result = {}
+          result[:$schema] = "http://json-schema.org/draft-06/schema#" if root?
+          result.merge!(type: "object", properties: keys, required: required.to_a)
+          result
+        end
+
+        alias_method :to_h, :to_hash
+
+        # @api private
+        def call(ast)
+          visit(ast)
+        end
+
+        # @api private
+        def visit(node, opts = EMPTY_HASH)
+          meth, rest = node
+          public_send(:"visit_#{meth}", rest, opts)
+        end
+
+        # @api private
+        def visit_set(node, opts = EMPTY_HASH)
+          target = (key = opts[:key]) ? self.class.new : self
+
+          node.map { |child| target.visit(child, opts) }
+
+          return unless key
+
+          target_info = opts[:member] ? {items: target.to_h} : target.to_h
+          type = opts[:member] ? "array" : "object"
+
+          keys.update(key => {**keys[key], type: type, **target_info})
+        end
+
+        # @api private
+        def visit_and(node, opts = EMPTY_HASH)
+          left, right = node
+
+          # We need to know the type first to apply filled macro
+          if left[1][0] == :filled?
+            visit(right, opts)
+            visit(left, opts)
+          else
+            visit(left, opts)
+            visit(right, opts)
+          end
+        end
+
+        # @api private
+        def visit_implication(node, opts = EMPTY_HASH)
+          node.each do |el|
+            visit(el, **opts, required: false)
+          end
+        end
+
+        # @api private
+        def visit_each(node, opts = EMPTY_HASH)
+          visit(node, opts.merge(member: true))
+        end
+
+        # @api private
+        def visit_key(node, opts = EMPTY_HASH)
+          name, rest = node
+
+          if opts.fetch(:required, :true)
+            required << name.to_s
+          else
+            opts.delete(:required)
+          end
+
+          visit(rest, opts.merge(key: name))
+        end
+
+        # @api private
+        def visit_not(node, opts = EMPTY_HASH)
+          _name, rest = node
+
+          visit_predicate(rest, opts)
+        end
+
+        # @api private
+        def visit_predicate(node, opts = EMPTY_HASH)
+          name, rest = node
+
+          if name.equal?(:key?)
+            prop_name = rest[0][1]
+            keys[prop_name] = {}
+          else
+            target = keys[opts[:key]]
+            type_opts = fetch_type_opts_for_predicate(name, rest, target)
+
+            if target[:type]&.include?("array")
+              target[:items] ||= {}
+              merge_opts!(target[:items], type_opts)
+            else
+              merge_opts!(target, type_opts)
+            end
+          end
+        end
+
+        # @api private
+        def fetch_type_opts_for_predicate(name, rest, target)
+          type_opts = PREDICATE_TO_TYPE.fetch(name) do
+            raise_unknown_conversion_error!(:predicate, name) unless loose?
+
+            EMPTY_HASH
+          end.dup
+          type_opts.transform_values! { |v| v.respond_to?(:call) ? v.call(rest[0][1], target) : v }
+          type_opts.merge!(fetch_filled_options(target[:type], target)) if name == :filled?
+          type_opts
+        end
+
+        # @api private
+        def fetch_filled_options(type, _target)
+          case type
+          when "string"
+            {minLength: 1}
+          when "array"
+            raise_unknown_conversion_error!(:type, :array) unless loose?
+
+            {not: {type: "null"}}
+          else
+            {not: {type: "null"}}
+          end
+        end
+
+        # @api private
+        def merge_opts!(orig_opts, new_opts)
+          new_type = new_opts[:type]
+          orig_type = orig_opts[:type]
+
+          if orig_type && new_type && orig_type != new_type
+            new_opts[:type] = [orig_type, new_type]
+          end
+
+          orig_opts.merge!(new_opts)
+        end
+
+        # @api private
+        def root?
+          @root
+        end
+
+        # @api private
+        def loose?
+          @loose
+        end
+
+        def raise_unknown_conversion_error!(type, name)
+          message = <<~MSG
+            Could not find an equivalent conversion for #{type} #{name.inspect}.
+
+            This means that your generated JSON schema may be missing this validation.
+
+            You can ignore this by generating the schema in "loose" mode, i.e.:
+                my_schema.json_schema(loose: true)
+          MSG
+
+          raise UnknownConversionError, message.chomp
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "dry/schema/extensions/json_schema/schema_compiler"
+
+module Dry
+  module Schema
+    # JSONSchema extension
+    #
+    # @api public
+    module JSONSchema
+      module SchemaMethods
+        # Convert the schema into a JSON schema hash
+        #
+        # @param [Symbol] loose Compile the schema in "loose" mode
+        #
+        # @return [Hash<Symbol=>Hash>]
+        #
+        # @api public
+        def json_schema(loose: false)
+          compiler = SchemaCompiler.new(root: true, loose: loose)
+          compiler.call(to_ast)
+          compiler.to_hash
+        end
+      end
+    end
+
+    Processor.include(JSONSchema::SchemaMethods)
+  end
+end

data/lib/dry/schema/extensions/open_api/schema_compiler.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "dry/schema/extensions/json_schema/schema_compiler"
+
+module Dry
+  module Schema
+    # @api private
+    module OpenAPI
+      # @api private
+      class SchemaCompiler < JSONSchema::SchemaCompiler
+        UnknownConversionError = Class.new(StandardError)
+
+        def to_hash
+          transform_json_schema_hash!(super)
+        end
+
+        private
+
+        def transform_json_schema_hash!(hash)
+          hash.delete(:$schema)
+          transform_nullables!(hash)
+        end
+
+        def transform_nullables!(hash)
+          deep_transform_values!(hash) do |input|
+            next input unless input.respond_to?(:key?)
+            next input unless input[:type].respond_to?(:each)
+
+            types = input[:type]
+            input[:nullable] = true if types.delete("null")
+
+            if types.length == 1
+              input[:type] = types.first
+              input
+            else
+              raise UnknownConversionError, "cannot map type #{types.inspect}"
+            end
+          end
+        end
+
+        def deep_transform_values!(hash, &block)
+          case hash
+          when Hash
+            hash.transform_values! { |value| deep_transform_values!(yield(value), &block) }
+          when Array
+            hash.map! { |e| deep_transform_values!(e, &block) }
+          else
+            yield(hash)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/schema/extensions/open_api.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "dry/schema/extensions/open_api/schema_compiler"
+
+module Dry
+  module Schema
+    # JSONSchema extension
+    #
+    # @api public
+    module OpenAPI
+      module SchemaMethods
+        # Convert the schema into a JSON schema hash
+        #
+        # @param [Symbol] loose Compile the schema in "loose" mode
+        #
+        # @return [Hash<Symbol=>Hash>]
+        #
+        # @api public
+        def open_api(loose: false)
+          compiler = SchemaCompiler.new(root: true, loose: loose)
+          compiler.call(to_ast)
+          compiler.to_hash
+        end
+      end
+    end
+
+    Processor.include(OpenAPI::SchemaMethods)
+  end
+end

data/lib/dry-schema-extensions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "dry-schema"
+
+Dry::Schema.register_extension(:json_schema) do
+  require "dry/schema/extensions/json_schema"
+end
+
+Dry::Schema.register_extension(:open_api) do
+  require "dry/schema/extensions/open_api"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: dry-schema-extensions
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ian Ker-Seymer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Enhances dry-schema with the ability to export convert dry-schemas to
+  OpenAPI definitions.
+
+  '
+email:
+- i.kerseymer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- dry-schema-extensions.gemspec
+- lib/dry-schema-extensions.rb
+- lib/dry/schema/extensions/json_schema.rb
+- lib/dry/schema/extensions/json_schema/schema_compiler.rb
+- lib/dry/schema/extensions/open_api.rb
+- lib/dry/schema/extensions/open_api/schema_compiler.rb
+homepage: https://dry-rb.org/gems/dry-schema
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: OpenAPI and JSON Schema extension for dry-schema
+test_files: []