cli-test 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a85c63f129a1c824466424bb4266a4cb2c3967bc
+  data.tar.gz: 066540802b20b65c8a47c97935a1340ad17dfe21
+SHA512:
+  metadata.gz: 1ceea902ab6160735d224b6501d295a2da4db2098a8f8cc297e0e810d4c8d085d13d160689bbf40a9e260228fb190fabc24083ddfde89afaca1fe36117c48e40
+  data.tar.gz: ec009c08963aeed9f96a9842255fc1d618c7eb0627b8fd907a815c0a937c617993b5f9038bf46e592df984a286b71f06d13f3245a9720307ba66428e4ef231d7

data/lib/cli-test.rb

@@ -0,0 +1,2 @@
+# to allow either 'cli_test' or 'cli-test' to be required to load code
+require 'cli_test'

data/lib/cli-test/execution.rb

@@ -0,0 +1,47 @@
+
+module CliTest
+  ##
+  # Encapsulates the execution results from the command
+  class Execution
+    extend Forwardable
+
+    ##
+    # @!attribute [r] stdout
+    #   @return [String] the stdout from the execution
+    # @!attribute [r] stderr
+    #   @return [String] the stderr from the execution
+    # @!attribute [r] status
+    #   @return [Process::Status] the status of the execution
+    attr_reader :stdout, :stderr, :status
+
+    ##
+    # creates an object of type CliTest::Execution
+    # @param [String] stdout the stdout of the execution
+    # @param [String] stderr the stderr of the execution
+    # @param [Process::Status] status the status of the execution
+    # @return [CliTest::Execution] the execution object
+    def initialize(stdout, stderr, status)
+      @stdout = stdout
+      @stderr = stderr
+      @status = status
+    end
+
+    ##
+    # returns true if the status code for the execution is
+    # is zero
+    # @return [Boolean] whether the execution was successful
+    def successful?
+      @status.success?
+    end
+
+    ##
+    # returns the stdout and stderr combined with a newline (<tt>\n</tt>)
+    # separator.
+    # @return [String] the combined stdout and stderr of the execution
+    def output
+      @stdout + "\n" + @stderr
+    end
+
+    def_delegator :@status, :exitstatus
+  end
+end

data/lib/cli-test/version.rb

@@ -0,0 +1,6 @@
+module CliTest
+  ##
+  # Version constant that is loaded as part of the gemspec for
+  # gem version
+  VERSION = '1.0.0' unless defined? VERSION
+end

data/lib/cli_test.rb

@@ -0,0 +1,73 @@
+require 'open3'
+
+require 'cli-test/version'
+require 'cli-test/execution'
+
+module CliTest
+
+  ## 
+  # Error class that will be used for all errors raise by library
+  class Error < StandardError
+  end
+
+  ##
+  # executes the supplied script and returns the results. If stdin_data
+  # is supplied it is passed to the command.
+  # @param [String] command the command to be executed
+  # @param [Hash] options a hash of options for the execution. valid values are:
+  #
+  #    - `stdin_data`: data to be passed into the STDIN of the command. If an array 
+  #   is passed in then the data is concatenated using <tt>\n</tt>  to simulate
+  #   multiple STDIN entries, as most scripts consider <tt>\n</tt> to be the end 
+  #   character for input.
+  # @return [CliTest::Execution] an Execution object containing the results
+  def execute(command, options={})
+    # if stdin_data is array then convert into a newline delineated string otherwise return as is
+    stdin_data = options[:stdin_data].respond_to?(:join) ? options[:stdin_data].join("\n") : options[:stdin_data]
+    stdout,stderr,status = Open3.capture3(command, stdin_data: stdin_data)
+    @last_execution = Execution.new(stdout,stderr,status)
+  rescue Exception => e
+    raise Error.new("command or file path: #{command} could not be executed. Error: #{e.message}")
+  end
+
+  ##
+  # executes the supplied Ruby script. Because Windows can't use shebangs to
+  # to figure out the correct intepreter 'ruby' is explicitly added to the command.
+  # If `use_bundler` is true then the script is executed with `bundle exec`.
+  # @param [String] script_path the relative or absolute path of a script to execute
+  # @param [Hash] options a hash of options to be used during the execution
+  #   valid options are:
+  #
+  #   - `use_bundler`: if set executes the script within the context of bundler
+  #   - `stdin_data`: data to be passed in to the STDIN of the execution
+  #   - `args`: any command line arguments to be supplied to the script. If an array is 
+  #   supplied then each entry is treated as a separate argument. Any arguments supplied
+  #   are converted to strings using the `to_s` method before the script is executed
+  # @return [CliTest::Execution] the execution object from running the script
+  def execute_script(script_path, options={})
+    # if args is an array convert into space delineated string otherwise return as is
+    args = options[:args].respond_to?(:join) ? options[:args].join(" ") : options[:args]
+    
+    cmd = script_path
+    cmd = "ruby #{cmd}" if RUBY_PLATFORM =~ /mswin|mingw|cygwin/
+    cmd = "bundle exec #{cmd}" if options[:use_bundler]
+    cmd = "#{cmd} #{args}" if args
+
+    execute(cmd, options)
+  end
+
+  ##
+  # convenience method to return last execution object for testing
+  # @return [CliTest::Execution] the last execution object
+  def last_execution
+    unless @last_execution
+      raise Error.new('No executions have occured. Try running execute or execute_script')
+    end
+
+    @last_execution
+  end
+
+  alias_method :run, :execute
+  alias_method :run_script, :execute_script
+  alias_method :last_run, :last_execution
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: cli-test
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Hoiberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-03 00:00:00.000000000 Z
+dependencies: []
+description: A rack-test inspired gem that provides helper methods to make testing
+  command line scripts easier
+email: tim.hoiberg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cli-test.rb
+- lib/cli-test/execution.rb
+- lib/cli-test/version.rb
+- lib/cli_test.rb
+homepage: https://github.com/thoiberg/cli-test
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: gem to make testing command line scripts easier
+test_files: []
+has_rdoc: