rspec_jsonapi_serializer 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c575d046628ade51e83238d8bc7179eea00ee9bc1cedde252fda0c8b98fa2269
-  data.tar.gz: 30d857690790f7cc807ac6e432e1103ef646e140f085a7c5c09c8b6d3b75b1c6
+  metadata.gz: e24d0b3794bdc77750c98e578543eb472a655f79ea61190682623b2ce7f8e89f
+  data.tar.gz: 89cfb3714d48e15345fbad93540bdf58b02153f4001e88defc66fbc63758d672
 SHA512:
-  metadata.gz: f1303aa1426102b7f26ebc5d4abc0fbfb0a9f712e9b231e05e5a43e6e70900d3f8a1e22731db6d00f701bcbf7c024117a7c2f22fed4530403e069682f2826556
-  data.tar.gz: 52b6d4c3dd1e2214e4275105195c028b35dfbb4b599754c23b6d65fe9c6b6cfb86e6ecc2a2bca35b5319d4b507b1c909171513dd0e5c427ea100cfb27429d261
+  metadata.gz: 2693f3a69e99f02b54d6a283b377bc41f02ef74f82455d78d7c4b98965645f972939e2df2aeaea107f2546f9e0a69f2cc51e803cdaf3e6090f8b09491929ce09
+  data.tar.gz: 2f5f2c1c81eb3a56e974d807c6136f2908540bb4afc07e25a179c03af36e5b0b9f0e583b8a707804b7e1d1cf032b84161ff8ea6221c21bf989e1c088c8675797

data/lib/rspec_jsonapi_serializer/matchers/association_matcher.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "rspec_jsonapi_serializer/matchers/base"
+require "rspec_jsonapi_serializer/matchers/association_matchers/serializer_matcher"
+require "rspec_jsonapi_serializer/metadata/relationships"
 
 module RSpecJSONAPISerializer
   module Matchers
@@ -15,17 +17,16 @@ module RSpecJSONAPISerializer
       def matches?(serializer_instance)
         @serializer_instance = serializer_instance
 
-        relationships.select { |_, r| r.relationship_type == relationship_type }
-                     .has_key?(expected)
+        relationship_matches? && submatchers_match?
       end
 
-      def description
-        description = "#{association_message} #{expected}"
+      def serializer(value)
+        add_submatcher AssociationMatchers::SerializerMatcher.new(value, expected)
 
-        [description, submatchers.map(&:description)].flatten.join(' ')
+        self
       end
 
-      def failure_message
+      def main_failure_message
         [expected_message, actual_message].compact.join(", ")
       end
 
@@ -37,20 +38,28 @@ module RSpecJSONAPISerializer
         "expected #{serializer_name} to #{association_message} #{expected}"
       end
 
+      def relationship_matches?
+        actual.present? && actual.relationship_type == relationship_type
+      end
+
       def actual_message
-        actual ? "got :#{actual} instead" : nil
+        actual ? "got :#{actual.relationship_type} instead" : nil
       end
 
       def association_message
-        relationship_matcher.to_s.split("_").join(" ")
+        relationship_matcher.to_s.split('_')
       end
 
       def actual
-        relationships.key(expected) || relationship.key(expected.to_s)
+        metadata.relationship(expected)
       end
 
       def relationships
-        @relationships ||= serializer_instance.class&.relationships_to_serialize || {}
+        metadata.relationships
+      end
+
+      def metadata
+        Metadata::Relationships.new(serializer_instance)
       end
     end
   end

data/lib/rspec_jsonapi_serializer/matchers/association_matchers/serializer_matcher.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/metadata/relationships"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    module AssociationMatchers
+      class SerializerMatcher < Base
+        def initialize(value, relationship_target)
+          super(value)
+
+          @relationship_target  = relationship_target
+        end
+
+        def matches?(serializer_instance)
+          @serializer_instance = serializer_instance
+
+          actual == expected
+        end
+
+        def main_failure_message
+          [expected_message, actual_message].compact.join(", ")
+        end
+
+        private
+
+        attr_reader :relationship_target
+
+        def expected_message
+          "expected #{serializer_name} to use #{expected} as serializer for #{relationship_target}"
+        end
+
+        def actual_message
+          actual ? "got #{actual} instead" : nil
+        end
+
+        def actual
+          metadata.relationship(relationship_target).serializer
+        end
+
+        def metadata
+          Metadata::Relationships.new(serializer_instance)
+        end
+      end
+    end
+  end
+end

data/lib/rspec_jsonapi_serializer/matchers/base.rb

@@ -13,17 +13,27 @@ module RSpecJSONAPISerializer
       end
 
       def failure_message
-        raise NotImplementedError
+        ([main_failure_message] + submatcher_failure_messages).compact.join("\n")
       end
 
       def failure_message_when_negated
-        raise NotImplementedError
+        ([main_failure_message_when_negated] + submatcher_failure_messages_when_negated)
+          .compact
+          .join("\n")
       end
 
       protected
 
       attr_reader :expected, :serializer_instance, :submatchers
 
+      def main_failure_message
+        raise NotImplementedError
+      end
+
+      def main_failure_message_when_negated
+        raise NotImplementedError
+      end
+
       def add_submatcher(submatcher)
         submatchers << submatcher
       end
@@ -40,6 +50,16 @@ module RSpecJSONAPISerializer
         serializer_instance.class.name
       end
 
+      private
+
+      def submatcher_failure_messages
+        failing_submatchers.map(&:failure_message)
+      end
+
+      def submatcher_failure_messages_when_negated
+        failing_submatchers.map(&:failure_message_when_negated)
+      end
+
       def failing_submatchers
         @failing_submatchers ||= submatchers.select do |submatcher|
           !submatcher.matches?(serializer_instance)

data/lib/rspec_jsonapi_serializer/matchers/belong_to_matcher.rb

@@ -13,12 +13,12 @@ module RSpecJSONAPISerializer
         association_matcher.matches?(serializer_instance)
       end
 
-      def description
-        association_matcher.description
+      def serializer(value)
+        association_matcher.serializer(value)
       end
 
-      def failure_message
-        association_matcher.failure_message
+      def main_failure_message
+        association_matcher.main_failure_message
       end
 
       private

data/lib/rspec_jsonapi_serializer/matchers/have_attribute_matcher.rb

@@ -19,35 +19,17 @@ module RSpecJSONAPISerializer
       end
 
       def as_nil
-        as(nil)
-      end
-
-      def description
-        description = "have attribute #{expected}"
+        add_submatcher HaveAttributeMatchers::AsMatcher.new(expected, nil)
 
-        [description, submatchers.map(&:description)].flatten.join(' ')
-      end
-
-      def failure_message
-        "Expected #{expectation}."
+        self
       end
 
-      def failure_message_when_negated
-        "Did not expect #{expectation}."
+      def main_failure_message
+        "expected #{serializer_name} to have attribute #{expected}." unless has_attribute?
       end
 
       private
 
-      def expectation
-        expectation = "#{serializer_name} to have attribute #{expected}"
-
-        submatchers_expectations = failing_submatchers.map do |submatcher|
-          "(#{submatcher.expectation})"
-        end.compact.join(", ")
-
-        [expectation, submatchers_expectations].reject(&:nil?).reject(&:empty?).join(" ")
-      end
-
       def attributes
         @attributes ||= serializer_instance.class.try(:attributes_to_serialize) || {}
       end

data/lib/rspec_jsonapi_serializer/matchers/have_attribute_matchers/as_matcher.rb

@@ -18,30 +18,20 @@ module RSpecJSONAPISerializer
           actual == expected
         end
 
-        def description
-          "as #{expected_to_string}"
-        end
-
-        def expectation
-          [ "as #{expected_to_string}", actual_message ].compact.join(", ")
+        def failure_message
+          [expected_message, actual_message].compact.join(", ")
         end
 
         private
 
         attr_reader :attribute
 
-        def expected_to_string
-          value_to_string(expected)
+        def expected_message
+          "expected #{serializer_instance.class.name} to serialize #{attribute} as #{expected}"
         end
 
         def actual_message
-          "got #{value_to_string(actual)} instead" if attributes.has_key?(attribute)
-        end
-
-        def value_to_string(value)
-          return 'nil' if value.nil?
-
-          value.to_s
+          "got #{actual.nil? ? 'nil' : actual} instead" if attributes.has_key?(attribute)
         end
 
         def actual

data/lib/rspec_jsonapi_serializer/matchers/have_id_matcher.rb

@@ -11,7 +11,7 @@ module RSpecJSONAPISerializer
         actual == expected
       end
 
-      def failure_message
+      def main_failure_message
         "expected that #{serializer_name} to have id :#{expected}, got :#{actual} instead"
       end
 

data/lib/rspec_jsonapi_serializer/matchers/have_link_matcher.rb

@@ -19,35 +19,17 @@ module RSpecJSONAPISerializer
       end
 
       def as_nil
-        as(nil)
-      end
-
-      def description
-        description = "have link #{expected}"
+        add_submatcher HaveLinkMatchers::AsMatcher.new(expected, nil)
 
-        [description, submatchers.map(&:description)].flatten.join(' ')
-      end
-
-      def failure_message
-        "Expected #{expectation}."
+        self
       end
 
-      def failure_message_when_negated
-        "Did not expect #{expectation}."
+      def main_failure_message
+        "expected #{serializer_name} to have link #{expected}." unless has_link?
       end
 
       private
 
-      def expectation
-        expectation = "#{serializer_name} to have link #{expected}"
-
-        submatchers_expectations = failing_submatchers.map do |submatcher|
-          "(#{submatcher.expectation})"
-        end.compact.join(", ")
-
-        [expectation, submatchers_expectations].reject(&:nil?).reject(&:empty?).join(" ")
-      end
-
       def has_link?
         links.has_key?(expected)
       end

data/lib/rspec_jsonapi_serializer/matchers/have_link_matchers/as_matcher.rb

@@ -18,30 +18,20 @@ module RSpecJSONAPISerializer
           actual == expected
         end
 
-        def description
-          "as #{expected_to_string}"
-        end
-
-        def expectation
-          [ "as #{expected_to_string}", actual_message ].compact.join(", ")
+        def failure_message
+          [expected_message, actual_message].compact.join(", ")
         end
 
         private
 
         attr_reader :link
 
-        def expected_to_string
-          value_to_string(expected)
+        def expected_message
+          "expected #{serializer_instance.class.name} to serialize link #{link} as #{expected}"
         end
 
         def actual_message
-          "got #{value_to_string(actual)} instead" if links.has_key?(link)
-        end
-
-        def value_to_string(value)
-          return 'nil' if value.nil?
-
-          value.to_s
+          "got #{actual.nil? ? 'nil' : actual} instead" if links.has_key?(link)
         end
 
         def actual

data/lib/rspec_jsonapi_serializer/matchers/have_many_matcher.rb

@@ -13,12 +13,12 @@ module RSpecJSONAPISerializer
         association_matcher.matches?(serializer_instance)
       end
 
-      def description
-        association_matcher.description
+      def serializer(value)
+        association_matcher.serializer(value)
       end
 
-      def failure_message
-        association_matcher.failure_message
+      def main_failure_message
+        association_matcher.main_failure_message
       end
 
       private

data/lib/rspec_jsonapi_serializer/matchers/have_meta_matcher.rb

@@ -19,35 +19,17 @@ module RSpecJSONAPISerializer
       end
 
       def as_nil
-        as(nil)
-      end
-
-      def description
-        description = "serialize meta #{expected}"
+        add_submatcher HaveMetaMatchers::AsMatcher.new(expected, nil)
 
-        [description, submatchers.map(&:description)].flatten.join(' ')
-      end
-
-      def failure_message
-        "Expected #{expectation}."
+        self
       end
 
-      def failure_message_when_negated
-        "Did not expect #{expectation}."
+      def main_failure_message
+        "expected #{serializer_name} to serialize meta #{expected}." unless has_meta?
       end
 
       private
 
-      def expectation
-        expectation = "#{serializer_name} to serialize meta #{expected}"
-
-        submatchers_expectations = failing_submatchers.map do |submatcher|
-          "(#{submatcher.expectation})"
-        end.compact.join(", ")
-
-        [expectation, submatchers_expectations].reject(&:nil?).reject(&:empty?).join(" ")
-      end
-
       def metas
         @metas ||= serializable_hash.dig(:data, :meta) || {}
       end

data/lib/rspec_jsonapi_serializer/matchers/have_meta_matchers/as_matcher.rb

@@ -18,33 +18,22 @@ module RSpecJSONAPISerializer
           actual == expected
         end
 
-        def description
-          "as #{expected_to_string}"
-        end
-
-        def expectation
-          [ "as #{expected_to_string}", actual_message ].compact.join(", ")
+        def failure_message
+          [expected_message, actual_message].compact.join(", ")
         end
 
         private
 
         attr_reader :meta
 
-        def expected_to_string
-          value_to_string(expected)
+        def expected_message
+          "expected #{serializer_instance.class.name} to serialize meta #{meta} as #{expected}"
         end
 
         def actual_message
           "got #{actual.nil? ? 'nil' : actual} instead" if metas.has_key?(meta)
         end
 
-        def value_to_string(value)
-          return 'nil' if value.nil?
-
-          value.to_s
-        end
-
-
         def actual
           metas[meta]
         end

data/lib/rspec_jsonapi_serializer/matchers/have_one_matcher.rb

@@ -13,12 +13,12 @@ module RSpecJSONAPISerializer
         association_matcher.matches?(serializer_instance)
       end
 
-      def description
-        association_matcher.description
+      def serializer(value)
+        association_matcher.serializer(value)
       end
 
-      def failure_message
-        association_matcher.failure_message
+      def main_failure_message
+        association_matcher.main_failure_message
       end
 
       private

data/lib/rspec_jsonapi_serializer/matchers/have_type_matcher.rb

@@ -11,7 +11,7 @@ module RSpecJSONAPISerializer
         actual == expected
       end
 
-      def failure_message
+      def main_failure_message
         "expected that #{serializer_name} to have type :#{expected}, got :#{actual} instead"
       end
 

data/lib/rspec_jsonapi_serializer/matchers.rb

@@ -13,6 +13,8 @@ module RSpecJSONAPISerializer
   module Matchers
     # This allows us to assert attributes on a serializer, e.g.:
     # expect(serializer).to belong_to(:team)
+    # If you have a custom serializer, you can assert its value with the `serializer` submatcher
+    # expect(serializer).to belong_to(:team).serializer(TeamSerializer)
     def belong_to(expected)
       BelongToMatcher.new(expected)
     end
@@ -45,6 +47,8 @@ module RSpecJSONAPISerializer
 
     # This allows us to assert attributes on a serializer, e.g.:
     # expect(serializer).to have_many(:teams)
+    # If you have a custom serializer, you can assert its value with the `serializer` submatcher
+    # expect(serializer).to have_many(:teams).serializer(TeamSerializer)
     def have_many(expected)
       HaveManyMatcher.new(expected)
     end
@@ -61,6 +65,8 @@ module RSpecJSONAPISerializer
 
     # This allows us to assert attributes on a serializer, e.g.:
     # expect(serializer).to have_one(:team)
+    # If you have a custom serializer, you can assert its value with the `serializer` submatcher
+    # expect(serializer).to have_one(:team).serializer(TeamSerializer)
     def have_one(expected)
       HaveOneMatcher.new(expected)
     end

data/lib/rspec_jsonapi_serializer/metadata/relationships.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+
+require "rspec_jsonapi_serializer/metadata/relationships"
+
+module RSpecJSONAPISerializer
+  module Metadata
+    class Relationships
+      def initialize(serializer)
+        @serializer = serializer
+      end
+
+      def relationship(key)
+        relationships.values.find { |relationship| relationship.key.to_s == key.to_s }
+      end
+
+      def relationships
+        serializer.class&.relationships_to_serialize || {}
+      end
+
+      private
+
+      attr_reader :serializer
+    end
+  end
+end

data/lib/rspec_jsonapi_serializer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RSpecJSONAPISerializer
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_jsonapi_serializer
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Mateus Cruz
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-21 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializer
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description:
+description: 
 email:
 - mateus@intricately.com
 executables: []
@@ -34,6 +34,7 @@ files:
 - lib/rspec_jsonapi_serializer.rb
 - lib/rspec_jsonapi_serializer/matchers.rb
 - lib/rspec_jsonapi_serializer/matchers/association_matcher.rb
+- lib/rspec_jsonapi_serializer/matchers/association_matchers/serializer_matcher.rb
 - lib/rspec_jsonapi_serializer/matchers/base.rb
 - lib/rspec_jsonapi_serializer/matchers/belong_to_matcher.rb
 - lib/rspec_jsonapi_serializer/matchers/have_attribute_matcher.rb
@@ -46,6 +47,7 @@ files:
 - lib/rspec_jsonapi_serializer/matchers/have_meta_matchers/as_matcher.rb
 - lib/rspec_jsonapi_serializer/matchers/have_one_matcher.rb
 - lib/rspec_jsonapi_serializer/matchers/have_type_matcher.rb
+- lib/rspec_jsonapi_serializer/metadata/relationships.rb
 - lib/rspec_jsonapi_serializer/version.rb
 homepage: https://github.com/teamintricately/rspec_jsonapi_serializer
 licenses:
@@ -54,7 +56,7 @@ metadata:
   homepage_uri: https://github.com/teamintricately/rspec_jsonapi_serializer
   source_code_uri: https://github.com/teamintricately/rspec_jsonapi_serializer
   changelog_uri: https://github.com/teamintricately/rspec_jsonapi_serializer/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -69,8 +71,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.2.16
+signing_key: 
 specification_version: 4
 summary: RSpec matchers for jsonapi-serializer.
 test_files: []