methadone 1.1.0 → 1.2.0

data/.travis.yml

@@ -9,3 +9,4 @@ rvm:
   - ree
   - ruby-head
   - rbx
+  - jruby

data/CHANGES.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v1.2.0 - May 21, 2012, 11:05 PM
+
+* Better handling of `open4` dependency when you don't install it and you don't use it.
+* Quoted spaced strings in config files and env var weren't working.  Now they are.
+* Use the current version in generated gemspec
+* Non-string arguments (such as Regexps for validation and classes for type conversion) were not working.  Now they are.
+* `sh` can now be used more safely by passing an array to avoid tokenization (thanks @gchpaco!)
+
 ## v1.1.0 - April 21, 2012, 6:00 PM
 
 * Can bootstrap apps using RSpec instead of Test::Unit (thanks @msgehard)

data/Rakefile

@@ -26,6 +26,12 @@ RDoc::Task.new do |rd|
   rd.title = 'Methadone - Power Up your Command Line Apps'
 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|
@@ -41,6 +47,7 @@ Cucumber::Rake::Task.new('features:wip') do |t|
   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']

data/bin/methadone

@@ -60,7 +60,7 @@ main do |app_name|
     "  #{gem_variable}.add_development_dependency('rdoc')",
     "  #{gem_variable}.add_development_dependency('aruba')",
     "  #{gem_variable}.add_development_dependency('rake','~> 0.9.2')",
-    "  #{gem_variable}.add_dependency('methadone', '~>1.0.0.rc4')",
+    "  #{gem_variable}.add_dependency('methadone', '~>#{Methadone::VERSION}')",
   ], :before => /^end\s*$/
 end
 

data/lib/methadone.rb

@@ -2,6 +2,7 @@ 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'

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/execution_strategy/base.rb

@@ -3,11 +3,14 @@ module Methadone
     # Base for any ExecutionStrategy implementation.  Currently, this is nothing more than an interface
     # specification.
     class Base
-      # Executes the command and returns the results back.
-      # This should do no logging or other logic other than to execute the command
-      # and return the required results.
+      # Executes the command and returns the results back.  This
+      # should do no logging or other logic other than to execute the
+      # command and return the required results.  If command is an
+      # array, use exec directly bypassing any tokenization, shell or
+      # otherwise; otherwise use the normal shell interpretation of
+      # the command string.
       #
-      # command:: the command-line to run, as a String
+      # command:: the command-line to run, as an Array or a String
       #
       # Returns an array of size 3:
       # <tt>[0]</tt>:: The standard output of the command as a String, never nil

data/lib/methadone/execution_strategy/jvm.rb

@@ -5,7 +5,12 @@ module Methadone
     # Methadone::ExecutionStrategy for the JVM that uses JVM classes to run the command and get its results.
     class JVM < Base
       def run_command(command)
-        process = java.lang.Runtime.get_runtime.exec(command)
+        process = case command
+                  when String then
+                    java.lang.Runtime.get_runtime.exec(command)
+                  else
+                    java.lang.Runtime.get_runtime.exec(*command)
+                  end
         process.get_output_stream.close
         stdout = input_stream_to_string(process.get_input_stream)
         stderr = input_stream_to_string(process.get_error_stream)

data/lib/methadone/execution_strategy/open_3.rb

@@ -5,7 +5,10 @@ module Methadone
     # Implementation for modern Rubies that uses the built-in Open3 library
     class Open_3 < MRI
       def run_command(command)
-        stdout,stderr,status = Open3.capture3(command)
+        stdout,stderr,status = case command
+                               when String then Open3.capture3(command)
+                               else Open3.capture3(*command)
+                               end
         [stdout.chomp,stderr.chomp,status]
       end
     end

data/lib/methadone/execution_strategy/open_4.rb

@@ -6,7 +6,11 @@ module Methadone
     # Open4 to get access to the standard output AND error.
     class Open_4 < MRI
       def run_command(command)
-        pid, stdin_io, stdout_io, stderr_io = Open4::popen4(command)
+        pid, stdin_io, stdout_io, stderr_io =
+          case command
+          when String then Open4::popen4(command)
+          else Open4::popen4(*command)
+          end
         stdin_io.close
         stdout = stdout_io.read
         stderr = stderr_io.read

data/lib/methadone/main.rb

@@ -72,6 +72,8 @@ module Methadone
   #
   module Main
     include Methadone::ExitNow
+    include Methadone::ARGVParser
+
     def self.included(k)
       k.extend(self)
     end
@@ -318,7 +320,7 @@ module Methadone
 
     def set_defaults_from_env_var
       if @env_var
-        String(ENV[@env_var]).split(/\s+/).each do |arg|
+        parse_string_for_argv(ENV[@env_var]).each do |arg|
           ::ARGV.unshift(arg)
         end
       end
@@ -329,7 +331,7 @@ module Methadone
         File.open(@rc_file) do |file| 
           parsed = YAML::load(file)
           if parsed.kind_of? String
-            String(parsed).split(/\s+/).each do |arg|
+            parse_string_for_argv(parsed).each do |arg|
               ::ARGV.unshift(arg)
             end
           elsif parsed.kind_of? Hash
@@ -344,6 +346,7 @@ module Methadone
       end
     end
 
+
     # Normalized all defaults to both string and symbol forms, so
     # the user can access them via either means just as they would for
     # non-defaulted options
@@ -450,7 +453,7 @@ module Methadone
       options << :one unless options.include?(:any) || options.include?(:many)
       @args << arg_name
       @arg_options[arg_name] = options
-      options.select { |_| _.kind_of? ::String }.each do |doc|
+      options.select(&STRINGS_ONLY).each do |doc|
         @arg_documentation[arg_name] = doc + (options.include?(:optional) ? " (optional)" : "")
       end
       set_banner
@@ -507,7 +510,11 @@ module Methadone
     end
 
     def option_names_from(args)
-      args.select { |_| _ =~ /^\-/ }.map { |_| _.gsub(/^\-+/,'').gsub(/\s.*$/,'') }
+      args.select(&STRINGS_ONLY).select { |_| 
+        _ =~ /^\-/ 
+      }.map { |_| 
+        _.gsub(/^\-+/,'').gsub(/\s.*$/,'') 
+      }
     end
 
     def set_banner
@@ -537,7 +544,7 @@ module Methadone
     end
 
     def option_names(*opts_on_args,&block)
-      opts_on_args.map { |arg|
+      opts_on_args.select(&STRINGS_ONLY).map { |arg|
         if arg =~ /^--\[no-\]([^-\s][^\s]*)/
           $1.to_sym
         elsif arg =~ /^--([^-\s][^\s]*)/
@@ -550,5 +557,7 @@ module Methadone
       }.reject(&:nil?)
     end
 
+    STRINGS_ONLY = lambda { |o| o.kind_of?(::String) }
+
   end
 end

data/lib/methadone/sh.rb

@@ -5,8 +5,7 @@ elsif RUBY_VERSION =~ /^1.8/
   begin
   require 'open4'
   rescue LoadError
-    STDERR.puts "!! For Ruby #{RUBY_VERSION}, the open4 library must be installed"
-    raise
+    warn "For Ruby #{RUBY_VERSION}, the open4 library must be installed or SH won't work"
   end
 else
   require 'open3'
@@ -72,7 +71,11 @@ module Methadone
     # If not, its output as logged at INFO.  In either case, its
     # error output is logged at WARN.
     #
-    # command:: the command to run
+    # command:: the command to run as a String or Array of String.  The String form is simplest, but
+    #           is open to injection.  If you need to execute a command that is assembled from some portion
+    #           of user input, consider using an Array of String.  This form prevents tokenization that occurs
+    #           in the String form.  The first element is the command to execute,
+    #           and the remainder are the arguments. See Methadone::ExecutionStrategy::Base for more info.
     # options:: options to control the call. Currently responds to:
     #           +:expected+:: an Int or Array of Int representing error codes, <b>in addition to 0</b>, that are
     #                         expected and therefore constitute success.  Useful for commands that don't use

data/lib/methadone/version.rb

@@ -1,3 +1,3 @@
-module Methadone
-  VERSION = "1.1.0"
+module Methadone #:nodoc:
+  VERSION = "1.2.0" #:nodoc:
 end

data/test/execution_strategy/test_open_3.rb

@@ -29,6 +29,29 @@ module ExecutionStrategy
       }
     end
 
+    test_that "run_command handles array arguments properly" do
+      Given {
+        @command = [any_string, any_string, any_string]
+        @stdout = any_string
+        @stderr = any_string
+        @status = stub('Process::Status')
+      }
+      When the_test_runs
+      Then {
+        Open3.expects(:capture3).with(*@command).returns([@stdout,@stderr,@status])
+      }
+
+      Given new_open_3_strategy
+      When {
+        @results = @strategy.run_command(@command)
+      }
+      Then {
+        @results[0].should == @stdout
+        @results[1].should == @stderr
+        @results[2].should be @status
+      }
+    end
+
     test_that "exception_meaning_command_not_found returns Errno::ENOENT" do
       Given new_open_3_strategy
       When {

data/test/execution_strategy/test_open_4.rb

@@ -39,6 +39,35 @@ module ExecutionStrategy
       }
     end
 
+    test_that "run_command handles array arguments properly" do
+      Given {
+        @command = [any_string, any_string, any_string]
+        @stdin_io = mock("IO")
+        @stdout = any_string
+        @stdout_io = StringIO.new(@stdout)
+        @stderr = any_string
+        @stderr_io = StringIO.new(@stderr)
+        @pid = any_int :min => 2, :max => 65536
+        @status = stub('Process::Status')
+      }
+      When the_test_runs
+      Then {
+        Open4.expects(:popen4).with(*@command).returns([@pid,@stdin_io,@stdout_io,@stderr_io])
+        @stdin_io.expects(:close)
+        Process.expects(:waitpid2).with(@pid).returns([any_string,@status])
+      }
+
+      Given new_open_4_strategy
+      When {
+        @results = @strategy.run_command(@command)
+      }
+      Then {
+        @results[0].should == @stdout
+        @results[1].should == @stderr
+        @results[2].should be @status
+      }
+    end
+
     test_that "exception_meaning_command_not_found returns Errno::ENOENT" do
       Given new_open_4_strategy
       When {

data/test/test_main.rb

@@ -289,6 +289,25 @@ class TestMain < BaseTest
     }
   end
 
+  test_that "passing non-strings wont' break automagic stuff" do
+    Given {
+      @foo = nil
+      @bar = nil
+      main do
+        @foo = options[:foo]
+        @bar = options[:bar]
+      end
+      on("--foo ARG",OptionParser::DecimalInteger)
+      on("--bar ARG",/^\d/)
+      set_argv %w(--foo 88 --bar 4)
+    }
+    When run_go_safely
+    Then {
+      assert_equal 88,@foo,@logged.string + $stdout.string
+      assert_equal '4',@bar,@logged.string + $stdout.string
+    }
+  end
+
   test_that "omitting the block to opts simply sets the value in the options hash and returns itself" do
     Given {
       @switch = nil
@@ -576,7 +595,40 @@ class TestMain < BaseTest
     }
   end
 
-  test_that "we can get defaults from a config file if it's specified" do
+  test_that "environment args correctly handle spaces" do
+    Given app_to_use_environment
+    And {
+      @flag_value = any_string + ' ' + any_string
+      ENV['APP_OPTS'] = "--switch --flag='#{@flag_value}'"
+    }
+    When {
+      @code = lambda { go! }
+    }
+    Then {
+      assert_exits(0,'',&@code)
+      @switch.should == true
+      @flag.should == @flag_value
+    }
+  end
+
+  test_that "environment args correctly handle spaces via backslash stuff" do
+    Given app_to_use_environment
+    And {
+      cli_flag_value = any_string(:max => 4) + "\\ " + any_string(:max => 4)
+      @flag_value = cli_flag_value.gsub("\\ "," ")
+      ENV['APP_OPTS'] = "--switch --flag=#{cli_flag_value}"
+    }
+    When {
+      @code = lambda { go! }
+    }
+    Then {
+      assert_exits(0,'',&@code)
+      @switch.should == true
+      @flag.should == @flag_value
+    }
+  end
+
+  test_that "we can get defaults from a YAML config file if it's specified" do
     Given app_to_use_rc_file
     And {
       @flag_value = any_string
@@ -616,7 +668,7 @@ class TestMain < BaseTest
     }
   end
 
-  test_that "we can use a different format for the rc file" do
+  test_that "we can use a simpler, text format for the rc file" do
     Given app_to_use_rc_file
     And {
       @flag_value = any_string
@@ -636,6 +688,25 @@ class TestMain < BaseTest
 
   end
 
+  test_that "the text format for the rc file attempts to respect quoted arguments" do
+    Given app_to_use_rc_file
+    And {
+      @flag_value = any_string(:max => 10) + " " + any_string(:max => 10)
+      rc_file = File.join(ENV['HOME'],'.my_app.rc')
+      File.open(rc_file,'w') do |file|
+        file.puts "--switch --flag='#{@flag_value}'"
+      end
+    }
+    When {
+      @code = lambda { go! }
+    }
+    Then {
+      assert_exits(0,&@code)
+      @switch.should == true
+      @flag.should == @flag_value
+    }
+  end
+
   test_that "with an ill-formed rc file, we get a reasonable error message" do
     Given app_to_use_rc_file
     And {
@@ -720,7 +791,7 @@ private
     block.call
     fail "Expected an exit of #{exit_code}, but we didn't even exit!"
   rescue SystemExit => ex
-    ex.status.should == exit_code
+    assert_equal exit_code,ex.status,@logged.string
   end
 
   def set_argv(args)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: methadone
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: 
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - davetron5000
@@ -15,13 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-21 00:00:00 -04:00
-default_executable: 
+date: 2012-05-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -30,12 +27,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   type: :runtime
-  version_requirements: *id001
+  name: bundler
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec-expectations
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -45,12 +42,12 @@ dependencies:
         - 2
         - 6
         version: "2.6"
+  prerelease: false
   type: :development
-  version_requirements: *id002
+  name: rspec-expectations
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  name: rake
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -59,12 +56,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   type: :development
-  version_requirements: *id003
+  name: rake
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
-  name: rdoc
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -74,12 +71,12 @@ dependencies:
         - 3
         - 9
         version: "3.9"
+  prerelease: false
   type: :development
-  version_requirements: *id004
+  name: rdoc
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
-  name: cucumber
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -90,12 +87,12 @@ dependencies:
         - 1
         - 1
         version: 1.1.1
+  prerelease: false
   type: :development
-  version_requirements: *id005
+  name: cucumber
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
-  name: aruba
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -104,12 +101,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   type: :development
-  version_requirements: *id006
+  name: aruba
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
-  name: simplecov
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -119,12 +116,12 @@ dependencies:
         - 0
         - 5
         version: "0.5"
+  prerelease: false
   type: :development
-  version_requirements: *id007
+  name: simplecov
+  requirement: *id007
 - !ruby/object:Gem::Dependency 
-  name: clean_test
-  prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -134,12 +131,12 @@ dependencies:
         - 0
         - 10
         version: "0.10"
+  prerelease: false
   type: :development
-  version_requirements: *id008
+  name: clean_test
+  requirement: *id008
 - !ruby/object:Gem::Dependency 
-  name: mocha
-  prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -148,8 +145,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   type: :development
-  version_requirements: *id009
+  name: mocha
+  requirement: *id009
 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, interface
 email: 
 - davetron5000 at gmail.com
@@ -180,6 +179,7 @@ files:
 - features/support/env.rb
 - features/version.feature
 - lib/methadone.rb
+- lib/methadone/argv_parser.rb
 - lib/methadone/cli.rb
 - lib/methadone/cli_logger.rb
 - lib/methadone/cli_logging.rb
@@ -222,7 +222,6 @@ files:
 - test/test_exit_now.rb
 - test/test_main.rb
 - test/test_sh.rb
-has_rdoc: true
 homepage: http://github.com/davetron5000/methadone
 licenses: []
 
@@ -256,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: methadone
-rubygems_version: 1.5.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Kick the bash habit and start your command-line apps off right