runfile-exec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90779b05a4e99841b74174a7749ee877f5128c3e
+  data.tar.gz: bdba048aedc64945d67f6a7a5de4df31e2641011
+SHA512:
+  metadata.gz: e43cb9139fd411d5d79df41a71cabdecbc2e4ac124b831d5dc1235a9238e9e6c6aeee895d6cd27f5304ee0279e7af1e08c0db07c7cc664b9f3ab9de5c842c7d7
+  data.tar.gz: e6489265df4b6d22b6ff1c85095f10b340b26e7098d70a90c67170749257afe027064a369e0070d35a1b1771d0fc7f66ee2c14e3e7c46135b4b8fb20e9885e47

data/README.md

@@ -0,0 +1,49 @@
+Runfile Exec
+============
+
+[![Gem Version](https://badge.fury.io/rb/runfile-exec.svg)](http://badge.fury.io/rb/runfile-exec)
+
+[Runfile](https://github.com/DannyBen/runfile) extensions for executing shell commands.
+
+## Install
+
+	$ gem install runfile-exec
+
+## Usage
+
+Put this in your Runfile
+
+```ruby
+require "runfile-exec"
+include RunfileExec
+```
+
+And then you can use any of these commands in your Runfile actions:
+
+```ruby
+# Print and run a command. Wait until it is done and continue.
+run 'pwd'
+
+# Print and run a command. Wait until it is done and exit.
+run! 'pwd'
+
+# Run a command in the background
+run_bg 'some-long-running --daemon'
+
+# Run a command in the background, log to a log file and save the process 
+# ID in a pid file for later reference
+run_bg 'some-long-running --daemon', log: 'my.log', pid: 'daemon'
+
+# Stop a command started with 'run_bg'. Provide the name of he pid file you 
+# used in 'run_bg'
+stop_bg 'daemon'
+```
+
+## About PID files ##
+
+PID files are stored in the working directory by default.
+To change the location, add this at the beginning of your Runfile:
+
+```ruby
+RunfileExec.pid_dir = './tmp'
+```

data/lib/runfile-exec.rb

@@ -0,0 +1,2 @@
+require "runfile-exec/version"
+require "runfile-exec/extensions"

data/lib/runfile-exec/extensions.rb

@@ -0,0 +1,60 @@
+# This module provides methods for easily and politely run shell commands
+# through a Runfile action.
+# It is mainly a convenient wrapper around `system` and `exec` and it also
+# adds functions for running background tasks with ease.
+
+module RunfileExec
+  @@pid_dir = nil
+
+  def self.pid_dir=(dir)
+    @@pid_dir = dir
+  end
+
+  def self.pid_dir
+    @@pid_dir
+  end
+
+  # Run a command, wait until it is done and continue
+  def run(cmd)
+    say "!txtgrn!> #{cmd}"
+    system cmd
+  end
+  module_function :run
+
+  # Run a command, wait until it is done, then exit
+  def run!(cmd)
+    say "!txtgrn!> #{cmd}"
+    exec cmd
+  end
+  module_function :run!
+
+  # Run a command in the background, optionally log to a log file and save
+  # the process ID in a pid file
+  def run_bg(cmd, pid: nil, log: '/dev/null')
+    full_cmd = "exec #{cmd} >#{log} 2>&1"
+    say "!txtgrn!> #{full_cmd}"
+    process = IO.popen "exec #{cmd} >#{log} 2>&1"
+    File.write pidfile(pid), process.pid if pid
+    return process.pid
+  end
+
+  # Stop a command started with 'run_bg'. Provide the name of he pid file you 
+  # used in 'run_bg'
+  def stop_bg(pid)
+    file = pidfile(pid)
+    if File.exist? file
+      pid = File.read file
+      File.delete file
+      run "kill -s TERM #{pid}"
+    else
+      say "!txtred!PID file not found."
+    end
+  end
+
+  private
+
+  def pidfile(pid)
+    @@pid_dir ? "#{@@pid_dir}/#{pid}.pid" : "#{pid}.pid"
+  end
+
+end

data/lib/runfile-exec/version.rb

@@ -0,0 +1,5 @@
+module RunfileExec
+
+	# Version constant, used by gemspec
+	VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: runfile-exec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colsole
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: A collection of utility methods to run shell commands for Runfile
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/runfile-exec.rb
+- lib/runfile-exec/extensions.rb
+- lib/runfile-exec/version.rb
+homepage: https://github.com/DannyBen/runfile-exec
+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: Runfile methods for executing shell commands
+test_files: []
+has_rdoc: