json_schemer 0.2.20 → 0.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79ed6f849e3328efd2414b4015f6e1d2d4d897d5aa97400fabf99f0dd5c2dbc5
-  data.tar.gz: e33eb4f20852cf54fd14d591d2a2cee7892ada8516477e78f605107eebc7a6c8
+  metadata.gz: bc9ff5876e71054ee601dc4464c99560e86557796ef792e36512e1f08725a065
+  data.tar.gz: 5ee26787348f3aecb1a591c38c7bccc7aaf4166fd14d1299999d426ecaa15893
 SHA512:
-  metadata.gz: 611e3e327169b79b74adb979b00fd0e8124ac224c3971bb7f02dfc8040c17024720f4bd0308428eaa79c138c5ab461cb06ae9ea12b122ca4ed75ad0e396804bd
-  data.tar.gz: ee237ca11f77f20aa4d1dd7a1c192744019abfddcaeebaf5e1c0e63ebdf53eb15fc1a3c52a3f34af9bee41f868b28f0f2ae1e131476880d46177ad10be5c4ea8
+  metadata.gz: 9b5dc77e4a136d9dd7ab774e530880188c3125647535707d67b9b09e615e538bfe826249fd53644d3dc452e8387667bc74a3e24ec21f847145bc4b92de15371d
+  data.tar.gz: 160ead197e1f0a61090e936a526e4753156b185e4049db6d5ca7efb9c8bbf4430ebd9a0eff952299fc5bdb0b93a063745d9be3e919bee80ce93c05864a9655b7

data/.github/workflows/ci.yml

@@ -23,4 +23,9 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
-    - run: bundle exec rake test
+    - run: |
+        mkdir -p tmp/gems
+        gem build json_schemer.gemspec
+        gem install --local --ignore-dependencies --no-document --install-dir tmp/gems json_schemer-*.gem
+        rm json_schemer-*.gem
+        bin/rake test

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json_schemer (0.2.20)
+    json_schemer (0.2.22)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
@@ -13,9 +13,9 @@ GEM
     ecma-re-validator (0.3.0)
       regexp_parser (~> 2.0)
     hana (1.3.7)
-    minitest (5.14.3)
-    rake (13.0.1)
-    regexp_parser (2.1.1)
+    minitest (5.15.0)
+    rake (13.0.6)
+    regexp_parser (2.3.1)
     uri_template (0.7.0)
 
 PLATFORMS
@@ -28,4 +28,4 @@ DEPENDENCIES
   rake (~> 13.0)
 
 BUNDLED WITH
-   2.2.11
+   2.3.11

data/README.md

@@ -110,10 +110,41 @@ JSONSchemer.schema(
   # 'net/http'/proc/lambda/respond_to?(:call)
   # 'net/http': proc { |uri| JSON.parse(Net::HTTP.get(uri)) }
   # default: proc { |uri| raise UnknownRef, uri.to_s }
-  ref_resolver: 'net/http'
+  ref_resolver: 'net/http',
+  
+  # use different method to match regexes
+  # 'ecma'/'ruby'/proc/lambda/respond_to?(:call)
+  # default: 'ecma'
+  regexp_resolver: proc do |pattern|
+    RE2::Regexp.new(pattern)
+  end
 )
 ```
 
+## CLI
+
+The `json_schemer` executable takes a JSON schema file as the first argument followed by one or more JSON data files to validate. If there are any validation errors, it outputs them and returns an error code.
+
+Validation errors are output as single-line JSON objects. The `--errors` option can be used to limit the number of errors returned or prevent output entirely (and fail fast).
+
+The schema or data can also be read from stdin using `-`.
+
+```
+% json_schemer --help
+Usage:
+  json_schemer [options] <schema> <data>...
+  json_schemer [options] <schema> -
+  json_schemer [options] - <data>...
+  json_schemer -h | --help
+  json_schemer --version
+
+Options:
+  -e, --errors MAX                 Maximum number of errors to output
+                                   Use "0" to validate with no output
+  -h, --help                       Show help
+  -v, --version                    Show version
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/exe/json_schemer

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'json'
+require 'optparse'
+require 'pathname'
+require 'json_schemer'
+
+parser = OptionParser.new('Usage:', 32, '  ')
+parser.separator("  #{parser.program_name} [options] <schema> <data>...")
+parser.separator("  #{parser.program_name} [options] <schema> -")
+parser.separator("  #{parser.program_name} [options] - <data>...")
+parser.separator("  #{parser.program_name} -h | --help")
+parser.separator("  #{parser.program_name} --version")
+parser.separator('')
+parser.separator('Options:')
+parser.on('-e', '--errors MAX', Integer, 'Maximum number of errors to output', 'Use "0" to validate with no output')
+parser.on_tail('-h', '--help', 'Show help')
+parser.on_tail('-v', '--version', 'Show version')
+
+options = {}
+parser.parse!(:into => options)
+
+if options[:help]
+  $stdout.puts(parser)
+  exit
+end
+
+if options[:version]
+  $stdout.puts("#{parser.program_name} #{JSONSchemer::VERSION}")
+  exit
+end
+
+if ARGV.size == 0
+  $stderr.puts("#{parser.program_name}: no schema or data")
+  exit(false)
+end
+
+if ARGV.size == 1
+  $stderr.puts("#{parser.program_name}: no data")
+  exit(false)
+end
+
+if ARGV.count('-') > 1
+  $stderr.puts("#{parser.program_name}: multiple stdin")
+  exit(false)
+end
+
+errors = 0
+schema = ARGF.file.is_a?(File) ? Pathname.new(ARGF.file.path) : ARGF.file.read
+schemer = JSONSchemer.schema(schema)
+
+while ARGV.any?
+  data = JSON.parse(ARGF.skip.file.read)
+  schemer.validate(data).each do |error|
+    exit(false) if options[:errors] == 0
+    errors += 1
+    $stdout.puts(JSON.generate(error))
+    exit(false) if options[:errors] == errors
+  end
+end
+
+exit(errors.zero?)

data/lib/json_schemer/cached_resolver.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module JSONSchemer
+  class CachedResolver
+    def initialize(&resolver)
+      @resolver = resolver
+      @cache = {}
+    end
+
+    def call(*args)
+      @cache[args] = @resolver.call(*args) unless @cache.key?(args)
+      @cache[args]
+    end
+  end
+
+  class CachedRefResolver < CachedResolver; end
+end

data/lib/json_schemer/format.rb

@@ -60,7 +60,7 @@ module JSONSchemer
     def valid_date_time?(data)
       DateTime.rfc3339(data)
       DATE_TIME_OFFSET_REGEX.match?(data)
-    rescue ArgumentError => e
+    rescue ArgumentError
       false
     end
 

data/lib/json_schemer/schema/base.rb

@@ -30,6 +30,14 @@ module JSONSchemer
         :eol => '\z'
       }.freeze
 
+      ECMA_262_REGEXP_RESOLVER = proc do |pattern|
+        Regexp.new(
+          Regexp::Scanner.scan(pattern).map do |type, token, text|
+            type == :anchor ? RUBY_REGEX_ANCHORS_TO_ECMA_262.fetch(token, text) : text
+          end.join
+        )
+      end
+
       INSERT_DEFAULT_PROPERTY = proc do |data, property, property_schema, _parent|
         if !data.key?(property) && property_schema.is_a?(Hash) && property_schema.key?('default')
           data[property] = property_schema.fetch('default').clone
@@ -44,7 +52,8 @@ module JSONSchemer
         after_property_validation: nil,
         formats: nil,
         keywords: nil,
-        ref_resolver: DEFAULT_REF_RESOLVER
+        ref_resolver: DEFAULT_REF_RESOLVER,
+        regexp_resolver: 'ecma'
       )
         raise InvalidSymbolKey, 'schemas must use string keys' if schema.is_a?(Hash) && !schema.empty? && !schema.first.first.is_a?(String)
         @root = schema
@@ -54,7 +63,15 @@ module JSONSchemer
         @after_property_validation = [*after_property_validation]
         @formats = formats
         @keywords = keywords
-        @ref_resolver = ref_resolver == 'net/http' ? CachedRefResolver.new(&NET_HTTP_REF_RESOLVER) : ref_resolver
+        @ref_resolver = ref_resolver == 'net/http' ? CachedResolver.new(&NET_HTTP_REF_RESOLVER) : ref_resolver
+        @regexp_resolver = case regexp_resolver
+        when 'ecma'
+          CachedResolver.new(&ECMA_262_REGEXP_RESOLVER)
+        when 'ruby'
+          CachedResolver.new(&Regexp.method(:new))
+        else
+          regexp_resolver
+        end
       end
 
       def valid?(data)
@@ -204,7 +221,7 @@ module JSONSchemer
 
     private
 
-      attr_reader :root, :formats, :keywords, :ref_resolver
+      attr_reader :root, :formats, :keywords, :ref_resolver, :regexp_resolver
 
       def id_keyword
         ID_KEYWORD
@@ -228,7 +245,8 @@ module JSONSchemer
           format: format?,
           formats: formats,
           keywords: keywords,
-          ref_resolver: ref_resolver
+          ref_resolver: ref_resolver,
+          regexp_resolver: regexp_resolver
         )
       end
 
@@ -398,7 +416,7 @@ module JSONSchemer
 
         yield error(instance, 'maxLength') if max_length && data.size > max_length
         yield error(instance, 'minLength') if min_length && data.size < min_length
-        yield error(instance, 'pattern') if pattern && ecma_262_regex(pattern) !~ data
+        yield error(instance, 'pattern') if pattern && resolve_regexp(pattern) !~ data
         yield error(instance, 'format') if format? && spec_format?(format) && !valid_spec_format?(data, format)
 
         if content_encoding || content_media_type
@@ -551,7 +569,7 @@ module JSONSchemer
 
           if pattern_properties
             regex_pattern_properties ||= pattern_properties.map do |pattern, property_schema|
-              [pattern, ecma_262_regex(pattern), property_schema]
+              [pattern, resolve_regexp(pattern), property_schema]
             end
             regex_pattern_properties.each do |pattern, regex, property_schema|
               if regex.match?(key)
@@ -596,15 +614,6 @@ module JSONSchemer
         nil
       end
 
-      def ecma_262_regex(pattern)
-        @ecma_262_regex ||= {}
-        @ecma_262_regex[pattern] ||= Regexp.new(
-          Regexp::Scanner.scan(pattern).map do |type, token, text|
-            type == :anchor ? RUBY_REGEX_ANCHORS_TO_ECMA_262.fetch(token, text) : text
-          end.join
-        )
-      end
-
       def join_uri(a, b)
         b = URI.parse(b) if b
         if a && b && a.relative? && b.relative?
@@ -652,6 +661,10 @@ module JSONSchemer
       def resolve_ref(uri)
         ref_resolver.call(uri) || raise(InvalidRefResolution, uri.to_s)
       end
+
+      def resolve_regexp(pattern)
+        regexp_resolver.call(pattern) || raise(InvalidRegexpResolution, pattern)
+      end
     end
   end
 end

data/lib/json_schemer/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module JSONSchemer
-  VERSION = '0.2.20'
+  VERSION = '0.2.22'
 end

data/lib/json_schemer.rb

@@ -17,7 +17,7 @@ require 'uri_template'
 require 'json_schemer/version'
 require 'json_schemer/format'
 require 'json_schemer/errors'
-require 'json_schemer/cached_ref_resolver'
+require 'json_schemer/cached_resolver'
 require 'json_schemer/schema/base'
 require 'json_schemer/schema/draft4'
 require 'json_schemer/schema/draft6'
@@ -27,6 +27,7 @@ module JSONSchemer
   class UnsupportedMetaSchema < StandardError; end
   class UnknownRef < StandardError; end
   class InvalidRefResolution < StandardError; end
+  class InvalidRegexpResolution < StandardError; end
   class InvalidFileURI < StandardError; end
   class InvalidSymbolKey < StandardError; end
 
@@ -46,7 +47,7 @@ module JSONSchemer
     raise InvalidFileURI, 'cannot have a host (use `file:///`)' if uri.host && !uri.host.empty?
     path = uri.path
     path = path[1..-1] if path.match?(WINDOWS_URI_PATH_REGEX)
-    JSON.parse(File.read(path))
+    JSON.parse(File.read(URI::DEFAULT_PARSER.unescape(path)))
   end
 
   class << self
@@ -55,11 +56,11 @@ module JSONSchemer
       when String
         schema = JSON.parse(schema)
       when Pathname
-        uri = URI.parse(File.join('file:', schema.realpath))
+        uri = URI.parse(File.join('file:', URI::DEFAULT_PARSER.escape(schema.realpath.to_s)))
         if options.key?(:ref_resolver)
           schema = FILE_URI_REF_RESOLVER.call(uri)
         else
-          ref_resolver = CachedRefResolver.new(&FILE_URI_REF_RESOLVER)
+          ref_resolver = CachedResolver.new(&FILE_URI_REF_RESOLVER)
           schema = ref_resolver.call(uri)
           options[:ref_resolver] = ref_resolver
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schemer
 version: !ruby/object:Gem::Version
-  version: 0.2.20
+  version: 0.2.22
 platform: ruby
 authors:
 - David Harsha
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2022-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,10 +108,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
 - davishmcclurg@gmail.com
-executables: []
+executables:
+- json_schemer
 extensions: []
 extra_rdoc_files: []
 files:
@@ -123,10 +124,12 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rake
 - bin/setup
+- exe/json_schemer
 - json_schemer.gemspec
 - lib/json_schemer.rb
-- lib/json_schemer/cached_ref_resolver.rb
+- lib/json_schemer/cached_resolver.rb
 - lib/json_schemer/errors.rb
 - lib/json_schemer/format.rb
 - lib/json_schemer/schema/base.rb
@@ -138,7 +141,7 @@ homepage: https://github.com/davishmcclurg/json_schemer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -153,8 +156,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: JSON Schema validator. Supports drafts 4, 6, and 7.
 test_files: []

data/lib/json_schemer/cached_ref_resolver.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-module JSONSchemer
-  class CachedRefResolver
-    def initialize(&ref_resolver)
-      @ref_resolver = ref_resolver
-      @cache = {}
-    end
-
-    def call(uri)
-      @cache[uri] = @ref_resolver.call(uri) unless @cache.key?(uri)
-      @cache[uri]
-    end
-  end
-end