test_assistant 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48905c8c6be7fc91de87ac31c24b5314338b0bf9
-  data.tar.gz: c39d609ffb786a18edb427ca959ac0e0ae47bb2c
+  metadata.gz: 49e305f2819ade85d5d24f684b4793021fc5b9a4
+  data.tar.gz: d665d5ac5bb5ac475e76c897fbb755cef7bb2a3d
 SHA512:
-  metadata.gz: 3e6c40ca210cb0a3d2ad25394cecbb2c564bedf9e0f8313b9581103ea71e73088fb492ff7f6579c6bb419e2ade754c87083dad260396074145a9bf3fb0b6b350
-  data.tar.gz: 8ad25ab4b5b18080abb83f1d42a489ba93db0ea23cae04c439429adce73c8d1873dd2e5b4722b45d47121bc9831a87dfcc90ce3d3eeae67c2dea5570eab2240e
+  metadata.gz: 398f6cfb2cde42b5d13b1f1daf392986400258bfa1e64e7e3c73b0215078fd9adfe458c3085d2e345d796ef15e3aa798e2162dd6ed082b2261ae148b3f7cc1f1
+  data.tar.gz: b571f52714417646144182f5051a88346d8b46b52538f68ecd478cc850e4494dc4453b5c7d4b6c5b4e50c4d499f20a627e7e608d8a128aed3e570a836b527d56

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Guardfile

@@ -0,0 +1,29 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  last_run_spec = nil
+
+  watch(%r{^lib/(.+)\.rb$}) do |match|
+    file_path =
+        if match[1] === 'lib'
+          "spec/lib/#{match[2]}_spec.rb"
+        else
+          "spec/#{match[2]}_spec.rb"
+        end
+
+    if File.exists?(file_path)
+      file_path
+    else
+      last_run_spec
+    end
+  end
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files) do |spec|
+    last_run_spec = spec[0]
+  end
+end

data/README.md

@@ -1,6 +1,6 @@
 # TestAssistant
 
-A collection of testing tools, hacks, and utilities for writing and fixing tests faster
+A collection of testing tools and utilities for writing and fixing tests faster
 
 ## Stability
 
@@ -84,6 +84,45 @@ RSpec.describe 'making some valid request', type: :request do
 end
 ```
 
+## JSON expectations
+
+RSpec's failed equality reports are often extremely difficult to interpret when dealing with complicated JSON objects. A minor difference, deeply nested in arrays and objects can take a long time to locate because RSpec dumps the entire object in the failure message.
+ 
+
+When enabled, Test Assistant provides a method `json_response` that automatically parses the last response object as json and a custom assertion `eql_json` that reports failed equality of complicated json objects in a format that is much clearer. The full `expected` and `actual` values are still reported, but below them Test Assistant prints only the paths to the failed nested values and their differences, removing the need to manually compare the two complete objects to find what is different. 
+
+```ruby
+TestAssistant.configure(config) do |ta_config|
+  ta_config.include_json_helpers type: :request
+end
+```
+
+```ruby
+RSpec.describe 'making some valid request', type: :request do
+  context 'some important context' do
+    it 'should return some complicated JSON' do
+      
+      perform_request
+      
+      expect(json_response).to eql_json([
+        {
+            "a" => [
+                1, 2, 3
+           ],
+           "c" => { "d" => "d'"}
+        }, 
+        {
+            "b" => [
+                1, 2, 3
+           ],
+           "c" => { "d" => "d'"}
+        } 
+      ])
+    end
+  end
+end
+```
+
 ## Email expectations
 
 

data/lib/test_assistant/json/expectation.rb

@@ -12,15 +12,17 @@ module TestAssistant::Json
     end
 
     def matches?(actual)
+      @message = ''
+      @reported_differences = {}
+
       @actual = actual
       @expected.eql?(@actual)
     end
 
     def failure_message
-      message = ''
-      message += "Expected: #{@expected}\n\n"
-      message += "Actual: #{@actual}\n\n"
-      message += "Differences\n\n"
+      @message += "Expected: #{@expected}\n\n"
+      @message += "Actual: #{@actual}\n\n"
+      @message += "Differences\n\n"
 
       differences = HashDiff.diff(@actual, @expected)
 
@@ -31,29 +33,66 @@ module TestAssistant::Json
           when '-'
             attribute, value = operands
 
-            message += format_diff(attribute, nil, value)
+            expected_value = attribute_value(@expected, attribute)
+            add_diff_description(attribute, format_diff(attribute, expected_value, value))
+
           when '+'
             attribute, value = operands
 
-            message += format_diff(attribute, value, nil)
+            actual_value = attribute_value(@actual, attribute)
+
+            add_diff_description(attribute, format_diff(attribute, value, actual_value))
+
           else
             attribute, actual_value, expected_value = operands
 
-            message += format_diff(attribute, expected_value, actual_value)
+            add_diff_description(attribute, format_diff(attribute, expected_value, actual_value))
         end
       end
 
-      message
+      @message
     end
 
     private
 
+    def add_diff_description(attribute, difference_description)
+      unless already_reported_difference?(attribute)
+        @message += difference_description
+        @reported_differences[attribute] = true
+      end
+    end
+
+    def already_reported_difference?(attribute)
+      !!@reported_differences[attribute]
+    end
+
+    def attribute_value(target, attribute_path)
+      keys = attribute_path.split(/\[|\]|\./)
+
+      keys = keys.map do |key|
+        if key.to_i == 0 && key != '0'
+          key
+        else
+          key.to_i
+        end
+      end
+
+      result = target
+
+      keys.each do |key|
+        unless key == ''
+          result = result[key]
+        end
+      end
+
+      result
+    end
+
     def format_diff(attribute, expected, actual)
       diff_description = ''
       diff_description += "#{attribute}\n"
       diff_description += "Expected: #{format_value(expected)}\n"
       diff_description += "Actual: #{format_value(actual)}\n\n"
-      diff_description
     end
 
     def format_value(value)

data/lib/test_assistant/version.rb

@@ -1,3 +1,3 @@
 module TestAssistant
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/eql_json_spec.rb

@@ -0,0 +1,256 @@
+require './lib/test_assistant/json/helpers'
+
+RSpec.describe "eql_json" do
+  include TestAssistant::Json::Helpers
+
+  context "when comparing strings" do
+    let(:expected) { 'a' }
+    let(:actual) { 'b' }
+
+    it "then correctly reports any differences" do
+
+      expect(actual).to eql_json(actual)
+
+      expect(actual).to_not eql(expected)
+
+      expect {
+        expect(actual).to eql_json(expected)
+      }.to raise_error.with_message(error_message(expected, actual, {
+          '' => {
+              expected: "'#{expected}'",
+              actual: "'#{actual}'"
+          }
+      }))
+    end
+  end
+
+  context "when comparing integers" do
+    let(:expected) { 2 }
+    let(:actual) { 1 }
+
+    it "then correctly reports any differences" do
+
+      expect(actual).to eql_json(actual)
+
+      expect(actual).to_not eql(expected)
+
+      expect {
+        expect(actual).to eql_json(expected)
+      }.to raise_error.with_message(error_message(expected, actual, {
+          '' => {
+              expected: expected,
+              actual: actual
+          }
+      }))
+    end
+  end
+
+  context "when comparing nil" do
+    let(:expected) { 2 }
+    let(:actual) { nil }
+
+    it "then correctly reports any differences" do
+      expect(actual).to eql_json(actual)
+
+      expect(actual).to_not eql(expected)
+
+      expect {
+        expect(actual).to eql_json(expected)
+      }.to raise_error.with_message(error_message(expected, actual, {
+          '' => {
+              expected: expected,
+              actual: actual
+          }
+      }))
+
+    end
+
+  end
+
+  context "when comparing arrays" do
+    let(:expected) { [ 1, 3, 4, 5 ] }
+    let(:actual) { [ 1, 2, 3 ] }
+
+    it "then correctly reports the elements that have changed" do
+
+      expect(actual).to eql(actual)
+
+      expect(actual).to_not eql(expected)
+
+      begin
+        expect(actual).to eql_json(expected)
+      rescue RSpec::Expectations::ExpectationNotMetError => e
+
+        expect(e.message).to eql(error_message(expected, actual, {
+
+          '[1]' => {
+              expected: 3,
+              actual: 2
+          },
+          '[2]' => {
+              expected: 4,
+              actual: 3
+          },
+          '[3]' => {
+              expected: 5,
+              actual: ''
+          }
+
+        }))
+
+      end
+
+    end
+
+  end
+
+  context "when comparing objects" do
+    let(:expected) { {
+        'a' => 'a',
+        'c' => 'd',
+        'e' => 'e'
+    } }
+
+    let(:actual) { {
+        'a' => 'a',
+        'b' => 'b',
+        'c' => 'c'
+    } }
+
+    it "then correctly reports the elements that have changed" do
+
+      expect(actual).to eql(actual)
+
+      expect(actual).to_not eql(expected)
+
+      begin
+        expect(actual).to eql_json(expected)
+      rescue RSpec::Expectations::ExpectationNotMetError => e
+
+        expect(e.message).to eql(error_message(expected, actual, {
+
+          'b' => {
+              expected: '',
+              actual: "'b'"
+          },
+          'c' => {
+              expected: "'d'",
+              actual: "'c'"
+          },
+          'e' => {
+              expected: "'e'",
+              actual: ''
+          }
+
+        }))
+
+      end
+
+    end
+
+  end
+
+  context "when comparing nested objects" do
+    let(:actual) { {
+        'a' => 'a',
+        'b' => {
+            'b' => 'b'
+        },
+        'c' => {
+            'd' => 'd',
+            'e' => 'e',
+            'f' => {
+                'g' => 'g'
+            },
+            'h' => [1,2,3]
+        },
+        'i' => {
+            'j' => 'j',
+            'k' => 'k'
+        }
+    } }
+
+    let(:expected ) { {
+        'a' => 'a',
+        'c' => {
+            'e' => 'e2',
+            'f' => {
+                'g2' => 'g2'
+            },
+            'h' => [1,2,4]
+        },
+        'i' => {
+            'j' => 'j',
+        }
+    } }
+
+    it "then correctly reports the elements that have changed" do
+
+      expect(actual).to eql(actual)
+
+      expect(actual).to_not eql(expected)
+
+      begin
+        expect(actual).to eql_json(expected)
+      rescue RSpec::Expectations::ExpectationNotMetError => e
+
+        expect(e.message).to eql(error_message(expected, actual, {
+
+          'b' => {
+              expected: '',
+              actual: '{"b"=>"b"}'
+          },
+          'c.d' => {
+              expected: '',
+              actual: "'d'"
+          },
+          'c.e' => {
+              expected: "'e2'",
+              actual: "'e'"
+          },
+          'c.f.g' => {
+              expected: '',
+              actual: "'g'"
+          },
+          'c.f.g2' => {
+              expected: "'g2'",
+              actual: ''
+          },
+          'c.h[2]' => {
+              expected: '4',
+              actual: '3'
+          },
+          'i.k' => {
+              expected: '',
+              actual: "'k'"
+          },
+
+
+        }))
+
+      end
+
+    end
+
+  end
+
+
+  private
+
+  def error_message(expected, actual, differences)
+    message_lines = [
+        "Expected: #{expected}\n\n",
+        "Actual: #{actual}\n\n",
+        "Differences\n\n"
+    ]
+
+    differences.each do |attribute_name, difference|
+      message_lines.push("#{attribute_name}\n")
+      message_lines.push("Expected: #{difference[:expected]}\n")
+      message_lines.push("Actual: #{difference[:actual]}\n\n")
+    end
+
+
+    message_lines.join
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+RSpec.configure do |config|
+  config.filter_run_including focus: true
+  config.run_all_when_everything_filtered = true
+end

data/test_assistant.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Aleck Greenham"]
   spec.email         = ["greenhama13@gmail.com"]
   spec.summary       = "A toolbox for increased testing efficiency with RSpec"
-  spec.description   = "A collection of testing tools, hacks, and utilities for writing and fixing tests faster"
+  spec.description   = "A collection of testing tools and utilities for writing and fixing tests faster"
   spec.homepage      = "https://github.com/greena13/test_assistant"
   spec.license       = "MIT"
 
@@ -18,9 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rspec-rails", "~> 3.0"
   spec.add_dependency 'capybara', '~> 2.5', '>= 2.5.0'
   spec.add_dependency 'hashdiff', '~> 0'
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "guard", "~> 2.1"
+  spec.add_development_dependency "rspec", ">= 3.5.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: test_assistant
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Aleck Greenham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-14 00:00:00.000000000 Z
+date: 2017-02-27 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -86,8 +72,50 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: A collection of testing tools, hacks, and utilities for writing and fixing
-  tests faster
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+description: A collection of testing tools and utilities for writing and fixing tests
+  faster
 email:
 - greenhama13@gmail.com
 executables: []
@@ -95,7 +123,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -107,6 +137,8 @@ files:
 - lib/test_assistant/json/expectation.rb
 - lib/test_assistant/json/helpers.rb
 - lib/test_assistant/version.rb
+- spec/eql_json_spec.rb
+- spec/spec_helper.rb
 - test_assistant.gemspec
 homepage: https://github.com/greena13/test_assistant
 licenses:
@@ -132,4 +164,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A toolbox for increased testing efficiency with RSpec
-test_files: []
+test_files:
+- spec/eql_json_spec.rb
+- spec/spec_helper.rb