shoe 0.5.1 → 0.6.0

data/lib/shoe/tasks/compile.rb

@@ -36,7 +36,9 @@ module Shoe
           end
         end
 
-        task :prepare => :compile
+        namespace :prepare do
+          task :execute => :compile
+        end
       end
     end
 

data/lib/shoe/tasks/cucumber.rb

@@ -6,7 +6,9 @@ module Shoe
     # Defines <tt>`rake cucumber`</tt> and <tt>`rake cucumber:<PROFILE>`</tt> to
     # run your Cucumber[http://cukes.info] features.
     #
-    # <tt>`rake cucumber`</tt> will run features according to the <tt>default</tt> profile; <tt>`rake cucumber:foo`</tt> according to the <tt>foo</tt> profile.
+    # <tt>`rake cucumber`</tt> will run features according to the
+    # <tt>default</tt> profile; <tt>`rake cucumber:foo`</tt> according to the
+    # <tt>foo</tt> profile.
     #
     # To enable and configure, create and edit your
     # <tt>{cucumber.yml}[http://wiki.github.com/aslakhellesoy/cucumber/cucumberyml]</tt>.
@@ -19,9 +21,7 @@ module Shoe
         begin
           require 'cucumber/rake/task'
         rescue LoadError
-          warn 'cucumber',
-            "Although you have a cucumber.yml, it seems you don't have cucumber installed.",
-            "You probably want to add a \"gem 'cucumber'\" to your Gemfile."
+          warn "It seems you don't have cucumber installed."
         else
           define_tasks
         end
@@ -44,21 +44,24 @@ module Shoe
       end
 
       def define_default_task
-        task :prepare
+        namespace :prepare do
+          task :execute
+        end
 
-        ::Cucumber::Rake::Task.new({ :cucumber => :prepare }, 'Run features') do |task|
+        ::Cucumber::Rake::Task.new({ :cucumber => 'prepare:execute' }, 'Run features') do |task|
           task.profile = 'default'
         end
 
-        task :default
-        Rake.application[:default].prerequisites.push(Rake.application[:cucumber])
+        task :default => :cucumber
       end
 
       def define_profile_task(profile)
-        task :prepare
+        namespace :prepare do
+          task :execute
+        end
 
         namespace :cucumber do
-          ::Cucumber::Rake::Task.new({ profile => :prepare }, "Run #{profile} features") do |task|
+          ::Cucumber::Rake::Task.new({ profile => 'prepare:execute' }, "Run #{profile} features") do |task|
             task.profile = profile
           end
         end

data/lib/shoe/tasks/rdoc.rb

@@ -1,4 +1,5 @@
 require 'rubygems/doc_manager'
+require 'launchy'
 
 module Shoe
   module Tasks
@@ -30,28 +31,8 @@ module Shoe
       def define
         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
-
-      private
-
-      # 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 = []
+          Gem::DocManager.new(spec).extend(Extensions::DocManager).generate_rdoc
+          Launchy::Browser.run('rdoc/index.html')
         end
       end
     end

data/lib/shoe/tasks/release.rb

@@ -27,8 +27,6 @@ module Shoe
     # tag to denote your compliance.
     class Release < Abstract
       def active?
-        spec.extend(VersionExtensions)
-
         spec.has_version_greater_than?('0.0.0') &&
           there_is_no_tag_for(version_tag(spec.version)) &&
           we_are_on_the_master_branch
@@ -41,10 +39,7 @@ module Shoe
           sh "git tag #{version_tag(spec.version)}"
 
           if there_is_no_tag_for('semver')
-            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'
+            warn "It seems you don't have a 'semver' tag. See http://semver.org/."
           end
 
           if there_is_a_remote_called('origin')
@@ -55,16 +50,16 @@ module Shoe
           sh "gem build #{spec.name}.gemspec"
           sh "gem push #{spec.file_name}"
         end
-      end
-
-      private
 
-      module VersionExtensions #:nodoc:
-        def has_version_greater_than?(string)
-          version > Gem::Version.new(string)
+        namespace :prepare do
+          task :release
         end
+
+        task :release => 'prepare:release'
       end
 
+      private
+
       def there_is_a_remote_called(name)
         `git remote`.to_a.include?("#{name}\n")
       end

data/lib/shoe/tasks/ronn.rb

@@ -0,0 +1,77 @@
+module Shoe
+  module Tasks
+
+    # Defines <tt>`rake ronn`</tt> to generate man pages from your
+    # <tt>{ronn}[http://rtomayko.github.com/ronn/]</tt> sources.
+    #
+    # To enable, create some <tt>man/*.ronn</tt> files.
+    #
+    # To configure the <tt>date</tt> and <tt>organization</tt> fields for your man pages, set the
+    # <tt>date[http://docs.rubygems.org/read/chapter/20#date]</tt>
+    # and the first of the
+    # <tt>authors[http://docs.rubygems.org/read/chapter/20#authors]</tt>
+    # in your gemspec, respectively.
+    #
+    # == Notes
+    #
+    # * It's best to check the generated man pages into version control so
+    #   they'll be included in your gem for
+    #   {gem-man}[http://github.com/defunkt/gem-man].
+    #
+    # * Ronn becomes a prerequisite for Release, 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
+      def active?
+        !ronn_files.empty?
+      end
+
+      def define
+        begin
+          require 'ronn'
+        rescue LoadError
+          warn "It seems you don't have 'ronn' installed."
+        else
+          define_tasks
+        end
+      end
+
+      private
+
+      def define_tasks
+        desc 'Generate man pages'
+        task :ronn => 'ronn:build' do
+          sh 'man', *man_files
+        end
+
+        namespace :ronn do
+          task :build => man_files
+        end
+
+        rule /\.\d$/ => '%p.ronn' do |task|
+          ronn('--roff', task.source)
+        end
+
+        namespace :prepare do
+          task :release => 'ronn:build'
+        end
+      end
+
+      def ronn(format, file)
+        sh "ronn --build #{format} --date #{spec.date.strftime('%Y-%m-%d')} --manual='RubyGems Manual' --organization='#{spec.author}' #{file}"
+      end
+
+      def ronn_files
+        spec.files.grep /^man\/.*\.ronn$/
+      end
+
+      def man_files
+        ronn_files.map { |path| path.sub(/\.ronn$/, '') }
+      end
+    end
+
+  end
+end

data/lib/shoe/tasks/test.rb

@@ -61,12 +61,12 @@ module Shoe
       def define
         desc 'Run tests'
         task :test do
-          Gem.source_index.extend(LocalGemSourceIndex)
+          Gem.source_index.extend(Extensions::SourceIndex)
           Gem.source_index.local_gemspec = spec
 
           Gem::Validator.send(:remove_const, :TestRunner)
           Gem::Validator.const_set(:TestRunner, LocalTestRunner)
-          Gem::Validator.new.extend(LocalGemValidator).unit_test(spec)
+          Gem::Validator.new.extend(Extensions::Validator).unit_test(spec)
         end
 
         task :prepare
@@ -78,30 +78,6 @@ module Shoe
 
       private
 
-      module LocalGemSourceIndex #:nodoc:
-        attr_accessor :local_gemspec
-
-        def find_name(*args)
-          if args.first == local_gemspec.name
-            [local_gemspec]
-          else
-            super
-          end
-        end
-      end
-
-      module LocalGemValidator #:nodoc:
-        def alert_error(*args)
-          # no-op
-        end
-
-        def unit_test(*args)
-          unless super.passed?
-            exit 1
-          end
-        end
-      end
-
       class LocalTestRunner < ::Test::Unit::UI::Console::TestRunner #:nodoc:
         def self.run(*args)
           new(args.first, ::Test::Unit::UI::NORMAL).start

data/man/shoe.1

@@ -0,0 +1,64 @@
+.\" generated with Ronn/v0.5
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "SHOE" "1" "April 2010" "Matthew Todd" "RubyGems Manual"
+.
+.SH "NAME"
+\fBshoe\fR \-\- generate a RubyGems project
+.
+.SH "SYNOPSIS"
+\fBshoe\fR [\-\fBadehtv\fR] [\fIpath\fR]
+.
+.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.
+.
+.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.)
+.
+.P
+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.
+.
+.TP
+\fB\-d\fR, \fB\-\-[no\-]data\fR
+Generate a data directory. Create a \fBdata\fR directory (perfect for HTML
+templates and other static assets) and a \fBdatadir\fR method in your top\-level
+module to access it.
+.
+.TP
+\fB\-e\fR, \fB\-\-[no\-]extension\fR
+Generate a C extension. Create an \fBext\fR directory with an \fBextconf.rb\fR and
+a bare\-bones \fBextension.c\fR defining a module named \fBExtension\fR.
+.
+.TP
+\fB\-t\fR, \fB\-\-[no\-]test\-unit\fR
+Generate Test::Unit tests. Create a \fBtest\fR directory with a \fBhelper.rb\fR
+and a single passing test.
+.
+.P
+\fBshoe\fR also responds to the following standard options:
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+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!)
+.
+.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!
+.
+.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

data/man/shoe.1.ronn

@@ -0,0 +1,63 @@
+shoe(1) -- generate a RubyGems project
+======================================
+
+## SYNOPSIS
+
+`shoe` [-`adehtv`] [_path_]
+
+## DESCRIPTION
+
+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.
+
+## 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.)
+
+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`.
+
+* `-d`, `--[no-]data`:
+  Generate a data directory. Create a `data` directory (perfect for HTML
+  templates and other static assets) and a `datadir` method in your top-level
+  module to access it.
+
+* `-e`, `--[no-]extension`:
+  Generate a C extension. Create an `ext` directory with an `extconf.rb` and
+  a bare-bones `extension.c` defining a module named `Extension`.
+
+* `-t`, `--[no-]test-unit`:
+  Generate Test::Unit tests. Create a `test` directory with a `helper.rb`
+  and a single passing test.
+
+`shoe` also responds to the following standard options:
+
+* `-h`, `--help`:
+  Print a help message and exit.
+
+* `-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!)
+
+## AUTHOR
+
+Matthew Todd, <@matthewtodd> on GitHub and Twitter. 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/>,
+<http://gembundler.com/>,
+<http://github.com/rtomayko/rpg>,
+<http://chneukirchen.github.com/rps/>

data/shoe.gemspec

@@ -1,5 +1,5 @@
 $:.unshift File.expand_path('../lib', __FILE__)
-require 'shoe/version'
+require 'shoe'
 
 Gem::Specification.new do |spec|
   spec.name    = 'shoe'
@@ -21,7 +21,9 @@ Gem::Specification.new do |spec|
   spec.requirements = ['git']
   spec.required_rubygems_version = '>= 1.3.6'
   spec.add_runtime_dependency 'rake'
+  spec.add_runtime_dependency 'launchy'
   spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'ronn'
 
   def spec.git_files(glob=nil)
     `git ls-files -z --cached --other --exclude-standard #{glob}`.split("\0")
@@ -37,5 +39,6 @@ Gem::Specification.new do |spec|
     --main README.rdoc
     --title #{spec.full_name}
     --inline-source
+    --webcvs http://github.com/matthewtodd/shoe/blob/v#{spec.version}/
   )
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 1
-  version: 0.5.1
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Matthew Todd
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-08 00:00:00 +03:00
+date: 2010-04-20 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: cucumber
+  name: launchy
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
@@ -39,8 +39,32 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ronn
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: |
   An ecosystem-friendly library of Rake tasks for your gem.
   
@@ -54,12 +78,13 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
+- BUNDLER.rdoc
 - CHANGELOG.rdoc
 - README.rdoc
 - TODO.rdoc
-- doc/bundler.rdoc
 files: 
 - .gitignore
+- BUNDLER.rdoc
 - CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
@@ -68,14 +93,33 @@ files:
 - TODO.rdoc
 - bin/shoe
 - cucumber.yml
-- doc/bundler.rdoc
+- data/shoe/templates/application.erb
+- data/shoe/templates/executable.erb
+- data/shoe/templates/extconf.erb
+- data/shoe/templates/extension.erb
+- data/shoe/templates/gemspec.erb
+- data/shoe/templates/gitignore.erb
+- data/shoe/templates/gitkeep.erb
+- data/shoe/templates/manpage.erb
+- data/shoe/templates/module.erb
+- data/shoe/templates/module_test.rb
+- data/shoe/templates/rakefile.erb
+- data/shoe/templates/readme.erb
+- data/shoe/templates/test_helper.erb
 - features/cucumber.feature
-- features/getting_started.feature
+- features/generator.feature
 - features/release.feature
 - features/step_definitions/shoe_steps.rb
 - features/support/env.rb
 - features/test.feature
 - lib/shoe.rb
+- lib/shoe/extensions.rb
+- lib/shoe/extensions/doc_manager.rb
+- lib/shoe/extensions/option_parser.rb
+- lib/shoe/extensions/pathname.rb
+- lib/shoe/extensions/source_index.rb
+- lib/shoe/extensions/specification.rb
+- lib/shoe/extensions/validator.rb
 - lib/shoe/generator.rb
 - lib/shoe/tasks.rb
 - lib/shoe/tasks/abstract.rb
@@ -84,12 +128,10 @@ files:
 - lib/shoe/tasks/cucumber.rb
 - lib/shoe/tasks/rdoc.rb
 - lib/shoe/tasks/release.rb
+- lib/shoe/tasks/ronn.rb
 - lib/shoe/tasks/test.rb
-- lib/shoe/templates/gemspec.erb
-- lib/shoe/templates/rakefile.erb
-- lib/shoe/templates/readme.erb
-- lib/shoe/templates/version.erb
-- lib/shoe/version.rb
+- man/shoe.1
+- man/shoe.1.ronn
 - shoe.gemspec
 has_rdoc: true
 homepage: http://github.com/matthewtodd/shoe
@@ -100,8 +142,10 @@ rdoc_options:
 - --main
 - README.rdoc
 - --title
-- shoe-0.5.1
+- shoe-0.6.0
 - --inline-source
+- --webcvs
+- http://github.com/matthewtodd/shoe/blob/v0.6.0/
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement