josevalim-simple_form 0.2.1 → 0.3.1

data/CHANGELOG

@@ -1,6 +1,10 @@
-# Version 0.2
+# Version 0.3
 
+* Added support to symbols on :sender, :subject and :recipients
 * Added support to symbols on :validate
+
+# Version 0.2
+
 * Added support to request objects and append DSL
 * Added support to :attachments (thanks to @andrewtimberlake)
 

data/README

@@ -1,6 +1,6 @@
 Simple Form
 License: MIT
-Version: 0.2.1
+Version: 0.3.1
 
 You can also read this README in pretty html at the GitHub project Wiki page:
 
@@ -121,31 +121,40 @@ Examples:
    # save is an alias to deliver to allow it to work with InheritedResources
    c.save #=> true
 
-== subject(string=nil, &block)
+== subject(string_or_symbol_or_block)
 
-Declares the subject of the contact email. It can be a string or a proc.
-As a proc, it receives a simple form instance. When not specified, it defaults
+Declares the subject of the contact email. 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. It defaults
 to the class human name.
 
    subject "My Contact Form"
-   subject {|c| "Contacted by #{c.name}"}
+   subject { |c| "Contacted by #{c.name}" }
+
+== sender(string_or_symbol_or_block)
 
-== sender(&block)
+Declares contact email sender. It can be a string or a proc or a symbol.
 
-Declares contact email sender. It can be a string or a proc.
-As a proc, it receives a simple form instance. By default is:
+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 SimpleForm object have at least an email attribute.
+This requires that your SimpleForm object have an email attribute.
 
-== headers(hash)
+== recipients(string_or_array_or_symbol_or_block)
 
-Additional headers to your e-mail.
+Who will receive the e-mail. Can be a string or array or a symbol or a proc.
 
-== recipients(string_or_array_or_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.
 
-Who will receive the e-mail. Can be a string or array, or a proc that returns one of them.
+Both the proc and the symbol must return a string or an array. By default is nil.
+
+== headers(hash)
+
+Additional headers to your e-mail.
 
 I18n
 ----

data/lib/simple_form/dsl.rb

@@ -60,9 +60,11 @@ class SimpleForm
       end
       alias :attributes :attribute
 
-      # Declares the subject of the contact email. It can be a string or a proc.
-      # As a proc, it receives a simple form instance. When not specified, it
-      # defaults to the class human name.
+      # 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
       #
@@ -70,53 +72,62 @@ class SimpleForm
       #     subject "My Contact Form"
       #   end
       #
-      def subject(string=nil, &block)
-        write_inheritable_attribute(:form_subject, string || block)
+      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.
-      # As a proc, it receives a simple form instance. By default is:
+      # 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 SimpleForm object have at least an email attribute.
+      # This requires that your SimpleForm object have an email attribute.
       #
       # == Examples
       #
       #   class ContactForm < SimpleForm
       #     # Change sender to include also the name
-      #     sender{|c| %{"#{c.name}" <#{c.email}>} }
+      #     sender { |c| %{"#{c.name}" <#{c.email}>} }
       #   end
       #
-      def sender(string=nil, &block)
-        write_inheritable_attribute(:form_sender, string || block)
+      def sender(duck=nil, &block)
+        write_inheritable_attribute(:form_sender, duck || block)
       end
       alias :from :sender
 
-      # Additional headers to your e-mail.
+      # 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 < SimpleForm
-      #     headers { :content_type => 'text/html' }
+      #     recipients [ "first.manager@domain.com", "second.manager@domain.com" ]
       #   end
       #
-      def headers(hash)
-        write_inheritable_hash(:form_headers, hash)
+      def recipients(duck=nil, &block)
+        write_inheritable_attribute(:form_recipients, duck || block)
       end
+      alias :to :recipients
 
-      # Who will receive the e-mail. Can be a string or array.
+      # Additional headers to your e-mail.
       #
       # == Examples
       #
       #   class ContactForm < SimpleForm
-      #     recipients "jose.valim@gmail.com"
+      #     headers { :content_type => 'text/html' }
       #   end
       #
-      def recipients(string_or_array_or_proc)
-        write_inheritable_attribute(:form_recipients, string_or_array_or_proc)
+      def headers(hash)
+        write_inheritable_hash(:form_headers, hash)
       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:

data/lib/simple_form/notifier.rb

@@ -36,6 +36,8 @@ class SimpleForm
 
         if duck.is_a?(Proc)
           duck.call(form)
+        elsif duck.is_a?(Symbol)
+          form.send(duck)
         else
           duck
         end

data/test/notifier_test.rb

@@ -9,7 +9,7 @@ class SimpleFormNotifierTest < ActiveSupport::TestCase
     @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'))
+    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 = []
@@ -51,6 +51,11 @@ class SimpleFormNotifierTest < ActiveSupport::TestCase
     assert_equal ['my.first@email.com', 'my.second@email.com'], ActionMailer::Base.deliveries.first.to
   end
 
+  def test_recipients_is_a_symbold
+    @with_file.deliver
+    assert_equal ['contact_file@my.domain.com'], ActionMailer::Base.deliveries.first.to
+  end
+
   def test_headers_is_a_hash
     @advanced.deliver
     assert_equal '<mypath>', ActionMailer::Base.deliveries.first.header['return-path'].to_s

data/test/test_file.txt

@@ -0,0 +1 @@
+A test file

data/test/test_helper.rb

@@ -37,13 +37,22 @@ end
 
 class FileForm < ContactForm
   attribute :file, :attachment => true, :validate => true
+  recipients :set_recipient
+
+  def set_recipient
+    if file
+      "contact_file@my.domain.com"
+    else
+      "contact@my.domain.com"
+    end
+  end
 end
 
 class NullRecipient < SimpleForm
   sender 'my.email@my.domain.com'
 end
 
-#Needed to correctly test an uploaded file
+# Needed to correctly test an uploaded file
 class ActionController::TestUploadedFile
   def read
     @tempfile.read

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: josevalim-simple_form
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-15 00:00:00 -07:00
+date: 2009-05-23 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -64,4 +64,5 @@ test_files:
 - test/base_test.rb
 - test/errors_test.rb
 - test/notifier_test.rb
+- test/test_file.txt
 - test/test_helper.rb