mail_form 1.0.0 → 1.1.0

data/test/{base_test.rb → resource_test.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require 'test_helper'
 
 class MailFormBaseTest < ActiveSupport::TestCase
 
@@ -37,8 +37,9 @@ class MailFormBaseTest < ActiveSupport::TestCase
     assert !form.valid?
     assert form.invalid?
 
-    assert_equal(2, form.errors.count)
-    assert_equal({:email=>:blank, :name=>:blank}, form.errors)
+    assert_equal 2, form.errors.count
+    assert_equal ["can't be blank"], form.errors[:email]
+    assert_equal ["can't be blank"], form.errors[:name]
   end
 
   def test_is_not_valid_when_validatable_regexp_does_not_match
@@ -47,7 +48,7 @@ class MailFormBaseTest < ActiveSupport::TestCase
     assert form.invalid?
 
     assert_equal(1, form.errors.count)
-    assert_equal({:email=>:invalid}, form.errors)
+    assert_equal ["is invalid"], form.errors[:email]
   end
 
   def test_is_valid_when_validatable_attributes_are_valid
@@ -86,12 +87,12 @@ class MailFormBaseTest < ActiveSupport::TestCase
   end
 
   def test_human_name_returns_a_humanized_name
-    assert_equal 'Contact form', ContactForm.human_name
+    assert_equal 'Contact form', ContactForm.model_name.human
   end
 
   def test_human_name_can_be_localized
     I18n.backend.store_translations(:en, :mail_form => { :models => { :contact_form => 'Formulário de contato' } })
-    assert_equal 'Formulário de contato', ContactForm.human_name
+    assert_equal 'Formulário de contato', ContactForm.model_name.human
   end
 
   def test_human_attribute_name_returns_a_humanized_attribute
@@ -99,10 +100,33 @@ class MailFormBaseTest < ActiveSupport::TestCase
   end
 
   def test_human_attribute_name_can_be_localized
-    I18n.backend.store_translations(:en, :mail_form => { :attributes => { :message => 'Mensagem' } })
+    I18n.backend.store_translations(:en, :mail_form => { :attributes => { :contact_form => { :message => 'Mensagem' } } })
     assert_equal 'Mensagem', ContactForm.human_attribute_name(:message)
   end
 
+  def test_activemodel_linked_errors
+    form = ContactForm.new(:email => 'not_valid', :category => "invalid")
+    form.valid?
+    assert_equal ["can't be blank"],              form.errors[:name]
+    assert_equal ["is invalid"],                  form.errors[:email]
+    assert_equal ["is not included in the list"], form.errors[:category]
+    assert_equal [],                              form.errors[:message]
+  end
+
+  def test_activemodel_errors_lookups_model_keys
+    I18n.backend.store_translations(:en, :mail_form => { :errors => { :models => { :contact_form =>
+      { :attributes => { :email => { :invalid => 'fill in the email' },
+                         :name => { :blank => 'fill in the name' } }
+      }
+    }}})
+
+    form = ContactForm.new(:email => 'not_valid')
+    form.valid?
+
+    assert_equal ["fill in the name"],  form.errors[:name]
+    assert_equal ["fill in the email"], form.errors[:email]
+  end
+
   def teardown
     I18n.reload!
   end

data/test/test_helper.rb

@@ -1,25 +1,38 @@
-require 'test/unit'
 require 'rubygems'
 
+begin
+  require 'test/unit'
+rescue LoadError
+end
+
 RAILS_ENV = ENV["RAILS_ENV"] = "test"
 
 require 'active_support'
 require 'active_support/test_case'
-require 'action_mailer'
+require 'action_controller'
 require 'action_controller/test_case'
+require 'action_mailer'
 
 ActionMailer::Base.delivery_method = :test
 
-# Load respond_to before defining ApplicationController
-require File.dirname(__FILE__) + '/../lib/mail_form.rb'
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'mail_form'
 
-class ContactForm < MailForm
+class ContactForm < MailForm::Base
   recipients 'my.email@my.domain.com'
 
   attribute :name,     :validate => true
   attribute :email,    :validate => /[^@]+@[^\.]+\.[\w\.\-]+/
+  attribute :category, :validate => ["Interface bug", "General"], :allow_blank => true
   attribute :nickname, :captcha => true
-  attributes :tellphone, :message, :validate => :callback
+
+  attributes :created_at, :message, :validate => :callback
+
+  before_create :set_created_at
+
+  def set_created_at
+    created_at = Date.today
+  end
 
   def callback
     @_callback_run = true
@@ -48,7 +61,7 @@ class FileForm < ContactForm
   end
 end
 
-class NullRecipient < MailForm
+class NullRecipient < MailForm::Base
   sender 'my.email@my.domain.com'
 end
 
@@ -56,8 +69,12 @@ class TemplateForm < ContactForm
   template 'custom_template'
 end
 
+class WrongForm < ContactForm
+  template 'does_not_exist'
+end
+
 # Needed to correctly test an uploaded file
-class ActionController::TestUploadedFile
+class Rack::Test::UploadedFile
   def read
     @tempfile.read
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mail_form
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-24 00:00:00 +01:00
+date: 2010-02-07 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -29,11 +29,10 @@ files:
 - Rakefile
 - lib/mail_form.rb
 - lib/mail_form/base.rb
-- lib/mail_form/dsl.rb
-- lib/mail_form/errors.rb
-- lib/mail_form/notifier.rb
+- lib/mail_form/delivery.rb
+- lib/mail_form/shim.rb
 - lib/mail_form/version.rb
-- views/mail_form/notifier/contact.erb
+- lib/views/mail_form/contact.erb
 has_rdoc: true
 homepage: http://github.com/plataformatec/mail_form
 licenses: []
@@ -63,7 +62,6 @@ signing_key:
 specification_version: 3
 summary: Send e-mail straight from forms in Rails with I18n, validations, attachments and request information.
 test_files: 
-- test/base_test.rb
-- test/errors_test.rb
-- test/notifier_test.rb
+- test/mail_form_test.rb
+- test/resource_test.rb
 - test/test_helper.rb

data/lib/mail_form/dsl.rb

@@ -1,171 +0,0 @@
-class MailForm
-  module DSL
-
-    protected
-
-      # Declare your form attributes. All attributes declared here will be appended
-      # to the e-mail, except the ones captcha is true.
-      #
-      # == Options
-      #
-      # * <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.
-      #
-      #   Whenever :validate is a symbol, the method given as symbol will be
-      #   called. You can then 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 :message
-      #     attributes :type
-      #     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
-
-        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)
-        end
-
-        if options[:validate]
-          validations = {}
-          accessors.each{ |a| validations[a] = options[:validate] }
-
-          write_inheritable_hash(:form_validatable, validations)
-        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(:form_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(:form_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(:form_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(:form_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(:form_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(:form_appendable, values)
-      end
-
-  end
-end

data/lib/mail_form/errors.rb

@@ -1,59 +0,0 @@
-# Provides an Errors class similar with ActiveRecord ones.
-#
-#   class ContactForm < MailForm
-#     attributes :name,  :validate => true
-#     attributes :email, :validate => /^([^@]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
-#     attributes :message
-#     attributes :nickname, :captcha => true
-#   end
-#
-# When validating an attribute name as above, it will search for messages in
-# the following order:
-#
-#   mail_form.messages.name
-#   mail_form.messages.blank
-#
-# When validating email, it will search for:
-#
-#   mail_form.messages.name
-#   mail_form.messages.invalid
-#
-# If the message is not available, it will output: "can't be blank" in the first
-# case and "is invalid" in the second.
-#
-class MailForm
-  class Errors < Hash
-
-    def initialize(base, *args)
-      @base = base
-      super(*args)
-    end
-
-    alias :add   :store
-    alias :count :size
-    alias :get   :[]
-
-    def on(attribute)
-      attribute = attribute.to_sym
-      return nil unless get(attribute)
-
-      generate_message_for(attribute, get(attribute))
-    end
-    alias :[] :on
-
-    def full_messages
-      map do |attribute, message|
-        next if message.nil?
-        attribute = attribute.to_sym
-        "#{@base.class.human_attribute_name(attribute)} #{generate_message_for(attribute, message)}"
-      end.compact.reverse
-    end
-
-    protected
-
-      def generate_message_for(attribute, message)
-        I18n.t(attribute, :default => [ message, DEFAULT_MESSAGES[message] ], :scope => [:mail_form, :messages])
-      end
-
-  end
-end

data/lib/mail_form/notifier.rb

@@ -1,48 +0,0 @@
-# This is the class responsable to send the e-mails.
-#
-class MailForm
-  class Notifier < ActionMailer::Base
-
-    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)
-      @template   = get_from_class_and_eval(form, :form_template)
-
-      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
-
-      @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)
-        elsif duck.is_a?(Symbol)
-          form.send(duck)
-        else
-          duck
-        end
-      end
-
-  end
-end