suspenders 0.0.4 → 0.1.0.beta.1

data/Rakefile

@@ -4,7 +4,7 @@ require 'cucumber/rake/task'
 require 'date'
 
 TEST_PROJECT = 'test_project'
-SUSPENDERS_GEM_VERSION = '0.0.4'
+SUSPENDERS_GEM_VERSION = '0.1.0.beta.1'
 
 #############################################################################
 #
@@ -16,34 +16,18 @@ Cucumber::Rake::Task.new
 
 namespace :test do
   desc "A full suspenders app's test suite"
-  task :full => ['generate', 'cucumber', 'destroy:suspenders']
+  task :full => ['test_project:generate', 'cucumber', 'test_project:destroy']
 end
 
-task :generate => ['generate:finish']
-namespace :generate do
+namespace :test_project do
   desc 'Suspend a new project. Pass REPO=... to change the Suspenders repo.'
-  task :suspenders do
+  task :generate do
     FileUtils.rm_rf(TEST_PROJECT)
     sh './bin/suspenders', 'create', TEST_PROJECT, ENV['REPO'].to_s
   end
 
-  desc 'Finishing touches'
-  task :finish => ['suspenders'] do
-    open(File.join(TEST_PROJECT, 'config', 'environments', 'cucumber.rb'), 'a') do |f|
-      f.puts "config.action_mailer.default_url_options = { :host => 'localhost:3000' }"
-    end
-
-    routes_file = IO.read(File.join(TEST_PROJECT, 'config', 'routes.rb')).split("\n")
-    routes_file = [routes_file[0]] + [%{map.root :controller => 'clearance/sessions', :action => 'new'}] + routes_file[1..-1]
-    open(File.join(TEST_PROJECT, 'config', 'routes.rb'), 'w') do |f|
-      f.puts routes_file.join("\n")
-    end
-  end
-end
-
-namespace :destroy do
   desc 'Remove a suspended project'
-  task :suspenders do
+  task :destroy do
     FileUtils.cd TEST_PROJECT
     sh "rake db:drop RAILS_ENV=development"
     sh "rake db:drop RAILS_ENV=test"

data/bin/suspenders

@@ -12,7 +12,7 @@ end
 case ARGV[0]
 when 'create', '--create'
   begin
-    Suspenders::Create.run!(ARGV[1], ARGV[2])
+    Suspenders::Create.run!(ARGV[1])
   rescue Suspenders::InvalidInput => e
     error_with_message(e.message)
   end

data/features/rake_clean.feature

@@ -9,7 +9,7 @@ Feature: Rake works in the suspended project
 
   Scenario: Making a spec then running rake
     When I drop and create the required databases
-    And I generate "rspec_model post title:string"
+    And I generate "model post title:string"
     And I run the rake task "db:migrate"
     And I run the rake task "spec"
     Then I see a successful response in the shell

data/features/step_definitions/shell.rb

@@ -6,7 +6,7 @@ end
 
 When 'I generate "$generator_with_args"' do |generator_with_args|
   Dir.chdir('test_project') do
-    system("./script/generate #{generator_with_args}")
+    system("rails generate #{generator_with_args}")
   end
 end
 

data/lib/create.rb

@@ -1,106 +1,54 @@
 # Methods needed to create a project.
 
 require 'rubygems'
-require 'digest/md5'
 require File.expand_path(File.dirname(__FILE__) + "/errors")
-require File.expand_path(File.dirname(__FILE__) + "/command")
 
 module Suspenders
   class Create
-    attr_accessor :project_name, :template_url, :project_directory
-    include Suspenders::Command
+    attr_accessor :project_path
 
-    def self.run!(input_project_name, input_template_url)
-      creator = self.new(input_project_name, input_template_url)
+    def self.run!(project_path)
+      creator = self.new(project_path)
       creator.create_project!
     end
 
-    def initialize(input_project_name, input_template_url)
-      @project_name = valid_project_name!(input_project_name)
-      @template_url, @project_directory = valid_template_url!(input_template_url, project_name)
+    def initialize(project_path)
+      self.project_path = project_path
+      validate_project_path
+      validate_project_name
     end
 
     def create_project!
-      run("mkdir #{project_directory}")
-      Dir.chdir(project_directory) or fail("Couldn't change to #{project_directory}")
-      run("git init")
-      run("git remote add suspenders #{template_url}")
-      run("git pull suspenders master")
-
-      Dir.glob("#{project_directory}/**/*.*").each do |file|
-        search_and_replace(file, changeme, project_name)
-      end
-
-      Dir.glob("#{project_directory}/**/session_store.rb").each do |file|
-        datestring = Time.now.strftime("%j %U %w %A %B %d %Y %I %M %S %p %Z")
-        search_and_replace(file, changesession, Digest::MD5.hexdigest("#{project_name} #{datestring}"))
-      end
-
-      run("git commit -a -m 'Initial commit'")
-
-      run("rake gems:refresh_specs")
-      run("rake db:create RAILS_ENV=development")
-      run("rake db:create RAILS_ENV=test")
-
-      run("script/generate clearance")
-      run("script/generate clearance_features -f")
-      run("script/generate clearance_views -f")
-
-      run("git add .")
-      run("git commit -m 'installed clearance'")
-
-      puts
-      puts "Now login to github and add a new project named '#{project_name}'"
+      exec(<<-COMMAND)
+        rails new #{project_path} \
+          --template=#{template} \
+          --skip-test-unit \
+          --skip-prototype
+      COMMAND
     end
 
     private
 
-    def changeme
-      "CHANGEME"
-    end
-
-    def changesession
-      "CHANGESESSION"
-    end
-
-    def valid_project_name!(project_name)
+    def validate_project_name
+      project_name = File.basename(project_path)
       unless project_name =~ /^[a-z0-9_]+$/
         raise InvalidInput.new("Project name must only contain [a-z0-9_]")
-      else
-        project_name
       end
     end
 
-    def valid_template_url!(template_url, project_name)
+    def validate_project_path
       base_directory = Dir.pwd
-      project_directory = File.join(base_directory, project_name)
+      full_path = File.join(base_directory, project_path)
 
       # This is for the common case for the user's convenience; the race
       # condition can still occur.
-      if File.exists?(project_directory)
-        raise InvalidInput.new("Project directory (#{project_directory}) already exists")
-      end
-
-      if template_url && !(template_url =~ /^ *$/)
-        [template_url, project_directory]
-      else
-        ["git://github.com/thoughtbot/suspenders.git", project_directory]
+      if File.exists?(full_path)
+        raise InvalidInput.new("Project directory (#{project_path}) already exists")
       end
     end
 
-    def search_and_replace(file, search, replace)
-      begin
-        contents = File.read(file)
-        if contents[search]
-          puts "Replacing #{search} with #{replace} in #{file}"
-          contents.gsub!(search, replace)
-          File.open(file, "w") { |f| f << contents }
-        end
-      rescue Errno::EISDIR => e
-        # This is fine, because Dir.glob can't select only files.
-      rescue Errno::ENOENT => e
-        fail "Attempted to perform a find-and-replace on a missing file: #{file}"
-      end
+    def template
+      File.expand_path(File.dirname(__FILE__) + "/../template/suspenders.rb")
     end
   end
 end

data/suspenders.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'suspenders'
-  s.version           = '0.0.4'
-  s.date              = '2010-08-10'
+  s.version           = '0.1.0.beta.1'
+  s.date              = '2010-09-28'
 
   s.summary     = "Generate a Rails app using thoughtbot's best practices."
   s.description = <<-HERE
@@ -24,15 +24,8 @@ rush to build something amazing; don't use it if you like missing deadlines.
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = %w[README.md LICENSE]
 
-  s.add_dependency('cucumber', [">= 0.6.2"])
-  s.add_dependency('nokogiri', '1.4.0')
-  s.add_dependency('RedCloth', '4.2.2')
-  s.add_dependency('cucumber-rails', '>=0.3.0')
-  s.add_dependency('mysql', '2.8.1')
-  s.add_dependency('rspec','1.3.0')
-  s.add_dependency('rspec-rails','= 1.3.2')
-  s.add_dependency('webrat','>=0.7.0')
-  s.add_dependency('treetop','1.4.5')
+  s.add_dependency('rails', '>= 3.0.0')
+  s.add_dependency('trout', '>= 0.3.0')
 
   # = MANIFEST =
   s.files = %w[
@@ -43,10 +36,24 @@ rush to build something amazing; don't use it if you like missing deadlines.
     features/rake_clean.feature
     features/step_definitions/shell.rb
     features/support/env.rb
-    lib/command.rb
     lib/create.rb
     lib/errors.rb
     suspenders.gemspec
+    template/files/README_FOR_SUSPENDERS
+    template/files/_flashes.html.erb
+    template/files/_javascript.html.erb
+    template/files/body_class_helper.rb
+    template/files/errors.rb
+    template/files/factory_girl_steps.rb
+    template/files/mysql_database.yml.erb
+    template/files/suspenders_gitignore
+    template/files/suspenders_layout.html.erb.erb
+    template/files/time_formats.rb
+    template/suspenders.rb
+    template/trout/Gemfile
+    template/trout/public/javascripts/jquery-ui.js
+    template/trout/public/javascripts/jquery.js
+    template/trout/public/javascripts/prefilled_input.js
   ]
   # = MANIFEST =
 

data/template/files/README_FOR_SUSPENDERS

@@ -0,0 +1,166 @@
+This is Suspenders, the thoughtbot rails template.
+
+To create a new project, first install the suspenders gem:
+
+  gem install suspenders
+
+Then run:
+
+  suspenders create projectname
+
+This will create a project in ../projectname.  You should then follow the
+instructions on Github to upload that project there.  This creates an
+entirely new git repository, and is not meant to be used against an existing
+repo.
+
+When making a change to a project that was created via this template, consider
+whether it's a change that should be made across all projects.  If so, then
+make the change in suspenders instead of your project.  Note: If you don't
+have commit access to suspenders, create a github ticket and we'll review your
+suggestion.
+
+Once that's committed, you can pull into your project to get all the changes 
+that have been made in suspenders since your last pull:
+
+  rake git:pull:suspenders
+
+About Suspenders
+----------------
+
+Suspenders was created for use at thoughtbot, inc. (http://thoughtbot.com) as a
+baseline application setup, with reasonable default plugins that the majority
+(if not all) of our applications used, as well as best-practice configuration
+options.
+
+Suspenders currently includes a version of Rails from the 2.3 stable branch.
+You can determine the changeset with the vendor/rails/REVISION_xxxxx file.
+
+Gems (unpacked in vendor/gems, unless they are compiled gems):
+--------------------------------------------------------------
+
+For record pagination:
+
+  will_paginate
+
+For text formatting:
+
+  RedCloth (4.2.2, not unpacked, this is a compiled gem)
+
+Form builder:
+
+  Formtastic
+
+File attachments:
+
+  Paperclip
+
+Basic user auth:
+
+  Clearance
+
+For testing:
+
+  jferris-mocha (standard mocha plus test spies)
+  factory_girl (fixture replacement for test data)
+  shoulda (rails test helpers and context framework)
+  timecop (for time sensitive tests)
+  fakeweb (for blocking HTTP calls to third-party services)
+
+Error notification:
+
+  hoptoad_notifier
+
+Plugins (in vendor/plugins):
+----------------------------
+
+  limerick_rake (useful rake tasks)
+  validation_reflection (used by formtastic to find required fields)
+  high_voltage (Rails engine for static pages)
+
+Initializers (in config/initializers)
+-------------------------------------
+
+  action_mailer_configs.rb
+  We use SMTP by default in all applications.
+
+  hoptoad.rb
+  Get your API key at http://hoptoadapp.com
+  
+  requires.rb
+  Automatically requires everything in
+    lib/
+    lib/extensions
+    test/mocks/RAILS_ENV (Removed in Rails 2, we decided to keep it)
+  Add other things you need to require in here.
+
+  time_formats.rb
+  Two time formats are available by default, :short_date and :long_date.
+  Add other time formats here.
+  
+Rake Tasks
+----------
+
+Rake tasks are contained in the limerick_rake gem.
+
+  bootstrap
+  Provides rake tasks for loading data into the database.  These are used for
+  an initial application dataset needed for production.
+  
+  capistrano
+  Standard capistrano deployment tasks
+  
+Testing
+-------
+
+Testing is done utilizing Test::Unit, Shoulda, factory_girl, and mocha.
+
+factory_girl is a fixture replacement library, following the factory pattern.
+Place your factories in test/factories.rb.  The fixture directory has been
+removed, as fixtures are not used.
+
+Shoulda is a pragmatic testing framework for TDD and BDD built on top of
+Test::Unit.  A number of additional testing macros are provided in
+test/shoulda_macros:
+
+  shoulda_have_form
+  shoulda_paginate_collection
+
+Timecop is used to freeze the time for the entire test suite. It is frozen to
+the value of Time.now; that is, the time that the tests suite starts running.
+
+Deployment
+----------
+
+Deployment is done using capistrano, and deploys to a mongrel cluster, running
+under Apache.
+
+Rake tasks are provided for managing git branches which the different
+environments pull from for deploy.
+
+To push the git master to git staging branch run:
+
+  rake git:push:staging
+
+To push the git staging branch to production branch run:
+
+  rake git:push:production
+
+Setup your deployment environment by running:
+
+  cap ENVIRONMENT deploy:setup
+  (You'll be prompted for the environment's database password)
+
+Deploy to the desired environment by running:
+
+  cap ENVIRONMENT deploy
+  
+The default environment for deploy is staging, to deploy to staging, just run:
+
+  cap deploy
+
+Mascot
+------
+
+The official Suspenders mascot is Suspenders Boy:
+
+  http://media.tumblr.com/1TEAMALpseh5xzf0Jt6bcwSMo1_400.png

data/template/files/_flashes.html.erb

@@ -0,0 +1,5 @@
+<div id="flash">
+  <% flash.each do |key, value| -%>
+    <div id="flash_<%= key %>"><%=h value %></div>
+  <% end -%>
+</div>

data/template/files/_javascript.html.erb

@@ -0,0 +1,2 @@
+<%= javascript_include_tag 'jquery', 'jquery-ui', 'prefilled_input',  :cache => true %>
+<%= yield :javascript %>

data/template/files/body_class_helper.rb

@@ -0,0 +1,7 @@
+module BodyClassHelper
+  # TODO: move this into a gem/plugin
+  def body_class
+    qualified_controller_name = controller.controller_path.gsub('/','-')
+    "#{qualified_controller_name} #{qualified_controller_name}-#{controller.action_name}"
+  end
+end

data/template/files/errors.rb

@@ -0,0 +1,26 @@
+require 'net/smtp'
+# Example:
+#   begin
+#     some http call
+#   rescue *HTTP_ERRORS => error
+#     notify_hoptoad error
+#   end
+
+HTTP_ERRORS = [Timeout::Error,
+               Errno::EINVAL,
+               Errno::ECONNRESET,
+               EOFError,
+               Net::HTTPBadResponse,
+               Net::HTTPHeaderSyntaxError,
+               Net::ProtocolError]
+
+SMTP_SERVER_ERRORS = [TimeoutError,
+                      IOError,
+                      Net::SMTPUnknownError,
+                      Net::SMTPServerBusy,
+                      Net::SMTPAuthenticationError]
+
+SMTP_CLIENT_ERRORS = [Net::SMTPFatalError,
+                      Net::SMTPSyntaxError]
+
+SMTP_ERRORS = SMTP_SERVER_ERRORS + SMTP_CLIENT_ERRORS