suspenders 0.0.2 → 0.0.3

data/README.md

@@ -22,7 +22,7 @@ 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 
+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:
 
   git pull suspenders master
@@ -63,6 +63,7 @@ Basic user auth:
 
 For testing:
 
+  rspec
   jferris-mocha (standard mocha plus test spies)
   factory_girl (fixture replacement for test data)
   shoulda (rails test helpers and context framework)
@@ -84,7 +85,7 @@ Initializers (in config/initializers)
 
   hoptoad.rb
   Get your API key at http://hoptoadapp.com
-  
+
   requires.rb
   Automatically requires everything in
     lib/
@@ -95,7 +96,7 @@ Initializers (in config/initializers)
   time_formats.rb
   Two time formats are available by default, :short_date and :long_date.
   Add other time formats here.
-  
+
 Rake Tasks
 ----------
 
@@ -104,25 +105,20 @@ 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.
+Testing is done utilizing RSpec, 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
+Shoulda matchers are used on top of RSpec.
 
 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.
@@ -152,7 +148,7 @@ Setup your deployment environment by running:
 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

data/Rakefile

@@ -4,7 +4,7 @@ require 'cucumber/rake/task'
 require 'date'
 
 TEST_PROJECT = 'test_project'
-SUSPENDERS_GEM_VERSION = '0.0.2'
+SUSPENDERS_GEM_VERSION = '0.0.3'
 
 #############################################################################
 #
@@ -16,17 +16,18 @@ Cucumber::Rake::Task.new
 
 namespace :test do
   desc "A full suspenders app's test suite"
-  task :full => ['generate:suspenders', 'generate:finish', 'cucumber', 'destroy:suspenders']
+  task :full => ['generate', 'cucumber', 'destroy:suspenders']
 end
 
+task :generate => ['generate:finish']
 namespace :generate do
-  desc 'Suspend a new project'
+  desc 'Suspend a new project. Pass REPO=... to change the Suspenders repo.'
   task :suspenders do
-    sh './bin/suspenders', 'create', TEST_PROJECT
+    sh './bin/suspenders', 'create', TEST_PROJECT, ENV['REPO'].to_s
   end
 
   desc 'Finishing touches'
-  task :finish do
+  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
@@ -42,6 +43,10 @@ end
 namespace :destroy do
   desc 'Remove a suspended project'
   task :suspenders do
+    FileUtils.cd TEST_PROJECT
+    sh "rake db:drop RAILS_ENV=development"
+    sh "rake db:drop RAILS_ENV=test"
+    FileUtils.cd '..'
     FileUtils.rm_rf TEST_PROJECT
   end
 end

data/bin/suspenders

@@ -1,80 +1,23 @@
 #!/usr/bin/env ruby
-require 'rubygems'
-require 'active_support'
-require 'pathname'
-require 'digest/md5'
 
-### currently the only thing you can do is create. So we ignore the first argument
-project_name = ARGV[1]
-fail("Usage:  #{File.basename(__FILE__)} create new_project_name")     unless project_name
-fail("Project name must only contain [a-z0-9_]")                       unless project_name =~ /^[a-z0-9_]+$/
+require File.expand_path(File.dirname(__FILE__) + "/../lib/create")
+require File.expand_path(File.dirname(__FILE__) + "/../lib/errors")
 
-base_directory = Dir.pwd
-project_directory = File.join(base_directory, project_name)
-fail("Project directory (#{project_directory}) already exists") if File.exists?(project_directory)
+include Suspenders::Errors
 
-template_url = "git://github.com/thoughtbot/suspenders.git"
-changeme = "CHANGEME"
-changesession = "CHANGESESSION"
-
-def run(cmd)
-  puts "Running '#{cmd}'"
-  out = `#{cmd}`
-  if $? != 0
-    fail "Command #{cmd} failed: #$?\n#{out}"
-  end
-  out
+def usage
+  "Usage: #{File.basename(__FILE__)} create new_project_name"
 end
 
-def search_and_replace(file, search, replace)
-  if File.file?(file)
-    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
+case ARGV[0]
+when 'create', '--create'
+  begin
+    Suspenders::Create.run!(ARGV[1], ARGV[2])
+  rescue Suspenders::InvalidInput => e
+    error_with_message(e.message)
   end
+when 'help', '--help'
+  puts usage
+else
+  error_with_message "Unknown subcommand: #{ARGV[0]}\n#{usage}"
 end
-
-def installed?(gem_name)
-  installed_gems = Gem.source_index.find_name(gem_name)
-  installed_gems.any?
-end
-
-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'")
-
-# can't vendor nokogiri because it has native extensions
-unless installed?("nokogiri")
-  run "sudo gem install nokogiri --version='1.4.0'"
-end
-
-# need RedCloth installed for clearance generators to run.
-unless installed?("RedCloth")
-  run "sudo gem install RedCloth --version='4.2.2'"
-end
-
-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.humanize.titleize}'"

data/features/rake_clean.feature

@@ -1,7 +1,14 @@
 Feature: Rake works in the suspended project
 
   Scenario: Running rake in the suspended project
-    When I run the rake task "db:create:all"
+    When I drop and create the required databases
     And I run the rake task "db:migrate"
     And I run the rake task "cucumber"
     Then I see a successful response in the shell
+
+  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 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

@@ -4,6 +4,21 @@ When 'I run the rake task "$task_name"' do |task_name|
   end
 end
 
+When 'I generate "$generator_with_args"' do |generator_with_args|
+  Dir.chdir('test_project') do
+    system("./script/generate #{generator_with_args}")
+  end
+end
+
 Then 'I see a successful response in the shell' do
   $?.to_i.should == 0
 end
+
+When 'I drop and create the required databases' do
+  Dir.chdir('test_project') do
+    system("rake db:drop RAILS_ENV=test")
+    system("rake db:drop")
+    system("rake db:create RAILS_ENV=test")
+    system("rake db:create")
+  end
+end

data/lib/command.rb

@@ -0,0 +1,12 @@
+# Methods needed to run a command.
+
+module Suspenders
+  module Command
+    def run(cmd)
+      puts "Running '#{cmd}'"
+      out = `#{cmd}`
+      fail "Command #{cmd} failed: #$?\n#{out}" if $? != 0
+      out
+    end
+  end
+end

data/lib/create.rb

@@ -0,0 +1,106 @@
+# 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
+
+    def self.run!(input_project_name, input_template_url)
+      creator = self.new(input_project_name, input_template_url)
+      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)
+    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}'"
+    end
+
+    private
+
+    def changeme
+      "CHANGEME"
+    end
+
+    def changesession
+      "CHANGESESSION"
+    end
+
+    def valid_project_name!(project_name)
+      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)
+      base_directory = Dir.pwd
+      project_directory = File.join(base_directory, project_name)
+
+      # 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]
+      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
+    end
+  end
+end

data/lib/errors.rb

@@ -0,0 +1,12 @@
+# User errors
+
+module Suspenders
+  class InvalidInput < Exception; end
+
+  module Errors
+    def error_with_message(msg)
+      STDERR.puts msg
+      exit 1
+    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.2'
-  s.date              = '2010-05-14'
+  s.version           = '0.0.3'
+  s.date              = '2010-07-13'
 
   s.summary     = "Generate a Rails app using thoughtbot's best practices."
   s.description = <<-HERE
@@ -26,6 +26,9 @@ rush to build something amazing; don't use it if you like missing deadlines.
 
   s.add_development_dependency('cucumber', [">= 0.6.2"])
 
+  s.add_dependency('nokogiri', '1.4.0')
+  s.add_dependency('RedCloth', '4.2.2')
+
   # = MANIFEST =
   s.files = %w[
     LICENSE
@@ -35,6 +38,9 @@ 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
   ]
   # = MANIFEST =

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Mike Burns
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-14 00:00:00 -04:00
+date: 2010-07-13 00:00:00 -04:00
 default_executable: suspenders
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,6 +31,34 @@ dependencies:
         version: 0.6.2
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 4
+        - 2
+        - 2
+        version: 4.2.2
+  type: :runtime
+  version_requirements: *id003
 description: |
   Suspenders is a base Rails project that you can upgrade. It is used by
   thoughtbot to get a jump start on a working app. Use Suspenders if you're in a
@@ -52,6 +80,9 @@ files:
 - features/rake_clean.feature
 - features/step_definitions/shell.rb
 - features/support/env.rb
+- lib/command.rb
+- lib/create.rb
+- lib/errors.rb
 - suspenders.gemspec
 has_rdoc: true
 homepage: http://github.com/thoughtbot/suspenders-gem