rspec-json_api 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f40d1a16f0eff4c046c4598ace80041df867575e52065a1b1dd298ec9cf98d6
-  data.tar.gz: 8aae365879c35374679dac663a490bdb5018a3646f8b30e64836700220aed5fb
+  metadata.gz: 2b58959b3880f31b8098ee0183aee6e254043f7566db77bd242c590ee2f21d72
+  data.tar.gz: 33a0cd48bf51713452ed3bbad1c1b576c3c8d1fa3e90a9696ffa8085e6aa7173
 SHA512:
-  metadata.gz: 8a5b5fe0e572b4e1424ebd7e32d1d0178046ee111e1c9e69f09fbae69eda8c273fd98498570c6ab7a4b58c12b214d11bfd8eec701e1b4502770826cd2c1cf724
-  data.tar.gz: 82afdf75029cd84a8ae8bd84335a4ef48e5dab5db0682018a79a2f799991fcc1af8c069fd01abd3905fe4ee468e46d28cbc615e0cf4d5c8e80133e10abd309d7
+  metadata.gz: c9931ef0406562f563346e91f413c7ec65872c6397b97a2c4b61e80816cf7c52ca48a1b55dfce43524e65750ae971d9c61a2e70e2e2b82747eb3b570c8bb2425
+  data.tar.gz: 822fc1a4ab0431a4f1f75ba4c4f2d3a73378fc4971e4380b13557f0679a757f679ea8167696a1cdaa2a4b0c37ed5f6953d6029fd7186634d8232951ac3b19fc2

data/Gemfile

@@ -9,3 +9,4 @@ gemspec
 gem "activesupport", "~> 6.1", ">= 6.1.4.1"
 gem "rake", "~> 13.0", ">= 13.0.6"
 gem "rspec-rails", "~> 5.0", ">= 5.0.2"
+gem "rubocop"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-json_api (1.1.0)
+    rspec-json_api (1.2.1)
       activesupport (>= 6.1.4.1)
       rails (>= 6.1.4.1)
       rspec-rails (>= 5.0.2)
@@ -68,6 +68,8 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
+    ast (2.4.2)
+    base64 (0.1.1)
     builder (3.2.4)
     concurrent-ruby (1.1.9)
     crass (1.0.6)
@@ -78,6 +80,8 @@ GEM
       activesupport (>= 6.1)
     i18n (1.9.1)
       concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
     loofah (2.13.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -91,19 +95,23 @@ GEM
     mini_mime (1.1.5)
     mini_portile2 (2.7.1)
     minitest (5.15.0)
-    net-imap (0.4.4)
+    net-imap (0.4.9.1)
       date
       net-protocol
     net-pop (0.1.2)
       net-protocol
     net-protocol (0.2.2)
       timeout
-    net-smtp (0.4.0)
+    net-smtp (0.4.0.1)
       net-protocol
-    nio4r (2.5.9)
+    nio4r (2.7.0)
     nokogiri (1.13.1)
       mini_portile2 (~> 2.7.0)
       racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
     racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
@@ -134,7 +142,10 @@ GEM
       method_source
       rake (>= 0.13)
       thor (~> 1.0)
+    rainbow (3.1.1)
     rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
     rspec-core (3.10.2)
       rspec-support (~> 3.10.0)
     rspec-expectations (3.10.2)
@@ -152,6 +163,21 @@ GEM
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
     rspec-support (3.10.3)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
     sprockets (4.1.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -163,6 +189,7 @@ GEM
     timeout (0.4.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
     websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
@@ -177,6 +204,7 @@ DEPENDENCIES
   rake (~> 13.0, >= 13.0.6)
   rspec-json_api!
   rspec-rails (~> 5.0, >= 5.0.2)
+  rubocop
 
 BUNDLED WITH
    2.2.19

data/README.md

@@ -66,6 +66,14 @@ RSpec.describe UsersController, type: :controller do
       expect(response.body).to match_json_schema(expected_schema)
     end
   end
+  
+  describe '#update' do
+    it 'matches API response' do
+      put :update, params: { name: 'John', age: 35 }
+      
+      expect(response.body).to have_no_content
+    end
+  end
 end
 ```
 
@@ -75,6 +83,11 @@ end
   expect(response.body).to match_json_schema(expected_schema)
 ```
 
+- ### have_no_content
+```
+  expect(response.body).to have_no_content
+```
+
 ## Interfaces
 The gem introduces interfaces to reuse them during test matches.
 

data/lib/rspec/json_api/compare_array.rb

@@ -8,17 +8,13 @@ module RSpec
       def compare(actual, expected)
         if interface?(expected)
           actual.all? do |actual_elem|
-            # Compare actual and expected schema
             return false unless actual_elem.deep_keys == expected[0].deep_keys
 
             CompareHash.compare(actual_elem, expected[0])
           end
         else
           actual.each_with_index.all? do |actual_elem, index|
-            # Compare actual and expected schema
-            return false unless actual[index].deep_keys == expected[index].deep_keys
-
-            CompareHash.compare(actual_elem, expected[index])
+            compare_primitive_type_element(actual, expected, actual_elem, index)
           end
         end
       end
@@ -28,6 +24,16 @@ module RSpec
       def interface?(expected_value)
         expected_value.size == 1 && expected_value[0].is_a?(Hash)
       end
+
+      def compare_primitive_type_element(actual, expected, actual_elem, index)
+        if actual[index].respond_to?(:deep_keys) && expected[index].respond_to?(:deep_keys)
+          return false unless actual[index].deep_keys == expected[index].deep_keys
+
+          CompareHash.compare(actual_elem, expected[index])
+        else
+          CompareHash.compare_values(actual[index], expected[index])
+        end
+      end
     end
   end
 end

data/lib/rspec/json_api/compare_hash.rb

@@ -15,18 +15,16 @@ module RSpec
         compare_key_paths_and_values(keys, actual, expected)
       end
 
-      private
-
       def compare_key_paths_and_values(keys, actual, expected)
         keys.all? do |key_path|
           actual_value = actual.dig(*key_path)
           expected_value = expected.dig(*key_path)
 
-          compare_hash_values(actual_value, expected_value)
+          compare_values(actual_value, expected_value)
         end
       end
 
-      def compare_hash_values(actual_value, expected_value)
+      def compare_values(actual_value, expected_value)
         case expected_value
         when Class
           compare_class(actual_value, expected_value)
@@ -37,7 +35,7 @@ module RSpec
         when Array
           compare_array(actual_value, expected_value)
         else
-          compare_value(actual_value, expected_value)
+          compare_simple_value(actual_value, expected_value)
         end
       end
 
@@ -63,7 +61,7 @@ module RSpec
           when :type
             compare_class(actual_value, condition_value)
           when :value
-            compare_value(actual_value, condition_value)
+            compare_simple_value(actual_value, condition_value)
           when :inclusion
             condition_value.include?(actual_value)
           when :min
@@ -95,12 +93,12 @@ module RSpec
           return false if actual_value&.size != expected_value&.size
 
           expected_value.each_with_index.all? do |elem, index|
-            elem.is_a?(Hash) ? compare(actual_value[index], elem) : compare_value(actual_value[index], elem)
+            elem.is_a?(Hash) ? compare(actual_value[index], elem) : compare_simple_value(actual_value[index], elem)
           end
         end
       end
 
-      def compare_value(actual_value, expected_value)
+      def compare_simple_value(actual_value, expected_value)
         actual_value == expected_value
       end
 

data/lib/rspec/json_api/matchers/have_no_content.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RSpec
+  module JsonApi
+    module Matchers
+      class HaveNoContent
+        def matches?(actual)
+          actual == ""
+        end
+
+        def failure_message
+          self
+        end
+
+        def failure_message_when_negated
+          self
+        end
+      end
+    end
+  end
+end

data/lib/rspec/json_api/matchers/match_json_schema.rb

@@ -11,6 +11,7 @@ module RSpec
         end
 
         def matches?(actual)
+          # Parse JSON to ruby object
           actual = JSON.parse(actual, symbolize_names: true)
 
           # Compare types

data/lib/rspec/json_api/matchers.rb

@@ -5,5 +5,9 @@ module RSpec
     def match_json_schema(expected)
       RSpec::JsonApi::Matchers::MatchJsonSchema.new(expected)
     end
+
+    def have_no_content
+      RSpec::JsonApi::Matchers::HaveNoContent.new
+    end
   end
 end

data/lib/rspec/json_api/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module JsonApi
-    VERSION = "1.1.1"
+    VERSION = "1.2.1"
   end
 end

data/lib/rspec/json_api.rb

@@ -15,6 +15,7 @@ require "extentions/hash"
 # Load matchers
 require "rspec/json_api/matchers"
 require "rspec/json_api/matchers/match_json_schema"
+require "rspec/json_api/matchers/have_no_content"
 
 # Load defined types
 require "rspec/json_api/types/email"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-json_api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Michal Gajowiak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-07 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -85,6 +85,7 @@ files:
 - lib/rspec/json_api/compare_hash.rb
 - lib/rspec/json_api/interfaces/example_interface.rb
 - lib/rspec/json_api/matchers.rb
+- lib/rspec/json_api/matchers/have_no_content.rb
 - lib/rspec/json_api/matchers/match_json_schema.rb
 - lib/rspec/json_api/types/email.rb
 - lib/rspec/json_api/types/uri.rb