systemcall 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91dd4ada1cd740295fe5dbeb3a239a668149f5d0
+  data.tar.gz: eaba66f9badaffdf3cb9c17577400be8034d6593
+SHA512:
+  metadata.gz: 60ab5951a1a7cf689e7c801c9f32946e2dcd2e0dfcaf7ec454219e2682116fbd47662b4bbbe587125c3e052331260be4112a888bdd491e0ef2491b2789094267
+  data.tar.gz: e6215adb3a1c8322b8218333283488fa3e059635aaa69793c4f1b1d8c379e5f5ee7aef77b0dccd6b5dbda6e0dfe692058f1b368a24146b1bf057f4e987a9f6ae

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+require: rubocop-performance
+
+AllCops:
+  TargetRubyVersion: '2.3'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in systemcall.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    systemcall (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.2)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.68.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-performance (1.1.0)
+      rubocop (>= 0.67.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.5.0)
+    yard (0.9.19)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.68.0)
+  rubocop-performance (~> 1.1.0)
+  systemcall!
+  yard (~> 0.9.19)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tobias Casper
+
+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,99 @@
+# System Call
+
+[![Build Status](https://travis-ci.org/tlux/systemcall.svg?branch=master)](https://travis-ci.org/tlux/systemcall)
+
+A simple wrapper around Ruby's Open3 to call CLI programs and process their
+output.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'systemcall'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install systemcall
+
+## Usage
+
+### Functional
+
+To run a CLI program use the following method:
+
+```ruby
+SystemCall.call('which', 'bash')
+SystemCall.call(['which', 'bash'])
+# => #<SystemCall::Result ...>
+```
+
+A command that has been executed returns a result object. When the command has
+run successfully, the result may look like so:
+
+```ruby
+result = SystemCall.call('which', 'bash')
+result.exit_code # => 0
+result.success? # => true
+result.error? # => false
+result.success_result # => "/bin/bash"
+result.error_result # => ""
+result.result # => "/bin/bash"
+```
+
+When the command failed, it may look like this:
+
+```ruby
+result = SystemCall.call('which', 'unknown')
+result.exit_code # => 1
+result.success? # => false
+result.error? # => true
+```
+
+In critical cases, the method may also raise:
+
+```ruby
+SystemCall.call('unknown')
+# ** (Errno::ENOENT) No such file or directory - unknown
+```
+
+### Mixin
+
+Alternatively, you can include the `SystemCall` module directly in your classes
+or modules. The included method name is `system_call` but the API is the same as
+for `SystemCall.call`.
+
+```ruby
+include SystemCall
+
+system_call('which', 'bash')
+system_call(['which', 'bash'])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/tlux/systemcall.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'systemcall'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/system_call.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'system_call/version'
+
+##
+# A simple wrapper around Ruby's Open3 to call CLI programs and process their
+# output.
+module SystemCall
+  autoload :Command, 'system_call/command'
+  autoload :Result, 'system_call/result'
+
+  ##
+  # Initializes and calls a {Command}, then returns the {Result}.
+  #
+  # @param args [Array] The command line arguments.
+  # @return [Result]
+  def self.call(*args)
+    Command.call(*args)
+  end
+
+  ##
+  # Initializes and calls a {Command}, then returns the {Result}.
+  #
+  # @param args [Array] The command line arguments.
+  # @return [Result]
+  def system_call(*args)
+    Command.call(*args)
+  end
+end

data/lib/system_call/command.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module SystemCall
+  ##
+  # A class responsible for communication with command line interfaces.
+  #
+  # @!attribute [r] args
+  #   @return [Array]
+  class Command
+    attr_reader :args
+
+    ##
+    # Initializes a {Command}.
+    #
+    # @param args [Array] The command line arguments.
+    def initialize(*args)
+      @args = args.flatten
+    end
+
+    ##
+    # Initializes and calls a {Command}, then returns the {Result}.
+    #
+    # @param args [Array] The command line arguments.
+    # @return [Result]
+    def self.call(*args)
+      new(*args).call
+    end
+
+    ##
+    # Invokes the {Command} and returns the {Result}.
+    #
+    # @return [Result]
+    def call
+      Open3.popen3(*args) do |_, stdout, stderr, wait_thr|
+        success_result = readlines(stdout)
+        error_result = readlines(stderr)
+        exit_status = wait_thr.value
+        Result.new(exit_status, success_result, error_result)
+      end
+    end
+
+    private
+
+    def readlines(io)
+      io.readlines.join.chomp
+    end
+  end
+end

data/lib/system_call/result.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module SystemCall
+  ##
+  # A class that represents a result of a system call.
+  #
+  # @!attribute [r] exit_status
+  #   @return [Process::Status] The exit status of the result.
+  # @!attribute [r] success_result
+  #   @return [String] The STDOUT of the result.
+  # @!attribute [r] error_result
+  #   @return [String] The STDERR of the result.
+  class Result
+    include Comparable
+
+    attr_reader :exit_status, :success_result, :error_result
+
+    ##
+    # Initializes a new {Result}.
+    #
+    # @param exit_status [Process::Status] The exit status of the result.
+    # @param success_result [String] The STDOUT of the result.
+    # @param error_result [String] The STDERR of the result.
+    def initialize(exit_status, success_result, error_result)
+      @exit_status = exit_status
+      @success_result = success_result
+      @error_result = error_result
+    end
+
+    ##
+    # Gets the exit code of the process.
+    #
+    # @return [Integer]
+    def exit_code
+      exit_status.exitstatus
+    end
+
+    ##
+    # Indicates whether the command has been executed successfully.
+    #
+    # @return [Boolean]
+    def success?
+      exit_status.success?
+    end
+
+    ##
+    # Indicates whether the command has not been executed successfully.
+    #
+    # @return [Boolean]
+    def error?
+      !success?
+    end
+
+    ##
+    # Returns the command result.
+    #
+    # @return [String] Returns result from {#success_result} when command exited
+    #   successfully. Otherwise returns result from {#error_result}.
+    def result
+      success? ? success_result : error_result
+    end
+
+    alias to_s result
+
+    ##
+    # Compares the result with the result of {#to_s} from another object.
+    #
+    # @param other [#to_s, nil]
+    # @return [Integer, nil]
+    def <=>(other)
+      return nil if other.nil?
+
+      result <=> other.to_s
+    end
+  end
+end

data/lib/system_call/version.rb

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

data/lib/systemcall.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'system_call'

data/systemcall.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'system_call/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'systemcall'
+  spec.version = SystemCall::VERSION
+  spec.authors = ['Tobias Casper']
+  spec.email = ['tobias.casper@gmail.com']
+
+  spec.summary = 'A simple wrapper to run CLI programs.'
+  spec.description = "A simple wrapper around Ruby's Open3 to call CLI " \
+    'programs and process their output.'
+  spec.homepage = 'https://github.com/tlux/systemcall'
+  spec.license = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.68.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.1.0'
+  spec.add_development_dependency 'yard', '~> 0.9.19'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: systemcall
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tobias Casper
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-29 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.68.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.68.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.19
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.19
+description: A simple wrapper around Ruby's Open3 to call CLI programs and process
+  their output.
+email:
+- tobias.casper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/system_call.rb
+- lib/system_call/command.rb
+- lib/system_call/result.rb
+- lib/system_call/version.rb
+- lib/systemcall.rb
+- systemcall.gemspec
+homepage: https://github.com/tlux/systemcall
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A simple wrapper to run CLI programs.
+test_files: []