shelltastic 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9b07dd350e166ed03ad713679d70d7ea6240e187
-  data.tar.gz: 210773d437ad75e55344586d6ad7e2c17664c02d
+SHA256:
+  metadata.gz: 20dc0136766aee9463af6c60624299cf3501267df0eb529b4b0f609434aeb9a2
+  data.tar.gz: b1daff36ac9f708334715dad20aab079ed2ca43bea163c820373639342cf1142
 SHA512:
-  metadata.gz: a80dcb34fcfc4cef75f0f7f74f0361714d84059eaf95791e832a6e8d275fd463e5f1b764ba32bd8d567daabfedd39775f5fe60ab6be0d2fee3c2d04f7c3a355d
-  data.tar.gz: 398974008814c3d93bb2ae2478dbcfed6064b948e8f96ccaaa5d7be8a59b01aa284437e5db75ef265092ba2141bd8eef865c58860df2e3791f7b6fcaf71312f7
+  metadata.gz: fbb7ebf36c4682cb9062ed86a04a033bc7d46a2ed87382ac9d3999573539228c5f5159327601731114423e0d5abeb0cdb24a54e725ada965372036a845ee2348
+  data.tar.gz: 307c95d92238bb2776dec664b4a6be2335541787d172cfa63334fe18181f3cb3a0291234d4d562766825586b33540160390cc79e504ac9069c7932746f785ee4

data/.github/workflows/ruby.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.tool-versions

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.5.0
+* Added `start` command to run commands in the background. Bump Version 0.5.0
+
 ## 0.4.0
 * `:error` returns false now if there is not an error--instead of empty string
 

data/README.md

@@ -1,6 +1,9 @@
 # Shelltastic
 Shelltastic is simple *nix shell wrapper for ruby.  You can pass a single command or multiple commands to run.
 
+[![Gem Version](https://badge.fury.io/rb/shelltastic.svg)](https://badge.fury.io/rb/shelltastic)
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -17,6 +20,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Run 
+
  ```ruby
 ShellTastic::Command.run("date")
 ```
@@ -30,7 +35,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 +60,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/command_io.rb

@@ -37,6 +37,39 @@ 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 = "1.0.0"
 end

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/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/output_formatter_spec.rb

@@ -7,20 +7,20 @@ describe ShellTastic::OutputFormatter do
                   pid: "10000000",
                   error: "No such file or directory")
   end
-  it "should return a hash" do
-    @result.inspect.should be_kind_of(Hash)
+  it "returns a hash" do
+    expect(@result.inspect).to be_kind_of(Hash)
   end
 
-  it "should allow to add key value pairs" do
+  it "allows to add key value pairs" do
     @result.command = "date"
-    @result.inspect[:command].should eq("date")
+    expect(@result.inspect[:command]).to eq("date")
   end
 
-  it "should have total time" do
+  it "contains total time" do
     timer = ShellTastic::Timer.new
     @result.start = timer.start
     @result.stop  = timer.stop
     @result.total_time = timer.total_time
-    @result.total_time.should_not be_nil
+    expect(@result.total_time).to_not be_nil
   end
 end

data/spec/shelltastic_spec.rb

@@ -1,43 +1,64 @@
 require 'spec_helper'
 
 describe ShellTastic do
-  it "should run a shell command" do
+  it "runs a shell command"do
     result = ShellTastic::Command.run("ls -l").first
-    result.fetch(:exitstatus).should eq(0)
+    expect(result.fetch(:exitstatus)).to eq(0)
   end
 
-  it "should run multiple commands" do
+  it "runs multiple commands"do
     result = ShellTastic::Command.run("ls -l", "date")
-    result.size.should eq(2) 
+    expect(result.size).to eq(2)
   end
 
-  it "should run take an array of commands to run" do
+  it "takes an array of commands to run"do
     result = ShellTastic::Command.run(["ls -l", "date"])
-    result.size.should eq(2) 
+    expect(result.size).to eq(2)
   end
 
 
-  it "should raise a command exception" do
+  it "raises a command exception"do
     expect {
-    result = ShellTastic::Command.run("lss -l")
+      result = ShellTastic::Command.run("lss -l")
     }.to raise_error(ShellTastic::CommandException)
   end
 
-  it "should alert if command is empty or nil" do
+  it "alerts if command is empty or nil"do
     expect {
       ShellTastic::Command.run("")
     }.to raise_error(ShellTastic::CommandException)
   end
 
-  it "should return `false` for error if there is not any errors" do
+  it "returns `false` for error if there is not any errors"do
     result = ShellTastic::Command.run("date").first
-    result[:error].should eq(false)
+    expect(result[:error]).to eq(false)
   end
 
-  it "should return error" do
-    result = ShellTastic::Command.run("du -sh /tmp/foos").first
-    result[:error].should_not eq(false)
+  it "returns an error and exit status"do
+    result = ShellTastic::Command.run("du -sh /tmp/inotexist").first
+    expect(result[:error]).not_to be_nil
+    expect(result[:exitstatus]).to eq(1)
   end
 
+  # fire and forget
+  it "fires a command in the background and has a pid"do
+    result = ShellTastic::Command.start("ls -al /").first
+    expect(result[:pid]).not_to be_nil
+  end
+
+  it "fires a command in the background and has a command populated"do
+    result = ShellTastic::Command.start("ls -al /").first
+    expect(result[:command]).to eq("ls -al /")
+  end
+
+  it "fires a command in the background and has no ouput"do
+    result = ShellTastic::Command.start("ls -al /").first
+    expect(result[:output]).to be_nil
+  end
 
+  it "fires a command in the background and raises an error"do
+    expect {
+      ShellTastic::Command.start("foobar").first
+    }.to raise_error(ShellTastic::CommandException)
+  end
 end

data/spec/spec_helper.rb

@@ -7,7 +7,6 @@
 require 'shelltastic'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

data/spec/timer_spec.rb

@@ -1,23 +1,23 @@
 require 'spec_helper'
 
 describe ShellTastic::Timer do
-  it "should report start time" do
+  it "reports start time" do
     start = ShellTastic::Timer.new.start
-    start.class.should eq(Time)
+    expect(start.class).to eq(Time)
   end
 
-  it "should report stop time" do
+  it "reports the stop time" do
     stop = ShellTastic::Timer.new.stop
-    stop.class.should eq(Time)
+    expect(stop.class).to eq(Time)
   end
 
-  it "should report total time" do
+  it "reports total time" do
     timer = ShellTastic::Timer.new
     start = timer.start
     sleep 2
     stop  = timer.stop
     total = timer.total_time
-    total.round.should eq(2)
+    expect(total.round).to eq(2)
   end
 
 end

metadata

@@ -1,66 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: shelltastic
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Bradley Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-13 00:00:00.000000000 Z
+date: 2024-01-13 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
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -79,29 +81,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.3.26
+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