shoe 0.5.1 → 0.6.0

data/CHANGELOG.rdoc

@@ -1,3 +1,18 @@
+== 0.6.0 -- 2010 April 20
+
+* Add --webcvs to rdoc_options in generated gemspec.
+* Move erb templates from lib to datadir.
+* Generate a top-level project module.
+* Move generated VERSION constant out of foo/version.rb, into foo.rb
+* The shoe generator accepts an --application option to generate an executable stub.
+* The shoe generator accepts a --data option to generate a data directory.
+* The shoe generator accepts an --extension option to generate a C extension.
+* The shoe generator accepts a --test-unit option to generate Test::Unit tests.
+* Shoe::Tasks may no longer be built with a Gem::Specification object; pass the path to a gemspec file instead.
+* Generate a .gitignore file.
+* New `rake ronn` task to build man pages from ronn sources.
+* Support running generated apps from a local checkout.
+
 == 0.5.1 -- 2010 April 7
 
 * Include summary in description.

data/Gemfile

@@ -1,7 +1,9 @@
 source :rubygems
 
 gem 'rake'
+gem 'launchy'
 
 group :development do
   gem 'cucumber'
+  gem 'ronn'
 end

data/Gemfile.lock

@@ -1,5 +1,9 @@
 --- 
 dependencies: 
+  ronn: 
+    group: 
+    - :development
+    version: ">= 0"
   rake: 
     group: 
     - :default
@@ -8,15 +12,21 @@ dependencies:
     group: 
     - :development
     version: ">= 0"
+  launchy: 
+    group: 
+    - :default
+    version: ">= 0"
 specs: 
 - rake: 
     version: 0.8.7
 - builder: 
     version: 2.1.2
+- configuration: 
+    version: 1.1.0
 - diff-lcs: 
     version: 1.1.2
 - json_pure: 
-    version: 1.2.3
+    version: 1.2.4
 - polyglot: 
     version: 0.3.1
 - term-ansicolor: 
@@ -24,8 +34,16 @@ specs:
 - treetop: 
     version: 1.4.5
 - cucumber: 
-    version: 0.6.3
-hash: bec7b29765230914672db7983d163d805c4afdb1
+    version: 0.6.4
+- hpricot: 
+    version: 0.8.2
+- launchy: 
+    version: 0.3.5
+- rdiscount: 
+    version: 1.6.3
+- ronn: 
+    version: "0.5"
+hash: d47953731e3f472755d844fb72d2644ea08f56d9
 sources: 
 - Rubygems: 
     uri: http://gemcutter.org

data/README.rdoc

@@ -16,6 +16,10 @@ Shoe is an ecosystem-friendly library of Rake tasks for your gem.
   {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.
+
 
 == Install
 
@@ -56,6 +60,14 @@ Shoe::Tasks::Release::
   calls <tt>`git tag`</tt>, <tt>`git push`</tt>, <tt>`gem build`</tt> and
   <tt>`gem push`</tt>, of course.
 
+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.
+
 Shoe::Tasks::Test::
   runs the
   <tt>test_files[http://docs.rubygems.org/read/chapter/20#test_files]</tt> in
@@ -82,8 +94,16 @@ other skeleton files for your new project:
 
  $ shoe my_project
 
-If you're using {Bundler}[http://gembundler.com], see
-{bundler.rdoc}[link:files/doc/bundler_rdoc.html] for some helpful tips.
+For more, run:
+
+ $ shoe --help
+
+Or, if you have <tt>{gem-man}[http://github.com/defunkt/gem-man]</tt> installed:
+
+ $ gem man shoe
+
+Also, if you're using {Bundler}[http://gembundler.com], see
+<tt>BUNDLER.rdoc</tt> for some helpful tips.
 
 
 == Contribute

data/TODO.rdoc

@@ -1,6 +1,6 @@
 = Next Up
 
-* Help generate man pages?
-* How would I incorporate Gem::Specification#add_bundler_dependencies?
-* Support any extension flavor that Rubygems supports, not just extconf.rb.
+* Generator should do the right thing when the base directory has a dash in it.
 * Find a better way to clean; I don't want to whack .bundler and .rvmrc.
+* Add :only/:except options to Shoe::Tasks.define.
+* Port cucumber features to Test::Unit so they'll be run under `gem check --test shoe`.

data/bin/shoe

@@ -1,4 +1,18 @@
 #!/usr/bin/env ruby
 
-require 'shoe'
-Shoe::Generator.new(*ARGV).run
+begin
+  require 'shoe'
+rescue LoadError
+  raise unless $!.message =~ /\bshoe$/
+
+  lib = File.expand_path('../../lib', __FILE__)
+  if !$:.include?(lib)
+    warn "#{$!}. Trying again with #{lib} on the $LOAD_PATH."
+    $:.unshift(lib)
+    retry
+  end
+
+  raise
+end
+
+Shoe::Generator.new.run(ARGV)

data/data/shoe/templates/application.erb

@@ -0,0 +1,23 @@
+require 'optparse'
+
+module <%= module_name %>
+  class Application
+    def initialize
+      @options = OptionParser.new do |opts|
+        # -h, --help, -v, --version are built into OptionParser
+        # Try `<%= name %> --version=all` as you require more libraries!
+        opts.version = <%= module_name %>::VERSION
+      end
+    end
+
+    def run(argv)
+      begin
+        @options.parse(argv)
+      rescue OptionParser::ParseError
+        @options.abort($!)
+      end
+
+      # Have at it!
+    end
+  end
+end

data/data/shoe/templates/executable.erb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+begin
+  require '<%= name %>'
+rescue LoadError
+  raise unless $!.message =~ /\b<%= name %>$/
+
+  lib = File.expand_path('../../lib', __FILE__)
+  if !$:.include?(lib)
+    warn "#{$!}. Trying again with #{lib} on the $LOAD_PATH."
+    $:.unshift(lib)
+    retry
+  end
+
+  raise
+end
+
+<%= module_name %>::Application.new.run(ARGV)

data/data/shoe/templates/extconf.erb

@@ -0,0 +1,2 @@
+require 'mkmf'
+create_makefile '<%= name %>/<%= extension_name %>'

data/data/shoe/templates/extension.erb

@@ -0,0 +1,9 @@
+#include "ruby.h"
+
+static VALUE m<%= module_name %>;
+static VALUE m<%= extension_module_name %>;
+
+void Init_ext() {
+  m<%= module_name %> = rb_define_module("<%= module_name %>");
+  m<%= extension_module_name %> = rb_define_module_under("<%= module_name %>", "<%= extension_module_name %>");
+}

data/data/shoe/templates/gemspec.erb

@@ -0,0 +1,50 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+require '<%= name %>'
+
+# Feel free to change whatever you like! This file is yours now.
+Gem::Specification.new do |spec|
+  spec.name    = '<%= name %>'
+  spec.version = <%= module_name %>::VERSION
+
+  spec.summary = '<%= module_name %> is one of my favorite things!'
+  spec.description = <<-END.gsub(/^ */, '')
+    #{spec.summary}
+
+    Further description here.
+  END
+
+  spec.author = '<%= `git config --get user.name`.chomp %>'
+  spec.email  = '<%= `git config --get user.email`.chomp %>'
+  spec.homepage = 'http://github.com/<%= `git config --get github.user`.chomp %>/<%= name %>'
+
+  # You may find these helpful:
+  # spec.requirements = ['git'] # If your library shells out to git
+  # spec.required_rubygems_version = ">= 1.3.6" # If you depend on prerelease gems
+  # spec.add_bundler_dependencies # I'm not sure how to use this yet...
+  # spec.add_runtime_dependency 'nokogiri' # Or what have you
+  spec.add_development_dependency 'shoe'
+
+  # This may not be the best way to select files for inclusion in your gem, but
+  # it does at least honor your .gitignore, keeping that bit of your
+  # configuration DRY. Alternatively, you could use more explicit Dir.glob
+  # patterns or even try reading a Manifest file, hoe-style.
+  def spec.git_files(glob=nil)
+    `git ls-files -z --cached --other --exclude-standard #{glob}`.split("\0")
+  end
+
+  # The kooky &File.method(:basename) trick keeps us from accidentally
+  # shadowing a variable named "file" in the context that evaluates this
+  # gemspec. I actually ran into this problem with Bundler!
+  spec.files            = spec.git_files
+  spec.executables      = spec.git_files('bin/*').map &File.method(:basename)
+  spec.extensions       = spec.git_files('ext/**/extconf.rb')
+  spec.extra_rdoc_files = spec.git_files('{,**/}*.rdoc')
+  spec.test_files       = spec.git_files('test/{,**/}*_test.rb')
+
+  spec.rdoc_options = %W(
+    --main README.rdoc
+    --title #{spec.full_name}
+    --inline-source
+    --webcvs http://github.com/<%= `git config --get github.user`.chomp %>/<%= name %>/blob/v#{spec.version}/
+  )
+end

data/data/shoe/templates/gitignore.erb

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

data/data/shoe/templates/manpage.erb

@@ -0,0 +1,30 @@
+<%= name %>(1) --
+=================
+
+## SYNOPSIS
+
+`<%= name %>` [_options_]
+
+## DESCRIPTION
+
+Write your description here.
+
+## OPTIONS
+
+`<%= name %>` also responds to the followng 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
+
+<%= `git config --get user.name`.chomp %> <<%= `git config --get user.email`.chomp %>>
+
+## SEE ALSO
+
+ruby(1)

data/data/shoe/templates/module.erb

@@ -0,0 +1,31 @@
+<% if data? %>
+require 'pathname'
+require 'rbconfig'
+require 'rbconfig/datadir'
+
+<% end %>
+module <%= module_name %>
+  VERSION = '<%= version %>'
+<% if application? || extension? %>
+
+<% end %>
+<% if application? %>
+  autoload :Application, '<%= name %>/application'
+<% end %>
+<% if extension? %>
+  autoload :<%= extension_module_name %>, '<%= name %>/<%= extension_name %>'
+<% end %>
+<% if data? %>
+
+  def self.datadir
+    @@datadir ||= begin
+      datadir = RbConfig.datadir('<%= name %>')
+      if !File.exist?(datadir)
+        warn "#{datadir} does not exist. Trying again with data directory relative to __FILE__."
+        datadir = File.expand_path('../../data/<%= name %>', __FILE__)
+      end
+      Pathname.new(datadir)
+    end
+  end
+<% end %>
+end

data/data/shoe/templates/module_test.rb

@@ -0,0 +1,7 @@
+require 'test/helper'
+
+class <%= module_name %>Test < Test::Unit::TestCase
+  def test_dummy
+    assert_equal '<%= version %>', <%= module_name %>::VERSION
+  end
+end

data/data/shoe/templates/rakefile.erb

@@ -0,0 +1,3 @@
+require 'shoe'
+
+Shoe::Tasks.define('<%= name %>.gemspec')

data/data/shoe/templates/readme.erb

@@ -0,0 +1,3 @@
+= <%= module_name %>
+
+<%= module_name %> is one of my favorite things! Let me tell you about it:

data/data/shoe/templates/test_helper.erb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require '<%= name %>'

data/features/cucumber.feature

@@ -4,25 +4,24 @@ Feature: Cucumber
   I want shoe to give me a rake task
 
   Scenario: Running rake --tasks in a shoe project without Cucumber features
-    Given I have created a project called "my_project"
-    When I run bundle exec rake --tasks inside "my_project"
+    Given I have run shoe my_project inside "."
+    When I run rake --tasks inside "my_project"
     Then I should not see "rake cucumber" on standard out
 
   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"
+    Given I have run shoe my_project inside "."
+    And I have run git init inside "."
     And I have created a file called "my_project/cucumber.yml" containing:
       """
       default: --tags ~@wip
       wip: --tags @wip --wip
       """
-    When I run bundle exec rake --tasks inside "my_project"
+    When I run rake --tasks inside "my_project"
     Then I should see "rake cucumber" on standard out
     And I should see "rake cucumber:wip" on standard out
 
   Scenario: Running rake --tasks in a shoe project with a bad cucumber.yml
-    Given I have created a project called "my_project"
-    And I have appended "gem 'cucumber'" to "my_project/Gemfile"
+    Given I have run shoe my_project inside "."
     And I have created a file called "my_project/cucumber.yml" containing ""
-    When I run bundle exec rake --tasks inside "my_project"
+    When I run rake --tasks inside "my_project"
     Then I should not see "rake cucumber" on standard out

data/features/generator.feature

@@ -0,0 +1,32 @@
+Feature: Getting started
+  In order to start using shoe
+  As a developer
+  I want a little help generating my Rakefile
+
+  Scenario: Running shoe to create a new project
+    When I run shoe my_project inside "."
+    Then I should see a file "my_project/.gitignore"
+    And I should see a file "my_project/Rakefile"
+    And I should see a file "my_project/README.rdoc"
+    And I should see a file "my_project/lib/my_project.rb"
+    And I should see a file "my_project/test/helper.rb"
+    And I should see a file "my_project/test/my_project_test.rb"
+    And I should see a file "my_project/my_project.gemspec"
+
+  Scenario: Running shoe --application to create a new project
+    When I run shoe --application my_project inside "."
+    Then I should see a file "my_project/bin/my_project"
+    And I should see a file "my_project/lib/my_project/application.rb"
+
+  Scenario: Running shoe --extension to create a new project
+    When I run shoe --extension my_project inside "."
+    Then I should see a file "my_project/ext/my_project/extconf.rb"
+    And I should see a file "my_project/ext/my_project/extension.c"
+
+  Scenario: Running shoe with no arguments in an existing project that already has a Rakefile
+    Given I have created a directory called "my_project"
+    And I have created a file called "my_project/Rakefile" containing "# RAKEFILE CONTENTS"
+    When I run shoe inside "my_project"
+    Then I should see "Rakefile exists. Not clobbering." on standard error
+    And the contents of "my_project/Rakefile" should still be "# RAKEFILE CONTENTS"
+

data/features/release.feature

@@ -6,28 +6,28 @@ Feature: Release
   Background:
     Given I have created a directory called "origin"
     And I have run git init --bare inside "origin"
-    Given I have created a project called "my_project"
+    Given I have run shoe my_project inside "."
     And I have run git init inside "my_project"
     And I have run git add . inside "my_project"
     And I have run git commit -m "Initial commit" inside "my_project"
 
   Scenario: I can release
-    When I replace "0.0.0" with "0.1.0" in the file "my_project/lib/my_project/version.rb"
-    And I run bundle exec rake --tasks inside "my_project"
+    When I replace "0.0.0" with "0.1.0" in the file "my_project/lib/my_project.rb"
+    And I run rake --tasks inside "my_project"
     Then I should see "rake release" on standard out
 
   Scenario: I cannot release when the version is 0.0.0
-    When I run bundle exec rake --tasks inside "my_project"
+    When I run rake --tasks inside "my_project"
     Then I should not see "rake release" on standard out
 
   Scenario: I cannot release when I already have a tag for the current version
     When I run git tag v0.1.0 inside "my_project"
-    And I replace "0.0.0" with "0.1.0" in the file "my_project/lib/my_project/version.rb"
-    And I run bundle exec rake --tasks inside "my_project"
+    And I replace "0.0.0" with "0.1.0" in the file "my_project/lib/my_project.rb"
+    And I run rake --tasks inside "my_project"
     Then I should not see "rake release" on standard out
 
   Scenario: I cannot release from a branch other than master
     When I run git checkout -b topic inside "my_project"
-    And I replace "0.0.0" with "0.1.0" in the file "my_project/lib/my_project/version.rb"
-    And I run bundle exec rake --tasks inside "my_project"
+    And I replace "0.0.0" with "0.1.0" in the file "my_project/lib/my_project.rb"
+    And I run rake --tasks inside "my_project"
     Then I should not see "rake release" on standard out