sheller 0.0.2 → 0.0.3

data/lib/sheller.rb

@@ -0,0 +1,65 @@
+require 'POpen4'
+
+module Sheller
+  VERSION = '0.0.3'
+  
+  INESCAPABLE = {}
+  
+  {
+    'STDOUT_TO_FILE'            => :>,
+    'STDOUT_TO_PIPE'            => :|,
+    'STDOUT_APPEND_TO_FILE'     => :>>,
+    'STDOUT_TO_STDERR'          => :'1>&2',
+    'STDERR_TO_FILE'            => :'2>',
+    'STDERR_TO_STDOUT'          => :'2>&1',
+    'STDERR_APPEND_TO_FILE'     => :'2>>',
+    'STDOUT_AND_STDERR_TO_FILE' => :'&>',
+    'STDIN_FROM_FILE'           => :<
+  }.each do |c, s|
+    const_set(c, s)
+    INESCAPABLE[s] = s.to_s
+  end
+  
+  SHELL_SAFE = /\A[0-9A-Za-z+,.\/:=@_-]+\z/
+  ARG_SCAN = /('+)|[^']+/
+  
+  class << self
+    def command(*args)
+      args.map { |a| arg_to_cmd(a) }.join(' ')
+    end
+    
+    def execute(*args)
+      stdout, stderr = nil
+      status = POpen4.popen4(command(*args)) do |_stdout, _stderr, _stdin, _pid|
+        stdout = _stdout.read
+        stderr = _stderr.read
+      end
+      ShellerResult.new(stdout, stderr, status)
+    end
+    
+    private
+    def arg_to_cmd(arg)
+      if INESCAPABLE[arg]
+        arg.to_s
+      elsif arg.empty? || SHELL_SAFE =~ arg
+        "'%s'" % arg
+      else
+        result = ''
+        arg.scan(ARG_SCAN) do
+          result << ($1 ? "\\'" * $1.length : "'#{$&}'")
+        end
+        result
+      end
+    end
+  end
+  
+  class ShellerResult
+    attr_reader 'stdout', 'stderr', 'exit_status'
+    
+    def initialize(stdout, stderr, exit_status)
+      @stdout = stdout
+      @stderr = stderr
+      @exit_status = exit_status
+    end
+  end
+end

data/test/fixtures/cities.txt

@@ -0,0 +1,4 @@
+Cork
+Dublin
+Louth
+Letterkenny

data/test/fixtures/stderr_frog

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+$stderr.puts "frog"

data/test/fixtures/stdout_stderr_puma

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+$stdout.puts "puma1"
+$stderr.puts "puma2"

data/test/fixtures/stdout_turtle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+$stdout.puts "turtle"

data/test/sheller_test.rb

@@ -0,0 +1,92 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class ShellerTest < Test::Unit::TestCase
+  TEST_DIR = File.expand_path(File.join(File.dirname(__FILE__)))
+  
+  def setup
+    @original_dir = Dir.pwd
+    Dir.chdir(TEST_DIR)
+  end
+  
+  def teardown
+    Dir.chdir(TEST_DIR) do
+      FileUtils.rm('output.txt', :force => true)
+    end
+    Dir.chdir(@original_dir)
+  end
+  
+  def test_command_no_arguments
+    assert_equal "turtle\n", Sheller.execute('./fixtures/stdout_turtle').stdout
+  end
+  
+  def test_command_one_argument
+    assert_equal "frog\n", Sheller.execute('echo', 'frog').stdout
+  end
+  
+  def test_command_one_argument_with_quotes
+    assert_equal "\"toad\"\n", Sheller.execute('echo', '"toad"').stdout
+  end
+  
+  def test_command_one_argument_with_redirect
+    assert_equal "toad > newt\n", Sheller.execute('echo', 'toad > newt').stdout
+  end
+  
+  def test_echo_to_stderr
+    assert_equal "frog\n", Sheller.execute('./fixtures/stderr_frog').stderr
+  end
+  
+  def test_successful_exit_status_code
+    assert_equal 0, Sheller.execute('echo').exit_status
+  end
+  
+  def test_unsuccessful_exit_status_code
+    assert_not_equal 0, Sheller.execute('false').exit_status
+  end
+  
+  def test_stdout_to_file
+    result = Sheller.execute('./fixtures/stdout_stderr_puma', Sheller::STDOUT_TO_FILE, 'output.txt')
+    assert_equal "puma1\n", File.read('output.txt')
+  end
+  
+  def test_stdout_to_pipe
+    result = Sheller.execute('./fixtures/stdout_stderr_puma', Sheller::STDOUT_TO_PIPE, 'grep', 'puma')
+    assert_equal "puma1\n", result.stdout
+  end
+  
+  def test_stdout_append_to_file
+    File.open('output.txt', 'w') { |f| f.puts "jungle" }
+    Sheller.execute('./fixtures/stdout_stderr_puma', Sheller::STDOUT_APPEND_TO_FILE, 'output.txt')
+    assert_equal "jungle\npuma1\n", File.read('output.txt')
+  end
+  
+  def test_stdout_to_stderr
+    result = Sheller.execute('./fixtures/stdout_stderr_puma', Sheller::STDOUT_TO_STDERR)
+    assert_equal "puma2\npuma1\n", result.stderr
+  end
+  
+  def test_stderr_to_file
+    Sheller.execute('./fixtures/stdout_stderr_puma', Sheller::STDERR_TO_FILE, 'output.txt')
+    assert_equal "puma2\n", File.read('output.txt')
+  end
+  
+  def test_stderr_to_stdout
+    result = Sheller.execute('./fixtures/stdout_stderr_puma', Sheller::STDERR_TO_STDOUT)
+    assert_equal "puma2\npuma1\n", result.stdout
+  end
+  
+  def test_stderr_append_to_file
+    File.open('output.txt', 'w') { |f| f.puts "jungle" }
+    Sheller.execute('./fixtures/stdout_stderr_puma', Sheller::STDERR_APPEND_TO_FILE, 'output.txt')
+    assert_equal "jungle\npuma2\n", File.read('output.txt')
+  end
+  
+  def test_stdout_and_stderr_to_file
+    Sheller.execute('./fixtures/stdout_stderr_puma', Sheller::STDOUT_AND_STDERR_TO_FILE, 'output.txt')
+    assert_equal "puma2\npuma1\n", File.read('output.txt')
+  end
+  
+  def test_stdin_from_file
+    result = Sheller.execute('grep', 'Dublin', Sheller::STDIN_FROM_FILE, './fixtures/cities.txt')
+    assert_equal "Dublin\n", result.stdout
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'test/unit'
+require 'fileutils'
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+
+require 'sheller'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sheller
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Duncan Beevers
@@ -42,8 +42,14 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- lib/sheller.rb
+- test/fixtures/cities.txt
+- test/fixtures/stderr_frog
+- test/fixtures/stdout_stderr_puma
+- test/fixtures/stdout_turtle
+- test/sheller_test.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/duncanbeevers/sheller
 licenses: []