shoe 0.6.2 → 0.7.0

data/lib/shoe/tasks/release.rb

@@ -1,81 +0,0 @@
-module Shoe
-  module Tasks
-
-    # Defines <tt>`rake release`</tt> to release your gem.
-    #
-    # To release is to: commit, tag, optionally push (with tags), and then
-    # build and push your gem.
-    #
-    # This task is enabled under very specific circumstances, to safeguard
-    # against accidental releases:
-    # 1. Your <tt>version[http://docs.rubygems.org/read/chapter/20#version]</tt> is greater than <tt>0.0.0</tt>.
-    # 2. There is no existing git tag <tt>"v#{version}"</tt>.
-    # 3. You are currently on the <tt>master</tt> branch.
-    #
-    # To configure, adjust the
-    # <tt>version[http://docs.rubygems.org/read/chapter/20#version]</tt> in
-    # your gemspec.
-    #
-    # = Semantic Versioning
-    #
-    # Shoe helps you follow the Tagging Specification of {Semantic
-    # Versioning}[http://semver.org] by tagging your releases as
-    # <tt>"v#{version}"</tt>, prefixing a <tt>"v"</tt> before the version
-    # number.
-    #
-    # Shoe additionally complains if you haven't yet created a <tt>semver</tt>
-    # tag to denote your compliance.
-    class Release < Abstract
-      def active?
-        spec.has_version_greater_than?('0.0.0') &&
-          there_is_no_tag_for(version_tag(spec.version)) &&
-          we_are_on_the_master_branch
-      end
-
-      def define
-        desc "Release #{spec.full_name}."
-        task :release do
-          sh "git commit -a -m 'Release #{spec.version}'"
-          sh "git tag #{version_tag(spec.version)}"
-
-          if there_is_no_tag_for('semver')
-            warn "WARN: Please `git tag semver`. <http://semver.org/>"
-          end
-
-          if there_is_a_remote_called('origin')
-            sh 'git push origin master'
-            sh 'git push --tags origin'
-          end
-
-          sh "gem build #{spec.name}.gemspec"
-          sh "gem push #{spec.file_name}"
-        end
-
-        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
-
-      def there_is_no_tag_for(tag)
-        !`git tag`.to_a.include?("#{tag}\n")
-      end
-
-      def version_tag(version)
-        "v#{spec.version}"
-      end
-
-      def we_are_on_the_master_branch
-        `git symbolic-ref HEAD`.strip == 'refs/heads/master'
-      end
-    end
-
-  end
-end

data/man/shoe.1

@@ -1,63 +0,0 @@
-.\" 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 \fIshoe(3)\fR library of
-on\-demand \fBrake(1)\fR tasks built around your (authoritative) gemspec.
-.
-.SH "OPTIONS"
-By default, \fBshoe\fR generates 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 \fBoptparse\fR\-based \fBApplication\fR class.
-.
-.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.
-.
-.SH "AUTHOR"
-Matthew Todd, \fImatthewtodd\fR on GitHub. Do drop
-me a line if you use \fBshoe\fR \-\- I'd love to hear from you!
-.
-.SH "SEE ALSO"
-\fIshoe(3)\fR, \fIhttp://chneukirchen.github.com/rps/\fR, \fIhttp://gembundler.com/\fR, \fIhttp://defunkt.github.com/rip/\fR, \fIhttp://github.com/rtomayko/rpg\fR

data/man/shoe.1.ronn

@@ -1,60 +0,0 @@
-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 [shoe(3)](shoe.3.html) library of
-on-demand `rake(1)` tasks built around your (authoritative) gemspec.
-
-## OPTIONS
-
-By default, `shoe` generates 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 `optparse`-based `Application` class.
-
-* `-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.
-
-## AUTHOR
-
-Matthew Todd, [matthewtodd](http://github.com/matthewtodd) on GitHub. Do drop
-me a line if you use `shoe` -- I'd love to hear from you!
-
-## SEE ALSO
-
-[shoe(3)](shoe.3.html),
-<http://chneukirchen.github.com/rps/>,
-<http://gembundler.com/>,
-<http://defunkt.github.com/rip/>,
-<http://github.com/rtomayko/rpg>

data/test/extensions/fake_rubygems_server.rb

@@ -1,62 +0,0 @@
-require 'logger'
-require 'rubygems/format'
-require 'stringio'
-require 'webrick'
-
-module Shoe
-  module TestExtensions
-
-    class FakeRubygemsServer
-      def self.start(&block)
-        new.start(&block)
-      end
-
-      def initialize(host='127.0.0.1', port=48484)
-        @initial_rubygems_host = ENV['RUBYGEMS_HOST']
-        @fake_rubygems_host    = "http://#{host}:#{port}"
-
-        @message_bus = Queue.new
-        @webrick = WEBrick::HTTPServer.new(
-                     # Ruby is super slow to create the underlying Socket if
-                     # (my ISP's upstream connection is flakey? and) we don't
-                     # specify a BindAddress.
-                     :BindAddress   => host,
-                     :Port          => port,
-                     :Logger        => Logger.new(nil),
-                     :AccessLog     => [],
-                     :StartCallback => lambda { @message_bus.push(:ready) }
-                   )
-
-        @webrick.mount_proc('/api/v1/gems') do |req, res|
-          @uploaded_gem = req.body
-          @uploaded_gem.extend(GemEntries)
-        end
-      end
-
-      def start(&block)
-        ENV['RUBYGEMS_HOST'] = @fake_rubygems_host
-        thread = Thread.new { @webrick.start }
-        @message_bus.pop
-        block.call
-        return @uploaded_gem
-      ensure
-        ENV['RUBYGEMS_HOST'] = @initial_rubygems_host
-        @webrick.shutdown
-        thread.join
-      end
-
-      private
-
-      module GemEntries
-        def contents
-          package.file_entries.map { |entry| entry.first['path'] }
-        end
-
-        def package
-          Gem::Format::from_io(StringIO.new(self))
-        end
-      end
-    end
-
-  end
-end

data/test/extensions/helper_methods.rb

@@ -1,73 +0,0 @@
-require 'open3'
-require 'pathname'
-
-module Shoe
-  module TestExtensions
-
-    module HelperMethods
-      attr_reader :stdout, :stderr
-
-      def system(*args)
-        stdin, stdout, stderr = Open3.popen3(*args)
-        stdin.close
-        @stdout = stdout.read
-        @stderr = stderr.read
-      end
-
-      def find(string)
-        root = Pathname.new(string)
-        root.enum_for(:find).
-               select { |path| path.file? }.
-              collect { |path| path.relative_path_from(root).to_s }
-      end
-
-      def write_file(path, contents)
-        path = Pathname.new(path)
-        path.parent.mkpath
-        path.open('w') { |stream| stream.write(contents) }
-      end
-
-      def in_project(name)
-        Dir.mkdir(name)
-        Dir.chdir(name)
-      end
-
-      def assert_file(path)
-        assert Pathname.new(path).exist?, "#{path} does not exist."
-      end
-
-      def assert_find(path, expected)
-        assert_equal expected.sort, find(path).sort
-      end
-
-      def assert_no_task(name)
-        system 'rake --tasks'
-        assert_no_match /\srake #{name}\s/, stdout
-      end
-
-      def assert_task(name)
-        system 'rake --tasks'
-        assert_match /\srake #{name}\s/, stdout
-      end
-
-      def add_files_for_c_extension
-        write_file "ext/foo/extconf.rb", <<-END.gsub(/^ */, '')
-          require 'mkmf'
-          create_makefile 'foo/extension'
-        END
-
-        write_file "ext/foo/extension.c", <<-END.gsub(/^ */, '')
-          #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
-
-    end
-
-  end
-end

data/test/extensions/isolated_environment.rb

@@ -1,50 +0,0 @@
-require 'tempfile'
-
-module Shoe
-  module TestExtensions
-
-    module IsolatedEnvironment
-      def setup
-        @environment = Environment.new
-        @environment.setup do |env|
-          env.path('PATH')    { |path| path.unshift Pathname.new('bin').expand_path }
-          env.path('RUBYLIB') { |path| path.unshift Pathname.new('lib').expand_path }
-        end
-        super
-      end
-
-      def teardown
-        super
-        @environment.teardown
-      end
-
-      private
-
-      class Environment
-        def setup
-          @initial_environment = {}
-          ENV.each { |name, value| @initial_environment[name] = value }
-          yield self
-          @initial_directory   = Dir.pwd
-          @working_directory   = Dir.mktmpdir
-          Dir.chdir(@working_directory)
-        end
-
-        def path(name)
-          path = ENV[name].to_s.split(File::PATH_SEPARATOR)
-          yield path
-          ENV[name] = path.join(File::PATH_SEPARATOR)
-        end
-
-        def teardown
-          Dir.chdir(@initial_directory)
-          FileUtils.remove_entry_secure(@working_directory)
-          ENV.clear
-          @initial_environment.each { |name, value| ENV[name] = value }
-        end
-      end
-    end
-
-  end
-end
-

data/test/extensions/test_case.rb

@@ -1,40 +0,0 @@
-module Shoe
-  module TestExtensions
-
-    module TestCase
-      def isolate_environment
-        include IsolatedEnvironment
-      end
-
-      def include_helper_methods
-        include HelperMethods
-      end
-
-      def pending(name, options={}, &block)
-        warn "WARN: Pending test \"#{name}\""
-      end
-
-      def test(name, options={}, &block)
-        if !block_given?
-          pending(name, options, &block)
-          return
-        end
-
-        requires = Array(options[:require])
-
-        requires.each do |lib|
-          begin
-            require lib
-          rescue LoadError
-            warn "WARN: #{lib} is not available.\n  Skipping test \"#{name}\""
-            define_method('default_test', lambda {})
-            return
-          end
-        end
-
-        define_method("test #{name}", &block)
-      end
-    end
-
-  end
-end

data/test/system/rake_clean_test.rb

@@ -1,36 +0,0 @@
-require 'test/helper'
-
-class RakeCleanTest < Test::Unit::TestCase
-  isolate_environment
-  include_helper_methods
-
-  def setup
-    super
-    in_project 'foo'
-    system 'shoe'
-  end
-
-  test 'rake clean is active only if there is a .git directory' do
-    assert_no_task 'clean'
-    system 'git init'
-    assert_task 'clean'
-  end
-
-  test 'rake clean removes ignored files, excluding .rvmrc and .bundler' do
-    system 'git init'
-
-    write_file '.gitignore', <<-END.gsub(/^ */, '')
-      .bundle
-      .rvmrc
-      bar
-    END
-
-    write_file '.bundle/config.rb', '# STAYING ALIVE'
-    write_file '.rvmrc',            '# STAYING ALIVE'
-    write_file 'bar',               'NOT LONG FOR THIS WORLD'
-
-    files_before_clean = find('.')
-    system 'rake clean'
-    assert_find  '.', files_before_clean - ['bar']
-  end
-end