test_assistant 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c14c4c6d990513adb024b4571090c7fc85dca59
-  data.tar.gz: 1ab16e504b25feca6a2d2ab443684d4512e4a67e
+  metadata.gz: fd9da0b295791c6249e94172857509c44b58b7ac
+  data.tar.gz: ffb211e31de33220bfeea704961e844738597308
 SHA512:
-  metadata.gz: 8361c96e295b176daf5c9aba592217be43174ba39876094fc5f7423e9f2ddfe14db46fc8e7b424b8ede85c8035c8f5b78074222f10a6be8631aea60a74e59577
-  data.tar.gz: 33107a1cc37d9ffd6d645b02206699c0d8f6afdb392fbf76b1e2a72cbc1fb7d0efa49294c010f58a6a8da415b72962bb72d6f9a74a5126ceff09c95fb30c2fcf
+  metadata.gz: 3c98c15b60558a8615edfdfc7336e307848eb481f8167574a7208d559d48220b1f6686b454b38e9c6f9932329158d5fbac98b40f470b71e89e956b62cb6f34db
+  data.tar.gz: 3d0500451574c4b9bffd61a05b5a8380a9fc5a8eeac1bc555b5e38348945c3d7f7b8bf931fb832fc6faf419b20fcf8ee98792ccd8a754c0de5668481e9b3f804

data/README.md

@@ -84,10 +84,40 @@ RSpec.describe 'making some valid request', type: :request do
 end
 ```
 
+## Email expectations
+
+
+```ruby
+TestAssistant.configure(config) do |ta_config|
+  ta_config.include_email_helpers type: :request
+end
+```
+
+```ruby
+RSpec.describe 'making some valid request', type: :request do
+  context 'some important context' do
+    it 'should send an email' do
+      expect(email).to have_been_sent
+                          .to('user@email.com')
+                          .from('admin@site.com')
+                          .with_subject('Welcome!')
+                          .with_text('Welcome, user@email.com').and('Thanks for signing up')
+                          .with_selector('#password').and('#username')
+                          .with_link('www.site.com/onboarding/1')
+                          .with_image('www.site.com/assets/images/welcome.png')
+    end
+  end
+end
+```
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/test_assistant/fork )
+1. Fork it ( https://github.com/greena13/test_assistant/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Inspirations
+
+* [CapybaraEmail](https://github.com/DockYard/capybara-email)

data/lib/test_assistant/configuration.rb

@@ -1,5 +1,6 @@
 module TestAssistant
   autoload :JSONHelpers, 'test_assistant/json_helpers'
+  autoload :Email, 'test_assistant/email/helpers'
   autoload :FailureReporter, 'test_assistant/failure_reporter'
 
   class Configuration
@@ -11,6 +12,10 @@ module TestAssistant
       @rspec_config.include JSONHelpers, options
     end
 
+    def include_email_helpers(options = {})
+      @rspec_config.include Email::Helpers, options
+    end
+
     def render_failed_responses(options = {})
       tag_filter = options[:tag]
       no_tag_filter = !tag_filter

data/lib/test_assistant/email/expectation.rb

@@ -0,0 +1,209 @@
+require 'capybara/rspec'
+
+module TestAssistant::Email
+  class Expectation
+    def initialize
+      @expectations = {}
+      @failure_message = 'Expected email to be sent'
+      @and_scope = nil
+    end
+
+    MATCHERS = {
+        to: :to,
+        from: :from,
+        with_subject: :subject,
+        with_text: {
+            match: ->(_, email, value){ value.all?{|text| email.has_content?(text) }},
+            actual: ->(_, email){ email.text}
+        },
+        with_selector: {
+            match: ->(_, email, value){ value.all?{|text| email.has_selector?(text) }},
+            actual: ->(_, email){ email.native },
+            actual_name: :with_body
+        },
+        with_link: {
+            match: ->(_, email, value){ value.all?{|value| email.has_selector?("a[href='#{value}']") }},
+            actual: ->(_, email){ email.native },
+            actual_name: :with_body
+        },
+        with_image: {
+            match: ->(_, email, value){ value.all?{|value| email.has_selector?("img[src='#{value}']") }},
+            actual: ->(_, email){ email.native },
+            actual_name: :with_body
+        }
+    }
+
+    def and(*arguments)
+      if @and_scope
+        self.send(@and_scope, *arguments)
+      else
+        ArugmentError.new("Cannot use and without a proceeding assertion.")
+      end
+    end
+
+    def to(email_address)
+      if email_address.kind_of?(Array)
+        @expectations[:to] = email_address
+      else
+        @expectations[:to] ||= []
+        @expectations[:to] << email_address
+      end
+
+      @and_scope = :to
+
+      self
+    end
+
+    def from(email_address)
+      if email_address.kind_of?(Array)
+        @expectations[:from] = email_address
+      else
+        @expectations[:from] ||= []
+        @expectations[:from] << email_address
+      end
+
+      @and_scope = :from
+
+      self
+    end
+
+    def with_subject(subject)
+      if @expectations[:with_subject]
+        raise ArgumentError('An email can only have one subject, but you tried to assert the presence of 2 or more values')
+      else
+        @expectations[:with_subject] = subject
+      end
+
+      self
+    end
+
+    def with_text(text)
+      @expectations[:with_text] ||= []
+      @expectations[:with_text].push(text)
+
+      @and_scope = :with_text
+      self
+    end
+
+    def with_selector(selector)
+      @expectations[:with_selector] ||= []
+      @expectations[:with_selector].push(selector)
+
+      @and_scope = :with_selector
+      self
+    end
+
+    def with_link(href)
+      @expectations[:with_link] ||= []
+      @expectations[:with_link].push(href)
+
+      @and_scope = :with_link
+      self
+    end
+
+    def with_image(src)
+      @expectations[:with_image] ||= []
+      @expectations[:with_image].push(src)
+
+      @and_scope = :with_image
+      self
+    end
+
+    def diffable?
+      false
+    end
+
+    def matches?(emails)
+      @emails = emails
+
+      matching_emails = @emails
+
+      @expectations.each do |attribute, expected|
+
+        matching_emails =
+            matching_emails.select do |email|
+              email_matches?(email, MATCHERS[attribute], expected)
+            end
+
+        if matching_emails.empty?
+          @failed_attribute = attribute
+          @failed_expected = expected
+          return false
+        end
+      end
+
+      true
+    end
+
+    def failure_message
+      field_description = @failed_attribute.to_s.gsub('_', ' ')
+      value_description =
+          case @failed_expected
+            when String
+              "'#{@failed_expected}'"
+            when Array
+              @failed_expected.map{|val| "'#{val}'"}.to_sentence
+            else
+              @failed_expected
+          end
+
+      base_clause = "Expected an email to be sent #{field_description} #{value_description}."
+
+      if @emails.length == 0
+        base_clause + ' However, no emails were sent.'
+      else
+        pluralisation = @emails.length == 1 ? 'email' : 'emails'
+
+        email_values = @emails.inject([]) do |memo, email|
+          matcher = MATCHERS[@failed_attribute]
+
+          value =
+              case matcher
+                when String, Symbol
+                  email.send(matcher)
+                when Hash
+                  field_description = matcher[:actual_name] if matcher[:actual_name]
+                  matcher[:actual].(email, parsed_emails(email))
+              end
+
+          value = value.kind_of?(String) ? "'#{value}'" : value
+          memo << value
+
+          memo
+        end
+
+
+        if email_values.any?
+          base_clause + " However, #{pluralisation} were sent #{field_description} #{email_values.to_sentence}"
+        else
+          base_clause
+        end
+      end
+    end
+
+    private
+
+    def parsed_emails(email)
+      @parsed_emails ||= {}
+      @parsed_emails[email] ||= parser(email)
+      @parsed_emails[email]
+    end
+
+    def parser(email)
+      Capybara::Node::Simple.new(email.parts.first.body.decoded)
+    end
+
+    def email_matches?(email, assertion, expected)
+      case assertion
+        when String, Symbol
+          email.send(assertion) == expected
+        when Hash
+          assertion[:match].(email, parsed_emails(email), expected)
+        else
+          raise RuntimeError.new(
+              "Unsupported assertion mapping '#{assertion_match}' of type #{assertion_match.class.name}"
+          )
+      end
+    end
+  end
+end

data/lib/test_assistant/email/helpers.rb

@@ -0,0 +1,13 @@
+require 'test_assistant/email/expectation'
+
+module TestAssistant::Email
+  module Helpers
+    def email
+      ActionMailer::Base.deliveries
+    end
+
+    def have_been_sent
+      TestAssistant::Email::Expectation.new
+    end
+  end
+end

data/lib/test_assistant/version.rb

@@ -1,3 +1,3 @@
 module TestAssistant
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test_assistant.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rspec-rails", "~> 3.0"
+  spec.add_dependency 'capybara', '~> 2.5', '>= 2.5.0'
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_assistant
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Aleck Greenham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-30 00:00:00.000000000 Z
+date: 2016-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -24,6 +24,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +87,8 @@ files:
 - Rakefile
 - lib/test_assistant.rb
 - lib/test_assistant/configuration.rb
+- lib/test_assistant/email/expectation.rb
+- lib/test_assistant/email/helpers.rb
 - lib/test_assistant/failure_reporter.rb
 - lib/test_assistant/json_helpers.rb
 - lib/test_assistant/version.rb