josevalim-simple_form 0.1.1 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,5 @@
+* Added support to :attachments (thanks to @andrewtimberlake)
+
 # Version 0.1
 
 * First release

data/README

@@ -17,12 +17,12 @@ to have a contact form (including the e-mail):
     recipients "your.email@your.domain.com"
     sender{|c| %{"#{c.name}" <#{c.email}>} }
 
-    attribute :name,        :validate => true
-    attribute :email,       :validate => /[^@]+@[^\.]+\.[\w\.\-]+/
-    attribute :company_name
-    attribute :telephone
-    attribute :message,     :validate => true
-    attribute :nickname,    :captcha  => true
+    attribute :name,      :validate => true
+    attribute :email,     :validate => /[^@]+@[^\.]+\.[\w\.\-]+/
+    attribute :file,      :attachment => true
+
+    attribute :message
+    attribute :nickname,  :captcha  => true
   end
 
 Then you start a script/console and type:
@@ -32,8 +32,11 @@ Then you start a script/console and type:
 
 Check your inbox and the e-mail will be there, with the sent fields.
 
-SimpleForm is tested and compatible with Rails 2.2.x and Rails 2.3.x. It also
-supports I18n and error messages, just as an ActiveRecord model does.
+SimpleForm also support attachments, I18n, error messages like in ActiveRecord 
+(so it works with custom FormBuilders) and can also send the user request information
+in the contact mail.
+
+It's tested and compatible with Rails 2.2.x and Rails 2.3.x.
 
 Installation
 ------------
@@ -47,6 +50,25 @@ If you want it as plugin, just do:
 
    script/plugin install git://github.com/josevalim/simple_form.git
 
+Request
+-------
+
+SimpleForm makes easy to append user information to the contact mail. You just
+have to do:
+
+  class ContactForm < SimpleForm
+    append :remote_ip, :user_agent, :session
+    # ...
+  end
+
+And in your controller:
+
+  @contact_form = ContactForm.new(params[:contact_form], request)
+
+And the remote ip, user agent and session will be sent in the e-mail in a
+request information session. You can send to append any method that the
+request object responds to.
+
 API Overview
 ------------
 
@@ -61,6 +83,9 @@ Options:
   When a regexp is given, check if the attribute matches is not blank and
   then if it matches the regexp.
 
+* :attachment - When given, expects a file to be sent and attaches
+  it to the e-mail. Don't forget to set your form to multitype.
+
 * :captcha - When true, validates the attributes must be blank.
   This is a simple way to avoid spam and the input should be hidden with CSS.
 
@@ -109,9 +134,9 @@ This requires that your SimpleForm object have at least an email attribute.
 
 Additional headers to your e-mail.
 
-== recipients(string_or_array)
+== recipients(string_or_array_or_proc)
 
-Who will receive the e-mail. Can be a string or array.
+Who will receive the e-mail. Can be a string or array, or a proc that returns one of them.
 
 I18n
 ----
@@ -121,17 +146,24 @@ Below is an I18n example file:
 
   simple_form:
     models:
-      contact_form: Formulário de contato
+      contact_form: "Your site contact form"
     attributes:
-      name: Nome
-      email: E-mail
-      company_name: Empresa
-      telephone: Telefone
-      message: Mensagem
+      email: "E-mail"
+      telephone: "Telephone number"
+      message: "Sent message"
     messages:
-      blank: "não pode ficar em branco"
-      invalid: "não é válido"
-      telephone: "deve haver oito dígitos"
+      blank: "can not be blank"
+      invalid: "is not valid"
+      telephone: "must have eight digits"
+    request:
+      title: "Technical information about the user"
+      remote_ip: "IP Address"
+      user_agent: "Browser"
+
+Contributors
+------------
+
+* "Andrew Timberlake":http://github.com/andrewtimberlake
 
 Bugs and Feedback
 -----------------

data/lib/simple_form/base.rb

@@ -1,8 +1,13 @@
 class SimpleForm
+  attr_accessor :request
 
   # Initialize assigning the parameters given as hash (just as in ActiveRecord).
   #
-  def initialize(params={})
+  # It also accepts the request object as second parameter which must be sent
+  # whenever :append is called.
+  #
+  def initialize(params={}, request=nil)
+    @request = request
     params.each_pair do |attr, value|
       self.send(:"#{attr}=", value)
     end unless params.blank?
@@ -70,8 +75,8 @@ class SimpleForm
   # If is not spam and the form is valid, we send the e-mail and returns true.
   # Otherwise returns false.
   #
-  def deliver
-    if self.not_spam? && self.valid?
+  def deliver(run_validations=true)
+    if !run_validations || (self.not_spam? && self.valid?)
       SimpleForm::Notifier.deliver_contact(self)
       return true
     else

data/lib/simple_form/dsl.rb

@@ -11,6 +11,10 @@ class SimpleForm
       # * <tt>:validate</tt> - When true, validates the attributes can't be blank.
       #   When a regexp is given, check if the attribute matches is not blank and
       #   then if it matches the regexp.
+      #
+      # * <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
       #
@@ -20,6 +24,7 @@ class SimpleForm
       #     attributes :name,  :validate => true
       #     attributes :email, :validate => /^([^@]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
       #     attributes :message
+      #     attributes :file, :attachment => true
       #     attributes :nickname, :captcha => true
       #   end
       #
@@ -28,7 +33,9 @@ class SimpleForm
 
         attr_accessor *accessors
 
-        if options[:captcha]
+        if options[:attachment]
+          write_inheritable_array(:form_attachments, accessors)
+        elsif options[:captcha]
           write_inheritable_array(:form_captcha, accessors)
         else
           write_inheritable_array(:form_attributes, accessors)
@@ -96,10 +103,28 @@ class SimpleForm
       #     recipients "jose.valim@gmail.com"
       #   end
       #
-      def recipients(string_or_array)
-        write_inheritable_array(:form_recipients, [*string_or_array])
+      def recipients(string_or_array_or_proc)
+        write_inheritable_attribute(:form_recipients, string_or_array_or_proc)
       end
       alias :to :recipients
 
+      # 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 < SimpleForm
+      #     append :remote_ip, :user_agent, :session, :cookies
+      #   end
+      #
+      def append(*values)
+        write_inheritable_array(:form_appendable, values)
+      end
+
   end
 end

data/lib/simple_form/notifier.rb

@@ -2,16 +2,14 @@
 #
 class SimpleForm
   class Notifier < ActionMailer::Base
-    def contact(form)
-      @subject = form.class.form_subject
-      @subject = @subject.call(form) if @subject.is_a?(Proc)
-
-      @from    = form.class.form_sender
-      @from    = @from.call(form)    if @from.is_a?(Proc)
 
-      @recipients = form.class.form_recipients
+    def contact(form)
+      @from       = get_from_class_and_eval(form, :form_sender)
+      @subject    = get_from_class_and_eval(form, :form_subject)
+      @recipients = get_from_class_and_eval(form, :form_recipients)
 
       raise ScriptError, "You forgot to setup #{form.class.name} recipients" if @recipients.blank?
+      raise ScriptError, "You set :append values but forgot to give me the request object" if form.request.nil? && !form.class.form_appendable.blank?
 
       @body['form']    = form
       @body['subject'] = @subject
@@ -19,6 +17,29 @@ class SimpleForm
       @sent_on = Time.now.utc
       @headers = form.class.form_headers
       @content_type = 'text/html'
+
+      form.class.form_attachments.each do |attribute|
+        value = form.send(attribute)
+        if value.respond_to?(:read)
+          attachment value.content_type.to_s do |att|
+            att.filename = value.original_filename
+            att.body = value.read
+          end
+        end
+      end
     end
+
+    protected
+
+      def get_from_class_and_eval(form, method)
+        duck = form.class.send(method)
+
+        if duck.is_a?(Proc)
+          duck.call(form)
+        else
+          duck
+        end
+      end
+
   end
 end

data/lib/simple_form.rb

@@ -7,22 +7,24 @@ require File.join(dir, 'simple_form', 'notifier')
 class SimpleForm
   extend SimpleForm::DSL
 
-  ACCESSORS = [ :form_attributes, :form_validatable, :form_subject,
-                :form_recipients, :form_sender, :form_captcha, :form_headers ]
+  ACCESSORS = [ :form_attributes, :form_validatable, :form_subject, :form_attachments,
+                :form_recipients, :form_sender, :form_captcha, :form_headers, :form_appendable ]
 
   DEFAULT_MESSAGES = { :blank => "can't be blank", :invalid => "is invalid" }
 
   class_inheritable_reader *ACCESSORS
   protected *ACCESSORS
 
-  # Configure default values
+  # Initialize arrays and hashes
   #
-  attribute :captcha => true
-  attribute :validate => true
+  write_inheritable_array :form_captcha, []
+  write_inheritable_array :form_appendable, []
+  write_inheritable_array :form_attributes, []
+  write_inheritable_array :form_attachments, []
+  write_inheritable_hash  :form_validatable, {}
 
   headers({})
-  recipients([])
-  sender{|c| c.email }
+  sender {|c| c.email }
   subject{|c| c.class.human_name }
 end
 

data/test/errors_test.rb

@@ -47,7 +47,8 @@ class SimpleFormErrorsTest < ActiveSupport::TestCase
     form = ContactForm.new(:email => 'not_valid')
     form.valid?
 
-    assert_equal ["Name can't be blank", "Email is invalid"], form.errors.full_messages
+    assert form.errors.full_messages.include?("Name can't be blank")
+    assert form.errors.full_messages.include?("Email is invalid")
   end
 
   def test_full_localized_messages
@@ -56,7 +57,8 @@ class SimpleFormErrorsTest < ActiveSupport::TestCase
     form = ContactForm.new(:email => 'not_valid')
     form.valid?
 
-    assert_equal ["Name should be filled", "E-mail is not valid"], form.errors.full_messages
+    assert form.errors.full_messages.include?("Name should be filled")
+    assert form.errors.full_messages.include?("E-mail is not valid")
   end
 
   def teardown

data/test/notifier_test.rb

@@ -3,8 +3,15 @@ require File.dirname(__FILE__) + '/test_helper'
 class SimpleFormNotifierTest < ActiveSupport::TestCase
 
   def setup
-    @form     = ContactForm.new(:name => 'José', :email => 'my.email@my.domain.com', :message => 'Cool')
-    @advanced = AdvancedForm.new(:name => 'José', :email => 'my.email@my.domain.com', :message => "Cool\nno?")
+    @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, @request)
+
+    test_file  = ActionController::TestUploadedFile.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)
+
     ActionMailer::Base.deliveries = []
   end
 
@@ -41,7 +48,7 @@ class SimpleFormNotifierTest < ActiveSupport::TestCase
 
   def test_recipients_is_an_array
     @advanced.deliver
-    assert_equal ['my.email@my.domain.com', 'my.first@email.com', 'my.second@email.com'], ActionMailer::Base.deliveries.first.to
+    assert_equal ['my.first@email.com', 'my.second@email.com'], ActionMailer::Base.deliveries.first.to
   end
 
   def test_headers_is_a_hash
@@ -69,10 +76,10 @@ class SimpleFormNotifierTest < ActiveSupport::TestCase
   end
 
   def test_body_contains_localized_attributes_names
-    I18n.backend.store_translations(:en, :simple_form => { :attributes => { :email => 'E-mail', :message => 'Sent message' } })
+    I18n.backend.store_translations(:en, :simple_form => { :attributes => { :message => 'Sent message' } })
     @form.deliver
-    assert_match /E\-mail:/, ActionMailer::Base.deliveries.first.body
     assert_match /Sent message:/, ActionMailer::Base.deliveries.first.body
+    assert_no_match /Message:/, ActionMailer::Base.deliveries.first.body
   end
 
   def test_body_simple_format_messages_with_break_line
@@ -83,6 +90,69 @@ class SimpleFormNotifierTest < ActiveSupport::TestCase
     assert_match /<p>Cool/, ActionMailer::Base.deliveries.last.body
   end
 
+  def test_body_does_not_append_request_if_append_is_not_called
+    @form.deliver
+    assert_no_match /Request information/, ActionMailer::Base.deliveries.first.body
+  end
+
+  def test_body_does_append_request_if_append_is_called
+    @advanced.deliver
+    assert_match /Request information/, ActionMailer::Base.deliveries.last.body
+  end
+
+  def test_request_title_is_localized
+    I18n.backend.store_translations(:en, :simple_form => { :request => { :title => 'Information about the request' } })
+    @advanced.deliver
+    assert_no_match /Request information/, ActionMailer::Base.deliveries.last.body
+    assert_match /Information about the request/, ActionMailer::Base.deliveries.last.body
+  end
+
+  def test_request_info_attributes_are_printed
+    @advanced.deliver
+    assert_match /Remote ip/, ActionMailer::Base.deliveries.last.body
+    assert_match /User agent/, ActionMailer::Base.deliveries.last.body
+  end
+
+  def test_request_info_attributes_are_localized
+    I18n.backend.store_translations(:en, :simple_form => { :request => { :remote_ip => 'IP Address' } })
+    @advanced.deliver
+    assert_match /IP Address/, ActionMailer::Base.deliveries.last.body
+    assert_no_match /Remote ip/, ActionMailer::Base.deliveries.last.body
+  end
+
+  def test_request_info_values_are_printed
+    @advanced.deliver
+    assert_match /0\.0\.0\.0/, ActionMailer::Base.deliveries.last.body
+    assert_match /Rails Testing/, ActionMailer::Base.deliveries.last.body
+  end
+
+  def test_request_info_hashes_are_print_inside_lis
+    @request.session = { :my => :session, :user => :data }
+    @advanced.deliver
+    assert_match /<li>my: session<\/li>/, ActionMailer::Base.deliveries.last.body
+    assert_match /<li>user: data<\/li>/, ActionMailer::Base.deliveries.last.body
+  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
+
+    #For some reason I need to encode the mail before the attachments array returns values
+    ActionMailer::Base.deliveries.first.to_s
+    assert_equal 1, ActionMailer::Base.deliveries.first.attachments.size
+  end
+
+  def test_form_with_file_does_not_output_attachment_as_attribute
+    @with_file.deliver
+    assert_no_match /File/, ActionMailer::Base.deliveries.first.body
+  end
+
   def teardown
     I18n.reload!
   end

data/test/test_helper.rb

@@ -6,6 +6,7 @@ RAILS_ENV = ENV["RAILS_ENV"] = "test"
 require 'active_support'
 require 'active_support/test_case'
 require 'action_mailer'
+require 'action_controller/test_case'
 
 ActionMailer::Base.delivery_method = :test
 
@@ -22,12 +23,25 @@ class ContactForm < SimpleForm
 end
 
 class AdvancedForm < ContactForm
+  append :remote_ip, :user_agent, :session
+
   recipients [ 'my.first@email.com', 'my.second@email.com' ]
   subject 'My Advanced Form'
   sender{|c| %{"#{c.name}" <#{c.email}>} }
   headers 'return-path' => 'mypath'
 end
 
+class FileForm < ContactForm
+  attribute :file, :attachment => true, :validate => true
+end
+
 class NullRecipient < SimpleForm
   sender 'my.email@my.domain.com'
 end
+
+#Needed to correctly test an uploaded file
+class ActionController::TestUploadedFile
+  def read
+    @tempfile.read
+  end
+end

data/views/simple_form/notifier/contact.erb

@@ -1,4 +1,4 @@
-<p><%=h @subject %></p>
+<h4 style="text-decoration:underline"><%=h @subject %></h4>
 
 <% @form.class.form_attributes.each do |attribute|
   value = @form.send(attribute)
@@ -7,3 +7,24 @@
   <p><b><%= @form.class.human_attribute_name(attribute) %>:</b>
   <%= value.include?("\n") ? simple_format(h(value)) : h(value) %></p>
 <% end %>
+
+<% unless @form.class.form_appendable.blank? %>
+  <br /><h4 style="text-decoration:underline"><%= I18n.t :title, :scope => [ :simple_form, :request ], :default => 'Request information' %></h4>
+
+  <% @form.class.form_appendable.each do |attribute|
+    value = @form.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 => [ :simple_form, :request ], :default => attribute.to_s.humanize %>:</b>
+    <%= value.include?("\n") ? simple_format(value) : value %></p>
+  <% end %>
+  <br />
+<% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: josevalim-simple_form
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"