shelltastic 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89419f6c9c35e7a71c2e181f12baa3999c7722e93908952008730c106ede5ca6
-  data.tar.gz: e1a6101fb87f0f06f1d09d605d9554342f081a57c186ef6432a1a042f748e054
+  metadata.gz: 20dc0136766aee9463af6c60624299cf3501267df0eb529b4b0f609434aeb9a2
+  data.tar.gz: b1daff36ac9f708334715dad20aab079ed2ca43bea163c820373639342cf1142
 SHA512:
-  metadata.gz: 1398fe39bca978e54368015448baa52ae6807d68533142180a07021a40ed3f67ee1a42694dd4e32a0741b903ba85dcd4b90af661fa6efb2006fd07228bd83e8c
-  data.tar.gz: 8356a89b04eb97814b99711b13fb2b802c64e2af205cdccf5cbb820e464b03ec1f6a803598823e402fa51dfe1253b7f39df7e5b90c6c1f986602bc4a885f7085
+  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:
@@ -91,7 +94,7 @@ The parent process (you) will not wait for the child to finish or return any inf
 
 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.
+__BEWARE__ of long running commands that could fail. ShellTastic detaches itself from the child command.
 
 
 

data/lib/shelltastic/command_io.rb

@@ -70,7 +70,6 @@ module ShellTastic
           Process.detach(pid) if pid
         end
       end
-
     end
   end
 end

data/lib/shelltastic/version.rb

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

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,65 +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 "should fire a command in the background and have a pid" do
+  it "fires a command in the background and has a pid"do
     result = ShellTastic::Command.start("ls -al /").first
-    result[:pid].should_not be_nil
+    expect(result[:pid]).not_to be_nil
   end
 
-  it "should fire a command in the background and have a command" do
+  it "fires a command in the background and has a command populated"do
     result = ShellTastic::Command.start("ls -al /").first
-    result[:command].should eq("ls -al /")
+    expect(result[:command]).to eq("ls -al /")
   end
 
-  it "should fire a command in the background and have no ouput" do
+  it "fires a command in the background and has no ouput"do
     result = ShellTastic::Command.start("ls -al /").first
-    result[:output].should be_nil
+    expect(result[:output]).to be_nil
   end
 
-  it "should fire a command in the background and not raise an error" do
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shelltastic
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Bradley Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-20 00:00:00.000000000 Z
+date: 2024-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open4
@@ -60,6 +60,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
@@ -98,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Shelltastic is a simple *nix shell wrapper.