shelltastic 0.2.5 → 0.3.0

data/lib/shelltastic.rb

@@ -4,20 +4,20 @@ require_relative "shelltastic/command_io"
 require_relative "shelltastic/timer"
 require_relative "shelltastic/exceptions"
 
-# @! ShellTastic 
+# ShellTastic namespace
 module ShellTastic
-  # Command is the namespace for the actual meat of the gem
   class Command
     class << self
-      # encapsualtes the popen call 
+      # run is the entry point to api 
       # @param command [String] command or multiple commands to be executed
+      # @param command [Array] multiple commands to be executed
       # @param timer [Object] timer object, @see ShellTastic::Timer
       # @return [Array] Array of hashes for each command executed @see IO::popen
       # @example
-      # ShellTastic::Command.run "whoami"
-      # ShellTastic::Command.run "whoami", "date"
+      #   ShellTastic::Command.run "whoami"
+      #   ShellTastic::Command.run "whoami", "date"
       def run(*command)
-        command.flatten.map { |cmd| ShellTastic::IO.popen(cmd, ShellTastic::Timer) }
+        command.flatten.map { |cmd| ShellTastic::IO.popen(cmd, ShellTastic::Timer.new) }
       end
     end
   end

data/lib/shelltastic/command_io.rb

@@ -8,11 +8,12 @@ module ShellTastic
     class << self
       # A wrapper around popen4
       #
-      # @see #Command.run
-      # @param command [String] command(s) to run
-      # @return [Array, Hash] command_results the command results from shell
-      # [{ :output, :pid, :error, :start, :stop, :total_time, :exitstatus }]
-      def popen(command, timer=ShellTastic::Timer)
+      # @see #run
+      # @param command [String] command(s) to execute
+      # @param command [Array] command(s) to execute
+      # @param command [Time] time object for run time
+      # @return [Array] array of hash meta-data for the command(s) executed
+      def popen(command, timer)
         string_nil_or_blank?(command)
         command_results = {}
         begin

data/lib/shelltastic/exceptions.rb

@@ -1,4 +1,4 @@
 module ShellTastic
-  # @raise: Describes an Exception that a method may throw
+  # A command Exception
   class CommandException < RuntimeError; end
 end

data/lib/shelltastic/timer.rb

@@ -1,18 +1,21 @@
 module ShellTastic
-  module Timer
-    class << self
+  class Timer
+      def initialize
+
+      end
+
       # Creates a start time object
       # @param [nil] 
       # @return [Time] Time now object
       def start
-        @start = Time.now
+        @start_time = Time.now
       end
       
       # Creates a stop time object
       # @param [nil] 
       # @return [Time] Time now object
       def stop
-        @stop = Time.now
+        @stop_time = Time.now
       end
 
       # Calculates the total time elapsed
@@ -22,11 +25,10 @@ module ShellTastic
       # @return [Time] Time elapsed between #start and #stop
       def total_time(milliseconds = false)
         if milliseconds
-          (@stop - @start) * 1000.0
+          (@stop_time - @start_time) * 1000.0
         else
-          @stop - @start
+          @stop_time - @start_time
         end
       end
     end
   end
-end

data/lib/shelltastic/utils.rb

@@ -2,12 +2,12 @@ module ShellTastic
 
   module Utils
     # A dirty string check for nil empty or just whitespace
-    # @param [String] str the string the needs to be checked
+    # @param str [String] a string that needs to be checked
     # @return [Boolean, nil] true if str is empty, nil, or just whitespace
     def string_nil_or_blank? str
       # raise if command is empty or nil
       if str !~ /[^[:space:]]/ || str.nil? || str.empty?
-        raise ShellTastic::CommandException.new("Command is emtpy or nil")
+        raise ShellTastic::CommandException.new("The command is emtpy or nil")
       end
     end
 

data/lib/shelltastic/version.rb

@@ -1,3 +1,3 @@
-module Shelltastic
-  VERSION = "0.2.5"
+module ShellTastic
+  VERSION = "0.3.0"
 end

data/shelltastic.gemspec

@@ -5,11 +5,11 @@ require 'shelltastic/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "shelltastic"
-  gem.version       = Shelltastic::VERSION
-  gem.authors       = ["Brad Smith"]
+  gem.version       = ShellTastic::VERSION
+  gem.authors       = ["Bradley Smith"]
   gem.email         = ["bradleydsmith@gmail.com"]
-  gem.description   = %q{Shelltastic is another *nix shell wrapper}
-  gem.summary       = %q{*nix shell wrapper}
+  gem.description   = %q{Shelltastic is a simple *nix shell wrapper}
+  gem.summary       = %q{Shelltastic is a simple *nix shell wrapper}
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($/)

data/spec/shelltastic_spec.rb

@@ -26,7 +26,7 @@ describe ShellTastic do
   it "should alert if command is empty or nil" do
     expect {
       ShellTastic::Command.run("")
-    }.to raise_error("Command is emtpy or nil")
+    }.to raise_error("The command is emtpy or nil")
   end
 
 end

data/spec/timer_spec.rb

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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: shelltastic
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
-- Brad Smith
+- Bradley Smith
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -59,7 +59,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Shelltastic is another *nix shell wrapper
+description: Shelltastic is a simple *nix shell wrapper
 email:
 - bradleydsmith@gmail.com
 executables: []
@@ -98,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3694164165919668282
+      hash: 375658513519469739
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -107,13 +107,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3694164165919668282
+      hash: 375658513519469739
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ! '*nix shell wrapper'
+summary: Shelltastic is a simple *nix shell wrapper
 test_files:
 - spec/shelltastic_spec.rb
 - spec/spec_helper.rb