schemacop 3.0.2 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90acd1ba976d75dae0019274d843c5d727858655238148a10bd485973e964fba
-  data.tar.gz: 40e63d805b815c61bcf342fc449fa5f0be506f386b7a315df33c9baada0723cd
+  metadata.gz: 85c1da35631e2529c91caa46f76c5784ad51fd83843eb1126912919b36c96809
+  data.tar.gz: e1315e5f708c804f329d79fe76c2a22ac9e2179dc3ddf5301ebcbbe280028638
 SHA512:
-  metadata.gz: ff575cb152372e2cf0685ae1f5ac123c88245a6bb23acbdc7dd0daa27098d245fc90f9e6f5d381d9490d4476109d22c01a86df5744e84b872c6708e4841b7a06
-  data.tar.gz: fda34143fc547221dadfe7cdcb24206185e2b1736ad8e4925e70928fb7d22a5f280f54a70503b5cdf7380f30fcdf250f5663eeae26323dec8dbabd4e686928dc
+  metadata.gz: f3de1743f921b7c09914d9d8f483ebe05fceb4055671b9d7413302ae0eb442a1b6c5b9c073e82eee43cd94e98c26c055b641677d154b0f515930aabae00a7714
+  data.tar.gz: 0c48ce6c72444da2702f1e4a927ffbc4533dea8abbf40f7065fa929be7a4b9ac49d788612550ca587ea6b16be1d24691814f9dec2bc81d7d27aeb48690e32be4

data/CHANGELOG.md

@@ -1,14 +1,38 @@
 # Change log
 
-<!--
-## master (unreleased)
+## 3.0.7 (2021-02-22)
 
-### New features
+* Adapt schema definitions handling when using Swagger-standard JSON
 
-### Bug fixes
+## 3.0.6 (2021-02-14)
 
-### Changes
--->
+* Remove option `json_format` from {Schemacop::Schema3.as_json as_json} again.
+  If you need to use the swagger format, use
+  {Schemacop::V3::Context.with_json_format} instead.
+
+* Rename `Schemacop::V3::Context.spawn_with` to
+  {Schemacop::V3::Context.with_json_format} and make keyword argument
+  `json_format` a positional argument.
+
+## 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)
 

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/VERSION

@@ -1 +1 @@
-3.0.2
+3.0.7

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 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)
@@ -157,12 +161,13 @@ module Schemacop
       end
 
       def process_json(attrs, json)
-        if @schemas.any?
+        if !context.swagger_json? && @schemas.any?
           json[:definitions] = {}
           @schemas.each do |name, subschema|
             json[:definitions][name] = subschema.as_json
           end
         end
+
         attrs.each do |attr|
           if options.include?(attr)
             json[attr.to_s.camelize(:lower).to_sym] = options[attr]
@@ -170,7 +175,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/reference_node.rb

@@ -11,7 +11,11 @@ module Schemacop
       end
 
       def as_json
-        process_json([], '$ref': "#/definitions/#{@path}")
+        if context.swagger_json?
+          process_json([], '$ref': "#/components/schemas/#{@path}")
+        else
+          process_json([], '$ref': "#/definitions/#{@path}")
+        end
       end
 
       def _validate(data, result:)

data/lib/schemacop/v3/string_node.rb

@@ -4,7 +4,6 @@ module Schemacop
       ATTRIBUTES = %i[
         min_length
         max_length
-        pattern
         format
       ].freeze
 
@@ -23,7 +22,7 @@ module Schemacop
       # 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
@@ -31,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:)
@@ -50,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 #
@@ -121,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.2 ruby lib
+# stub: schemacop 3.0.7 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "schemacop".freeze
-  s.version = "3.0.2"
+  s.version = "3.0.7"
 
   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-14"
+  s.date = "2021-02-22"
   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,13 @@ 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
+    Schemacop.context.with_json_format(:swagger) do
+      assert_equal expected_json.as_json, @schema.as_json.as_json
+    end
+  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
 
@@ -314,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.2
+  version: 3.0.7
 platform: ruby
 authors:
 - Sitrox
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-14 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport