schemacop 3.0.0 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb25d83997e507cf7bf5e905143584e01b543c296f74e190eae487fe1a8bfdc0
-  data.tar.gz: 896f9bc4e14ac0e59831eacd83ae2e5a691a53e377f0b4895790b3686c24c2db
+  metadata.gz: 27400e248bfdb65fc7cc229fbbb625cfa68a1421996fc5cbbb3283eb82d28a1e
+  data.tar.gz: 4b435374b7d2c0ce05e4410235995983dc0f96c8d6c21b69d88e80abdae7aed0
 SHA512:
-  metadata.gz: 461b762ba18edeac632010db52d368978ead449c6de8a88f6b6883d0109cfa3ff3e8b9bf4c8f2780023b60624bfc80f6456a421a8044fdf4ed7b565d8779db5c
-  data.tar.gz: 693beb806323f0695fce4183ad65d65670d5cab8b76692d74b4a467e396a52540bbb4fa9b9c03bef9940a35c1f62a32fcd0e51ea435f450bc134b502ca5839df
+  metadata.gz: 194c2f72fcadad2e311e1c96ca9bfd004e5f27c5d591bd1188a1fb177d56a75aa2670b50fddc07e7afaee99fd48f98195156a8f98a250485fd6a75a0ac57bda8
+  data.tar.gz: 798a3dfaf53b6c2996e2799cc841bdf2172ef4ebd89c022c67a2d21424add61f1c0ef0c686e11c17b589b417961343f603012395e5510284573cb8a7e78a3468

data/CHANGELOG.md

@@ -10,6 +10,34 @@
 ### Changes
 -->
 
+## 3.0.5 (2021-02-14)
+
+* Allow option `pattern` to be a `Regexp` for `string` (`str`) nodes
+
+* Remove `examples_keyword` from context again
+
+* Add option `json_format` to {Schemacop::Schema3.as_json as_json}. This allows
+  generating a JSON schema that is [specific to
+  swagger](https://swagger.io/docs/specification/data-models/keywords/) by
+  passing `:swagger` to it.
+
+## 3.0.4 (2021-02-15)
+
+* Add `examples_keyword` to context which allows to customize the name of the
+  `examples` attribute in JSON output
+
+## 3.0.3 (2021-02-15)
+
+* Fix boolean node casting
+
+## 3.0.2 (2021-02-14)
+
+* Fix #15 Code to ignore Zeitwerk fails when Zeitwerk is disabled
+
+## 3.0.1 (2021-02-11)
+
+* Add format `symbol` to strings
+
 ## 3.0.0 (2021-02-08)
 
 * Setup Zeitwerk ignores for Rails applications

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Sitrox
+Copyright © 2016 - 2021 Sitrox
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -16,7 +16,7 @@ Schemacop is tested with the following ruby versions:
 * 2.7.1
 * 3.0.0
 
-For these versions, the automated CI tests are ran on travis. Other ruby versions might work, but stick to these versions for best results.
+Other ruby versions might work but are not covered by our Travis tests.
 
 ## Basic example
 

data/README_V3.md

@@ -241,6 +241,9 @@ transformed into various types.
 * `number`
   The string must be a number and will be casted to a ruby `Float` object.
 
+* `symbol`
+  The string can be anything and will be casted to a ruby `Symbol` object.
+
 #### Examples
 
 ```ruby

data/VERSION

@@ -1 +1 @@
-3.0.0
+3.0.5

data/lib/schemacop/railtie.rb

@@ -7,7 +7,7 @@ module Schemacop
       end
 
       # Tell Zeitwerk to ignore the files in our load path
-      if defined?(Rails) && defined?(Zeitwerk)
+      if defined?(Rails) && defined?(Zeitwerk) && Rails.autoloaders.zeitwerk_enabled?
         Schemacop.load_paths.each do |load_path|
           Rails.autoloaders.main.ignore(Rails.root.join(load_path))
         end

data/lib/schemacop/schema3.rb

@@ -14,8 +14,8 @@ module Schemacop
       root.validate(data)
     end
 
-    def as_json
-      root.as_json
+    def as_json(json_format: V3::Context::DEFAULT_JSON_FORMAT)
+      Schemacop.context.spawn_with(json_format: json_format) { root.as_json }
     end
   end
 end

data/lib/schemacop/v3.rb

@@ -3,6 +3,24 @@ module Schemacop
     def self.register(*args)
       NodeRegistry.register(*args)
     end
+
+    # @private
+    def self.sanitize_exp(exp)
+      return exp if exp.is_a?(String)
+
+      _start_slash, caret, exp, dollar, _end_slash, flags = exp.inspect.match(%r{^(/?)(\^)?(.*?)(\$)?(/?)([ixm]*)?$}).captures
+      flags = flags.split('')
+
+      if flags.delete('i')
+        exp = "(?i)(#{exp})"
+      end
+
+      if flags.any?
+        fail "Flags #{flags.inspect} are not supported by Schemacop."
+      end
+
+      return "#{caret}#{exp}#{dollar}"
+    end
   end
 end
 

data/lib/schemacop/v3/boolean_node.rb

@@ -11,6 +11,14 @@ module Schemacop
           FalseClass => :boolean
         }
       end
+
+      def cast(value)
+        if value.is_a?(TrueClass) || value.is_a?(FalseClass)
+          value
+        else
+          default
+        end
+      end
     end
   end
 end

data/lib/schemacop/v3/context.rb

@@ -2,9 +2,13 @@ module Schemacop
   module V3
     class Context
       attr_accessor :schemas
+      attr_accessor :json_format
 
-      def initialize
+      DEFAULT_JSON_FORMAT = :default
+
+      def initialize(json_format: DEFAULT_JSON_FORMAT)
         @schemas = {}.with_indifferent_access.freeze
+        @json_format = json_format
       end
 
       def schema(name, type = :hash, **options, &block)
@@ -12,6 +16,18 @@ module Schemacop
           name => Node.create(type, **options, &block)
         ).freeze
       end
+
+      def spawn_with(json_format: @json_format)
+        prev_json_format = @json_format
+        @json_format = json_format
+        return yield
+      ensure
+        @json_format = prev_json_format
+      end
+
+      def swagger_json?
+        @json_format == :swagger
+      end
     end
   end
 end

data/lib/schemacop/v3/hash_node.rb

@@ -21,14 +21,6 @@ module Schemacop
         super + NodeRegistry.dsl_methods(true) + %i[dsl_dep dsl_add]
       end
 
-      def self.sanitize_exp(exp)
-        exp = exp.to_s
-        if exp.start_with?('(?-mix:')
-          exp = exp.to_s.gsub(/^\(\?-mix:/, '').gsub(/\)$/, '')
-        end
-        return exp
-      end
-
       def add_child(node)
         unless node.name
           fail Exceptions::InvalidSchemaError, 'Child nodes must have a name.'
@@ -64,7 +56,7 @@ module Schemacop
 
         json = {}
         json[:properties] = Hash[properties.values.map { |p| [p.name, p.as_json] }] if properties.any?
-        json[:patternProperties] = Hash[pattern_properties.values.map { |p| [self.class.sanitize_exp(p.name), p.as_json] }] if pattern_properties.any?
+        json[:patternProperties] = Hash[pattern_properties.values.map { |p| [V3.sanitize_exp(p.name), p.as_json] }] if pattern_properties.any?
 
         # In schemacop, by default, additional properties are not allowed,
         # the users explicitly need to enable additional properties

data/lib/schemacop/v3/node.rb

@@ -150,6 +150,10 @@ module Schemacop
 
       protected
 
+      def context
+        Schemacop.context
+      end
+
       def item_matches?(item, data)
         item_result = Result.new(self)
         item._validate(data, result: item_result)
@@ -170,7 +174,7 @@ module Schemacop
         end
 
         json[:title] = @title if @title
-        json[:examples] = @examples if @examples
+        json[context.swagger_json? ? :example : :examples] = @examples if @examples
         json[:description] = @description if @description
         json[:default] = @default if @default
         json[:enum] = @enum.to_a if @enum

data/lib/schemacop/v3/numeric_node.rb

@@ -4,16 +4,34 @@ module Schemacop
     class NumericNode < Node
       ATTRIBUTES = %i[
         minimum
-        exclusive_minimum
         maximum
-        exclusive_maximum
         multiple_of
+        exclusive_minimum
+        exclusive_maximum
       ].freeze
 
       def self.allowed_options
         super + ATTRIBUTES
       end
 
+      def process_json(attrs, json)
+        if context.swagger_json?
+          if options[:exclusive_minimum]
+            json[:minimum] = options[:exclusive_minimum]
+            json[:exclusiveMinimum] = true
+          end
+
+          if options[:exclusive_maximum]
+            json[:maximum] = options[:exclusive_maximum]
+            json[:exclusiveMaximum] = true
+          end
+
+          attrs -= %i[exclusive_minimum exclusive_maximum]
+        end
+
+        super attrs, json
+      end
+
       def _validate(data, result:)
         super_data = super
         return if super_data.nil?

data/lib/schemacop/v3/string_node.rb

@@ -4,7 +4,6 @@ module Schemacop
       ATTRIBUTES = %i[
         min_length
         max_length
-        pattern
         format
       ].freeze
 
@@ -16,13 +15,14 @@ module Schemacop
         email:       URI::MailTo::EMAIL_REGEXP,
         boolean:     /^(true|false)$/,
         binary:      nil,
+        symbol:      nil,
         integer:     /^-?[0-9]+$/,
         number:      /^-?[0-9]+(\.[0-9]+)?$/
       }.freeze
       # rubocop:enable Layout/LineLength
 
       def self.allowed_options
-        super + ATTRIBUTES - %i[cast_str] + %i[format_options]
+        super + ATTRIBUTES - %i[cast_str] + %i[format_options pattern]
       end
 
       def allowed_types
@@ -30,7 +30,11 @@ module Schemacop
       end
 
       def as_json
-        process_json(ATTRIBUTES, type: :string)
+        json = { type: :string }
+        if options[:pattern]
+          json[:pattern] = V3.sanitize_exp(Regexp.compile(options[:pattern]))
+        end
+        process_json(ATTRIBUTES, json)
       end
 
       def _validate(data, result:)
@@ -49,8 +53,14 @@ module Schemacop
         end
 
         # Validate pattern #
-        if options[:pattern] && !super_data.match?(Regexp.compile(options[:pattern]))
-          result.error "String does not match pattern #{options[:pattern].inspect}."
+        if (pattern = options[:pattern])
+          unless options[:pattern].is_a?(Regexp)
+            pattern = Regexp.compile(pattern)
+          end
+
+          unless super_data.match?(pattern)
+            result.error "String does not match pattern #{V3.sanitize_exp(pattern).inspect}."
+          end
         end
 
         # Validate format #
@@ -87,6 +97,8 @@ module Schemacop
           return Integer(to_cast)
         when :number
           return Float(to_cast)
+        when :symbol
+          return to_cast.to_sym
         else
           return to_cast
         end
@@ -118,7 +130,9 @@ module Schemacop
         end
 
         if options[:pattern]
-          fail 'Option "pattern" must be a string.' unless options[:pattern].is_a?(String)
+          unless options[:pattern].is_a?(String) || options[:pattern].is_a?(Regexp)
+            fail 'Option "pattern" must be a string or Regexp.'
+          end
 
           begin
             Regexp.compile(options[:pattern])

data/schemacop.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: schemacop 3.0.0 ruby lib
+# stub: schemacop 3.0.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "schemacop".freeze
-  s.version = "3.0.0"
+  s.version = "3.0.5"
 
   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 = "2021-02-08"
+  s.date = "2021-02-16"
   s.files = [".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, ".travis.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/lib/test_helper.rb

@@ -142,6 +142,11 @@ class V3Test < SchemacopTest
     assert_equal expected_json.as_json, @schema.as_json.as_json
   end
 
+  def assert_swagger_json(expected_json)
+    # TODO: Double "as_json" should not be necessary
+    assert_equal expected_json.as_json, @schema.as_json(json_format: :swagger).as_json
+  end
+
   def assert_match_any(array, exp)
     assert array.any? { |element| element.match?(exp) },
            "Expected any of #{array.inspect} to match #{exp}."

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

@@ -120,6 +120,22 @@ module Schemacop
                       ]
                     })
       end
+
+      def test_cast
+        schema :boolean
+
+        assert_cast(true, true)
+        assert_cast(false, false)
+        assert_cast(nil, nil)
+      end
+
+      def test_cast_default
+        schema :boolean, default: true
+
+        assert_cast(true, true)
+        assert_cast(false, false)
+        assert_cast(nil, true)
+      end
     end
   end
 end

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

@@ -125,6 +125,12 @@ module Schemacop
           exclusiveMinimum: 0
         )
 
+        assert_swagger_json(
+          type:             :integer,
+          minimum:          0,
+          exclusiveMinimum: true
+        )
+
         assert_validation 5
         assert_validation 1
         assert_validation(0) do
@@ -158,6 +164,12 @@ module Schemacop
           exclusiveMaximum: 5
         )
 
+        assert_swagger_json(
+          type:             :integer,
+          maximum:          5,
+          exclusiveMaximum: true
+        )
+
         assert_validation 4
         assert_validation 1
         assert_validation(5) do

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

@@ -63,6 +63,20 @@ module Schemacop
                     })
       end
 
+      def test_swagger_example
+        schema :string, examples: ['Foo', 'Foo bar']
+
+        assert_json(
+          type:     :string,
+          examples: ['Foo', 'Foo bar']
+        )
+
+        assert_swagger_json(
+          type:    :string,
+          example: ['Foo', 'Foo bar']
+        )
+      end
+
       def test_cast_in_root
         schema :integer, cast_str: true, required: true
 

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

@@ -101,6 +101,12 @@ module Schemacop
           exclusiveMinimum: 0
         )
 
+        assert_swagger_json(
+          type:             :number,
+          minimum:          0,
+          exclusiveMinimum: true
+        )
+
         assert_validation 5
         assert_validation 1
         assert_validation(0) do
@@ -134,6 +140,12 @@ module Schemacop
           exclusiveMaximum: 5
         )
 
+        assert_swagger_json(
+          type:             :number,
+          maximum:          5,
+          exclusiveMaximum: true
+        )
+
         assert_validation 4
         assert_validation 1
         assert_validation(5) do

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

@@ -80,7 +80,7 @@ module Schemacop
         end
       end
 
-      def test_pattern
+      def test_pattern_as_string
         schema :string, pattern: '^a_.*_z$'
 
         assert_json(type: :string, pattern: '^a_.*_z$')
@@ -95,6 +95,22 @@ module Schemacop
         end
       end
 
+      def test_pattern_as_regexp
+        schema :string, pattern: /^a_.*_z$/i
+
+        assert_json(type: :string, pattern: '^(?i)(a_.*_z)$')
+
+        assert_validation 'a__z'
+        assert_validation 'a__Z'
+        assert_validation 'a_ foo bar _Z'
+        assert_validation '' do
+          error '/', 'String does not match pattern "^(?i)(a_.*_z)$".'
+        end
+        assert_validation 'a_ _zfoo' do
+          error '/', 'String does not match pattern "^(?i)(a_.*_z)$".'
+        end
+      end
+
       def test_format_date
         schema :string, format: :date
 
@@ -165,6 +181,23 @@ module Schemacop
         assert_cast('john.doe@example.com', 'john.doe@example.com')
       end
 
+      def test_format_symbol
+        schema :string, format: :symbol
+
+        assert_json(type: :string, format: :symbol)
+
+        assert_validation 'foobar'
+        assert_validation ''
+
+        assert_validation 234 do
+          error '/', 'Invalid type, expected "string".'
+        end
+
+        assert_cast(nil, nil)
+        assert_cast('foobar', :foobar)
+        assert_cast('039n23$g- sfk3/', :'039n23$g- sfk3/')
+      end
+
       def test_enum
         schema :string, enum: ['foo', 'some string', 'some other string', 42]
 
@@ -297,8 +330,8 @@ module Schemacop
         end
 
         assert_raises_with_message Exceptions::InvalidSchemaError,
-                                   'Option "pattern" must be a string.' do
-          schema :string, pattern: //
+                                   'Option "pattern" must be a string or Regexp.' do
+          schema :string, pattern: 42
         end
 
         assert_raises_with_message Exceptions::InvalidSchemaError,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemacop
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.5
 platform: ruby
 authors:
 - Sitrox
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-08 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,8 +164,8 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.21.2
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -277,7 +277,7 @@ homepage: https://github.com/sitrox/schemacop
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -292,8 +292,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Schemacop validates ruby structures consisting of nested hashes and arrays
   against simple schema definitions.