shoe 0.1.13 → 0.2.0

data/lib/shoe/cli.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+require 'erb'
+require 'pathname'
+
+class Shoe
+  class CLI
+    class << self
+      def run
+        new.run
+      end
+    end
+
+    attr_reader :root
+    attr_reader :spec
+    attr_reader :template_path
+
+    def initialize
+      @root = Pathname.pwd.expand_path
+
+      @spec = Gem::Specification.new do |spec|
+        spec.name = root.basename.to_s
+        spec.version = '0.0.0'
+      end
+
+      @template_path = Pathname.new(__FILE__).dirname.join('templates')
+    end
+
+    def run
+      path('Gemfile').update template('gemfile.erb')
+
+      path('README.rdoc').install template('readme.erb')
+      path('Rakefile').install    template('rakefile.erb')
+      path(version_path).install  template('version.erb')
+      path(gemspec_path).install  spec.to_ruby
+    end
+
+    private
+
+    def project
+      spec.name
+    end
+
+    def project_class
+      project.capitalize.gsub(/_(\w)/) { $1.upcase }
+    end
+
+    def project_version
+      spec.version
+    end
+
+    def version_path
+      "lib/#{project}/version.rb"
+    end
+
+    def gemspec_path
+      "#{project}.gemspec"
+    end
+
+    def template(name)
+      ERB.new(template_contents(name)).result(binding)
+    end
+
+    def template_contents(name)
+      template_path.join(name).read
+    end
+
+    def path(name)
+      path = root.join(name)
+      path.dirname.mkpath
+      path.extend(PathExtensions)
+    end
+
+    module PathExtensions
+      def install(contents)
+        if exist?
+          $stderr.puts "#{to_s} exists. Not clobbering."
+        else
+          write(contents, 'w')
+        end
+      end
+
+      def update(contents)
+        write(contents, 'a')
+      end
+
+      private
+
+      def write(contents, mode)
+        open(mode) { |file| file.write(contents) }
+      end
+    end
+  end
+end

data/lib/shoe/project.rb

@@ -0,0 +1,26 @@
+module Shoe
+  class Project
+
+    # 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', 'lib/**/*']
+        spec.author           = `git config --get user.name`.chomp
+        spec.email            = `git config --get user.email`.chomp
+      end
+    end
+
+    # This is where the magic happens.
+    def define_tasks
+      Shoe::Tasks.each do |task|
+        task.define(spec)
+      end
+    end
+  end
+end

data/lib/shoe/tasks.rb

@@ -0,0 +1,80 @@
+module Shoe
+  module Tasks
+
+    autoload :Bin,       'shoe/tasks/bin'
+    autoload :Clean,     'shoe/tasks/clean'
+    autoload :Compile,   'shoe/tasks/compile'
+    autoload :Cucumber,  'shoe/tasks/cucumber'
+    autoload :Gemspec,   'shoe/tasks/gemspec'
+    autoload :Rdoc,      'shoe/tasks/rdoc'
+    autoload :Release,   'shoe/tasks/release'
+    autoload :Resources, 'shoe/tasks/resources'
+    autoload :Shell,     'shoe/tasks/shell'
+    autoload :Shoulda,   'shoe/tasks/shoulda'
+    autoload :Test,      'shoe/tasks/test'
+
+    LOAD_ORDER = %w(
+      Bin
+      Clean
+      Gemspec
+      Rdoc
+      Release
+      Resources
+      Shell
+      Shoulda
+      Test
+      Cucumber
+      Compile
+    )
+
+    def self.each
+      LOAD_ORDER.map { |name| const_get name }.
+                each { |task| yield task }
+    end
+
+    class AbstractTask
+      def self.define(spec)
+        task = new(spec)
+
+        if task.active?
+          task.update_spec
+          task.define
+        end
+
+        task
+      end
+
+      attr_reader :spec
+
+      def initialize(spec)
+        @spec = spec
+      end
+
+      def active?
+        true
+      end
+
+      def define
+        # no-op
+      end
+
+      def update_spec
+        # no-op
+      end
+
+      private
+
+      def before(name, dependency)
+        desc Rake::Task[dependency].comment
+        task name => dependency
+      end
+
+      def before_existing(name, dependency)
+        if Rake::Task.task_defined?(name)
+          task name => dependency
+        end
+      end
+    end
+
+  end
+end

data/lib/shoe/tasks/bin.rb

@@ -0,0 +1,14 @@
+module Shoe
+  module Tasks
+
+    class Bin < AbstractTask
+      def update_spec
+        spec.files       += Rake::FileList['bin/*']
+        spec.executables += Rake::FileList['bin/*'].map do |path|
+          File.basename(path)
+        end
+      end
+    end
+
+  end
+end

data/lib/shoe/tasks/clean.rb

@@ -0,0 +1,18 @@
+module Shoe
+  module Tasks
+
+    class Clean < AbstractTask
+      def active?
+        File.directory?('.git')
+      end
+
+      def define
+        desc 'Remove ignored files'
+        task :clean do
+          sh 'git clean -fdX'
+        end
+      end
+    end
+
+  end
+end

data/lib/shoe/tasks/compile.rb

@@ -0,0 +1,46 @@
+require 'rubygems/ext'
+
+module Shoe
+  module Tasks
+
+    class Compile < AbstractTask
+      def active?
+        File.directory?('ext')
+      end
+
+      def define
+        desc 'Compile C extensions'
+        task :compile do
+          top_level_path   = File.expand_path('.')
+          destination_path = File.join(top_level_path, spec.require_paths.first)
+
+          spec.extensions.each do |extension|
+            Dir.chdir File.dirname(extension) do
+              Gem::Ext::ExtConfBuilder.build(
+                extension,
+                top_level_path,
+                destination_path,
+                results = []
+              )
+            end
+          end
+        end
+
+        %w(
+          test
+          cucumber:ok
+          cucumber:wip
+          release
+        ).each do |name|
+          before_existing(name, :compile)
+        end
+      end
+
+      def update_spec
+        spec.files      += Rake::FileList['ext/**/extconf.rb', 'ext/**/*.c']
+        spec.extensions += Rake::FileList['ext/**/extconf.rb']
+      end
+    end
+
+  end
+end

data/lib/shoe/tasks/cucumber.rb

@@ -0,0 +1,42 @@
+module Shoe
+  module Tasks
+
+    class Cucumber < AbstractTask
+      def active?
+        File.directory?('features')
+      end
+
+      def define
+        begin
+          require 'cucumber/rake/task'
+        rescue LoadError
+          # no cuke for you
+        else
+          define_tasks
+        end
+      end
+
+      def update_spec
+        spec.files += Rake::FileList['features/**/*']
+      end
+
+      private
+
+      def define_tasks
+        namespace :cucumber do
+          ::Cucumber::Rake::Task.new(:ok, 'Run features') do |task|
+            task.cucumber_opts = '--tags ~@wip'
+          end
+
+          ::Cucumber::Rake::Task.new(:wip, 'Run work-in-progress features') do |task|
+            task.cucumber_opts = '--tags @wip --wip'
+          end
+        end
+
+        before(:default, 'cucumber:ok')
+        before(:default, 'cucumber:wip')
+      end
+    end
+
+  end
+end

data/lib/shoe/tasks/gemspec.rb

@@ -0,0 +1,14 @@
+module Shoe
+  module Tasks
+
+    class Gemspec < AbstractTask
+      def define
+        desc 'Show latest gemspec contents'
+        task :gemspec do
+          puts spec.to_ruby
+        end
+      end
+    end
+
+  end
+end

data/lib/shoe/tasks/rdoc.rb

@@ -0,0 +1,63 @@
+require 'rubygems/doc_manager'
+
+module Shoe
+  module Tasks
+
+    class Rdoc < AbstractTask
+      def active?
+        File.directory?('lib')
+      end
+
+      def define
+        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
+
+      def update_spec
+        spec.files += Rake::FileList['**/*.rdoc', 'examples/**/*']
+
+        spec.rdoc_options = %W(
+          --main README.rdoc
+          --title #{spec.full_name}
+          --inline-source
+        )
+
+        spec.extra_rdoc_files += Rake::FileList['**/*.rdoc']
+
+        spec.has_rdoc = true
+      end
+
+      private
+
+      # 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
+
+  end
+end

data/lib/shoe/tasks/release.rb

@@ -0,0 +1,94 @@
+module Shoe
+  module Tasks
+
+    class Release < AbstractTask
+      def active?
+        spec.extend(VersionExtensions)
+
+        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
+          File.open("#{spec.name}.gemspec", 'w') do |stream|
+            stream.write(spec.to_ruby)
+          end
+
+          sh "git add #{spec.name}.gemspec"
+          sh "git commit -a -m 'Release #{spec.version}'"
+          sh "git tag #{version_tag(spec.version)}"
+
+          if there_is_no_tag_for('semver')
+            $stderr.puts <<-END.gsub(/^ +/, '')
+            ---------------------------------------------
+            SEMANTIC VERSIONING WARNING
+
+            It seems you don't yet have a 'semver' tag.
+
+            Please read more about the emerging consensus
+            around semantic versioning:
+
+            http://semver.org/
+            ---------------------------------------------
+            END
+          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"
+
+          if Gem::CommandManager.instance.command_names.include?('push')
+            sh "gem push #{spec.file_name}"
+          else
+            $stderr.puts <<-END.gsub(/^ +/, '')
+            ---------------------------------------------
+            GEMCUTTER WARNING
+
+            It seems you don't have gemcutter installed.
+
+            Please `gem install gemcutter` and
+            `gem push #{spec.file_name}`
+            if you would like to make a public release.
+            ---------------------------------------------
+            END
+          end
+        end
+      end
+
+      def update_spec
+        spec.files += Rake::FileList['*.gemspec']
+      end
+
+      private
+
+      module VersionExtensions
+        def has_version_greater_than?(string)
+          version > Gem::Version.new(string)
+        end
+      end
+
+      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