rspec_structure_matcher 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 193cd69f56ffdd252aaf2737ff554fed0b3ae767
-  data.tar.gz: e103d7eee610617d6b33bbeac712f1ff8ce2f678
+  metadata.gz: b806804c4a8f7c07e794d2d08d314fed04b2a7c3
+  data.tar.gz: c7add716e2fb93116eca59247d69ab20c4e94d56
 SHA512:
-  metadata.gz: 99823fa6ba3e1b747e2487af5ccb9858df3dbb0985a33a056d045be6fc44d4d911742a789cc91b51ab4106758e7e9f87c0267c3b2ce1a4bbecbeb4b1bd5e798c
-  data.tar.gz: 3c48db7cb3414c6f6a824ee45409250e51c090b50eedef1a7d94c264f96d790564932edef9004e95656537e33407e079f7395b2f2ddfb29f96867087e64895c7
+  metadata.gz: 89dc486be69a92be0e6084c803fbc3f3187edc62c44ddb80785c831eec1440efb31168ebd71f8b91347516ddceebee176453a4b5ee1e3f506becdffa66b7ee0d
+  data.tar.gz: 78157d392b7b7d48bbe1374b1518fe1c0a01c093fcf73a53e7dfa99b223278f2cdaaa1960e24ebf0e00a551fcc4fb015b9d9b4f7fff0a2f8c00d165113751454

data/README.md

@@ -57,6 +57,27 @@ Callable proc/lambda
 Exact match
 : Other values will be compared directly with `==`.
 
+### Testing arrays
+
+You often want to match each item in an array of objects against the same structure. To do so, simply define your structure with a single item in the array. This item will be matched against all items in the array you are testing.
+
+    expected_structure = {
+      items: [
+        {
+          name: String
+        }
+      ]
+    }
+
+    actual_object = {
+      items: [
+        { name: 'Bob' },
+        { name: 'Jane' }
+      ]
+    }
+
+    expect(actual_object).to have_structure(expected_structure) # true
+
 ### Testing Optional Values
 
 As mentioned above, you can use `optionally` to test optional values, so that the test will pass even if the response contains a `null`. `optionally` is nothing more than a helpful lambda generation method, much like the proc/lambda that you can write yourself.

data/lib/have_structure_matcher.rb

@@ -1,6 +1,6 @@
 require 'pp'
 
-RSpec::Matchers.define :have_structure do |expected, opts|
+RSpec::Matchers.define :have_structure do |expected|
   match do |actual|
     HaveStructureMatcher.match?(actual, expected)
   end

data/lib/support_methods.rb

@@ -10,8 +10,20 @@ module HaveStructureMatcher
   end
 
   def self.build_diff(actual, expected)
-    return expected unless actual.is_a?(Hash)
+    if actual.is_a?(Array) && expected.is_a?(Array)
+      build_array_diff(actual, expected)
+    elsif actual.is_a?(Hash) && expected.is_a?(Hash)
+      build_hash_diff(actual, expected)
+    elsif actual.is_a?(Hash)
+      expected
+    elsif value_match?(actual, expected)
+      actual
+    else
+      expected
+    end
+  end
 
+  def self.build_hash_diff(actual, expected)
     keys = actual.keys | expected.keys
 
     keys.each_with_object({}) do |key, memo|
@@ -22,7 +34,7 @@ module HaveStructureMatcher
         if expected_value.is_a?(Hash)
           memo[key] = build_diff(actual_value, expected_value)
         elsif expected_value.is_a?(Array)
-          memo[key] = expected_value.zip(actual_value).map { |(e,a)| build_diff(a, e) }
+          memo[key] = build_array_diff(actual_value, expected_value)
         elsif value_match?(actual_value, expected_value)
           memo[key] = actual_value
         else
@@ -35,6 +47,14 @@ module HaveStructureMatcher
     end
   end
 
+  def self.build_array_diff(actual_value, expected_value)
+    if expected_value.length == 1 && actual_value.is_a?(Array)
+      actual_value.map { |a| build_diff(a, expected_value[0]) }
+    else
+      expected_value.zip(actual_value).map { |(e,a)| build_diff(a, e) }
+    end
+  end
+
   def self.print_expected_value(expected_value)
     if expected_value.respond_to?(:call)
       "Proc [#{expected_value.source_location.join(':')}]"

data/lib/version.rb

@@ -1,3 +1,3 @@
 module RspecStructureMatcher
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/lib/have_structure_matcher_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'rspec_structure_matcher'
 
 describe 'have_structure' do
   let(:expected_structure) {
@@ -19,7 +18,7 @@ describe 'have_structure' do
     it 'raises the correct error' do
       expect {
         expect(structure).to have_structure(expected_structure)
-      }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /-"bar" => String/)
+      }.to raise_error(RSpec::Expectations::ExpectationNotMetError, Regexp.new('-{"foo"=>"baz", "bar"=>String}'))
     end
   end
 
@@ -35,7 +34,10 @@ describe 'have_structure' do
     it 'raises the correct error' do
       expect {
         expect(structure).to have_structure(expected_structure)
-      }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /\+"bam" => "baz"/)
+      }.to raise_error(
+        RSpec::Expectations::ExpectationNotMetError,
+        Regexp.new(Regexp.escape('+{"foo"=>"baz", "bar"=>"baz", "bam"=>"baz"}'))
+      )
     end
   end
 
@@ -50,7 +52,10 @@ describe 'have_structure' do
     it 'raises the correct error' do
       expect {
         expect(structure).to have_structure(expected_structure)
-      }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /-"foo" => String/)
+      }.to raise_error(
+        RSpec::Expectations::ExpectationNotMetError,
+        Regexp.new(Regexp.escape('+{"foo"=>1, "bar"=>"baz"}'))
+      )
     end
   end
 
@@ -80,7 +85,10 @@ describe 'have_structure' do
     it 'fails validation' do
       expect {
         expect(structure).to have_structure(expected_structure)
-      }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /-"foo" => String/)
+      }.to raise_error(
+        RSpec::Expectations::ExpectationNotMetError,
+        Regexp.new(Regexp.escape('+{:foo=>"baz", "bar"=>"baz"}'))
+      )
     end
   end
 
@@ -118,7 +126,10 @@ describe 'have_structure' do
       it 'fails validation' do
         expect {
           expect(structure).to have_structure(expected_structure)
-        }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /-"foo" => 2/)
+        }.to raise_error(
+          RSpec::Expectations::ExpectationNotMetError,
+          Regexp.new(Regexp.escape('+{"foo"=>1, "bar"=>"baz"}'))
+        )
       end
     end
   end
@@ -148,7 +159,10 @@ describe 'have_structure' do
       it 'fails validation' do
         expect {
           expect(structure).to have_structure(expected_structure)
-        }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /\+"foo" => 100/)
+        }.to raise_error(
+          RSpec::Expectations::ExpectationNotMetError,
+          Regexp.new(Regexp.quote('+{"foo"=>100}'))
+        )
       end
     end
   end
@@ -179,6 +193,17 @@ describe 'have_structure' do
         }.not_to raise_error
       end
     end
+
+    context 'regular expression' do
+      let(:expected_structure) { {'foo' => optionally(/\w+/)} }
+      let(:structure) { {'foo' => 'hello'} }
+
+      it 'raises no error' do
+        expect {
+          expect(structure).to have_structure(expected_structure)
+        }.not_to raise_error
+      end
+    end
   end
 
   context "with nested structure" do
@@ -219,9 +244,49 @@ describe 'have_structure' do
       it 'fails validation' do
         expect {
           expect(structure).to have_structure(expected_structure)
-        }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /\+"bar" => "a"/)
+        }.to raise_error(
+          RSpec::Expectations::ExpectationNotMetError,
+          Regexp.new(Regexp.quote('+{"foo"=>1, "bar"=>"a"}'))
+        )
       end
     end
+  end
+
+  context "matching against an array of objects" do
+    let(:expected_structure) do
+      {
+        'items' => [
+          {
+            'name' => String
+          }
+        ]
+      }
+    end
+
+    let(:structure) do
+      {
+        'items' => [
+          { 'name' => 'Bob' },
+          { 'name' => 'Jane' }
+        ]
+      }
+    end
 
+    it 'passes validation' do
+      expect {
+        expect(structure).to have_structure(expected_structure)
+      }.not_to raise_error
+    end
+  end
+
+  context "matching two arrays" do
+    let(:expected_structure) { [Integer] }
+    let(:structure) { [10, 20, 30] }
+
+    it 'passes validation' do
+      expect {
+        expect(structure).to have_structure(expected_structure)
+      }.not_to raise_error
+    end
   end
 end

data/spec/spec_helper.rb

@@ -2,3 +2,8 @@ require "bundler/setup"
 Bundler.setup
 
 require "pry-byebug"
+require "rspec_structure_matcher"
+
+RSpec.configure do |config|
+  config.include HaveStructureMatcher::Methods
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_structure_matcher
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Tony Marklove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec