methadone 1.2.2 → 1.2.3

data/.gitignore

@@ -9,3 +9,7 @@ results.html
 coverage
 *.rbc
 .DS_Store
+T_KICK_THE_BASH_HABIT_WITH_RUBY_AND_METHADONE.itmsp
+bin/cukedoc
+methadone.wiki
+tut

data/.travis.yml

@@ -8,4 +8,6 @@ rvm:
   - 1.8.7
   - ree
   - rbx
-  - jruby
+  - jruby-18mode
+  - jruby-19mode
+  - 2.0.0

data/CHANGES.md

@@ -1,17 +1,24 @@
 # Changelog
 
-## v1.2.3 - Oct 21, 2012
+## v.1.2.3 - Dec 8, 2012
 
-* Generated Rakefile has better formatted code (See [57])
-* Error output preface now says "stderr is" instead of "error output", which is less confusing (See [53])
+* Can create an app with a dash in its name (See [55])
+* Help switches, `-h`, and `--help` are documented in help output (See [51])
+* Improve cucumber step requiring docs and fix bug where said docs had to start with a three-letter words (See [37])
 
-  [57]: http://github.com/davetron5000/methadone/issues/57
-  [53]: http://github.com/davetron5000/methadone/issues/53
+[37]: http://github.com/davetron5000/methadone/issues/37
+[51]: http://github.com/davetron5000/methadone/issues/51
+[55]: http://github.com/davetron5000/methadone/issues/55
 
-## v1.2.2 - Oct 2, 2012
+## v1.2.2 - Oct 21, 2012
 
+* Generated Rakefile has better formatted code (See [57])
+* Error output preface now says "stderr is" instead of "error output", which is less confusing (See [53])
 * Less scary stdout/stderr prefixing from SH, courtesy @yoni
 
+[57]: http://github.com/davetron5000/methadone/issues/57
+[53]: http://github.com/davetron5000/methadone/issues/53
+
 ## v1.2.1 - Jun 10, 2012, 3:41 PM
 
 * Slightly loosen what passes for a one-line description of the app, courtesy @jredville

data/bin/methadone

@@ -16,7 +16,7 @@ main do |app_name|
   using_readme = options[:readme]
 
   gemname = File.basename(app_name)
-  module_name = gemname.split(/_/).map(&:capitalize).join('')
+  module_name = gemname.split(/_/).map(&:capitalize).join('').split(/-/).map(&:capitalize).join("::")
 
   debug "Creating project for gem #{gemname}"
 
@@ -37,7 +37,6 @@ main do |app_name|
   if rspec
     template_dirs_in(:rspec).each  { |dir| mkdir_p dir }
     copy_file "spec/tc_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

data/features/bootstrap.feature

@@ -5,6 +5,7 @@ Feature: Bootstrap a new command-line app
 
   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`
@@ -45,6 +46,7 @@ Feature: Bootstrap a new command-line app
     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`
@@ -70,6 +72,26 @@ Feature: Bootstrap a new command-line app
     6 steps (6 passed)
     """
 
+  Scenario: 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)
+    """
+
   Scenario: Won't squash an existing dir
     When I successfully run `methadone tmp/newgem`
     And I run `methadone tmp/newgem`
@@ -93,7 +115,10 @@ Feature: Bootstrap a new command-line app
     When I get help for "methadone"
     Then the exit status should be 0
     And the following options should be documented:
-      |--force|
+      | --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:

data/features/step_definitions/version_steps.rb

@@ -1,4 +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','newgem',dir)
+  ENV["RUBYOPT"] = (ENV["RUBYOPT"] || '') + " -I" + File.join(Dir.pwd,ARUBA_DIR,'tmp',@app_name,dir)
   step %(I successfully run `#{command}`)
 end

data/features/version.feature

@@ -5,7 +5,8 @@ Feature: The version should show up in the banner by default
   And so users can easily see the version from the app itself
 
   Scenario Outline: Show the gem version
-    Given I successfully run `methadone tmp/newgem`
+    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

data/lib/methadone/cucumber.rb

@@ -6,15 +6,21 @@ module Methadone
   #
   #     When I get help for "command_to_run"
   #
-  # * Make sure that each option shows up in the help and has *some* sort of documentation
+  # * Make sure that each option shows up in the help and has *some* sort of documentation.  By default,
+  #   the options won't be re2quired to be negatable.
   #
   #     Then the following options should be documented:
   #       |--force|
   #       |-x     |
   #
+  #     Then the following options should be documented:
+  #       |--force| which is negatable     |
+  #       |-x     | which is not negatable |
+  #
   # * Check an individual option for documentation:
   #
   #     Then the option "--force" should be documented
+  #     Then the option "--force" should be documented which is negatable
   #
   # * Checks that the help has a proper usage banner
   #
@@ -56,12 +62,17 @@ end
 
 Then /^the following options should be documented:$/ do |options|
   options.raw.each do |option|
-    step %(the option "#{option[0]}" should be documented)
+    step %(the option "#{option[0]}" should be documented #{option[1]})
   end
 end
 
-Then /^the option "([^"]*)" should be documented$/ do |option|
-  step %(the output should match /\\s*#{Regexp.escape(option)}[\\s\\W]+\\w\\w\\w+/)
+Then /^the option "([^"]*)" should be documented(.*)$/ do |options,qualifiers|
+  options.split(',').map(&:strip).each do |option|
+    if qualifiers.strip == "which is negatable"
+      option = option.gsub(/^--/,"--[no-]")
+    end
+    step %(the output should match /\\s*#{Regexp.escape(option)}[\\s\\W]+\\w[\\s\\w][\\s\\w]+/)
+  end
 end
 
 Then /^the banner should be present$/ do

data/lib/methadone/main.rb

@@ -404,6 +404,7 @@ module Methadone
       @description = nil
       @version = nil
       set_banner
+      document_help
     end
 
     def check_args!
@@ -497,6 +498,13 @@ module Methadone
 
     private
 
+    def document_help
+      @option_parser.on("-h","--help","Show command line help") do 
+        puts @option_parser.to_s
+        exit 0
+      end
+    end
+
     def add_default_value_to_docstring(*args)
       default_value = nil
       option_names_from(args).each do |option|

data/lib/methadone/version.rb

@@ -1,3 +1,3 @@
 module Methadone #:nodoc:
-  VERSION = "1.2.2" #:nodoc:
+  VERSION = "1.2.3" #:nodoc:
 end

data/methadone.gemspec

@@ -11,17 +11,6 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/davetron5000/methadone"
   s.summary     = %q{Kick the bash habit and start your command-line apps off right}
   s.description = %q{Methadone provides a lot of small but useful features for developing a command-line app, including an opinionated bootstrapping process, some helpful cucumber steps, and some classes to bridge logging and output into a simple, unified, interface}
-  s.post_install_message = "
-
-!!!!!!!!!!!!!!!!!!!!!!
-
-If you are on Ruby 1.8 or REE, you MUST
-
-gem install open4
-
-!!!!!!!!!!!!!!!!!!!!!!
-  "
-
   s.rubyforge_project = "methadone"
 
   s.files         = `git ls-files`.split("\n")

data/test/test_main.rb

@@ -359,7 +359,7 @@ class TestMain < BaseTest
     }
   end
 
-  test_that "without specifying options, [options] doesn't show up in our banner" do
+  test_that "without specifying options, options in brackets doesn't show up in our banner" do
     Given {
       main {}
     }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: methadone
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-21 00:00:00.000000000 Z
+date: 2012-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -314,8 +314,7 @@ files:
   dGVzdC90ZXN0X3NoLnJi
 homepage: http://github.com/davetron5000/methadone
 licenses: []
-post_install_message: ! "\n\n!!!!!!!!!!!!!!!!!!!!!!\n\nIf you are on Ruby 1.8 or REE,
-  you MUST\n\ngem install open4\n\n!!!!!!!!!!!!!!!!!!!!!!\n  "
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib