methadone 0.0.2 → 0.1.0

data/README.rdoc

@@ -99,7 +99,8 @@ Here's an example from methadone's own tests:
       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|required|
+        |app_name|which is required|
+        |dir_name|which is optional|
 
 === Steps Provided
 * Run <tt>command_to_run --help</tt> using aruba
@@ -124,10 +125,21 @@ Here's an example from methadone's own tests:
 
     Then the banner should document that this app takes options
 
+* Do the opposite; check that you don't indicate options are accepted
+
+    Then the banner should document that this app takes no options
+
 * Checks that the app's usage banner documents that its arguments are <tt>args</tt>
 
     Then the banner should document that this app's arguments are "args"
 
+* Do the opposite; check that your app doesn't take any arguments
+
+    Then the banner should document that this app takes no arguments
+
+* Check for a usage description which occurs after the banner and a blank line
+
+    Then there should be a one-line summary of what the app does
 
 == What might be
 

data/Rakefile

@@ -28,7 +28,9 @@ end
 CUKE_RESULTS = 'results.html'
 CLEAN << CUKE_RESULTS
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x"
+  tag_opts = ''
+  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
 

data/bin/methadone

@@ -36,6 +36,8 @@ def main(basedir,force)
   add_to_file "#{gemname}.gemspec", [
     "  s.add_development_dependency('rdoc')",
     "  s.add_development_dependency('aruba')",
+    "  s.add_development_dependency('rake','~> 0.9.2')",
+    "  s.add_dependency('methadone')",
   ], :before => /^end\s*$/
 
   return 0
@@ -115,7 +117,8 @@ end
 options = {}
 option_parser = OptionParser.new do |opts|
   executable = File.basename(__FILE__)
-  opts.banner = "Usage: #{executable} [options] app_name"
+  opts.banner = "Usage: #{executable} [options] app_name\n\n" +
+  "Kick the bash habit by bootstrapping your Ruby command-line apps\n\nOptions:"
 
   opts.on("--force","Overwrite files if they exist") do
     options[:force] = true

data/features/bootstrap.feature

@@ -26,11 +26,17 @@ Feature: Bootstrap a new command-line app
       |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/newgem.gemspec" should match /add_development_dependency\('grancher'/
     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','~> 0.9.2'/
+    And the file "tmp/newgem/newgem.gemspec" should match /add_dependency\('methadone'/
     Given I cd to "tmp/newgem"
-    When I successfully run `rake -T`
+    And my app's name is "newgem"
+    When I successfully run `bin/newgem --help`
+    Then the banner should be present
+    And the banner should document that this app takes no options
+    And the banner should document that this app takes no arguments
+    When I successfully run `rake -T -I../../lib`
     Then the output should contain:
     """
     rake build         # Build newgem-0.0.1.gem into the pkg directory
@@ -44,7 +50,7 @@ Feature: Bootstrap a new command-line app
     rake rerdoc        # Rebuild RDoc HTML files
     rake test          # Run tests
     """    
-    When I run `rake`
+    When I run `rake -I../../../../lib`
     Then the exit status should be 0
     And the output should contain:
     """
@@ -53,7 +59,7 @@ Feature: Bootstrap a new command-line app
     And the output should contain:
     """
     1 scenario (1 passed)
-    3 steps (3 passed)
+    5 steps (5 passed)
     """
 
   Scenario: Won't squash an existing dir
@@ -78,6 +84,7 @@ Feature: Bootstrap a new command-line app
     error: app_dir required
     """
 
+    @debug
   Scenario: Help is properly documented
     When I get help for "methadone"
     Then the exit status should be 0
@@ -86,4 +93,5 @@ Feature: Bootstrap a new command-line app
     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|required|
+      |app_name|which is required|
+    And there should be a one line summary of what the app does

data/features/step_definitions/bootstrap_steps.rb

@@ -5,3 +5,7 @@ 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

data/lib/methadone/cucumber.rb

@@ -19,12 +19,30 @@ end
 
 Then /^the banner should document that this app takes options$/ do
   Then %(the output should match /\[options\]/)
+  And %(the output should contain "Options")
 end
 
 Then /^the banner should document that this app's arguments are:$/ do |table|
   expected_arguments = table.raw.map { |row|
     option = row[0]
-    option = "[#{option}]" if row[1] == 'optional'
+    option = "[#{option}]" if row[1] == 'optional' || row[1] == 'which is optional'
   }.join(' ')
   Then %(the output should contain "#{expected_arguments}")
 end
+
+Then /^the banner should document that this app takes no options$/ do
+  Then %(the output should not contain "[options]")
+  And %(the output should not contain "Options")
+end
+
+Then /^the banner should document that this app takes no arguments$/ do
+  Then %(the output should match /Usage: #{@app_name}\\s*$/)
+end
+
+Then /^there should be a one line summary of what the app does$/ do
+  output_lines = all_output.split(/\n/)
+  output_lines.should have_at_least(3).items
+  # [0] is our banner, which we've checked for
+  output_lines[1].should match(/^\s*$/)
+  output_lines[2].should match(/^\w\w+\s+\w\w+/)
+end

data/lib/methadone/version.rb

@@ -1,3 +1,3 @@
 module Methadone
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/templates/full/bin/executable.erb

@@ -4,7 +4,11 @@ require 'optparse'
 
 option_parser = OptionParser.new do |opts|
   executable_name = File.basename(__FILE__)
-  opts.banner = "Usage: #{executable_name} [options]"
+  opts.banner = "Usage: #{executable_name}"
+  # When/if you add options:
+  # opts.banner = "Usage: #{executable_name} [options]\n\n" +
+  # "One-line description of your app\n\n" +
+  # "Options:"
 end
 
 option_parser.parse!

data/templates/full/features/executable.feature.erb

@@ -4,9 +4,8 @@ Feature: My bootstrapped app kinda works
   So I don't have to do it myself
 
   Scenario: App just runs
-    When I run `<%= gemname %> --help`
+    When I get help for "<%= gemname %>"
     Then the exit status should be 0
-    And the output should contain:
-    """
-    Usage: <%= gemname %> [options]
-    """
+    And the banner should be present
+    And the banner should document that this app takes no options
+    And the banner should document that this app takes no arguments

data/templates/full/features/support/env.rb.erb

@@ -1,4 +1,5 @@
 require 'aruba/cucumber'
+require 'methadone/cucumber'
 
 ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: methadone
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-12 00:00:00.000000000Z
+date: 2011-09-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
-  requirement: &70317239005260 !ruby/object:Gem::Requirement
+  requirement: &70245763026000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70317239005260
+  version_requirements: *70245763026000
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70317239004840 !ruby/object:Gem::Requirement
+  requirement: &70245763024980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70317239004840
+  version_requirements: *70245763024980
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70317239004340 !ruby/object:Gem::Requirement
+  requirement: &70245763024340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 3.6.1
   type: :development
   prerelease: false
-  version_requirements: *70317239004340
+  version_requirements: *70245763024340
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70317239003920 !ruby/object:Gem::Requirement
+  requirement: &70245763023660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70317239003920
+  version_requirements: *70245763023660
 description: 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,