email_form_generator 1.0.0

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0 / 2008-05-21
+* Birthday!
+

data/README.txt

@@ -0,0 +1,124 @@
+=Email Form Generator
+    by Brian Hogan
+    http://www.napcs.com
+
+== DESCRIPTION:
+  
+This generator creates a working contact form with validations and delivery, and provides a method for working with configuration from YML files as well as a mechanism for working with models that don't require a database but still need validations and callbacks.
+
+== Usage:
+
+  ruby script/generate email_form contact
+
+  or
+  ruby script/generate email_form Contact first_name:string last_name:string email:string message:string
+  
+The command generates the following output:
+
+     Your form is ready for use in your application.
+     Before you start the server, fill in the right details into config/config.yml.
+           exists  app/models/
+           exists  app/controllers/
+           exists  app/helpers/
+           create  app/views/contact_forms
+           create  app/views/contact_form_mailer
+           exists  app/views/layouts/
+           exists  test/functional/
+           exists  test/unit/
+           create  app/views/contact_forms/success.html.erb
+           create  app/views/contact_forms/new.html.erb
+           create  app/views/contact_form_mailer/form.html.erb
+           create  app/controllers/contact_forms_controller.rb
+           create  config/config.yml
+           create  config/initializers/config.rb
+           create  app/models/contact_form.rb
+           create  app/models/contact_form_mailer.rb
+           create  app/models/tableless.rb
+           create  test/functional/contact_forms_controller_test.rb
+           create  test/unit/contact_form_mailer_test.rb
+
+Notice that it generates a model called ContactForm with a RESTful resource ContactForms, mapped to a singular resource route (map.resource :contact_form)
+
+Also generates a configuration file and an initializer to make configuring email for various environments a snap and a tableless model is included so you can use validations and form helpers just like you do with regular models.
+
+ 
+ 
+=== Configuration
+When the generator runs, it creates a configuration file called config.yml.  You need to modify this file so that it reflects your settings for your email server.
+
+    development:
+      email:
+        delivery_method: smtp
+        server: smtp.yourdomain.com
+        port: 25
+        domain: yourdomain.com
+        authentication: none
+        username:
+        password: 
+        contact_recipient: admin@yourdomain.com
+    production:
+      email:
+        delivery_method: sendmail
+        contact_recipient: admin@yourdomain.com
+    test:
+      fms_host: localhost:3000
+      disable_google_ads: false
+      email:
+        delivery_method: test
+        contact_recipient: admin@yourdomain.com
+ 
+This file is read by config/initializers/config.rb, where it configures ActionMailer's settings. It should work fine out of the box for most environments.
+
+== Tableless Model
+The Tableless model inherits from ActiveRecord::Base and then removes the
+database functionality from the model.
+
+===Examples of use:
+
+  class Foo < Tableless
+    column :bar, :string
+    validates_presense_of :bar
+  end
+
+  @foo = Foo.new
+  @foo.save  #=> false
+  @foo.bar = "hello"
+  @foo.save #=> true
+
+This concept was inspired by Rick Olson
+ 
+
+== REQUIREMENTS:
+
+* The Mocha gem is required because I use it for testing. Change the tests if you want to use something else.
+* Rails with ActiveRecord
+
+== INSTALL:
+
+* Mac and Linux: sudo gem install email_form_generator
+* Windows: gem install email_form_generator
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Brian Hogan with code from http://dev.rubyonrails.org/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/email_form_generator.rb

@@ -0,0 +1,129 @@
+
+require 'rails_commands'
+class EmailFormGenerator < Rails::Generator::NamedBase
+  default_options :skip_timestamps => false, :skip_migration => false
+ 
+  attr_reader :controller_name,
+                :controller_class_path,
+                :controller_file_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :controller_underscore_name,
+                :controller_singular_name,
+                :controller_plural_name
+  alias_method :controller_file_name, :controller_underscore_name
+  alias_method :controller_table_name, :controller_plural_name
+ 
+  def initialize(runtime_args, runtime_options = {})
+    @original_name = ARGV[0]
+    if ! ARGV[0].downcase.include?("form")
+      ARGV[0] = ARGV[0].underscore + "_form"
+    end
+    super
+   # @name = @name + "_form"
+    
+    @controller_name = @name.pluralize
+ 
+    base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
+    @controller_class_name_without_nesting, @controller_underscore_name, @controller_plural_name = inflect_names(base_name)
+    @controller_singular_name=base_name.singularize
+    if @controller_class_nesting.empty?
+      @controller_class_name = @controller_class_name_without_nesting
+    else
+      @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+    end
+  end
+ 
+  def manifest
+    recorded_session = record do |m|
+      # Check for class naming collisions.
+      m.class_collisions(controller_class_path, "#{controller_class_name}Controller", "#{controller_class_name}Helper")
+      m.class_collisions(class_path, "#{class_name}")
+ 
+      # Controller, helper, views, test and stylesheets directories.
+      m.directory(File.join('app/models', class_path))
+      m.directory(File.join('app/controllers', controller_class_path))
+      m.directory(File.join('app/helpers', controller_class_path))
+      m.directory(File.join('app/views', controller_class_path, controller_file_name))
+      m.directory(File.join('app/views', controller_class_path, file_name + "_mailer"))
+      m.directory(File.join('app/views/layouts', controller_class_path))
+      m.directory(File.join('test/functional', controller_class_path))
+      m.directory(File.join('test/unit', class_path))
+ 
+      for action in scaffold_views
+      m.template(
+          "view_#{action}.html.erb",
+          File.join('app/views', controller_class_path, controller_file_name, "#{action}.html.erb")
+        )
+      end
+     
+      # mailer template
+      m.template(
+          "view_form.html.erb",
+          File.join('app/views', controller_class_path, file_name + "_mailer", "form.html.erb")
+        )
+        
+        
+      m.template(
+        'controller.rb', File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb")
+      )
+      
+      m.template('config.yml', File.join('config', 'config.yml'))
+      m.template('config.rb', File.join('config/initializers', 'config.rb'))
+      
+      m.template(
+        'model.rb', File.join('app/models', "#{file_name}.rb")
+      )
+      
+      m.template(
+        'mailer.rb', File.join('app/models', "#{file_name}_mailer.rb")
+      )
+      
+      m.template(
+        'tableless.rb', File.join('app/models', "tableless.rb"), :collision => :skip
+      )
+      
+      m.template('functional_test.rb', File.join('test/functional', controller_class_path, "#{controller_file_name}_controller_test.rb"))
+      m.template('mailer_test.rb', File.join('test/unit', "#{file_name}_mailer_test.rb"))
+ 
+      m.route_resource  controller_singular_name
+ 
+      action = nil
+      action = $0.split("/")[1]
+      case action
+        when "generate"
+          puts "Your form is ready for use in your application."
+          puts "Before you start the server, fill in the right details into config/config.yml." 
+          
+      end      
+      
+    end
+    
+    recorded_session
+     
+  end
+ 
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} email_form Contact [field:type, field:type]"
+    end
+ 
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--skip-timestamps",
+             "Don't add timestamps to the migration file for this model") { |v| options[:skip_timestamps] = v }
+      opt.on("--skip-migration",
+             "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
+    end
+ 
+    def scaffold_views
+      %w[success new ]
+    end
+ 
+    def model_name
+      class_name.demodulize
+    end
+end

data/lib/email_form.rb

@@ -0,0 +1,6 @@
+#=Email Form Generator
+# Generate a simple "Contact Us" or "Feeback" type form for your app
+# complete with validations and unit/functional tests.
+# 
+# This generator creates a RESTful controller as well, though it uses a singular resource.
+

data/lib/rails_commands.rb

@@ -0,0 +1,31 @@
+# borrowed from restful_authentication
+
+Rails::Generator::Commands::Create.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+
+    logger.route "map.resource #{resource_list}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.resource #{resource_list}\n"
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    look_for = "\n  map.resource #{resource_list}\n"
+    logger.route "map.resource #{resource_list}"
+    gsub_file 'config/routes.rb', /(#{look_for})/mi, ''
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    logger.route "map.resource #{resource_list}"
+  end
+end

data/templates/config.rb

@@ -0,0 +1,25 @@
+c = YAML::load(File.open("#{RAILS_ROOT}/config/config.yml"))
+
+if c[RAILS_ENV]['email']['delivery_method'] == "sendmail"
+   ActionMailer::Base.delivery_method = :sendmail
+
+elsif c[RAILS_ENV]['email']['delivery_method'] == "test"
+      ActionMailer::Base.delivery_method = :test
+else
+  ActionMailer::Base.delivery_method = :smtp
+
+
+  ActionMailer::Base.smtp_settings[:tls] = true   
+  
+  ActionMailer::Base.smtp_settings = {
+    :address  => c[RAILS_ENV]['email']['server'], 
+    :port  => c[RAILS_ENV]['email']['port'], 
+    :domain  => c[RAILS_ENV]['email']['domain'],
+    :authentication => c[RAILS_ENV]['email']['authentication'],
+    :user_name => c[RAILS_ENV]['email']['username'],
+    :password => c[RAILS_ENV]['email']['password']
+  }
+
+end
+
+CONTACT_RECIPIENT = c[RAILS_ENV]['email']['contact_recipient']

data/templates/config.yml

@@ -0,0 +1,20 @@
+development:
+  email:
+    delivery_method: smtp
+    server: smtp.yourdomain.com
+    port: 25
+    domain: yourdomain.com
+    authentication: none
+    username:
+    password: 
+    contact_recipient: admin@yourdomain.com
+production:
+  email:
+    delivery_method: sendmail
+    contact_recipient: admin@yourdomain.com
+test:
+  fms_host: localhost:3000
+  disable_google_ads: false
+  email:
+    delivery_method: test
+    contact_recipient: admin@yourdomain.com

data/templates/controller.rb

@@ -0,0 +1,34 @@
+class <%= controller_class_name %>Controller < ApplicationController
+
+ 
+# GET /<%= table_name %>/new
+# GET /<%= table_name %>/new.xml
+def new
+@<%= file_name %> = <%= class_name %>.new
+ 
+respond_to do |format|
+format.html # new.html.erb
+format.xml { render :xml => @<%= file_name %> }
+end
+end
+ 
+
+# POST /<%= table_name %>
+# POST /<%= table_name %>.xml
+  def create
+    @<%= file_name %> = <%= class_name %>.new(params[:<%= file_name %>])
+ 
+respond_to do |format|
+if @<%= file_name %>.deliver
+        flash[:notice] = 'The message was sent successfully.'
+        format.html { render :action=>"success" }
+format.xml { render :xml => @<%= file_name %>, :status => :created, :location => @<%= file_name %> }
+else
+format.html { render :action => "new" }
+        format.xml { render :xml => @<%= file_name %>.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+ 
+ 
+end

data/templates/functional_test.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require '<%= controller_file_name %>_controller'
+
+# requires mocha gem - gem install mocha
+require 'mocha'
+
+# Re-raise errors caught by the controller.
+class <%= controller_class_name %>Controller; def rescue_action(e) raise e end; end
+
+class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
+
+
+
+  def setup
+    @controller = <%= controller_class_name %>Controller.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.perform_deliveries = false
+    ActionMailer::Base.deliveries = []
+    
+  end
+
+  def test_should_display_form
+    get :new
+    assert_not_nil assigns(:<%= file_name %>)
+    assert_response :success
+  end
+  
+  
+  def test_should_show_success_when_created
+    post :create, {:<%= file_name %> => {}  }
+    assert_response :success
+    assert_template "success"
+  end
+
+  def test_should_fail_to_send_and_show_form_again
+    <%=class_name %>.any_instance.expects(:deliver).returns(false)
+    
+    post :create
+    assert_response :success
+    assert_template "new"
+  end
+
+ 
+end

data/templates/mailer.rb

@@ -0,0 +1,18 @@
+class <%= class_name %>Mailer < ActionMailer::Base
+  def form(<%= file_name %>)
+    setup_email(<%= file_name %>)
+    @subject    += 'Message from the site'
+    @recipients  = CONTACT_RECIPIENT
+
+  end
+  
+
+  
+  protected
+    def setup_email(<%= file_name %>)
+      @from        = "ADMINEMAIL"
+      @subject     = "[YOURSITE] "
+      @sent_on     = Time.now
+      @body[:<%= file_name %>] = <%= file_name %>
+    end
+end

data/templates/mailer_test.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require '<%= file_name %>_mailer'
+
+class <%= class_name %>MailerTest < Test::Unit::TestCase
+
+
+  def setup
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.perform_deliveries = true
+    ActionMailer::Base.deliveries = []
+
+
+  end
+
+  def test_deliver_form
+    @f = <%=class_name %>.new
+    
+    <% attributes.each do |attribute| %>
+       @f.<%=attribute.name %> = "foo"
+    <% end %>
+    
+    <%=class_name%>Mailer::deliver_form(@f)
+    assert_equal 1, ActionMailer::Base.deliveries.length
+    
+  end
+
+
+end

data/templates/model.rb

@@ -0,0 +1,21 @@
+class <%= class_name %> < Tableless
+  <% for attribute in attributes -%>
+  <%= "column :#{attribute.name}, :#{attribute.type}" %>
+  <% end -%>
+  
+  
+  def deliver
+    if valid?
+      begin
+        <%= class_name %>Mailer::deliver_form(self)
+      rescue
+         @errors.add_to_base "Your message could not be sent due to configuration issues with the server."
+         return false
+      end
+    else
+      return false
+    end
+  end
+  
+  
+end

data/templates/tableless.rb

@@ -0,0 +1,30 @@
+#=Tableless
+#
+# The Tableless model inherits from ActiveRecord::Base and then removes the
+# database functionality from the model.
+# 
+#==Examples of use:
+#
+# class Foo < Tableless
+#   column :bar, :string
+#   validates_presense_of :bar
+# end
+#
+# @foo = Foo.new
+# @foo.save  #=> false
+# @foo.bar = "hello"
+# @foo.save #=> true
+#
+# This concept was inspired by Rick Olson
+class Tableless < ActiveRecord::Base
+  def self.columns() @columns ||= []; end
+  def self.column(name, sql_type = nil, default = nil, null = true)
+    columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default,
+    sql_type.to_s, null)
+  end
+  
+  # override the save method to prevent exceptions.
+  def save(validate = true)
+    validate ? valid? : true
+  end
+end

data/templates/unit_test.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+
+  def test_should_deliver_message
+    
+    @f = <%=class_name %>.new
+    
+    <% attributes.each do |attribute| %>
+    @f.<%=attribute.name %> = "foo"
+    <% end %>
+    
+    assert @f.deliver
+  end
+  
+  # modify this test in such a way as to cause the 
+  # validations to fail, if you have any.
+  def test_should_not_deliver_message
+    
+    @f = <%=class_name %>.new
+    assert ! @f.deliver
+    
+  end
+
+
+end

data/templates/view_form.html.erb

@@ -0,0 +1,3 @@
+<% for attribute in attributes -%>   
+   <%%= @<%= singular_name %>.<%=attribute.name%> %>
+<% end %>

data/templates/view_new.html.erb

@@ -0,0 +1,17 @@
+
+<%% form_for(@<%= singular_name %>, :url=><%= singular_name %>_url ) do |f| %>
+  <%%= f.error_messages :header_message=>"Please try again", :message=> "We couldn't process your email form for the following reasons:" %>
+ 
+<% for attribute in attributes -%>
+  <p>
+    <%%= f.label :<%= attribute.name %> %><br />
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+  </p>
+<% end -%>
+  <p>
+    <%%= f.submit "Send" %>
+  </p>
+<%% end %>
+
+
+

data/templates/view_success.html.erb

@@ -0,0 +1,3 @@
+<h1>Your message has been sent to the site administrator. </h1>
+
+

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: email_form_generator
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Brian Hogan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-21 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Generates a feedback form with model, controller, and views to make it dead simple for your users to send messages to you.
+email: info@napcs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+- History.txt
+files: 
+- README.txt
+- History.txt
+- email_form_generator.rb
+- lib/rails_commands.rb
+- lib/email_form.rb
+- templates/config.rb
+- templates/config.yml
+- templates/controller.rb
+- templates/functional_test.rb
+- templates/mailer_test.rb
+- templates/mailer.rb
+- templates/model.rb
+- templates/tableless.rb
+- templates/unit_test.rb
+- templates/view_form.html.erb
+- templates/view_new.html.erb
+- templates/view_success.html.erb
+has_rdoc: true
+homepage: This generator creates a working contact form with validations and delivery, and provides a method for working with configuration from YML files as well as a mechanism for working with models that don't require a database but still need validations and callbacks.
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: emailform
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Email form generation with model, controller, tests, and mailer.
+test_files: 
+- test/test_scaffold_form.rb