test_assistant 0.1.2 → 1.0.0

data/lib/test_assistant/email/helpers.rb

@@ -1,37 +0,0 @@
-require 'test_assistant/email/expectation'
-
-module TestAssistant::Email
-  # Module containing email helper methods that can be mixed into RSpec the test scope
-  #
-  # @see TestAssistant::Configuration#include_email_helpers
-  module Helpers
-    # Syntactic sugar for referencing the list of emails sent since the start of the test
-    #
-    # @return [Array<Mail::Message>] list of sent emails
-    #
-    # @example Asserting email has been sent
-    #   expect(email).to have_been_sent.to('test@email.com')
-    def email
-      ActionMailer::Base.deliveries
-    end
-
-    # Clears the list of sent emails. Automatically called by Test Assistant at the
-    # end of every test.
-    #
-    # @return void
-    def clear_emails
-      ActionMailer::Base.deliveries = []
-    end
-
-    # Creates a new email expectation that allows asserting emails should have specific
-    # attributes.
-    #
-    # @see TestAssistant::Email::Expectation
-    #
-    # @example Asserting email has been sent
-    #   expect(email).to have_been_sent.to('test@email.com')
-    def have_been_sent
-      TestAssistant::Email::Expectation.new
-    end
-  end
-end

data/lib/test_assistant/json/expectation.rb

@@ -1,189 +0,0 @@
-require 'capybara/rspec'
-require 'hashdiff'
-
-module TestAssistant::Json
-  # Backing class for the eql_json RSpec matcher. Used for matching Ruby representations
-  # of JSON response bodies. Provides clear diff representations for simple and complex
-  # or nested JSON objects, highlighting only the values that are different, and where
-  # they are in the larger JSON object.
-  #
-  # Expected to be used as part of a RSpec test suite and with json_response.
-  #
-  # Implements the same interface as RSpec custom matcher classes
-  #
-  # @see TestAssistant::Json::Helpers#json_response
-  # @see TestAssistant::Json::Helpers#eql_json
-  class Expectation
-    # Creates a new TestAssistant::Json::Expectation object.
-    #
-    # @see TestAssistant::Json::Helpers#eql_json
-    #
-    # @param expected the expected value that will be compared with the actual value
-    # @return [TestAssistant::Json::Expectation] new expectation object
-    def initialize(expected)
-      @expected = expected
-      @message = ''
-      @reported_differences = {}
-    end
-
-    # Declares that RSpec should not attempt to diff the actual and expected values
-    # to put in the failure message. This class takes care of diffing and presenting
-    # the differences, itself.
-    # @return [false] always returns false
-    def diffable?
-      false
-    end
-
-    # Whether the actual value and the expected value are considered equal.
-    # @param actual value to be compared to the expected value for equality
-    # @return [Boolean] whether actual is equal to expected
-    def matches?(actual)
-      @actual = actual
-      @expected.eql?(@actual)
-    end
-
-    # Message to display to StdOut by RSpec if the equality check fails. Includes a
-    # complete serialisation of the expected and actual values and is then followed
-    # by a description of only the (possibly deeply nested) attributes that are
-    # different
-    # @return [String] message full failure message with explanation of why actual
-    #   failed the equality check with expected
-    def failure_message
-      @message += "Expected: #{@expected}\n\n"
-      @message += "Actual: #{@actual}\n\n"
-      @message += "Differences\n\n"
-
-      add_diff_to_message(@actual, @expected)
-
-      @message
-    end
-
-    private
-
-    # Adds diff descriptions to the failure message until the all the nodes of the
-    # expected and actual values have been compared and all the differences (and the
-    # paths to them) have been included. For Hashes and Arrays, it recursively calls
-    # itself to compare all nodes and elements.
-    #
-    # @param actual_value current node of the actual value being compared to the
-    #   corresponding node of the expected value
-    # @param expected_value current node of the expected value being compared to
-    #   the corresponding node of the actual value
-    # @param [String] path path to the current nodes being compared,
-    #   relative to the root full objects
-    # @return void Diff descriptions are appended directly to message
-    def add_diff_to_message(actual_value, expected_value, path = '')
-      diffs_sorted_by_name = HashDiff
-                        .diff(actual_value, expected_value)
-                        .sort{|diff1, diff2| diff1[1] <=> diff2[1]}
-
-      diffs_grouped_by_name =
-        diffs_sorted_by_name.inject({}) do |memo, diff|
-          operator, name, value = diff
-          memo[name] ||= {}
-          memo[name][operator] = value
-          memo
-        end
-
-      diffs_grouped_by_name.each do |name, difference|
-
-        missing_value = difference['-'] || value_at_path(actual_value, name)
-        extra_value = difference['+'] || value_at_path(expected_value, name)
-        different_value = difference['~']
-
-        full_path = path.length > 0 ? "#{path}.#{name}" : name
-
-        if non_empty_hash?(missing_value) && non_empty_hash?(extra_value)
-
-          add_diff_to_message(missing_value, extra_value, full_path)
-
-        elsif non_empty_array?(missing_value) && non_empty_array?(extra_value)
-
-          [ missing_value.length, extra_value.length ].max.times do |i|
-            add_diff_to_message(missing_value[i], extra_value[i], full_path)
-          end
-
-        else
-          if difference.has_key?('~')
-            append_to_message(full_path,
-                get_diff(
-                    full_path,
-                    expected: value_at_path(expected_value, name),
-                    actual: different_value
-                )
-            )
-          else
-            append_to_message(full_path,
-                get_diff(
-                  full_path,
-                  expected: extra_value,
-                  actual: missing_value
-              )
-            )
-          end
-        end
-
-      end
-    end
-
-    def non_empty_hash?(target)
-      target.kind_of?(Hash) && target.any?
-    end
-
-    def non_empty_array?(target)
-      target.kind_of?(Array) && target.any?
-    end
-
-    def append_to_message(attribute, difference_description)
-      unless already_reported_difference?(attribute)
-        @message += difference_description
-        @reported_differences[attribute] = true
-      end
-    end
-
-    def already_reported_difference?(attribute)
-      !!@reported_differences[attribute]
-    end
-
-    def value_at_path(target, attribute_path)
-      keys = attribute_path.split(/\[|\]|\./)
-
-      keys = keys.map do |key|
-        if key.to_i == 0 && key != '0'
-          key
-        else
-          key.to_i
-        end
-      end
-
-      result = target
-
-
-      keys.each do |key|
-
-        unless key == ''
-          result = result[key]
-        end
-
-      end
-
-      result
-    end
-
-    def get_diff(attribute, options = {})
-      diff_description = ''
-      diff_description += "#{attribute}\n"
-      diff_description += "Expected: #{format_value(options[:expected])}\n"
-      diff_description + "Actual: #{format_value(options[:actual])}\n\n"
-    end
-
-    def format_value(value)
-      if value.kind_of?(String)
-        "'#{value}'"
-      else
-        value
-      end
-    end
-
-  end
-end

data/lib/test_assistant/json/helpers.rb

@@ -1,38 +0,0 @@
-require 'test_assistant/json/expectation'
-
-module TestAssistant::Json
-  # Module containing JSON helper methods that can be mixed into RSpec the test scope
-  #
-  # @see TestAssistant::Configuration#include_json_helpers
-  module Helpers
-    # Parses the last response body in a Rails RSpec controller or request test as JSON
-    #
-    # @return [Hash{String => String, Number, Hash, Array}] Ruby representation of
-    #   the JSON response body
-    # @raise []JSON::ParserError] when the response body is not valid JSON
-    def json_response
-      begin
-        JSON.parse(response.body)
-      rescue JSON::ParserError
-        '< INVALID JSON RESPONSE >'.freeze
-      end
-    end
-
-    # Creates a new TestAssistant::Json::Expectation instance so it can be passed
-    # to RSpec to match against an actual value.
-    #
-    # @see TestAssistant::Expectation
-    #
-    # @param expected the expected value the RSpec matcher should match against
-    # @return [TestAssistant::Json::Expectation] new expectation object
-    #
-    # @example Use the eql_json expectation
-    #   expect(actual).to eql_json(expected)
-    #
-    # @example Use the eql_json expectation with json_response
-    #   expect(json_response).to eql_json(expected)
-    def eql_json(expected)
-      TestAssistant::Json::Expectation.new(expected)
-    end
-  end
-end

data/spec/email_expectation_spec.rb

@@ -1,369 +0,0 @@
-require 'test_assistant/email/helpers'
-require_relative './support/email_mock'
-
-RSpec.describe 'have_sent_email' do
-  include TestAssistant::Email::Helpers
-
-  context "when no emails have been sent" do
-    subject { [] }
-
-    it "then the positive assertion fails" do
-      expect {
-        expect(subject).to have_been_sent
-      }.to raise_error.with_message('Expected an email to be sent. However, no emails were sent.')
-    end
-
-    it "then the negative assertion passes" do
-      expect {
-        expect(subject).to_not have_been_sent
-      }.to_not raise_error
-    end
-
-    it "then a non-matching 'to' assertion fails" do
-      expect {
-        expect(subject).to have_been_sent.to('test@email.com')
-      }.to raise_error.with_message('Expected an email to be sent to \'test@email.com\'. However, no emails were sent.')
-    end
-
-    it "then a non-matching 'from' assertion fails" do
-      expect {
-        expect(subject).to have_been_sent.from('test@email.com')
-      }.to raise_error.with_message('Expected an email to be sent from \'test@email.com\'. However, no emails were sent.')
-    end
-
-    it "then a non-matching 'with_subject' assertion fails" do
-      expect {
-        expect(subject).to have_been_sent.with_subject('Subject')
-      }.to raise_error.with_message('Expected an email to be sent with subject \'Subject\'. However, no emails were sent.')
-    end
-
-    it "then a non-matching 'with_text' assertion fails" do
-      expect {
-        expect(subject).to have_been_sent.with_text('Text')
-      }.to raise_error.with_message('Expected an email to be sent with text \'Text\'. However, no emails were sent.')
-    end
-
-    it "then a non-matching 'matching_selector' assertion fails" do
-      expect {
-        expect(subject).to have_been_sent.matching_selector('h1')
-      }.to raise_error.with_message('Expected an email to be sent matching selector \'h1\'. However, no emails were sent.')
-    end
-
-    it "then a non-matching 'with_link' assertion fails" do
-      expect {
-        expect(subject).to have_been_sent.with_link('www.example.com')
-      }.to raise_error.with_message('Expected an email to be sent with link \'www.example.com\'. However, no emails were sent.')
-    end
-
-    it "then a non-matching 'with_image' assertion fails" do
-      expect {
-        expect(subject).to have_been_sent.with_image('www.example.com')
-      }.to raise_error.with_message('Expected an email to be sent with image \'www.example.com\'. However, no emails were sent.')
-    end
-
-  end
-
-  context "when an email has been sent" do
-    subject { [ EmailMock.new ] }
-
-    it "then the unqualified assertion passes" do
-      expect {
-        expect(subject).to have_been_sent
-      }.to_not raise_error
-    end
-
-    it "then the unqualified negative assertion fails" do
-      expect {
-        expect(subject).to_not have_been_sent
-      }.to raise_error("Expected no emails to be sent.")
-    end
-  end
-
-  context "when a matching email has been sent" do
-    subject { [ EmailMock.new ] }
-
-    it "then a positive 'to' assertion passes" do
-      expect {
-        expect(subject).to have_been_sent.to(subject[0].to[0])
-      }.to_not raise_error
-    end
-
-    it "then a negative 'to' assertion fails" do
-      expect {
-        expect(subject).to_not have_been_sent.to(subject[0].to[0])
-      }.to raise_error.with_message("Expected no emails to be sent to '#{subject[0].to[0]}'.")
-    end
-
-    it "then a positive 'from' assertion passes" do
-      expect {
-        expect(subject).to have_been_sent.from(subject[0].from[0])
-      }.to_not raise_error
-    end
-
-    it "then a negative 'from' assertion fails" do
-      expect {
-        expect(subject).to_not have_been_sent.from(subject[0].from[0])
-      }.to raise_error.with_message("Expected no emails to be sent from '#{subject[0].from[0]}'.")
-    end
-
-    it "then a positive 'with_subject' assertion passes" do
-      expect {
-        expect(subject).to have_been_sent.with_subject(subject[0].subject)
-      }.to_not raise_error
-    end
-
-    it "then a negative 'with_subject' assertion fails" do
-      expect {
-        expect(subject).to_not have_been_sent.with_subject(subject[0].subject)
-      }.to raise_error.with_message("Expected no emails to be sent with subject '#{subject[0].subject}'.")
-    end
-
-    it "then a positive 'with_text' assertion passes" do
-      expect {
-        expect(subject).to have_been_sent.with_text(subject[0].text)
-      }.to_not raise_error
-    end
-
-    it "then a negative 'with_text' assertion fails" do
-      expect {
-        expect(subject).to_not have_been_sent.with_text(subject[0].text)
-      }.to raise_error.with_message("Expected no emails to be sent with text '#{subject[0].text}'.")
-    end
-
-    it "then a positive 'matching_selector' assertion passes" do
-      expect {
-        expect(subject).to have_been_sent.matching_selector('h1')
-      }.to_not raise_error
-    end
-
-    it "then a negative 'matching_selector' assertion fails" do
-      expect {
-        expect(subject).to_not have_been_sent.matching_selector('h1')
-      }.to raise_error.with_message("Expected no emails to be sent matching selector 'h1'.")
-    end
-
-    it "then a positive 'with_link' assertion passes" do
-      expect {
-        expect(subject).to have_been_sent.with_link('www.test.com')
-      }.to_not raise_error
-    end
-
-    it "then a negative 'with_link' assertion fails" do
-      expect {
-        expect(subject).to_not have_been_sent.with_link('www.test.com')
-      }.to raise_error.with_message("Expected no emails to be sent with link 'www.test.com'.")
-    end
-
-    it "then a positive 'with_image' assertion passes" do
-      expect {
-        expect(subject).to have_been_sent.with_image('www.test.com')
-      }.to_not raise_error
-    end
-
-    it "then a negative 'with_image' assertion fails" do
-      expect {
-        expect(subject).to_not have_been_sent.with_image('www.test.com')
-      }.to raise_error.with_message("Expected no emails to be sent with image 'www.test.com'.")
-    end
-  end
-
-  context "when a non-matching email has been sent" do
-    subject { [ EmailMock.new ] }
-
-    it "then a positive 'to' assertion fails" do
-      expect {
-        expect(subject).to have_been_sent.to('other@email.com')
-      }.to raise_error.with_message("Expected an email to be sent to 'other@email.com'. However, 1 was sent to '#{subject[0].to[0]}'.")
-    end
-
-    it "then a negative 'to' assertion passes" do
-      expect {
-        expect(subject).to_not have_been_sent.to('other@email.com')
-      }.to_not raise_error
-    end
-
-    it "then a positive 'from' assertion fails" do
-      expect {
-        expect(subject).to have_been_sent.from('other@email.com')
-      }.to raise_error.with_message("Expected an email to be sent from 'other@email.com'. However, 1 was sent from '#{subject[0].from[0]}'.")
-    end
-
-    it "then a negative 'from' assertion passes" do
-      expect {
-        expect(subject).to_not have_been_sent.from('other@email.com')
-      }.to_not raise_error
-    end
-
-    it "then a positive 'with_subject' assertion fails" do
-      expect {
-        expect(subject).to have_been_sent.with_subject('Other Subject')
-      }.to raise_error.with_message("Expected an email to be sent with subject 'Other Subject'. However, 1 was sent with subject '#{subject[0].subject}'.")
-    end
-
-    it "then a negative 'with_subject' assertion passes" do
-      expect {
-        expect(subject).to_not have_been_sent.with_subject('Other Subject')
-      }.to_not raise_error
-    end
-
-    it "then a positive 'with_text' assertion fails" do
-      expect {
-        expect(subject).to have_been_sent.with_text('Other text')
-      }.to raise_error.with_message("Expected an email to be sent with text 'Other text'. However, 1 was sent with text '#{subject[0].text}'.")
-    end
-
-    it "then a negative 'with_text' assertion passes" do
-      expect {
-        expect(subject).to_not have_been_sent.with_text('Other text')
-      }.to_not raise_error
-    end
-
-    it "then a positive 'matching_selector' assertion fails" do
-      expect {
-        expect(subject).to have_been_sent.matching_selector('.other')
-      }.to raise_error.with_message("Expected an email to be sent matching selector '.other'. However, 1 was sent with body #{subject[0].body}.")
-    end
-
-    it "then a negative 'matching_selector' assertion passes" do
-      expect {
-        expect(subject).to_not have_been_sent.matching_selector('.other')
-      }.to_not raise_error
-    end
-
-    it "then a positive 'with_link' assertion fails"do
-      expect {
-        expect(subject).to have_been_sent.with_link('www.other.com')
-      }.to raise_error.with_message("Expected an email to be sent with link 'www.other.com'. However, 1 was sent with body #{subject[0].body}.")
-    end
-
-    it "then a negative 'with_link' assertion passes" do
-      expect {
-        expect(subject).to_not have_been_sent.with_link('www.other.com')
-      }.to_not raise_error
-    end
-
-    it "then a positive 'with_image' assertion fails" do
-      expect {
-        expect(subject).to have_been_sent.with_image('www.other.com')
-      }.to raise_error.with_message("Expected an email to be sent with image 'www.other.com'. However, 1 was sent with body #{subject[0].body}.")
-    end
-
-    it "then a negative 'with_image' assertion passes" do
-      expect {
-        expect(subject).to_not have_been_sent.with_image('www.other.com')
-      }.to_not raise_error
-    end
-  end
-
-  context "when multiple emails have been sent" do
-    subject { [ EmailMock.new, EmailMock.new(to: 'other@email.com') ] }
-
-    it "then a positive assertion matching the first email passes" do
-      expect {
-        expect(subject).to have_been_sent.to(subject[0].to[0])
-      }.to_not raise_error
-    end
-
-    it "then a negative assertion matching the first email fails" do
-      expect {
-        expect(subject).to_not have_been_sent.to(subject[0].to[0])
-      }.to raise_error.with_message("Expected no emails to be sent to '#{subject[0].to[0]}'.")
-    end
-
-    it "then a positive assertion matching the second email passes" do
-      expect {
-        expect(subject).to have_been_sent.to(subject[1].to)
-      }.to_not raise_error
-    end
-
-    it "then a negative assertion matching the second email fails" do
-      expect {
-        expect(subject).to_not have_been_sent.to(subject[1].to)
-      }.to raise_error.with_message("Expected no emails to be sent to '#{subject[1].to[0]}'.")
-    end
-
-  end
-
-  context "when using multiple qualifiers" do
-    subject { [ EmailMock.new ] }
-
-    it "then a positive assertions correctly matches a matching email" do
-      expect {
-        expect(subject).to have_been_sent.to(subject[0].to[0]).from(subject[0].from[0])
-      }.to_not raise_error
-    end
-
-    it "then a positive assertions don't match an email if the first qualifier isn't satisfied" do
-      expect {
-        expect(subject).to have_been_sent.to('other@email.com').from(subject[0].from[0])
-      }.to raise_error.with_message("Expected an email to be sent to 'other@email.com'. However, 1 was sent to '#{subject[0].to[0]}'.")
-    end
-
-    it "then a positive assertions don't match an email if the last qualifier isn't satisfied" do
-      expect {
-        expect(subject).to have_been_sent.to(subject[0].to[0]).from('other@email.com')
-      }.to raise_error.with_message("Expected an email to be sent from 'other@email.com'. However, 1 was sent from '#{subject[0].from[0]}'.")
-    end
-
-    it "then a negative assertions correctly matches a matching email" do
-      expect {
-        expect(subject).to_not have_been_sent.to(subject[0].to[0]).from(subject[0].from[0])
-      }.to raise_error.with_message("Expected no emails to be sent to '#{subject[0].to[0]}' from '#{subject[0].from[0]}'.")
-    end
-
-    it "then a negative assertions don't match an email if the first qualifier isn't satisfied" do
-      expect {
-        expect(subject).to_not have_been_sent.to('other@email.com').from(subject[0].from[0])
-      }.to_not raise_error
-    end
-
-    it "then a negative assertions don't match an email if the last qualifier isn't satisfied" do
-      expect {
-        expect(subject).to_not have_been_sent.to(subject[0].to[0]).from('other@email.com')
-      }.to_not raise_error
-    end
-  end
-
-  context "when using the and method" do
-    subject { [ EmailMock.new ] }
-
-    it "then a positive assertion will fail if the first qualifier is not satisfied" do
-      expect {
-        expect(subject).to have_been_sent.with_text('Other').and('Email')
-      }.to raise_error.with_message("Expected an email to be sent with text 'Other' and 'Email'. However, 1 was sent with text '#{subject[0].text}'.")
-    end
-
-    it "then a positive assertion will fail if the second qualifier is not satisfied" do
-      expect {
-        expect(subject).to have_been_sent.with_text('Test').and('Other')
-      }.to raise_error.with_message("Expected an email to be sent with text 'Test' and 'Other'. However, 1 was sent with text '#{subject[0].text}'.")
-    end
-
-    it "then a positive assertion will pass if both qualifiers are satisfied" do
-      expect {
-        expect(subject).to have_been_sent.with_text('Test').and('Email')
-      }.to_not raise_error
-    end
-
-    it "then a negative assertion will pass if the first qualifier is not satisfied" do
-      expect {
-        expect(subject).to_not have_been_sent.with_text('Other').and('Email')
-      }.to_not raise_error
-    end
-
-    it "then a negative assertion will pass if the second qualifier is not satisfied" do
-      expect {
-        expect(subject).to_not have_been_sent.with_text('Test').and('Other')
-      }.to_not raise_error
-    end
-
-    it "then a negative assertion will fail if both qualifiers are satisfied" do
-      expect {
-        expect(subject).to_not have_been_sent.with_text('Test').and('Email')
-      }.to raise_error.with_message('Expected no emails to be sent with text \'Test\' and \'Email\'.')
-    end
-
-  end
-
-
-end