json-matchers 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2bc10af4131d3f0ed42c314a9a9647547051e6f
-  data.tar.gz: bd823542ce64cab597d9f9689a7b49bce21494e8
+  metadata.gz: 2f5663f28a62b7036c41b7648cc84db8be036445
+  data.tar.gz: 4dc11e206e1010683b3b92277bd61f314fdcb95c
 SHA512:
-  metadata.gz: 8ce7b02e972556b4d961a245b4766e537d21b7adef732c4f0cab6aecc990ca01258a062acbb73a6773fc051769f374ead55a474aeb402a4d8311fdc2f52a4a30
-  data.tar.gz: e8b8f5c80dfe722447f5bea3cf95c369b23c1eab49439383e5a31a87d2ab27126a5ac1d6b38d685f31883629aa4e558e4d4bce06d3589c384323b419b6ee19ac
+  metadata.gz: d710ea1267974d7dd9e7bba6181f2d39206d7552ec3c2613f17f05239ec546ee85ab27ef580d817b7ce434849d201c6e32b06a57beb50821e5a8b961fd067f9f
+  data.tar.gz: 85d2db20bde72739562656cf0b651a9d5df49319cfdd3244b661d623dfc5ec84b231a965268c799c083d938af4732183a510d2abae470091cce4ec8e473bbc57

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 master
 ------
 
+0.3.1
+-----
+
+* BREAKING CHANGE: Rename module to `JsonMatchers`. This resolves clashing with
+  gems like `oj` / `oj_mimic_json` that take control of the standard library's
+  `json` module. As a result, the file to require is now `json_matchers`,
+  instead of `json/matchers`.
+
+* No longer condone auto-loading RSpec. Add documentation around adding `require
+  "json_matchers/rspec"` to consumers' `spec/spec_helper.rb`
+
 0.3.0
 -----
 

data/README.md

@@ -1,4 +1,4 @@
-# JSON::Matchers
+# JsonMatchers
 
 Validate the JSON returned by your Rails JSON APIs
 
@@ -7,7 +7,9 @@ Validate the JSON returned by your Rails JSON APIs
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'json-matchers', require: false
+group :test do
+  gem "json-matchers", require: false
+end
 ```
 
 And then execute:
@@ -27,7 +29,7 @@ First, include it in your `spec_helper`:
 ```ruby
 # spec/spec_helper.rb
 
-require "json/matchers"
+require "json_matchers/rspec"
 ```
 
 Define your [JSON Schema](http://json-schema.org/example1.html) in the schema directory:
@@ -134,13 +136,13 @@ To learn more about `$ref`, check out [Understanding JSON Schema Structuring](ht
 
 By default, the schema directory is `spec/support/api/schemas`.
 
-This can be configured via `JSON::Matchers.schema_root`.
+This can be configured via `JsonMatchers.schema_root`.
 
 
 ```ruby
 # spec/support/json-matchers.rb
 
-JSON::Matchers.schema_root = "docs/api/schemas"
+JsonMatchers.schema_root = "docs/api/schemas"
 ```
 
 ## Contributing

data/json-matchers.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "json/matchers/version"
+require "json_matchers/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "json-matchers"
-  spec.version       = JSON::Matchers::VERSION
+  spec.version       = JsonMatchers::VERSION
   spec.authors       = ["Sean Doyle"]
   spec.email         = ["sean.p.doyle24@gmail.com"]
   spec.summary       = %q{Validate your Rails JSON API's JSON}

data/lib/json-matchers.rb

@@ -0,0 +1,12 @@
+warn <<-WARNING
+DEPRECATED: The `json-matchers` gem has been deprecated.
+
+Please replace change your Gemfile's reference from `json-matchers` to
+`json_matchers`.
+WARNING
+
+require "json_matchers"
+
+if defined?(RSpec)
+  require "json_matchers/rspec"
+end

data/lib/json/matchers.rb

@@ -1,20 +1,12 @@
-require "json/matchers/version"
-require "json/matchers/matcher"
-require "json/matchers/errors"
-require "active_support/all"
+warn <<-WARNING
+DEPRECATED: requiring the library via `require "json/matchers"` is deprecated.
 
-module JSON
-  module Matchers
-    mattr_accessor :schema_root
+To include the library, please add `require "json_matchers/rspec"` to your
+`spec/spec_helper.rb`.
+WARNING
 
-    self.schema_root = "#{Dir.pwd}/spec/support/api/schemas"
-
-    def self.path_to_schema(schema_name)
-      Pathname(schema_root).join("#{schema_name}.json")
-    end
-  end
-end
+require "json_matchers"
 
 if defined?(RSpec)
-  require "json/matchers/rspec"
+  require "json_matchers/rspec"
 end

data/lib/json_matchers.rb

@@ -0,0 +1,14 @@
+require "json_matchers/version"
+require "json_matchers/matcher"
+require "json_matchers/errors"
+require "active_support/all"
+
+module JsonMatchers
+  mattr_accessor :schema_root
+
+  self.schema_root = "#{Dir.pwd}/spec/support/api/schemas"
+
+  def self.path_to_schema(schema_name)
+    Pathname(schema_root).join("#{schema_name}.json")
+  end
+end

data/lib/json_matchers/errors.rb

@@ -0,0 +1,4 @@
+module JsonMatchers
+  InvalidSchemaError = Class.new(StandardError)
+  MissingSchema = Class.new(Errno::ENOENT)
+end

data/lib/json_matchers/matcher.rb

@@ -0,0 +1,37 @@
+require "json-schema"
+
+module JsonMatchers
+  class Matcher
+    def initialize(schema_path, **options)
+      @schema_path = schema_path
+      @options = options
+    end
+
+    def matches?(response)
+      @response = response
+
+      validator_options = {
+        strict: true,
+      }.merge(options)
+
+      JSON::Validator.validate!(
+        schema_path.to_s,
+        response.body,
+        validator_options,
+      )
+    rescue JSON::Schema::ValidationError => ex
+      @validation_failure_message = ex.message
+      false
+    rescue JSON::ParserError
+      raise InvalidSchemaError
+    end
+
+    def validation_failure_message
+      @validation_failure_message.to_s
+    end
+
+    private
+
+    attr_reader :schema_path, :options
+  end
+end

data/lib/json_matchers/rspec.rb

@@ -0,0 +1,83 @@
+require "json_matchers"
+
+module JsonMatchers
+  class RSpec < SimpleDelegator
+    attr_reader :schema_name
+
+    def initialize(schema_name, **options)
+      @schema_name = schema_name
+
+      super(JsonMatchers::Matcher.new(schema_path, options))
+    end
+
+    def failure_message(response)
+      <<-FAIL.strip_heredoc
+      expected
+
+      #{response.body}
+
+      to match schema "#{schema_name}":
+
+      #{schema_body}
+
+      ---
+
+      #{validation_failure_message}
+
+      FAIL
+    end
+
+    def failure_message_when_negated(response)
+      <<-FAIL.strip_heredoc
+      expected
+
+      #{response.body}
+
+      not to match schema "#{schema_name}":
+
+      #{schema_body}
+
+      ---
+
+      #{validation_failure_message}
+
+      FAIL
+    end
+
+    def schema_path
+      JsonMatchers.path_to_schema(schema_name)
+    end
+
+    def schema_body
+      File.read(schema_path)
+    end
+  end
+end
+
+if RSpec.respond_to?(:configure)
+  RSpec::Matchers.define :match_response_schema do |schema_name, **options|
+    matcher = JsonMatchers::RSpec.new(schema_name, options)
+
+    match do |response|
+      matcher.matches?(response)
+    end
+
+    if respond_to?(:failure_message)
+      failure_message do |response|
+        matcher.failure_message(response)
+      end
+
+      failure_message_when_negated do |response|
+        matcher.failure_message_when_negated(response)
+      end
+    else
+      failure_message_for_should do |response|
+        matcher.failure_message(response)
+      end
+
+      failure_message_for_should_not do |response|
+        matcher.failure_message_when_negated(response)
+      end
+    end
+  end
+end

data/lib/json_matchers/version.rb

@@ -0,0 +1,3 @@
+module JsonMatchers
+  VERSION = "0.3.1"
+end

data/spec/{json/matchers → json_matchers}/match_response_schema_spec.rb

@@ -1,10 +1,10 @@
-describe JSON::Matchers, "#match_response_schema" do
+describe JsonMatchers, "#match_response_schema" do
   it "fails with an invalid JSON body" do
     create_schema("foo", "")
 
     expect {
       expect(response_for("")).to match_response_schema("foo")
-    }.to raise_error(JSON::Matchers::InvalidSchemaError)
+    }.to raise_error(JsonMatchers::InvalidSchemaError)
   end
 
   it "does not fail with an empty JSON body" do

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require "json/matchers"
+require "json_matchers/rspec"
 
 Dir["./spec/support/*"].each { |file| require file }
 

data/spec/support/file_helpers.rb

@@ -1,5 +1,5 @@
 module FileHelpers
-  ORIGINAL_SCHEMA_ROOT = JSON::Matchers.schema_root
+  ORIGINAL_SCHEMA_ROOT = JsonMatchers.schema_root
 
   def create_schema(name, json)
     File.open("#{schema_root}/#{name}.json", "w") do |file|
@@ -23,7 +23,7 @@ module FileHelpers
   end
 
   def schema_root
-    JSON::Matchers.schema_root
+    JsonMatchers.schema_root
   end
 end
 
@@ -31,12 +31,12 @@ RSpec.configure do |config|
   config.include FileHelpers
 
   config.around do |example|
-    JSON::Matchers.schema_root = File.join(Dir.pwd, "spec", "fixtures", "schemas")
-    FileUtils.mkdir_p(JSON::Matchers.schema_root)
+    JsonMatchers.schema_root = File.join(Dir.pwd, "spec", "fixtures", "schemas")
+    FileUtils.mkdir_p(JsonMatchers.schema_root)
 
     example.run
 
-    FileUtils.rm_rf(JSON::Matchers.schema_root)
-    JSON::Matchers.schema_root = FileHelpers::ORIGINAL_SCHEMA_ROOT
+    FileUtils.rm_rf(JsonMatchers.schema_root)
+    JsonMatchers.schema_root = FileHelpers::ORIGINAL_SCHEMA_ROOT
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-matchers
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Sean Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -112,12 +112,14 @@ files:
 - README.md
 - Rakefile
 - json-matchers.gemspec
+- lib/json-matchers.rb
 - lib/json/matchers.rb
-- lib/json/matchers/errors.rb
-- lib/json/matchers/matcher.rb
-- lib/json/matchers/rspec.rb
-- lib/json/matchers/version.rb
-- spec/json/matchers/match_response_schema_spec.rb
+- lib/json_matchers.rb
+- lib/json_matchers/errors.rb
+- lib/json_matchers/matcher.rb
+- lib/json_matchers/rspec.rb
+- lib/json_matchers/version.rb
+- spec/json_matchers/match_response_schema_spec.rb
 - spec/spec_helper.rb
 - spec/support/file_helpers.rb
 homepage: https://github.com/thoughtbot/json-matchers
@@ -145,7 +147,7 @@ signing_key:
 specification_version: 4
 summary: Validate your Rails JSON API's JSON
 test_files:
-- spec/json/matchers/match_response_schema_spec.rb
+- spec/json_matchers/match_response_schema_spec.rb
 - spec/spec_helper.rb
 - spec/support/file_helpers.rb
 has_rdoc: 

data/lib/json/matchers/errors.rb

@@ -1,6 +0,0 @@
-module JSON
-  module Matchers
-    InvalidSchemaError = Class.new(StandardError)
-    MissingSchema = Class.new(Errno::ENOENT)
-  end
-end

data/lib/json/matchers/matcher.rb

@@ -1,39 +0,0 @@
-require "json-schema"
-
-module JSON
-  module Matchers
-    class Matcher
-      def initialize(schema_path, **options)
-        @schema_path = schema_path
-        @options = options
-      end
-
-      def matches?(response)
-        @response = response
-
-        validator_options = {
-          strict: true,
-        }.merge(options)
-
-        JSON::Validator.validate!(
-          schema_path.to_s,
-          response.body,
-          validator_options,
-        )
-      rescue JSON::Schema::ValidationError => ex
-        @validation_failure_message = ex.message
-        false
-      rescue JSON::ParserError
-        raise InvalidSchemaError
-      end
-
-      def validation_failure_message
-        @validation_failure_message.to_s
-      end
-
-      private
-
-      attr_reader :schema_path, :options
-    end
-  end
-end

data/lib/json/matchers/rspec.rb

@@ -1,83 +0,0 @@
-module JSON
-  module Matchers
-    class RSpec < SimpleDelegator
-      attr_reader :schema_name
-
-      def initialize(schema_name, **options)
-        @schema_name = schema_name
-
-        super(JSON::Matchers::Matcher.new(schema_path, options))
-      end
-
-      def failure_message(response)
-        <<-FAIL.strip_heredoc
-        expected
-
-        #{response.body}
-
-        to match schema "#{schema_name}":
-
-        #{schema_body}
-
-        ---
-
-        #{validation_failure_message}
-
-        FAIL
-      end
-
-      def failure_message_when_negated(response)
-        <<-FAIL.strip_heredoc
-        expected
-
-        #{response.body}
-
-        not to match schema "#{schema_name}":
-
-        #{schema_body}
-
-        ---
-
-        #{validation_failure_message}
-
-        FAIL
-      end
-
-      def schema_path
-        JSON::Matchers.path_to_schema(schema_name)
-      end
-
-      def schema_body
-        File.read(schema_path)
-      end
-    end
-  end
-end
-
-if RSpec.respond_to?(:configure)
-  RSpec::Matchers.define :match_response_schema do |schema_name, **options|
-    matcher = JSON::Matchers::RSpec.new(schema_name, options)
-
-    match do |response|
-      matcher.matches?(response)
-    end
-
-    if respond_to?(:failure_message)
-      failure_message do |response|
-        matcher.failure_message(response)
-      end
-
-      failure_message_when_negated do |response|
-        matcher.failure_message_when_negated(response)
-      end
-    else
-      failure_message_for_should do |response|
-        matcher.failure_message(response)
-      end
-
-      failure_message_for_should_not do |response|
-        matcher.failure_message_when_negated(response)
-      end
-    end
-  end
-end

data/lib/json/matchers/version.rb

@@ -1,5 +0,0 @@
-module JSON
-  module Matchers
-    VERSION = "0.3.0"
-  end
-end