Contents

require_relative 'base_matcher'

module RSpec
  module GraphqlMatchers
    class HaveAField < BaseMatcher
      def initialize(expected_field_name)
        @expected_field_name = expected_field_name.to_s
        @expected_field_type = @graph_object = nil
      end

      def matches?(graph_object)
        @graph_object = graph_object

        unless @graph_object.respond_to?(:fields)
          raise "Invalid object #{@graph_object} provided to have_a_field " \
            'matcher. It does not seem to be a valid GraphQL object type.'
        end

        @actual_field = @graph_object.fields[@expected_field_name]
        valid_field? && types_match?(@actual_field.type, @expected_field_type)
      end

      def that_returns(expected_field_type)
        @expected_field_type = expected_field_type

        self
      end
      alias returning that_returns
      alias of_type that_returns

      def failure_message
        "expected #{describe_obj(@graph_object)} to " \
          "#{description}, #{explanation}."
      end

      def description
        "define field `#{@expected_field_name}`" + of_type_description
      end

      private

      def explanation
        return 'but no field was found with that name' unless @actual_field

        "but the field type was `#{@actual_field.type}`"
      end

      def valid_field?
        unless @expected_field_type.nil? || @actual_field.respond_to?(:type)
          error_msg = "The `#{@expected_field_name}` field defined by the GraphQL " \
          'object does\'t seem valid as it does not respond to #type. ' \
          "\n\n\tThe field found was #{@actual_field.inspect}. "
          puts error_msg
          raise error_msg
        end

        @actual_field
      end

      def of_type_description
        return '' unless @expected_field_type

        " of type `#{@expected_field_type}`"
      end

      def describe_obj(field)
        field.respond_to?(:name) && field.name || field.inspect
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rspec-graphql_matchers-0.4.0	lib/rspec/graphql_matchers/have_a_field.rb