mail_form 1.0.0 → 1.1.0

data/lib/mail_form/delivery.rb

@@ -0,0 +1,239 @@
+module MailForm::Delivery
+  extend ActiveSupport::Concern
+
+  ACCESSORS = [ :mail_attributes, :mail_subject, :mail_captcha,
+                :mail_attachments, :mail_recipients, :mail_sender,
+                :mail_headers, :mail_template, :mail_appendable ]
+
+  included do
+    class_inheritable_reader *ACCESSORS
+    protected *ACCESSORS
+
+    # Initialize arrays and hashes
+    write_inheritable_array :mail_captcha, []
+    write_inheritable_array :mail_appendable, []
+    write_inheritable_array :mail_attributes, []
+    write_inheritable_array :mail_attachments, []
+
+    headers({})
+    sender {|c| c.email }
+    subject{|c| c.class.model_name.human }
+    template 'contact'
+
+    before_create :not_spam?
+    after_create  :deliver!
+
+    attr_accessor :request
+    alias :deliver :create
+  end
+
+  module ClassMethods
+    # Declare your form attributes. All attributes declared here will be appended
+    # to the e-mail, except the ones captcha is true.
+    #
+    # == Options
+    #
+    # * :validate - A hook to validates_*_of. When true is given, validates the
+    #       presence of the attribute. When a regexp, validates format. When array,
+    #       validates the inclusion of the attribute in the array.
+    # 
+    #       Whenever :validate is given, the presence is automatically checked. Give
+    #       :allow_blank => true to override.
+    # 
+    #       Finally, when :validate is a symbol, the method given as symbol will be
+    #       called. Then you can add validations as you do in ActiveRecord (errors.add).
+    #
+    # * <tt>:attachment</tt> - When given, expects a file to be sent and attaches
+    #   it to the e-mail. Don't forget to set your form to multitype.
+    #
+    # * <tt>:captcha</tt> - When true, validates the attributes must be blank
+    #   This is a simple way to avoid spam
+    #
+    # == Examples
+    #
+    #   class ContactForm < MailForm
+    #     attributes :name,  :validate => true
+    #     attributes :email, :validate => /^([^@]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+    #     attributes :type,  :validate => ["General", "Interface bug"]
+    #     attributes :message
+    #     attributes :screenshot, :attachment => true, :validate => :interface_bug?
+    #     attributes :nickname, :captcha => true
+    #
+    #     def interface_bug?
+    #       if type == 'Interface bug' && screenshot.nil?
+    #         self.errors.add(:screenshot, "can't be blank when you are reporting an interface bug")
+    #       end
+    #     end
+    #   end
+    #
+    def attribute(*accessors)
+      options = accessors.extract_options!
+      attr_accessor *(accessors - instance_methods.map(&:to_sym))
+
+      if options[:attachment]
+        write_inheritable_array(:mail_attachments, accessors)
+      elsif options[:captcha]
+        write_inheritable_array(:mail_captcha, accessors)
+      else
+        write_inheritable_array(:mail_attributes, accessors)
+      end
+
+      validation = options.delete(:validate)
+      return unless validation
+
+      accessors.each do |accessor|
+        case validation
+        when Symbol, Class
+          validate validation
+          break
+        when Regexp
+          validates_format_of accessor, :with => validation, :allow_blank => true
+        when Array
+          validates_inclusion_of accessor, :in => validation, :allow_blank => true
+        when Range
+          validates_length_of accessor, :within => validation, :allow_blank => true
+        end
+
+        validates_presence_of accessor unless options[:allow_blank] == true
+      end
+    end
+    alias :attributes :attribute
+
+    # Declares contact email sender. It can be a string or a proc or a symbol.
+    #
+    # When a symbol is given, it will call a method on the form object with
+    # the same name as the symbol. As a proc, it receives a simple form
+    # instance. By default is the class human name.
+    #
+    # == Examples
+    #
+    #   class ContactForm < MailForm
+    #     subject "My Contact Form"
+    #   end
+    #
+    def subject(duck=nil, &block)
+      write_inheritable_attribute(:mail_subject, duck || block)
+    end
+
+    # Declares contact email sender. It can be a string or a proc or a symbol.
+    #
+    # When a symbol is given, it will call a method on the form object with
+    # the same name as the symbol. As a proc, it receives a simple form
+    # instance. By default is:
+    #
+    #   sender{ |c| c.email }
+    #
+    # This requires that your MailForm object have an email attribute.
+    #
+    # == Examples
+    #
+    #   class ContactForm < MailForm
+    #     # Change sender to include also the name
+    #     sender { |c| %{"#{c.name}" <#{c.email}>} }
+    #   end
+    #
+    def sender(duck=nil, &block)
+      write_inheritable_attribute(:mail_sender, duck || block)
+    end
+    alias :from :sender
+
+    # Who will receive the e-mail. Can be a string or array or a symbol or a proc.
+    #
+    # When a symbol is given, it will call a method on the form object with
+    # the same name as the symbol. As a proc, it receives a simple form instance.
+    #
+    # Both the proc and the symbol must return a string or an array. By default
+    # is nil.
+    #
+    # == Examples
+    #
+    #   class ContactForm < MailForm
+    #     recipients [ "first.manager@domain.com", "second.manager@domain.com" ]
+    #   end
+    #
+    def recipients(duck=nil, &block)
+      write_inheritable_attribute(:mail_recipients, duck || block)
+    end
+    alias :to :recipients
+
+    # Additional headers to your e-mail.
+    #
+    # == Examples
+    #
+    #   class ContactForm < MailForm
+    #     headers { :content_type => 'text/html' }
+    #   end
+    #
+    def headers(hash)
+      write_inheritable_hash(:mail_headers, hash)
+    end
+
+    # Customized template for your e-mail, if you don't want to use default
+    # 'contact' template or need more than one contact form with different
+    # template layouts.
+    #
+    # When a symbol is given, it will call a method on the form object with
+    # the same name as the symbol. As a proc, it receives a simple form
+    # instance. Both method and proc must return a string with the template
+    # name. Defaults to 'contact'.
+    #
+    # == Examples
+    #
+    #   class ContactForm < MailForm
+    #     # look for a template in views/mail_form/notifier/my_template.erb
+    #     template 'my_template'
+    #   end
+    #
+    def template(new_template)
+      write_inheritable_attribute(:mail_template, new_template)
+    end
+
+    # Values from request object to be appended to the contact form.
+    # Whenever used, you have to send the request object when initializing the object:
+    #
+    #   @contact_form = ContactForm.new(params[:contact_form], request)
+    #
+    # You can get the values to be appended from the AbstractRequest
+    # documentation (http://api.rubyonrails.org/classes/ActionController/AbstractRequest.html)
+    #
+    # == Examples
+    #
+    #   class ContactForm < MailForm
+    #     append :remote_ip, :user_agent, :session, :cookies
+    #   end
+    #
+    def append(*values)
+      write_inheritable_array(:mail_appendable, values)
+    end
+  end
+
+  # In development, raises an error if the captcha field is not blank. This is
+  # is good to remember that the field should be hidden with CSS and shown only
+  # to robots.
+  #
+  # In test and in production, it returns true if all captcha fields are blank,
+  # returns false otherwise.
+  #
+  def spam?
+    mail_captcha.each do |field|
+      next if send(field).blank?
+
+      if defined?(Rails) && Rails.env.development?
+        raise ScriptError, "The captcha field #{field} was supposed to be blank"
+      else
+        return true
+      end
+    end
+
+    false
+  end
+
+  def not_spam?
+    !spam?
+  end
+
+  # Deliver the resource without checking any condition.
+  def deliver!
+    MailForm.contact(self).deliver
+  end
+end

data/lib/mail_form/shim.rb

@@ -0,0 +1,50 @@
+require 'active_model'
+
+# This the module which makes any class behave like ActiveModel.
+module MailForm::Shim
+  def self.included(base)
+    base.class_eval do
+      extend ActiveModel::Naming
+      extend ActiveModel::Translation
+      extend ActiveModel::Callbacks
+      include ActiveModel::Validations
+      include ActiveModel::Conversion
+
+      extend MailForm::Shim::ClassMethods
+      define_model_callbacks :create
+    end
+  end
+
+  module ClassMethods
+    def i18n_scope
+      :mail_form
+    end
+  end
+
+  # Initialize assigning the parameters given as hash (just as in ActiveRecord).
+  def initialize(params={})
+    params.each_pair do |attr, value|
+      self.send(:"#{attr}=", value)
+    end unless params.blank?
+  end
+
+  # Always return true so when using form_for, the default method will be post.
+  def new_record?
+    true
+  end
+
+  # Always return nil so when using form_for, the default method will be post.
+  def id
+    nil
+  end
+
+  # Create just check validity, and if so, trigger callbacks.
+  def create
+    if valid?
+      _run_create_callbacks { true }
+    else
+      false
+    end
+  end
+  alias :save :create
+end

data/lib/mail_form/version.rb

@@ -1,3 +1,3 @@
 module MailForm
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

data/lib/views/mail_form/contact.erb

@@ -0,0 +1,38 @@
+<h4 style="text-decoration:underline"><%= mailer.subject %></h4>
+
+<% @resource.class.mail_attributes.each do |attribute|
+  value = @resource.send(attribute)
+  next if value.blank? %>
+
+  <p><b><%= @resource.class.human_attribute_name(attribute) %>:</b>
+  <%= case value
+    when /\n/
+      raw(simple_format(h(value)))
+    when Time, DateTime, Date
+      I18n.l value
+    else
+      value
+    end
+  %></p>
+<% end %>
+
+<% unless @resource.class.mail_appendable.blank? %>
+  <br /><h4 style="text-decoration:underline"><%= I18n.t :title, :scope => [ :mail_form, :request ], :default => 'Request information' %></h4>
+
+  <% @resource.class.mail_appendable.each do |attribute|
+    value = @resource.request.send(attribute)
+
+    value = if value.is_a?(Hash) && !value.empty?
+      content_tag(:ul, value.to_a.map{|k,v| content_tag(:li, h("#{k}: #{v.inspect}")) }.join("\n"), :style => "list-style:none;")
+    elsif value.is_a?(String)
+      h(value)
+    else
+      h(value.inspect)
+    end
+  %>
+
+    <p><b><%= I18n.t attribute, :scope => [ :mail_form, :request ], :default => attribute.to_s.humanize %>:</b>
+    <%= value.include?("\n") ? raw(simple_format(value)) : value %></p>
+  <% end %>
+  <br />
+<% end %>

data/test/mail_form_test.rb

@@ -0,0 +1,190 @@
+require 'test_helper'
+
+class MailFormNotifierTest < ActiveSupport::TestCase
+
+  def setup
+    @form = ContactForm.new(:name => 'José', :email => 'my.email@my.domain.com', :message => 'Cool')
+
+    @request          = ActionController::TestRequest.new
+    @valid_attributes = { :name => 'José', :email => 'my.email@my.domain.com', :message => "Cool\nno?" }
+    @advanced         = AdvancedForm.new(@valid_attributes)
+    @advanced.request = @request
+
+    test_file  = Rack::Test::UploadedFile.new(File.join(File.dirname(__FILE__), 'test_file.txt'))
+    @with_file = FileForm.new(:name => 'José', :email => 'my.email@my.domain.com', :message => "Cool", :file => test_file)
+
+    @template = TemplateForm.new(@valid_attributes)
+
+    ActionMailer::Base.deliveries = []
+  end
+
+  def test_email_is_sent
+    @form.deliver
+    assert_equal 1, ActionMailer::Base.deliveries.size
+  end
+
+  def test_subject_defaults_to_class_human_name
+    @form.deliver
+    assert_equal 'Contact form', first_delivery.subject
+  end
+
+  def test_subject_is_a_string
+    @advanced.deliver
+    assert_equal 'My Advanced Form', first_delivery.subject
+  end
+
+  def test_sender_defaults_to_form_email
+    @form.deliver
+    assert_equal ['my.email@my.domain.com'], first_delivery.from
+  end
+
+  def test_error_is_raised_when_recipients_is_nil
+    assert_raise ScriptError do
+      NullRecipient.new.deliver
+    end
+  end
+
+  def test_recipients_is_a_string
+    @form.deliver
+    assert_equal ['my.email@my.domain.com'], first_delivery.to
+  end
+
+  def test_recipients_is_an_array
+    @advanced.deliver
+    assert_equal ['my.first@email.com', 'my.second@email.com'], first_delivery.to
+  end
+
+  def test_recipients_is_a_symbold
+    @with_file.deliver
+    assert_equal ['contact_file@my.domain.com'], first_delivery.to
+  end
+
+  def test_headers_is_a_hash
+    @advanced.deliver
+    assert_equal 'mypath', first_delivery.header['return-path'].to_s
+  end
+
+  def test_body_contains_subject
+    @form.deliver
+    assert_match /Contact form/, first_delivery.body.to_s
+  end
+
+  def test_body_contains_attributes_values
+    @form.deliver
+    assert_match /José/, first_delivery.body.to_s
+    assert_match /my.email@my.domain.com/, first_delivery.body.to_s
+    assert_match /Cool/, first_delivery.body.to_s
+  end
+
+  def test_body_contains_attributes_names
+    @form.deliver
+    assert_match /Name:/, first_delivery.body.to_s
+    assert_match /Email:/, first_delivery.body.to_s
+    assert_match /Message:/, first_delivery.body.to_s
+  end
+
+  def test_body_contains_localized_attributes_names
+    I18n.backend.store_translations(:en, :mail_form => { :attributes => { :contact_form => { :message => 'Sent message' } } })
+    @form.deliver
+    assert_match /Sent message:/, first_delivery.body.to_s
+    assert_no_match /Message:/, first_delivery.body.to_s
+  end
+
+  def test_body_mail_format_messages_with_break_line
+    @form.deliver
+    assert_no_match /<p>Cool/, first_delivery.body.to_s
+
+    @advanced.deliver
+    assert_match /<p>Cool/, last_delivery.body.to_s
+  end
+
+  def test_body_mail_format_dates_with_i18n
+    @form.deliver
+    assert_no_match /I18n.l(Date.today)/, first_delivery.body.to_s
+  end
+
+  def test_body_does_not_append_request_if_append_is_not_called
+    @form.deliver
+    assert_no_match /Request information/, first_delivery.body.to_s
+  end
+
+  def test_body_does_append_request_if_append_is_called
+    @advanced.deliver
+    assert_match /Request information/, last_delivery.body.to_s
+  end
+
+  def test_request_title_is_localized
+    I18n.backend.store_translations(:en, :mail_form => { :request => { :title => 'Information about the request' } })
+    @advanced.deliver
+    assert_no_match /Request information/, last_delivery.body.to_s
+    assert_match /Information about the request/, last_delivery.body.to_s
+  end
+
+  def test_request_info_attributes_are_printed
+    @advanced.deliver
+    assert_match /Remote ip/, last_delivery.body.to_s
+    assert_match /User agent/, last_delivery.body.to_s
+  end
+
+  def test_request_info_attributes_are_localized
+    I18n.backend.store_translations(:en, :mail_form => { :request => { :remote_ip => 'IP Address' } })
+    @advanced.deliver
+    assert_match /IP Address/, last_delivery.body.to_s
+    assert_no_match /Remote ip/, last_delivery.body.to_s
+  end
+
+  def test_request_info_values_are_printed
+    @advanced.deliver
+    assert_match /0\.0\.0\.0/, last_delivery.body.to_s
+    assert_match /Rails Testing/, last_delivery.body.to_s
+  end
+
+  def test_request_info_hashes_are_print_inside_lis
+    @request.session = { :my => :session, :user => "data" }
+    @advanced.deliver
+    assert_match /<li>my: :session<\/li>/, last_delivery.body.to_s
+    assert_match /<li>user: &quot;data&quot;<\/li>/, last_delivery.body.to_s
+  end
+
+  def test_error_is_raised_when_append_is_given_but_no_request_is_given
+    assert_raise ScriptError do
+      @advanced.request = nil
+      @advanced.deliver
+    end
+  end
+
+  def test_form_with_file_includes_an_attachment
+    @with_file.deliver
+    assert_equal 1, first_delivery.attachments.size
+  end
+
+  def test_form_with_file_does_not_output_attachment_as_attribute
+    @with_file.deliver
+    assert_no_match /File:/, first_delivery.body.to_s
+  end
+
+  def test_form_with_customized_template_render_correct_template
+    begin
+      previous_view_path = MailForm.view_paths
+      MailForm.prepend_view_path File.join(File.dirname(__FILE__), 'views')
+      @template.deliver
+      assert_match 'Hello from my custom template!', last_delivery.body.to_s
+    ensure
+      MailForm.view_paths = previous_view_path
+    end
+  end
+
+  protected
+
+    def first_delivery
+      ActionMailer::Base.deliveries.first
+    end
+
+    def last_delivery
+      ActionMailer::Base.deliveries.last
+    end
+  
+    def teardown
+      I18n.reload!
+    end
+end