idlemailer 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 026e7c3207e3a4d68ad8788514da4df57fb38c7c
-  data.tar.gz: 1ba8967dd1cea7dbb1615083c542dc75371220c5
+  metadata.gz: cc834e63c8ea6672e0994a01d0443523dafd5f27
+  data.tar.gz: 756db93875c86f865d330f1eee5c6a1a1724f337
 SHA512:
-  metadata.gz: 33eabc8cf62e1a2854b56d330150b2e7f5525ea04640e03455eecc256140af4dfa999f30b714e171875db1a2fc2bc7c350da0869445b455389e4e118817356d6
-  data.tar.gz: '0294ef2f3f64dce15c02c787f0b1fb0234ca7c902c85a1f5162d4236c2ccf59f1dca1bdce1c96f7b2900c610d04bc4f9d33e2513221c066f33ddf164bdf1b15e'
+  metadata.gz: 4726efb741bd15359ec79c3ae8825f05cfcf6cb5a0b3abac25e1bb05a78186725688479f1bc4d18ffb5d7f9a46dc9e90729e7718ca776ea1409788c44548e174
+  data.tar.gz: 89679a1c6df53140a4e7e21011c8dd9d20cddab9ea641addfd21d92434b83e9d0c89faa6270e07324ca81c6dc240a4d199564c75d54e46ecd7ef7709fc9e5be7

data/README.md

@@ -1,15 +1,16 @@
 # IdleMailer
 
-A lightweight (~150 line) alternative to ActionMailer for hipsters who use Ruby but not Rails. Powered by [mail](http://www.rubydoc.info/gems/mail). Great for API-only backends that need to send email.
+A lightweight (~150 line) alternative to ActionMailer for Rubyists who are too cool for Rails. Powered by the [mail](http://www.rubydoc.info/gems/mail) gem. Great for API-only backends that need to send email.
 
 ## Installation
 
-    $ [sudo] gem install idlemailer
-    # Or add "idlemailer" to your Gemfile
+Add to your Gemfile.
+
+    gem 'idlemailer'
 
 ## Use
 
-IdleMailer is all about providing mailer classes and templates. But [the mail gem](http://www.rubydoc.info/gems/mail) has a great API, so you have unfettered access to it in your mailers through the "mail" object.
+IdleMailer provides mailer classes and templates on top of the [mail](http://www.rubydoc.info/gems/mail) gem. `mail` has a great API, so you have unfettered access to it in your mailers.
 
 ```ruby
 # Define your mailer class
@@ -17,18 +18,17 @@ class WidgetMailer
   include IdleMailer::Mailer
 
   def initialize(user, widget)
+    @widget = widget
     mail.to = user.email
     mail.subject = "Widget #{widget.sku}"
-    @widget = widget
   end
 end
 
-# Create widget.html.erb and/or widget.text.erb templates.
+# Create widget.html.erb and/or widget.text.erb in your templates directory.
 # They'll have access to instance variables like @widget above.
 
 # Send your mail
-mailer = WidgetMailer.new(current_user, widget)
-mailer.deliver
+WidgetMailer.new(current_user, widget).deliver
 ```
 
 ### Inline templates
@@ -40,9 +40,9 @@ class WidgetMailer
   include IdleMailer::Mailer
 
   def initialize(user, widget)
+    @widget = widget
     mail.to = user.email
     mail.subject = "Widget #{widget.sku}"
-    @widget = widget
   end
 
   text %(
@@ -104,7 +104,7 @@ end
 
 ## Testing
 
-Put the mailer in testing mode:
+Put the mailer into testing mode:
 
 ```ruby
 IdleMailer.config do |config|
@@ -112,10 +112,44 @@ IdleMailer.config do |config|
 end
 ```
 
-Then use mail gem's built in testing helpers in your specs:
+Then configure your test runner. Here's an example with RSpec:
+
+```ruby
+RSpec.configure do |config|
+  # Clear sent mail after every test
+  config.after :each do
+    IdleMailer::Testing.clear_mail!
+  end
+
+  # Include the test helpers in your specs
+  config.include IdleMailer::Testing::Helpers
+end
+```
+
+Your tests will have access to these helper methods. (Note you can also call them directly on `IdleMailer::Testing` as well)
 
 ```ruby
-sent = Mail::TestMailer.deliveries.any? { |mail| mail.to.include? @user.email }
+# quick boolean checks
+sent_mail_to? 'user@example.com'
+sent_mail_to? 'user@example.com', /subject/
+sent_mail_to? 'user@example.com', /subject/, /body/
+sent_mail_with_subject? /Foo/
+sent_mail_with_body? /Bar/
+sent_mail_from? 'user@example.com'
+
+# get arrays of matching sent mail (Mail::Message objects)
+mail_to 'user@example.com'
+mail_to 'user@example.com', /subject/
+mail_to 'user@example.com', /subject/, /body/
+mail_with_subject /Foo/
+mail_with_body /Bar/
+mail_from 'user@example.com'
+
+# get an array of all sent mail
+sent_mail
+
+# clear all sent mail
+clear_mail!
 ```
 
 ## License

data/lib/idlemailer/template_manager.rb

@@ -1,4 +1,5 @@
 module IdleMailer
+  # Loads a mailer's templates and layouts
   module TemplateManager
     def self.extended(klass)
       klass.class_eval do
@@ -11,19 +12,19 @@ module IdleMailer
     end
 
     def text(str)
-      templates['text'] = ERB.new str
+      templates['text'] = ERB.new str.chomp
     end
 
     def html(str)
-      templates['html'] = ERB.new str
+      templates['html'] = ERB.new str.chomp
     end
 
     def template(type)
-      templates[type] || ERB.new(template_path(template_name, type).read)
+      templates[type] || ERB.new(template_path(template_name, type).read.chomp)
     end
 
     def layout(type)
-      layouts[type] || ERB.new(template_path(IdleMailer.config.layout, type).read)
+      layouts[type] || ERB.new(template_path(IdleMailer.config.layout, type).read.chomp)
     end
 
     def has_template?(type)

data/lib/idlemailer/testing.rb

@@ -0,0 +1,60 @@
+module IdleMailer
+  # Module for testing. You can call all IdleMailer::Testing::Helpers methods directly on this module if you want.
+  module Testing
+    # Helpers for your tests
+    module Helpers
+      # Returns true if any mail was sent from the given email address.
+      def sent_mail_from?(addr)
+        mail_from(addr).any?
+      end
+
+      # Returns true if any mail was sent to the given email address. You may pass subject and body patterns to get more specific (String or Regexp).
+      def sent_mail_to?(addr, subject = nil, body = nil)
+        mail_to(addr, subject, body).any?
+      end
+
+      # Returns true if any mail was sent matching the given subject (String or Regexp).
+      def sent_mail_with_subject?(pattern)
+        mail_with_subject(pattern).any?
+      end
+
+      # Returns true if any mail was sent matching the given body (Regexp).
+      def sent_mail_with_body?(pattern)
+        mail_with_body(pattern).any?
+      end
+
+      # Returns all mail sent from the given email address.
+      def mail_from(addr)
+        sent_mail.select { |m| m.from.include? addr }
+      end
+
+      # Returns all mail sent to the given email address. You may pass subject and body patterns to get more specific (String or Regexp).
+      def mail_to(addr, subject = nil, body = nil)
+        sent_mail.select { |m|
+          m.to.include?(addr) && (subject.nil? || subject === m.subject) && (body.nil? || body === m.to_s)
+        }
+      end
+
+      # Returns all mail sent matching the given subject (String or Regexp).
+      def mail_with_subject(pattern)
+        sent_mail.select { |m| pattern === m.subject }
+      end
+
+      # Returns all mail sent matching the given body (Regexp).
+      def mail_with_body(pattern)
+        sent_mail.select { |m| pattern === m.to_s }
+      end
+
+      # Returns all sent mail.
+      def sent_mail
+        Mail::TestMailer.deliveries
+      end
+
+      # Clears sent mail.
+      def clear_mail!
+        Mail::TestMailer.deliveries.clear
+      end
+    end
+    extend Helpers
+  end
+end

data/lib/idlemailer/version.rb

@@ -1,5 +1,5 @@
 # IdleMailer module
 module IdleMailer
   # Version number
-  VERSION = '2.0.0.rc1'
+  VERSION = '2.0.0'
 end

data/lib/idlemailer.rb

@@ -1,9 +1,14 @@
 require 'erb'
 require 'pathname'
 require 'mail'
+
 require 'idlemailer/config'
 require 'idlemailer/defaults'
 require 'idlemailer/message'
 require 'idlemailer/mailer'
 require 'idlemailer/template_manager'
 require 'idlemailer/version'
+
+module IdleMailer
+  autoload :Testing, 'idlemailer/testing'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idlemailer
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-28 00:00:00.000000000 Z
+date: 2017-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -39,6 +39,7 @@ files:
 - lib/idlemailer/mailer.rb
 - lib/idlemailer/message.rb
 - lib/idlemailer/template_manager.rb
+- lib/idlemailer/testing.rb
 - lib/idlemailer/version.rb
 homepage: https://github.com/jhollinger/idlemailer
 licenses: []
@@ -51,12 +52,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.2