shoe 0.5.1 → 0.6.0

data/features/step_definitions/shoe_steps.rb

@@ -1,12 +1,3 @@
-Given /^I have created a project called "([^\"]*)"$/ do |name|
-  create_directory(name)
-  create_file("#{name}/Gemfile", <<-END.gsub(/^\s*/, ''))
-    source :rubygems
-    gem 'shoe', :group => :development
-  END
-  run('bundle exec shoe .', name)
-end
-
 Given /^I have created a directory called "([^\"]*)"$/ do |name|
   create_directory(name)
 end

data/features/support/env.rb

@@ -19,7 +19,7 @@ class WorkingDirectory
   end
 
   def create_file(path, contents)
-    file(path).open('w') { |file| file.write(be_sneaky_with_the_gemfile(contents)) }
+    file(path).open('w') { |file| file.write(contents) }
   end
 
   def append_file(path, contents)
@@ -47,19 +47,15 @@ class WorkingDirectory
 
   private
 
-  def be_sneaky_with_the_gemfile(contents)
-    contents.sub("gem 'shoe'", "gem 'shoe', :path => '#{PROJECT_ROOT.expand_path}'")
-  end
-
   def isolate_environment(command)
-    # set the PATH so bundle exec can find shoe
+    # set the PATH so tests can just run shoe
     ENV['PATH'] = ENV['PATH'].split(File::PATH_SEPARATOR).
                             unshift(PROJECT_ROOT.join('bin')).uniq.
                                join(File::PATH_SEPARATOR)
+    ENV['RUBYLIB'] = PROJECT_ROOT.join('lib')
 
-    # whack most environment variables so nested bundle exec won't get confused
-    # about where the Gemfile is
-    "/usr/bin/env -i #{preserve_environment 'HOME', 'PATH', 'GEM_HOME', 'GEM_PATH'} #{command}"
+    # whack most environment variables for good hygiene
+    "/usr/bin/env -i #{preserve_environment 'HOME', 'PATH', 'GEM_HOME', 'GEM_PATH', 'RUBYLIB'} #{command}"
   end
 
   def preserve_environment(*variables)

data/features/test.feature

@@ -4,15 +4,15 @@ Feature: Test
   I want shoe to give me a rake task
 
   Scenario: Running rake --tasks in a shoe project without tests
-    Given I have created a project called "my_project"
+    Given I have run shoe --no-test-unit my_project inside "."
     And I have run git init inside "my_project"
-    When I run bundle exec rake --tasks inside "my_project"
+    When I run rake --tasks inside "my_project"
     Then I should not see "rake test" on standard out
 
   Scenario: Running rake --tasks in a shoe project with tests
-    Given I have created a project called "my_project"
+    Given I have run shoe --no-test-unit my_project inside "."
     And I have run git init inside "my_project"
     And I have created a directory called "my_project/test"
     And I have created a file called "my_project/test/foo_test.rb" containing ""
-    When I run bundle exec rake --tasks inside "my_project"
+    When I run rake --tasks inside "my_project"
     Then I should see "rake test" on standard out

data/lib/shoe.rb

@@ -1,4 +1,22 @@
+require 'pathname'
+require 'rbconfig'
+require 'rbconfig/datadir'
+
 module Shoe
-  autoload :Generator, 'shoe/generator'
-  autoload :Tasks,     'shoe/tasks'
+  VERSION = '0.6.0'
+
+  autoload :Extensions, 'shoe/extensions'
+  autoload :Generator,  'shoe/generator'
+  autoload :Tasks,      'shoe/tasks'
+
+  def self.datadir
+    @@datadir ||= begin
+      datadir = RbConfig.datadir('shoe')
+      if !File.exist?(datadir)
+        warn "#{datadir} does not exist. Trying again with relative data directory."
+        datadir = File.expand_path('../../data/shoe', __FILE__)
+      end
+      Pathname.new(datadir)
+    end
+  end
 end

data/lib/shoe/extensions.rb

@@ -0,0 +1,10 @@
+module Shoe
+  module Extensions
+    autoload :DocManager,    'shoe/extensions/doc_manager'
+    autoload :OptionParser,  'shoe/extensions/option_parser'
+    autoload :Pathname,      'shoe/extensions/pathname'
+    autoload :SourceIndex,   'shoe/extensions/source_index'
+    autoload :Specification, 'shoe/extensions/specification'
+    autoload :Validator,     'shoe/extensions/validator'
+  end
+end

data/lib/shoe/extensions/doc_manager.rb

@@ -0,0 +1,11 @@
+module Shoe
+  module Extensions
+
+    module DocManager
+      def self.extended(manager)
+        manager.instance_variable_set(:@doc_dir, Dir.pwd)
+      end
+    end
+
+  end
+end

data/lib/shoe/extensions/option_parser.rb

@@ -0,0 +1,25 @@
+module Shoe
+  module Extensions
+
+    module OptionParser
+      attr_accessor :defaults
+
+      def order(*args, &block)
+        begin
+          super(defaults.dup.concat(*args), &block)
+        rescue ::OptionParser::ParseError
+          abort($!)
+        end
+      end
+
+      def summarize(*args, &block)
+        return <<-END.gsub(/^ {10}/, '')
+          #{super}
+          Defaults:
+          #{summary_indent}#{defaults.join(' ')}
+        END
+      end
+    end
+
+  end
+end

data/lib/shoe/extensions/pathname.rb

@@ -0,0 +1,16 @@
+module Shoe
+  module Extensions
+
+    module Pathname
+      def install(contents, mode)
+        if exist?
+          warn "#{to_s} exists. Not clobbering."
+        else
+          open('w') { |file| file.write(contents) }
+          chmod(mode)
+        end
+      end
+    end
+
+  end
+end

data/lib/shoe/extensions/source_index.rb

@@ -0,0 +1,17 @@
+module Shoe
+  module Extensions
+
+    module SourceIndex
+      attr_accessor :local_gemspec
+
+      def find_name(*args)
+        if args.first == local_gemspec.name
+          [local_gemspec]
+        else
+          super
+        end
+      end
+    end
+
+  end
+end

data/lib/shoe/extensions/specification.rb

@@ -0,0 +1,19 @@
+module Shoe
+  module Extensions
+
+    module Specification
+      def self.extended(specification)
+        specification.loaded_from = Dir.pwd
+      end
+
+      def full_gem_path
+        Dir.pwd
+      end
+
+      def has_version_greater_than?(string)
+        version > Gem::Version.new(string)
+      end
+    end
+
+  end
+end

data/lib/shoe/extensions/validator.rb

@@ -0,0 +1,15 @@
+module Shoe
+  module Extensions
+
+    module Validator
+      def alert_error(*args)
+        # no-op
+      end
+
+      def unit_test(*args)
+        exit(1) unless super.passed?
+      end
+    end
+
+  end
+end

data/lib/shoe/generator.rb

@@ -1,63 +1,145 @@
 require 'erb'
+require 'optparse'
 require 'pathname'
 
 module Shoe
   class Generator
-    def initialize(root)
-      @root          = Pathname.new(root).expand_path
-      @template_path = Pathname.new(__FILE__).dirname.join('templates')
+    def initialize
+      @options = {}
+      @parser  = OptionParser.new do |opts|
+        opts.extend(Extensions::OptionParser)
+
+        opts.banner   = "Usage: #{File.basename($0)} [-adehtv] [path]"
+        opts.defaults = %w(--no-application --no-data --no-extension --test-unit .)
+        opts.version  = Shoe::VERSION
+
+        opts.on('-a', '--[no-]application', 'Generate a command-line application.') do |application|
+          @options[:application] = application
+        end
+
+        opts.on('-d', '--[no-]data', 'Generate a data directory.') do |data|
+          @options[:data] = data
+        end
+
+        opts.on('-e', '--[no-]extension', 'Generate a C extension.') do |extension|
+          @options[:extension] = extension
+        end
+
+        opts.on('-t', '--[no-]test-unit', 'Generate Test::Unit tests.') do |test_unit|
+          @options[:test_unit] = test_unit
+        end
+      end
     end
 
-    def run
-      path('README.rdoc').install template('readme.erb')
-      path('Rakefile').install    template('rakefile.erb')
-      path(version_path).install  template('version.erb')
-      path(gemspec_path).install  template('gemspec.erb')
+    def run(arguments)
+      @parser.order(arguments) { |path| @project = Project.new(path, @options) }
+
+      @project.generate
     end
 
     private
 
-    def project_name
-      @root.basename.to_s
-    end
 
-    def project_module
-      project_name.capitalize.gsub(/_(\w)/) { $1.upcase }
-    end
+    class Project
+      def initialize(path, options)
+        @path    = Pathname.new(path)
+        @options = options
+      end
 
-    def project_version
-      '0.0.0'
-    end
+      def generate
+        install('gitignore.erb', '.gitignore')
+        install('readme.erb',    'README.rdoc')
+        install('rakefile.erb',  'Rakefile')
+        install('gemspec.erb',   "#{name}.gemspec")
+        install('module.erb',    "lib/#{name}.rb")
 
-    def version_path
-      "lib/#{project_name}/version.rb"
-    end
+        if application?
+          install('executable.erb',  "bin/#{name}", 0755)
+          install('application.erb', "lib/#{name}/application.rb")
+          install('manpage.erb',     "man/#{name}.1.ronn")
+        end
 
-    def gemspec_path
-      "#{project_name}.gemspec"
-    end
+        if data?
+          install('gitkeep.erb', "data/#{name}/.gitkeep")
+        end
 
-    def template(name)
-      ERB.new(template_contents(name)).result(binding)
-    end
+        if extension?
+          install('extconf.erb',   "ext/#{name}/extconf.rb")
+          install('extension.erb', "ext/#{name}/#{extension_name}.c")
+        end
 
-    def template_contents(name)
-      @template_path.join(name).read
-    end
+        if test_unit?
+          install('test_helper.erb', "test/helper.rb")
+          install('module_test.rb',  "test/#{name}_test.rb")
+        end
+      end
+
+      private
+
+      def install(template, path, mode=0644)
+        installable_path(path).install(contents(template), mode)
+      end
 
-    def path(name)
-      path = @root.join(name)
-      path.dirname.mkpath
-      path.extend(PathExtensions)
+      def application?
+        @options[:application]
+      end
+
+      def data?
+        @options[:data]
+      end
+
+      def extension?
+        @options[:extension]
+      end
+
+      def test_unit?
+        @options[:test_unit]
+      end
+
+      def name
+        @path.expand_path.basename.to_s
+      end
+
+      def module_name
+        name.capitalize.gsub(/_(\w)/) { $1.upcase }
+      end
+
+      def version
+        '0.0.0'
+      end
+
+      def extension_name
+        'extension'
+      end
+
+      def extension_module_name
+        extension_name.capitalize.gsub(/_(\w)/) { $1.upcase }
+      end
+
+      def installable_path(name)
+        path = @path.join(name)
+        path.dirname.mkpath
+        path.extend(Extensions::Pathname)
+      end
+
+      def contents(template)
+        Template.new(template).evaluate(binding)
+      end
     end
 
-    module PathExtensions #:nodoc:
-      def install(contents)
-        if exist?
-          $stderr.puts "#{to_s} exists. Not clobbering."
-        else
-          open('w') { |file| file.write(contents) }
-        end
+    class Template
+      def initialize(name)
+        @name = name
+      end
+
+      def evaluate(binding)
+        ERB.new(contents, nil, '<>').result(binding)
+      end
+
+      private
+
+      def contents
+        Shoe.datadir.join('templates', @name).read
       end
     end
   end

data/lib/shoe/tasks.rb

@@ -6,6 +6,7 @@ module Shoe
     autoload :Compile,   'shoe/tasks/compile'
     autoload :Cucumber,  'shoe/tasks/cucumber'
     autoload :Rdoc,      'shoe/tasks/rdoc'
+    autoload :Ronn,      'shoe/tasks/ronn'
     autoload :Release,   'shoe/tasks/release'
     autoload :Test,      'shoe/tasks/test'
 
@@ -14,6 +15,7 @@ module Shoe
       Compile
       Cucumber
       Rdoc
+      Ronn
       Release
       Test
     )

data/lib/shoe/tasks/abstract.rb

@@ -5,75 +5,9 @@ module Shoe
       attr_reader :spec
 
       def initialize(spec)
-        @spec = if spec.respond_to?(:rubygems_version)
-                  spec
-                else
-                  Gem::Specification.load(spec)
-                end
-
-        @spec.extend(LocalGemspecExtensions)
-
-        if active?
-          define
-        end
-      end
-
-      private
-
-      module LocalGemspecExtensions #:nodoc:
-        def full_gem_path
-          Dir.pwd
-        end
-      end
-
-      def warn(subject, *paragraphs)
-        $stderr.extend(Colored).
-                extend(Formatted).
-                message(subject, paragraphs)
-      end
-
-      module Colored #:nodoc:
-        YELLOW = "\e[33m"
-        CLEAR  = "\e[0m"
-
-        def write(string)
-          super(YELLOW) if tty?
-          super
-          super(CLEAR) if tty?
-        end
-      end
-
-      module Formatted #:nodoc:
-        WIDTH = 72
-        WRAP  = /(.{1,#{WIDTH}})( +|$\n?)|(.{1,#{WIDTH}})/
-
-        def message(subject, paragraphs)
-          border
-          heading(subject)
-          body(paragraphs)
-          border
-        end
-
-        private
-
-        def border
-          puts '-' * WIDTH
-        end
-
-        def heading(string)
-          puts "#{string} warning from shoe".upcase
-        end
-
-        def body(paragraphs)
-          paragraphs.each do |paragraph|
-            puts
-            puts wrap(paragraph)
-          end
-        end
-
-        def wrap(string)
-          string.gsub(WRAP, "\\1\\3\n")
-        end
+        @spec = Gem::Specification.load(spec)
+        @spec.extend(Extensions::Specification)
+        define if active?
       end
     end