radiant-mailer-extension 1.0.0

data/lib/mailer_tags.rb

@@ -0,0 +1,331 @@
+module MailerTags
+  include Radiant::Taggable
+  include ActionView::Helpers::DateHelper
+
+  def config
+    @config ||= begin
+      page = self
+      until page.part(:mailer) or (not page.parent)
+        page = page.parent
+      end
+      string = page.render_part(:mailer)
+      (string.empty? ? {} : YAML::load(string))
+    end
+  end
+
+  desc %{ All mailer-related tags live inside this one. }
+  tag "mailer" do |tag|
+    if Mail.valid_config?(config)
+      tag.expand
+    else
+      "Mailer config is not valid (see Mailer.valid_config?)"
+    end
+  end
+
+  desc %{
+    Will expand if and only if there is an error with the last mail.
+
+    If you specify the "on" attribute, it will only expand if there
+    is an error on the named attribute, and will make the error
+    message available to the mailer:error:message tag.}
+  tag "mailer:if_error" do |tag|
+    if mail = tag.locals.page.last_mail
+      if on = tag.attr['on']
+        if error = mail.errors[on]
+          tag.locals.error_message = error
+          tag.expand
+        end
+      else
+        unless mail.valid?
+          tag.expand
+        end
+      end
+    end
+  end
+
+  desc %{
+    Will expand if and only if there is NO error with the last mail.
+
+    If you specify the "on" attribute, it will only expand if there
+    is NO error on the named attribute.}
+  tag "mailer:unless_error" do |tag|
+    if mail = tag.locals.page.last_mail
+      if on = tag.attr['on']
+        unless mail.errors[on]
+          tag.expand
+        end
+      else
+        if mail.valid?
+          tag.expand
+        end
+      end
+    end
+  end
+
+  desc %{Outputs the error message.}
+  tag "mailer:if_error:message" do |tag|
+    tag.locals.error_message
+  end
+
+  desc %{
+    Generates a form for submitting email.
+
+    Usage:
+    <pre><code>  <r:mailer:form>...</r:mailer:form></code></pre>}
+  tag "mailer:form" do |tag|
+    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 <<   tag.expand
+    results << %(</form>)
+  end
+
+  desc %{
+    Outputs a bit of javascript that will cause the enclosed content
+    to be displayed when mail is successfully sent.}
+  tag "mailer:if_success" do |tag|
+    tag.expand if tag.locals.page.last_mail && tag.locals.page.last_mail.sent?
+  end
+
+  %w(checkbox date datetime datetime-local email hidden month number radio range tel text time url week).each do |type|
+    desc %{
+      Renders a #{type} input tag for a mailer form. The 'name' attribute is required.}
+    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)}>)]
+      add_required(result, tag)
+    end
+  end
+
+  desc %{
+    Renders a @<select>...</select>@ tag for a mailer form.  The 'name' attribute is required.
+    @<r:option />@ tags may be nested inside the tag to automatically generate options.}
+  tag 'mailer:select' do |tag|
+    raise_error_if_name_missing "mailer:select", tag.attr
+    tag.locals.parent_tag_name = tag.attr['name']
+    tag.locals.parent_tag_type = 'select'
+    result = [%Q(<select #{mailer_attrs(tag, 'size' => '1')}>)]
+    result << tag.expand
+    result << "</select>"
+    add_required(result, tag)
+  end
+
+  desc %{
+    Renders a <textarea>...</textarea> tag for a mailer form. The 'name' attribute is required. }
+  tag 'mailer:textarea' do |tag|
+    raise_error_if_name_missing "mailer:textarea", tag.attr
+    result =  [%(<textarea #{mailer_attrs(tag, 'rows' => '5', 'cols' => '35')}>)]
+    result << (prior_value(tag) || tag.expand)
+    result << "</textarea>"
+    add_required(result, tag)
+  end
+
+  desc %{
+    Renders a series of @<input type="radio" .../>@ tags for a mailer form.  The 'name' attribute is required.
+    Nested @<r:option />@ tags will generate individual radio buttons with corresponding values. }
+  tag 'mailer:radiogroup' do |tag|
+    raise_error_if_name_missing "mailer:radiogroup", tag.attr
+    tag.locals.parent_tag_name = tag.attr['name']
+    tag.locals.parent_tag_type = 'radiogroup'
+    tag.expand
+  end
+
+  desc %{ Renders an @<option/>@ tag if the parent is a
+    @<r:mailer:select>...</r:mailer:select>@ tag, an @<input type="radio"/>@ tag if
+    the parent is a @<r:mailer:radiogroup>...</r:mailer:radiogroup>@ }
+  tag 'mailer:option' do |tag|
+    if tag.locals.parent_tag_type == 'radiogroup'
+      tag.attr['name'] ||= tag.locals.parent_tag_name
+    end
+    value = (tag.attr['value'] || tag.expand)
+    prev_value = prior_value(tag, tag.locals.parent_tag_name)
+    checked = tag.attr.delete('selected') || tag.attr.delete('checked')
+    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>)
+    elsif tag.locals.parent_tag_type == 'radiogroup'
+      %(<input type="radio" value="#{value}"#{%( checked="checked") if selected} #{mailer_attrs(tag)}>)
+    end
+  end
+  
+  desc %{
+    Provides a mechanism to iterate over array datum submitted via a 
+    mailer form. Used in the 'email', 'email_html', and 'mailer' parts to 
+    generate the resulting email. May work OK nested, but this hasn't been 
+    tested.
+  }
+  tag 'mailer:get_each' do |tag|
+    name = tag.attr['name']
+    mail = tag.locals.page.last_mail
+    if tag.locals.mailer_element then
+      ary=tag.locals.mailer_element
+    else
+      ary=mail.data[name]
+    end
+    result=[]
+    return '' if ary.blank?
+
+    case ary
+      when Array
+        ary.each_with_index do |element, idx|
+          tag.locals.mailer_key=idx
+          tag.locals.mailer_element = element
+          result << tag.expand
+        end
+      else
+        ary.each do |key, element|
+          tag.locals.mailer_key=key
+          tag.locals.mailer_element = element
+          result << tag.expand
+        end
+    end
+    result
+  end
+  
+  desc %{ 
+    Uses @ActionView::Helpers::DateHelper.date_select@ to render three select tags for date selection. 
+  }
+  tag 'mailer:date_select' do |tag|
+    raise_error_if_name_missing "mailer:date_select", tag.attr
+    name = tag.attr.delete('name')
+    
+    options = {}
+    
+    tag.attr.each do |k, v|
+      if v =~ /(true|false)/
+        options[k] = (v == 'true')
+      elsif v =~ /\d+/
+        options[k] = v.to_i
+      elsif k == 'order'
+        options[k] = v.split(',').map(&:strip).map(&:to_sym)
+      else
+        options[k] = v
+      end
+    end
+    
+    options.symbolize_keys!
+    
+    date_select('mailer', name, options)
+  end
+
+  desc %{
+    Renders the value of a datum submitted via a mailer form.  Used in the 
+    'email', 'email_html', and 'mailer' parts to generate the resulting email.
+    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
+    if tag.locals.mailer_element then
+      element = tag.locals.mailer_element
+    else
+      element = tag.locals.page.last_mail.data
+    end
+    if name
+      format_mailer_data(element, name)
+    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. 
+  }
+  tag 'mailer:index' do |tag|
+    tag.locals.mailer_key || nil
+  end
+
+  desc %{
+    Renders the contained block if a named datum was submitted via a mailer 
+    form.  Used in the 'email', 'email_html' and 'mailer' parts to generate 
+    the resulting email.
+  }
+  tag 'mailer:if_value' do |tag|
+    name = tag.attr['name']
+    eq = tag.attr['equals']
+    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
+      data.to_sentence
+    elsif date = detect_date(element, name)
+      date
+    else
+      data
+    end
+  end
+  
+  def detect_date(mail, name)
+    date_components = mail.select { |key, value| key =~ Regexp.new("#{name}\\(\\di\\)") }
+    
+    if date_components.length == 3
+      date_values = date_components.sort { |a, b| a[0] <=> b[0] }.map { |v| v[1].to_i }
+      return Date.new(*date_values)
+    else
+      return nil
+    end
+  end
+
+  def prior_value(tag, tag_name=tag.attr['name'])
+    if mail = tag.locals.page.last_mail
+      mail.data[tag_name]
+    else
+      nil
+    end
+  end
+
+  def mailer_attrs(tag, extras={})
+    attrs = {
+      'accept' => nil,
+      'accesskey' => nil,
+      'alt' => nil,
+      'autocomplete' => nil,
+      'autofocus' => nil,
+      'checked' => nil,
+      'class' => nil,
+      'contextmenu' => nil,
+      'dir' => nil,
+      'disabled' => nil,
+      'height' => nil,
+      'hidden' => nil,
+      'id' => tag.attr['name'],
+      'lang' => nil,
+      'max' => nil,
+      'maxlength' => nil,
+      'min' => nil,
+      'pattern' => nil,
+      'placeholder' => nil,
+      'required' => nil,
+      'size' => nil,
+      'spellcheck' => nil,
+      'step' => nil,
+      'style' => nil,
+      'tabindex' => nil,
+      'title' => nil,
+      'width' => nil}.merge(extras)
+    result = attrs.collect do |k,v|
+      v = (tag.attr[k] || v)
+      next if v.blank?
+      %(#{k}="#{v}")
+    end.reject{|e| e.blank?}
+    result << %(name="mailer[#{tag.attr['name']}]") unless tag.attr['name'].blank?
+    result.join(' ')
+  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
+  end
+
+  def raise_error_if_name_missing(tag_name, tag_attr)
+    raise "`#{tag_name}' tag requires a `name' attribute" if tag_attr['name'].blank?
+  end
+end

data/lib/tasks/mailer_extension_tasks.rake

@@ -0,0 +1,16 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :mailer do
+      
+      desc "Runs the migration of the Mailer extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          MailerExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          MailerExtension.migrator.migrate
+        end
+      end
+    end
+  end
+end

data/mailer_extension.rb

@@ -0,0 +1,16 @@
+class MailerExtension < Radiant::Extension
+  version "1.0"
+  description "Provides support for email forms and generic mailing functionality."
+  url "http://github.com/radiant/radiant-mailer-extension"
+
+  define_routes do |map|
+    map.resources :mail, :path_prefix => "/pages/:page_id", :controller => "mail"
+  end
+
+  def activate
+    Page.class_eval do
+      include MailerTags
+      include MailerProcess
+    end
+  end
+end

data/radiant-mailer-extension.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{radiant-mailer-extension}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathaniel Talbott", "Sean Cribbs", "Matt McCray"]
+  s.date = %q{2010-04-29}
+  s.description = %q{An extension for Radiant CMS that allows you to create 'contact us' and other mail-bound forms.}
+  s.email = %q{radiant@radiantcms.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/mail_controller.rb",
+     "app/models/mail.rb",
+     "app/models/mailer.rb",
+     "lib/mailer_process.rb",
+     "lib/mailer_tags.rb",
+     "lib/radiant-mailer-extension.rb",
+     "lib/tasks/mailer_extension_tasks.rake",
+     "mailer_extension.rb",
+     "radiant-mailer-extension.gemspec",
+     "spec/controllers/mail_controller_spec.rb",
+     "spec/dataset/mailer_dataset.rb",
+     "spec/lib/mailer_process_spec.rb",
+     "spec/lib/mailer_tags_spec.rb",
+     "spec/models/mail_spec.rb",
+     "spec/models/mailer_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/radiant/radiant-mailer-extension}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Enables form mail on a page.}
+  s.test_files = [
+    "spec/controllers/mail_controller_spec.rb",
+     "spec/dataset/mailer_dataset.rb",
+     "spec/lib/mailer_process_spec.rb",
+     "spec/lib/mailer_tags_spec.rb",
+     "spec/models/mail_spec.rb",
+     "spec/models/mailer_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/spec/controllers/mail_controller_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe MailController do
+  dataset :mailer
+  describe "POST to /pages/:id/mail" do
+    before :each do
+      @page = pages(:mail_form)
+      @mail = mock("Mail", :send => false)
+      ActionMailer::Base.delivery_method = :test
+      ActionMailer::Base.deliveries = []
+    end
+    
+    def do_post
+      post :create, :page_id => @page.id, :mailer => {:body => 'Hello, world!'}
+    end
+    
+    it "should load the page by id" do
+      do_post
+      assigns[:page].should == @page
+    end
+    
+    it "should render the page if mail fails to send" do
+      Mail.should_receive(:new).and_return(@mail)
+      @mail.should_receive(:send).and_return(false)
+      @controller.should_not_receive(:redirect_to)
+      do_post
+      response.should be_success
+      response.body.should == assigns[:page].render
+    end
+    
+    it "should redirect back to the page by default if the mail sends" do
+      Mail.should_receive(:new).and_return(@mail)
+      @mail.should_receive(:send).and_return(true)
+      do_post
+      response.should be_redirect
+      response.redirect_url.should match(%r{/mail-form/#mail_sent})
+    end
+    
+    it "should redirect to the configured url if the mail sends" do
+      @page.part(:mailer).update_attributes(:content => {'redirect_to' => '/first', 'recipients' => 'foo@bar.com', 'from' => 'baz@noreply.com'}.to_yaml)
+      Mail.should_receive(:new).and_return(@mail)
+      @mail.should_receive(:send).and_return(true)
+      do_post
+      response.should be_redirect
+      response.redirect_url.should match(%r{/first})
+    end
+  end
+end

data/spec/dataset/mailer_dataset.rb

@@ -0,0 +1,17 @@
+class MailerDataset < Dataset::Base
+  uses :pages
+
+  def load
+    create_page "Mail form" do
+      create_page_part "mailer", :content => {'recipients' => 'foo@bar.com', 'from' => 'baz@noreply.com'}.to_yaml
+    end
+    create_page "Plain mail" do
+      create_page_part "plain_mailer", :content => {'recipients' => 'foo@bar.com', 'from' => 'baz@noreply.com'}.to_yaml, :name => "mailer"
+      create_page_part "email_plain", :content => 'The body: <r:mailer:get name="body" />', :name => 'email'
+    end
+    create_page "HTML mail" do
+      create_page_part "html_mailer", :content => {'recipients' => 'foo@bar.com', 'from' => 'baz@noreply.com'}.to_yaml, :page_id => page_id(:html_mail), :name => "mailer"
+      create_page_part "email_html", :content => '<html><body><r:mailer:get name="body" /></body></html>', :page_id => page_id(:html_mail)
+    end
+  end
+end

data/spec/lib/mailer_process_spec.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+require 'site_controller'
+SiteController.class_eval { def rescue_action(e) raise e; end }
+
+describe "MailerProcess" do
+  it "should add a last_mail accessor to Page" do
+    @page = Page.new
+    @page.should respond_to(:last_mail)
+    @page.should respond_to(:last_mail=)
+  end
+
+  it "should override the process method" do
+    @page = Page.new
+    @page.should respond_to(:process_without_mailer)
+    @page.should respond_to(:process_with_mailer)
+  end
+end
+
+describe SiteController, "receiving a mailer request", :type => :controller do
+  dataset :mailer
+
+  before :each do
+    ResponseCache.instance.clear
+    Radiant::Config['mailer.post_to_page?'] = true
+    @page = pages(:mail_form)
+    @mail = mock("Mail", :send => false, :data => {}, :errors => {})
+    Page.stub!(:find_by_url).and_return(@page)
+    Mail.stub!(:new).and_return(@mail)
+  end
+
+  it "should not process a mail form if the request was GET" do
+    @page.should_receive(:process_without_mailer).with(request, response)
+    Mail.should_not_receive(:new)
+    get :show_page, :url => @page.url
+  end
+
+  it "should not process a mail form if mailer.post_to_page? is set to false" do
+    Radiant::Config['mailer.post_to_page?'] = false
+    @page.should_receive(:process_without_mailer).with(request, response)
+    Mail.should_not_receive(:new)
+    post :show_page, :url => @page.url
+  end
+
+  it "should not process a mail form unless there are mailer parameters" do
+    @page.should_receive(:process_without_mailer).with(request, response)
+    Mail.should_not_receive(:new)
+    post :show_page, :url => @page.url
+  end
+
+  it "should process a mail form if the request was POST, posting to the page is enabled, and mailer parameters were submitted" do
+    Mail.should_receive(:new).and_return(@mail)
+    @page.should_receive(:process_without_mailer).with(request, response)
+    post :show_page, :url => @page.url, :mailer => {:foo => 'bar'}
+  end
+
+  it "should create a Mail object and assign it to the page's last_mail accessor" do
+    Mail.should_receive(:new).and_return(@mail)
+    @page.should_receive(:last_mail=).with(@mail).at_least(:once)
+    post :show_page, :url => @page.url, :mailer => {:foo => 'bar'}
+  end
+
+  it "should attempt to send the mail" do
+    @mail.should_receive(:send).and_return(false)
+    post :show_page, :url => @page.url, :mailer => {:foo => 'bar'}
+  end
+
+  it "should clear out the mail data and errors when sending is successful" do
+    @mail.should_receive(:send).and_return(true)
+    @mail.data.should_receive(:delete_if)
+    @mail.errors.should_receive(:delete_if)
+    post :show_page, :url => @page.url, :mailer => {:foo => 'bar'}
+  end
+  
+  it "should redirect to the configured URL when sending is successful" do
+    @page.should_receive(:mailer_config_and_page).and_return([{:redirect_to => "/foo/bar"}, @page])
+    @mail.should_receive(:send).and_return(true)
+    post :show_page, :url => @page.url, :mailer => {:foo => 'bar'}
+    response.redirect_url.should match(%r{/foo/bar})
+  end
+end