system_run 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8880b54914f20294364a0bb3695c9a5fda5aa66
+  data.tar.gz: fb73e272798e02d8e1357a6a5f4ef942a455c670
+SHA512:
+  metadata.gz: 3b7ec264ee01e09d5c9466eabb486d12dcdace8da23faf9f144ce8a32783ff8a4dc6a8a356a37cc65e5507e0a6e6f40c60df4eba2d5c919cf34ed48e8d6650bd
+  data.tar.gz: 69ea30062b708f6f69145f106b36e2c2634595cced51bad4b39804c075d9d294fc0dd8a9d7098fb20824a0e62bde45a8d5609edc47aab56e155dd4ffc6fac1a1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Sonja Biedermann
+
+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,3 @@
+# system_run
+Tiny wrapper for running commands.
+Inspired by systemu.

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rubygems/package_task'
+
+# require 'rake/testtask'
+# Rake::TestTask.new do |t|
+#   t.libs << "test"
+#   t.test_files = FileList['./test/tc_*.rb']
+#   t.verbose = false
+# end
+
+spec = eval(File.read('system_run.gemspec'))
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+  `rm pkg/* -rf`
+  `ln -sf #{pkg.name}.gem pkg/system_run.gem`
+end
+
+task :push => :gem do |r|
+  `gem push pkg/system_run.gem`
+end
+
+task :install => :gem do |r|
+  `sudo gem install pkg/system_run.gem`
+end

data/lib/system_run.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+require 'timeout'
+require 'tempfile'
+
+module System
+  def self.run(cmd, *args, timeout: nil, env: {}, capture: :default, file: nil, cwd: '.', on_timeout: nil)
+    cmd = cmd.dup << ' ' << args.join(' ')
+    env = env.dup.map { |k, v| [k.to_s, v.to_s] }.to_h
+
+    raise ArgumentError, "file(s) must be instance of File or Tempfile" unless file.nil? || file.all? { |f| f.is_a?(File) || f.is_a?(Tempfile) }
+    out, err = case capture
+               when :default then
+                 raise ArgumentError, "invalid file redirects for default capture, expected array of two" unless file.nil? || file.is_a?(Array) && file.size == 2
+                 file ? [file.first, file.last] : [Tempfile.new('sysrun-out'), Tempfile.new('sysrun-err')]
+               when :out then [file || Tempfile.new('sysrun-out'), '/dev/null']
+               when :err then ['/dev/null', file || Tempfile.new('sysrun-err')]
+               when :both then [file || Tempfile.new('sysrun-outerr')] * 2
+               else raise ArgumentError, "unknown capture: #{capture}"
+               end
+
+    pid = spawn env, cmd, out: out, err: err, chdir: cwd
+    status = wait_or_kill pid, timeout, on_timeout
+    [out, err].each { |f| f.rewind if f.respond_to? :rewind }
+
+    file ? status : case capture
+                    when :default then [status, out.read, err.read]
+                    when :out, :both then [status, out.read]
+                    when :err then [status, err.read]
+                    end
+  ensure
+    [out, err].each { |f| f.unlink if f.is_a?(Tempfile) && f.path&.include?('sysrun') }
+  end
+
+  def self.wait_or_kill(pid, timeout=nil, on_timeout=nil)
+    begin
+      Timeout::timeout(timeout) do
+        Process.wait pid
+      end
+    rescue Timeout::Error
+      if on_timeout then
+        on_timeout.call pid
+      else
+        Process.kill 9, pid
+      end
+      Process.wait pid
+    end
+
+    $?
+  end
+
+  private_class_method :wait_or_kill
+end
+
+if __FILE__ == $0 then
+  date = %q(ruby -e "t = Time.now; STDOUT.puts t; STDERR.puts t")
+
+  # capture stdout and stderr separately.
+  status, stdout, stderr = System.run date
+  p [status, stdout, stderr]
+
+  # capture only stdout, discard stderr.
+  status, stdout = System.run date, capture: :out
+  p [status, stdout]
+
+  # capture stderr and discard stdout.
+  status, stderr = System.run date, capture: :err
+  p [status, stderr]
+
+  # capture both stdout and stderr.
+  status, all = System.run date, capture: :both
+  p [status, all]
+
+  # capture stderr. kill process after 2 seconds.
+  loop_time = %q(ruby -e "loop { STDERR.puts Time.now.to_i; sleep 2 }")
+  status, stderr = System.run loop_time, capture: :err, timeout: 2
+  p [status, stderr]
+
+  # set timeout to 2 seconds and provide an action for when timeout occurs. default
+  # action is to send signal 9. this will be overridden!
+  status, _, _ = System.run %q(ruby -e "sleep 10"), timeout: 2, on_timeout: ->(pid) do
+    puts 'oh no, request timed out'
+    Process.kill 9, pid
+  end
+  p status
+
+  # set environment variables.
+  env = %q(ruby -e "puts ENV['HELLO']")
+  status, stdout = System.run env, env: {'HELLO' => 'WORLD'}, capture: :out
+  p [status, stdout]
+
+  # switch to a different directory before executing the command.
+  dir = %q(ruby -e "puts Dir.pwd")
+  status, stdout = System.run dir, cwd: Dir.tmpdir, capture: :out
+  p [status, stdout]
+
+  # write to a file instead of loading output into a string.
+  out = File.open 'test_out.txt', 'w+'
+  err = File.open 'test_err.txt', 'w+'
+
+  hello = %q(ruby -e "STDERR.puts 'hello'; STDOUT.puts 'world'")
+  status = System.run hello, file: [out, err]
+  p [status, out.read, err.read]
+
+  [out, err].each { |f| f.close; File.unlink f.path }
+end

data/system_run.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name             = "system_run"
+  s.version          = "1.0"
+  s.platform         = Gem::Platform::RUBY
+  s.license          = "MIT"
+  s.summary          = "Tiny wrapper for running commands. Inspired by systemu."
+
+  s.description      = "see https://github.com/biederfrau/system_run"
+
+  s.files            = Dir['{example/**/*,server/**/*,lib/**/*,cockpit/**/*,contrib/logo*,contrib/Screen*,log/**/*}'] + %w(LICENSE Rakefile system_run.gemspec README.md)
+  s.require_path     = 'lib'
+  s.extra_rdoc_files = ['README.md']
+  s.test_files       = []
+
+  s.required_ruby_version = '>=2.3.0'
+
+  s.authors          = ['Sonja Biedermann']
+
+  s.email            = 's.bdrmnn@gmail.com'
+  s.homepage         = 'https://github.com/biederfrau/system_run'
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: system_run
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Sonja Biedermann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-02 00:00:00.000000000 Z
+dependencies: []
+description: see https://github.com/biederfrau/system_run
+email: s.bdrmnn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/system_run.rb
+- system_run.gemspec
+homepage: https://github.com/biederfrau/system_run
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Tiny wrapper for running commands. Inspired by systemu.
+test_files: []