shoe 0.6.2 → 0.7.0

data/{data/shoe/templates/gitignore.erb → .gitignore}

@@ -1,4 +1,4 @@
 .bundle
-.rvmrc
 *.gem
+pkg
 rdoc

data/.rvmrc

@@ -0,0 +1 @@
+rvm use @shoe

data/CHANGELOG.rdoc

@@ -1,4 +1,12 @@
-== Git
+== 0.7.0 -- 2010 October 11
+
+* 1.9 compatibility!
+* Remove shoe generator; use `bundle gem foo` instead.
+* Remove release tasks; suggest Bundler's instead.
+* Use Shoe.install_tasks to auto-detect gemspec.
+* Remove dependency on launchy.
+
+== 0.6.2 -- 2010 April 29
 
 * Generated C extension actually works now.
 * `rake test` now properly depends on `rake compile`.

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    shoe (0.7.0)
+      rake (~> 0.8.7)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (2.1.2)
+    cucumber (0.6.4)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      json_pure (>= 1.2.0)
+      polyglot (>= 0.2.9)
+      term-ansicolor (>= 1.0.4)
+      treetop (>= 1.4.2)
+    diff-lcs (1.1.2)
+    hpricot (0.8.2)
+    json_pure (1.4.3)
+    polyglot (0.3.1)
+    rake (0.8.7)
+    rdiscount (1.6.3.1)
+    ronn (0.5)
+      hpricot (>= 0.8.2)
+      rdiscount (>= 1.5.8)
+    term-ansicolor (1.0.5)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  cucumber (~> 0.6.4)
+  rake (~> 0.8.7)
+  ronn (~> 0.5)
+  shoe!

data/README.rdoc

@@ -1,24 +1,13 @@
 = Shoe
 
-Shoe is an ecosystem-friendly library of Rake tasks for your gem.
+Configuration-free Rake tasks that {read your
+gemspec}[http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/] and
+re-use
+{built-in}[http://rubygems.rubyforge.org/rubygems-update/Gem/Ext/ExtConfBuilder.html]
+{Rubygems}[http://rubygems.rubyforge.org/rubygems-update/Gem/DocManager.html]
+{functionality}[http://rubygems.rubyforge.org/rubygems-update/Gem/Validator.html].
 
-* It <b>reads your gemspec</b> instead of writing it like
-  Hoe[http://seattlerb.rubyforge.org/hoe] and
-  Jeweler[http://github.com/technicalpickles/jeweler] do.
-  (Background[http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/].)
-
-* It <b>uses Rubygems</b>
-  {for}[http://rubygems.rubyforge.org/rubygems-update/Gem/Ext/ExtConfBuilder.html]
-  {common}[http://rubygems.rubyforge.org/rubygems-update/Gem/DocManager.html]
-  {functionality}[http://rubygems.rubyforge.org/rubygems-update/Gem/Validator.html],
-  rather than
-  {reinventing}[http://github.com/luislavena/rake-compiler/]
-  {the}[http://rake.rubyforge.org/classes/Rake/RDocTask.html]
-  {wheel}[http://rake.rubyforge.org/classes/Rake/TestTask.html].
-
-* It <b>follows the
-  {Ruby Packaging Standard}[http://chneukirchen.github.com/rps/]</b>
-  when generating project files.
+Shoe works great on both Ruby 1.8 and 1.9.
 
 
 == Install
@@ -29,58 +18,37 @@ Shoe is an ecosystem-friendly library of Rake tasks for your gem.
 == Use
 
  require 'shoe'
-
- Shoe::Tasks.define('my_project.gemspec')
+ Shoe.install_tasks
 
 
 == Configure
 
-Shoe::Tasks accept no direct configuration. Instead, they rely on your project environment:
+Keep your configuration DRY: use your gemspec! (And friends.)
 
 Shoe::Tasks::Clean::
-  calls something like <tt>`git clean -fdX`</tt>, but preserves
-  <tt>.bundle/</tt> and <tt>.rvmrc</tt>.
+  {.gitignore}[http://www.kernel.org/pub/software/scm/git/docs/gitignore.html]
 
 Shoe::Tasks::Compile::
-  builds the
-  <tt>extensions[http://docs.rubygems.org/read/chapter/20#extensions]</tt> in
-  your gemspec.
+  {#extensions}[http://docs.rubygems.org/read/chapter/20#extensions]
 
 Shoe::Tasks::Cucumber::
-  runs individual profiles in your
-  <tt>{cucumber.yml}[http://wiki.github.com/aslakhellesoy/cucumber/cucumberyml]</tt>.
+  cucumber.yml[http://wiki.github.com/aslakhellesoy/cucumber/cucumberyml]
 
 Shoe::Tasks::Rdoc::
-  uses the
-  <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>
-  in your gemspec.
-
-Shoe::Tasks::Release::
-  calls <tt>`git tag`</tt>, <tt>`git push`</tt>, <tt>`gem build`</tt> and
-  <tt>`gem push`</tt>, of course.
+  {#rdoc_options}[http://docs.rubygems.org/read/chapter/20#rdoc_options],
+  {#extra_rdoc_files}[http://docs.rubygems.org/read/chapter/20#extra_rdoc_files]
 
 Shoe::Tasks::Ronn::
-  builds man pages from your <tt>{ronn}[http://rtomayko.github.com/ronn/]</tt> sources,
-  honoring the
-  <tt>date[http://docs.rubygems.org/read/chapter/20#date]</tt>
-  and the first
-  <tt>author[http://docs.rubygems.org/read/chapter/20#authors]</tt>
-  in your gemspec.
+  {#date}[http://docs.rubygems.org/read/chapter/20#date],
+  {#author}[http://docs.rubygems.org/read/chapter/20#authors]
 
 Shoe::Tasks::Test::
-  runs the
-  <tt>test_files[http://docs.rubygems.org/read/chapter/20#test_files]</tt> in
-  your gemspec.
-
-Each Task class definition has more specific configuration notes.
+  {#test_files}[http://docs.rubygems.org/read/chapter/20#test_files]
 
 
 == Cherry Pick
 
-If you don't want to use all the Shoe::Tasks, just instantiate the ones you
-want:
+If you don't want to use all the tasks, just instantiate the ones you want:
 
  require 'shoe'
 
@@ -88,27 +56,7 @@ want:
  Shoe::Tasks::Rdoc.new('my_project.gemspec')
 
 
-== Bootstrap
-
-The provided <tt>shoe</tt> executable will generate a helpful gemspec and some
-other skeleton files for your new project:
-
- $ shoe my_project
-
-For more, run:
-
- $ shoe --help
-
-Or, if you have <tt>{gem-man}[http://github.com/defunkt/gem-man]</tt> installed:
-
- $ gem man shoe
-
-
 == Contribute
 
-A number of these tasks are maybe less useful for you than they could be,
-probably because you and I use different conventions. If you have some ideas
-for making Shoe better, I'd love to hear them! Feel free to send issues / pull
-requests / messages through GitHub.
-
-All the best,  -- Matthew
+Feel free to send issues / pull requests / messages through
+GitHub[http://github.com/matthewtodd/shoe].

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+Bundler.setup(:default, :development)
+
+require 'shoe'
+Shoe.install_tasks

data/TODO.rdoc

@@ -1,12 +1,17 @@
 = Next Up
 
-* Remove Launchy? (Follow hub's lead.)
 * Start running on 1.9: Gem::Validator uses MiniTest::Unit.
 
 = Someday Maybe
 
 * Re-think focus: probably want to ditch cucumber, since I'm not using it for shoe?
-* Document rake task hooks prepare:execute and prepare:release.
-* Use a generator framework?
-* Generator should do the right thing when the base directory has a dash in it.
-* Add :only/:except options to Shoe::Tasks.define.
+* Document rake task hook prepare.
+* Reintroduce a command-line tool to fill in the gaps left by bundler:
+  * Modify the gemspec:
+    * Help setting rdoc_options and extra_rdoc_files.
+    * Help setting author and email?
+    * Help setting extensions?
+  * Generate a C extension.
+  * Generate a data directory and provide access to it.
+  * Generate man pages.
+  * Generate an .rvmrc.

data/lib/shoe.rb

@@ -1,22 +1,38 @@
-require 'pathname'
-require 'rbconfig'
-require 'rbconfig/datadir'
+require 'shoe/version'
 
 module Shoe
-  VERSION = '0.6.2'
-
   autoload :Extensions, 'shoe/extensions'
-  autoload :Generator,  'shoe/generator'
   autoload :Tasks,      'shoe/tasks'
 
-  def self.datadir
-    @@datadir ||= begin
-      datadir = RbConfig.datadir('shoe')
-      if !File.exist?(datadir)
-        warn "WARN: #{datadir} does not exist.\n  Trying again with relative data directory..."
-        datadir = File.expand_path('../../data/shoe', __FILE__)
+  class << self
+    def browse(url)
+      system(browser, url)
+    end
+
+    def install_tasks(name='*')
+      Tasks.define Dir["#{name}.gemspec"].first
+    end
+
+    private
+
+    # stolen from hub
+    def browser
+      if ENV['BROWSER']
+        ENV['BROWSER']
+      elsif RUBY_PLATFORM.include?('darwin')
+        'open'
+      elsif command?("xdg-open")
+        'xdg-open'
+      elsif command?("cygstart")
+        'cygstart'
+      else
+        abort 'Please set $BROWSER to a web launcher to use this command.'
       end
-      Pathname.new(datadir)
+    end
+
+    def command?(name)
+      `which #{name} 2>/dev/null`
+      $?.success?
     end
   end
 end

data/lib/shoe/extensions.rb

@@ -1,11 +1,7 @@
 module Shoe
   module Extensions
     autoload :DocManager,    'shoe/extensions/doc_manager'
-    autoload :OptionParser,  'shoe/extensions/option_parser'
-    autoload :Pathname,      'shoe/extensions/pathname'
-    autoload :SourceIndex,   'shoe/extensions/source_index'
     autoload :Specification, 'shoe/extensions/specification'
-    autoload :TestRunner,    'shoe/extensions/test_runner'
     autoload :Validator,     'shoe/extensions/validator'
   end
 end

data/lib/shoe/extensions/specification.rb

@@ -9,10 +9,6 @@ module Shoe
       def full_gem_path
         Dir.pwd
       end
-
-      def has_version_greater_than?(string)
-        version > Gem::Version.new(string)
-      end
     end
 
   end

data/lib/shoe/extensions/validator.rb

@@ -1,24 +1,53 @@
+
 module Shoe
   module Extensions
 
     module Validator
       def self.extended(base)
-        base.send :include, InstanceMethods
-        base.test_runner = TestRunner
+        if RUBY_VERSION < '1.9'
+          require 'test/unit'
+          Test::Unit.run = true
+          base.send :include, Ruby18::InstanceMethods
+          base.send :remove_const, :TestRunner
+          base.send :const_set,    :TestRunner, Ruby18::TestRunner
+        else
+          require 'minitest/unit'
+          MiniTest::Unit.class_eval('@@installed_at_exit = true')
+        end
       end
 
-      def test_runner=(klass)
-        remove_const :TestRunner
-        const_set    :TestRunner, klass
-      end
+      module Ruby18 #:nodoc:
+        module InstanceMethods #:nodoc:
+          def alert_error(*args)
+            # no-op
+          end
 
-      module InstanceMethods #:nodoc:
-        def alert_error(*args)
-          # no-op
+          def unit_test(*args)
+            exit(1) unless super.passed?
+          end
         end
 
-        def unit_test(*args)
-          exit(1) unless super.passed?
+        module TestRunner #:nodoc:
+          # Conforms the normal TestRunner interface to the slightly different form
+          # called by Gem::Validator.
+          #
+          # Note that we use Test::Unit::AutoRunner (rather than going directly for
+          # Test::Unit::UI::Console::TestRunner) in order to give redgreen a chance
+          # to register itself, should it have been required in one of the
+          # test_files.
+          def self.run(suite, ui)
+            runner = Test::Unit::AutoRunner.new(false)
+            runner.collector = lambda { suite }
+            runner.run.extend(BooleanPassed)
+          end
+
+          private
+
+          module BooleanPassed #:nodoc:
+            def passed?
+              self
+            end
+          end
         end
       end
     end

data/lib/shoe/tasks.rb

@@ -1,29 +1,20 @@
 module Shoe
   module Tasks
-
-    autoload :Abstract,  'shoe/tasks/abstract'
-    autoload :Clean,     'shoe/tasks/clean'
-    autoload :Compile,   'shoe/tasks/compile'
-    autoload :Cucumber,  'shoe/tasks/cucumber'
-    autoload :Rdoc,      'shoe/tasks/rdoc'
-    autoload :Ronn,      'shoe/tasks/ronn'
-    autoload :Release,   'shoe/tasks/release'
-    autoload :Test,      'shoe/tasks/test'
-
-    NAMES = %w(
-      Clean
-      Compile
-      Cucumber
-      Rdoc
-      Ronn
-      Release
-      Test
-    )
+    autoload :Clean,    'shoe/tasks/clean'
+    autoload :Compile,  'shoe/tasks/compile'
+    autoload :Cucumber, 'shoe/tasks/cucumber'
+    autoload :Rdoc,     'shoe/tasks/rdoc'
+    autoload :Ronn,     'shoe/tasks/ronn'
+    autoload :Task,     'shoe/tasks/task'
+    autoload :Test,     'shoe/tasks/test'
 
     def self.define(spec)
-      NAMES.map { |name| const_get(name) }.
-           each { |task| task.new(spec)  }
+      Clean.new(spec)
+      Compile.new(spec)
+      Cucumber.new(spec)
+      Rdoc.new(spec)
+      Ronn.new(spec)
+      Test.new(spec)
     end
-
   end
 end

data/lib/shoe/tasks/clean.rb

@@ -6,13 +6,13 @@ module Shoe
     #
     # Uses something like <tt>`{git
     # clean}[http://www.kernel.org/pub/software/scm/git/docs/git-clean.html]
-    # -fdX`</tt>, except preserves <tt>.bundle/</tt> and <tt>.rvmrc</tt>.
+    # -fdX`</tt>, except preserves <tt>.bundle/</tt>.
     #
     # To enable, version your project with git[http://git-scm.com].
     #
     # To configure, edit your
     # <tt>{.gitignore}[http://www.kernel.org/pub/software/scm/git/docs/gitignore.html]</tt>.
-    class Clean < Abstract
+    class Clean < Task
       def active?
         File.directory?('.git')
       end
@@ -21,7 +21,7 @@ module Shoe
         desc <<-END.gsub(/^ */, '')
           Remove ignored files.
           Configure via your .gitignore file. Uses something like `git clean -fdX`,
-          except preserves .bundle/ and .rvmrc.
+          except preserves .bundle/.
         END
 
         task :clean do
@@ -36,7 +36,7 @@ module Shoe
       end
 
       def preserved_files
-        %w( .bundle/ .rvmrc )
+        %w( .bundle/ )
       end
     end