contact_us 0.0.1 → 0.0.2

data/README.md

@@ -2,29 +2,35 @@
 
 A Rails 3 Engine providing a basic contact form.  I used Formtastic to keep things simple, and to hook into your apps custom Formtastic stylesheets.
 
-REQUIREMENTS
-------------
+## REQUIREMENTS
+
 Contact Us requires the Formtastic Gem.  Read more about Formtastic @ https://github.com/justinfrench/formtastic
 
-INSTALL
--------
+## INSTALLATION
+
 In your `Gemfile`, add the following dependencies:
+
     gem 'formtastic'
     gem 'contact_us'
-Run:
+
+From `Rails.root` run:
+
     $ bundle install
+    $ rake contact_us:install
+    
+Modify the installed initializer's mailer to settings to use your own email address.
+
+## CONFIGURATION
+
+The installation generator creates the `contact_us.rb` initializer within your apps `config/initializers` directory.
 
-CONFIGURATION
--------------
+Modify the mailer to setting to be where you would like to send the contact form emails.
 
-# Usage
+The generator has also copied the view files to `app/views/contact_us`, and you can customize them to suit your needs.
 
-# TODO
+## TODO
 
-* config option for contact email
-* install generator to copy views
-* finish readme documentation
 * 100% test coverage
 * i18n
 
-Copyright (c) 2011 Jeff Dutil, released under the MIT license.
+Copyright (c) 2011 Jeff Dutil, released under the MIT license.

data/app/helpers/contact_us/contacts_helper.rb

@@ -1,5 +1,2 @@
 module ContactUs::ContactsHelper
-  def clear_div
-    %Q{<div style="clear: both; height: 0px; line-height: 0px;" class="clear">&nbsp;</div>}.html_safe
-  end
 end

data/app/mailers/contact_us/contact_mailer.rb

@@ -1,9 +1,9 @@
 class ContactUs::ContactMailer < ActionMailer::Base
   def contact_email(contact)
     @message = contact.message
-    
-    mail(:to => "contact@YOUR-SITE.com",
+
+    mail :from    => contact.email,
          :subject => "Contact Us message from #{contact.email}",
-         :from => contact.email)
+         :to      => ContactUs.mailer_to
   end
 end

data/app/views/contact_us/contact_mailer/contact_email.text.html.erb

@@ -0,0 +1,3 @@
+<p><%= @message %><p>
+<p>---------------------</p>
+<p>Sent by contact form.</p>

data/app/views/contact_us/contact_mailer/contact_email.text.plain.erb

@@ -0,0 +1,4 @@
+<%= @message %>
+
+-------------------------------------
+Sent by contact form.

data/config/locales/{en.yml → contact_us.en.yml}

@@ -2,4 +2,5 @@
 # See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
 
 en:
-  hello: "Hello world"
+  contact_us:
+    sent_by: "Sent by "

data/lib/contact_us.rb

@@ -1,3 +1,13 @@
 module ContactUs
   require 'contact_us/engine'
+  
+  # Address which sends Devise e-mails.
+  mattr_accessor :mailer_to
+
+  # Default way to setup ContactUs. Run rake contact_us:install to create
+  # a fresh initializer with all configuration values.
+  def self.setup
+    yield self
+  end
+
 end

data/lib/contact_us/version.rb

@@ -1,3 +1,3 @@
 module ContactUs
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/tasks/install.rake

@@ -0,0 +1,59 @@
+require 'rails/generators'
+
+namespace :contact_us do
+  desc "Install ContactUs"
+  task :install do
+    gem_path = __FILE__
+    gem_path = gem_path.split("/")
+
+    gem_path = gem_path[0..-4]
+    gem_path = gem_path.join("/")
+
+    Rails::Generators::Base.source_root(gem_path)
+    copier = Rails::Generators::Base.new
+
+    unless File.exists?(Rails.root.join("config/initializers/contact_us.rb"))
+      print "Now copying initializer!\n"
+
+      locales_path = gem_path + "/lib/templates/*"
+      app_path = Rails.root.join("config/initializers")
+      unless File.directory?(app_path)
+        app_path.mkdir
+      end
+      Dir.glob(locales_path).each do |file|
+        copier.copy_file file, File.join(app_path, File.basename(file))
+      end
+    end
+    
+    print "Now copying locales files!\n"
+
+    locales_path = gem_path + "/config/locales/*.yml"
+    app_path = Rails.root.join("config/locales")
+    unless File.directory?(app_path)
+      app_path.mkdir
+    end
+    Dir.glob(locales_path).each do |file|
+      copier.copy_file file, File.join(app_path, File.basename(file))
+    end
+
+    print "Now copying view files for customization!\n"
+
+    locales_path = gem_path + "/app/views/contact_us/contact_mailer/*"
+    app_path = Rails.root.join("app/views/contact_us/contact_mailer")
+    unless File.directory?(app_path)
+      app_path.mkdir
+    end
+    Dir.glob(locales_path).each do |file|
+      copier.copy_file file, File.join(app_path, File.basename(file))
+    end
+    
+    locales_path = gem_path + "/app/views/contact_us/contacts/*"
+    app_path = Rails.root.join("app/views/contact_us/contacts")
+    unless File.directory?(app_path)
+      app_path.mkdir
+    end
+    Dir.glob(locales_path).each do |file|
+      copier.copy_file file, File.join(app_path, File.basename(file))
+    end    
+  end
+end

data/lib/templates/contact_us.rb

@@ -0,0 +1,6 @@
+# Use this hook to configure contact mailer.
+ContactUs.setup do |config|
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in ContactMailer.
+  config.mailer_to = "contact@please-change-me.com"
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: contact_us
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jeff Dutil
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-03 00:00:00 -04:00
+date: 2011-05-04 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -38,14 +38,17 @@ files:
 - app/helpers/contact_us/contacts_helper.rb
 - app/mailers/contact_us/contact_mailer.rb
 - app/models/contact_us/contact.rb
-- app/views/contact_us/contact_mailer/contact.html.erb
+- app/views/contact_us/contact_mailer/contact_email.text.html.erb
+- app/views/contact_us/contact_mailer/contact_email.text.plain.erb
 - app/views/contact_us/contacts/new.html.erb
-- config/locales/en.yml
+- config/locales/contact_us.en.yml
 - config/routes.rb
 - contact_us.gemspec
 - lib/contact_us.rb
 - lib/contact_us/engine.rb
 - lib/contact_us/version.rb
+- lib/tasks/install.rake
+- lib/templates/contact_us.rb
 has_rdoc: true
 homepage: https://github.com/jdutil/contact_us
 licenses: []

data/app/views/contact_us/contact_mailer/contact.html.erb

@@ -1,3 +0,0 @@
-<p><%= @message %><p>
-<p>-------------------------------------</p>
-<p>Sent by BurlingtonWebApps.com contact form.</p>