shoe 0.2.0 → 0.3.0

data/README.rdoc

@@ -1,17 +1,19 @@
 = Shoe
 
-You probably don't want to use shoe -- especially if you're like me!
+Shoe defines some handy Rake tasks for your project, all built around your
+Gem::Specification.
 
-I like tinkering with my build scripts, so I made shoe, even though
+Shoe is a small blip in the grand tradition of more popular projects like
 hoe[http://seattlerb.rubyforge.org/hoe] and
-jeweler[http://github.com/technicalpickles/jeweler] are awesome.
+jeweler[http://github.com/technicalpickles/jeweler]. I had an itch to scratch,
+you understand.
 
 == Behold
 
 Here's how your +Rakefile+ looks:
 
- require 'shoe'
  require 'my_project/version'
+ require 'shoe'
 
  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:
@@ -34,7 +36,7 @@ And here's what you get, at most:
 Most of the time, though, you won't see all of these: when possible, tasks are
 conditionally defined.
 
-See what I mean by reading <tt>Shoe#define_tasks</tt>.
+See what I mean by clicking through the various <tt>Shoe::Tasks</tt>.
 
 == Getting Started
 
@@ -42,14 +44,15 @@ See what I mean by reading <tt>Shoe#define_tasks</tt>.
 
 1. Start with just shoe in your +Gemfile+:
 
-    source :gemcutter
+    source :rubygems
     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>.)
+   (If you run into trouble, {this blog
+   post}[http://matthewtodd.org/2010/02/19/bundle-exec-bash.html] may help.)
 
 3. Use +shoe+ to generate some skeleton project files:
 

data/Rakefile

@@ -3,5 +3,6 @@ require 'shoe/version'
 
 Shoe.tie('shoe', Shoe::VERSION, 'Another take on hoe, jeweler & friends.') do |spec|
   spec.requirements = ['git']
+  spec.required_rubygems_version = '>= 1.3.6'
   spec.add_runtime_dependency 'rake'
 end

data/bin/shoe

@@ -1,3 +1,4 @@
-require 'shoe/cli'
+#!/usr/bin/env ruby
 
+require 'shoe/cli'
 Shoe::CLI.run

data/features/cucumber.feature

@@ -10,6 +10,7 @@ Feature: Cucumber
 
   Scenario: Running rake --tasks in a shoe project with Cucumber features
     Given I have created a project called "my_project"
+    And I have appended "gem 'cucumber'" to "my_project/Gemfile"
     And I have created a directory called "my_project/features"
     When I run bundle exec rake --tasks inside "my_project"
     Then I should see "rake cucumber" on standard out

data/features/getting_started.feature

@@ -7,7 +7,7 @@ Feature: Getting started
     Given I have created a directory called "my_project"
     And I have created a file called "my_project/Gemfile" containing:
       """
-      source :gemcutter
+      source :rubygems
       gem 'shoe'
       """
     When I run bundle exec shoe inside "my_project"
@@ -20,7 +20,7 @@ Feature: Getting started
     Given I have created a directory called "my_project"
     And I have created a file called "my_project/Gemfile" containing:
       """
-      source :gemcutter
+      source :rubygems
       gem 'shoe'
       """
     And I have created a file called "my_project/Rakefile" containing "# RAKEFILE CONTENTS"

data/features/step_definitions/shoe_steps.rb

@@ -1,7 +1,7 @@
 Given /^I have created a project called "([^\"]*)"$/ do |name|
   create_directory(name)
   create_file("#{name}/Gemfile", <<-END.gsub(/^\s*/, ''))
-    source :gemcutter
+    source :rubygems
     gem 'shoe'
   END
   run('bundle exec shoe', name)
@@ -19,6 +19,10 @@ Given /^I have created a file called "([^\"]*)" containing:$/ do |path, contents
   create_file(path, contents)
 end
 
+Given /^I have appended "([^\"]*)" to "([^\"]*)"$/ do |contents, path|
+  append_file(path, contents)
+end
+
 When /^I replace "([^\"]*)" with "([^\"]*)" in the file "([^\"]*)"$/ do |search, replace, path|
   edit_file(path, search, replace)
 end

data/features/support/env.rb

@@ -4,7 +4,7 @@ require 'test/unit/assertions'
 require 'tmpdir'
 
 class WorkingDirectory
-  PROJECT_ROOT = Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '..', '..')))
+  PROJECT_ROOT = Pathname.new(File.expand_path('../../..', __FILE__))
 
   attr_reader :working_directory
   attr_reader :standard_out
@@ -48,13 +48,22 @@ class WorkingDirectory
   private
 
   def be_sneaky_with_the_gemfile(contents)
-    contents.sub("gem 'shoe'", "gem 'shoe', :path => '#{Pathname.pwd.expand_path}'")
+    contents.sub("gem 'shoe'", "gem 'shoe', :path => '#{PROJECT_ROOT.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}"
+    # set the PATH so bundle exec can find shoe
+    ENV['PATH'] = ENV['PATH'].split(File::PATH_SEPARATOR).
+                            unshift(PROJECT_ROOT.join('bin')).uniq.
+                               join(File::PATH_SEPARATOR)
+
+    # whack most environment variables so nested bundle exec won't get confused
+    # about where the Gemfile is
+    "/usr/bin/env -i #{preserve_environment 'HOME', 'PATH', 'GEM_HOME', 'GEM_PATH'} #{command}"
+  end
+
+  def preserve_environment(*variables)
+    variables.map { |name| "#{name}='#{ENV[name]}'" }.join(' ')
   end
 end
 

data/lib/shoe.rb

@@ -1,22 +1,7 @@
-# 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_runtime_dependency 'dnssd'
-#  end
-#
-# 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)
     project = Project.new(name, version, summary)
     yield project.spec if block_given?

data/lib/shoe/cli.rb

@@ -3,7 +3,7 @@
 require 'erb'
 require 'pathname'
 
-class Shoe
+module Shoe
   class CLI
     class << self
       def run

data/lib/shoe/tasks.rb

@@ -74,6 +74,35 @@ module Shoe
           task name => dependency
         end
       end
+
+      def warn(subject, *paragraphs)
+        message = StringIO.new
+        width   = 72
+
+        message.puts '-' * width
+        message.puts "#{subject} warning from shoe".upcase
+        paragraphs.each do |paragraph|
+          message.puts
+          message.puts wrap(paragraph, width)
+        end
+        message.puts '-' * width
+
+        $stderr.write yellow(message.string)
+        $stderr.flush
+      end
+
+      # blatantly stolen from Gem::Command
+      def wrap(text, width)
+        text.gsub(/(.{1,#{width}})( +|$\n?)|(.{1,#{width}})/, "\\1\\3\n")
+      end
+
+      def yellow(string)
+        if $stderr.tty?
+          "\e[33m#{string}\e[0m"
+        else
+          string
+        end
+      end
     end
 
   end

data/lib/shoe/tasks/cucumber.rb

@@ -10,7 +10,9 @@ module Shoe
         begin
           require 'cucumber/rake/task'
         rescue LoadError
-          # no cuke for you
+          warn 'cucumber',
+            "Although you have a features directory, it seems you don't have cucumber installed.",
+            "You probably want to add a \"gem 'cucumber'\" to your Gemfile."
         else
           define_tasks
         end

data/lib/shoe/tasks/release.rb

@@ -22,18 +22,10 @@ module Shoe
           sh "git tag #{version_tag(spec.version)}"
 
           if there_is_no_tag_for('semver')
-            $stderr.puts <<-END.gsub(/^ +/, '')
-            ---------------------------------------------
-            SEMANTIC VERSIONING WARNING
-
-            It seems you don't yet have a 'semver' tag.
-
-            Please read more about the emerging consensus
-            around semantic versioning:
-
-            http://semver.org/
-            ---------------------------------------------
-            END
+            warn 'semantic versioning',
+              "It seems you don't yet have a 'semver' tag.",
+              'Please read more about the emerging consensus around semantic versioning:',
+              'http://semver.org'
           end
 
           if there_is_a_remote_called('origin')
@@ -42,22 +34,7 @@ module Shoe
           end
 
           sh "gem build #{spec.name}.gemspec"
-
-          if Gem::CommandManager.instance.command_names.include?('push')
-            sh "gem push #{spec.file_name}"
-          else
-            $stderr.puts <<-END.gsub(/^ +/, '')
-            ---------------------------------------------
-            GEMCUTTER WARNING
-
-            It seems you don't have gemcutter installed.
-
-            Please `gem install gemcutter` and
-            `gem push #{spec.file_name}`
-            if you would like to make a public release.
-            ---------------------------------------------
-            END
-          end
+          sh "gem push #{spec.file_name}"
         end
       end
 

data/lib/shoe/templates/rakefile.erb

@@ -1,5 +1,5 @@
-require 'shoe'
 require '<%= project %>/version'
+require 'shoe'
 
 Shoe.tie('<%= project %>', <%= project_class %>::VERSION, 'TODO write a summary of <%= project_class %> here.') do |spec|
   # do whatever you want with the Gem::Specification here, for example:

data/lib/shoe/version.rb

@@ -1,3 +1,3 @@
 module Shoe
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/shoe.gemspec

@@ -2,20 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shoe}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matthew Todd"]
-  s.date = %q{2010-02-16}
+  s.date = %q{2010-03-30}
   s.default_executable = %q{shoe}
   s.email = %q{matthew.todd@gmail.com}
   s.executables = ["shoe"]
-  s.extra_rdoc_files = ["BUNDLER.rdoc", "README.rdoc"]
-  s.files = ["Rakefile", "lib/shoe", "lib/shoe/cli.rb", "lib/shoe/project.rb", "lib/shoe/tasks", "lib/shoe/tasks/bin.rb", "lib/shoe/tasks/clean.rb", "lib/shoe/tasks/compile.rb", "lib/shoe/tasks/cucumber.rb", "lib/shoe/tasks/gemspec.rb", "lib/shoe/tasks/rdoc.rb", "lib/shoe/tasks/release.rb", "lib/shoe/tasks/resources.rb", "lib/shoe/tasks/shell.rb", "lib/shoe/tasks/shoulda.rb", "lib/shoe/tasks/test.rb", "lib/shoe/tasks.rb", "lib/shoe/templates", "lib/shoe/templates/gemfile.erb", "lib/shoe/templates/rakefile.erb", "lib/shoe/templates/readme.erb", "lib/shoe/templates/version.erb", "lib/shoe/version.rb", "lib/shoe.rb", "bin/shoe", "BUNDLER.rdoc", "README.rdoc", "shoe.gemspec", "features/cucumber.feature", "features/getting_started.feature", "features/release.feature", "features/step_definitions", "features/step_definitions/shoe_steps.rb", "features/support", "features/support/env.rb"]
-  s.rdoc_options = ["--main", "README.rdoc", "--title", "shoe-0.2.0", "--inline-source"]
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.files = ["Rakefile", "lib/shoe", "lib/shoe/cli.rb", "lib/shoe/project.rb", "lib/shoe/tasks", "lib/shoe/tasks/bin.rb", "lib/shoe/tasks/clean.rb", "lib/shoe/tasks/compile.rb", "lib/shoe/tasks/cucumber.rb", "lib/shoe/tasks/gemspec.rb", "lib/shoe/tasks/rdoc.rb", "lib/shoe/tasks/release.rb", "lib/shoe/tasks/resources.rb", "lib/shoe/tasks/shell.rb", "lib/shoe/tasks/shoulda.rb", "lib/shoe/tasks/test.rb", "lib/shoe/tasks.rb", "lib/shoe/templates", "lib/shoe/templates/gemfile.erb", "lib/shoe/templates/rakefile.erb", "lib/shoe/templates/readme.erb", "lib/shoe/templates/version.erb", "lib/shoe/version.rb", "lib/shoe.rb", "bin/shoe", "README.rdoc", "shoe.gemspec", "features/cucumber.feature", "features/getting_started.feature", "features/release.feature", "features/step_definitions", "features/step_definitions/shoe_steps.rb", "features/support", "features/support/env.rb"]
+  s.rdoc_options = ["--main", "README.rdoc", "--title", "shoe-0.3.0", "--inline-source"]
   s.require_paths = ["lib"]
   s.requirements = ["git"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Another take on hoe, jeweler & friends.}
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: shoe
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Matthew Todd
@@ -9,19 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-16 00:00:00 +03:00
+date: 2010-03-30 00:00:00 +03:00
 default_executable: shoe
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: 
 email: matthew.todd@gmail.com
 executables: 
@@ -29,7 +36,6 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- BUNDLER.rdoc
 - README.rdoc
 files: 
 - Rakefile
@@ -54,7 +60,6 @@ files:
 - lib/shoe/version.rb
 - lib/shoe.rb
 - bin/shoe
-- BUNDLER.rdoc
 - README.rdoc
 - shoe.gemspec
 - features/cucumber.feature
@@ -71,7 +76,7 @@ rdoc_options:
 - --main
 - README.rdoc
 - --title
-- shoe-0.2.0
+- shoe-0.3.0
 - --inline-source
 require_paths: 
 - lib
@@ -79,18 +84,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: 
 - git
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Another take on hoe, jeweler & friends.

data/BUNDLER.rdoc

@@ -1,38 +0,0 @@
-= 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'