shoe 0.1.8

data/README.rdoc

@@ -0,0 +1,39 @@
+= Shoe
+
+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[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.
+
+== 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
+
+And here's what you get, at most:
+
+ 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
+
+ gem install matthewtodd-shoe --source http://gems.github.com
+
+== Getting Started
+
+Shoe can create a Rakefile for you:
+
+ cd myproject && shoe

data/Rakefile

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'shoe'
+
+Shoe.tie('shoe', '0.1.8', "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/bin/shoe

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+if File.exists?('Rakefile')
+  abort 'Rakefile exists. Not clobbering.'
+end
+
+project_name = File.basename(File.expand_path(Dir.pwd))
+
+File.open('Rakefile', 'w') do |file|
+  file.write <<-END_RAKEFILE.gsub('NAME', project_name)
+this_rakefile_uses_shoe = <<END
+----------------------------------------
+Please install Shoe:
+gem sources --add http://gems.github.com
+gem install matthewtodd-shoe
+----------------------------------------
+END
+
+begin
+  gem 'matthewtodd-shoe'
+rescue Gem::LoadError
+  abort this_rakefile_uses_shoe
+else
+  require 'shoe'
+end
+
+Shoe.tie('NAME', '0.1.0', 'TODO write a summary of NAME here.') do |spec|
+  # spec.add_development_dependency 'thoughtbot-shoulda'
+end
+  END_RAKEFILE
+end
+
+if File.exists?('README.rdoc')
+  abort 'README.rdoc exists. Not clobbering.'
+end
+
+File.open('README.rdoc', 'w') do |file|
+  file.write <<-END_README.gsub('NAME', project_name.capitalize)
+= NAME
+
+NAME is one of my favorite things! Let me tell you about it:
+  END_README
+end

data/lib/shoe.rb

@@ -0,0 +1,149 @@
+require 'rubygems/doc_manager'
+
+# 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', '*.gemspec', '**/*.rdoc', 'bin/**/*', 'examples/**/*', 'features/**/*', 'lib/**/*', 'resources/**/*', 'shoulda_macros/**/*', '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', 'shoulda_macros/**/*'].to_a
+      spec.has_rdoc         = true
+      spec.author           = `git config --get user.name`.chomp
+      spec.email            = `git config --get user.email`.chomp
+      spec.add_development_dependency 'matthewtodd-shoe'
+    end
+
+    def @spec.remove_development_dependency_on_shoe
+      dependencies.delete_if { |d| d.name == 'matthewtodd-shoe' }
+    end
+  end
+
+  # This is where the magic happens.
+  def define_tasks
+    if File.directory?('.git')
+      desc 'Remove ignored files'
+      task :clean do
+        sh 'git clean -fdX'
+      end
+    end
+
+    if File.directory?('lib')
+      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
+
+    if File.file?("lib/#{spec.name}.rb")
+      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
+    end
+
+    if File.directory?('test')
+      require 'rake/testtask'
+      # MAYBE be a little more forgiving in test selection, using test/**/*_test.rb. Or create suites based on subdirectory?
+      Rake::TestTask.new { |task| task.pattern = 'test/*_test.rb' }
+      default_depends_on(:test)
+    end
+
+    if File.directory?('features')
+      require 'cucumber/rake/task'
+      Cucumber::Rake::Task.new('features', 'Run features')
+      default_depends_on(:features)
+    end
+
+    desc 'Show latest gemspec contents'
+    task :gemspec do
+      puts spec.to_ruby
+    end
+
+    if there_is_no_tag_for_the_current_version && we_are_on_the_master_branch && we_have_already_pushed_the_master_branch_to_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 }
+        sh "git add #{spec.name}.gemspec"
+        sh "git commit -a -m 'Release #{spec.version}'"
+        sh "git tag #{spec.version}"
+        sh 'git push'
+        sh 'git push --tags'
+      end
+    end
+  end
+
+  private
+
+  def default_depends_on(task_name)
+    desc Rake.application.lookup(task_name).comment
+    task :default => task_name
+  end
+
+  def everything_in_the_bin_directory
+    File.directory?('bin') ? Dir.entries('bin') - ['.', '..'] : []
+  end
+
+  def there_is_no_tag_for_the_current_version
+    !File.file?(".git/refs/tags/#{spec.version}")
+  end
+
+  def we_are_on_the_master_branch
+    File.file?('.git/HEAD') && File.read('.git/HEAD').strip == 'ref: refs/heads/master'
+  end
+
+  def we_have_already_pushed_the_master_branch_to_a_remote_called_origin
+    File.file?('.git/refs/remotes/origin/master')
+  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   = 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

data/shoe.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{shoe}
+  s.version = "0.1.8"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matthew Todd"]
+  s.date = %q{2009-09-02}
+  s.default_executable = %q{shoe}
+  s.email = %q{matthew.todd@gmail.com}
+  s.executables = ["shoe"]
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.files = ["Rakefile", "shoe.gemspec", "README.rdoc", "bin/shoe", "lib/shoe.rb"]
+  s.rdoc_options = ["--main", "README.rdoc", "--title", "shoe-0.1.8", "--inline-source"]
+  s.require_paths = ["lib"]
+  s.requirements = ["git"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{You probably don't want to use Shoe.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<cucumber>, [">= 0"])
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+    else
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: shoe
+version: !ruby/object:Gem::Version 
+  version: 0.1.8
+platform: ruby
+authors: 
+- Matthew Todd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-02 00:00:00 +03:00
+default_executable: shoe
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: matthew.todd@gmail.com
+executables: 
+- shoe
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- shoe.gemspec
+- README.rdoc
+- bin/shoe
+- lib/shoe.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --title
+- shoe-0.1.8
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- git
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: You probably don't want to use Shoe.
+test_files: []
+