suspenders 1.0.1 → 1.1.0

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    suspenders (1.0.0)
+    suspenders (1.0.1)
       bundler (>= 1.1)
+      hub (~> 1.10.2)
       rails (= 3.2.6)
 
 GEM
@@ -56,6 +57,7 @@ GEM
     gherkin (2.9.3)
       json (>= 1.4.6)
     hike (1.2.1)
+    hub (1.10.2)
     i18n (0.6.0)
     journey (1.0.4)
     json (1.6.6)

data/NEWS.md

@@ -1,3 +1,10 @@
+1.1.0 (August 3, 2012)
+
+* Add --github option.
+* Add --webkit option.
+* Remove cruft when generating controllers.
+* Add Spork and Guard.
+
 1.0.1 (August 2, 2012)
 
 * Fix broken install on Ruby 1.8.

data/README.md

@@ -27,29 +27,27 @@ which will be appended to the default generated projectname/Gemfile.
 
 It includes application gems like:
 
-* [Paperclip](https://github.com/thoughtbot/paperclip) for file uploads
-* [Formtastic](https://github.com/justinfrench/formtastic) for better forms
 * [Airbrake](https://github.com/airbrake/airbrake) for exception notification
-* [Flutie](https://github.com/thoughtbot/flutie) for default CSS styles
 * [Bourbon](https://github.com/thoughtbot/bourbon) for classy sass mixins
 * [Clearance](https://github.com/thoughtbot/clearance) for authentication
+* [Flutie](https://github.com/thoughtbot/flutie) for default CSS styles
+* [Formtastic](https://github.com/justinfrench/formtastic) for better forms
+* [Paperclip](https://github.com/thoughtbot/paperclip) for file uploads
 
 And testing gems like:
 
+* [Bourne](https://github.com/thoughtbot/bourne) and Mocha for stubbing and spying
 * [Cucumber, Capybara, and Capybara Webkit](http://robots.thoughtbot.com/post/4583605733/capybara-webkit) for integration testing, including Javascript behavior
-* [RSpec](https://github.com/rspec/rspec) for awesome, readable isolation testing
 * [Factory Girl](https://github.com/thoughtbot/factory_girl) for easier creation of test data
+* [RSpec](https://github.com/rspec/rspec) for awesome, readable isolation testing
 * [Shoulda Matchers](http://github.com/thoughtbot/shoulda-matchers) for frequently needed Rails and RSpec matchers
 * [Timecop](https://github.com/jtrupiano/timecop) for dealing with time
-* [Bourne](https://github.com/thoughtbot/bourne) and Mocha for stubbing and spying
-* [email_spec](https://github.com/bmabey/email-spec) for testing emails.
 
 Other goodies
 -------------
 
 Suspenders also comes with:
 
-* [jQuery](https://github.com/jquery/jquery) for Javascript pleasantry
 * Rails' flashes set up and in application layout.
 * A few nice time formats.
 
@@ -65,6 +63,17 @@ This has the same effect as running:
     heroku create app-staging --remote staging
     heroku create app-production --remote production
 
+Github
+------
+
+You can optionally create a Github repository:
+
+    suspenders app --github organization/project
+
+This has the same effect as running:
+
+    hub create organization/project
+
 Clearance
 ---------
 
@@ -72,6 +81,14 @@ You can optionally not include Clearance:
 
     suspenders app --clearance false
 
+Capybara Webkit
+---------------
+
+You can optionally not include Capybara Webkit (which depends on QT being
+installed on your machine):
+
+    suspenders app --webkit false
+
 Dependencies
 ------------
 

data/features/clearance_false.feature

@@ -0,0 +1,10 @@
+@disable-bundler
+Feature: Skipping Clearance
+
+  Scenario: --clearance=false
+    When I suspend a project called "test_project" with:
+      | argument    | value |
+      | --clearance | false |
+    And I cd to the "test_project" root
+    Then "clearance" should not be installed
+    And I can cleanly rake the project

data/features/github_repo.feature

@@ -0,0 +1,8 @@
+@disable-bundler
+Feature: Creating a Github repo
+
+  Scenario: --github=organization/project
+    When I suspend a project called "test_project" with:
+      | argument | value                |
+      | --github | organization/project |
+    Then the "organization/project" Github repo should exist

data/features/heroku_true.feature

@@ -0,0 +1,9 @@
+@disable-bundler
+Feature: Creating a Heroku app
+
+  Scenario: --heroku=true
+    When I suspend a project called "test_project" with:
+      | argument | value |
+      | --heroku | true  |
+    Then the "test_project-staging" Heroku app should exist
+    And the "test_project-production" Heroku app should exist

data/features/step_definitions/{shell_steps.rb → suspenders_steps.rb}

@@ -53,3 +53,21 @@ Then 'I can cleanly rake the project' do
     Then I see a successful response in the shell
   }
 end
+
+Then /^"(.*)" should not be installed$/ do |gem_name|
+  in_current_dir do
+    system("bundle show #{gem_name} 2>&1 > /dev/null").should be_false
+  end
+end
+
+Then /^"(.*)" should not be included in "(.*)"$/ do |content, file_path|
+  check_file_content file_path, content, false
+end
+
+Then /^the "([^"]*)" Heroku app should exist$/ do |app_name|
+  FakeHeroku.should have_created_app(app_name)
+end
+
+Then /^the "([^"]*)" Github repo should exist$/ do |repo_name|
+  FakeGithub.should have_created_repo(repo_name)
+end

data/features/support/env.rb

@@ -1,15 +1,10 @@
 Before do
   ENV['TESTING'] = 'true'
-end
-
-Before do
   @aruba_timeout_seconds = 560
 end
 
 After do
   FakeHeroku.clear!
-end
-
-After do
-  FileUtils.rm_rf('test_project')
+  FakeGithub.clear!
+  FileUtils.rm_rf 'test_project'
 end

data/features/support/fake_github.rb

@@ -0,0 +1,21 @@
+class FakeGithub
+  RECORDER = File.expand_path(File.join('..', '..', 'tmp', 'hub_commands'), File.dirname(__FILE__))
+
+  def initialize(args)
+    @args = args
+  end
+
+  def run!
+    File.open(RECORDER, 'a') do |file|
+      file.write @args.join(' ')
+    end
+  end
+
+  def self.clear!
+    FileUtils.rm_rf RECORDER
+  end
+
+  def self.has_created_repo?(repo_name)
+    File.open(RECORDER, 'r').read.include?("create #{repo_name}")
+  end
+end

data/features/support/fake_heroku.rb

@@ -12,7 +12,7 @@ class FakeHeroku
   end
 
   def self.clear!
-    FileUtils.rm_rf(RECORDER)
+    FileUtils.rm_rf RECORDER
   end
 
   def self.has_created_app?(app_name)

data/features/webkit_false.feature

@@ -0,0 +1,11 @@
+@disable-bundler
+Feature: Skipping Capybara Webkit
+
+  Scenario: --webkit=false
+    When I suspend a project called "test_project" with:
+      | argument | value |
+      | --webkit | false |
+    And I cd to the "test_project" root
+    Then "capybara-webkit" should not be installed
+    And "webkit" should not be included in "features/support/env.rb"
+    And I can cleanly rake the project

data/lib/suspenders/app_builder.rb

@@ -55,24 +55,40 @@ module Suspenders
     end
 
     def use_postgres_config_template
-      template 'postgresql_database.yml.erb', 'config/database.yml', :force => true
+      template 'postgresql_database.yml.erb', 'config/database.yml',
+        :force => true
     end
 
     def create_database
       bundle_command 'exec rake db:create'
     end
 
-    def include_custom_gems
+    def add_custom_gems
       additions_path = find_in_source_paths 'Gemfile_additions'
       new_gems = File.open(additions_path).read
-      inject_into_file 'Gemfile', "\n#{new_gems}", :after => /gem 'jquery-rails'/
+      inject_into_file 'Gemfile', "\n#{new_gems}",
+        :after => /gem 'jquery-rails'/
+    end
+
+    def add_clearance_gem
+      inject_into_file 'Gemfile', "\ngem 'clearance'",
+        :after => /gem 'jquery-rails'/
+    end
+
+    def add_capybara_webkit_gem
+      inject_into_file 'Gemfile', "\n  gem 'capybara-webkit', '~> 0.11.0'",
+        :after => /gem 'cucumber-rails', '1.3.0'/
     end
 
     def configure_rspec
       generators_config = <<-RUBY
-          config.generators do |generate|
-            generate.test_framework :rspec
-          end
+    config.generators do |generate|
+      generate.test_framework :rspec
+      generate.helper false
+      generate.stylesheets false
+      generate.javascript_engine false
+      generate.view_specs false
+    end
       RUBY
       inject_into_class 'config/application.rb', 'Application', generators_config
     end
@@ -86,18 +102,27 @@ module Suspenders
 
     def generate_rspec
       generate 'rspec:install'
+      inject_into_file '.rspec', " --drb", :after => '--color'
       replace_in_file 'spec/spec_helper.rb',
         '# config.mock_with :mocha', 'config.mock_with :mocha'
     end
 
-    def generate_cucumber
+    def generate_cucumber(options = {})
       generate 'cucumber:install', '--rspec', '--capybara'
-      inject_into_file 'features/support/env.rb',
-        %{Capybara.save_and_open_page_path = 'tmp'\n} +
-        %{Capybara.javascript_driver = :webkit\n},
-        :before => %{Capybara.default_selector = :css}
       inject_into_file 'config/cucumber.yml',
-        ' -r features', :after => %{default: <%= std_opts %> features}
+        ' -drb -r features', :after => %{default: <%= std_opts %> features}
+      copy_file 'features_support_env.rb', 'features/support/env.rb',
+        :force => true
+
+      if options[:webkit]
+        inject_into_file 'features/support/env.rb',
+          "\n  Capybara.javascript_driver = :webkit",
+          :after => /Capybara.default_selector = :css/
+      end
+    end
+
+    def setup_guard_spork
+      copy_file 'Guardfile', 'Guardfile'
     end
 
     def generate_clearance
@@ -137,11 +162,7 @@ module Suspenders
     end
 
     def create_heroku_apps
-      path_additions = ''
-      if ENV['TESTING']
-        support_bin = File.expand_path(File.join('..', '..', '..', 'features', 'support', 'bin'))
-        path_addition = "PATH=#{support_bin}:$PATH"
-      end
+      path_addition = override_path_for_tests
       run "#{path_addition} heroku create #{app_name}-production --remote=production"
       run "#{path_addition} heroku create #{app_name}-staging    --remote=staging"
     end
@@ -152,6 +173,11 @@ module Suspenders
       inject_into_file('README.md', "#{documentation}\n", :before => 'Most importantly')
     end
 
+    def create_github_repo(repo_name)
+      path_addition = override_path_for_tests
+      run "#{path_addition} hub create #{repo_name}"
+    end
+
     def copy_miscellaneous_files
       copy_file 'errors.rb', 'config/initializers/errors.rb'
       copy_file 'time_formats.rb', 'config/initializers/time_formats.rb'
@@ -177,6 +203,10 @@ module Suspenders
       route "root :to => 'Clearance::Sessions#new'"
     end
 
+    def remove_routes_comment_lines
+      replace_in_file 'config/routes.rb', /Application\.routes\.draw do.*end/m, "Application.routes.draw do\nend"
+    end
+
     def set_attr_accessibles_on_user
       inject_into_file 'app/models/user.rb',
         '  attr_accessible :email, :password\n',
@@ -197,8 +227,13 @@ module Suspenders
       end
     end
 
-    def add_clearance_gem
-      inject_into_file 'Gemfile', "\ngem 'clearance'", :after => /gem 'jquery-rails'/
+    private
+
+    def override_path_for_tests
+      if ENV['TESTING']
+        support_bin = File.expand_path(File.join('..', '..', '..', 'features', 'support', 'bin'))
+        "PATH=#{support_bin}:$PATH"
+      end
     end
   end
 end

data/lib/suspenders/generators/app_generator.rb

@@ -3,17 +3,23 @@ require 'rails/generators/rails/app/app_generator'
 
 module Suspenders
   class AppGenerator < Rails::Generators::AppGenerator
+    class_option :clearance, :type => :boolean, :aliases => '-C', :default => true,
+      :desc => 'Add the Clearance Rails authentication library'
+
     class_option :database, :type => :string, :aliases => '-d', :default => 'postgresql',
       :desc => "Preconfigure for selected database (options: #{DATABASES.join('/')})"
 
+    class_option :heroku, :type => :boolean, :aliases => '-H', :default => false,
+      :desc => 'Create staging and production Heroku apps'
+
+    class_option :github, :type => :string, :aliases => '-G', :default => nil,
+      :desc => 'Create Github repository and add remote origin pointed to repo'
+
     class_option :skip_test_unit, :type => :boolean, :aliases => '-T', :default => true,
       :desc => 'Skip Test::Unit files'
 
-    class_option :heroku, :type => :boolean, :aliases => '-H', :default => false,
-      :desc => 'Create staging and production heroku apps'
-
-    class_option :clearance, :type => :boolean, :aliases => '-C', :default => true,
-      :desc => 'Add the clearance Rails authentication library'
+    class_option :webkit, :type => :boolean, :aliases => '-W', :default => true,
+      :desc => 'Add the Capybara Webkit Javascript integration testing library'
 
     def finish_template
       invoke :suspenders_customization
@@ -33,9 +39,11 @@ module Suspenders
       invoke :setup_stylesheets
       invoke :copy_miscellaneous_files
       invoke :customize_error_pages
+      invoke :remove_routes_comment_lines
       invoke :setup_root_route
       invoke :setup_git
       invoke :create_heroku_apps
+      invoke :create_github_repo
       invoke :outro
     end
 
@@ -74,18 +82,26 @@ module Suspenders
     end
 
     def customize_gemfile
-      build :include_custom_gems
+      build :add_custom_gems
+
       if options[:clearance]
         build :add_clearance_gem
       end
+
+      if options[:webkit]
+        build :add_capybara_webkit_gem
+      end
+
       bundle_command 'install'
     end
 
     def setup_database
       say 'Setting up database'
+
       if 'postgresql' == options[:database]
         build :use_postgres_config_template
       end
+
       build :create_database
     end
 
@@ -94,7 +110,8 @@ module Suspenders
       build :configure_rspec
       build :configure_action_mailer
       build :generate_rspec
-      build :generate_cucumber
+      build :generate_cucumber, :webkit => options[:webkit]
+      build :setup_guard_spork
       build :add_email_validator
       build :setup_default_rake_task
       build :setup_clearance
@@ -104,6 +121,7 @@ module Suspenders
       if options[:clearance]
         build :generate_clearance
         build :include_clearance_matchers
+
         if using_active_record?
           build :set_attr_accessibles_on_user
         end
@@ -122,13 +140,20 @@ module Suspenders
     end
 
     def create_heroku_apps
-      if options['heroku']
-        say 'Creating heroku apps'
+      if options[:heroku]
+        say 'Creating Heroku apps'
         build :create_heroku_apps
         build :document_heroku
       end
     end
 
+    def create_github_repo
+      if options[:github]
+        say 'Creating Github repo'
+        build :create_github_repo, options[:github]
+      end
+    end
+
     def setup_gitignore
       build :gitignore_files
     end
@@ -147,6 +172,10 @@ module Suspenders
       build :customize_error_pages
     end
 
+    def remove_routes_comment_lines
+      build :remove_routes_comment_lines
+    end
+
     def setup_root_route
       if options[:clearance]
         say 'Setting up a root route'