schemacop 3.0.0.rc5 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fdf2a714534a94acf7c83e028fe7ce1e4b62c76266cc3e01786cd408d5c17c9
-  data.tar.gz: 21ba336e330bf881d4f99cb63c4070dea7559813d7387faa0a2ee53c85fdbb1e
+  metadata.gz: 2b28a407ae498b94fa8c7897895d052c1bea34ebeee991ab992b4a86aa94f7ab
+  data.tar.gz: 7bd4dbd4f0a51ac591a7ff6189fd98e803597c0487f8a16e43c78774dc75c5e3
 SHA512:
-  metadata.gz: 3636130ba0c0ee471e97e3ef9e259cc86840eaaf6b6435466fcaa17dafdb17aaff406b052e7e3eeffbbbb6e0f1fe3283feb5dda4dfcd5a008d3d60ee8c01f5bf
-  data.tar.gz: 46fa1c3b015cfa725e9c624f74fc16f0bf07c6db64e74282e12136c17dc664ae02edb128fe3110516728fab47c2fd105068fb2d9b318f617db39f82dc6264b64
+  metadata.gz: b40fb214b50815f65f87f978052f0c6bc38018340d00eeeddb68e392dfb44106e0d6ebeb5e908172113dadc57cd0f88bbdf1d230d38cd5dab31382f8d217f34a
+  data.tar.gz: cf87908ded44c22bd53b824e732f7447ade01608104cb55a844879fb7f17b2172b78c13b47adb0f373abbba3a90f75d353cf0f63ec5d74b16128eee780743db6

data/CHANGELOG.md

@@ -10,6 +10,30 @@
 ### Changes
 -->
 
+## 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
+
+* Read previous `3.0.0.rcX` entries for all changes included
+  in this stable release
+
 ## 3.0.0.rc5 (2021-02-05)
 
 * Use `ruby2_keywords` for compatibility with ruby `2.6.2`

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
@@ -1191,14 +1194,17 @@ local schemas > context schemas > global schemas
 
 Where:
 
-* local schemas: Defined by using the DSL method? `scm`
+* local schemas: Defined by using the DSL method `scm`
 * context schemas: Defined in the current context using `context.schema`
 * global schemas: Defined in a ruby file in the load path
 
 ### Rails applications
 
-In Rails applications, your schemas are automatically eager-laoded from the load
-path `'app/schemas'` when your application is started.
+In Rails applications, your schemas are automatically eager-loaded from the load
+path `'app/schemas'` when your application is started, unless your application
+is running in the `DEVELOPMENT` environment. In the `DEVELOPMENT` environment,
+schemas are loaded each time when they are used, and as such you can make changes
+to your external schemas without having to restart the server each time.
 
 After starting your application, you can reference them like normally defined
 reference schemas, with the name being relative to the load path.
@@ -1246,8 +1252,12 @@ schema.validate!({usr: {first_name: 'Joe', last_name: 'Doe', groups: [{name: 'fo
 ### Non-Rails applications
 
 Usage in non-Rails applications is the same as with usage in Rails applications,
-however you need to eager load the schemas yourself:
+however you might need to eager load the schemas yourself:
 
 ```ruby
 Schemacop::V3::GlobalContext.eager_load!
 ```
+
+As mentioned before, you can also use the external schemas without having to
+eager-load them, but if you use the schemas multiple times, it might be better
+to eager-load them on start of your application / script.

data/VERSION

@@ -1 +1 @@
-3.0.0.rc5
+3.0.4

data/lib/schemacop/railtie.rb

@@ -5,6 +5,13 @@ module Schemacop
       unless Rails.env.development?
         V3::GlobalContext.eager_load!
       end
+
+      # Tell Zeitwerk to ignore the files in our load path
+      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
+      end
     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 :examples_keyword
+
+      DEFAULT_EXAMPLES_KEYWORD = :examples
 
       def initialize
         @schemas = {}.with_indifferent_access.freeze
+        @examples_keyword = DEFAULT_EXAMPLES_KEYWORD
       end
 
       def schema(name, type = :hash, **options, &block)

data/lib/schemacop/v3/node.rb

@@ -170,7 +170,7 @@ module Schemacop
         end
 
         json[:title] = @title if @title
-        json[:examples] = @examples if @examples
+        json[Schemacop.context.examples_keyword] = @examples if @examples
         json[:description] = @description if @description
         json[:default] = @default if @default
         json[:enum] = @enum.to_a if @enum

data/lib/schemacop/v3/string_node.rb

@@ -16,6 +16,7 @@ module Schemacop
         email:       URI::MailTo::EMAIL_REGEXP,
         boolean:     /^(true|false)$/,
         binary:      nil,
+        symbol:      nil,
         integer:     /^-?[0-9]+$/,
         number:      /^-?[0-9]+(\.[0-9]+)?$/
       }.freeze
@@ -87,6 +88,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

data/schemacop.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: schemacop 3.0.0.rc5 ruby lib
+# stub: schemacop 3.0.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "schemacop".freeze
-  s.version = "3.0.0.rc5"
+  s.version = "3.0.4"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1".freeze) if s.respond_to? :required_rubygems_version=
+  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-05"
+  s.date = "2021-02-15"
   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/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/string_node_test.rb

@@ -165,6 +165,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]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemacop
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc5
+  version: 3.0.4
 platform: ruby
 authors:
 - Sitrox
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-02-15 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
@@ -288,12 +288,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      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.