shoe 0.6.1 → 0.6.2

data/man/shoe.1

@@ -12,12 +12,12 @@
 .SH "DESCRIPTION"
 The \fBshoe\fR command generates a new RubyGems project. Big deal, right? As
 compared with other tools, \fBshoe\fR gently guides you toward hygenic packaging
-standards and provides you with a sweet library of on\-demand \fBrake(1)\fR tasks
-built around your (authoritative) gemspec.
+standards and provides you with a sweet \fIshoe(3)\fR library of
+on\-demand \fBrake(1)\fR tasks built around your (authoritative) gemspec.
 .
 .SH "OPTIONS"
-\fBshoe\fR's default mode of operation is to generate a basic library, its \fBRakefile\fR, and some \fBTest::Unit\fR tests in the current directory. (You may pass
-a different \fIpath\fR on the command line, if you like.)
+By default, \fBshoe\fR generates a basic library, its \fBRakefile\fR, and some \fBTest::Unit\fR tests in the current directory. (You may pass a different \fIpath\fR
+on the command line, if you like.)
 .
 .P
 To generate additional files, use the following options:
@@ -25,7 +25,7 @@ To generate additional files, use the following options:
 .TP
 \fB\-a\fR, \fB\-\-[no\-]application\fR
 Generate a command\-line application. Create a simple executable script in
-the \fBbin\fR directory and an \fBApplication\fR class that uses \fBoptparse\fR.
+the \fBbin\fR directory and an \fBoptparse\fR\-based \fBApplication\fR class.
 .
 .TP
 \fB\-d\fR, \fB\-\-[no\-]data\fR
@@ -53,12 +53,11 @@ Print a help message and exit.
 .TP
 \fB\-v\fR, \fB\-\-version\fR[=all]
 Print \fBshoe\fR's version number and exit. If \fB=all\fR is given, also print
-version numbers of \fBshoe\fR's dependencies. (This is standard \fBoptparse\fR behavior
-that deserves more attention!)
+version numbers of \fBshoe\fR's dependencies.
 .
 .SH "AUTHOR"
-Matthew Todd, \fI@matthewtodd\fR on GitHub and Twitter. Do drop me a line if you
-use \fBshoe\fR \-\- I'd love to hear from you!
+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"
-\fIhttp://seattlerb.rubyforge.org/hoe/\fR, \fIhttp://github.com/technicalpickles/jeweler\fR, \fIhttp://github.com/sr/mg\fR, \fIhttp://defunkt.github.com/rip/\fR, \fIhttp://gembundler.com/\fR, \fIhttp://github.com/rtomayko/rpg\fR, \fIhttp://chneukirchen.github.com/rps/\fR
+\fIshoe(3)\fR, \fIhttp://chneukirchen.github.com/rps/\fR, \fIhttp://gembundler.com/\fR, \fIhttp://defunkt.github.com/rip/\fR, \fIhttp://github.com/rtomayko/rpg\fR

data/man/shoe.1.ronn

@@ -9,20 +9,20 @@ shoe(1) -- generate a RubyGems project
 
 The `shoe` command generates a new RubyGems project. Big deal, right? As
 compared with other tools, `shoe` gently guides you toward hygenic packaging
-standards and provides you with a sweet library of on-demand `rake(1)` tasks
-built around your (authoritative) gemspec.
+standards and provides you with a sweet [shoe(3)](shoe.3.html) library of
+on-demand `rake(1)` tasks built around your (authoritative) gemspec.
 
 ## OPTIONS
 
-`shoe`'s default mode of operation is to generate a basic library, its
-`Rakefile`, and some `Test::Unit` tests in the current directory. (You may pass
-a different _path_ on the command line, if you like.)
+By default, `shoe` generates a basic library, its `Rakefile`, and some
+`Test::Unit` tests in the current directory. (You may pass a different _path_
+on the command line, if you like.)
 
 To generate additional files, use the following options:
 
 * `-a`, `--[no-]application`:
   Generate a command-line application. Create a simple executable script in
-  the `bin` directory and an `Application` class that uses `optparse`.
+  the `bin` directory and an `optparse`-based `Application` class.
 
 * `-d`, `--[no-]data`:
   Generate a data directory. Create a `data` directory (perfect for HTML
@@ -44,20 +44,17 @@ To generate additional files, use the following options:
 
 * `-v`, `--version`[=all]:
   Print `shoe`'s version number and exit. If `=all` is given, also print
-  version numbers of `shoe`'s dependencies. (This is standard `optparse` behavior
-  that deserves more attention!)
+  version numbers of `shoe`'s dependencies.
 
 ## AUTHOR
 
-Matthew Todd, <@matthewtodd> on GitHub and Twitter. Do drop me a line if you
-use `shoe` -- I'd love to hear from you!
+Matthew Todd, [matthewtodd](http://github.com/matthewtodd) on GitHub. Do drop
+me a line if you use `shoe` -- I'd love to hear from you!
 
 ## SEE ALSO
 
-<http://seattlerb.rubyforge.org/hoe/>,
-<http://github.com/technicalpickles/jeweler>,
-<http://github.com/sr/mg>,
-<http://defunkt.github.com/rip/>,
+[shoe(3)](shoe.3.html),
+<http://chneukirchen.github.com/rps/>,
 <http://gembundler.com/>,
-<http://github.com/rtomayko/rpg>,
-<http://chneukirchen.github.com/rps/>
+<http://defunkt.github.com/rip/>,
+<http://github.com/rtomayko/rpg>

data/man/shoe.3

@@ -0,0 +1,68 @@
+.\" generated with Ronn/v0.5
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "SHOE" "3" "April 2010" "Matthew Todd" "RubyGems Manual"
+.
+.SH "NAME"
+\fBshoe\fR \-\- standard Rake tasks for your RubyGems project
+.
+.SH "SYNOPSIS"
+require 'shoe'
+.
+.br
+Shoe::Tasks.define('\fIproject.gemspec\fR')
+.
+.SH "DESCRIPTION"
+\fBShoe::Tasks.define()\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.
+.
+.SH "TASKS"
+.
+.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.
+.
+.TP
+\fBrake compile\fR
+Compile C extensions with RubyGems' built\-in Gem::Ext::ExtConfBuilder,
+reading the \fBextensions\fR field in your Gem::Specification.
+.
+.TP
+\fBrake cucumber\fR
+Run Cucumber features, using the \fBdefault\fR profile in \fBcucumber.yml\fR.
+Tasks for the other profiles are placed under the cucumber namespace, so you
+could run a hypothetical \fBwip\fR profile with \fBrake cucumber:wip\fR, etc.
+.
+.TP
+\fBrake rdoc\fR
+Generate RDoc documentation with RubyGems' built\-in Gem::DocManager, which
+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.)
+.
+.TP
+\fBrake test\fR
+Run tests with RubyGems' built\-in Gem::Validator, which reads the \fBtest_files\fR field in your Gem::Specification to know which tests to run.
+.
+.P
+Note these tasks check conditions before defining themselves, so that your \fBrake \-\-tasks\fR list stays relevant and compact. You won't see all the tasks all
+the time.
+.
+.SH "AUTHOR"
+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

data/man/shoe.3.ronn

@@ -0,0 +1,64 @@
+shoe(3) -- standard Rake tasks for your RubyGems project
+========================================================
+
+## SYNOPSIS
+
+require 'shoe'  
+Shoe::Tasks.define('_project.gemspec_')
+
+## DESCRIPTION
+
+`Shoe::Tasks.define()` 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)`.
+
+## TASKS
+
+* `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`.
+
+* `rake compile`:
+  Compile C extensions with RubyGems' built-in Gem::Ext::ExtConfBuilder,
+  reading the `extensions` field in your Gem::Specification.
+
+* `rake cucumber`:
+  Run Cucumber features, using the `default` profile in `cucumber.yml`.
+  Tasks for the other profiles are placed under the cucumber namespace, so you
+  could run a hypothetical `wip` profile with `rake cucumber:wip`, etc.
+
+* `rake rdoc`:
+  Generate RDoc documentation with RubyGems' built-in Gem::DocManager, which
+  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
+  be available via `gem-man(1)` once your gem is installed.)
+
+* `rake test`:
+  Run tests with RubyGems' built-in Gem::Validator, which reads the
+  `test_files` field in your Gem::Specification to know which tests to run.
+
+Note these tasks check conditions before defining themselves, so that your
+`rake --tasks` list stays relevant and compact. You won't see all the tasks all
+the time.
+
+## AUTHOR
+
+Matthew Todd, [matthewtodd](http://github.com/matthewtodd) on GitHub. Do drop
+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/>

data/test/extensions/fake_rubygems_server.rb

@@ -0,0 +1,62 @@
+require 'logger'
+require 'rubygems/format'
+require 'stringio'
+require 'webrick'
+
+module Shoe
+  module TestExtensions
+
+    class FakeRubygemsServer
+      def self.start(&block)
+        new.start(&block)
+      end
+
+      def initialize(host='127.0.0.1', port=48484)
+        @initial_rubygems_host = ENV['RUBYGEMS_HOST']
+        @fake_rubygems_host    = "http://#{host}:#{port}"
+
+        @message_bus = Queue.new
+        @webrick = WEBrick::HTTPServer.new(
+                     # Ruby is super slow to create the underlying Socket if
+                     # (my ISP's upstream connection is flakey? and) we don't
+                     # specify a BindAddress.
+                     :BindAddress   => host,
+                     :Port          => port,
+                     :Logger        => Logger.new(nil),
+                     :AccessLog     => [],
+                     :StartCallback => lambda { @message_bus.push(:ready) }
+                   )
+
+        @webrick.mount_proc('/api/v1/gems') do |req, res|
+          @uploaded_gem = req.body
+          @uploaded_gem.extend(GemEntries)
+        end
+      end
+
+      def start(&block)
+        ENV['RUBYGEMS_HOST'] = @fake_rubygems_host
+        thread = Thread.new { @webrick.start }
+        @message_bus.pop
+        block.call
+        return @uploaded_gem
+      ensure
+        ENV['RUBYGEMS_HOST'] = @initial_rubygems_host
+        @webrick.shutdown
+        thread.join
+      end
+
+      private
+
+      module GemEntries
+        def contents
+          package.file_entries.map { |entry| entry.first['path'] }
+        end
+
+        def package
+          Gem::Format::from_io(StringIO.new(self))
+        end
+      end
+    end
+
+  end
+end

data/test/extensions/helper_methods.rb

@@ -0,0 +1,73 @@
+require 'open3'
+require 'pathname'
+
+module Shoe
+  module TestExtensions
+
+    module HelperMethods
+      attr_reader :stdout, :stderr
+
+      def system(*args)
+        stdin, stdout, stderr = Open3.popen3(*args)
+        stdin.close
+        @stdout = stdout.read
+        @stderr = stderr.read
+      end
+
+      def find(string)
+        root = Pathname.new(string)
+        root.enum_for(:find).
+               select { |path| path.file? }.
+              collect { |path| path.relative_path_from(root).to_s }
+      end
+
+      def write_file(path, contents)
+        path = Pathname.new(path)
+        path.parent.mkpath
+        path.open('w') { |stream| stream.write(contents) }
+      end
+
+      def in_project(name)
+        Dir.mkdir(name)
+        Dir.chdir(name)
+      end
+
+      def assert_file(path)
+        assert Pathname.new(path).exist?, "#{path} does not exist."
+      end
+
+      def assert_find(path, expected)
+        assert_equal expected.sort, find(path).sort
+      end
+
+      def assert_no_task(name)
+        system 'rake --tasks'
+        assert_no_match /\srake #{name}\s/, stdout
+      end
+
+      def assert_task(name)
+        system 'rake --tasks'
+        assert_match /\srake #{name}\s/, stdout
+      end
+
+      def add_files_for_c_extension
+        write_file "ext/foo/extconf.rb", <<-END.gsub(/^ */, '')
+          require 'mkmf'
+          create_makefile 'foo/extension'
+        END
+
+        write_file "ext/foo/extension.c", <<-END.gsub(/^ */, '')
+          #include "ruby.h"
+          static VALUE mFoo;
+          static VALUE mExtension;
+          void Init_extension() {
+            mFoo = rb_define_module("Foo");
+            mExtension = rb_define_module_under(mFoo, "Extension");
+          }
+        END
+      end
+
+    end
+
+  end
+end

data/test/extensions/isolated_environment.rb

@@ -0,0 +1,50 @@
+require 'tempfile'
+
+module Shoe
+  module TestExtensions
+
+    module IsolatedEnvironment
+      def setup
+        @environment = Environment.new
+        @environment.setup do |env|
+          env.path('PATH')    { |path| path.unshift Pathname.new('bin').expand_path }
+          env.path('RUBYLIB') { |path| path.unshift Pathname.new('lib').expand_path }
+        end
+        super
+      end
+
+      def teardown
+        super
+        @environment.teardown
+      end
+
+      private
+
+      class Environment
+        def setup
+          @initial_environment = {}
+          ENV.each { |name, value| @initial_environment[name] = value }
+          yield self
+          @initial_directory   = Dir.pwd
+          @working_directory   = Dir.mktmpdir
+          Dir.chdir(@working_directory)
+        end
+
+        def path(name)
+          path = ENV[name].to_s.split(File::PATH_SEPARATOR)
+          yield path
+          ENV[name] = path.join(File::PATH_SEPARATOR)
+        end
+
+        def teardown
+          Dir.chdir(@initial_directory)
+          FileUtils.remove_entry_secure(@working_directory)
+          ENV.clear
+          @initial_environment.each { |name, value| ENV[name] = value }
+        end
+      end
+    end
+
+  end
+end
+

data/test/extensions/test_case.rb

@@ -0,0 +1,40 @@
+module Shoe
+  module TestExtensions
+
+    module TestCase
+      def isolate_environment
+        include IsolatedEnvironment
+      end
+
+      def include_helper_methods
+        include HelperMethods
+      end
+
+      def pending(name, options={}, &block)
+        warn "WARN: Pending test \"#{name}\""
+      end
+
+      def test(name, options={}, &block)
+        if !block_given?
+          pending(name, options, &block)
+          return
+        end
+
+        requires = Array(options[:require])
+
+        requires.each do |lib|
+          begin
+            require lib
+          rescue LoadError
+            warn "WARN: #{lib} is not available.\n  Skipping test \"#{name}\""
+            define_method('default_test', lambda {})
+            return
+          end
+        end
+
+        define_method("test #{name}", &block)
+      end
+    end
+
+  end
+end