command_line 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c96c7405e0e0bc9f0ab84fd180bd29934eac52693b49793223a62cc87a6e8bd
+  data.tar.gz: 2713ef9a363e555106a50d3bb9e3c182f559fef9c4c536427abf8ce6cf869352
+SHA512:
+  metadata.gz: 2f4c26ed8af0508911fc9e607ca407d30bf6ce3ea76bad548b510027fd0664a2ec0ec6f541aedc6b25f8eb1407f289033fde8f0107dd9fc1cc7fc6d2056f3db1
+  data.tar.gz: fc00e60b70829934ea0b4bbbde98d12a7f68b487963b4a76d84c8d710ca56fa040b66a08d3197d8c7262a0205e6c7b319129b6b9d8b2a2acf491d33ca4476951

data/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+# Everywhere
+[*]
+end_of_line = lf # Unix-style newlines
+trim_trailing_whitespace = true
+
+# Ruby
+[.rb, .rake, Rakefile]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle/
+/.yardoc
+/pkg/
+/spec/reports/
+/spec/examples.txt
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+  - '*.gemspec'
+  - Gemfile
+  - Rakefile
+  - spec/fixtures/**/*
+  - bin/**/*
+Layout/AlignArguments:
+  EnforcedStyle: with_fixed_indentation
+Layout/IndentFirstHashElement:
+  EnforcedStyle: consistent
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+Metrics/MethodLength:
+  Max: 15

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+before_install: # for bundler 2.0+
+  - gem install bundler
+script: bundle exec rake $RAKE_TASK
+matrix:
+  include:
+    # Linux - Tests and Linting
+    - os: linux
+      rvm: 2.6
+    - os: linux
+      rvm: 2.5
+    - os: linux
+      rvm: 2.4
+    # OS X - Tests
+    - os: osx
+      rvm: 2.6
+      env: RAKE_TASK=spec
+    - os: osx
+      rvm: 2.5
+      env: RAKE_TASK=spec
+    - os: osx
+      rvm: 2.4
+      env: RAKE_TASK=spec

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 (TBD)
+
+Initial release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Aaron Lasseigne
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# CommandLine
+
+CommandLine provides an easier way to run command-line applications.
+It captures all outputs, can handle applications that require stdin, and can pass environment variables.
+It's also helpful for testing commmand-line applications.
+
+This project is tested against and works on Linux, OS X, and Windows.
+
+## Installation
+
+This project uses [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'command_line', '~> 1.0.0'
+```
+
+If you want `command_line` available globally you can add this line to your application's Gemfile:
+
+```ruby
+gem 'command_line', '~> 1.0.0', require: 'command_line/global'
+```
+
+Or manually install it yourself with:
+
+```sh
+$ gem install command_line
+```
+
+In a script you can make `command_line` available globally with:
+
+```ruby
+require 'command_line/global'
+```
+
+## Usage
+
+All examples below assume that `command_line` has been made available globally.
+If not, simply call `CommandLine.command_line` instead of `command_line`.
+
+With `command_line` you to easily run commands and check their `stdout`, `stderr`, and exit status.
+
+```ruby
+>> result = command_line('echo', 'hello')
+=> #<CommandLine::Result ...>
+>> result.stdout
+=> "hello\n"
+>> result.stderr
+=> ""
+>> result.exited?
+=> true
+>> result.exitstatus
+=> 0
+>> result.success?
+=> true
+>> result.failure?
+=> false
+```
+
+If your application requires input use a block to send input.
+
+```ruby
+command_line('command_expecting_input') do |stdin|
+  stdin.puts "first input"
+  stdin.puts "second input"
+end
+```
+
+Environment variables can be passed after the command and arguments are passed.
+
+```ruby
+command_line('some_webserver', { 'PORT' => '80' })
+```
+
+### RSpec
+
+To have direct access to `CommandLine.command_line` you can include it in `spec/spec_helper.rb`.
+
+```ruby
+require 'command_line'
+
+RSpec.configure do |config|
+  config.include CommandLine
+end
+```
+
+This will make `command_line` available in your test suite.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DragonRuby/command_line.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new do |task|
+  task.options = ['--display-cop-names']
+end
+
+task default: %i[spec rubocop]

data/appveyor.yml

@@ -0,0 +1,19 @@
+environment:
+  matrix:
+    - RUBY_VERSION: 26
+    - RUBY_VERSION: 25
+    - RUBY_VERSION: 24
+
+install:
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - bundle install
+
+build: off
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'command_line'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/command_line.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'command_line/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'command_line'
+  spec.version = CommandLine::VERSION
+  spec.authors = ['Aaron Lasseigne']
+  spec.email   = ['aaron.lasseigne@dragonruby.org']
+
+  spec.summary     = 'An easier way execute command line applications and get all of the output.'
+  spec.description = spec.summary
+  spec.homepage    = 'https://github.com/DragonRuby/command_line'
+  spec.license     = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/DragonRuby/command_line'
+    spec.metadata['changelog_uri'] = 'https://github.com/DragonRuby/command_line/blob/master/CHANGELOG.md'
+  end
+
+  spec.required_ruby_version = '>= 2.4'
+
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop', '~> 0.75.0'
+  spec.add_development_dependency 'yard', '~> 0.9.20'
+end

data/lib/command_line.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+require 'command_line/result'
+require 'command_line/version'
+
+# CommandLine provides an easier way to run command-line applications.  It
+# captures all outputs, can handle applications that require stdin, and can pass
+# environment variables. It's also helpful for testing commmand-line
+# applications.
+module CommandLine
+  module_function
+
+  # Run a command and get back the result.
+  #
+  # @param command [String] the command to run
+  # @param args [Array<String>] any arguments passed to the command
+  # @param [Hash] env: Pass environment variables to use. The key should
+  #   be a String representing the environment variable name. The value
+  #   is the value you want that variable to have.
+  #
+  # @yield [stdin] Handle any input on stdin that the command needs.
+  # @yieldparam stdin [IO]
+  #
+  # @example
+  #   command_line('echo', 'hello')
+  #
+  # @example
+  #   command_line('command_expecting_input') do |stdin|
+  #     stdin.puts "first input"
+  #     stdin.puts "second input"
+  #   end
+  #
+  # @example
+  #   command_line('some_webserver', { 'PORT' => '80' })
+  #
+  # @return [Result]
+  def command_line(command, *args, env: {})
+    stdout = ''
+    stderr = ''
+    status = nil
+
+    Open3.popen3(env, command, *args) do |i, o, e, wait_thr|
+      yield i if block_given?
+
+      stdout = o.read
+      stderr = e.read
+      status = wait_thr.value
+    end
+
+    Result.new(stdout, stderr, status)
+  end
+end

data/lib/command_line/global.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'command_line'
+
+# Docs are included here so they can be discovered.
+
+# Run a command and get back the result.
+#
+# @param command [String] the command to run
+# @param args [Array<String>] any arguments passed to the command
+# @param [Hash] env: Pass environment variables to use. The key should
+#   be a String representing the environment variable name. The value
+#   is the value you want that variable to have.
+#
+# @yield [stdin] Handle any input on stdin that the command needs.
+# @yieldparam stdin [IO]
+#
+# @example
+#   command_line('echo', 'hello')
+#
+# @example
+#   command_line('command_expecting_input') do |stdin|
+#     stdin.puts "first input"
+#     stdin.puts "second input"
+#   end
+#
+# @example
+#   command_line('some_webserver', { 'PORT' => '80' })
+#
+# @return [Result]
+def command_line(*args, &block)
+  CommandLine.command_line(*args, &block)
+end

data/lib/command_line/result.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module CommandLine
+  # The result returned from running {CommandLine.command_line}.
+  class Result
+    def initialize(stdout, stderr, status)
+      @stdout = stdout
+      @stderr = stderr
+      @status = status
+    end
+
+    # The complete contents of stdout after running the application.
+    #
+    # @example
+    #   command_line('echo', 'hi').stdout
+    #   # => "hi\n"
+    #
+    # @return [String]
+    attr_reader :stdout
+
+    # The complete contents of stderr after running the application.
+    #
+    # @example
+    #   command_line('grep').stderr
+    #   # => "usage: grep ..."
+    #
+    # @return [String]
+    attr_reader :stderr
+
+    # Returns true if the application exited normally.
+    #
+    # @example
+    #   command_line('grep').exited?
+    #
+    # @return [Boolean]
+    def exited?
+      @status.exited?
+    end
+
+    # The numeric exit status of the application if it exited normally.
+    #
+    # @example
+    #   command_line('echo', 'hi').exitstatus
+    #   # => 0
+    #   command_line('grep').exitstatus
+    #   # => 2
+    #
+    # @return [Integer,nil]
+    def exitstatus
+      @status.exitstatus
+    end
+
+    # Returns true if the command exited normally with a success status.
+    #
+    # @example
+    #   command_line('echo', 'hi').success?
+    #   # => true
+    #
+    # @return [Boolean]
+    def success?
+      !@status.nil? && @status.success?
+    end
+
+    # Returns true if the command failed to exit normally or exited with a
+    # failing status.
+    #
+    # @example
+    #   command_line('grep').failure?
+    #   # => true
+    #
+    # @return [Boolean]
+    def failure?
+      !success?
+    end
+  end
+end

data/lib/command_line/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CommandLine
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: command_line
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Lasseigne
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.75.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.75.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+description: An easier way execute command line applications and get all of the output.
+email:
+- aaron.lasseigne@dragonruby.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- appveyor.yml
+- bin/console
+- bin/setup
+- command_line.gemspec
+- lib/command_line.rb
+- lib/command_line/global.rb
+- lib/command_line/result.rb
+- lib/command_line/version.rb
+homepage: https://github.com/DragonRuby/command_line
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DragonRuby/command_line
+  source_code_uri: https://github.com/DragonRuby/command_line
+  changelog_uri: https://github.com/DragonRuby/command_line/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An easier way execute command line applications and get all of the output.
+test_files: []