shoe 0.6.2 → 0.7.0

data/test/support/assertions.rb

@@ -0,0 +1,45 @@
+require 'pathname'
+
+module Assertions
+  def assert_file(path)
+    assert Pathname.new(path).exist?, "#{path} does not exist."
+  end
+
+  def assert_file_removed(*expected, &block)
+    files = find_files
+    block.call
+    assert_equal expected, files - find_files
+  end
+
+  def assert_task(expected)
+    assert find_tasks.include?(expected)
+  end
+
+  def assert_task_added(*expected, &block)
+    tasks = find_tasks
+    block.call
+    assert_equal expected, find_tasks - tasks
+  end
+
+  def assert_task_removed(*expected, &block)
+    tasks = find_tasks
+    block.call
+    assert_equal expected, tasks - find_tasks
+  end
+
+  private
+
+  def find_files
+    pwd = Pathname.pwd
+    pwd.enum_for(:find).
+      select  { |path| path.file? }.
+      collect { |path| path.relative_path_from(pwd) }.
+      collect { |path| path.to_s }
+  end
+
+  def find_tasks
+    system('rake --tasks').lines.grep(/^rake/) { |l| l.split(' ')[1] }
+  end
+end
+
+Shoe::TestCase.send(:include, Assertions)

data/test/support/command_runner.rb

@@ -0,0 +1,11 @@
+module CommandRunner
+  attr_reader :output
+
+  def system(command)
+    IO.popen("#{command} 2>&1") { |io| @output = io.read.chomp }
+    assert $?.success?, @output
+    @output
+  end
+end
+
+Shoe::TestCase.send(:include, CommandRunner)

data/test/support/declarative_tests.rb

@@ -0,0 +1,24 @@
+module DeclarativeTests
+  def describe(name, &block)
+    @context ||= []
+    @context.push(name)
+    block.call
+    @context.pop
+  end
+
+  def requires(lib, &block)
+    require lib
+  rescue LoadError
+    warn "#{lib} is not available. Skipping some tests."
+  else
+    block.call
+  end
+
+  def it(name, &block)
+    describe(name) do
+      define_method("test #{@context.join(' ')}", &block)
+    end
+  end
+end
+
+Shoe::TestCase.extend(DeclarativeTests)

data/test/support/example_project.rb

@@ -0,0 +1,37 @@
+require 'tempfile'
+
+module ExampleProject
+  PATH = File.expand_path('../../..', __FILE__)
+
+  attr_accessor :initial_gemfile
+  attr_accessor :initial_directory
+  attr_accessor :working_directory
+
+  def setup
+    self.initial_gemfile   = ENV['BUNDLE_GEMFILE']
+    self.initial_directory = Dir.pwd
+    self.working_directory = Dir.mktmpdir
+
+    Dir.chdir working_directory
+    system 'bundle gem foo'
+    Dir.chdir 'foo'
+
+    prepend_file 'Gemfile',  "path '#{PATH}'"
+    add_development_dependency 'shoe'
+    append_file  'Rakefile', <<-END
+      Bundler.setup(:default, :development)
+      require 'shoe'
+      Shoe.install_tasks
+    END
+
+    ENV['BUNDLE_GEMFILE'] = nil
+  end
+
+  def teardown
+    ENV['BUNDLE_GEMFILE'] = initial_gemfile
+    Dir.chdir initial_directory
+    FileUtils.remove_entry_secure working_directory
+  end
+end
+
+Shoe::TestCase.send(:include, ExampleProject)

data/test/support/file_manipulation.rb

@@ -0,0 +1,43 @@
+require 'pathname'
+
+# Largely stolen from thor, then simplified a bit.
+module FileManipulation
+  def prepend_file(path, contents)
+    inject_into_file(path, contents, :before => /\A/)
+  end
+
+  def append_file(path, contents)
+    inject_into_file(path, contents, :after => /\z/)
+  end
+
+  def inject_into_file(path, contents, options={})
+    flag = nil
+
+    if options.key?(:after)
+      contents = '\0' + contents + "\n"
+      flag     = options.delete(:after)
+    else
+      contents = contents + "\n" + '\0'
+      flag     = options.delete(:before)
+    end
+
+    gsub_file(path, flag, contents)
+  end
+
+  def gsub_file(path, search, replace)
+    write_file(path, File.read(path).gsub(search, replace))
+  end
+
+  def write_file(path, contents)
+    path = Pathname.new(path)
+    path.parent.mkpath
+    path.open('w') { |stream| stream.write(contents) }
+  end
+
+  def write_versioned_file(path, contents)
+    write_file path, contents
+    system "git add #{path}"
+  end
+end
+
+Shoe::TestCase.send(:include, FileManipulation)

data/test/support/gemspec_manipulation.rb

@@ -0,0 +1,24 @@
+require 'pathname'
+
+module GemspecManipulation
+  def add_development_dependency(name)
+    add_to_gemspec("s.add_development_dependency('#{name}')")
+  end
+
+  def add_to_gemspec(contents)
+    # don't say "end" to avoid confusing vim's formatter
+    inject_into_file(gemspec, contents, :before => /en.\s*\z/)
+  end
+
+  def mask_gemspec_todos
+    gsub_file(gemspec, /TODO: Write [ \w]*/, 'Masked')
+  end
+
+  private
+
+  def gemspec
+    Dir['*.gemspec'].first
+  end
+end
+
+Shoe::TestCase.send(:include, GemspecManipulation)

data/test/support/project_files.rb

@@ -0,0 +1,60 @@
+require 'yaml'
+
+module ProjectFiles
+  def add_files_for_c_extension
+    add_to_gemspec(
+      's.extensions = `git ls-files -- "ext/**/extconf.rb"`.split("\n")')
+
+    write_versioned_file "ext/foo/extconf.rb", <<-END
+      require 'mkmf'
+      create_makefile 'foo/extension'
+    END
+
+    write_versioned_file "ext/foo/extension.c", <<-END
+      #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
+
+  def add_files_for_cucumber(assertion='')
+    write_file 'cucumber.yml',
+      { 'default' => 'features', 'wip' => 'features' }.to_yaml
+
+    write_file 'features/api.feature', <<-END
+      Feature: The API
+        Scenario: Exercising something
+          Then I should pass
+    END
+
+    write_file 'features/step_definitions/steps.rb', <<-END
+      Then /^I should pass$/ do
+        #{assertion}
+      end
+    END
+  end
+
+  def add_files_for_ronn
+    write_versioned_file 'man/foo.3.ronn', <<-END
+      foo(3) -- be awesome
+      ====================
+    END
+  end
+
+  def add_files_for_test(assertion='assert true')
+    write_versioned_file 'test/foo_test.rb', <<-END
+      require 'test/unit'
+      class FooTest < Test::Unit::TestCase
+        def test_something
+          #{assertion}
+        end
+      end
+    END
+  end
+end
+
+Shoe::TestCase.send(:include, ProjectFiles)

data/test/support/redgreen.rb

@@ -0,0 +1,6 @@
+begin
+  require 'redgreen' if $stdout.tty?
+rescue LoadError
+  # Since we don't have hard gem dependencies for testing, folks can run `gem
+  # check --test shoe` without installing anything else.
+end

data/test/system/rake_test.rb

@@ -0,0 +1,124 @@
+require 'test/helper'
+
+class RakeTest < Shoe::TestCase
+  describe 'rake clean' do
+    it 'is active only if there is a .git directory' do
+      assert_task_removed 'clean' do
+        system 'mv .git .git.bak'
+      end
+    end
+
+    it 'removes ignored files, excluding .bundler' do
+      write_file '.gitignore',     ".bundle\nbar"
+      write_file '.bundle/foo.rb', 'will remain'
+      write_file 'bar',            'will be deleted'
+      assert_file_removed 'bar' do
+        system 'rake clean'
+      end
+    end
+  end
+
+  describe 'rake compile' do
+    it 'is active only if there are extensions' do
+      assert_task_added 'compile' do
+        add_files_for_c_extension
+      end
+    end
+
+    it 'builds extensions' do
+      add_files_for_c_extension
+      system 'rake compile'
+      system 'ruby -Ilib -rfoo/extension -e "puts Foo::Extension.name"'
+      assert_equal 'Foo::Extension', output
+    end
+  end
+
+  describe 'rake cucumber' do
+    requires 'cucumber' do
+      it 'is active only if there are profiles in cucumber.yml' do
+        add_development_dependency 'cucumber'
+        assert_task_added 'cucumber', 'cucumber:wip' do
+          add_files_for_cucumber
+        end
+      end
+
+      it 'runs cucumber features' do
+        add_development_dependency 'cucumber'
+        add_files_for_cucumber
+        system 'rake cucumber'
+        assert_match '1 scenario (1 passed)', output
+      end
+
+      it 'depends (perhaps indirectly) on rake compile' do
+        add_development_dependency 'cucumber'
+        add_files_for_c_extension
+        add_files_for_cucumber 'require "foo/extension"'
+        system 'rake cucumber'
+        assert_match '1 scenario (1 passed)', output
+      end
+    end
+  end
+
+  describe 'rake rdoc' do
+    it 'is unconditionally active' do
+      assert_task 'rdoc'
+    end
+
+    it 'generates rdoc' do
+      # Launchy runs BROWSER in a subshell, sending output to /dev/null, so if
+      # I want to test it, I'm going to have to be more clever than this. For
+      # the meantime, though, using /bin/echo at least keeps from opening a
+      # real browser at test time.
+      system 'BROWSER=/bin/echo rake rdoc'
+      assert_file 'rdoc/index.html'
+    end
+  end
+
+  describe 'rake ronn' do
+    requires 'ronn' do
+      it 'is enabled if there are ronn files' do
+        add_development_dependency 'ronn'
+        assert_task_added 'ronn' do
+          add_files_for_ronn
+        end
+      end
+
+      it 'generates man pages' do
+        add_development_dependency 'ronn'
+        add_files_for_ronn
+        system 'MANPAGER=/bin/cat rake ronn'
+        assert_file 'man/foo.3'
+        assert_match 'FOO(3)', output
+      end
+
+      it 'registers itself as a prerequisite of rake build' do
+        add_development_dependency 'ronn'
+        add_files_for_ronn
+        mask_gemspec_todos
+        system 'rake build'
+        assert_file 'man/foo.3'
+      end
+    end
+  end
+
+  describe 'rake test' do
+    it 'is active only if there are test files present' do
+      assert_task_added 'test' do
+        add_files_for_test
+      end
+    end
+
+    it 'runs tests' do
+      add_files_for_test
+      system 'rake test'
+      assert_match '1 tests, 1 assertions, 0 failures, 0 errors', output
+    end
+
+    it 'depends (perhaps indirectly) on rake compile' do
+      add_files_for_c_extension
+      add_files_for_test 'require "foo/extension"'
+      system 'rake test'
+      assert_match '1 tests, 0 assertions, 0 failures, 0 errors', output
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 2
-  version: 0.6.2
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Matthew Todd
@@ -14,140 +14,114 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-29 00:00:00 +03:00
+date: 2010-10-11 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        version: "0"
+        - 8
+        - 7
+        version: 0.8.7
   type: :runtime
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: launchy
-  prerelease: false
+  name: bundler
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
+        - 1
         - 0
-        version: "0"
-  type: :runtime
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: cucumber
-  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        version: "0"
+        - 6
+        - 4
+        version: 0.6.4
   type: :development
+  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: redgreen
-  prerelease: false
+  name: ronn
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        version: "0"
+        - 5
+        version: "0.5"
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: ronn
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id005
-description: |
-  An ecosystem-friendly library of Rake tasks for your gem.
-  
-  Shoe assumes you could be using any number of other tools -- bundler,
-  cucumber, git, rip, rubygems -- and so leans hard on them for the things
-  they do well, relegating command-line rake to mere syntactic sugar.
+  version_requirements: *id004
+description: Configuration-free Rake tasks that read your gemspec. These tasks re-use built-in Rubygems functionality so you can be confident you're shipping what you think you are.
+email: 
+- matthew.todd@gmail.com
+executables: []
 
-email: matthew.todd@gmail.com
-executables: 
-- shoe
 extensions: []
 
-extra_rdoc_files: 
-- CHANGELOG.rdoc
-- README.rdoc
-- TODO.rdoc
+extra_rdoc_files: []
+
 files: 
+- .gitignore
+- .rvmrc
 - CHANGELOG.rdoc
+- Gemfile
+- Gemfile.lock
 - README.rdoc
+- Rakefile
 - TODO.rdoc
-- bin/shoe
-- 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_1.erb
-- data/shoe/templates/manpage_3.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
+- 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/test_runner.rb
 - lib/shoe/extensions/validator.rb
-- lib/shoe/extensions.rb
-- lib/shoe/generator.rb
-- lib/shoe/tasks/abstract.rb
+- lib/shoe/tasks.rb
 - lib/shoe/tasks/clean.rb
 - lib/shoe/tasks/compile.rb
 - lib/shoe/tasks/cucumber.rb
 - lib/shoe/tasks/rdoc.rb
-- lib/shoe/tasks/release.rb
 - lib/shoe/tasks/ronn.rb
+- lib/shoe/tasks/task.rb
 - lib/shoe/tasks/test.rb
-- lib/shoe/tasks.rb
-- lib/shoe.rb
-- man/shoe.1
-- man/shoe.1.ronn
+- lib/shoe/util/minitest_colors.rb
+- lib/shoe/version.rb
 - man/shoe.3
 - man/shoe.3.ronn
-- test/extensions/fake_rubygems_server.rb
-- test/extensions/helper_methods.rb
-- test/extensions/isolated_environment.rb
-- test/extensions/test_case.rb
+- shoe.gemspec
 - test/helper.rb
-- test/system/rake_clean_test.rb
-- test/system/rake_compile_test.rb
-- test/system/rake_cucumber_test.rb
-- test/system/rake_rdoc_test.rb
-- test/system/rake_release_test.rb
-- test/system/rake_ronn_test.rb
-- test/system/rake_test_test.rb
-- test/system/shoe_test.rb
+- test/support/assertions.rb
+- test/support/command_runner.rb
+- test/support/declarative_tests.rb
+- test/support/example_project.rb
+- test/support/file_manipulation.rb
+- test/support/gemspec_manipulation.rb
+- test/support/project_files.rb
+- test/support/redgreen.rb
+- test/system/rake_test.rb
 has_rdoc: true
 homepage: http://github.com/matthewtodd/shoe
 licenses: []
@@ -157,20 +131,23 @@ rdoc_options:
 - --main
 - README.rdoc
 - --title
-- shoe-0.6.2
+- shoe-0.7.0
 - --inline-source
 - --webcvs
-- http://github.com/matthewtodd/shoe/blob/v0.6.2/
+- http://github.com/matthewtodd/shoe/blob/v0.7.0/
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 373556691
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -181,17 +158,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: 
 - git
-rubyforge_project: 
-rubygems_version: 1.3.6
+rubyforge_project: shoe
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: An ecosystem-friendly library of Rake tasks for your gem.
+summary: Configuration-free Rake tasks that read your gemspec.
 test_files: 
-- test/system/rake_clean_test.rb
-- test/system/rake_compile_test.rb
-- test/system/rake_cucumber_test.rb
-- test/system/rake_rdoc_test.rb
-- test/system/rake_release_test.rb
-- test/system/rake_ronn_test.rb
-- test/system/rake_test_test.rb
-- test/system/shoe_test.rb
+- test/helper.rb
+- test/support/assertions.rb
+- test/support/command_runner.rb
+- test/support/declarative_tests.rb
+- test/support/example_project.rb
+- test/support/file_manipulation.rb
+- test/support/gemspec_manipulation.rb
+- test/support/project_files.rb
+- test/support/redgreen.rb
+- test/system/rake_test.rb