shoe 0.1.13 → 0.2.0

data/BUNDLER.rdoc

@@ -0,0 +1,38 @@
+= Notes on <tt>`bundle exec bash`</tt>
+
+If your <tt>$SHELL</tt> happens to be +bash+, you may run into some of the same problems I did.
+
+Here they are, with fixes:
+
+== Functions and Aliases Aren't Available
+
+I had all of my +bash+ configuration in <tt>~/.profile</tt>. But,
+<tt>~/.profile</tt> isn't read when you execute +bash+ from the command-line
+(i.e. as a non-login shell), and only environment variables are inherited from
+the parent shell; not functions, aliases, or completion rules.
+
+So, just move all your non-environment-variable configuration out of
+<tt>~/.profile</tt> and into <tt>~/.bashrc</tt>, and then add something like
+this to your <tt>~/.profile</tt>:
+
+ if [ -f ~/.bashrc ]; then
+   source ~/.bashrc
+ fi
+
+== Prompts are SLOW!
+
+Once I got that sorted, I still had the problem that my bash prompts were way
+slow to generate. I was using the <tt>__git_ps1</tt> function and had the
+standalone version of Chris Wanstrath's hub[http://github.com/defunkt/hub]
+installed, with <tt>alias git=hub</tt> in my <tt>~/.bashrc</tt>.
+
+The issue is that <tt>`bundle exec`</tt> adds <tt>-rbundler/setup</tt> to the
++RUBYOPT+ environment variable, so every +ruby+ invocation first requires all
+of your bundled gems. Since +hub+ is a ruby script, and <tt>__git_ps1</tt>
+invokes +git+ multiple times, generating a prompt gets expensive quickly. I was
+seeing something like 3-second delays!
+
+One way to work around this issue is to change the way you call +hub+, clearing
+out +RUBYOPT+ first:
+
+ $ alias git='RUBYOPT= hub'

data/README.rdoc

@@ -1,25 +1,28 @@
 = Shoe
 
-You probably don't want to use Shoe -- especially if you're like me!
+You probably don't want to use shoe -- especially if you're like me!
 
-I like tinkering with my build scripts. That's why I don't use hoe[http://seattlerb.rubyforge.org/hoe] and jeweler[http://github.com/technicalpickles/jeweler] and those guys, even though they're awesome. I like to put my own thing together, so I made Shoe.
+I like tinkering with my build scripts, so I made shoe, even though
+hoe[http://seattlerb.rubyforge.org/hoe] and
+jeweler[http://github.com/technicalpickles/jeweler] are awesome.
 
 == Behold
 
-Here's how your Rakefile looks:
+Here's how your +Rakefile+ looks:
 
  require 'shoe'
+ require 'my_project/version'
 
- Shoe.tie('myproject', '0.1.0', "This is my project, and it's awesome!") do |spec|
+ Shoe.tie('my_project', MyProject::VERSION, "This is my project, and it's awesome!") do |spec|
    # do whatever you want with the Gem::Specification here, for example:
-   # spec.add_development_dependency 'shoulda'
+   # spec.add_runtime_dependency 'dnssd'
  end
 
 And here's what you get, at most:
 
  rake clean         # Remove ignored files
  rake compile       # Compile C extensions
- rake cucumber      # Run features
+ rake cucumber:ok   # Run features
  rake cucumber:wip  # Run work-in-progress features
  rake default       # Run features
  rake gemspec       # Show latest gemspec contents
@@ -28,16 +31,46 @@ And here's what you get, at most:
  rake shell         # Run an irb console
  rake test          # Run tests
 
-Most of the time, though, you won't see all of these: when possible, tasks are conditionally defined.
+Most of the time, though, you won't see all of these: when possible, tasks are
+conditionally defined.
 
-See what I mean by reading Shoe#define_tasks.
+See what I mean by reading <tt>Shoe#define_tasks</tt>.
 
-== Install
+== Getting Started
 
- gem install shoe
+=== With Bundler[http://github.com/carlhuda/bundler]
 
-== Getting Started
+1. Start with just shoe in your +Gemfile+:
+
+    source :gemcutter
+    gem 'shoe'
+
+2. Open a sub-shell configured for the bundler environment:
+
+    $ bundle exec $SHELL
+
+   (See BUNDLER.rdoc if you run into trouble with <tt>`bundle exec`</tt>.)
+
+3. Use +shoe+ to generate some skeleton project files:
+
+    $ shoe
 
-Shoe can create a Rakefile for you:
+4. And then you can poke around with
+
+    $ rake -T
+
+=== Without Bundler
+
+If you're not using bundler, it's probably best not to use the +shoe+
+generator. Instead, just install shoe normally:
+
+ $ gem install shoe
+
+And then <tt>require 'shoe'</tt> and add a <tt>Shoe.tie</tt> clause to your +Rakefile+:
+
+ Shoe.tie('my_project', '0.0.0', 'My project is awesome.') do |spec|
+   # spec.add_runtime_dependency 'dnssd' # or whatever...
+ end
 
- cd myproject && shoe
+Shoe also assumes you have a <tt>README.rdoc</tt>, so you'll need to create one if you
+want to avoid warnings running <tt>`rake rdoc`</tt>.

data/Rakefile

@@ -1,10 +1,7 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
 require 'shoe'
+require 'shoe/version'
 
-Shoe.tie('shoe', '0.1.13', 'Another take on hoe, jeweler & friends.') do |spec|
-  spec.remove_development_dependency_on_shoe
+Shoe.tie('shoe', Shoe::VERSION, 'Another take on hoe, jeweler & friends.') do |spec|
   spec.requirements = ['git']
-  spec.add_runtime_dependency 'cucumber'
-  spec.add_runtime_dependency 'gemcutter'
   spec.add_runtime_dependency 'rake'
 end

data/bin/shoe

@@ -1,31 +1,3 @@
-#!/usr/bin/env ruby
+require 'shoe/cli'
 
-def create_file(name, contents)
-  project_name = File.basename(File.expand_path(Dir.pwd))
-
-  if File.exists?(name)
-    STDERR.puts("#{name} exists. Not clobbering.")
-  else
-    File.open(name, 'w') { |file| file.write(contents.gsub('NAME', project_name)) }
-  end
-end
-
-# TODO read about heredocs at http://tomayko.com to see if I can clean this up a little.
-create_file 'Rakefile', <<-END
-begin
-  require 'shoe'
-rescue LoadError
-  abort 'Please `gem install shoe` to get started.'
-end
-
-Shoe.tie('NAME', '0.0.0', 'TODO write a summary of NAME here.') do |spec|
-  # do whatever you want with the Gem::Specification here, for example:
-  # spec.add_development_dependency 'shoulda'
-end
-END
-
-create_file 'README.rdoc', <<-END
-= NAME
-
-NAME is one of my favorite things! Let me tell you about it:
-END
+Shoe::CLI.run

data/features/cucumber.feature

@@ -4,33 +4,14 @@ Feature: Cucumber
   I want shoe to give me a rake task
 
   Scenario: Running rake --tasks in a shoe project without Cucumber features
-    Given I have created a directory called "my_project"
-    And I have run shoe inside "my_project"
-    When I run rake --tasks inside "my_project"
+    Given I have created a project called "my_project"
+    When I run bundle exec rake --tasks inside "my_project"
     Then I should not see "rake cucumber" on standard out
 
   Scenario: Running rake --tasks in a shoe project with Cucumber features
-    Given I have created a directory called "my_project"
+    Given I have created a project called "my_project"
     And I have created a directory called "my_project/features"
-    And I have run shoe inside "my_project"
-    When I run rake --tasks inside "my_project"
+    When I run bundle exec rake --tasks inside "my_project"
     Then I should see "rake cucumber" on standard out
-    And I should not see "rake cucumber:wip" on standard out
+    And I should see "rake cucumber:wip" on standard out
 
-  Scenario: Running rake --tasks in a shoe project with work-in-progress Cucumber features
-    Given I have created a directory called "my_project"
-    And I have created a directory called "my_project/features"
-    And I have created a file called "my_project/features/some.feature" containing:
-      """
-      Feature: Cucumber
-        In order to use cucumber conveniently
-        As a developer
-        I want shoe to give me a rake task
-
-        @wip
-        Scenario: Running rake --tasks in a shoe project with work-in-progress Cucumber features
-          Given I have created a directory called "my_project"
-      """
-    And I have run shoe inside "my_project"
-    When I run rake --tasks inside "my_project"
-    Then I should see "rake cucumber:wip" on standard out

data/features/getting_started.feature

@@ -5,22 +5,25 @@ Feature: Getting started
 
   Scenario: Running shoe with no arguments in an empty directory
     Given I have created a directory called "my_project"
-    When I run shoe inside "my_project"
+    And I have created a file called "my_project/Gemfile" containing:
+      """
+      source :gemcutter
+      gem 'shoe'
+      """
+    When I run bundle exec shoe inside "my_project"
     Then I should see a file "my_project/Rakefile"
     And I should see a file "my_project/README.rdoc"
+    And I should see a file "my_project/lib/my_project/version.rb"
+    And I should see a file "my_project/my_project.gemspec"
 
   Scenario: Running shoe with no arguments in a directory that already has a Rakefile
     Given I have created a directory called "my_project"
+    And I have created a file called "my_project/Gemfile" containing:
+      """
+      source :gemcutter
+      gem 'shoe'
+      """
     And I have created a file called "my_project/Rakefile" containing "# RAKEFILE CONTENTS"
-    When I run shoe inside "my_project"
+    When I run bundle exec shoe inside "my_project"
     Then I should see "Rakefile exists. Not clobbering." on standard error
     And the contents of "my_project/Rakefile" should still be "# RAKEFILE CONTENTS"
-    And I should see a file "my_project/README.rdoc"
-
-  Scenario: Running shoe with no arguments in a directory that already has a README.rdoc
-    Given I have created a directory called "my_project"
-    And I have created a file called "my_project/README.rdoc" containing "= README CONTENTS"
-    When I run shoe inside "my_project"
-    Then I should see a file "my_project/Rakefile"
-    Then I should see "README.rdoc exists. Not clobbering." on standard error
-    And the contents of "my_project/README.rdoc" should still be "= README CONTENTS"

data/features/release.feature

@@ -5,40 +5,29 @@ Feature: Release
 
   Background:
     Given I have created a directory called "origin"
-    And I have run git init inside "origin"
-    Given I have created a directory called "my_project"
-    And I have run shoe inside "my_project"
+    And I have run git init --bare inside "origin"
+    Given I have created a project called "my_project"
     And I have run git init inside "my_project"
     And I have run git add . inside "my_project"
     And I have run git commit -m "Initial commit" inside "my_project"
-    And I have run git remote add origin ../origin inside "my_project"
 
   Scenario: I can release
-    When I run git push origin master inside "my_project"
-    And I replace "0.0.0" with "0.1.0" in the file "my_project/Rakefile"
-    And I run rake --tasks inside "my_project"
+    When I replace "0.0.0" with "0.1.0" in the file "my_project/lib/my_project/version.rb"
+    And I run bundle exec rake --tasks inside "my_project"
     Then I should see "rake release" on standard out
 
   Scenario: I cannot release when the version is 0.0.0
-    When I run git push origin master inside "my_project"
-    And I run rake --tasks inside "my_project"
+    When I run bundle exec rake --tasks inside "my_project"
     Then I should not see "rake release" on standard out
 
   Scenario: I cannot release when I already have a tag for the current version
-    When I run git push origin master inside "my_project"
-    And I run git tag 0.1.0 inside "my_project"
-    And I replace "0.0.0" with "0.1.0" in the file "my_project/Rakefile"
-    And I run rake --tasks inside "my_project"
-    Then I should not see "rake release" on standard out
-
-  Scenario: I cannot release when I have not yet pushed master to origin
-    When I replace "0.0.0" with "0.1.0" in the file "my_project/Rakefile"
-    And I run rake --tasks inside "my_project"
+    When I run git tag v0.1.0 inside "my_project"
+    And I replace "0.0.0" with "0.1.0" in the file "my_project/lib/my_project/version.rb"
+    And I run bundle exec rake --tasks inside "my_project"
     Then I should not see "rake release" on standard out
 
   Scenario: I cannot release from a branch other than master
-    When I run git push origin master inside "my_project"
-    And I run git checkout -b topic inside "my_project"
-    And I replace "0.0.0" with "0.1.0" in the file "my_project/Rakefile"
-    And I run rake --tasks inside "my_project"
+    When I run git checkout -b topic inside "my_project"
+    And I replace "0.0.0" with "0.1.0" in the file "my_project/lib/my_project/version.rb"
+    And I run bundle exec rake --tasks inside "my_project"
     Then I should not see "rake release" on standard out

data/features/step_definitions/shoe_steps.rb

@@ -1,3 +1,12 @@
+Given /^I have created a project called "([^\"]*)"$/ do |name|
+  create_directory(name)
+  create_file("#{name}/Gemfile", <<-END.gsub(/^\s*/, ''))
+    source :gemcutter
+    gem 'shoe'
+  END
+  run('bundle exec shoe', name)
+end
+
 Given /^I have created a directory called "([^\"]*)"$/ do |name|
   create_directory(name)
 end
@@ -18,17 +27,18 @@ When /^I (?:have )?run (.*) inside "([^\"]*)"$/ do |command, path|
   run(command, path)
 end
 
-Then /^I (should.*) see "([^\"]*)" on (standard.*)$/ do |should_or_should_not, message, standard_out_or_error|
+Then /^I should(.*) see "([^\"]*)" on (standard.*)$/ do |negate, message, standard_out_or_error|
   standard_out_or_error.tr!(' ', '_')
-  should_or_should_not.tr!(' ', '_')
+  am_i_expecting_to_see_something = negate.strip.empty?
+  contents = send(standard_out_or_error)
 
-  send(standard_out_or_error).send(should_or_should_not, include(message))
+  assert_equal am_i_expecting_to_see_something, contents.include?(message), contents
 end
 
 Then /^I should see a file "([^\"]*)"$/ do |path|
-  file(path).exist?.should == true
+  assert file(path).exist?
 end
 
 Then /^the contents of "([^\"]*)" should still be "([^\"]*)"$/ do |path, expected|
-  file(path).read.should == expected
+  assert_equal expected, file(path).read
 end

data/features/support/env.rb

@@ -1,5 +1,6 @@
 require 'open3'
 require 'pathname'
+require 'test/unit/assertions'
 require 'tmpdir'
 
 class WorkingDirectory
@@ -18,7 +19,11 @@ class WorkingDirectory
   end
 
   def create_file(path, contents)
-    file(path).open('w') { |file| file.write(contents) }
+    file(path).open('w') { |file| file.write(be_sneaky_with_the_gemfile(contents)) }
+  end
+
+  def append_file(path, contents)
+    file(path).open('a') { |file| file.write(contents) }
   end
 
   def edit_file(path, search, replace)
@@ -33,7 +38,7 @@ class WorkingDirectory
 
   def run(command, path)
     Dir.chdir(working_directory.join(path)) do
-      Open3.popen3(rejigger_the_path(command)) do |stdin, stdout, stderr|
+      Open3.popen3(isolate_environment(command)) do |stdin, stdout, stderr|
         @standard_out   = stdout.read
         @standard_error = stderr.read
       end
@@ -42,11 +47,18 @@ class WorkingDirectory
 
   private
 
-  def rejigger_the_path(command)
-    "/usr/bin/env PATH='#{PROJECT_ROOT.join('bin')}:#{ENV['PATH']}' RUBYLIB='#{PROJECT_ROOT.join('lib')}' #{command}"
+  def be_sneaky_with_the_gemfile(contents)
+    contents.sub("gem 'shoe'", "gem 'shoe', :path => '#{Pathname.pwd.expand_path}'")
+  end
+
+  # bundle exec rake running from bundle exec cucumber otherwise gets confused
+  # about where the real Gemfile is.
+  def isolate_environment(command)
+    "/usr/bin/env -i HOME=#{ENV['HOME']} PATH=#{ENV['PATH']} #{command}"
   end
 end
 
+World(Test::Unit::Assertions)
 World  { WorkingDirectory.new }
 Before { working_directory.mkpath }
 After  { working_directory.rmtree }

data/lib/shoe.rb

@@ -1,192 +1,25 @@
-require 'rubygems/doc_manager'
-require 'rubygems/ext'
-
-# Shoe defines some handy Rake tasks for your project, all built around your Gem::Specification.
+# Shoe defines some handy Rake tasks for your project, all built around your
+# Gem::Specification.
 #
 # Here's how you use it in your Rakefile:
 #
 #  require 'shoe'
 #  Shoe.tie('myproject', '0.1.0', "This is my project, and it's awesome!") do |spec|
 #    # do whatever you want with the Gem::Specification here, for example:
-#    # spec.add_development_dependency 'shoulda'
+#    # spec.add_runtime_dependency 'dnssd'
 #  end
 #
-# Shoe comes with an executable named "shoe" that will generate a Rakefile like this (but slightly fancier) for you.
-class Shoe
+# Shoe comes with an executable named "shoe" that will generate a Rakefile like
+# this (but slightly fancier) for you.
+module Shoe
+  autoload :Project, 'shoe/project'
+  autoload :Tasks,   'shoe/tasks'
+
   # Here's where you start. In your Rakefile, you'll probably just call
   # Shoe.tie, then add any dependencies in the block.
   def self.tie(name, version, summary)
-    shoe = new(name, version, summary)
-    yield shoe.spec if block_given?
-    shoe.define_tasks
-  end
-
-  # The Gem::Specification for your project.
-  attr_reader :spec
-
-  # Initializes a Gem::Specification with some nice conventions.
-  def initialize(name, version, summary)
-    @spec = Gem::Specification.new do |spec|
-      spec.name             = name
-      spec.version          = version
-      spec.summary          = summary
-      spec.files            = FileList['Rakefile', '*.gemspec', '**/*.rdoc', 'bin/**/*', 'examples/**/*', 'ext/**/extconf.rb', 'ext/**/*.c', 'features/**/*', 'lib/**/*', 'resources/**/*', 'shoulda_macros/**/*', 'test/**/*'].to_a
-      spec.executables      = everything_in_the_bin_directory
-      spec.extensions       = FileList['ext/**/extconf.rb'].to_a
-      spec.rdoc_options     = %W(--main README.rdoc --title #{name}-#{version} --inline-source) # MAYBE include --all, so that we document private methods?
-      spec.extra_rdoc_files = FileList['**/*.rdoc', 'shoulda_macros/**/*'].to_a
-      spec.has_rdoc         = true
-      spec.author           = `git config --get user.name`.chomp
-      spec.email            = `git config --get user.email`.chomp
-      spec.add_development_dependency 'shoe'
-    end
-
-    def @spec.remove_development_dependency_on_shoe
-      dependencies.delete_if { |d| d.name == 'shoe' }
-    end
-  end
-
-  # This is where the magic happens.
-  def define_tasks
-    if File.directory?('.git')
-      desc 'Remove ignored files'
-      task :clean do
-        sh 'git clean -fdX'
-      end
-    end
-
-    if File.directory?('lib')
-      desc 'Generate documentation'
-      task :rdoc do
-        LocalDocManager.new(spec).generate_rdoc
-
-        case RUBY_PLATFORM
-        when /darwin/
-          sh 'open rdoc/index.html'
-        when /mswin|mingw/
-          sh 'start rdoc\index.html'
-        else
-          sh 'firefox rdoc/index.html'
-        end
-      end
-    end
-
-    if File.file?("lib/#{spec.name}.rb")
-      desc 'Run an irb console'
-      task :shell do
-        exec 'irb', '-Ilib', "-r#{spec.name}"
-      end
-    end
-
-    if File.directory?('test')
-      require 'rake/testtask'
-      # MAYBE be a little more forgiving in test selection, using test/**/*_test.rb. Or create suites based on subdirectory?
-      Rake::TestTask.new do |task|
-        task.libs    = ['lib', 'test']
-        task.pattern = 'test/*_test.rb'
-      end
-      default_depends_on(:test)
-    end
-
-    if File.directory?('features')
-      require 'cucumber/rake/task'
-      Cucumber::Rake::Task.new(:cucumber, 'Run features') { |task| task.cucumber_opts = '--tags ~@wip' }
-      default_depends_on(:cucumber)
-
-      if there_are_any_work_in_progress_features
-        namespace :cucumber do
-          Cucumber::Rake::Task.new(:wip, 'Run work-in-progress features') { |task| task.cucumber_opts = '--tags @wip --wip' }
-        end
-      end
-    end
-
-    desc 'Show latest gemspec contents'
-    task :gemspec do
-      puts spec.to_ruby
-    end
-
-    if the_current_version_is_greater_than_zero && there_is_no_tag_for_the_current_version && we_are_on_the_master_branch && we_have_already_pushed_the_master_branch_to_a_remote_called_origin
-      desc "Release #{spec.name}-#{spec.version}"
-      task :release do
-        File.open("#{spec.name}.gemspec", 'w') { |f| f.write spec.to_ruby }
-        sh "git add #{spec.name}.gemspec"
-        sh "git commit -a -m 'Release #{spec.version}'"
-        sh "git tag #{spec.version}"
-        sh 'git push'
-        sh 'git push --tags'
-        sh "gem build #{spec.name}.gemspec"
-        sh "gem push #{spec.file_name}"
-      end
-    end
-
-    if File.directory?('ext')
-      desc 'Compile C extensions'
-      task :compile do
-        top_level_path   = File.expand_path('.')
-        destination_path = File.join(top_level_path, spec.require_paths.first)
-
-        spec.extensions.each do |extension|
-          Dir.chdir(File.dirname(extension)) do
-            Gem::Ext::ExtConfBuilder.build(extension, top_level_path, destination_path, results = [])
-          end
-        end
-      end
-
-      [:test, :cucumber, 'cucumber:wip', :release].each do |task_name|
-        if Rake.application.lookup(task_name)
-          task task_name => :compile
-        end
-      end
-    end
-  end
-
-  private
-
-  def default_depends_on(task_name)
-    desc Rake.application.lookup(task_name).comment
-    task :default => task_name
-  end
-
-  def everything_in_the_bin_directory
-    File.directory?('bin') ? Dir.entries('bin') - ['.', '..'] : []
-  end
-
-  def the_current_version_is_greater_than_zero
-    spec.version > Gem::Version.new('0.0.0')
-  end
-
-  def there_are_any_work_in_progress_features
-    Dir.glob('features/**/*.feature').detect do |path|
-      File.read(path).include?('@wip')
-    end
-  end
-
-  def there_is_no_tag_for_the_current_version
-    !File.file?(".git/refs/tags/#{spec.version}")
-  end
-
-  def we_are_on_the_master_branch
-    File.file?('.git/HEAD') && File.read('.git/HEAD').strip == 'ref: refs/heads/master'
-  end
-
-  def we_have_already_pushed_the_master_branch_to_a_remote_called_origin
-    File.file?('.git/refs/remotes/origin/master')
-  end
-
-  # Using Gem::DocManager instead of Rake::RDocTask means you get to see your
-  # rdoc *exactly* as users who install your gem will.
-  class LocalDocManager < Gem::DocManager #:nodoc:
-    def initialize(spec)
-      @spec      = spec
-      @doc_dir   = Dir.pwd
-      @rdoc_args = []
-      adjust_spec_so_that_we_can_generate_rdoc_locally
-    end
-
-    def adjust_spec_so_that_we_can_generate_rdoc_locally
-      def @spec.full_gem_path
-        Dir.pwd
-      end
-    end
+    project = Project.new(name, version, summary)
+    yield project.spec if block_given?
+    project.define_tasks
   end
 end