openc-json_schema 0.0.13 → 0.0.14

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDAyZjEwMGFjN2IzYmMyZTEyYzhjMmNhZTc1Mjg4NDE3NzdmZGRjZA==
-  data.tar.gz: !binary |-
-    YTFkZjIyNmI3MzQzNDE5YWY5MjU4YTcwM2UzOTQ0ODUwYjIzNzhkOQ==
+SHA1:
+  metadata.gz: ccb1b4275ae9645554976a7b87d2b5b6cdb73e5c
+  data.tar.gz: 3b95c93c17c65d7c5d6b0b183fc3e03d8937692a
 SHA512:
-  metadata.gz: !binary |-
-    NTJjYTVlNmM1NzU4ZDZkOTk4NGQ3YzJkODQ3YzhhNmM4MWQ1NTcwYjc2NzI2
-    M2UxOWM1ODc3MWZlM2VhMDRmYjJhMmVmMzc3YWNhODgyMzc0NGVmN2JkMGIy
-    OTE0MWIzZDZkNzBkZjVkMjJkOTA3ODVmNmY3NTkyMmRmMzNiOGI=
-  data.tar.gz: !binary |-
-    MzYwY2MyMmM4N2ZkOTVmZjVlZDVmZDc0MzViYjllNTE5YTZlNWJjNDZhMjI1
-    Y2Y0OTRiM2JkYmNiNTE3NWVjNDEyOTVhNzZmZDYyZTljMjUwNTczMGYyZGZl
-    YTgwMTE0ZjY5ZTBkY2I1MmNkMjhjMWFiNGU1YzY4NTYwN2QwN2I=
+  metadata.gz: 3e7489d1dc42eb390e3d8d6e1b9993aa4ec377b6ad4a9bff89092ffdbb591a29da0128b052ef10450c42fef470fd36d9693bccf20503118432c27b539bb056f7
+  data.tar.gz: fa296c3de7ea00c77736db7e9d409d1ee6412b4dd4d38cebd77931c0daa3665151b0f06598f5e7f0ed7ed8d76b183b7b39bd920a250275ada466a6458150fbfd

data/.gitignore

@@ -1,2 +1,4 @@
 spec/tmp/*.json
 coverage
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0

data/Gemfile

@@ -1,6 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in openc-json-schema.gemspec
+# Specify your gem's dependencies in the gemspec
 gemspec
-
-gem 'simplecov', :require => false

data/{LICENSE.txt → LICENSE}

@@ -1,7 +1,5 @@
 Copyright (c) 2015 Peter Inglesby
 
-MIT License
-
 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

data/README.md

@@ -1,20 +1,19 @@
 # Openc::JsonSchema
 
+[![Gem Version](https://badge.fury.io/rb/openc-json_schema.svg)](https://badge.fury.io/rb/openc-json_schema)
+[![Build Status](https://secure.travis-ci.org/openc/openc-json_schema.png)](https://travis-ci.org/openc/openc-json_schema)
+[![Dependency Status](https://gemnasium.com/openc/openc-json_schema.png)](https://gemnasium.com/openc/openc-json_schema)
+[![Coverage Status](https://coveralls.io/repos/openc/openc-json_schema/badge.png)](https://coveralls.io/r/openc/openc-json_schema)
+[![Code Climate](https://codeclimate.com/github/openc/openc-json_schema.png)](https://codeclimate.com/github/openc/openc-json_schema)
+
 A wrapper around the json-schema gem to provide better error messages on
 validation failure.
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'openc-json_schema'
-```
-
-And then execute:
+## Releasing a new version
 
-    $ bundle
+Bump the version in `lib/openc/json_schema/version.rb` according to the [Semantic Versioning](http://semver.org/) convention, then:
 
-Or install it yourself as:
+    git commit lib/openc/json_schema/version.rb -m 'Release new version'
+    rake release # requires Rubygems credentials
 
-    $ gem install openc-json_schema
+Finally, [rebuild the Docker image](https://github.com/openc/morph-docker-ruby#readme).

data/Rakefile

@@ -1,2 +1,16 @@
-require "bundler/gem_tasks"
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

data/lib/openc/json_schema.rb

@@ -1,3 +1,4 @@
+require 'json-pointer'
 require 'json-schema'
 
 require 'openc/json_schema/date_converter'

data/lib/openc/json_schema/validator.rb

@@ -14,59 +14,61 @@ module Openc
         convert_error(extract_error(error, record, validator))
       end
 
+    private
+
+      # Returns the value of the `oneOf` keyword that is within the given schema
+      # at the given path.
+      #
+      # @param [Hash] schema a schema
+      # @param [Array<String>] path a path, based on a JSON Pointer
+      # @return [Array<Hash>] the value of the `oneOf` keyword
+      def walk_schema(schema, path)
+        if schema.key?('oneOf')
+          schema['oneOf']
+        elsif schema.key?('properties')
+          walk_schema(schema['properties'].fetch(path.shift), path)
+        elsif schema.key?('items')
+          walk_schema(schema['items'], path.drop(1))
+        end
+      end
+
       def extract_error(error, record, validator)
         if error[:failed_attribute] == 'OneOf'
           if error[:message].match(/did not match any/)
-            path_elements = fragment_to_path(error[:fragment]).split('.')
-
-            json_schema = Utils.extract_json_schema(validator)
-            schema = json_schema.schema
-
-            path_elements.each do |element|
-              record = record[element]
-              schema = schema['properties'][element]
+            record = JsonPointer.new(record, error[:fragment][1..-1]).value
+            schema = JSON::Validator.schema_for_uri(error[:schema]).schema
 
-              if (ref = schema['$ref'])
-                schema_uri = validator.absolutize_ref_uri(ref, json_schema.uri)
-                json_schema = JSON::Validator.schema_reader.read(schema_uri)
-                schema = json_schema.schema
-              end
-            end
-
-            one_of_schemas = schema['oneOf']
+            path = fragment_to_path(error[:fragment]).split('.')
+            one_of = walk_schema(schema, path).each_with_index
 
-            schemas_for_type_with_ix = case record
+            # Try to report errors for relevant `oneOf` schemas only.
+            schemas_matching_type = case record
             when Hash
-              one_of_schemas.each_with_index.reject {|s, ix| s['properties'].nil?}
+              one_of.select{|schema, _| schema.key?('properties')}
             when String
-              one_of_schemas.each_with_index.select {|s, ix| s['type'] == 'string' || (s['type'].nil? && s['properties'].nil?)}
+              one_of.select{|schema, _| schema['type'] == 'string' || schema['type'].nil? && schema['properties'].nil?}
             when Integer
-              one_of_schemas.each_with_index.select {|s, ix| s['type'] == 'integer'}
+              one_of.select{|schema, _| schema['type'] == 'integer'}
             when Array
-              one_of_schemas.each_with_index.select {|s, ix| s['type'] == 'array'}
+              one_of.select{|schema, _| schema['type'] == 'array'}
             else
               raise "Unexpected type: #{record}"
             end
 
-            case schemas_for_type_with_ix.size
-            when 0
-              return error
-            when 1
-              ix = schemas_for_type_with_ix[0][1]
-              return error[:errors][:"oneof_#{ix}"][0]
-            else
-              if record.is_a?(Hash)
-                schemas_for_type_with_ix.each do |s, ix|
-                  s['properties'].each do |k, v|
-                    next if v['enum'].nil?
-
-                    if v['enum'].include?(record[k])
-                      return error[:errors][:"oneof_#{ix}"][0]
-                    end
+            matches = schemas_matching_type.size
+
+            if matches == 1
+              i = schemas_matching_type[0][1]
+              return error[:errors][:"oneof_#{i}"][0]
+            end
+
+            if matches > 1 && record.is_a?(Hash)
+              schemas_matching_type.each do |schema, i|
+                schema['properties'].each do |key, value|
+                  if value['enum'] && value['enum'].include?(record[key])
+                    return error[:errors][:"oneof_#{i}"][0]
                   end
                 end
-              else
-                return error
               end
             end
           end
@@ -86,12 +88,14 @@ module Openc
           path = fragment_to_path("#{error[:fragment]}/#{missing_property}")
           type = :missing
           message = "Missing required property: #{path}"
+
         when 'AdditionalProperties'
           match = error[:message].match(/contains additional properties \["(.*)"\] outside of the schema/)
           additional_property = match[1].split('", "')[0]
           path = fragment_to_path("#{error[:fragment]}/#{additional_property}")
           type = :additional
           message = "Disallowed additional property: #{path}"
+
         when 'OneOf'
           if error[:message].match(/did not match any/)
             type = :one_of_no_matches
@@ -100,27 +104,32 @@ module Openc
             type = :one_of_many_matches
             message = "Multiple possible matches for property: #{path}"
           end
+
         when 'AnyOf'
           type = :any_of_no_matches
           message = "No match for property: #{path}"
+
         when 'MinLength'
           match = error[:message].match(/minimum string length of (\d+) in/)
           min_length = match[1].to_i
           type = :too_short
           message = "Property too short: #{path} (must be at least #{min_length} characters)"
           extra_params = {:length => min_length}
+
         when 'MaxLength'
           match = error[:message].match(/maximum string length of (\d+) in/)
           max_length = match[1].to_i
           type = :too_long
           message = "Property too long: #{path} (must be at most #{max_length} characters)"
           extra_params = {:length => max_length}
+
         when 'TypeV4'
           match = error[:message].match(/the following types?: ([\w\s,]+) in schema/)
           allowed_types = match[1].split(',').map(&:strip)
           type = :type_mismatch
           message = "Property of wrong type: #{path} (must be of type #{allowed_types.join(', ')})"
           extra_params = {:allowed_types => allowed_types}
+
         when 'Enum'
           match = error[:message].match(/the following values: ([\w\s,]+) in schema/)
           allowed_values = match[1].split(',').map(&:strip)
@@ -131,6 +140,7 @@ module Openc
             message = "Property not an allowed value: #{path} (must be one of #{allowed_values.join(', ')})"
           end
           extra_params = {:allowed_values => allowed_values}
+
         else
           if error[:message].match(/must be of format yyyy-mm-dd/)
             type = :format_mismatch

data/lib/openc/json_schema/version.rb

@@ -1,5 +1,5 @@
 module Openc
   module JsonSchema
-    VERSION = '0.0.13'
+    VERSION = '0.0.14'
   end
 end

data/openc-json_schema.gemspec

@@ -1,25 +1,25 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'openc/json_schema/version'
+require File.expand_path('../lib/openc/json_schema/version', __FILE__)
 
-Gem::Specification.new do |spec|
-  spec.name          = "openc-json_schema"
-  spec.version       = Openc::JsonSchema::VERSION
+Gem::Specification.new do |gem|
+  gem.name    = "openc-json_schema"
+  gem.version = Openc::JsonSchema::VERSION
 
-  spec.author        = "OpenCorporates"
-  spec.email         = "info@opencorporates.com"
-  spec.summary       = "Utilities for validating JSON"
-  spec.license       = "MIT"
+  gem.author      = "OpenCorporates"
+  gem.email       = "info@opencorporates.com"
+  gem.homepage    = "https://github.com/openc/openc-json_schema"
+  gem.summary     = "Utilities for validating JSON"
+  gem.license     = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  gem.add_dependency "json-schema", "~> 2.6.0"
+  gem.add_dependency "json-pointer"
 
-  spec.add_dependency "json-schema-openc-fork", "0.0.1"
+  gem.add_development_dependency "bundler", "~> 1.7"
+  gem.add_development_dependency "coveralls"
+  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "rspec", "~> 3.0"
 end

data/spec/openc_json_schema_spec.rb

@@ -425,6 +425,20 @@ describe Openc::JsonSchema do
       error = 'Property not of expected format: aaa (must be of format yyyy-mm-dd)'
       expect([schema, record]).to fail_validation_with(error)
     end
+
+    specify 'when oneOf is an item in an array' do
+      schema = {
+        'type' => 'array',
+        'items' => {
+          'oneOf' => [{
+            'type' => 'string',
+          }]
+        }
+      }
+      record = [1]
+      error = 'No match for property: 0'
+      expect([schema, record]).to fail_validation_with(error)
+    end
   end
 
   describe '.convert_dates' do

data/spec/spec_helper.rb

@@ -1,50 +1,33 @@
-require 'simplecov'
-SimpleCov.start
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter "spec"
+end
 
 require 'openc/json_schema'
 
-def get_schema_path(schema_or_path)
-  case schema_or_path
-  when Hash
-    json_data = schema_or_path.to_json
-    filename = Digest::MD5.hexdigest(json_data) + '.json'
-    schema_path = File.join('spec', 'tmp', filename)
-    File.open(schema_path, 'w') {|f| f.write(json_data)}
-  when String
-    schema_path = schema_or_path
-  else
-    raise
-  end
-
-  schema_path
-end
-
 RSpec::Matchers.define(:fail_validation_with) do |expected|
-  match do |actual|
-    schema_or_path, record = actual
-    @error = Openc::JsonSchema.validate(get_schema_path(schema_or_path), record)[:message]
-    expect(@error).to eq(expected)
+  match do |(schema_or_path, record)|
+    @actual = Openc::JsonSchema.validate(schema_or_path, record)[:message]
+    expect(@actual).to eq(expected)
   end
 
   failure_message do |actual|
-    "Expected error to be #{expected}, but was #{@error}"
+    "Expected error to be #{expected}, but was #{@actual}"
   end
 end
 
 RSpec::Matchers.define(:be_valid) do
-  match do |actual|
-    schema_or_path, record = actual
-    error = Openc::JsonSchema.validate(get_schema_path(schema_or_path), record)
+  match do |(schema_or_path, record)|
+    error = Openc::JsonSchema.validate(schema_or_path, record)
     expect(error).to eq(nil)
   end
 end
 
 RSpec::Matchers.define(:convert_dates_to) do |expected|
-  match do |actual|
-    schema_or_path, record = actual
-    schema_path = get_schema_path(schema_or_path)
-
-    converted_record = Openc::JsonSchema.convert_dates(schema_path, record)
+  match do |(schema_or_path, record)|
+    converted_record = Openc::JsonSchema.convert_dates(schema_or_path, record)
     expect(converted_record).to eq(expected)
   end
 end

metadata

@@ -1,81 +1,109 @@
 --- !ruby/object:Gem::Specification
 name: openc-json_schema
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - OpenCorporates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-12 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: json-pointer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: json-schema-openc-fork
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :runtime
+        version: '3.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '3.0'
 description: 
 email: info@opencorporates.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - lib/openc/json_schema.rb
@@ -85,7 +113,6 @@ files:
 - lib/openc/json_schema/validator.rb
 - lib/openc/json_schema/version.rb
 - openc-json_schema.gemspec
-- publish.sh
 - spec/openc_json_schema_spec.rb
 - spec/schemas/aaa.json
 - spec/schemas/ccc.json
@@ -103,8 +130,7 @@ files:
 - spec/schemas/lll.json
 - spec/schemas/yyy.json
 - spec/spec_helper.rb
-- spec/tmp/.gitkeep
-homepage: 
+homepage: https://github.com/openc/openc-json_schema
 licenses:
 - MIT
 metadata: {}
@@ -114,17 +140,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Utilities for validating JSON
@@ -146,5 +172,4 @@ test_files:
 - spec/schemas/lll.json
 - spec/schemas/yyy.json
 - spec/spec_helper.rb
-- spec/tmp/.gitkeep
 has_rdoc: 

data/Gemfile.lock

@@ -1,41 +0,0 @@
-PATH
-  remote: .
-  specs:
-    openc-json_schema (0.0.13)
-      json-schema-openc-fork (= 0.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.7)
-    diff-lcs (1.2.5)
-    json-schema-openc-fork (0.0.1)
-      addressable (~> 2.3)
-    multi_json (1.10.1)
-    rake (10.4.2)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.7)
-  openc-json_schema!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  simplecov

data/publish.sh

@@ -1,9 +0,0 @@
-#!/bin/bash
-
-gem build openc-json_schema.gemspec
-gem push $(ls *gem|tail -1)
-
-function clean {
-rm *gem
-}
-trap clean EXIT