magritte 0.5.6 → 0.5.7

data/spec/line_buffer_spec.rb

@@ -0,0 +1,52 @@
+require 'magritte/line_buffer'
+
+describe Magritte::LineBuffer do
+  let(:buffer) { Magritte::LineBuffer.new }
+
+  context 'when writing' do
+    it 'returns 0 when no line separators were written' do
+      buffer.write("asdf").should == 0
+    end
+
+    it 'returns the number bytes written including the last record separator' do
+      buffer.write("asdf\nfi").should == 5
+    end
+
+    it 'handles more than one line at a time' do
+      buffer.write("asdf\nasdf\nfi").should == 10
+    end
+  end
+
+  context 'when reading' do
+    it 'only returns data that ends with a record separator - no partial records' do
+      buffer.write("asdf\nasdf\nfi")
+      buffer.buffer.should == "asdf\nasdf\n"
+    end
+  end
+
+  context 'when iterating' do
+    it 'returns each line one at a time' do
+      buffer.write("asdf\nasdf\n")
+      buffer.should have(2).items
+    end
+
+    it 'does not return partial lines' do
+      buffer.write("asdf\nasdf\nfi")
+      buffer.map {|x| x}.should == %w{ asdf asdf }
+    end
+
+    it 'clears the buffer once it has been iterated' do
+      buffer.write("asdf\nasdf\nfi")
+
+      buffer.map {|x| x}
+      buffer.should have(0).items
+    end
+
+    it 'supports arbitrary record separators' do
+      buffer = Magritte::LineBuffer.new("\r\n")
+      buffer.write("asdf\r\nasdf\r\nasdf\r\n")
+      
+      buffer.map {|x| x}.should == %w{ asdf asdf asdf }
+    end
+  end
+end

data/spec/pipe_spec.rb

@@ -0,0 +1,100 @@
+require 'magritte/pipe'
+require 'stringio'
+
+describe 'Magritte::Pipe' do
+  let(:infile)   { File.join(File.dirname(__FILE__), 'fixtures/prisoner_of_zenda.txt') }
+  let(:output)   { StringIO.new }
+  let(:no_input) { File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', 'no_input.rb')) }
+
+  context 'handling input' do
+    it 'opens a file when passed a filename' do
+      File.should_receive(:open).with(infile)
+
+      Magritte::Pipe.from_input_file(infile)
+    end
+
+    it 'creates a BlockStream' do
+      Magritte::BlockStream.should_receive(:new)
+
+      Magritte::Pipe.from_input_stream(StringIO.new)
+    end
+
+    it 'wraps a string in a StringIO' do
+      mock_stringio = mock('stringio')
+      StringIO.should_receive(:new).and_return(mock_stringio)
+      Magritte::BlockStream.should_receive(:new).with(mock_stringio)
+
+      Magritte::Pipe.from_input_string('asdf')
+    end
+
+    it 'handles nil input strings' do
+      expect { Magritte::Pipe.from_input_string(nil).out_to { |x| x.size }.filtering_with('cat') }.not_to raise_error
+    end
+  end
+
+  context 'handling output' do
+    it 'raises when no output has been set' do
+      expect { Magritte::Pipe.from_input_file(infile).filtering_with('cat') }.to \
+        raise_error(RuntimeError)
+    end
+
+    it 'calls a block for output when out_to is passed one' do
+      buffer = ""
+      input = "12345\n67890"
+      Magritte::Pipe.from_input_string(input).out_to { |p| buffer += p; p.size }.filtering_with('cat')
+
+      buffer.should == input
+    end
+
+    it 'raises when the output Proc does not return a size value' do
+      expect { Magritte::Pipe.from_input_file(infile).out_to { |p| nil }.filtering_with('cat') }.to \
+        raise_error('output block must return number of bytes written!')
+    end
+
+    it 'handles line-by-line output blocks' do
+      buffer = []
+      Magritte::Pipe.from_input_string("1234\n56789\n")
+        .line_by_line
+        .out_to { |p| buffer << p }.filtering_with('cat')
+
+      buffer.should == %w{ 1234 56789 }
+    end
+  end
+
+  context 'processing data' do
+    it 'raises when the sub-process exits inappropriately' do
+      expect { Magritte::Pipe.from_input_file(infile).out_to(output).filtering_with('bash -c "exit 1"') }.to \
+        raise_error(Errno::EPIPE)
+    end
+
+    it 'raises when the sub-process cannot receive data' do
+      expect { Magritte::Pipe.from_input_file(infile).out_to(output).filtering_with(no_input) }.to \
+        raise_error(Errno::EPIPE)
+    end
+
+    it 'sends all input to the sub-process and out to the output stream' do
+      Magritte::Pipe.from_input_file(infile).out_to(output).filtering_with('cat')
+      output.string.split(/\n/).should have(6737).items
+    end
+
+    it 'correctly handles sub-processes that buffer heavily' do
+      Magritte::Pipe.from_input_file(infile).out_to(output).filtering_with('sort')
+      output.string.split(/\n/).should have(6737).items
+    end
+
+    it 'processes the data without any artifacts or other junk added to the stream' do
+      Magritte::Pipe.from_input_file(infile).out_to(output).filtering_with('cat')
+      output.string.should == File.read(infile)
+    end
+  end
+
+  it 'recovers when the end of the file was not a record separator' do
+    pending 'this not yet implemented'
+    buffer = []
+    Magritte::Pipe.from_input_string("1234\n56789")
+      .line_by_line
+      .out_to { |p| buffer << p }.filtering_with('cat')
+
+    buffer.should == %w{ 1234 56789 }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magritte
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-21 00:00:00.000000000 Z
+date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70306428054220 !ruby/object:Gem::Requirement
+  requirement: &2152647480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70306428054220
+  version_requirements: *2152647480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70306428053460 !ruby/object:Gem::Requirement
+  requirement: &2152640880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *70306428053460
+  version_requirements: *2152640880
 description: ! '  Magritte is a simple but powerful wrapper to Open3 pipes that makes
   it easy to handle two-way piping of data into and out of a sub-process. Various
   input IO wrappers are supported and output can either be to an IO or to a block.
@@ -45,13 +45,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- lib/magritte.rb
 - lib/magritte/iostreams.rb
 - lib/magritte/line_buffer.rb
 - lib/magritte/pipe.rb
-- lib/magritte.rb
-- README.md
-- LICENSE
-homepage: http://github.com/mydrive/magritte
+- spec/fixtures/no_input.rb
+- spec/fixtures/prisoner_of_zenda.txt
+- spec/line_buffer_spec.rb
+- spec/pipe_spec.rb
+homepage: https://github.com/mydrive/magritte
 licenses: []
 post_install_message: 
 rdoc_options: []