shoe 0.6.2 → 0.7.0

data/lib/shoe/tasks/compile.rb

@@ -13,7 +13,7 @@ module Shoe
     # To enable and configure, add
     # <tt>extensions[http://docs.rubygems.org/read/chapter/20#extensions]</tt>
     # to your gemspec.
-    class Compile < Abstract
+    class Compile < Task
       def active?
         !spec.extensions.empty?
       end
@@ -40,9 +40,7 @@ module Shoe
           end
         end
 
-        namespace :prepare do
-          task :execute => :compile
-        end
+        task :prepare => :compile
       end
     end
 

data/lib/shoe/tasks/cucumber.rb

@@ -12,7 +12,7 @@ module Shoe
     #
     # To enable and configure, create and edit your
     # <tt>{cucumber.yml}[http://wiki.github.com/aslakhellesoy/cucumber/cucumberyml]</tt>.
-    class Cucumber < Abstract
+    class Cucumber < Task
       def active?
         !cucumber_profiles.empty?
       end
@@ -44,11 +44,9 @@ module Shoe
       end
 
       def define_default_task
-        namespace :prepare do
-          task :execute
-        end
+        task :prepare
 
-        ::Cucumber::Rake::Task.new({ :cucumber => 'prepare:execute' }, "Run features.\nConfigure via the default profile in cucumber.yml.") do |task|
+        ::Cucumber::Rake::Task.new({ :cucumber => :prepare }, "Run features.\nConfigure via the default profile in cucumber.yml.") do |task|
           task.profile = 'default'
         end
 
@@ -56,12 +54,10 @@ module Shoe
       end
 
       def define_profile_task(profile)
-        namespace :prepare do
-          task :execute
-        end
+        task :prepare
 
         namespace :cucumber do
-          ::Cucumber::Rake::Task.new({ profile => 'prepare:execute' }, "Run #{profile} features.\nConfigure via the #{profile} profile in cucumber.yml.") do |task|
+          ::Cucumber::Rake::Task.new({ profile => :prepare }, "Run #{profile} features.\nConfigure via the #{profile} profile in cucumber.yml.") do |task|
             task.profile = profile
           end
         end

data/lib/shoe/tasks/rdoc.rb

@@ -1,5 +1,4 @@
 require 'rubygems/doc_manager'
-require 'launchy'
 
 module Shoe
   module Tasks
@@ -23,7 +22,7 @@ module Shoe
     # <tt>rdoc_options[http://docs.rubygems.org/read/chapter/20#rdoc_options]</tt> and
     # <tt>extra_rdoc_files[http://docs.rubygems.org/read/chapter/20#extra_rdoc_files]</tt>
     # to your gemspec.
-    class Rdoc < Abstract
+    class Rdoc < Task
       def active?
         true
       end
@@ -37,7 +36,7 @@ module Shoe
         END
         task :rdoc do
           Gem::DocManager.new(spec).extend(Extensions::DocManager).generate_rdoc
-          Launchy::Browser.run('rdoc/index.html')
+          Shoe.browse('rdoc/index.html')
         end
       end
     end

data/lib/shoe/tasks/ronn.rb

@@ -17,13 +17,13 @@ module Shoe
     # * It's best to include the generated man pages in your gem, so that
     #   {gem-man}[http://github.com/defunkt/gem-man] can get to them.
     #
-    # * Ronn becomes a prerequisite for Release, so your man pages are sure to
-    #   be up-to-date.
+    # * Ronn becomes a prerequisite for <tt>rake build</tt>, so your man pages
+    #   are sure to be up-to-date.
     #
     # * You may like to add a <tt>task :man => :ronn</tt> to your
     #   <tt>Rakefile</tt>. I felt a little uncomfortable clogging that
     #   namespace without your consent.
-    class Ronn < Abstract
+    class Ronn < Task
       def active?
         !ronn_files.empty?
       end
@@ -59,8 +59,8 @@ module Shoe
           ronn('--roff', task.source)
         end
 
-        namespace :prepare do
-          task :release => 'ronn:build'
+        if Rake::Task.task_defined?(:build)
+          task :build => 'ronn:build'
         end
       end
 

data/lib/shoe/tasks/{abstract.rb → task.rb}

@@ -1,7 +1,7 @@
 module Shoe
   module Tasks
 
-    class Abstract
+    class Task
       attr_reader :spec
 
       def initialize(spec)

data/lib/shoe/tasks/test.rb

@@ -1,12 +1,4 @@
 require 'rubygems/validator'
-require 'test/unit/ui/console/testrunner'
-
-# Disable Test::Unit::AutoRunner.
-#
-# Though I tried to be really restrictive with the above testrunner require
-# statement, test/unit itself still gets pulled in, activating the at_exit
-# hook. Dang.
-Test::Unit.run = true
 
 module Shoe
   module Tasks
@@ -19,60 +11,33 @@ module Shoe
     # check}[http://docs.rubygems.org/read/chapter/10#page30] --test
     # your_project`</tt>.
     #
-    # (Incidentally, this ensures your tests _are_ runnable via <tt>`gem
-    # check`</tt>, a forgotten command second only to <tt>`{gem
-    # cert}[http://docs.rubygems.org/read/chapter/10#page93]`</tt> in its
-    # underuse.)
-    #
     # To enable and configure, edit the
     # <tt>test_files[http://docs.rubygems.org/read/chapter/20#test_files]</tt>
     # in your gemspec.
     #
-    # = <tt>Test::Unit</tt>
-    #
-    # Using <tt>Gem::Validator</tt> in this way means that you *must* use
-    # <tt>Test::Unit</tt> in all of your
-    # <tt>test_files[http://docs</tt>.rubygems.org/read/chapter/20#test_files]
-    # -- if you prefer Rspec[http://rspec.info], just leave <tt>test_files</tt>
-    # blank and set up your own Rake task.
-    #
-    # = <tt>$LOAD_PATH</tt>
-    #
-    # At test time, the root of your gem, any
-    # <tt>{require_paths}[http://docs.rubygems.org/read/chapter/20#require_paths]</tt>,
-    # and any
-    # <tt>{dependencies}[http://docs.rubygems.org/read/chapter/20#dependencies]</tt>
-    # are on the <tt>$LOAD_PATH</tt>.
-    #
-    # <b>Wrong:</b>
+    # = A Few Precautions
     #
-    #  # Don't do this; test_helper's not in the $LOAD_PATH
-    #  require 'test_helper'
+    # * Using <tt>Gem::Validator</tt> means that only <tt>Test::Unit</tt> (all
+    #   Rubies) and <tt>MiniTest::Unit</tt> (Ruby 1.9) tests will be run.
     #
-    # <b>Right:</b>
+    # * You'll need to <tt>Bundler.setup(:default, :development)</tt> in your
+    #   <tt>Rakefile</tt> so that the <tt>Gem::Validator</tt> can find your
+    #   code. (If you put this line in your <tt>test_helper</tt> instead,
+    #   you'll break <tt>`gem check --test`</tt> for people who don't have
+    #   Bundler installed.)
     #
-    #  require 'test/test_helper'
+    # * The <tt>test</tt> directory will not be in the <tt>$LOAD_PATH</tt>, so
+    #   you'll have to <tt>require 'test/test_helper'</tt>.
     #
     # = Pretty Colors
     #
-    # If you like pretty colors (I do!), just <tt>require
-    # '{redgreen}[http://rubygems.org/gems/redgreen]'</tt> in your tests. The
-    # <tt>Gem::Validator</tt> has been configured to play nicely with it.
+    # For Ruby 1.8, Shoe patches the <tt>Gem::Validator</tt> to play nicely with
+    # {redgreen}[http://rubygems.org/gems/redgreen]</tt>.
     #
-    # <b>Wrong:</b>
+    # For Ruby 1.9, <tt>require 'shoe/util/minitest_colors'</tt> in your
+    # <tt>test_helper</tt>.
     #
-    #  # Don't do this; it breaks `gem check --test` if redgreen's not installed.
-    #  require 'redgreen' if $stdout.tty?
-    #
-    # <b>Right:</b>
-    #
-    #  begin
-    #    require 'redgreen' if $stdout.tty?
-    #  rescue LoadError
-    #    # No colors, but `gem check --test` is golden!
-    #  end
-    #
-    class Test < Abstract
+    class Test < Task
       def active?
         !spec.test_files.empty?
       end
@@ -84,18 +49,13 @@ module Shoe
         END
 
         task :test do
-          Gem.source_index.extend(Extensions::SourceIndex)
-          Gem.source_index.local_gemspec = spec
-
           Gem::Validator.extend(Extensions::Validator)
           Gem::Validator.new.unit_test(spec)
         end
 
-        namespace :prepare do
-          task :execute
-        end
+        task :prepare
 
-        task :test => 'prepare:execute'
+        task :test => :prepare
 
         task :default
         Rake.application[:default].prerequisites.unshift(Rake.application[:test])

data/lib/shoe/util/minitest_colors.rb

@@ -0,0 +1,60 @@
+require 'delegate'
+
+module Shoe
+  module Util
+
+    class MiniTestColors < DelegateClass(IO)
+      RED    = 31
+      GREEN  = 32
+      YELLOW = 33
+      CYAN   = 36
+
+      def print(object)
+        case object
+        when '.'
+          super color(GREEN, object)
+        when 'F'
+          super color(RED, object)
+        when 'E'
+          super color(YELLOW, object)
+        when 'S'
+          super color(CYAN, object)
+        else
+          super
+        end
+      end
+
+      STATUS = /\d+ tests, \d+ assertions, (\d+) failures, (\d+) errors, \d+ skips/
+
+      def puts(*objects)
+        if objects.size == 1
+          string = objects.first
+
+          string.gsub!(STATUS) do |match|
+            failures, errors = $1.to_i, $2.to_i
+            if failures + errors == 0
+              color(GREEN, match)
+            else
+              color(RED, match)
+            end
+          end
+
+          string.gsub!(/\bFailure:/) { |s| color(RED, s) }
+          string.gsub!(/\bError:/)   { |s| color(YELLOW, s) }
+          string.gsub!(/\bSkipped:/) { |s| color(CYAN, s) }
+        end
+
+        super
+      end
+
+      private
+
+      def color(code, string)
+        "\e[#{code}m#{string}\e[0m"
+      end
+    end
+
+  end
+end
+
+MiniTest::Unit.output = Shoe::Util::MiniTestColors.new($stdout)

data/lib/shoe/version.rb

@@ -0,0 +1,3 @@
+module Shoe
+  VERSION = '0.7.0'
+end

data/man/shoe.3

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.5
 .\" http://github.com/rtomayko/ronn/
 .
-.TH "SHOE" "3" "April 2010" "Matthew Todd" "RubyGems Manual"
+.TH "SHOE" "3" "October 2010" "Matthew Todd" "RubyGems Manual"
 .
 .SH "NAME"
 \fBshoe\fR \-\- standard Rake tasks for your RubyGems project
@@ -10,10 +10,10 @@
 require 'shoe'
 .
 .br
-Shoe::Tasks.define('\fIproject.gemspec\fR')
+Shoe.install_tasks
 .
 .SH "DESCRIPTION"
-\fBShoe::Tasks.define()\fR defines a number of standard \fBrake(1)\fR tasks for your
+\fBShoe.install_tasks\fR defines a number of standard \fBrake(1)\fR tasks for your
 RubyGems project. These tasks derive their configuration from your
 Gem::Specification, and they assume you are using \fBgit(1)\fR.
 .
@@ -22,7 +22,7 @@ Gem::Specification, and they assume you are using \fBgit(1)\fR.
 .TP
 \fBrake clean\fR
 Remove ignored files. Calls something like \fBgit\-clean(1)\fR with the \fB\-fdX\fR
-options, honoring your \fBgitignore(5)\fR rules, but preserving \fB.bundle/\fR and \fB.rvmrc\fR.
+options, honoring your \fBgitignore(5)\fR rules, but preserving \fB.bundle/\fR.
 .
 .TP
 \fBrake compile\fR
@@ -42,12 +42,6 @@ reads the \fBrdoc_options\fR and \fBextra_rdoc_files\fR fields in your
 Gem::Specification.
 .
 .TP
-\fBrake release\fR
-Push a release to \fIhttp://rubygems.org/\fR, additionally running \fBgit\-push(1)\fR if
-you have a \fBgit\-remote(1)\fR named \fBorigin\fR. Before pushing, runs \fBgit\-commit(1)\fR and \fBgit\-tag(1)\fR with the current \fBversion\fR in your
-Gem::Specification.
-.
-.TP
 \fBrake ronn\fR
 Generate man pages with \fBronn(1)\fR from the \fBman/*.ronn\fR sources listed in the \fBfiles\fR field of your Gem::Specification. (The generated manpages will then
 be available via \fBgem\-man(1)\fR once your gem is installed.)
@@ -65,4 +59,4 @@ Matthew Todd, \fImatthewtodd\fR on GitHub. Do drop
 me a line if you use \fBshoe\fR \-\- I'd love to hear from you!
 .
 .SH "SEE ALSO"
-\fIshoe(1)\fR, \fIhttp://docs.rubygems.org/read/chapter/20\fR, \fIhttp://semver.org/\fR
+\fIhttp://docs.rubygems.org/read/chapter/20\fR

data/man/shoe.3.ronn

@@ -4,11 +4,11 @@ shoe(3) -- standard Rake tasks for your RubyGems project
 ## SYNOPSIS
 
 require 'shoe'  
-Shoe::Tasks.define('_project.gemspec_')
+Shoe.install_tasks
 
 ## DESCRIPTION
 
-`Shoe::Tasks.define()` defines a number of standard `rake(1)` tasks for your
+`Shoe.install_tasks` defines a number of standard `rake(1)` tasks for your
 RubyGems project. These tasks derive their configuration from your
 Gem::Specification, and they assume you are using `git(1)`.
 
@@ -16,8 +16,7 @@ Gem::Specification, and they assume you are using `git(1)`.
 
 * `rake clean`:
   Remove ignored files. Calls something like `git-clean(1)` with the `-fdX`
-  options, honoring your `gitignore(5)` rules, but preserving `.bundle/` and
-  `.rvmrc`.
+  options, honoring your `gitignore(5)` rules, but preserving `.bundle/`.
 
 * `rake compile`:
   Compile C extensions with RubyGems' built-in Gem::Ext::ExtConfBuilder,
@@ -33,12 +32,6 @@ Gem::Specification, and they assume you are using `git(1)`.
   reads the `rdoc_options` and `extra_rdoc_files` fields in your
   Gem::Specification.
 
-* `rake release`:
-  Push a release to <http://rubygems.org/>, additionally running `git-push(1)` if
-  you have a `git-remote(1)` named `origin`. Before pushing, runs
-  `git-commit(1)` and `git-tag(1)` with the current `version` in your
-  Gem::Specification.
-
 * `rake ronn`:
   Generate man pages with `ronn(1)` from the `man/*.ronn` sources listed in the
   `files` field of your Gem::Specification. (The generated manpages will then
@@ -59,6 +52,4 @@ me a line if you use `shoe` -- I'd love to hear from you!
 
 ## SEE ALSO
 
-[shoe(1)](shoe.1.html),
-<http://docs.rubygems.org/read/chapter/20>,
-<http://semver.org/>
+<http://docs.rubygems.org/read/chapter/20>

data/shoe.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'shoe/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'shoe'
+  s.version     = Shoe::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Matthew Todd']
+  s.email       = ['matthew.todd@gmail.com']
+  s.homepage    = 'http://github.com/matthewtodd/shoe'
+  s.summary     = 'Configuration-free Rake tasks that read your gemspec.'
+  s.description = "#{s.summary} These tasks re-use built-in Rubygems functionality so you can be confident you're shipping what you think you are."
+
+  s.rubyforge_project = 'shoe'
+
+  s.requirements = ['git']
+  s.required_rubygems_version = '>= 1.3.6'
+  s.add_runtime_dependency 'rake', '~> 0.8.7'
+  s.add_development_dependency 'bundler',  '~> 1.0.0'
+  s.add_development_dependency 'cucumber', '~> 0.6.4'
+  s.add_development_dependency 'ronn',     '~> 0.5'
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- test`.split("\n")
+  s.extra_rdoc_files = `git ls-files -- "**/*.rdoc"`.split("\n")
+  s.require_paths    = ['lib']
+
+  s.rdoc_options = %W(
+    --main README.rdoc
+    --title #{s.full_name}
+    --inline-source
+    --webcvs http://github.com/matthewtodd/shoe/blob/v#{s.version}/
+  )
+end

data/test/helper.rb

@@ -1,20 +1,14 @@
 require 'test/unit'
 require 'shoe'
 
-begin
-  require 'redgreen' if $stdout.tty?
-rescue LoadError
-  # Since we don't have hard gem dependencies for testing, folks can run `gem
-  # check --test shoe` without installing anything else.
+if RUBY_VERSION >= '1.9' && $stdout.tty?
+  require 'shoe/util/minitest_colors'
 end
 
-module Shoe
-  module TestExtensions
-    autoload :FakeRubygemsServer,  'test/extensions/fake_rubygems_server'
-    autoload :HelperMethods,       'test/extensions/helper_methods'
-    autoload :IsolatedEnvironment, 'test/extensions/isolated_environment'
-    autoload :TestCase,            'test/extensions/test_case'
+class Shoe::TestCase < Test::Unit::TestCase
+  def default_test
+    # keep Test::Unit from complaining
   end
 end
 
-Test::Unit::TestCase.extend(Shoe::TestExtensions::TestCase)
+Dir['test/support/*.rb'].each { |path| require path }