rubysh 0.0.1

data/test/unit/lib/rubysh/subprocess/parallel_io.rb

@@ -0,0 +1,233 @@
+require File.expand_path('../../../_lib', File.dirname(__FILE__))
+
+module RubyshTest::Unit
+  class ParallelIOTest < UnitTest
+    describe 'when given no readers / writers' do
+      it 'returns immediately from run' do
+        io = Rubysh::Subprocess::ParallelIO.new({}, {})
+        io.run
+      end
+    end
+
+    describe 'when given only readers' do
+      it 'makes callbacks as data is read' do
+        reader, writer = IO.pipe
+        writer.write('hi')
+
+        count = 0
+
+        io = Rubysh::Subprocess::ParallelIO.new({reader => :reader}, {})
+        io.on_read do |reader_name, data|
+          count += 1
+
+          case count
+          when 1
+            assert_equal('hi', data)
+            writer.write('bye')
+          when 2
+            assert_equal('bye', data)
+            writer.write('done')
+          when 3
+            assert_equal('done', data)
+            writer.close
+          when 4
+            assert_equal(Rubysh::Subprocess::ParallelIO::EOF, data)
+          else
+            assert(false)
+          end
+        end
+        io.run
+        assert_equal(4, count)
+      end
+
+      it 'uses the reader name when data is read' do
+        reader, writer = IO.pipe
+        writer.write('hi')
+
+        io = Rubysh::Subprocess::ParallelIO.new({reader => :reader}, {})
+        io.on_read do |reader_name, data|
+          assert_equal(:reader, reader_name)
+          writer.close unless writer.closed?
+        end
+        io.run
+      end
+    end
+
+    describe 'when given only writers' do
+      it 'makes callbacks as data is written' do
+        reader, writer = IO.pipe
+
+        count = 0
+
+        io = Rubysh::Subprocess::ParallelIO.new({}, {writer => :writer})
+        io.on_write do |writer_name, data, remaining|
+          count += 1
+
+          case count
+          when 1
+            assert_equal('hi', data)
+            assert_equal('', remaining)
+            io.write(:writer, 'bye', false)
+          when 2
+            assert_equal('bye', data)
+            assert_equal('', remaining)
+            io.write(:writer, 'done', false)
+          when 3
+            assert_equal('done', data)
+            assert_equal('', remaining)
+            io.write(:writer, '', true)
+          when 4
+            assert_equal(Rubysh::Subprocess::ParallelIO::EOF, data)
+            assert_equal('', remaining)
+          else
+            assert(false)
+          end
+        end
+        io.write(:writer, 'hi', false)
+        io.run
+
+        assert_equal(4, count)
+        received = reader.read
+        assert_equal('hibyedone', received)
+      end
+
+      it 'uses the writer name when data is written' do
+        reader, writer = IO.pipe
+
+        io = Rubysh::Subprocess::ParallelIO.new({}, {writer => :writer})
+        io.on_write do |writer_name, data|
+          assert_equal(:writer, writer_name)
+        end
+        io.run
+      end
+
+      it 'splits up data if it cannot all be written at once' do
+        reader, writer = IO.pipe
+
+        io = Rubysh::Subprocess::ParallelIO.new({}, {writer => :writer})
+        io.on_write do |writer_name, data, remaining|
+          unless data == Rubysh::Subprocess::ParallelIO::EOF
+            assert(remaining.length > 0)
+            assert(data.length > 0)
+            writer.close
+          end
+        end
+        io.write(:writer, '*' * 100000, false)
+        io.run
+      end
+
+      it 'actually writes the correct data if it cannot all be written at once' do
+        reader, writer = IO.pipe
+        input = '*' * 100000
+        received = ''
+
+        io = Rubysh::Subprocess::ParallelIO.new({}, {writer => :writer})
+        io.on_write do |writer_name, data, remaining|
+          unless data == Rubysh::Subprocess::ParallelIO::EOF
+            received << reader.read_nonblock(100000)
+          end
+        end
+        io.write(:writer, input, true)
+        io.run
+
+        assert_equal(input, received)
+      end
+    end
+
+    describe 'when given both writers and readers' do
+      it 'correctly reads and writes data' do
+        reader1, writer1 = IO.pipe
+        reader2, writer2 = IO.pipe
+
+        count1 = 0
+        count2 = 0
+
+        io = Rubysh::Subprocess::ParallelIO.new(
+          {reader1 => :reader1, reader2 => :reader2},
+          {writer1 => :writer1, writer2 => :writer2})
+
+        io.on_read do |reader_name, data|
+          if reader_name == :reader1
+            count1 += 1
+            case count1
+            when 2
+              assert_equal('hi1', data)
+              io.write(:writer1, 'test1', false)
+            when 4
+              assert_equal('test1', data)
+              io.write(:writer1, 'final1', true)
+            when 7
+              assert_equal('final1', data)
+            when 8
+              assert_equal(Rubysh::Subprocess::ParallelIO::EOF, data)
+            else
+              raise "Unexpected count1: #{count1}"
+            end
+          elsif reader_name == :reader2
+            count2 += 1
+            case count2
+            when 2
+              assert_equal('hi2', data)
+              io.write(:writer2, 'test2', false)
+            when 4
+              assert_equal('test2', data)
+              io.write(:writer2, 'final2', true)
+            when 7
+              assert_equal('final2', data)
+            when 8
+              assert_equal(Rubysh::Subprocess::ParallelIO::EOF, data)
+            else
+              raise "Unexpected count2: #{count2}"
+            end
+          else
+            raise "Unrecognized reader"
+          end
+        end
+
+        io.on_write do |writer_name, data, remaining|
+          if writer_name == :writer1
+            count1 += 1
+
+            case count1
+            when 1
+              assert_equal('hi1', data)
+            when 3
+              assert_equal('test1', data)
+            when 5
+              assert_equal('final1', data)
+            when 6
+              assert_equal(Rubysh::Subprocess::ParallelIO::EOF, data)
+            else
+              raise "Unexpected count1: #{count1}"
+            end
+          elsif writer_name == :writer2
+            count2 += 1
+
+            case count2
+            when 1
+              assert_equal('hi2', data)
+            when 3
+              assert_equal('test2', data)
+            when 5
+              assert_equal('final2', data)
+            when 6
+              assert_equal(Rubysh::Subprocess::ParallelIO::EOF, data)
+            else
+              raise "Unexpected count2: #{count2}"
+            end
+          else
+            raise "Unrecognized writer"
+          end
+        end
+
+        io.write(:writer1, 'hi1', false)
+        io.write(:writer2, 'hi2', false)
+
+        io.run
+
+        assert_equal(8, count1)
+        assert_equal(8, count2)
+      end
+    end
+  end
+end

data/test/unit/lib/rubysh/subprocess.rb

@@ -0,0 +1,37 @@
+require File.expand_path('../../_lib', File.dirname(__FILE__))
+
+module RubyshTest::Unit
+  class SubprocessTest < UnitTest
+    describe 'when running a command' do
+      it 'calls exec with the expected arguments' do
+        read_fd, write_fd = stub_pipe
+        Kernel.expects(:exec).with(['cmd', 'cmd'], 'arg1', 'arg2')
+
+        proc = Rubysh::Subprocess.new(['cmd', 'arg1', 'arg2'])
+        proc.send(:open_exec_status)
+        assert_raises(Rubysh::Error::UnreachableError) do
+          proc.send(:do_run_child)
+        end
+      end
+
+      describe 'with a Redirect' do
+        it 'calls exec with the expected arguments' do
+          runner = mock
+
+          read_fd, write_fd = stub_pipe
+          Kernel.expects(:exec).with(['cmd', 'cmd'], 'arg1', 'arg2')
+
+          redirect = Rubysh::Redirect.new(2, '>', 1)
+          redirect.expects(:apply!).with(runner)
+
+          proc = Rubysh::Subprocess.new(['cmd', 'arg1', 'arg2'],
+            [redirect], [], runner)
+          proc.send(:open_exec_status)
+          assert_raises(Rubysh::Error::UnreachableError) do
+            proc.send(:do_run_child)
+          end
+        end
+      end
+    end
+  end
+end

data/test/unit/lib/rubysh.rb

@@ -0,0 +1,74 @@
+require File.expand_path('../_lib', File.dirname(__FILE__))
+
+module RubyshTest::Unit
+  class RubyshTest < UnitTest
+    describe 'when running a command' do
+      # Rubysh('ls', '/tmp')
+      describe 'that is straightline' do
+        it 'prints nicely' do
+          command = Rubysh('ls', '/tmp')
+          expected = 'Command: ls /tmp'
+          assert_equal(expected, command.to_s)
+        end
+
+        it 'creates a command with the expected arguments' do
+          command = Rubysh('ls', '/tmp')
+          runner = Rubysh::Runner.new(command)
+          command.send(:prepare_subprocess, runner)
+          subprocess = runner.state(command)[:subprocess]
+          assert_equal('ls', subprocess.command)
+          assert_equal(['/tmp'], subprocess.args)
+          assert_equal([], subprocess.directives)
+        end
+      end
+
+      # Rubysh('ls', '/tmp') | Rubysh('grep', 'myfile')
+      describe 'with a pipe' do
+        it 'prints nicely' do
+          command = Rubysh('ls', '/tmp') | Rubysh('grep', 'myfile')
+          expected = 'Command: ls /tmp | grep myfile'
+          assert_equal(expected, command.to_s)
+        end
+
+        it 'creates a command with the expected arguments' do
+          read_fd, write_fd = stub_pipe
+          command = Rubysh('ls', '/tmp') | Rubysh('grep', 'myfile')
+
+          pipeline = command.pipeline
+          assert_equal(2, pipeline.length)
+
+          runner = Rubysh::Runner.new(command)
+
+          left, right = pipeline
+          left.send(:prepare_subprocess, runner)
+          right.send(:prepare_subprocess, runner)
+
+          left_subprocess = runner.state(left)[:subprocess]
+          right_subprocess = runner.state(right)[:subprocess]
+
+          assert_equal([], left_subprocess.directives)
+          assert_equal([], right_subprocess.directives)
+        end
+      end
+
+      # Rubysh('ls', '/tmp', Rubysh.stderr > Rubysh.stdout)
+      describe 'with a redirection to another file descriptor' do
+        it 'prints nicely' do
+          command = Rubysh('ls', '/tmp', Rubysh.stderr > Rubysh.stdout)
+          expected = 'Command: ls /tmp 2>&1'
+          assert_equal(expected, command.to_s)
+        end
+
+        it 'creates a command with the expected arguments' do
+          command = Rubysh('ls', '/tmp', Rubysh.stderr > Rubysh.stdout)
+          runner = Rubysh::Runner.new(command)
+          command.send(:prepare_subprocess, runner)
+          subprocess = runner.state(command)[:subprocess]
+          assert_equal('ls', subprocess.command)
+          assert_equal(['/tmp'], subprocess.args)
+          assert_equal([Rubysh::Redirect.new(Rubysh::FD.new(2), '>', Rubysh::FD.new(1))], subprocess.directives)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification 
+name: rubysh
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Greg Brockman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 3
+        - 1
+        - 0
+        version: 3.1.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: "Rubysh: Ruby subprocesses made easy"
+email: 
+- gdb@gregbrockman.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rubysh.rb
+- lib/rubysh/base_command.rb
+- lib/rubysh/base_directive.rb
+- lib/rubysh/command.rb
+- lib/rubysh/error.rb
+- lib/rubysh/fd.rb
+- lib/rubysh/pipe.rb
+- lib/rubysh/pipeline.rb
+- lib/rubysh/redirect.rb
+- lib/rubysh/runner.rb
+- lib/rubysh/subprocess.rb
+- lib/rubysh/subprocess/parallel_io.rb
+- lib/rubysh/subprocess/pipe_wrapper.rb
+- lib/rubysh/triple_less_than.rb
+- lib/rubysh/util.rb
+- lib/rubysh/version.rb
+- rubysh.gemspec
+- test/_lib.rb
+- test/functional/_lib.rb
+- test/functional/lib/fd-lister
+- test/functional/lib/leaked_fds.rb
+- test/functional/lib/redirect_ordering.rb
+- test/functional/lib/triple_less_than.rb
+- test/integration/_lib.rb
+- test/integration/lib/rubysh.rb
+- test/rubysh
+- test/unit/_lib.rb
+- test/unit/lib/rubysh.rb
+- test/unit/lib/rubysh/command.rb
+- test/unit/lib/rubysh/pipeline.rb
+- test/unit/lib/rubysh/redirect.rb
+- test/unit/lib/rubysh/runner.rb
+- test/unit/lib/rubysh/subprocess.rb
+- test/unit/lib/rubysh/subprocess/parallel_io.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: "Rubysh makes shelling out easy with a __sh__-like syntax layer for Ruby:  irb -r rubysh >> command = Rubysh('echo', 'hello-from-Rubysh') | Rubysh('grep', '--color', 'Rubysh') >> command.run hello-from-Rubysh => Rubysh::Runner: echo hello-from-Rubysh | grep --color Rubysh (exitstatus: 0)"
+test_files: 
+- test/_lib.rb
+- test/functional/_lib.rb
+- test/functional/lib/fd-lister
+- test/functional/lib/leaked_fds.rb
+- test/functional/lib/redirect_ordering.rb
+- test/functional/lib/triple_less_than.rb
+- test/integration/_lib.rb
+- test/integration/lib/rubysh.rb
+- test/rubysh
+- test/unit/_lib.rb
+- test/unit/lib/rubysh.rb
+- test/unit/lib/rubysh/command.rb
+- test/unit/lib/rubysh/pipeline.rb
+- test/unit/lib/rubysh/redirect.rb
+- test/unit/lib/rubysh/runner.rb
+- test/unit/lib/rubysh/subprocess.rb
+- test/unit/lib/rubysh/subprocess/parallel_io.rb