rspec_jsonapi_serializer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ed8b7ea471eb94db672c660a12559e64b185bc7d9e47326f9623be38859d9b6
+  data.tar.gz: eacf5f0be70a08e50cb2b42f02788c14b089722cbee3d4d1e28a1efda1e8b7a2
+SHA512:
+  metadata.gz: '090a203b5643c3930787cf553d6ea1146fffc51964b4a2e94e01b318a31900b590ef3b61e50ec63cb9d1b4d6cc66c7040ca74e60719e3e37470bd7e525940936'
+  data.tar.gz: e7dc94dce570f0a299389743e42183dfe119c723f76573687577f10b5de2175d655ebdbeb2dbb5cc5583027dae58580e07590fe7940eca09035a1270ad924fc4

data/lib/rspec_jsonapi_serializer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/version"
+require "rspec_jsonapi_serializer/matchers"
+
+module RSpecJSONAPISerializer
+end

data/lib/rspec_jsonapi_serializer/matchers.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/matchers/belong_to_matcher"
+require "rspec_jsonapi_serializer/matchers/have_attribute_matcher"
+require "rspec_jsonapi_serializer/matchers/have_id_matcher"
+require "rspec_jsonapi_serializer/matchers/have_link_matcher"
+require "rspec_jsonapi_serializer/matchers/have_many_matcher"
+require "rspec_jsonapi_serializer/matchers/have_meta_matcher"
+require "rspec_jsonapi_serializer/matchers/have_one_matcher"
+require "rspec_jsonapi_serializer/matchers/have_type_matcher"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    # This allows us to assert attributes on a serializer, e.g.:
+    # expect(serializer).to belong_to(:team)
+    def belong_to(expected)
+      BelongToMatcher.new(expected)
+    end
+
+    # This allows us to assert attributes on a serializer, e.g.:
+    # expect(serializer).to have_attribute(:email)
+    # You can test custom attributes by using the submatcher "as".
+    # expect(serializer).to have_attribute(:email).as('john.doe@example.com')
+    def have_attribute(expected)
+      HaveAttributeMatcher.new(expected)
+    end
+
+    alias_method :serialize_attribute, :have_attribute
+
+    # This allows us to assert ids on a serializer, e.g.:
+    # expect(serializer).to have_id(:slug)
+    def have_id(expected)
+      HaveIdMatcher.new(expected)
+    end
+
+    # This allows us to assert links on a serializer, e.g.:
+    # expect(serializer).to have_link(:self)
+    # You can test custom links by using the submatcher "as".
+    # expect(serializer).to have_link(:self).as('https://example.com/users/1')
+    def have_link(expected)
+      HaveLinkMatcher.new(expected)
+    end
+
+    alias_method :serialize_link, :have_link
+
+    # This allows us to assert attributes on a serializer, e.g.:
+    # expect(serializer).to have_many(:teams)
+    def have_many(expected)
+      HaveManyMatcher.new(expected)
+    end
+
+    # This allows us to assert metadata on a serializer, e.g.:
+    # expect(serializer).to have_meta(:foo)
+    # You can test custom metadata by using the submatcher "as".
+    # expect(serializer).to have_meta(:foo).as('bar')
+    def have_meta(expected)
+      HaveMetaMatcher.new(expected)
+    end
+
+    alias_method :serialize_meta, :have_meta
+
+    # This allows us to assert attributes on a serializer, e.g.:
+    # expect(serializer).to have_one(:team)
+    def have_one(expected)
+      HaveOneMatcher.new(expected)
+    end
+
+    # This allows us to assert types on a serializer, e.g.:
+    # expect(serializer).to have_type(:salesforce_serializer)
+    def have_type(expected)
+      HaveTypeMatcher.new(expected)
+    end
+  end
+end

data/lib/rspec_jsonapi_serializer/matchers/association_matcher.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/matchers/base"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    class AssociationMatcher < Base
+      def initialize(expected, relationship_matcher, relationship_type)
+        super(expected)
+
+        @relationship_matcher = relationship_matcher
+        @relationship_type    = relationship_type
+      end
+
+      def matches?(serializer_instance)
+        @serializer_instance = serializer_instance
+
+        relationships.select { |_, r| r.relationship_type == relationship_type }
+                     .has_key?(expected)
+      end
+
+      def main_failure_message
+        [expected_message, actual_message].compact.join(", ")
+      end
+
+      private
+
+      attr_reader :relationship_matcher, :relationship_type
+
+      def expected_message
+        "expected #{serializer_name} to #{association_message} #{expected}"
+      end
+
+      def actual_message
+        actual ? "got :#{actual} instead" : nil
+      end
+
+      def association_message
+        relationship_matcher.to_s.split('_')
+      end
+
+      def actual
+        relationships.key(expected) || relationship.key(expected.to_s)
+      end
+
+      def relationships
+        @relationships ||= serializer_instance.class&.relationships_to_serialize || {}
+      end
+    end
+  end
+end

data/lib/rspec_jsonapi_serializer/matchers/base.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RSpecJSONAPISerializer
+  module Matchers
+    class Base
+      def initialize(expected)
+        @expected    = expected
+        @submatchers = []
+      end
+
+      def matches?(serializer_instance)
+        raise NotImplementedError
+      end
+
+      def failure_message
+        ([main_failure_message] + submatcher_failure_messages).compact.join("\n")
+      end
+
+      def failure_message_when_negated
+        ([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
+
+      def submatchers_match?
+        submatchers.all? { |submatcher| submatcher.matches?(serializer_instance) }
+      end
+
+      def serializable_hash
+        serializer_instance.serializable_hash
+      end
+
+      def serializer_name
+        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)
+        end
+      end
+    end
+  end
+end

data/lib/rspec_jsonapi_serializer/matchers/belong_to_matcher.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/matchers/association_matcher"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    class BelongToMatcher
+      def initialize(expected)
+        @association_matcher = AssociationMatcher.new(expected, :belong_to, :belongs_to)
+      end
+
+      def matches?(serializer_instance)
+        association_matcher.matches?(serializer_instance)
+      end
+
+      def main_failure_message
+        association_matcher.main_failure_message
+      end
+
+      private
+
+      attr_reader :association_matcher
+    end
+  end
+end

data/lib/rspec_jsonapi_serializer/matchers/have_attribute_matcher.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/matchers/base"
+require "rspec_jsonapi_serializer/matchers/have_attribute_matchers/as_matcher"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    class HaveAttributeMatcher < Base
+      def matches?(serializer_instance)
+        @serializer_instance = serializer_instance
+
+        has_attribute? && submatchers_match?
+      end
+
+      def as(value)
+        add_submatcher HaveAttributeMatchers::AsMatcher.new(expected, value)
+
+        self
+      end
+
+      def as_nil
+        add_submatcher HaveAttributeMatchers::AsMatcher.new(expected, nil)
+
+        self
+      end
+
+      def main_failure_message
+        "expected #{serializer_name} to have attribute #{expected}." unless has_attribute?
+      end
+
+      private
+
+      def attributes
+        @attributes ||= serializer_instance.class.try(:attributes_to_serialize) || {}
+      end
+
+      def has_attribute?
+        attributes.has_key?(expected)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/matchers/base"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    module HaveAttributeMatchers
+      class AsMatcher < Base
+        def initialize(attribute, expected)
+          super(expected)
+
+          @attribute = attribute
+        end
+
+        def matches?(serializer_instance)
+          @serializer_instance = serializer_instance
+
+          actual == expected
+        end
+
+        def failure_message
+          [expected_message, actual_message].compact.join(", ")
+        end
+
+        private
+
+        attr_reader :attribute
+
+        def expected_message
+          "expected #{serializer_instance.class.name} to serialize #{attribute} as #{expected}"
+        end
+
+        def actual_message
+          "got #{actual.nil? ? 'nil' : actual} instead" if attributes.has_key?(attribute)
+        end
+
+        def actual
+          attributes[attribute]
+        end
+
+        def attributes
+          serializable_hash.dig(:data, :attributes)
+        end
+
+        def serializable_hash
+          serializer_instance.serializable_hash
+        end
+      end
+    end
+  end
+end

data/lib/rspec_jsonapi_serializer/matchers/have_id_matcher.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/matchers/base"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    class HaveIdMatcher < Base
+      def matches?(serializer_instance)
+        @serializer_instance = serializer_instance
+
+        actual == expected
+      end
+
+      def main_failure_message
+        "expected that #{serializer_name} to have id :#{expected}, got :#{actual} instead"
+      end
+
+      private
+
+      def actual
+        serializer_instance.class.record_id
+      end
+    end
+  end
+end

data/lib/rspec_jsonapi_serializer/matchers/have_link_matcher.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/matchers/base"
+require "rspec_jsonapi_serializer/matchers/have_link_matchers/as_matcher"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    class HaveLinkMatcher < Base
+      def matches?(serializer_instance)
+        @serializer_instance = serializer_instance
+
+        has_link? && submatchers_match?
+      end
+
+      def as(value)
+        add_submatcher HaveLinkMatchers::AsMatcher.new(expected, value)
+
+        self
+      end
+
+      def as_nil
+        add_submatcher HaveLinkMatchers::AsMatcher.new(expected, nil)
+
+        self
+      end
+
+      def main_failure_message
+        "expected #{serializer_name} to have link #{expected}." unless has_link?
+      end
+
+      private
+
+      def has_link?
+        links.has_key?(expected)
+      end
+
+      def links
+        serializable_hash.dig(:data, :links)
+      end
+
+      def serializable_hash
+        serializer_instance.serializable_hash
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/matchers/base"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    module HaveLinkMatchers
+      class AsMatcher < Base
+        def initialize(link, expected)
+          super(expected)
+
+          @link = link
+        end
+
+        def matches?(serializer_instance)
+          @serializer_instance = serializer_instance
+
+          actual == expected
+        end
+
+        def failure_message
+          [expected_message, actual_message].compact.join(", ")
+        end
+
+        private
+
+        attr_reader :link
+
+        def expected_message
+          "expected #{serializer_instance.class.name} to serialize link #{link} as #{expected}"
+        end
+
+        def actual_message
+          "got #{actual.nil? ? 'nil' : actual} instead" if links.has_key?(link)
+        end
+
+        def actual
+          links[link]
+        end
+
+        def links
+          serializable_hash.dig(:data, :links)
+        end
+
+        def serializable_hash
+          serializer_instance.serializable_hash
+        end
+      end
+    end
+  end
+end

data/lib/rspec_jsonapi_serializer/matchers/have_many_matcher.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/matchers/association_matcher"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    class HaveManyMatcher
+      def initialize(expected)
+        @association_matcher = AssociationMatcher.new(expected, :have_many, :has_many)
+      end
+
+      def matches?(serializer_instance)
+        association_matcher.matches?(serializer_instance)
+      end
+
+      def main_failure_message
+        association_matcher.main_failure_message
+      end
+
+      private
+
+      attr_reader :association_matcher
+    end
+  end
+end

data/lib/rspec_jsonapi_serializer/matchers/have_meta_matcher.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/matchers/base"
+require "rspec_jsonapi_serializer/matchers/have_meta_matchers/as_matcher"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    class HaveMetaMatcher < Base
+      def matches?(serializer_instance)
+        @serializer_instance = serializer_instance
+
+        has_meta? && submatchers_match?
+      end
+
+      def as(value)
+        add_submatcher HaveMetaMatchers::AsMatcher.new(expected, value)
+
+        self
+      end
+
+      def as_nil
+        add_submatcher HaveMetaMatchers::AsMatcher.new(expected, nil)
+
+        self
+      end
+
+      def main_failure_message
+        "expected #{serializer_name} to serialize meta #{expected}." unless has_meta?
+      end
+
+      private
+
+      def metas
+        @metas ||= serializable_hash.dig(:data, :meta) || {}
+      end
+
+      def has_meta?
+        metas.has_key?(expected)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/matchers/base"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    module HaveMetaMatchers
+      class AsMatcher < Base
+        def initialize(meta, expected)
+          super(expected)
+
+          @meta = meta
+        end
+
+        def matches?(serializer_instance)
+          @serializer_instance = serializer_instance
+
+          actual == expected
+        end
+
+        def failure_message
+          [expected_message, actual_message].compact.join(", ")
+        end
+
+        private
+
+        attr_reader :meta
+
+        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 actual
+          metas[meta]
+        end
+
+        def metas
+          @metas ||= serializable_hash.dig(:data, :meta) || {}
+        end
+      end
+    end
+  end
+end

data/lib/rspec_jsonapi_serializer/matchers/have_one_matcher.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/matchers/association_matcher"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    class HaveOneMatcher
+      def initialize(expected)
+        @association_matcher = AssociationMatcher.new(expected, :have_one, :has_one)
+      end
+
+      def matches?(serializer_instance)
+        association_matcher.matches?(serializer_instance)
+      end
+
+      def main_failure_message
+        association_matcher.main_failure_message
+      end
+
+      private
+
+      attr_reader :association_matcher
+    end
+  end
+end

data/lib/rspec_jsonapi_serializer/matchers/have_type_matcher.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rspec_jsonapi_serializer/matchers/base"
+
+module RSpecJSONAPISerializer
+  module Matchers
+    class HaveTypeMatcher < Base
+      def matches?(serializer_instance)
+        @serializer_instance = serializer_instance
+
+        actual == expected
+      end
+
+      def main_failure_message
+        "expected that #{serializer_name} to have type :#{expected}, got :#{actual} instead"
+      end
+
+      private
+
+      def actual
+        serializer_instance.class.record_type
+      end
+    end
+  end
+end

data/lib/rspec_jsonapi_serializer/version.rb

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

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: rspec_jsonapi_serializer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mateus Cruz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsonapi-serializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- mateus@intricately.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+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/base.rb
+- lib/rspec_jsonapi_serializer/matchers/belong_to_matcher.rb
+- lib/rspec_jsonapi_serializer/matchers/have_attribute_matcher.rb
+- lib/rspec_jsonapi_serializer/matchers/have_attribute_matchers/as_matcher.rb
+- lib/rspec_jsonapi_serializer/matchers/have_id_matcher.rb
+- lib/rspec_jsonapi_serializer/matchers/have_link_matcher.rb
+- lib/rspec_jsonapi_serializer/matchers/have_link_matchers/as_matcher.rb
+- lib/rspec_jsonapi_serializer/matchers/have_many_matcher.rb
+- lib/rspec_jsonapi_serializer/matchers/have_meta_matcher.rb
+- 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/version.rb
+homepage: https://github.com/teamintricately/rspec_jsonapi_serializer
+licenses:
+- MIT
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key: 
+specification_version: 4
+summary: RSpec matchers for jsonapi-serializer.
+test_files: []