exec-simple 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ab5a6b092749313ecd978461696154ffbef0a92
+  data.tar.gz: 5b77ccd07d905730c362b90cf671a95b2be83b1e
+SHA512:
+  metadata.gz: 9d5465c60ac2e20c75faf85bf468c013002d4de5e2b9312f0037b250aeeb3e9ece59748289b2a604191875b4e617c324ff26990dabb06b5ecbbb116c00b8d138
+  data.tar.gz: a6f89a61a3bd0d901b47ac6e0108dccb662b27e72b1b68f01fbde74e65c0cdf58f368295f3d152c75f9ac5ab3292eb24c88532c2259ae49a3038a51f65bcd9c4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+## 0.1.2
+
+* bugfix: add missing concurrent-ruby dependency
+
+## 0.1.1
+
+* bugfix: prevent additional newlines in output if using Logger module
+
+## 0.1.0
+
+Basic functionality added: 
+
+* Run commands asynchronously
+* Support timeouts
+* Continously get output
+* Support Loggers to continuously print output

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exec-simple.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dominik Richter
+
+MIT License
+
+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,63 @@
+# ExecSimple
+
+A simple command runner in Ruby.
+
+```ruby
+ExecSimple.run 'echo 123'
+=> ["123\n", "", 0]
+```
+
+```ruby
+ExecSimple.run 'echo "error message" >&2; exit 123'
+=> ["", "error message\n", 123]
+```
+
+Handle timeouts:
+
+```ruby
+ExecSimple.run 'echo "Legen... wait for it"; sleep 100; echo "DARY"', timeout: 1
+=> ["Legen... wait for it\n", "", nil]
+```
+
+Integrate with logging:
+
+```ruby
+require 'logging'
+log = Logging.logger['main']
+log.add_appenders(Logging.appenders.stdout)
+
+ExecSimple.run 'echo "You will read this"; sleep 3; echo "before the end."', log: log
+ INFO  main : You will read this
+ INFO  main : before the end.
+=> 0
+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exec-simple'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exec-simple
+
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/exec-simple/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/exec-simple.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exec-simple'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exec-simple"
+  spec.version       = ExecSimple::VERSION
+  spec.authors       = ["Dominik Richter"]
+  spec.email         = ["dominik.richter@gmail.com"]
+  spec.summary       = %q{Simply run commands.}
+  spec.description   = %q{A simple command runner interface.}
+  spec.homepage      = "http://github.com/arlimus/exec-simple"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "concurrent-ruby", "~> 0.5"
+end

data/lib/exec-simple.rb

@@ -0,0 +1,72 @@
+require 'concurrent'
+require 'open3'
+require 'io/wait'
+
+module ExecSimple
+  VERSION = "0.1.2"
+
+  # Run a command. Optionally log results from stadard output and error
+  # with a logger object. Optionally set a timeout as a maximum time to
+  # wait until the process is killed.
+  # @param [String] cmd The command to run
+  # @param [Logging::Logger] log An optional logger object to use for output
+  # @param [Int] timeout An optional timeout to wait until the process is killed.
+  # @returny [Array] Either return an array of [output, error, exit_code] or 
+  # just the exit_code if a log-object was provided
+  def self.run cmd, log: nil, timeout: nil
+    # run the command concurrently to manage timeouts
+  
+    out = ""
+    err = ""
+    stdin, stdout, stderr, wait_thr = Open3.popen3(cmd)
+    # we don't need stdin
+    stdin.close
+    # run readers on stdin and stderr
+    op = Concurrent::Promise.execute do
+      while( not stdout.eof? )
+        #stdout.wait_readable
+        #cur = stdout.read
+        cur = stdout.readpartial(4096)
+        if log.nil? then out << cur else log.info cur.chomp end
+      end
+    end
+    ep = Concurrent::Promise.execute do
+      while( not stderr.eof? )
+        #stdout.wait_readable
+        #cur = stdout.read
+        cur = stderr.readpartial(4096)
+        if log.nil? then err << cur else log.error cur.chomp end
+      end
+    end
+    # 
+    pid = wait_thr[:pid]
+
+    future = Concurrent::Future.execute do
+        wait_thr.value
+      end
+    # get the future's value
+    exit_code = future.value(timeout)
+    exitstatus = if exit_code.nil? then nil else exit_code.exitstatus end
+    
+    # if we didn't yet get a value, kill the process
+    if wait_thr.alive?
+      Process.kill('TERM', pid)
+      sleep 1
+      # check if it terminated successfully
+      if wait_thr.alive?
+        # if not give it some more time
+        sleep 3
+        # and then kill it
+        Process.kill('KILL', pid) if wait_thr.alive?
+      end
+    end
+    
+    # finishing up
+    stdout.close
+    stderr.close
+
+    # get the results
+    return exitstatus if not log.nil?
+    [out, err, exitstatus]
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: exec-simple
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Dominik Richter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: A simple command runner interface.
+email:
+- dominik.richter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exec-simple.gemspec
+- lib/exec-simple.rb
+homepage: http://github.com/arlimus/exec-simple
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simply run commands.
+test_files: []
+has_rdoc: