methadone-rehab 1.9.2

data/Rakefile

@@ -0,0 +1,98 @@
+require 'sdoc'
+require 'bundler'
+require 'rake/clean'
+require 'rake/testtask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+desc 'run tests'
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.ruby_opts << "-rrubygems"
+  t.test_files = FileList['test/test_*.rb'] + FileList['test/execution_strategy/test_*.rb']
+end
+
+desc 'build rdoc'
+task :rdoc => [:build_rdoc, :hack_css]
+RDoc::Task.new(:build_rdoc) do |rd|
+  rd.main = "README.rdoc"
+  rd.options << '-f' << 'sdoc'
+  rd.template = 'direct'
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Methadone - Power Up your Command Line Apps'
+end
+CLOBBER << 'html'
+
+FONT_FIX = {
+  "0.82em" => "16px",
+  "0.833em" => "16px",
+  "0.85em" => "16px",
+  "1.15em" => "20px",
+  "1.1em" => "20px",
+  "1.2em" => "20px",
+  "1.4em" => "24px",
+  "1.5em" => "24px",
+  "1.6em" => "32px",
+  "1em" => "16px",
+  "2.1em" => "38px",
+}
+
+
+task :hack_css do
+  maincss = File.open('html/css/main.css').readlines
+  File.open('html/css/main.css','w') do |file|
+    file.puts '@import url(https://fonts.googleapis.com/css?family=Lato:300italic,700italic,300,700);'
+    maincss.each do |line|
+      if line.strip == 'font-family: "Helvetica Neue", Arial, sans-serif;'
+        file.puts 'font-family: Lato, "Helvetica Neue", Arial, sans-serif;'
+      elsif line.strip == 'font-family: monospace;'
+        file.puts 'font-family: Monaco, monospace;'
+      elsif line =~ /^pre\s*$/
+        file.puts "pre {
+          font-family: Monaco, monospace;
+          margin-bottom: 1em;
+        }
+        pre.original"
+      elsif line =~ /^\s*font-size:\s*(.*)\s*;/
+        if FONT_FIX[$1]
+          file.puts "font-size: #{FONT_FIX[$1]};"
+        else
+          file.puts line.chomp
+        end
+      else
+        file.puts line.chomp
+      end
+    end
+  end
+end
+if RUBY_PLATFORM == 'java'
+task :features do
+  puts "Aruba doesn't work on JRuby; cannot run features"
+end
+task 'features:wip' => :features
+else
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+end
+
+CLEAN << "coverage"
+CLOBBER << FileList['**/*.rbc']
+task :default => [:test, :features]

data/TODO.md

@@ -0,0 +1,3 @@
+TODO:
+
+Optional:  non-public methods are prefixed with __methadone_ to prevent namespace contamination

data/bin/methadone

@@ -0,0 +1,157 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'optparse'
+require 'methadone'
+require 'methadone/cli'
+
+include FileUtils
+include Methadone::Main
+include Methadone::CLILogging
+include Methadone::CLI
+include Methadone::SH
+
+main do |app_name|
+  check_and_prepare_basedir!(app_name,options[:force])
+  using_readme = options[:readme]
+
+  gemname = File.basename(app_name)
+  module_name = gemname.split(/-/).map(&:capitalize).collect{ |segment| segment.split(/_/).map(&:capitalize).join('') }.join('::')
+
+  debug "Creating project for gem #{gemname}"
+
+  chdir File.dirname(app_name)
+
+  # Create the basic files for a gem via bundler:
+  #   Gemfile
+  #   Rakefile
+  #   LICENSE.txt
+  #   README.md
+  #   .gitignore
+  #   <gemname>.gemspec
+  #   lib/<gemname>.rb
+  #   lib/<gemname>/version.rb
+  require_file = nil
+  sh! "bundle gem #{gemname} --no-color" do |stdout|
+    require_file = stdout.split(/\n/).select { |file|
+      file =~ /\.rb$/ && file !~ /version.rb$/
+    }.first
+  end
+  require_file = gemname if require_file.nil?
+  require_file.gsub!(/^.*lib\//,'')
+
+  add_library_to_load_path = options[:add_lib] || false
+
+  chdir gemname
+
+  template_dirs_in(:full).each  { |dir| mkdir_p dir }
+
+  commands = options[:commands]
+  multi = !commands.nil?
+  if multi
+    mkdir_p "lib/#{gemname}/commands"
+    copy_file 'lib/commands.rb', :as => "#{gemname}/commands.rb", :from => :multicommand, :binding => binding
+    commands.each do |cmd|
+      copy_file 'lib/command.rb', :as => "#{gemname}/commands/#{normalize_command(cmd)}.rb",  :from => :multicommand, :binding => binding
+    end
+  end
+
+  rspec = options[:rspec]
+
+  ["Rakefile", ".gitignore", "features/support/env.rb"].each do |file|
+    copy_file file, :binding => binding
+  end
+
+  if rspec
+    template_dirs_in(:rspec).each  { |dir| mkdir_p dir }
+    copy_file "spec/something_spec.rb", :from => :rspec, :binding => binding
+  else
+    template_dirs_in(:test_unit).each  { |dir| mkdir_p dir }
+    copy_file "test/tc_something.rb", :from => :test_unit, :binding => binding
+  end
+
+  gemspec = "#{gemname}.gemspec"
+  gem_variable = File.open(gemspec) { |x| x.read }.match(/(\w+)\.executables/)[1]
+
+  license = options[:license]
+  warn "warning: your app has no license" unless license
+  license = nil if license == 'NONE'
+  if license
+    copy_file "#{options[:license]}_LICENSE.txt", :as => "LICENSE.txt" 
+  else
+    #Remove the MIT license generated by `bundle gem`
+    debug "Making sure no LICENSE.txt file exists at the root of the repo"
+    FileUtils.rm_f "LICENSE.txt"
+  end
+
+  #Ensure the gemspec file mentions the correct license
+  gemspec_content = File.read(gemspec)
+  if gemspec_content =~ /(^\s*#{gem_variable}\.license\s*=\s*).*/
+    gemspec_content.gsub!(/(^\s*#{gem_variable}\.license\s*=\s*).*/,"\\1#{license.to_s.inspect}")
+  else
+    gemspec_content.gsub!(/(^\s*#{gem_variable}\.name\s*=\s*.*)/,"\\1\n  #{gem_variable}.license=#{license.to_s.inspect}")
+  end
+  File.open(gemspec,'w') {|f| f.write gemspec_content }
+
+
+  # TODO: bundle gem creates README.md regardless of using_readme setting.
+  copy_file "README.rdoc", :binding => binding if using_readme
+
+  copy_file "features/executable.feature", :as => "#{gemname}.feature", :binding => binding
+  copy_file "features/step_definitions/executable_steps.rb", :as => "#{gemname}_steps.rb"
+  copy_file "bin/executable", :as => gemname, :executable => true, :binding => binding, :from => (multi ? :multicommand : :full)
+
+  add_to_file gemspec, [
+    "  #{gem_variable}.add_development_dependency('rdoc')",
+    "  #{gem_variable}.add_development_dependency('aruba')",
+    "  #{gem_variable}.add_development_dependency('rake')",
+    "  #{gem_variable}.add_dependency('methadone-rehab', '~> #{Methadone::VERSION}')",
+  ], :before => /^end\s*$/
+  ruby_major,ruby_minor,ruby_patch = RUBY_VERSION.split(/\./).map(&:to_i)
+
+  if ruby_major >= 2 && ruby_minor >= 2
+    add_to_file gemspec, [
+      "  #{gem_variable}.add_development_dependency('test-unit')",
+    ], :before => /^end\s*$/
+  end
+
+  if rspec
+    add_to_file gemspec, [
+    "  #{gem_variable}.add_development_dependency('rspec', '~> 3')",
+    ], :before => /^end\s*$/
+  end
+
+  sh! %q(git add --all .)
+end
+
+options[:readme] = true
+
+description "Kick the bash habit by bootstrapping your Ruby command-line apps"
+
+on("--force","Overwrite files if they exist")
+on("--[no-]readme","[Do not ]produce a README file")
+on("--rspec", "Generate RSpec unit tests instead of Test::Unit")
+on("--add-lib", "Add lib to the load path") do
+  options[:add_lib] = true
+end
+on "-c cmd1,cmd2,cmdN", "--commands", Array, "Generate framework for a cli app that provides the following commands" do |commands|
+  options[:commands] = commands
+  unless options[:commands].grep(/^-/).empty?
+    puts "Cannot have commands that begin with a '-'"
+    exit 65 # Data format error
+  end
+end
+
+licenses = %w(mit apache gplv2 gplv3 custom NONE)
+on("-l LICENSE","--license",licenses,"Specify the license for your project",'(' + licenses.join('|') + ')')
+
+use_log_level_option
+
+leak_exceptions true
+
+arg :app_name, :required, "Name of your app, which is used for the gem name and executable name"
+
+version Methadone::VERSION, :compact => true
+
+go!
+

data/features/bootstrap.feature

@@ -0,0 +1,169 @@
+Feature: Bootstrap a new command-line app
+  As an awesome developer who wants to make a command-line app
+  I should be able to use methadone to bootstrap it
+  And get all kinds of cool things
+
+  Background:
+    Given the directory "tmp/newgem" does not exist
+    And the directory "tmp/new-gem" does not exist
+
+  Scenario: Bootstrap a new app from scratch
+    When I successfully run `methadone tmp/newgem`
+    Then the following directories should exist:
+      |tmp/newgem                           |
+      |tmp/newgem/bin                       |
+      |tmp/newgem/lib                       |
+      |tmp/newgem/lib/newgem                |
+      |tmp/newgem/test                      |
+      |tmp/newgem/features                  |
+      |tmp/newgem/features/support          |
+      |tmp/newgem/features/step_definitions |
+    Then the following directories should not exist:
+      |tmp/newgem/spec |
+    And the following files should exist:
+      |tmp/newgem/newgem.gemspec                            |
+      |tmp/newgem/Rakefile                                  |
+      |tmp/newgem/.gitignore                                |
+      |tmp/newgem/Gemfile                                   |
+      |tmp/newgem/bin/newgem                                |
+      |tmp/newgem/features/newgem.feature                   |
+      |tmp/newgem/features/support/env.rb                   |
+      |tmp/newgem/features/step_definitions/newgem_steps.rb |
+      |tmp/newgem/test/tc_something.rb                      |
+    And the file "tmp/newgem/.gitignore" should match /results.html/
+    And the file "tmp/newgem/.gitignore" should match /html/
+    And the file "tmp/newgem/.gitignore" should match /pkg/
+    And the file "tmp/newgem/.gitignore" should match /.DS_Store/
+    And the file "tmp/newgem/newgem.gemspec" should match /add_development_dependency\('aruba'/
+    And the file "tmp/newgem/newgem.gemspec" should match /add_development_dependency\('rdoc'/
+    And the file "tmp/newgem/newgem.gemspec" should match /add_development_dependency\('rake'/
+    And the file "tmp/newgem/newgem.gemspec" should match /add_dependency\('methadone-rehab'/
+    And the file "tmp/newgem/newgem.gemspec" should include "test-unit" if needed
+    And the file "tmp/newgem/newgem.gemspec" should use the same block variable throughout
+    Given I cd to "tmp/newgem"
+    And my app's name is "newgem"
+    When I successfully run `bin/newgem --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 following options should be documented:
+      |--version|
+      |--help|
+      |--log-level|
+    And the banner should document that this app takes no arguments
+    When I successfully run `rake -T -I../../lib`
+    Then the output should match /rake clean/
+    And the output should match /rake clobber/
+    And the output should match /rake clobber_rdoc/
+    And the output should match /rake features/
+    And the output should match /rake rdoc/
+    And the output should match /rake release/
+    And the output should match /rake rerdoc/
+    And the output should match /rake test/
+    And the output should match /rake install/
+    And the output should match /rake build/
+    When I run `rake -I../../../../lib`
+    Then the exit status should be 0
+    And the output should match /1 tests, 1 assertions, 0 failures, 0 errors/
+    And the output should contain:
+    """
+    1 scenario (1 passed)
+    6 steps (6 passed)
+    """
+
+  Scenario Outline: Bootstrap a new app with a dash is OK
+    Given I successfully run `methadone tmp/new-gem`
+    And I cd to "tmp/new-gem"
+    And my app's name is "new-gem"
+    When I successfully run `bin/new-gem <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 following options should be documented:
+      |--version|
+      |--log-level|
+    And the banner should document that this app takes no arguments
+    When I run `rake -I../../../../lib`
+    Then the exit status should be 0
+    And the output should match /1 tests, 1 assertions, 0 failures, 0 errors/
+    And the output should contain:
+    """
+    1 scenario (1 passed)
+    6 steps (6 passed)
+    """
+    Examples:
+      | help      |
+      | -h        |
+      | --help    |
+      | --version |
+
+  Scenario: Version flag can be used to only show the app version
+    Given I successfully run `methadone tmp/new-gem`
+    And "bin/new-gem" has configured version to show only the version and not help
+    And I cd to "tmp/new-gem"
+    And my app's name is "new-gem"
+    When I successfully run `bin/new-gem --version` with "lib" in the library path
+    Then the output should match /new-gem version 0/
+
+  Scenario: Version flag can be used to only show the app version with a custom format
+    Given I successfully run `methadone tmp/new-gem`
+    And "bin/new-gem" has configured version to show only the version with a custom format and not help
+    And I cd to "tmp/new-gem"
+    And my app's name is "new-gem"
+    When I successfully run `bin/new-gem --version` with "lib" in the library path
+    Then the output should match /new-gem V0/
+
+  Scenario: Won't squash an existing dir
+    When I successfully run `methadone tmp/newgem`
+    And I run `methadone tmp/newgem`
+    Then the exit status should not be 0
+    And the stderr should contain:
+    """
+    error: tmp/newgem exists, use --force to override
+    """
+
+  Scenario: WILL squash an existing dir if we use --force
+    When I successfully run `methadone tmp/newgem`
+    And I run `methadone --force tmp/newgem`
+    Then the exit status should be 0
+
+  Scenario: We must supply a dirname
+    When I run `methadone`
+    Then the exit status should not be 0
+    And the stderr should match /'app_name' is required/
+
+  Scenario: We can add the lib directory to the load path
+    Given the directory "tmp/newgem2" does not exist
+    When I run `methadone --add-lib tmp/newgem2`
+    Then the exit status should be 0
+    And the file "tmp/newgem2/bin/newgem2" should match /\$LOAD_PATH\.unshift File\.expand_path\(File\.join\(File\.dirname\(__FILE__\), '\.\..lib'\)\)/
+
+    Given I cd to "tmp/newgem2"
+    And my app's name is "newgem2"
+    When I successfully run `bin/newgem2 --help`
+    Then the banner should be present
+    And the banner should document that this app takes options
+    And the following options should be documented:
+      |--version|
+      |--help|
+      |--log-level|
+    And the banner should document that this app takes no arguments
+
+  Scenario: Help is properly documented
+    When I get help for "methadone"
+    Then the exit status should be 0
+    And the following options should be documented:
+      | --force       | |
+      | --readme      | which is negatable       |
+      | -l, --license | which is not negatable   |
+      | --log-level   | |
+    And the banner should be present
+    And the banner should document that this app takes options
+    And the banner should document that this app's arguments are:
+      |app_name|which is required|
+    And there should be a one line summary of what the app does
+
+  Scenario: The whole initial state of the app has been staged with git
+    Given I successfully run `methadone -l custom tmp/newgem`
+    And I cd to "tmp/newgem"
+    When I successfully run `git ls-files --others --deleted `
+    Then the output should match /\A\Z/
+

data/features/license.feature

@@ -0,0 +1,43 @@
+Feature: Users should get the license included
+  As a user
+  I'd like to be able to include a license
+  So that I don't have to hunt it down for every new project
+
+  Background:
+    Given the directory "tmp/newgem" does not exist
+
+  Scenario: Use a non-stock license
+    When I successfully run `methadone -l custom tmp/newgem`
+    Then newgem's license should be an empty file
+    And the README should reference the need for a license
+
+  Scenario: We only support a few licenses
+    When I run `methadone -l foobar tmp/newgem`
+    Then the exit status should not be 0
+    And the stderr should match /invalid argument: -l foobar/
+
+  Scenario: No license specified
+    When I successfully run `methadone tmp/newgem`
+    Then the stderr should contain "warning: your app has no license"
+    And the README should not reference a license
+    And the file "tmp/newgem/LICENSE.txt" should not exist
+
+  Scenario: No license specified explicitly
+    When I successfully run `methadone -l NONE tmp/newgem`
+    Then the stderr should not contain "warning: your app has no license"
+    And the README should not reference a license
+    And the file "tmp/newgem/LICENSE.txt" should not exist
+
+  Scenario Outline: Include one of a few stock licenses
+    When I successfully run `methadone -l <license> tmp/newgem`
+    Then newgem's license should be the <license> license
+    And the README should reference this license
+    And LICENSE.txt should contain user information and program name
+
+    Examples:
+      |license|
+      |apache|
+      |mit|
+      |gplv2|
+      |gplv3|
+