rspec_jsonapi_serializer 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61f6a27fca68262e1efe72673c7519610c53c72de7f5aeb393c9ad5b32864bfd
-  data.tar.gz: 7f5745572ef15b1442df7d055802f5ffec3e5aac01c14b92e97e80db827f6387
+  metadata.gz: de385c644fa13cd583e2c85c16bf015e883e616acd9a1c2f97ad4715e1280fbb
+  data.tar.gz: be5bb549771e9a1fdad1eebeccf6681fedb5fb1d146458a0ed5f64b6fed0c1f8
 SHA512:
-  metadata.gz: 8f35c497af303a5802f192639b5d36997d6ea76626d7229cbc9d1990882f7163bdb5f6ac12e4f93e2990a95d9c21888ffa465e02ac5edc0a414ced5ef0c9dadf
-  data.tar.gz: 7c0ba61d35ad01c788164f650a60b0d532f856cac08f05f974c33c04309b92d7656c776452d7b83418580c700b6f5accab09b6e8d8a7d40c923f848c73e87b29
+  metadata.gz: be7897f9eeb88466697814a55c599ea43102bb10d30ebfe8e2913196c478ef5e28e5f7136de9ab84c36adf092dba15761f7561146496382e9b38a662bb9b431c
+  data.tar.gz: 6e67c25b2d7e37da12976f1c4973ff3579a82f707057162e32a68a2a997d626679b3705a15a937c0d51c0e3eeeba7a065bcd84f3967b149041fef0aa777fc28e

data/lib/rspec_jsonapi_serializer/matchers/association_matcher.rb

@@ -2,6 +2,7 @@
 
 require "rspec_jsonapi_serializer/matchers/base"
 require "rspec_jsonapi_serializer/matchers/association_matchers/serializer_matcher"
+require "rspec_jsonapi_serializer/matchers/association_matchers/id_method_name_matcher"
 require "rspec_jsonapi_serializer/metadata/relationships"
 
 module RSpecJSONAPISerializer
@@ -26,32 +27,22 @@ module RSpecJSONAPISerializer
         self
       end
 
-      def description
-        description = "#{association_message} #{expected}"
+      def id_method_name(value)
+        add_submatcher AssociationMatchers::IdMethodNameMatcher.new(value, expected)
 
-        [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_message, actual_message].compact.join(", ")
       end
 
       private
 
       attr_reader :relationship_matcher, :relationship_type
 
-      def expectation
-        expectation = "#{serializer_name} to #{association_message} #{expected}"
-
-        submatchers_expectations = failing_submatchers.map do |submatcher|
-          "(#{submatcher.expectation})"
-        end.compact.join(", ")
-
-        [expectation, submatchers_expectations].reject(&:nil?).reject(&:empty?).join(" ")
+      def expected_message
+        "expected #{serializer_name} to #{association_message} #{expected}"
       end
 
       def relationship_matches?
@@ -63,7 +54,7 @@ module RSpecJSONAPISerializer
       end
 
       def association_message
-        relationship_matcher.to_s.split("_").join(" ")
+        relationship_matcher.to_s.split('_')
       end
 
       def actual

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/metadata/relationships"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    module AssociationMatchers
+      class IdMethodNameMatcher < 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 id_method_name for #{relationship_target}"
+        end
+
+        def actual_message
+          actual ? "got #{actual} instead" : nil
+        end
+
+        def actual
+          metadata.relationship(relationship_target).id_method_name
+        end
+
+        def metadata
+          Metadata::Relationships.new(serializer_instance)
+        end
+      end
+    end
+  end
+end

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

@@ -18,18 +18,18 @@ module RSpecJSONAPISerializer
           actual == expected
         end
 
-        def description
-          "with serializer #{expected}"
-        end
-
-        def expectation
-          [ "with serializer #{expected}", actual_message ].compact.join(", ")
+        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

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,20 +13,16 @@ module RSpecJSONAPISerializer
         association_matcher.matches?(serializer_instance)
       end
 
-      def serializer(value)
-        association_matcher.serializer(value)
-      end
-
-      def description
-        association_matcher.description
+      def id_method_name(value)
+        association_matcher.id_method_name(value)
       end
 
-      def failure_message
-        association_matcher.failure_message
+      def serializer(value)
+        association_matcher.serializer(value)
       end
 
-      def failure_message_when_negated
-        association_matcher.failure_message_when_negated
+      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,20 +13,16 @@ module RSpecJSONAPISerializer
         association_matcher.matches?(serializer_instance)
       end
 
-      def serializer(value)
-        association_matcher.serializer(value)
-      end
-
-      def description
-        association_matcher.description
+      def id_method_name(value)
+        association_matcher.id_method_name(value)
       end
 
-      def failure_message
-        association_matcher.failure_message
+      def serializer(value)
+        association_matcher.serializer(value)
       end
 
-      def failure_message_when_negated
-        association_matcher.failure_message_when_negated
+      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,20 +13,16 @@ module RSpecJSONAPISerializer
         association_matcher.matches?(serializer_instance)
       end
 
-      def serializer(value)
-        association_matcher.serializer(value)
-      end
-
-      def description
-        association_matcher.description
+      def id_method_name(value)
+        association_matcher.id_method_name(value)
       end
 
-      def failure_message
-        association_matcher.failure_message
+      def serializer(value)
+        association_matcher.serializer(value)
       end
 
-      def failure_message_when_negated
-        association_matcher.failure_message_when_negated
+      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

@@ -15,6 +15,8 @@ module RSpecJSONAPISerializer
     # 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)
+    # If you have a custom id, you can assert its value with the `id_method_name` submatcher
+    # expect(serializer).to belong_to(:team).id_method_name(:team_slug)
     def belong_to(expected)
       BelongToMatcher.new(expected)
     end
@@ -49,6 +51,8 @@ module RSpecJSONAPISerializer
     # 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)
+    # If you have a custom id, you can assert its value with the `id_method_name` submatcher
+    # expect(serializer).to have_many(:teams).id_method_name(:team_slugs)
     def have_many(expected)
       HaveManyMatcher.new(expected)
     end
@@ -67,6 +71,8 @@ module RSpecJSONAPISerializer
     # 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)
+    # If you have a custom id, you can assert its value with the `id_method_name` submatcher
+    # expect(serializer).to have_one(:team).id_method_name(:team_slug)
     def have_one(expected)
       HaveOneMatcher.new(expected)
     end

data/lib/rspec_jsonapi_serializer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_jsonapi_serializer
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Mateus Cruz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-21 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializer
@@ -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/id_method_name_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
@@ -71,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: RSpec matchers for jsonapi-serializer.