shelltastic 0.2.5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## Changelog
+* Add multiple command arguments.  Bump Version 0.2.5
+* Change Open4 back to popen4.  Update README.  Bump minor version 0.2.3
+* Bump version 0.2.2. Move timer object out of IO#popen; inject object insteadMove #string_nil_or_blank? to utils module.  Now extend this module in IO.
+* Bump version to 0.1.2 for bug fix
+* Fix syntax error in timer
+* Add rake console and fix yard doc
+* Add string check for command and clean up readme
+* Add yard markdown docs
+* Add summary to gemspec
+* Add deps to gemfile spec
+* Add timer test
+* Add run to Command
+* Initial commit

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shelltastic.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brad Smith
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Shelltastic
+Shelltastic is simple *nix shell wrapper for ruby.  You can pass a single command or multiple commands to run.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shelltastic'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shelltastic
+
+## Usage
+
+ ```ruby
+ShellTastic::Command.run("date")
+```
+
+The above will return an Array of hash meta-data.
+
+```ruby 
+[{ :output, :pid, :error, :start, :stop, :total_time, :exitstatus }]
+```
+
+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=>"", :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.
+
+```ruby
+ShellTastic::Command.run("date", "whoami")
+```
+
+```ruby
+ShellTastic::Command.run(["date", "whoami"])
+```
+
+```ruby
+[{:output=>"Sat Apr  6 15:26:05 EDT 2013", :pid=>92558, :error=>"", :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=>"", :start=>2013-04-06 15:26:05 -0400, :stop=>2013-04-06 15:26:05 -0400, :command=>"whoami", :total_time=>0.008262, :exitstatus=>0}]
+```
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -Ilib -r shelltastic"
+end
+

data/lib/shelltastic/command_io.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'open4'
+
+module ShellTastic
+  class IO
+    extend ShellTastic::Utils
+    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)
+        string_nil_or_blank?(command)
+        command_results = {}
+        begin
+          start = timer.start
+          return_code = Open4::popen4(command) do |pid, stdin, stdout, stderr|
+                          command_results.store(:output,stdout.read.strip)
+                          command_results.store(:pid,pid)
+                          command_results.store(:error,stderr.read.strip)
+                          stdin.close
+                        end
+          stop = timer.stop
+          total_time = timer.total_time
+          command_results.merge!(start: start, 
+                                 stop: stop,
+                                 command: command,
+                                 total_time: total_time, 
+                                 exitstatus: return_code.exitstatus)
+        rescue Errno::ENOENT => e
+          raise ShellTastic::CommandException.new("Shell command #{command} failed with status #{$?} and ERROR: #{e.message}")
+        end
+        command_results
+      end
+    end
+  end
+
+
+end

data/lib/shelltastic/exceptions.rb

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

data/lib/shelltastic/timer.rb

@@ -0,0 +1,32 @@
+module ShellTastic
+  module Timer
+    class << self
+      # Creates a start time object
+      # @param [nil] 
+      # @return [Time] Time now object
+      def start
+        @start = Time.now
+      end
+      
+      # Creates a stop time object
+      # @param [nil] 
+      # @return [Time] Time now object
+      def stop
+        @stop = Time.now
+      end
+
+      # Calculates the total time elapsed
+      # @see #start and #stop
+      # @param [Hash, nil] opts the opts passed in
+      # @option [Boolean] milliseconds the time in milliseconds
+      # @return [Time] Time elapsed between #start and #stop
+      def total_time(milliseconds = false)
+        if milliseconds
+          (@stop - @start) * 1000.0
+        else
+          @stop - @start
+        end
+      end
+    end
+  end
+end

data/lib/shelltastic/utils.rb

@@ -0,0 +1,17 @@
+module ShellTastic
+
+  module Utils
+    # A dirty string check for nil empty or just whitespace
+    # @param [String] str the string the 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")
+      end
+    end
+
+
+  end
+
+end

data/lib/shelltastic/version.rb

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

data/lib/shelltastic.rb

@@ -0,0 +1,24 @@
+require_relative "shelltastic/version"
+require_relative "shelltastic/utils"
+require_relative "shelltastic/command_io"
+require_relative "shelltastic/timer"
+require_relative "shelltastic/exceptions"
+
+# @! ShellTastic 
+module ShellTastic
+  # Command is the namespace for the actual meat of the gem
+  class Command
+    class << self
+      # encapsualtes the popen call 
+      # @param command [String] command or 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"
+      def run(*command)
+        command.flatten.map { |cmd| ShellTastic::IO.popen(cmd, ShellTastic::Timer) }
+      end
+    end
+  end
+end

data/shelltastic.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shelltastic/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "shelltastic"
+  gem.version       = Shelltastic::VERSION
+  gem.authors       = ["Brad Smith"]
+  gem.email         = ["bradleydsmith@gmail.com"]
+  gem.description   = %q{Shelltastic is another *nix shell wrapper}
+  gem.summary       = %q{*nix shell wrapper}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('open4', '>= 1.3.0')
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/spec/shelltastic_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe ShellTastic do
+  it "should run a shell command" do
+    result = ShellTastic::Command.run("ls -l")
+    result.first.fetch(:exitstatus).should eq(0)
+  end
+
+  it "should run multiple commands" do
+    result = ShellTastic::Command.run("ls -l", "date")
+    result.size.should eq(2) 
+  end
+
+  it "should run take an array of commands to run" do
+    result = ShellTastic::Command.run(["ls -l", "date"])
+    result.size.should eq(2) 
+  end
+
+
+  it "should raise a command exception" do
+    expect {
+    result = ShellTastic::Command.run("lss -l")
+    }.to raise_error(ShellTastic::CommandException)
+  end
+
+  it "should alert if command is empty or nil" do
+    expect {
+      ShellTastic::Command.run("")
+    }.to raise_error("Command is emtpy or nil")
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+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
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/timer_spec.rb

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

data/tags

@@ -0,0 +1,23 @@
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
+!_TAG_PROGRAM_NAME	Exuberant Ctags	//
+!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
+!_TAG_PROGRAM_VERSION	5.9~svn20110310	//
+Command	lib/shelltastic.rb	/^  class Command$/;"	c	class:ShellTastic
+CommandException	lib/shelltastic/exceptions.rb	/^  class CommandException < RuntimeError; end$/;"	c	class:ShellTastic
+IO	lib/shelltastic/command_io.rb	/^  module IO$/;"	m	class:ShellTastic
+ShellTastic	lib/shelltastic.rb	/^module ShellTastic$/;"	m
+ShellTastic	lib/shelltastic/command_io.rb	/^module ShellTastic$/;"	m
+ShellTastic	lib/shelltastic/exceptions.rb	/^module ShellTastic$/;"	m
+ShellTastic	lib/shelltastic/timer.rb	/^module ShellTastic$/;"	m
+ShellTastic	lib/shelltastic/utils.rb	/^module ShellTastic$/;"	m
+Shelltastic	lib/shelltastic/version.rb	/^module Shelltastic$/;"	m
+Timer	lib/shelltastic/timer.rb	/^  module Timer$/;"	m	class:ShellTastic
+Utils	lib/shelltastic/utils.rb	/^  module Utils$/;"	m	class:ShellTastic
+popen	lib/shelltastic/command_io.rb	/^      def popen(command, timer=ShellTastic::Timer)$/;"	f	class:ShellTastic.IO
+run	lib/shelltastic.rb	/^      def run(command, *args)$/;"	f	class:ShellTastic.Command
+start	lib/shelltastic/timer.rb	/^      def start$/;"	f	class:ShellTastic.Timer
+stop	lib/shelltastic/timer.rb	/^      def stop$/;"	f	class:ShellTastic.Timer
+string_nil_or_blank?	lib/shelltastic/utils.rb	/^    def string_nil_or_blank? str$/;"	f	class:ShellTastic.Utils
+total_time	lib/shelltastic/timer.rb	/^      def total_time(milliseconds = false)$/;"	f	class:ShellTastic.Timer

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: shelltastic
+version: !ruby/object:Gem::Version
+  version: 0.2.5
+  prerelease: 
+platform: ruby
+authors:
+- Brad Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: open4
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Shelltastic is another *nix shell wrapper
+email:
+- bradleydsmith@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shelltastic.rb
+- lib/shelltastic/command_io.rb
+- lib/shelltastic/exceptions.rb
+- lib/shelltastic/timer.rb
+- lib/shelltastic/utils.rb
+- lib/shelltastic/version.rb
+- shelltastic.gemspec
+- spec/shelltastic_spec.rb
+- spec/spec_helper.rb
+- spec/timer_spec.rb
+- tags
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3694164165919668282
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3694164165919668282
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! '*nix shell wrapper'
+test_files:
+- spec/shelltastic_spec.rb
+- spec/spec_helper.rb
+- spec/timer_spec.rb