shelltastic 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9b07dd350e166ed03ad713679d70d7ea6240e187
-  data.tar.gz: 210773d437ad75e55344586d6ad7e2c17664c02d
+SHA256:
+  metadata.gz: 89419f6c9c35e7a71c2e181f12baa3999c7722e93908952008730c106ede5ca6
+  data.tar.gz: e1a6101fb87f0f06f1d09d605d9554342f081a57c186ef6432a1a042f748e054
 SHA512:
-  metadata.gz: a80dcb34fcfc4cef75f0f7f74f0361714d84059eaf95791e832a6e8d275fd463e5f1b764ba32bd8d567daabfedd39775f5fe60ab6be0d2fee3c2d04f7c3a355d
-  data.tar.gz: 398974008814c3d93bb2ae2478dbcfed6064b948e8f96ccaaa5d7be8a59b01aa284437e5db75ef265092ba2141bd8eef865c58860df2e3791f7b6fcaf71312f7
+  metadata.gz: 1398fe39bca978e54368015448baa52ae6807d68533142180a07021a40ed3f67ee1a42694dd4e32a0741b903ba85dcd4b90af661fa6efb2006fd07228bd83e8c
+  data.tar.gz: 8356a89b04eb97814b99711b13fb2b802c64e2af205cdccf5cbb820e464b03ec1f6a803598823e402fa51dfe1253b7f39df7e5b90c6c1f986602bc4a885f7085

data/README.md

@@ -17,6 +17,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Run 
+
  ```ruby
 ShellTastic::Command.run("date")
 ```
@@ -30,7 +32,18 @@ The above will return an Array of hash meta-data.
 For example, the above command's return would look something like this:
 
 ```ruby
-[{:output=>"Sun Feb  3 17:41:45 EST 2013", :pid=>17507, :error=>false, :start=>2013-02-03 17:41:45 -0500, :stop=>2013-02-03 17:41:45 -0500, :total_time=>0.004405272, :exitstatus=>0}]
+[
+  {
+    :output=>"Sun Feb  3 17:41:45 EST 2013", 
+    :pid=>17507, 
+    :command => "date",
+    :error=>false, 
+    :start=>2013-02-03 17:41:45 -0500, 
+    :stop=>2013-02-03 17:41:45 -0500, 
+    :total_time=>0.004405272, 
+    :exitstatus=>0
+  }
+]
 ```
 
 You can also pass multiple commands separated by commas or pass an array.
@@ -44,7 +57,74 @@ ShellTastic::Command.run(["date", "whoami"])
 ```
 
 ```ruby
-[{:output=>"Sat Apr  6 15:26:05 EDT 2013", :pid=>92558, :error=>false, :start=>2013-04-06 15:26:05 -0400, :stop=>2013-04-06 15:26:05 -0400, :command=>"date", :total_time=>0.010004, :exitstatus=>0}, {:output=>"bradleydsmith", :pid=>92559, :error=>false, :start=>2013-04-06 15:26:05 -0400, :stop=>2013-04-06 15:26:05 -0400, :command=>"whoami", :total_time=>0.008262, :exitstatus=>0}]
+[
+  {
+    :output=>"Sat Apr  6 15:26:05 EDT 2013", 
+    :pid=>92558, 
+    :error=>false, 
+    :start=>2013-04-06 15:26:05 -0400, 
+    :stop=>2013-04-06 15:26:05 -0400, 
+    :command=>"date", 
+    :total_time=>0.010004, 
+    :exitstatus=>0
+   }, 
+
+   {
+     :output=>"bradleydsmith", 
+     :pid=>92559, 
+     :error=>false, 
+     :start=>2013-04-06 15:26:05 -0400, 
+     :stop=>2013-04-06 15:26:05 -0400, 
+     :command=>"whoami", 
+     :total_time=>0.008262, 
+     :exitstatus=>0
+    }
+]
+```
+
+### Start
+Start will run a command in the background and return the pid immediately.
+
+It takes the same command arguments as `#run`
+
+The parent process (you) will not wait for the child to finish or return any information.
+
+This is useful if you want to run a command, but dont care about the output or exit status.
+
+__BEWARE__ of long running commands that could fail.  ShellTastic detaches itself from the child command.
+
+
+
+```ruby
+ShellTastic::Command.start("sleep 10; date")
+```
+or
+
+```ruby
+ShellTastic::Command.start(["sleep 10", "date"])
+```
+
+The above will return an Array of hash meta-data.
+
+```ruby 
+[{ :output, :pid, :error, :start, :stop, :total_time, :exitstatus, :command }]
+```
+
+For example, the above command's return would look something like this:
+
+```ruby
+[
+  { 
+    :output=>nil, 
+    :pid=>17507, 
+    :error=>false, 
+    :start=>2013-02-03 17:41:45 -0500, 
+    :stop=>2013-02-03 17:41:45 -0500, 
+    :command=>"sleep 10; date", 
+    :total_time=>0.004405272, 
+    :exitstatus=>nil
+  }
+]
 ```
 
 

data/lib/shelltastic.rb

@@ -20,6 +20,10 @@ module ShellTastic
       def run(*command)
         command.flatten.map { |cmd| ShellTastic::IO.popen(cmd, ShellTastic::Timer.new, ShellTastic::OutputFormatter.new) }
       end
+
+      def start(*command)
+        command.flatten.map { |cmd| ShellTastic::IO.fire_and_forget(cmd, ShellTastic::Timer.new, ShellTastic::OutputFormatter.new) }
+      end
     end
   end
 end

data/lib/shelltastic/command_io.rb

@@ -37,6 +37,40 @@ module ShellTastic
         end
         formatter.inspect
       end
+
+      # run command in background dont wait for it to exit 
+      #
+      # @see #start
+      # @param command [String] command(s) to execute
+      # @param command [Time] time object for run time
+      # @param command [Formatter] formatter object to build output
+      # @return [Hash] hash meta-data for the command executed
+      # @note output, error , exitstatus will be nil
+      # @example
+      #  { :output, :pid, :error, :start, :stop, :total_time, :exitstatus }
+      def fire_and_forget(command, timer, formatter)
+        string_nil_or_blank! command
+        begin
+          formatter.start = timer.start
+          pid = Process.spawn(command, :pgroup=>true, [:out, :err, :in] => "/dev/null")
+          formatter.build(command: command,
+                          output: nil,
+                          pid: pid,
+                          error: false,
+                          stop: timer.stop,
+                          exitstatus: $?,
+                          total_time: timer.total_time)
+
+        Process.detach(pid)
+        formatter.inspect
+        rescue Errno::ENOENT => e
+          Process.kill(9, pid) if pid
+          raise ShellTastic::CommandException.new("Shell command #{command} failed with status #{$?} and ERROR: #{e.message}")
+        ensure
+          Process.detach(pid) if pid
+        end
+      end
+
     end
   end
 end

data/lib/shelltastic/version.rb

@@ -1,3 +1,3 @@
 module ShellTastic
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/shelltastic.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |gem|
   gem.version       = ShellTastic::VERSION
   gem.authors       = ["Bradley Smith"]
   gem.email         = ["bradleydsmith@gmail.com"]
-  gem.description   = %q{Shelltastic is a simple *nix shell wrapper}
-  gem.summary       = %q{Shelltastic is a simple *nix shell wrapper}
-  gem.homepage      = ""
+  gem.description   = %q{Shelltastic is a simple *nix shell wrapper that you can use in your own applications.}
+  gem.summary       = %q{Shelltastic is a simple *nix shell wrapper.}
+  gem.homepage      = "https://github.com/bradleyd/shelltastic"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/shelltastic_spec.rb

@@ -39,5 +39,27 @@ describe ShellTastic do
     result[:error].should_not eq(false)
   end
 
+  # fire and forget
+  it "should fire a command in the background and have a pid" do
+    result = ShellTastic::Command.start("ls -al /").first
+    result[:pid].should_not be_nil
+  end
+
+  it "should fire a command in the background and have a command" do
+    result = ShellTastic::Command.start("ls -al /").first
+    result[:command].should eq("ls -al /")
+  end
+
+  it "should fire a command in the background and have no ouput" do
+    result = ShellTastic::Command.start("ls -al /").first
+    result[:output].should be_nil
+  end
+
+  it "should fire a command in the background and not raise an error" do
+    expect {
+      ShellTastic::Command.start("foobar").first
+    }.to raise_error(ShellTastic::CommandException)
+  end
+
 
 end

metadata

@@ -1,66 +1,67 @@
 --- !ruby/object:Gem::Specification
 name: shelltastic
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Bradley Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-13 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open4
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !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: rspec
   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'
-description: Shelltastic is a simple *nix shell wrapper
+description: Shelltastic is a simple *nix shell wrapper that you can use in your own
+  applications.
 email:
 - bradleydsmith@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -79,29 +80,28 @@ files:
 - spec/spec_helper.rb
 - spec/timer_spec.rb
 - tags
-homepage: ''
+homepage: https://github.com/bradleyd/shelltastic
 licenses: []
 metadata: {}
-post_install_message: 
+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.1.11
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
-summary: Shelltastic is a simple *nix shell wrapper
+summary: Shelltastic is a simple *nix shell wrapper.
 test_files:
 - spec/output_formatter_spec.rb
 - spec/shelltastic_spec.rb