methadone-rehab 1.9.2

data/features/multilevel_commands.feature

@@ -0,0 +1,125 @@
+Feature: Support multi-level commands
+  As a developer who wants to make a multi-level command line app
+  I should be able to create a Methadone class that delegates subcommands to other Methadone classes
+  and each should support their own options, args and potentially other subcommands.
+
+  Background:
+    Given the directory "tmp/multigem" does not exist
+
+  Scenario: Bootstrap a multi-level app from scratch
+    When I successfully run `methadone --commands walk,run,crawl,dance tmp/multigem`
+    Then the following directories should exist:
+      |tmp/multigem                           |
+      |tmp/multigem/bin                       |
+      |tmp/multigem/lib                       |
+      |tmp/multigem/lib/multigem              |
+      |tmp/multigem/lib/multigem/commands     |
+      |tmp/multigem/test                      |
+      |tmp/multigem/features                  |
+      |tmp/multigem/features/support          |
+      |tmp/multigem/features/step_definitions |
+    Then the following directories should not exist:
+      |tmp/multigem/spec |
+    And the following files should exist:
+      |tmp/multigem/multigem.gemspec                            |
+      |tmp/multigem/Rakefile                                    |
+      |tmp/multigem/.gitignore                                  |
+      |tmp/multigem/Gemfile                                     |
+      |tmp/multigem/bin/multigem                                |
+      |tmp/multigem/lib/multigem/version.rb                     |
+      |tmp/multigem/lib/multigem/commands/walk.rb               |
+      |tmp/multigem/lib/multigem/commands/run.rb                |
+      |tmp/multigem/lib/multigem/commands/crawl.rb              |
+      |tmp/multigem/lib/multigem/commands/dance.rb              |
+      |tmp/multigem/features/multigem.feature                   |
+      |tmp/multigem/features/support/env.rb                     |
+      |tmp/multigem/features/step_definitions/multigem_steps.rb |
+      |tmp/multigem/test/tc_something.rb                        |
+    And the file "tmp/multigem/.gitignore" should match /results.html/
+    And the file "tmp/multigem/.gitignore" should match /html/
+    And the file "tmp/multigem/.gitignore" should match /pkg/
+    And the file "tmp/multigem/.gitignore" should match /.DS_Store/
+    And the file "tmp/multigem/multigem.gemspec" should match /add_development_dependency\('aruba'/
+    And the file "tmp/multigem/multigem.gemspec" should match /add_development_dependency\('rdoc'/
+    And the file "tmp/multigem/multigem.gemspec" should match /add_development_dependency "rake", "~> 10.0"/
+    And the file "tmp/multigem/multigem.gemspec" should match /add_dependency\('methadone-rehab'/
+    And the file "tmp/multigem/multigem.gemspec" should use the same block variable throughout
+    And the file "tmp/multigem/bin/multigem" should match /command "walk" => Multigem::Commands::Walk/
+    And the file "tmp/multigem/bin/multigem" should match /command "run" => Multigem::Commands::Run/
+    And the file "tmp/multigem/bin/multigem" should match /command "crawl" => Multigem::Commands::Crawl/
+    And the file "tmp/multigem/bin/multigem" should match /command "dance" => Multigem::Commands::Dance/
+    Given I cd to "tmp/multigem"
+    And my app's name is "multigem"
+    When I successfully run `bin/multigem --help` with "lib" in the library path
+    Then the banner should be present
+    And the banner should document that this app takes options
+    And the banner should document that this app takes commands
+    And the following commands should be documented:
+      |walk  |
+      |run   |
+      |crawl |
+      |dance |
+    And the following options should be documented:
+      |--version|
+      |--help|
+      |--log-level|
+
+  Scenario: Special characters in subcommands and gem name
+    Given a directory named "tmp"
+    And the directory "tmp/multigem2" does not exist
+    When I run `methadone --add-lib --commands walk,run,crawl_to_bed,tap-dance,@go-crazy tmp/multigem2`
+    Then the exit status should be 0
+    And the following directories should exist:
+      |tmp/multigem2                            |
+      |tmp/multigem2/bin                        |
+      |tmp/multigem2/lib                        |
+      |tmp/multigem2/lib/multigem2              |
+      |tmp/multigem2/lib/multigem2/commands     |
+      |tmp/multigem2/test                       |
+      |tmp/multigem2/features                   |
+      |tmp/multigem2/features/support           |
+      |tmp/multigem2/features/step_definitions  |
+    And the following directories should not exist:
+      |tmp/multigem2/spec |
+    And the following files should exist:
+      |tmp/multigem2/multigem2.gemspec                             |
+      |tmp/multigem2/Rakefile                                     |
+      |tmp/multigem2/.gitignore                                   |
+      |tmp/multigem2/Gemfile                                      |
+      |tmp/multigem2/bin/multigem2                                |
+      |tmp/multigem2/lib/multigem2/version.rb                     |
+      |tmp/multigem2/lib/multigem2/commands/walk.rb               |
+      |tmp/multigem2/lib/multigem2/commands/run.rb                |
+      |tmp/multigem2/lib/multigem2/commands/crawl_to_bed.rb       |
+      |tmp/multigem2/lib/multigem2/commands/tap_dance.rb          |
+      |tmp/multigem2/lib/multigem2/commands/go_crazy.rb           |
+      |tmp/multigem2/features/multigem2.feature                   |
+      |tmp/multigem2/features/support/env.rb                      |
+      |tmp/multigem2/features/step_definitions/multigem2_steps.rb |
+      |tmp/multigem2/test/tc_something.rb                         |
+    And the file "tmp/multigem2/bin/multigem2" should match /command "walk" => Multigem2::Commands::Walk/
+    And the file "tmp/multigem2/bin/multigem2" should match /command "run" => Multigem2::Commands::Run/
+    And the file "tmp/multigem2/bin/multigem2" should match /command "crawl_to_bed" => Multigem2::Commands::CrawlToBed/
+    And the file "tmp/multigem2/bin/multigem2" should match /command "tap-dance" => Multigem2::Commands::TapDance/
+    And the file "tmp/multigem2/bin/multigem2" should match /command "@go-crazy" => Multigem2::Commands::GoCrazy/
+    Given I cd to "tmp/multigem2"
+    And my app's name is "multigem2"
+    When I successfully run `bin/multigem2 --help`
+    Then the banner should be present
+    And the banner should document that this app takes options
+    And the banner should document that this app takes commands
+    And the following commands should be documented:
+      |walk         |
+      |run          |
+      |crawl_to_bed |
+      |tap-dance    |
+      |@go-crazy    |
+    And the following options should be documented:
+      |--version|
+      |--help|
+      |--log-level|
+    When I successfully run `bin/multigem2 tap-dance -h`
+    Then the banner should be present
+    And the banner should document that this app takes global options
+    And the banner should document that this app takes options
+

data/features/readme.feature

@@ -0,0 +1,26 @@
+Feature: a README should be generated
+  As a user
+  I want a template README
+  So I don't need to recall the formatting or other info to get started
+
+  Background:
+    Given the directory "tmp/newgem" does not exist
+
+  Scenario: I don't want a README
+    When I successfully run `methadone --no-readme tmp/newgem`
+    Then a README should not be generated
+    And the file "tmp/newgem/Rakefile" should not match /rd.main = "README.rdoc"/
+
+  Scenario Outline: Generate README
+    When I successfully run `methadone <flag> tmp/newgem`
+    Then a README should be generated in RDoc
+    And the README should contain the project name
+    And the README should contain my name
+    And the README should contain links to Github and RDoc.info
+    And the README should contain empty sections for common elements of a README
+    And the file "tmp/newgem/Rakefile" should match /rd.main = "README.rdoc"/
+
+    Examples:
+      |flag|
+      | |
+      |--readme|

data/features/rspec_support.feature

@@ -0,0 +1,27 @@
+Feature: Bootstrap a new command-line app using RSpec instead of Test::Unit
+  As an awesome developer who wants to make a command-line app
+  I should be able to use methadone to bootstrap it
+  And get support for RSpec instead of Test::Unit
+
+  Background:
+    Given the directory "tmp/newgem" does not exist
+
+  Scenario: Bootstrap a new app from scratch
+    When I successfully run `methadone --rspec tmp/newgem`
+    Then the following directories should exist:
+      |tmp/newgem/spec                      |
+    And the following directories should not exist:
+      |tmp/newgem/test                      |
+    And the following files should exist:
+      |tmp/newgem/spec/something_spec.rb                 |
+    And the file "tmp/newgem/newgem.gemspec" should match /add_development_dependency\('rspec'/
+    When I cd to "tmp/newgem"
+    And I successfully run `rake -T -I../../lib`
+    Then the output should match /rake spec/
+    And the output should not match /rake test/
+    When I run `rake spec -I../../lib`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    1 example, 0 failures
+    """

data/features/step_definitions/bootstrap_steps.rb

@@ -0,0 +1,47 @@
+require 'fileutils'
+include FileUtils
+
+Given /^the directory "([^"]*)" does not exist$/ do |dir|
+  dir = File.join(ARUBA_DIR,dir)
+  rm_rf dir,:verbose => false, :secure => true
+end
+
+Given /^my app's name is "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+end
+
+Then /^the file "([^"]*)" should use the same block variable throughout$/ do |file|
+  prep_for_fs_check do
+    content = IO.read(file)
+    from_bundler = content.match(/(\w+)\.authors/)[1]
+    added_by_methadone = content.match(/(\w+).add_development_dependency\('rdoc'/)[1]
+    from_bundler.should == added_by_methadone
+  end
+end
+
+Then /^the stderr should match \/([^\/]*)\/$/ do |expected|
+  assert_matching_output(expected, all_stderr)
+end
+
+Given /^"(.*?)" has configured version to show only the version (.*)and not help$/ do |gemname,extras|
+  lines = File.read("tmp/aruba/tmp/new-gem/#{gemname}").split(/\n/)
+  File.open("tmp/aruba/tmp/new-gem/#{gemname}","w") do |file|
+    lines.each do |line|
+      if line =~ /^\s*version New::Gem::VERSION/
+        if extras =~ /with a custom format/
+          file.puts line + ", :compact => true, :format => '%s V%s'"
+        else
+          file.puts line + ", :compact => true"
+        end
+      else
+        file.puts line
+      end
+    end
+  end
+end
+
+Then /^the file "(.*?)" should include "(.*?)" if needed$/ do |file, gemname|
+  if RUBY_VERSION =~ /^2\./ && RUBY_VERSION !~ /^2.0/ && RUBY_VERSION !~ /^2.1/
+    step %{the file "#{file}" should match /add_development_dependency\\('#{gemname}/}
+  end
+end

data/features/step_definitions/license_steps.rb

@@ -0,0 +1,30 @@
+Then /^the README should not reference a license$/ do
+  step %(the file "tmp/newgem/README.rdoc" should not match /[Ll]icense/)
+end
+
+Then /^newgem's license should be the (\w+) license/ do |license|
+  @license = license
+  step %(a file named "tmp/newgem/LICENSE.txt" should exist)
+  step %(the file "tmp/newgem/newgem.gemspec" should match /#{@license}/)
+end
+
+Then /^the README should reference this license$/ do
+  step %(the file "tmp/newgem/README.rdoc" should match /License::/)
+  step %(the file "tmp/newgem/README.rdoc" should match /#{@license}/)
+end
+
+
+Then /^newgem's license should be an empty file$/ do
+  step %(a file named "tmp/newgem/LICENSE.txt" should exist)
+  File.read("tmp/aruba/tmp/newgem/LICENSE.txt").should == "\n"
+end
+
+Then /^the README should reference the need for a license$/ do
+  step %(the file "tmp/newgem/README.rdoc" should match /License:: INSERT LICENSE HERE/)
+end
+
+Then(/^LICENSE\.txt should contain user information and program name$/) do
+  step %(the file "tmp/newgem/LICENSE.txt" should match /#{`git config user.name`}/)
+  step %(the file "tmp/newgem/LICENSE.txt" should match /newgem/)
+  step %(the file "tmp/newgem/LICENSE.txt" should match /#{Time.now.year}/)
+end

data/features/step_definitions/readme_steps.rb

@@ -0,0 +1,26 @@
+Then /^a README should not be generated$/ do
+  step %(the file "tmp/newgem/README.rdoc" should not exist)
+end
+
+Then /^a README should be generated in RDoc$/ do
+  step %(a file named "tmp/newgem/README.rdoc" should exist)
+end
+
+Then /^the README should contain the project name$/ do
+  step %(the file "tmp/newgem/README.rdoc" should match /newgem/)
+end
+
+Then /^the README should contain my name$/ do
+  step %(the file "tmp/newgem/README.rdoc" should match /Author::  YOUR NAME \\\(YOUR EMAIL\\\)/)
+end
+
+Then /^the README should contain links to Github and RDoc.info$/ do
+  step %(the file "tmp/newgem/README.rdoc" should match /\\\* \\\{Source on Github\\\}\\\[LINK TO GITHUB\\\]/)
+  step %(the file "tmp/newgem/README.rdoc" should match /RDoc\\\[LINK TO RDOC.INFO\\\]/)
+end
+
+Then /^the README should contain empty sections for common elements of a README$/ do
+  step %(the file "tmp/newgem/README.rdoc" should match /^== Install/)
+  step %(the file "tmp/newgem/README.rdoc" should match /^== Examples/)
+  step %(the file "tmp/newgem/README.rdoc" should match /^== Contributing/)
+end

data/features/step_definitions/version_steps.rb

@@ -0,0 +1,4 @@
+When /^I successfully run `([^`]*)` with "([^"]*)" in the library path$/ do |command,dir|
+  ENV["RUBYOPT"] = (ENV["RUBYOPT"] || '') + " -I" + File.join(Dir.pwd,ARUBA_DIR,'tmp',@app_name,dir)
+  step %(I successfully run `#{command}`)
+end

data/features/support/env.rb

@@ -0,0 +1,26 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+PROJECT_ROOT = File.join(File.dirname(__FILE__),'..','..')
+ENV['PATH'] = "#{File.join(PROJECT_ROOT,'bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+ARUBA_DIR = File.join(%w(tmp aruba))
+Before do
+  @dirs = [ARUBA_DIR]
+  @puts = true
+  @aruba_timeout_seconds = 60
+  @original_rubylib = ENV['RUBYLIB']
+  @original_rubyopt = ENV['RUBYOPT']
+
+  # We want to use, hopefully, the methadone from this codebase and not
+  # the gem, so we put it in the RUBYLIB
+  ENV['RUBYLIB'] = File.join(PROJECT_ROOT,'lib') + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+
+  # We need -rubygems here so that 1.8-style rubies work AND travis-ci doesn't barf with it in the shebang line
+  ENV['RUBYOPT'] = (ENV['RUBYOPT'] || '') + ' -rubygems'
+end
+
+After do
+  # Put back how it was
+  ENV['RUBYLIB'] = @original_rubylib
+  ENV['RUBYOPT'] = @original_rubyopt
+end

data/features/version.feature

@@ -0,0 +1,17 @@
+Feature: The version should show up in the banner by default
+  As a developer
+  I should be able to have the current gem version in the banner
+  So I don't have to maintain it in two places 
+  And so users can easily see the version from the app itself
+
+  Scenario Outline: Show the gem version
+    Given my app's name is "newgem"
+    And I successfully run `methadone tmp/newgem`
+    When I cd to "tmp/newgem"
+    And I successfully run `bin/newgem <flag>` with "lib" in the library path
+    Then the banner should include the version
+
+    Examples:
+      |flag      |
+      |--help    |
+      |--version |

data/lib/methadone.rb

@@ -0,0 +1,15 @@
+require 'methadone/version'
+require 'methadone/cli_logger'
+require 'methadone/cli_logging'
+require 'methadone/exit_now'
+require 'methadone/argv_parser'
+require 'methadone/main'
+require 'methadone/error'
+require 'methadone/execution_strategy/base'
+require 'methadone/execution_strategy/mri'
+require 'methadone/execution_strategy/open_3'
+require 'methadone/execution_strategy/open_4'
+require 'methadone/execution_strategy/rbx_open_4'
+require 'methadone/execution_strategy/jvm'
+require 'methadone/sh'
+# Note: DO NOT require cli.rb OR cucumber.rb here

data/lib/methadone/argv_parser.rb

@@ -0,0 +1,50 @@
+module Methadone #:nodoc:
+  # Assists with parsing strings in the same way that ARGV might.
+  # This is *not* used to parse the command-line, but used to 
+  # parse config files/environment variables so they can be placed into ARGV and properly interpretted by 
+  # OptionParser
+  module ARGVParser #:nodoc:
+
+  private
+
+    # Parses +string+, returning an array that can be placed into ARGV or given to OptionParser
+    def parse_string_for_argv(string) #:nodoc:
+      return [] if string.nil?
+
+      args = []               # return value we are building up
+      current = 0             # pointer to where we are in +string+
+      next_arg = ''           # the next arg we are building up to ultimatley put into args
+      inside_quote = nil      # quote character we are "inside" of
+      last_char = nil         # the last character we saw
+
+      while current < string.length
+        char = string.chars.to_a[current]
+        case char
+        when /["']/
+          if inside_quote.nil?         # eat the quote, but remember we are now "inside" one
+            inside_quote = char
+          elsif inside_quote == char   # we closed the quote we were "inside"
+            inside_quote = nil
+          else                         # we got a different quote, so it goes in literally
+            next_arg << char
+          end
+        when /\s/
+          if last_char == "\\"         # we have an escaped space, replace the escape char
+            next_arg[-1] = char
+          elsif inside_quote           # we are inside a quote so keep the space
+            next_arg << char
+          else                         # new argument
+            args << next_arg
+            next_arg = ''
+          end
+        else
+          next_arg << char
+        end
+        current += 1
+        last_char = char
+      end
+      args << next_arg unless next_arg == ''
+      args
+    end
+  end
+end

data/lib/methadone/cli.rb

@@ -0,0 +1,124 @@
+require 'erb'
+
+module Methadone
+  # <b>Methadone Internal - treat as private</b>
+  #
+  # Stuff to implement methadone's CLI app.  These
+  # stuff isn't generally for your use and it's not
+  # included when you require 'methadone'
+  module CLI
+
+    # Checks that the basedir can be used, either by
+    # not existing, or by existing and force is true.
+    # In that case, we clean it out entirely
+    #
+    # +basedir+:: base directory where the user wants to create a new project
+    # +force+:: if true, and +basedir+ exists, delete it before proceeding
+    #
+    # This will exit the app if the dir exists and force is false
+    def check_and_prepare_basedir!(basedir,force)
+      if File.exists? basedir
+        if force
+          rm_rf basedir, :verbose => true, :secure => true
+        else
+          exit_now! 1,"error: #{basedir} exists, use --force to override"
+        end
+      end
+      mkdir_p basedir
+    end
+
+    # Add content to a file
+    #
+    # +file+:: path to the file
+    # +lines+:: Array of String representing the lines to add
+    # +options+:: Hash of options:
+    #             <tt>:before</tt>:: A regexp that will appear right after the new content. i.e.
+    #                                this is where to insert said content.
+    def add_to_file(file,lines,options = {})
+      new_lines = []
+      found_line = false
+      File.open(file).readlines.each do |line|
+        line.chomp!
+        if options[:before] && options[:before] === line
+          found_line = true
+          new_lines += lines
+        end
+        new_lines << line
+      end
+
+      raise "No line matched #{options[:before]}" if options[:before] && !found_line
+
+      new_lines += lines unless options[:before]
+      File.open(file,'w') do |fp|
+        new_lines.each { |line| fp.puts line }
+      end
+    end
+
+    # Copies a file, running it through ERB
+    #
+    # +relative_path+:: path to the file, relative to the project root, minus the .erb extension
+    #                   You should use forward slashes to separate paths; this method
+    #                   will handle making the ultimate path OS independent.
+    # +options+:: Options to affect how the copy is done:
+    #             <tt>:from</tt>:: The name of the profile from which to find the file, "full" by default
+    #             <tt>:as</tt>:: The name the file should get if not the one in relative_path
+    #             <tt>:executable</tt>:: true if this file should be set executable
+    #             <tt>:binding</tt>:: the binding to use for the template
+    def copy_file(relative_path,options = {})
+
+      relative_path = File.join(relative_path.split(/\//))
+
+      template_path = File.join(template_dir(options[:from] || :full),relative_path + ".erb")
+      template = ERB.new(File.open(template_path).readlines.join(''), nil ,'-')
+
+      relative_path_parts = File.split(relative_path)
+      relative_path_parts[-1] = options[:as] if options[:as]
+
+      File.open(File.join(relative_path_parts),'w') do |file|
+        file.puts template.result(options[:binding] || binding)
+        file.chmod(0755) if options[:executable]
+      end
+    end
+
+    # Get the location of the templates for profile "from"
+    def template_dir(from)
+      File.join(File.dirname(__FILE__),'..','..','templates',from.to_s)
+    end
+
+    def template_dirs_in(profile)
+      template_dir = template_dir(profile)
+
+      Dir["#{template_dir}/**/*"].select { |x| 
+        File.directory? x 
+      }.map { |dir| 
+        dir.gsub(/^#{template_dir}\//,'')
+      }
+    end
+
+    # converts string to constant form:
+    #   methadone-module_name-class_name => Methadone::ModuleName::ClassName
+    def titlify(name)
+      name.gsub(/(^|-|_)(.)/) {"#{'::' if $1 == '-'}#{$2.upcase}"}
+    end
+
+    def normalize_command(cmd)
+      #Note: not i18n-safe
+      cmd.tr('A-Z','a-z').gsub(/[^a-z0-9_]/,'_').sub(/^_*/,'')
+    end
+
+    def render_license_partial(partial)
+      ERB.new(File.read(template_dir('full/'+partial))).result(binding).strip 
+    end
+
+    def gemspec
+      @gemspec || @gemspec=_get_gemspec
+    end
+    private
+    def _get_gemspec
+      files=Dir.glob("*.gemspec")
+      raise "Multiple gemspec files" if files.size>1
+      raise "No gemspec file" if files.size < 1
+      Gem::Specification::load(files.first)
+    end
+  end
+end