optparse-plus 3.0.0

data/lib/optparse_plus/process_status.rb

@@ -0,0 +1,45 @@
+module OptparsePlus
+  # <b>OptparsePlus Internal - treat as private</b>
+  #
+  # A wrapper/enhancement of Process::Status that handles coersion and expected
+  # nonzero statuses
+  class ProcessStatus
+
+    # The exit status, either directly from a Process::Status or derived from a non-Int value.
+    attr_reader :exitstatus
+
+    # Create the ProcessStatus with the given status.
+    #
+    # status:: if this responds to #exitstatus, that method is used to extract the exit code.  If it's
+    #          and Int, that is used as the exit code.  Otherwise,
+    #          it's truthiness is used: 0 for truthy, 1 for falsey.
+    # expected:: an Int or Array of Int representing the expected exit status, other than zero,
+    #            that represent "success".
+    def initialize(status,expected)
+      @exitstatus = derive_exitstatus(status)
+      @success = ([0] + Array(expected)).include?(@exitstatus)
+    end
+
+    # True if the exit status was a successul (i.e. expected) one.
+    def success?
+      @success
+    end
+
+  private
+
+    def derive_exitstatus(status)
+      status = if status.respond_to? :exitstatus
+                 status.exitstatus
+               else
+                 status
+               end
+      if status.kind_of? Integer
+        status
+      elsif status
+        0
+      else
+        1
+      end
+    end
+  end
+end

data/lib/optparse_plus/sh.rb

@@ -0,0 +1,223 @@
+if RUBY_PLATFORM == 'java'
+  require 'java'
+  require 'ostruct'
+elsif RUBY_VERSION =~ /^1.8/
+  begin
+  require 'open4'
+  rescue LoadError
+    warn "For Ruby #{RUBY_VERSION}, the open4 library must be installed or SH won't work"
+  end
+else
+  require 'open3'
+end
+
+require 'optparse_plus/process_status'
+
+module OptparsePlus
+  # Module with various helper methods for executing external commands.
+  # In most cases, you can use #sh to run commands and have decent logging
+  # done.  You will likely use this in a class that also mixes-in
+  # OptparsePlus::CLILogging (remembering that OptparsePlus::Main mixes this in for you).  
+  # If you <b>don't</b>, you must provide a logger via #set_sh_logger.
+  #
+  # == Examples
+  #
+  #    include OptparsePlus::SH
+  #
+  #    sh 'cp foo.txt /tmp'
+  #    # => logs the command to DEBUG, executes the command, logs its output to DEBUG and its
+  #    #    error output to WARN, returns 0
+  # 
+  #    sh 'cp non_existent_file.txt /nowhere_good'
+  #    # => logs the command to DEBUG, executes the command, logs its output to INFO and
+  #    #    its error output to WARN, returns the nonzero exit status of the underlying command
+  # 
+  #    sh! 'cp non_existent_file.txt /nowhere_good'
+  #    # => same as above, EXCEPT, raises a OptparsePlus::FailedCommandError
+  #
+  #    sh 'cp foo.txt /tmp' do
+  #      # Behaves exactly as before, but this block is called after
+  #    end
+  #
+  #    sh 'cp non_existent_file.txt /nowhere_good' do
+  #      # This block isn't called, since the command failed
+  #    end
+  #
+  #    sh 'ls -l /tmp/' do |stdout|
+  #      # stdout contains the output of the command
+  #    end
+  #    sh 'ls -l /tmp/ /non_existent_dir' do |stdout,stderr|
+  #      # stdout contains the output of the command,
+  #      # stderr contains the standard error output.
+  #     end
+  #    
+  # == Handling process execution
+  #
+  # In order to work on as many Rubies as possible, this class defers the actual execution
+  # to an execution strategy.  See #set_execution_strategy if you think you'd like to override
+  # that, or just want to know how it works.
+  #
+  # == More complex execution and subprocess management
+  #
+  # This is not intended to be a complete replacement for Open3 or an enhanced means of managing subprocesses.
+  # This is to make it easy for you to shell-out to external commands and have your app be robust and
+  # easy to maintain.
+  module SH
+    def self.included(k)
+      k.extend(self)
+    end
+    # Run a shell command, capturing and logging its output.
+    # If the command completed successfully, it's output is logged at DEBUG.
+    # If not, its output as logged at INFO.  In either case, its
+    # error output is logged at WARN.
+    #
+    # 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 OptparsePlus::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
+    #                         exit codes the way you'd like
+    # block:: if provided, will be called if the command exited nonzero.  The block may take 0, 1, 2, or 3 arguments.
+    #         The arguments provided are the standard output as a string, standard error as a string, and
+    #         the exitstatus as an Int.
+    #         You should be safe to pass in a lambda instead of a block, as long as your
+    #         lambda doesn't take more than three arguments
+    #
+    # Example
+    #
+    #     sh "cp foo /tmp"
+    #     sh "ls /tmp" do |stdout|
+    #       # stdout contains the output of ls /tmp
+    #     end
+    #     sh "ls -l /tmp foobar" do |stdout,stderr|
+    #       # ...
+    #     end
+    #
+    # Returns the exit status of the command.  Note that if the command doesn't exist, this returns 127.
+    def sh(command,options={},&block)
+      sh_logger.debug("Executing '#{command}'")
+
+      stdout,stderr,status = execution_strategy.run_command(command)
+      process_status = OptparsePlus::ProcessStatus.new(status,options[:expected])
+
+      sh_logger.warn("stderr output of '#{command}': #{stderr}") unless stderr.strip.length == 0
+
+      if process_status.success?
+        sh_logger.debug("stdout output of '#{command}': #{stdout}") unless stdout.strip.length == 0
+        call_block(block,stdout,stderr,process_status.exitstatus) unless block.nil?
+      else
+        sh_logger.info("stdout output of '#{command}': #{stdout}") unless stdout.strip.length == 0
+        sh_logger.warn("Error running '#{command}'")
+      end
+
+      process_status.exitstatus
+    rescue *exception_meaning_command_not_found => ex
+      sh_logger.error("Error running '#{command}': #{ex.message}")
+      127
+    end
+
+    # Run a command, throwing an exception if the command exited nonzero.
+    # Otherwise, behaves exactly like #sh.
+    #
+    # options:: options hash, responding to:
+    #           <tt>:expected</tt>:: same as for #sh
+    #           <tt>:on_fail</tt>:: a custom error message.  This allows you to have your
+    #                               app exit on shell command failures, but customize the error
+    #                               message that they see.
+    #
+    # Raises OptparsePlus::FailedCommandError if the command exited nonzero.
+    #
+    # Examples:
+    #
+    #     sh!("rsync foo bar")
+    #     # => if command fails, app exits and user sees: "error: Command 'rsync foo bar' exited 12"
+    #     sh!("rsync foo bar", :on_fail => "Couldn't rsync, check log for details")
+    #     # => if command fails, app exits and user sees: "error: Couldn't rsync, check log for details
+    def sh!(command,options={},&block)
+      sh(command,options,&block).tap do |exitstatus|
+        process_status = OptparsePlus::ProcessStatus.new(exitstatus,options[:expected])
+        unless process_status.success?
+          raise OptparsePlus::FailedCommandError.new(exitstatus,command,options[:on_fail]) 
+        end
+      end
+    end
+
+    # Override the default logger (which is the one provided by CLILogging).
+    # You would do this if you want a custom logger or you aren't mixing-in
+    # CLILogging.
+    #
+    # Note that this method is *not* called <tt>sh_logger=</tt> to avoid annoying situations
+    # where Ruby thinks you are setting a local variable
+    def set_sh_logger(logger)
+      @sh_logger = logger
+    end
+
+    # Set the strategy to use for executing commands.  In general, you don't need to set this
+    # since this module chooses an appropriate implementation based on your Ruby platform:
+    #
+    # 1.8 Rubies, including 1.8, and REE:: Open4 is used via OptparsePlus::ExecutionStrategy::Open_4. <b><tt>open4</tt> will not be
+    #                                      installed as a dependency</b>.  RubyGems doesn't allow conditional dependencies, 
+    #                                      so make sure that your app declares it as a dependency if you think you'll be 
+    #                                      running on 1.8 or REE.
+    # Rubinius:: Open4 is used, but we handle things a bit differently; see OptparsePlus::ExecutionStrategy::RBXOpen_4.
+    #            Same warning on dependencies applies.
+    # JRuby:: Use JVM calls to +Runtime+ via OptparsePlus::ExecutionStrategy::JVM
+    # Windows:: Currently no support for Windows
+    # All others:: we use Open3 from the standard library, via OptparsePlus::ExecutionStrategy::Open_3
+    #
+    # See OptparsePlus::ExecutionStrategy::Base for how to implement your own.
+    def set_execution_strategy(strategy)
+      @execution_strategy = strategy
+    end
+
+  private 
+
+    def exception_meaning_command_not_found
+      execution_strategy.exception_meaning_command_not_found
+    end
+
+    def self.default_execution_strategy_class
+      if RUBY_PLATFORM == 'java'
+        OptparsePlus::ExecutionStrategy::JVM
+      elsif defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+        OptparsePlus::ExecutionStrategy::RBXOpen_4
+      elsif RUBY_VERSION =~ /^1.8/
+        OptparsePlus::ExecutionStrategy::Open_4
+      else
+        OptparsePlus::ExecutionStrategy::Open_3
+      end
+    end
+
+    def execution_strategy
+      @execution_strategy ||= SH.default_execution_strategy_class.new 
+    end
+
+    def sh_logger
+      @sh_logger ||= begin
+        raise StandardError, "No logger set! Please include OptparsePlus::CLILogging or provide your own via #set_sh_logger." unless self.respond_to?(:logger)
+        self.logger
+      end
+    end
+
+    # Safely call our block, even if the user passed in a lambda
+    def call_block(block,stdout,stderr,exitstatus)
+      # blocks that take no arguments have arity -1.  Or 0.  Ugh.
+      if block.arity > 0
+        case block.arity
+        when 1 
+          block.call(stdout)
+        when 2
+          block.call(stdout,stderr)
+        else
+          # Let it fail for lambdas
+          block.call(stdout,stderr,exitstatus)
+        end
+      else
+        block.call
+      end
+    end
+  end
+end

data/lib/optparse_plus/test/base_integration_test.rb

@@ -0,0 +1,31 @@
+require "test/unit"
+require "fileutils"
+require "pathname"
+require "tmpdir"
+require "open3"
+
+require_relative "integration_test_assertions"
+
+# Clean test should be setting this
+$FOR_TESTING_ONLY_SKIP_STDERR = false
+
+module OptparsePlus
+end
+class OptparsePlus::BaseIntegrationTest < Test::Unit::TestCase
+  include FileUtils
+  include OptparsePlus::IntegrationTestAssertions
+
+  # Run your app, capturing stdout, stderr, and process status.
+  # app_name:: Your bin name, without `bin/`
+  # args:: CLI args as a string
+  # allow_failure:: if true, this will return even if the app invocation fails.  If false (the default), blows up if things go
+  # wrong.
+  def run_app(app_name, args, allow_failure: false)
+    command = "bin/#{app_name} #{args}"
+    stdout,stderr,results = Open3.capture3(command)
+    if @allow_failure && !results.success?
+      raise "'#{command}' failed!: #{results.inspect}\n\nSTDOUT {\n#{stdout}\n} STDERR {\n#{stderr}\n} END"
+    end
+    [stdout,stderr,results]
+  end
+end

data/lib/optparse_plus/test/integration_test_assertions.rb

@@ -0,0 +1,65 @@
+module OptparsePlus
+end
+module OptparsePlus::IntegrationTestAssertions
+  # Assert that a file's contents contains one or more regexps
+  #
+  # filename:: The file whose contents to check
+  # contains:: either a regexp or array of regexpts that the file's contents must match
+  def assert_file(filename, contains:)
+    contents = File.read(filename)
+    Array(contains).each do |regexp|
+      assert_match(regexp,contents,"Expected #{filename} to contain #{regexp}")
+    end
+  end
+
+  # Assert that the stdout contains an appropriate banner for your app
+  #
+  # stdout:: The standard out, presumably of running `«your-app» --help`
+  # bin_name:: The binary name of your app 
+  # takes_options:: set this to true if your app should take options
+  # takes_arguments:: set this to a hash of the arguments your app should take, with the key being the arg name and the value
+  # being either `:required` or `:optional`
+  def assert_banner(stdout, bin_name, takes_options: , takes_arguments: {})
+    if takes_options
+      assert_match(/Options/, stdout)
+      if takes_arguments == false || takes_arguments.empty?
+        assert_match(/Usage: #{Regexp.escape(bin_name)}.*\[options\]\s*$/,stdout)
+      else
+        expected_args = takes_arguments.map { |arg, required|
+          if required == :required
+            arg.to_s
+          else
+            "[#{arg}]"
+          end
+        }.join(" ")
+
+        assert_match(/Usage: #{Regexp.escape(bin_name)}.*\[options\]\s*#{Regexp.escape(expected_args)}$/,stdout)
+      end
+    else
+      assert_match(/Usage: #{Regexp.escape(bin_name)}\s*$/,stdout)
+    end
+  end
+
+  # Assert that your app takes the given option(s)
+  #
+  # stdout:: The standard out, presumably of running `«your-app» --help`
+  # options:: options your app should take.  Put the literal value in here e.g. `--foo` or `--[no-]bar`.  The array form is to
+  # allow you to assert long and short options for readable tests:
+  #
+  #     assert_option(stdout, "--version")
+  #     assert_option(stdout, "-h", "--help")
+  def assert_option(stdout, *options)
+    options.each do |option|
+      assert_match(/#{Regexp.escape(option)}/,stdout)
+    end
+  end
+
+  # Assert that your app has a one-line summary
+  # stdout:: The standard out, presumably of running `«your-app» --help`
+  def assert_oneline_summary(stdout)
+    output = stdout.split(/\n/)
+    assert output.size >= 3, "Expected 3 or more lines:\n#{stdout}"
+    assert_match(/^\s*$/,output[1],"Should be a blank line after the banner")
+    assert_match(/^\w+\s+\w+/,output[2],"Should be at least two words describing your app")
+  end
+end

data/lib/optparse_plus/version.rb

@@ -0,0 +1,3 @@
+module OptparsePlus #:nodoc:
+  VERSION = "3.0.0"
+end

data/optparse_plus.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "optparse_plus/version"
+
+Gem::Specification.new do |s|
+  s.name        = "optparse-plus"
+  s.version     = OptparsePlus::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["davetron5000"]
+  s.email       = ["davetron5000 at gmail.com"]
+  s.homepage    = "http://github.com/davetron5000/optparse-plus"
+  s.summary     = %q{Wrapper around the Standard Library's Option Parser to make CLIs Easier}
+  s.description = %q{OptparsePlus provides a lot of small but useful features for developing a command-line app, including an opinionated bootstrapping process, some helpful integration test support, and some classes to bridge logging and output into a simple, unified, interface}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency("bundler")
+  s.add_development_dependency("rake")
+  s.add_development_dependency("rdoc","~> 6.0")
+  s.add_development_dependency("sdoc")
+  s.add_development_dependency("simplecov", "~> 0.5")
+  s.add_development_dependency("clean_test", "~> 1.0.1")
+  s.add_development_dependency("mocha")
+  s.add_development_dependency("rspec") # needed for testing the generated tests
+  s.add_development_dependency("i18n")
+end

data/templates/full/.gitignore.erb

@@ -0,0 +1,4 @@
+.DS_Store
+results.html
+pkg
+html

data/templates/full/README.rdoc.erb

@@ -0,0 +1,24 @@
+= <%= gemname %> - DESCRIBE YOUR GEM
+
+Author::  YOUR NAME (YOUR EMAIL)
+Copyright:: Copyright (c) <%= Time.now.year %> YOUR NAME
+<% if license %>
+<% if license == 'custom' %>
+License:: INSERT LICENSE HERE
+<% else %>
+License:: <%= license %>, see LICENSE.txt
+<% end %>
+<% end %>
+
+DESCRIBE YOUR GEM HERE
+
+== Links
+
+* {Source on Github}[LINK TO GITHUB]
+* RDoc[LINK TO RDOC.INFO]
+
+== Install
+
+== Examples
+
+== Contributing

data/templates/full/Rakefile.erb

@@ -0,0 +1,71 @@
+def dump_load_path
+  puts $LOAD_PATH.join("\n")
+  found = nil
+  $LOAD_PATH.each do |path|
+    if File.exists?(File.join(path,"rspec"))
+      puts "Found rspec in #{path}"
+      if File.exists?(File.join(path,"rspec","core"))
+        puts "Found core"
+        if File.exists?(File.join(path,"rspec","core","rake_task"))
+          puts "Found rake_task"
+          found = path
+        else
+          puts "!! no rake_task"
+        end
+      else
+        puts "!!! no core"
+      end
+    end
+  end
+  if found.nil?
+    puts "Didn't find rspec/core/rake_task anywhere"
+  else
+    puts "Found in #{path}"
+  end
+end
+require 'bundler'
+require 'rake/clean'
+<% if rspec %>
+begin
+require 'rspec/core/rake_task'
+rescue LoadError
+dump_load_path
+raise
+end
+<% else %>
+require 'rake/testtask'
+<% end %>
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+<% if rspec %>
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
+end
+<% else %>
+Rake::TestTask.new do |t|
+  t.pattern = 'test/unit/test_*.rb'
+end
+
+Rake::TestTask.new("test:integration") do |t|
+  t.pattern = 'test/integration/test_*.rb'
+end
+<% end %>
+
+Rake::RDocTask.new do |rd|
+  <% if using_readme %>
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  <% else %>
+  rd.rdoc_files.include("lib/**/*.rb","bin/**/*")
+  <% end %>
+end
+<% if rspec %>
+task :default => [:spec]
+<% else %>
+task :default => [:test,"test:integration"]
+<% end %>