matthewtodd-shoe 0.1.4 → 0.1.5

data/README.rdoc

@@ -2,23 +2,38 @@
 
 You probably don't want to use Shoe -- especially if you're like me!
 
-I like tinkering with my build scripts. That's why I don't use hoe and jeweler and those guys, even though they're awesome. I like to put my own thing together, so I made Shoe.
+I like tinkering with my build scripts. That's why I don't use hoe[http://seattlerb.rubyforge.org/hoe] and jeweler[http://github.com/technicalpickles/jeweler] and those guys, even though they're awesome. I like to put my own thing together, so I made Shoe.
 
-== Install
+== Behold
+
+Here's how your Rakefile looks:
+
+ require 'shoe'
+
+ Shoe.tie('myproject', '0.1.0', "This is my project, and it's awesome!") do |spec|
+   spec.add_development_dependency 'thoughtbot-shoulda'
+ end
 
- gem sources --add http://gems.github.com
- gem install matthewtodd-shoe
+And here's what you get, at most:
 
-== Use
+ rake clean     # Remove ignored files
+ rake default   # Run tests / Run features
+ rake features  # Run features
+ rake rdoc      # Generate documentation
+ rake release   # Release myproject-0.1.0
+ rake shell     # Run an irb console
+ rake test      # Run tests
+
+Most of the time, though, you won't see all of these: when possible, tasks are conditionally defined.
+
+See what I mean by reading Shoe#define_tasks.
+
+== Install
 
- cd myproject
- shoe           # create a Rakefile
- rake -T        # see what you get
+ gem install matthewtodd-shoe --source http://gems.github.com
 
- mkdir test
- rake -T
+== Getting Started
 
- mkdir features
- rake -T
+Shoe can create a Rakefile for you:
 
-And that's about it. There's also a :release task that will pop up when you have a git remote called "origin", you're on the master branch, and you don't have a tag with the current version number.
+ cd myproject && shoe

data/Rakefile

@@ -1,8 +1,9 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
 require 'shoe'
 
-Shoe.tie('shoe', '0.1.4', "You probably don't want to use Shoe.") do |spec|
+Shoe.tie('shoe', '0.1.5', "You probably don't want to use Shoe.") do |spec|
   spec.remove_development_dependency_on_shoe
+  spec.requirements = ['git']
   spec.add_runtime_dependency 'cucumber'
   spec.add_runtime_dependency 'rake'
 end

data/lib/shoe.rb

@@ -1,26 +1,36 @@
-require 'pathname'
 require 'rubygems/doc_manager'
 
-require 'cucumber/rake/task'
-require 'rake/testtask'
-
+# Shoe defines some handy Rake tasks for your project, all built around your Gem::Specification.
+#
+# Here's how you use it in your Rakefile:
+#
+#  require 'shoe'
+#  Shoe.tie('myproject', '0.1.0', "This is my project, and it's awesome!") do |spec|
+#    spec.add_development_dependency 'thoughtbot-shoulda'
+#  end
+#
+# Shoe comes with an executable named "shoe" that will generate a Rakefile like this (but slightly fancier) for you.
 class Shoe
+  # Here's where you start. In your Rakefile, you'll probably just call
+  # Shoe.tie, then add any dependencies in the block.
   def self.tie(name, version, summary)
     shoe = new(name, version, summary)
     yield shoe.spec if block_given?
     shoe.define_tasks
   end
 
+  # The Gem::Specification for your project.
   attr_reader :spec
 
+  # Initializes a Gem::Specification with some nice conventions.
   def initialize(name, version, summary)
     @spec = Gem::Specification.new do |spec|
       spec.name             = name
       spec.version          = version
       spec.summary          = summary
-      spec.files            = FileList['Rakefile', '*.rdoc', 'bin/**/*', 'features/**/*', 'lib/**/*', 'resources**/*', 'test/**/*'].to_a
-      spec.executables      = executables
-      spec.rdoc_options     = %W(--main README.rdoc --title #{name}-#{version} --inline-source)
+      spec.files            = FileList['Rakefile', '*.rdoc', 'bin/**/*', 'features/**/*', 'lib/**/*', 'resources/**/*', 'test/**/*'].to_a
+      spec.executables      = everything_in_the_bin_directory
+      spec.rdoc_options     = %W(--main README.rdoc --title #{name}-#{version} --inline-source) # MAYBE include --all, so that we document private methods?
       spec.extra_rdoc_files = FileList['*.rdoc'].to_a
       spec.has_rdoc         = true
       spec.author           = `git config --get user.name`.chomp
@@ -33,6 +43,7 @@ class Shoe
     end
   end
 
+  # This is where the magic happens.
   def define_tasks
     desc 'Remove ignored files'
     task :clean do
@@ -41,20 +52,29 @@ class Shoe
 
     desc 'Generate documentation'
     task :rdoc do
-      DocManager.new(local_spec).generate_rdoc
+      LocalDocManager.new(spec).generate_rdoc
+      sh 'open rdoc/index.html' if RUBY_PLATFORM =~ /darwin/
+    end
+
+    desc 'Run an irb console'
+    task :shell do
+      # MAYBE include -Iext. I think I'd like to wait until I handle C extensions in general.
+      exec 'irb', '-Ilib', "-r#{spec.name}"
     end
 
-    if Pathname.pwd.join('test').directory?
+    if File.directory?('test')
+      require 'rake/testtask'
       Rake::TestTask.new { |task| task.pattern = 'test/*_test.rb' }
       default_depends_on(:test)
     end
 
-    if Pathname.pwd.join('features').directory?
+    if File.directory?('features')
+      require 'cucumber/rake/task'
       Cucumber::Rake::Task.new('features', 'Run features')
       default_depends_on(:features)
     end
 
-    if system("[[ -z `git tag -l #{spec.version}` ]] && git branch | grep -q '* master' && git remote | grep -q origin")
+    if these_shell_commands_all_succeed(there_is_no_tag_for_the_current_version, we_are_on_the_master_branch, there_is_a_remote_called_origin)
       desc "Release #{spec.name}-#{spec.version}"
       task :release do
         File.open("#{spec.name}.gemspec", 'w') { |f| f.write spec.to_ruby }
@@ -74,24 +94,42 @@ class Shoe
     task :default => task_name
   end
 
-  def executables
-    bin = Pathname.pwd.join('bin')
-    bin.directory? ? bin.children.map { |child| child.basename.to_s } : []
+  def everything_in_the_bin_directory
+    File.directory?('bin') ? Dir.entries('bin') - ['.', '..'] : []
   end
 
-  def local_spec
-    local_spec = spec.dup
-    def local_spec.full_gem_path
-      Pathname.pwd
-    end
-    local_spec
+  # I'm guessing it's a little faster shell out to all these commands
+  # together, rather than running each one separately.
+  def these_shell_commands_all_succeed(*commands)
+    system(commands.join(' && '))
   end
 
-  class DocManager < Gem::DocManager #:nodoc:
+  def there_is_no_tag_for_the_current_version
+    "[[ -z `git tag -l #{spec.version}` ]]"
+  end
+
+  def we_are_on_the_master_branch
+    "git branch | grep -q '* master'"
+  end
+
+  def there_is_a_remote_called_origin
+    'git remote | grep -q origin'
+  end
+
+  # 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   = Pathname.pwd
+      @doc_dir   = Dir.pwd
       @rdoc_args = []
+      adjust_spec_so_that_we_can_generate_rdoc_locally
+    end
+
+    def adjust_spec_so_that_we_can_generate_rdoc_locally
+      def @spec.full_gem_path
+        Dir.pwd
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: matthewtodd-shoe
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Matthew Todd
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-20 00:00:00 -07:00
+date: 2009-07-24 00:00:00 -07:00
 default_executable: shoe
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,7 +52,7 @@ rdoc_options:
 - --main
 - README.rdoc
 - --title
-- shoe-0.1.4
+- shoe-0.1.5
 - --inline-source
 require_paths: 
 - lib
@@ -68,8 +68,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version 
       version: "0"
   version: 
-requirements: []
-
+requirements: 
+- git
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: