minitest-match_json 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9eaa93ab6b63e391b400cf735062aee1bf35789
-  data.tar.gz: 5f2e263215501e2156665c01e5fa657acecf5915
+  metadata.gz: 0c4027d485fb16d15e957b930a8da529ab72cbe1
+  data.tar.gz: 23bbd0c28f7c4ca0428f880641b51fb3c34d8abc
 SHA512:
-  metadata.gz: 836047934b955381b27e8459cfdef90c530b5bccceeb878a10f8b2bc32f2007e1fa40a7690aad25f7b34bef43ed82dc968075b3feba520e6a363a58c70718c7d
-  data.tar.gz: add2c480d0331eebf596ee85c933994b1dcec13544b5cd4d7dea62d25a6ca6719e5732ac85b250a6d93f635d7c1aa635bf1201759d9f285e43591f464fc83e3f
+  metadata.gz: b353ade92cb392f4f73611b6220b461c1ead810545a55ca44eef92b532d5fbd56f13709b41f0f7fb8c7ef694f30ce05226447d184b028b81727f84f7406a237b
+  data.tar.gz: 129aa8951a8953e668ef81c2d9943aa7fc9043d46bebd4ed8f1cb25c7c04dd676be336c2a02a49b2becd9e8b6806f564035ee7114cd9ecea01c1761c76da0cf4

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2

data/README.md

@@ -1,6 +1,6 @@
 # Minitest::MatchJson
 
-TODO: Write a gem description
+Compare two JSON objects. If a String is passed in, it is expected to be valid JSON, any other type will be converted to json if possible.
 
 ## Installation
 
@@ -20,11 +20,32 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+require 'minitest-match_json'
+```
+
+[Diffy](https://github.com/samg/diffy) is used to compared the two JSON objects. Options to control the output format and number of context lines to be displayed can be passed through to Diffy.
+
+```ruby
+Minitest::MatchJson.configure do |config|
+  config.format = :color
+  config.context = 1
+end
+```
+
+### Assert style
+```ruby
+assert_match_json expected_json, actual_json
+```
+
+### Spec style
+```ruby
+actual_json.must_match_json expected_json
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/minitest-match_json/fork )
+1. Fork it ( https://github.com/ggordon/minitest-match_json/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-task :default => :test
+task default: :test

data/lib/minitest/match_json/configuration.rb

@@ -0,0 +1,14 @@
+module Minitest
+  module MatchJson
+    # Configuration options passed to diffy
+    class Configuration
+      attr_accessor :format
+      attr_accessor :context
+
+      def initialize
+        @format = :text
+        @context = nil
+      end
+    end
+  end
+end

data/lib/minitest/match_json/version.rb

@@ -1,5 +1,6 @@
 module Minitest
+  # JSON matchers
   module MatchJson
-    VERSION = "0.0.1"
+    VERSION = '0.1.0'
   end
 end

data/lib/minitest/match_json.rb

@@ -1,55 +1,78 @@
 # require 'minitest/match_json/version'
+require 'minitest/match_json/configuration'
 require 'minitest/spec'
 require 'json'
 require 'diffy'
-Diffy::Diff.default_format = :color
 
 module Minitest
+  # JSON matchers
+  module MatchJson
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield configuration
+    end
+
+    def self.compare_json(actual_json, expected_json)
+      Diffy::Diff.new(
+        expected_json,
+        actual_json,
+        context: configuration.context
+      ).to_s(configuration.format)
+    end
+
+    def self.pretty_json(param)
+      json = (param.is_a?(String)) ? param : param.to_json
+      JSON.pretty_generate(JSON.parse(json))
+    end
+  end
+
+  # Assert style
   module Assertions
     #
     #  Fails unless +param and +actual have the same items.
     #
     def assert_match_json(expected, actual)
-      compare_json(expected, actual)
+      match_json(expected, actual)
     end
 
     private
 
     # Helper to highlight diffs between two json strings
-    def compare_json(expected, actual)
-      expected_json = _convert_to_json(expected)
-      actual_json = _convert_to_json(actual)
-      actual_pretty = JSON.pretty_generate(JSON.parse(actual_json))
-      expected_pretty = JSON.pretty_generate(JSON.parse(expected_json))
-      diff =  Diffy::Diff.new(expected_pretty, actual_pretty)
-
-      if diff.to_s.strip.empty?
-        pass "JSON matched"
-      else
-        puts "\n#{diff}\n"
-        flunk 'JSON did not match'
-      end
-    end
-
-    def _convert_to_json(param)
-      case param
-      when String
-        param
-      when Hash
-        param.to_json
-      else
-        flunk 'Expected parameter must be a String or a Hash'
-      end
+    def match_json(expected, actual)
+      diff_str = Minitest::MatchJson.compare_json(
+        pretty_json(actual), pretty_json(expected)
+      )
+      diff_str.strip.empty? ? match_json_passes : match_json_fails(diff_str)
     end
-  end
 
+    def match_json_fails(diff_str)
+      puts "\n#{diff_str}\n"
+      flunk 'JSON did not match'
+    end
+
+    def match_json_passes
+      pass 'JSON matched'
+    end
 
+    def pretty_json(param)
+      Minitest::MatchJson.pretty_json(param)
+    rescue StandardError
+      flunk 'Parameter cannot be converted to JSON'
+    end
+  end
+
+  # Spec style
   module Expectations
     #
     #  Fails unless the subject and parameter are equivalent JSON
     #
-    String.infect_an_assertion :assert_match_json, :must_match_json
-    Hash.infect_an_assertion :assert_match_json, :must_match_json
+    infect_an_assertion :assert_match_json, :must_match_json
   end
-
 end

data/minitest-match_json.gemspec

@@ -8,15 +8,16 @@ Gem::Specification.new do |spec|
   spec.version       = Minitest::MatchJson::VERSION
   spec.authors       = ['Gary Gordon']
   spec.email         = ['gfgordon@gmail.com']
-  spec.summary       = %q{Compare two JSON objects}
-  spec.description   = %q{Compare two JSON objects with pretty diffs}
-  spec.homepage      = ''
+  spec.summary       = 'Compare two JSON objects'
+  spec.description   = 'Compare two JSON objects with pretty diffs'
+  spec.homepage      = 'http://ggordon.github.io/minitest-match_json'
   spec.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.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 1.9'
 
   spec.add_dependency 'diffy'
   spec.add_dependency 'json'
@@ -24,4 +25,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'simplecov'
 end

data/test/minitest/match_json_test.rb

@@ -1,11 +1,117 @@
+require 'simplecov'
+SimpleCov.start
+
 gem 'minitest'
 require 'minitest/autorun'
 require 'minitest/match_json'
 
-describe Minitest::Test do
-  it 'compares some json' do
-    json = '{"a": 2, "b": 4}'
-    hash = { a: 2, b: 4 }
-    json.must_match_json hash.to_json
+describe Minitest do
+  describe 'Configuration' do
+    it '#configure will override defaults' do
+      Minitest::MatchJson.configure do |config|
+        config.format = :color
+        config.context = 1
+      end
+      Minitest::MatchJson.configuration.format.must_equal :color
+      Minitest::MatchJson.configuration.context.must_equal 1
+    end
+  end
+
+  describe 'Basic tests' do
+    it 'compares some json' do
+      json = '{"a": 2, "b": 4}'
+      hash = { a: 2, b: 4 }
+      json.must_match_json hash
+    end
+
+    it 'fails trying to compares a non json object' do
+      json = '{"a": 2, "b": 4}'
+      begin
+        json.must_match_json 2
+      rescue MiniTest::Assertion
+        pass
+      end
+    end
+
+    it 'returns a default result when failing' do
+      Minitest::MatchJson.configure do |config|
+        config.format = :text
+      end
+
+      json = '{"b": 5}'
+      hash = { b: 4 }
+
+      out, _ = capture_io do
+        begin
+          json.must_match_json hash.to_json
+        rescue MiniTest::Assertion
+          pass
+        end
+      end
+      out.must_equal(<<STR
+
+ {
+-  \"b\": 4
++  \"b\": 5
+ }
+\
+
+STR
+      )
+    end
+
+    it 'returns a default result with reduced context when failing' do
+      Minitest::MatchJson.configure do |config|
+        config.format = :text
+        config.context = 1
+      end
+
+      json = '{"a": 3, "b": 5, "c": 5}'
+      hash = { a: 3, b: 4, c: 5 }
+
+      out, _ = capture_io do
+        begin
+          json.must_match_json hash.to_json
+        rescue MiniTest::Assertion
+          pass
+        end
+      end
+      out.must_equal(<<STR
+
+   \"a\": 3,
+-  \"b\": 4,
++  \"b\": 5,
+   \"c\": 5
+
+STR
+      )
+    end
+
+    it 'returns a colorized result when failing' do
+      Minitest::MatchJson.configure do |config|
+        config.format = :color
+      end
+
+      json = '{"b": 5}'
+      hash = { b: 4 }
+
+      out, _ = capture_io do
+        begin
+          json.must_match_json hash.to_json
+        rescue MiniTest::Assertion
+          pass
+        end
+      end
+      out.must_equal(<<STR
+
+ {
+\e[31m-  \"b\": 4\e[0m
+\e[32m+  \"b\": 5\e[0m
+ }
+\
+
+STR
+      )
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-match_json
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gary Gordon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2015-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Compare two JSON objects with pretty diffs
 email:
 - gfgordon@gmail.com
@@ -88,16 +102,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/minitest-match_json.rb
 - lib/minitest/match_json.rb
+- lib/minitest/match_json/configuration.rb
 - lib/minitest/match_json/version.rb
 - minitest-match_json.gemspec
 - test/minitest/match_json_test.rb
-homepage: ''
+homepage: http://ggordon.github.io/minitest-match_json
 licenses:
 - MIT
 metadata: {}
@@ -109,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="