radiant-mailer-extension 1.0.2 → 1.0.3

data/features/fixtures/attachment.txt

@@ -0,0 +1 @@
+this is the attached file

data/features/mailer.feature

@@ -0,0 +1,23 @@
+Feature: Radiant Mailer Extension
+  In order to have email sending capabilities
+  As an user
+  I want to send and receive email
+
+  Scenario: Sending email
+    Given I go to the contact page
+     When I fill in "name" with "Cristi"
+      And I fill in "email" with "cristi.duma@aissac.ro"
+      And I fill in "message" with "Have you heard?"
+      And I fill in "attached_file" with the attachment
+      And I press "Send"
+     Then I should be on the thank you page
+
+  Scenario: Receiving email
+    Given the above email has been sent
+     Then "example@aissac.ro" should receive 1 email
+     When I open the email
+      And I should see "From the website of Whatever" in the subject
+      And I should see "Name: Cristi" in the email
+      And I should see "Email: cristi.duma@aissac.ro" in the email
+      And I should see "Message: Have you heard?" in the email
+      And I should have an attachment

data/features/step_definitions/email_steps.rb

@@ -0,0 +1,73 @@
+#Commonly used email steps
+#
+# To add your own steps make a custom_email_steps.rb
+# The provided methods are:
+#
+# reset_mailer 
+# open_last_email
+# visit_in_email
+# unread_emails_for
+# mailbox_for
+# current_email
+# open_email
+# read_emails_for
+# find_email
+
+module EmailHelpers
+  def current_email_address
+    "example@aissac.ro" # Replace with your a way to find your current_email. e.g current_user.email
+  end
+end
+World(EmailHelpers)
+
+# Use this step to reset the e-mail queue within a scenario.
+# This is done automatically before each scenario.
+Given /^(?:a clear email queue|no emails have been sent)$/ do
+  reset_mailer
+end
+
+# Use this step to open the most recently sent e-mail. 
+When /^I open the email$/ do
+  open_email(current_email_address)
+end
+
+When %r{^I follow "([^"]*?)" in the email$} do |link|
+  visit_in_email(link)
+end
+
+Then /^I should receive (an|\d+) emails?$/ do |amount|
+  amount = 1 if amount == "an"
+  unread_emails_for(current_email_address).size.should == amount.to_i
+end
+
+Then %r{^"([^"]*?)" should receive (\d+) emails?$} do |address, n|
+  unread_emails_for(address).size.should == n.to_i 
+end
+
+Then %r{^"([^"]*?)" should have (\d+) emails?$} do |address, n|
+  mailbox_for(address).size.should == n.to_i
+end
+
+Then %r{^"([^"]*?)" should not receive an email$} do |address|
+  find_email(address).should be_nil
+end
+
+Then %r{^I should see "([^"]*?)" in the subject$} do |text|
+  current_email.should have_subject(Regexp.new(text))
+end
+
+Then %r{^I should see "([^"]*?)" in the email$} do |text|
+  current_email.body.should =~ Regexp.new(text)
+end
+
+When %r{^"([^"]*?)" opens? the email with subject "([^"]*?)"$} do |address, subject|
+  open_email(address, :with_subject => subject)
+end
+
+When %r{^"([^"]*?)" opens? the email with text "([^"]*?)"$} do |address, text|
+  open_email(address, :with_text => text)
+end
+
+When /^I click the first link in the email$/ do
+  click_first_link_in_email
+end

data/features/step_definitions/mailer_steps.rb

@@ -0,0 +1,16 @@
+Given /^the above email has been sent$/ do
+  Given "I go to the contact page"
+   When "I fill in \"name\" with \"Cristi\""
+   When "I fill in \"email\" with \"cristi.duma@aissac.ro\""
+   When "I fill in \"message\" with \"Have you heard?\""
+   When "I fill in \"attached_file\" with the attachment"
+   When "I press \"Send\""
+end
+
+When /^I fill in "([^\"]*)" with the attachment$/ do |field|
+  fill_in(field, :with => RAILS_ROOT + "/vendor/extensions/mailer/features/fixtures/attachment.txt") 
+end
+
+Then /^I should have an attachment$/ do
+  current_email.attachments.size.should == 1
+end

data/features/step_definitions/webrat_steps.rb

@@ -0,0 +1,107 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+
+# Commonly used webrat steps
+# http://github.com/brynary/webrat
+
+Given /^I am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^I go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^I press "([^\"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^I follow "([^\"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^I fill in "([^\"]*)" with "([^\"]*)"$/ do |field, value|
+  fill_in(field, :with => value) 
+end
+
+When /^I select "([^\"]*)" from "([^\"]*)"$/ do |value, field|
+  select(value, :from => field) 
+end
+
+# Use this step in conjunction with Rail's datetime_select helper. For example:
+# When I select "December 25, 2008 10:00" as the date and time 
+When /^I select "([^\"]*)" as the date and time$/ do |time|
+  select_datetime(time)
+end
+
+# Use this step when using multiple datetime_select helpers on a page or 
+# you want to specify which datetime to select. Given the following view:
+#   <%= f.label :preferred %><br />
+#   <%= f.datetime_select :preferred %>
+#   <%= f.label :alternative %><br />
+#   <%= f.datetime_select :alternative %>
+# The following steps would fill out the form:
+# When I select "November 23, 2004 11:20" as the "Preferred" data and time
+# And I select "November 25, 2004 10:30" as the "Alternative" data and time
+When /^I select "([^\"]*)" as the "([^\"]*)" date and time$/ do |datetime, datetime_label|
+  select_datetime(datetime, :from => datetime_label)
+end
+
+# Use this step in conjunction with Rail's time_select helper. For example:
+# When I select "2:20PM" as the time
+# Note: Rail's default time helper provides 24-hour time-- not 12 hour time. Webrat
+# will convert the 2:20PM to 14:20 and then select it. 
+When /^I select "([^\"]*)" as the time$/ do |time|
+  select_time(time)
+end
+
+# Use this step when using multiple time_select helpers on a page or you want to
+# specify the name of the time on the form.  For example:
+# When I select "7:30AM" as the "Gym" time
+When /^I select "([^\"]*)" as the "([^\"]*)" time$/ do |time, time_label|
+  select_time(time, :from => time_label)
+end
+
+# Use this step in conjunction with Rail's date_select helper.  For example:
+# When I select "February 20, 1981" as the date
+When /^I select "([^\"]*)" as the date$/ do |date|
+  select_date(date)
+end
+
+# Use this step when using multiple date_select helpers on one page or
+# you want to specify the name of the date on the form. For example:
+# When I select "April 26, 1982" as the "Date of Birth" date
+When /^I select "([^\"]*)" as the "([^\"]*)" date$/ do |date, date_label|
+  select_date(date, :from => date_label)
+end
+
+When /^I check "([^\"]*)"$/ do |field|
+  check(field) 
+end
+
+When /^I uncheck "([^\"]*)"$/ do |field|
+  uncheck(field) 
+end
+
+When /^I choose "([^\"]*)"$/ do |field|
+  choose(field)
+end
+
+When /^I attach the file at "([^\"]*)" to "([^\"]*)"$/ do |path, field|
+  attach_file(field, path)
+end
+
+Then /^I should see "([^\"]*)"$/ do |text|
+  response.should contain(text)
+end
+
+Then /^I should not see "([^\"]*)"$/ do |text|
+  response.should_not contain(text)
+end
+
+Then /^the "([^\"]*)" checkbox should be checked$/ do |label|
+  field_labeled(label).should be_checked
+end
+
+Then /^I should be on (.+)$/ do |page_name|
+  URI.parse(current_url).path.should == path_to(page_name)
+end

data/features/support/env.rb

@@ -0,0 +1,28 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+ 
+require 'cucumber/rails/world'
+require 'cucumber/formatter/unicode' # Comment out this line if you don't want Cucumber Unicode support
+
+require 'webrat'
+ 
+Webrat.configure do |config|
+  config.mode = :rails
+end
+
+require 'spec'
+require 'email_spec/cucumber'
+
+# Comment out the next two lines if you're not using RSpec's matchers (should / should_not) in your steps.
+require 'cucumber/rails/rspec'
+require 'webrat/core/matchers'
+ 
+Cucumber::Rails::World.class_eval do
+  include Dataset
+  datasets_directory "#{RADIANT_ROOT}/spec/datasets"
+  Dataset::Resolver.default = Dataset::DirectoryResolver.new("#{RADIANT_ROOT}/spec/datasets", File.dirname(__FILE__) + '/../datasets')
+  self.datasets_database_dump_path = "#{Rails.root}/tmp/dataset"
+  
+  dataset :pages, :users, :mailer_page
+end

data/features/support/paths.rb

@@ -0,0 +1,21 @@
+module NavigationHelpers
+  def path_to(page_name)
+    case page_name
+    
+    when /the welcome page/
+      admin_path
+    when /the contact page/
+      '/contact'
+    when /the thank you page/
+      '/contact/thank-you'
+    
+    # Add more page name => path mappings here
+    
+    else
+      raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+        "Now, go and add a mapping in features/support/paths.rb"
+    end
+  end
+end
+
+World(NavigationHelpers)

data/lib/mailer_process.rb

@@ -13,6 +13,7 @@ module MailerProcess
 
       mail = Mail.new(part_page, config, request.parameters[:mailer])
       self.last_mail = part_page.last_mail = mail
+      process_mail(mail, config)
 
       if mail.send
         response.redirect(config[:redirect_to], "302 Found") and return if config[:redirect_to]
@@ -25,6 +26,11 @@ module MailerProcess
   end
 
   private
+  
+    # Hook here to do additional things, like check a CAPTCHA
+    def process_mail(mail, config)
+    end
+    
     def mailer_config_and_page
       page = self
       until page.part(:mailer) or (not page.parent)

data/lib/mailer_tags.rb

@@ -1,10 +1,11 @@
 module MailerTags
   include Radiant::Taggable
   include ActionView::Helpers::DateHelper
+  include ActionView::Helpers::TagHelper
 
-  def config
-    @config ||= begin
-      page = self
+  def mailer_config(mailer_page=self)
+    @mailer_config ||= begin
+      page = mailer_page
       until page.part(:mailer) or (not page.parent)
         page = page.parent
       end
@@ -15,10 +16,10 @@ module MailerTags
 
   desc %{ All mailer-related tags live inside this one. }
   tag "mailer" do |tag|
-    if Mail.valid_config?(config)
+    if Mail.valid_config?(mailer_config(tag.locals.page))
       tag.expand
     else
-      "Mailer config is not valid (see Mailer.valid_config?)"
+      "Mailer config is invalid: #{Mail.config_error_messages(mailer_config)}"
     end
   end
 
@@ -37,6 +38,7 @@ module MailerTags
         end
       else
         unless mail.valid?
+          tag.locals.error_messages = mail.errors
           tag.expand
         end
       end
@@ -64,6 +66,13 @@ module MailerTags
 
   desc %{Outputs the error message.}
   tag "mailer:if_error:message" do |tag|
+    if tag.locals.error_messages
+      result = []
+      tag.locals.error_messages.each do |on, err|
+        result << content_tag(:li, "#{on} #{err}")
+      end
+      return content_tag(:ul, result)
+    end
     tag.locals.error_message
   end
 
@@ -76,9 +85,20 @@ module MailerTags
     tag.attr['id'] ||= 'mailer'
     results = []
     action = Radiant::Config['mailer.post_to_page?'] ? tag.locals.page.url : "/pages/#{tag.locals.page.id}/mail##{tag.attr['id']}"
-    results << %(<form action="#{action}" method="post" #{mailer_attrs(tag)}>)
+    results << %(<form action="#{action}" method="post" enctype="multipart/form-data" #{mailer_attrs(tag)}>)
     results <<   tag.expand
     results << %(</form>)
+    results << %(
+<script type="text/javascript">
+  function showSubmitPlaceholder()
+  {
+    var submitplaceholder = document.getElementById("submit-placeholder-part");
+    if (submitplaceholder != null)
+    {
+      submitplaceholder.style.display="";
+    }
+  }
+</script>)
   end
 
   desc %{
@@ -94,10 +114,36 @@ module MailerTags
     tag "mailer:#{type}" do |tag|
       raise_error_if_name_missing "mailer:#{type}", tag.attr
       value = (prior_value(tag) || tag.attr['value'])
-      result = [%(<input type="#{type}" value="#{value}" #{mailer_attrs(tag)}>)]
+      result = [%(<input type="#{type}" value="#{value}" #{mailer_attrs(tag)} />)]
       add_required(result, tag)
     end
   end
+  
+  desc %{
+    Renders a submit input tag for a mailer form. Specify a 'src' to
+    render as an image submit input tag.}
+  tag "mailer:submit" do |tag|
+    value = tag.attr['value'] || tag.attr['name']
+    tag.attr.merge!("name" => "mailer-form-button")
+    src = tag.attr['src'] || nil
+    if src
+      result = [%(<input onclick="showSubmitPlaceholder();" type="image" src="#{src}" value="#{value}" #{mailer_attrs(tag)} />)]
+    else
+      result = [%(<input onclick="showSubmitPlaceholder();" type="submit" value="#{value}" #{mailer_attrs(tag)} />)]
+    end
+  end
+
+  desc %{
+    Renders a hidden div containing the contents of the submit_placeholder page part. The
+    div will be shown when a user submits a mailer form.
+  }
+  tag "mailer:submit_placeholder" do |tag|
+    if part(:submit_placeholder)
+      results = %Q(<div id="submit-placeholder-part" style="display:none">)
+      results << render_part(:submit_placeholder)
+      results << %Q(</div>)
+    end
+  end
 
   desc %{
     Renders a @<select>...</select>@ tag for a mailer form.  The 'name' attribute is required.
@@ -145,9 +191,9 @@ module MailerTags
     selected = prev_value ? prev_value == value : checked
 
     if tag.locals.parent_tag_type == 'select'
-      %(<option value="#{value}"#{%( selected="selected") if selected} #{mailer_attrs(tag)}>#{tag.expand}</option>)
+      %(<option value="#{value}"#{%( selected="selected") if selected} #{mailer_attrs(tag)}>#{value}</option>)
     elsif tag.locals.parent_tag_type == 'radiogroup'
-      %(<input type="radio" value="#{value}"#{%( checked="checked") if selected} #{mailer_attrs(tag)}>)
+      %(<input type="radio" value="#{value}"#{%( checked="checked") if selected} #{mailer_attrs(tag, "id" => tag.attr['name'] + value)} />)
     end
   end
   
@@ -217,6 +263,7 @@ module MailerTags
     When used within mailer:get_each it defaults to getting elements within 
     that array. 
   }
+  
   tag 'mailer:get' do |tag|
     name = tag.attr['name']
     mail = tag.locals.page.last_mail
@@ -226,12 +273,18 @@ module MailerTags
       element = tag.locals.page.last_mail.data
     end
     if name
-      format_mailer_data(element, name)
+      if mail.data[name].is_a?(Array)
+        mail.data[name].map{ |d| d.respond_to?(:original_filename) ? d.original_filename : d.to_s }.to_sentence
+      elsif mail.data[name].respond_to?(:original_filename)
+        mail.data[name].original_filename
+      else
+        format_mailer_data(element, name)
+      end
     else
       element.to_hash.to_yaml.to_s
     end
   end
-    
+
   desc %{
     For use within a mailer:get_each to output the index/key for each element 
     of the hash. 
@@ -251,7 +304,7 @@ module MailerTags
     mail = tag.locals.page.last_mail || tag.globals.page.last_mail
     tag.expand if name && mail.data[name] && (eq.blank? || eq == mail.data[name])
   end
-  
+
   def format_mailer_data(element, name)
     data = element[name]
     if Array === data
@@ -276,7 +329,8 @@ module MailerTags
 
   def prior_value(tag, tag_name=tag.attr['name'])
     if mail = tag.locals.page.last_mail
-      mail.data[tag_name]
+      h(mail.data[tag_name]) unless StringIO === mail.data[tag_name] or
+        Tempfile === mail.data[tag_name]
     else
       nil
     end
@@ -312,6 +366,9 @@ module MailerTags
       'width' => nil}.merge(extras)
     result = attrs.collect do |k,v|
       v = (tag.attr[k] || v)
+      if k == 'class' && tag.attr['required'].present?
+        v = [v, 'required', tag.attr['required']].compact.join(' ')
+      end
       next if v.blank?
       %(#{k}="#{v}")
     end.reject{|e| e.blank?}
@@ -320,7 +377,7 @@ module MailerTags
   end
 
   def add_required(result, tag)
-    result << %(<input type="hidden" name="mailer[required][#{tag.attr['name']}]" value="#{tag.attr['required']}">) if tag.attr['required']
+    result << %(<input type="hidden" name="mailer[required][#{tag.attr['name']}]" value="#{tag.attr['required']}" />) if tag.attr['required']
     result
   end