shoulda_action_mailer 0.2.1

data/HISTORY.markdown

@@ -0,0 +1,4 @@
+## v0.1
+
+* Turned into a gem
+* Documented some stuff

data/LICENSE

@@ -0,0 +1,24 @@
+MIT License
+--------------------------------------------------------------------------------
+Copyright (c) 2009 Thumble Monks, Justin Knowlden
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,48 @@
+# Action Mailer Shoulda Macros (and maybe assertions, too)
+
+While Shoulda does ship with some Action Mailer assertions, it does not ship with standard macros that would help in testing Action Mailer emails. Macros such as:
+
+* should\_have\_subject
+* should\_have\_to\_recipient
+* should\_have\_to\_recipients - *notice the plurality!*
+* should\_have\_from
+* should\_have\_reply\_to
+* should\_match\_body
+* should\_have\_mime\_parts - *also with counts*
+* should\_have\_mime\_content\_type
+* should\_use\_charset
+* should\_be\_inlined_content
+* should\_be\_an\_attachment - *also with a check for filename*
+* should\_have\_filename
+
+Incidentally, those happen to be all the macros supported for now. We fully intend to have macros for everything in Action Mailer, but didn't have a need for any others yet (read: nothing forced us to write them yet). So, if you have a need for some others, please feel MORE THAN FREE to fork, add, and send a pull request so we can add them in.
+
+For documentation, just look at the only file in the lib directory for now. Or, install the gem and the rdoc with it.
+
+### Installing & Using
+
+Install as a gem:
+
+    sudo gem install thumblemonks-shoulda_action_mailer
+
+And then do this in your `test_helper.rb` (or whatever you call it for your environment):
+
+    require 'shoulda_action_mailer'
+
+Or, just tell Rails about them by doing this in your app's `test.rb`:
+
+    config.gem 'thumblemonks-shoulda_action_mailer', :lib => false, :source => 'http://gems.github.com'
+
+# Uh ... where are the tests?
+
+I feel kind of bad not having tests here, but I actually did write these macros as refactorings to tests I already had in a certain other project that shall remain nameless for the time being. So, I don't really feel compelled to add any tests here unless someone asks me or I just decide to modify this code for random reason.
+
+I hope that satisfies you.
+
+# Contact
+
+Justin Knowlden <gus@gusg.us>
+
+# License
+
+See LICENSE

data/lib/shoulda_action_mailer.rb

@@ -0,0 +1,180 @@
+module Thumblemonks #:nodoc:
+  module ActionMailer
+    # Every should_action_mailer macro assumes an instance variable named @email is defined and
+    # is an instance of a TMail object. Even the ones that work on parts.
+    #
+    # When we support Shoulda 2.10.2, we will switch to subject
+    module Shoulda
+      # Tries to match the provided subject with that of the email's. Regular
+      # expressions are valid inputs.
+      # 
+      #   should_have_subject 'Hello world'
+      # 
+      # If a block is provided, the result of calling it will
+      # be used as the expected subject.
+      # 
+      #   should_have_subject { "What's going on #{@person.name}?" }
+      def should_have_subject(subject=nil, &block)
+        should "have subject" do
+          subject = self.instance_eval(&block) if block_given?
+          assert_match subject, @email.subject
+        end
+      end
+
+      # Asserts that the provided address is one of those in the list of to recipients.
+      # 
+      #   should_have_to_recipient "foo@bar.baz"
+      # 
+      # If you provide a block, it will be used to obtain the recipient. If you need to use
+      # block approach more than once within the same context, use should_have_to_recipients
+      # instead.
+      # 
+      #   should_have_to_recipient { @person.email }
+      def should_have_to_recipient(recipient=nil, &block)
+        should "have #{recipient || 'some email address'} as a to recipient" do
+          recipient = self.instance_eval(&block) if block_given?
+          assert_contains @email.to, recipient
+        end
+      end
+
+      # Asserts that all of the to recipients match those in the provided list. 
+      # 
+      #   should_have_to_recipients ["foo@bar.baz", "ma@pa.biz"]
+      # 
+      # If you provide a block, it will be used to obtain the expected list of recipients.
+      # 
+      #   should_have_to_recipients { @network.people.map(&:email) }
+      def should_have_to_recipients(recipient_list=nil, &block)
+        handle_a_list("to recipients", :to, recipient_list, &block)
+      end
+
+      # Asserts that all of the from addresses match those in the provided list. You can provide a
+      # single email address or an array of email addresses.
+      # 
+      #   should_have_from "foo@bar.baz"
+      #   should_have_from ["foo@bar.baz", "ma@pa.biz"]
+      # 
+      # If you provide a block, it will be used to obtain the list of from addresses.
+      #
+      #   should_have_from { @person.email }
+      #   should_have_from { [@network.owner.email, @you.mom.email] }
+      def should_have_from(from_list=nil, &block)
+        handle_a_list("from", :from, from_list, &block)
+      end
+
+      # Asserts that all of the reply to addresses match those in the provided list. You can provide a
+      # single email address or an array of email addresses.
+      # 
+      #   should_have_reply_to "foo@bar.baz"
+      #   should_have_reply_to ["foo@bar.baz", "ma@pa.biz"]
+      # 
+      # If you provide a block, it will be used to obtain the list of reply to addresses.
+      #
+      #   should_have_reply_to { @person.email }
+      #   should_have_reply_to { [@network.owner.email, @you.mom.email] }
+      def should_have_reply_to(reply_to_list=nil, &block)
+        handle_a_list("reply to's", :reply_to, reply_to_list, &block)
+      end
+
+      # Asserts that the email or part body matches the value provided.
+      # 
+      #   should_match_body /Sincerely,\nYour Mom/
+      #   should_match_body %r[Dear John,]
+      #   should_match_body "this is the entire email body" # bascially like an assert_equal
+      #
+      # If you provide a block, it will be used to get the expression that will be matched
+      # against the email body. You must provide a namespace for the test in this case, so
+      # test name collisions can be avoided (because we're assuming you're going to do this
+      # more than once within a context).
+      #
+      #   should_match_body("salutation") { %r[Dear #{@person.name}] }
+      def should_match_body(matcher_or_name, &block)
+        should "match body to #{matcher_or_name}" do
+          matcher_or_name = self.instance_eval(&block) if block_given?
+          assert_match matcher_or_name, @email.body
+        end
+      end
+
+      # Asserts that the email has at least one part attached to it.
+      # 
+      #    should_have_mime_parts
+      # 
+      # If provided with option `:count`, asserts that the exact number of parts are attached.
+      # 
+      #    should_have_mime_parts :count => 2
+      def should_have_mime_parts(opts={})
+        if count_of_parts = opts[:count]
+          should "have #{count_of_parts} message part(s)" do
+            assert_equal count_of_parts, Array(@email.parts).length
+          end
+        else
+          should("have at least one message part") { assert Array(@email.parts).length > 0 }
+        end
+      end
+
+      # Asserts that the content type of the email or part matches the expectation.
+      # 
+      #     should_have_mime_content_type "text/plain"
+      #     should_have_mime_content_type "multipart/alternative" # For multi-part emails without attachments
+      #     should_have_mime_content_type "multipart/mixed"       # For multi-part emails with attachments
+      #     should_have_mime_content_type "text/csv"              # For file attachments
+      def should_have_mime_content_type(name)
+        should "have #{name} content type" do
+          @email.to_s # Not doing this means the content-type is never generated (i smell bug)
+          assert_equal name, @email["content-type"].content_type
+        end
+      end
+
+      # Asserts that the charset of the email or part matches the expectation. Expects the charset to be
+      # defined on the Content-Type header.
+      # 
+      #     should_have_mime_content_type "text/utf-8"
+      def should_use_charset(name)
+        should("use #{name} charset") { assert_equal name, @email["content-type"]["charset"] }
+      end
+
+      # Asserts that the content-disposition of the part is "inline". Meaning, the content is to be displayed
+      # in the readers viewer immediately (different than an attachment). Basically, you've put some text in
+      # the email you want the reader to see.
+      # 
+      #     should_be_inlined_content
+      def should_be_inlined_content
+        should("be inline content") { assert_equal "inline", @email["content-disposition"].disposition }
+      end
+
+      # Asserts that the content-disposition of the part is "attachment". Meaning, the reader has to do
+      # something to see the content. Whenever you use the `ActionMailer::Base#attachment` method, you'll
+      # get this disposition.
+      # 
+      #     should_be_an_attachment
+      #
+      # If you provide a filename option, this method will assert that the attachment filename matches your
+      # expectation.
+      #
+      #     should_be_an_attachment :filename => "file.pdf"
+      def should_be_an_attachment(opts={})
+        should("be an attachment") { assert_equal "attachment", @email["content-disposition"].disposition }
+        should_have_filename(opts[:filename]) if opts[:filename]
+      end
+
+      # Asserts that the attachment (most likely) has a filename attribute and that it matches the expected
+      # filename.
+      #
+      #     should_have_filename "file.pdf"
+      def should_have_filename(filename)
+        should "have filename of #{filename}" do
+          assert_equal filename, @email["content-disposition"]["filename"]
+        end
+      end
+    private
+      def handle_a_list(named, accessed_as, expected=nil, &block)
+        should "have #{named}" do
+          expected = self.instance_eval(&block) if block_given?
+          assert_same_elements Array(expected), Array(@email.send(accessed_as))
+        end
+      end
+    end # Shoulda
+  end # ActionMailer
+end # Thumblemonks
+
+ActionMailer::TestCase.extend(Thumblemonks::ActionMailer::Shoulda)

data/shoulda_action_mailer.gemspec

@@ -0,0 +1,34 @@
+Gem::Specification.new do |s|
+  s.name     = "shoulda_action_mailer"
+  s.version  = "0.2.1"
+  s.date     = "2009-08-26"
+  s.summary  = "Shoulda macros and more assertions for Action Mailer and ActionMailer::TestCase; now includes tests for parts."
+  s.email    = %w[gus@gusg.us]
+  s.homepage = "http://github.com/thumblemonks/shoulda_action_mailer"
+  s.description = "Shoulda macros and more assertions for Action Mailer and ActionMailer::TestCase; now includes tests for parts."
+  s.authors  = %w[Justin\ Knowlden]
+  s.post_install_message = %q{Choosy mailpersons choose Thumble Monks.}
+
+  s.rubyforge_project = %q{load_model}
+
+  s.has_rdoc = true
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Load Model", "--main", "README.markdown"]
+  s.extra_rdoc_files = ["HISTORY.markdown", "README.markdown"]
+  
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to?(:required_rubygems_version=)
+  s.rubygems_version = "1.3.1"
+  s.require_paths = ["lib"]
+
+  # run git ls-files to get an updated list
+  s.files = %w[
+    HISTORY.markdown
+    LICENSE
+    README.markdown
+    lib/shoulda_action_mailer.rb
+    shoulda_action_mailer.gemspec  ]
+  
+  s.test_files = %w[
+  ]
+
+  s.post_install_message = %q{Choosy free loaders choose Thumble Monks}
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: shoulda_action_mailer
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Justin Knowlden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-26 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Shoulda macros and more assertions for Action Mailer and ActionMailer::TestCase; now includes tests for parts.
+email: 
+- gus@gusg.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- HISTORY.markdown
+- README.markdown
+files: 
+- HISTORY.markdown
+- LICENSE
+- README.markdown
+- lib/shoulda_action_mailer.rb
+- shoulda_action_mailer.gemspec
+has_rdoc: true
+homepage: http://github.com/thumblemonks/shoulda_action_mailer
+licenses: []
+
+post_install_message: Choosy free loaders choose Thumble Monks
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Load Model
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: load_model
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Shoulda macros and more assertions for Action Mailer and ActionMailer::TestCase; now includes tests for parts.
+test_files: []
+