contact_us 0.3.0 → 0.4.0.beta

data/README.md

@@ -12,18 +12,18 @@ There is also a demo application showing how the ContactUs form works:
 
 ## REQUIREMENTS
 
-Contact Us requires the Formtastic Gem.  Read more about Formtastic @ https://github.com/justinfrench/formtastic
+Contact Us requires:
 
-I used Formtastic as a dependency to keep things simple, and hook into your apps custom Formtastic stylesheets.
-People have different tastes for their html / css markup, and I find Formtastic to be a great standardized and reusable way to build forms across apps.
+* Ruby >= 1.8.7 (will soon only support > 1.9.2)
+* Rails >= 3.0.0
 
-If you don't want to have Formtastic as a dependency there is a fork of this project without it [here](https://github.com/sch1zo/contact_us).
+It is also recommended to use Formtastic or SimpleForm (see configuration) in order to hook into your apps custom form builders.
 
 ## INSTALLATION
 
 In your `Gemfile`, add the following dependencies:
 
-    gem 'contact_us', '~> 0.3.0'
+    gem 'contact_us', '~> 0.4.0.beta'
 
 From `Rails.root` run:
 
@@ -43,6 +43,30 @@ You may also specify an email address for the notification emails from field:
 
     config.mailer_from = "dontreply@yourdomain.com"
 
+## CONFIGURATION
+
+The generator copies the view files to `app/views/contact_us`, and you can customize them to suit your needs.  If you would like to add a name or subject field to the form you may simply
+set the options to true within the contact_us initializer located at `config/initializers/contact_us.rb`:
+
+    config.require_name = true
+    config.require_subject = true
+
+You may also update your locales under `config/locales/contact_us.en.yml` or create your own.  Please feel free to submit your own locales so that other users will hopefully find this gem more useful.
+
+### Formtastic
+
+In order to use a Formtastic compatible template to hook into your custom form styles configure `config/initializers/contact_us.rb`:
+
+    config.form_gem = 'formtastic'
+
+* By default the HTML should match that produced by Formtastic, but to ensure it is up to date you should set Formtastic.
+
+### SimpleForm
+
+In order to use a SimpleForm compatible template to hook into your custom form styles configure `config/initializers/contact_us.rb`:
+
+    config.form_gem = 'simple_form'
+
 ## UPGRADING
 
 When upgrading from 0.1.x to 0.2.x you should rerun the install generator to install the new settings, views, and locale updates:
@@ -54,16 +78,6 @@ Or you may run the generators for each specific component you would like to upda
     $ bundle exec rake contact_us:copy_locales
     $ bundle exec rake contact_us:copy_views
 
-## CONFIGURATION
-
-The generator copies the view files to `app/views/contact_us`, and you can customize them to suit your needs.  If you would like to add a name or subject field to the form you may simply
-set the options to true within the contact_us initializer located at `config/initializers/contact_us.rb`:
-
-    config.require_name = true
-    config.require_subject = true
-
-You may also update your locales under `config/locales/contact_us.en.yml` or create your own.  Please feel free to submit your own locales so that other users will hopefully find this gem more useful.
-
 ## USAGE
 
 Visit your website and navigate to `/contact-us` to see the form in action.
@@ -97,6 +111,7 @@ Here are some ways *you* can contribute:
 
 ## TODO
 
-* Add new language translations
+* Add new language translations.
+* Stop copying views/locales by default.
 
 Copyright (c) 2011 Jeff Dutil, released under the [MIT license](https://github.com/jdutil/contact_us/tree/master/MIT-LICENSE).

data/app/controllers/contact_us/contacts_controller.rb

@@ -7,12 +7,24 @@ class ContactUs::ContactsController < ApplicationController
       redirect_to('/', :notice => t('contact_us.notices.success'))
     else
       flash[:error] = t('contact_us.notices.error')
-      render :new
+      render_new_page
     end
   end
 
   def new
     @contact = ContactUs::Contact.new
+    render_new_page
   end
 
+  protected
+
+    def render_new_page
+      case ContactUs.form_gem
+      when 'formtastic'  then render 'new_formtastic'
+      when 'simple_form' then render 'new_simple_form'
+      else
+        render 'new'
+      end
+    end
+
 end

data/app/views/contact_us/contacts/new.html.erb

@@ -1,8 +1,38 @@
 <h2><%= t('.contact_us') %></h2>
-<%= semantic_form_for @contact, :url => contacts_path do |f| %>
-  <%= f.input :name, :label => t('.name') if ContactUs.require_name %>
-  <%= f.input :email, :label => t('.email') %>
-  <%= f.input :subject, :label => t('.subject') if ContactUs.require_subject %>
-  <%= f.input :message, :as => :text, :label => t('.message') %>
-  <%= f.action :submit, :label => t('.submit'), :button_html => { :alt => t('.submit'), :id => 'contact_us_contact_submit', :title => t('.submit') } %>
+<%= form_for @contact, :url => contacts_path, :html => {:class => 'formtastic'} do |f| %>
+  <% if ContactUs.require_name %>
+    <li class='string required' id='contact_us_contact_name_input'>
+      <%= f.label :name, (t('.name') + content_tag(:abbr, '*', :class => 'required')).html_safe %>
+      <%= f.text_field :name %>
+      <% if f.object.errors[:name].present? %>
+        <p class='inline-error'><%= f.object.errors[:name].join(' and ') %></p>
+      <% end %>
+    </li>
+  <% end %>
+  <li class='string required' id='contact_us_contact_email_input'>
+    <%= f.label :email, (t('.email') + content_tag(:abbr, '*', :class => 'required')).html_safe %>
+    <%= f.text_field :email %>
+    <% if f.object.errors[:email].present? %>
+      <p class='inline-error'><%= f.object.errors[:email].join(' and ') %></p>
+    <% end %>
+  </li>
+  <% if ContactUs.require_subject %>
+    <li class='string required' id='contact_us_contact_subject_input'>
+      <%= f.label :subject, (t('.subject') + content_tag(:abbr, '*', :class => 'required')).html_safe %>
+      <%= f.text_field :subject %>
+      <% if f.object.errors[:subject].present? %>
+        <p class='inline-error'><%= f.object.errors[:subject].join(' and ') %></p>
+      <% end %>
+    </li>
+  <% end %>
+  <li class='text required' id='contact_us_contact_message_input'>
+    <%= f.label :message, (t('.message') + content_tag(:abbr, '*', :class => 'required')).html_safe %>
+    <%= f.text_area :message %>
+    <% if f.object.errors[:message].present? %>
+      <p class='inline-error'><%= f.object.errors[:message].join(' and ') %></p>
+    <% end %>
+  </li>
+  <li class='commit'>
+    <%= f.submit :submit, :alt => t('.submit'), :class => 'submit create', :label => t('.submit'), :title => t('.submit') %>
+  </li>
 <% end %>

data/app/views/contact_us/contacts/new_formtastic.html.erb

@@ -0,0 +1,8 @@
+<h2><%= t('.contact_us') %></h2>
+<%= semantic_form_for @contact, :url => contacts_path do |f| %>
+  <%= f.input :name, :label => t('.name') if ContactUs.require_name %>
+  <%= f.input :email, :label => t('.email') %>
+  <%= f.input :subject, :label => t('.subject') if ContactUs.require_subject %>
+  <%= f.input :message, :as => :text, :label => t('.message') %>
+  <%= f.action :submit, :label => t('.submit'), :button_html => { :alt => t('.submit'), :id => 'contact_us_contact_submit', :title => t('.submit') } %>
+<% end %>

data/app/views/contact_us/contacts/new_simple_form.html.erb

@@ -0,0 +1,8 @@
+<h2><%= t('.contact_us') %></h2>
+<%= simple_form_for @contact, :url => contacts_path do |f| %>
+  <%= f.input :name, :label => t('.name') if ContactUs.require_name %>
+  <%= f.input :email, :label => t('.email') %>
+  <%= f.input :subject, :label => t('.subject') if ContactUs.require_subject %>
+  <%= f.input :message, :as => :text, :label => t('.message') %>
+  <%= f.button :submit, :label => t('.submit'), :button_html => { :alt => t('.submit'), :id => 'contact_us_contact_submit', :title => t('.submit') } %>
+<% end %>

data/config/locales/contact_us.de.yml

@@ -9,13 +9,17 @@ de:
         sent_by_name: "Sent by %{name} from %{email}"
         subject: "Contact Us message from %{email}"
     contacts:
-      new:
+      new: &new
         contact_us: "Kontaktiere Uns"
         email: "Email"
         message: "Nachricht"
         name: "Name"
         subject: "Subject"
         submit: "Abschicken"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
     notices:
       error: "Beide Felder müssen ausgefüllt werden."
       success: "Die Nachricht wurde erfolgreich versendet."

data/config/locales/contact_us.en.yml

@@ -9,13 +9,17 @@ en:
         sent_by_name: "Sent by %{name} from %{email}"
         subject: "Contact Us message from %{email}"
     contacts:
-      new:
+      new: &new
         contact_us: "Contact Us"
         email: "Email"
         message: "Message"
         name: "Name"
         subject: "Subject"
         submit: "Submit"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
     notices:
       error: "You must enter both fields."
       success: "Contact email was successfully sent."

data/config/locales/contact_us.es.yml

@@ -9,13 +9,17 @@ es:
         sent_by_name: "Sent by %{name} from %{email}"
         subject: "Contact Us message from %{email}"
     contacts:
-      new:
+      new: &new
         contact_us: "Contactanos"
         email: "Email"
         message: "Mensaje"
         name: "Name"
         subject: "Subject"
         submit: "Enviar"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
     notices:
       error: "Debes de ingresar ambos campos."
       success: "El correo electrónico de contacto fue enviado con éxito."

data/config/locales/contact_us.it.yml

@@ -9,13 +9,17 @@ it:
         sent_by_name: "Sent by %{name} from %{email}"
         subject: "Contact Us message from %{email}"
     contacts:
-      new:
+      new: &new
         contact_us: "Contattaci"
         email: "Email"
         message: "Messaggio"
         name: "Name"
         subject: "Subject"
         submit: "Inviare"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
     notices:
       error: "Devi inserire entrambi i campi."
       success: "La mail di contatto è stata inviata."

data/config/locales/contact_us.pt-BR.yml

@@ -9,13 +9,17 @@ pt-BR:
         sent_by_name: "Sent by %{name} from %{email}"
         subject: "Contact Us message from %{email}"
     contacts:
-      new:
+      new: &new
         contact_us: "Contate-nos"
         email: "Email"
         message: "Messagem"
         name: "Name"
         subject: "Subject"
         submit: "Enviar"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
     notices:
       error: "Você deve preencher os campos."
       success: "Email de contato foi enviado com sucesso."

data/config/locales/contact_us.zh.yml

@@ -9,13 +9,17 @@ zh:
         sent_by_name: "Sent by %{name} from %{email}"
         subject: "Contact Us message from %{email}"
     contacts:
-      new:
+      new: &new
         contact_us: "联系我们"
         email: "邮箱"
         message: "消息"
         name: "Name"
         subject: "Subject"
         submit: "发送"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
     notices:
       error: "请正确输入邮箱与信息。"
       success: "邮件已成功发送。"

data/lib/contact_us/version.rb

@@ -1,3 +1,3 @@
 module ContactUs
-  VERSION = "0.3.0"
+  VERSION = "0.4.0.beta"
 end

data/lib/contact_us.rb

@@ -13,6 +13,9 @@ module ContactUs
   # Enable or Disable subject field.
   mattr_accessor :require_subject
 
+  # Formtastic or SimpleForm
+  mattr_accessor :form_gem
+
   # Default way to setup ContactUs. Run rake contact_us:install to create
   # a fresh initializer with all configuration values.
   def self.setup

data/lib/templates/contact_us.rb

@@ -19,4 +19,9 @@ ContactUs.setup do |config|
   # Configure the form to ask for a subject.
   config.require_subject = false
 
+  # Configure the form gem to use.
+  # Example:
+  # config.form_gem = 'formtastic
+  config.form_gem = nil
+
 end

data/spec/dummy/config/locales/contact_us.de.yml

@@ -9,13 +9,17 @@ de:
         sent_by_name: "Sent by %{name} from %{email}"
         subject: "Contact Us message from %{email}"
     contacts:
-      new:
+      new: &new
         contact_us: "Kontaktiere Uns"
         email: "Email"
         message: "Nachricht"
         name: "Name"
         subject: "Subject"
         submit: "Abschicken"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
     notices:
       error: "Beide Felder müssen ausgefüllt werden."
       success: "Die Nachricht wurde erfolgreich versendet."

data/spec/dummy/config/locales/contact_us.es.yml

@@ -9,13 +9,17 @@ es:
         sent_by_name: "Sent by %{name} from %{email}"
         subject: "Contact Us message from %{email}"
     contacts:
-      new:
+      new: &new
         contact_us: "Contactanos"
         email: "Email"
         message: "Mensaje"
         name: "Name"
         subject: "Subject"
         submit: "Enviar"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
     notices:
       error: "Debes de ingresar ambos campos."
       success: "El correo electrónico de contacto fue enviado con éxito."

data/spec/dummy/config/locales/contact_us.it.yml

@@ -9,13 +9,17 @@ it:
         sent_by_name: "Sent by %{name} from %{email}"
         subject: "Contact Us message from %{email}"
     contacts:
-      new:
+      new: &new
         contact_us: "Contattaci"
         email: "Email"
         message: "Messaggio"
         name: "Name"
         subject: "Subject"
         submit: "Inviare"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
     notices:
       error: "Devi inserire entrambi i campi."
       success: "La mail di contatto è stata inviata."

data/spec/dummy/config/locales/contact_us.pt-BR.yml

@@ -9,13 +9,17 @@ pt-BR:
         sent_by_name: "Sent by %{name} from %{email}"
         subject: "Contact Us message from %{email}"
     contacts:
-      new:
+      new: &new
         contact_us: "Contate-nos"
         email: "Email"
         message: "Messagem"
         name: "Name"
         subject: "Subject"
         submit: "Enviar"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
     notices:
       error: "Você deve preencher os campos."
       success: "Email de contato foi enviado com sucesso."

data/spec/dummy/config/locales/contact_us.zh.yml

@@ -9,13 +9,17 @@ zh:
         sent_by_name: "Sent by %{name} from %{email}"
         subject: "Contact Us message from %{email}"
     contacts:
-      new:
+      new: &new
         contact_us: "联系我们"
         email: "邮箱"
         message: "消息"
         name: "Name"
         subject: "Subject"
         submit: "发送"
+      new_formtastic:
+        <<: *new
+      new_simple_form:
+        <<: *new
     notices:
       error: "请正确输入邮箱与信息。"
       success: "邮件已成功发送。"