email_form_generator 1.0.4 → 1.0.5

data/History.txt

@@ -1,3 +1,8 @@
+
+== 1.0.5 / 2009-07-20
+ * Fixed bug where help screen would not show due to bad parsing of the arguments
+ * RSpec option (--spec)
+ * renamed email_config.rb to email.rb
 == 1.0.4 / 2009-07-03
  * Tests updated for Rails 2.3x
  * Fixed broken generator.

data/README.rdoc

@@ -41,8 +41,12 @@ Notice that it generates a model called ContactForm with a RESTful resource Cont
 
 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.
 
- 
- 
+=== RSpec support
+
+If you prefer to have specs instead of tests, use the --spec flag.
+
+  ruby script/generate email_form Contact first_name:string last_name:string email:string message:string --spec
+
 === Configuration
 When the generator runs, it creates a configuration file called email.yml.  You need to modify this file so that it reflects your settings for your email server.
 
@@ -92,6 +96,7 @@ 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.
+* If you're using RSpec and you want to use the tests generated, you need to enable Mocha's mocking, or change the mock lines to use RSpec's mocking instead.
 * Rails 2.x with ActiveRecord
 
 == INSTALL:

data/email_form_generator.rb

@@ -17,8 +17,10 @@ class EmailFormGenerator < Rails::Generator::NamedBase
  
   def initialize(runtime_args, runtime_options = {})
     @original_name = ARGV[0]
-    if ! ARGV[0].downcase.include?("form")
-      ARGV[0] = ARGV[0].underscore + "_form"
+    if ARGV[0]
+      if ! ARGV[0].downcase.include?("form")
+        ARGV[0] = ARGV[0].underscore + "_form"
+      end
     end
     super
     
@@ -47,8 +49,7 @@ class EmailFormGenerator < Rails::Generator::NamedBase
       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(
@@ -73,7 +74,7 @@ class EmailFormGenerator < Rails::Generator::NamedBase
         'tableless.rb', File.join('app/models', "tableless.rb"), :collision => :skip
       )
       m.template('config.yml', File.join('config', 'email.yml'), :collision => :skip)
-      m.template('config.rb', File.join('config/initializers', 'email_config.rb'), :collision => :skip)
+      m.template('config.rb', File.join('config/initializers', 'email.rb'), :collision => :skip)
       
       m.template(
         'model.rb', File.join('app/models', "#{file_name}.rb")
@@ -83,10 +84,22 @@ class EmailFormGenerator < Rails::Generator::NamedBase
         'mailer.rb', File.join('app/models', "#{file_name}_mailer.rb")
       )
       
-
-      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"))
- 
+      unless options[:rspec]
+        m.directory(File.join('test/functional', controller_class_path))
+        m.directory(File.join('test/unit', class_path))
+        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.template('unit_test.rb', File.join('test/unit', "#{file_name}_test.rb"))
+        
+      else
+        m.directory(File.join('spec/controllers', controller_class_path))
+        m.directory(File.join('spec/models', class_path))
+        m.template('controller_spec.rb', File.join('spec/controllers', controller_class_path, "#{controller_file_name}_controller_spec.rb"))
+        m.template('mailer_spec.rb', File.join('spec/models', "#{file_name}_mailer_spec.rb"))
+        m.template('model_spec.rb', File.join('spec/models', "#{file_name}_spec.rb"))
+      
+      end
+      
       m.route_resource  controller_singular_name
  
       action = nil
@@ -94,7 +107,7 @@ class EmailFormGenerator < Rails::Generator::NamedBase
       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." 
+          puts "Before you start the server, fill in the right details into config/email.yml." 
           
       end      
       
@@ -107,7 +120,7 @@ class EmailFormGenerator < Rails::Generator::NamedBase
   protected
     
     def ran_before?
-    options[:rspec] || (File.exist?('app/models/tableless.rb'))
+      (File.exist?('app/models/tableless.rb'))
     end
     
     # Override with your own usage banner.
@@ -118,6 +131,7 @@ class EmailFormGenerator < Rails::Generator::NamedBase
     def add_options!(opt)
       opt.separator ''
       opt.separator 'Options:'
+      opt.on("--spec", "Generate specs instead of test:unit files") {|v| options[:rspec] = v }
       opt.on("--skip-timestamps",
              "Don't add timestamps to the migration file for this model") { |v| options[:skip_timestamps] = v }
       opt.on("--skip-migration",

data/templates/controller_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe <%= controller_class_name %>Controller do
+  integrate_views
+  
+  it "should display the form" do
+    get :new
+    assigns(:<%= file_name %>).should_not be_nil
+    response.should render_template(:new)
+  end
+  
+  it "Should display the success page when an email is sent" do
+    <%=class_name %>.any_instance.expects(:deliver).returns(true)
+    post :create, {:<%= file_name %> => {}  }
+    response.should render_template(:success)
+  end
+
+  it "should show the new page again" do
+    <%=class_name %>.any_instance.expects(:deliver).returns(false)
+    post :create
+    response.should render_template(:new)
+  end
+end

data/templates/functional_test.rb

@@ -2,29 +2,22 @@ require File.dirname(__FILE__) + '/../test_helper'
 
 class <%= controller_class_name %>ControllerTest < ActionController::TestCase
 
-  def setup
-    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
+    assert_template("new")
   end
   
   def test_should_show_success_when_created
     <%=class_name %>.any_instance.expects(:deliver).returns(true)
     post :create, {:<%= file_name %> => {}  }
-    assert_response :success
-    assert_template "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"
+    assert_template("new")
   end
 end

data/templates/mailer_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe <%=class_name %>Mailer do
+  before(:each) do
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.perform_deliveries = true
+    ActionMailer::Base.deliveries = []
+  end
+  
+  it "should deliver <%=singular_name %>" do
+    @f = <%=class_name %>.new
+    
+    <% attributes.each do |attribute| %>
+       @f.<%=attribute.name %> = "foo"
+    <% end %>
+    
+    <%=class_name%>Mailer::deliver_<%=singular_name %>(@f)
+    ActionMailer::Base.deliveries.length.should == 1
+    
+  end
+  
+end

data/templates/model.rb

@@ -11,6 +11,7 @@ class <%= class_name %> < Tableless
     if valid?
       begin
         <%= class_name %>Mailer::deliver_<%=singular_name %>(self)
+        return true
       rescue
          @errors.add_to_base "Your message could not be sent due to configuration issues with the server."
          return false

data/templates/model_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe <%= class_name %> do
+
+  it "should deliver the message" do
+    
+    @f = <%=class_name %>.new
+    
+    <% attributes.each do |attribute| %>
+    @f.<%=attribute.name %> = "foo"
+    <% end %>
+    
+    @f.deliver.should == true
+  end
+  
+  # modify this test in such a way as to cause the 
+  # validations to fail, if you have any.
+  # it "should not deliver the message when there are errors" do
+  #   
+  #   @f = <%=class_name %>.new
+  #   @f.deliver.should_not == true
+  #   
+  # end
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: email_form_generator
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors: 
 - Brian Hogan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-03 00:00:00 -05:00
+date: 2009-07-20 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,6 +49,9 @@ files:
 - templates/view_form.html.erb
 - templates/view_new.html.erb
 - templates/view_success.html.erb
+- templates/model_spec.rb
+- templates/controller_spec.rb
+- templates/mailer_spec.rb
 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: