infopark-user_io 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 788fbbd5a3940295bcdce71286f3cd3ffc1dba49
-  data.tar.gz: 9147dc314df032cb8cb9b0c461a6d374d9620597
+  metadata.gz: 4a723c208d08faafcf16ab1a69f3d1a0258626a2
+  data.tar.gz: 18a653156ce1b8bbbcff53bdc7808924951d813a
 SHA512:
-  metadata.gz: f8400ac9352308270eb09c367836eac8417101398b43712837494fe81612cc12a84ad4426ec692803c270b61134c26a3b1797128b4abb06dbba2203458732110
-  data.tar.gz: 07c1a06cdcfec38ec4d6fc7c98f63221c33941ca7f9335da98abc083fadb32ce0bb6c141e6451d4f6858fb9c7979053d607b7e7845f9d941b3e68d1991ca28d7
+  metadata.gz: f8d775c13cdca54d5dcfaf57fea54c6c7384df57297a48025548ef4209ebfc7c4e2b1bf0e6020a4a2e121eb471137973b4612de0d33bcea57585eb9fb954ab8f
+  data.tar.gz: e9977f5ff38901242d98fe5c84ef2ee18c321c8bf1d20d6d6d21d8ad5741dda401c045d1a0f82df15d508ad0528ea42a48b1e88c80cfda89bb843219e0528fb9

data/lib/infopark/user_io.rb

@@ -65,6 +65,25 @@ class UserIO
     tell_line(lines.last, newline: newline, **line_options)
   end
 
+  def tell_pty_stream(stream, **color_options)
+    color_prefix, color_postfix = compute_color(**color_options)
+    write_raw(output_prefix) unless line_pending?
+    write_raw(color_prefix)
+    nl_pending = false
+    uncolored_prefix = "#{color_postfix}#{output_prefix}#{color_prefix}"
+    until stream.eof?
+      chunk = stream.read_nonblock(100)
+      next if chunk.empty?
+      write_raw("\n#{uncolored_prefix}") if nl_pending
+      chunk.chop! if nl_pending = chunk.end_with?("\n")
+      chunk.gsub!(/([\r\n])/, "\\1#{uncolored_prefix}")
+      write_raw(chunk)
+    end
+    write_raw("\n") if nl_pending
+    write_raw(color_postfix)
+    line_pending!(false)
+  end
+
   def warn(*text)
     tell(*text, color: :yellow, bright: true)
   end
@@ -119,14 +138,14 @@ class UserIO
 
   def background_other_threads
     unless @foreground_thread
-      @background_lines = []
+      @background_data = []
       @foreground_thread = Thread.current
     end
   end
 
   def foreground
     if @foreground_thread
-      @background_lines.each(&STDOUT.method(:write))
+      @background_data.each(&STDOUT.method(:write))
       @foreground_thread = nil
       # take over line_pending from background
       @line_pending[false] = @line_pending[true]
@@ -223,22 +242,39 @@ class UserIO
   end
 
   def tell_line(line, newline: true, prefix: true, **color_options)
-    if tty?
-      if line_prefix = text_color(**color_options)
-        line_postfix = text_color(color: :none, bright: false)
-      end
-    end
-
-    prefix = false if @line_pending[background?]
+    line_prefix, line_postfix = compute_color(**color_options)
+    prefix = false if line_pending?
 
     out_line = "#{output_prefix if prefix}#{line_prefix}#{line}#{line_postfix}#{"\n" if newline}"
+    write_raw(out_line)
+
+    line_pending!(!newline)
+  end
+
+  def write_raw(bytes)
     if background?
-      @background_lines << out_line
+      @background_data << bytes
     else
-      STDOUT.write(out_line)
+      STDOUT.write(bytes)
     end
+  end
 
-    @line_pending[background?] = !newline
+  def line_pending?
+    @line_pending[background?]
+  end
+
+  def line_pending!(value)
+    @line_pending[background?] = value
+  end
+
+  def compute_color(**options)
+    if tty?
+      if prefix = text_color(**options)
+        # TODO matching annihilators for options
+        postfix = text_color(color: :none, bright: false)
+      end
+    end
+    [prefix, postfix]
   end
 
   def control_sequence(*parameters, function)

data/lib/infopark/user_io/version.rb

@@ -1,5 +1,5 @@
 module Infopark
   class UserIO
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/spec/user_io_spec.rb

@@ -130,4 +130,224 @@ RSpec.describe ::Infopark::UserIO do
       end
     end
   end
+
+  describe "#tell_pty_stream" do
+    let(:color_options) { {} }
+    let(:stream) { instance_double(IO) }
+    let(:data) { "test data" }
+
+    subject(:tell) { user_io.tell_pty_stream(stream, **color_options) }
+
+    before do
+      chunks = Array(data)
+      allow(stream).to receive(:eof?).and_return(*[false] * chunks.size, true)
+      allow(stream).to receive(:read_nonblock).and_return(*chunks)
+      RSpec::Mocks.space.proxy_for($stdout).reset
+      allow($stdout).to receive(:write).with(nil)
+    end
+
+    it "tells all data from stream in non blocking chunks" do
+      expect(stream).to receive(:eof?).and_return(false, false, false, true)
+      expect(stream).to receive(:read_nonblock).with(100).
+          and_return("first\nchunk", "second chunk", "\nlast chunk")
+      expect($stdout).to receive(:write).with("first\nchunk")
+      expect($stdout).to receive(:write).with("second chunk")
+      expect($stdout).to receive(:write).with("\nlast chunk")
+      tell
+    end
+
+    context "with color" do
+      let(:color_options) { {color: :yellow} }
+
+      it "colorizes the output" do
+        expect($stdout).to receive(:write).with("\e[33m").ordered
+        expect($stdout).to receive(:write).with("test data").ordered
+        expect($stdout).to receive(:write).with("\e[22;39m").ordered
+        tell
+      end
+    end
+
+    context "with output_prefix" do
+      let(:options) { {output_prefix: "the prefix"} }
+
+      it "prefixes the output" do
+        expect($stdout).to receive(:write).with("[the prefix] ").ordered
+        expect($stdout).to receive(:write).with("test data").ordered
+        tell
+      end
+
+      context "with color" do
+        let(:color_options) { {color: :yellow} }
+
+        it "does not colorize the prefix" do
+          expect($stdout).to receive(:write).with("[the prefix] ").ordered
+          expect($stdout).to receive(:write).with("\e[33m").ordered
+          expect($stdout).to receive(:write).with("test data").ordered
+          expect($stdout).to receive(:write).with("\e[22;39m").ordered
+          tell
+        end
+      end
+
+      context "when stream contains carriage return" do
+        let(:data) { "some\rdata\rwith\rCRs" }
+
+        it "writes the prefix right after the CR" do
+          expect($stdout).to receive(:write).with("[the prefix] ").ordered
+          expect($stdout).to receive(:write).
+              with("some\r[the prefix] data\r[the prefix] with\r[the prefix] CRs").ordered
+          tell
+        end
+
+        context "with color" do
+          let(:color_options) { {color: :yellow} }
+
+          it "uncolorizes the prefix" do
+            expect($stdout).to receive(:write).with("[the prefix] ").ordered
+            expect($stdout).to receive(:write).with("\e[33m").ordered
+            expect($stdout).to receive(:write).with(
+              "some\r"\
+              "\e[22;39m" "[the prefix] " "\e[33m" "data\r"\
+              "\e[22;39m" "[the prefix] " "\e[33m" "with\r"\
+              "\e[22;39m" "[the prefix] " "\e[33m" "CRs"
+            ).ordered
+            expect($stdout).to receive(:write).with("\e[22;39m").ordered
+            tell
+          end
+        end
+      end
+
+      context "when stream contains newline" do
+        let(:data) { "some\ndata\nwith\nNLs" }
+
+        it "writes the prefix right after the NL" do
+          expect($stdout).to receive(:write).with("[the prefix] ").ordered
+          expect($stdout).to receive(:write).
+              with("some\n[the prefix] data\n[the prefix] with\n[the prefix] NLs")
+          tell
+        end
+
+        context "with color" do
+          let(:color_options) { {color: :yellow} }
+
+          it "uncolorizes the prefix" do
+            expect($stdout).to receive(:write).with("[the prefix] ").ordered
+            expect($stdout).to receive(:write).with("\e[33m").ordered
+            expect($stdout).to receive(:write).with(
+              "some\n"\
+              "\e[22;39m" "[the prefix] " "\e[33m" "data\n"\
+              "\e[22;39m" "[the prefix] " "\e[33m" "with\n"\
+              "\e[22;39m" "[the prefix] " "\e[33m" "NLs"
+            ).ordered
+            expect($stdout).to receive(:write).with("\e[22;39m").ordered
+            tell
+          end
+        end
+
+        context "when stream ends with newline" do
+          # includes an empty chunk to verify, that they don't consume the pending NL
+          let(:data) { ["some\n", "data\n", "with\n", "", "NLs\n", ""] }
+
+          it "does not write prefix after the last newline" do
+            expect($stdout).to receive(:write).with("[the prefix] ").ordered
+            expect($stdout).to receive(:write).with("some").ordered
+            expect($stdout).to receive(:write).with("\n" "[the prefix] ").ordered
+            expect($stdout).to receive(:write).with("data").ordered
+            expect($stdout).to receive(:write).with("\n" "[the prefix] ").ordered
+            expect($stdout).to receive(:write).with("with").ordered
+            expect($stdout).to receive(:write).with("\n" "[the prefix] ").ordered
+            expect($stdout).to receive(:write).with("NLs").ordered
+            expect($stdout).to receive(:write).with("\n").ordered
+            tell
+          end
+
+          context "with color" do
+            let(:color_options) { {color: :yellow} }
+
+            it "uncolorizes the prefix" do
+              expect($stdout).to receive(:write).with("[the prefix] ").ordered
+              expect($stdout).to receive(:write).with("\e[33m").ordered
+              expect($stdout).to receive(:write).with("some").ordered
+              expect($stdout).to receive(:write).
+                  with("\n" "\e[22;39m" "[the prefix] " "\e[33m").ordered
+              expect($stdout).to receive(:write).with("data").ordered
+              expect($stdout).to receive(:write).
+                  with("\n" "\e[22;39m" "[the prefix] " "\e[33m").ordered
+              expect($stdout).to receive(:write).with("with").ordered
+              expect($stdout).to receive(:write).
+                  with("\n" "\e[22;39m" "[the prefix] " "\e[33m").ordered
+              expect($stdout).to receive(:write).with("NLs").ordered
+              expect($stdout).to receive(:write).with("\n").ordered
+              expect($stdout).to receive(:write).with("\e[22;39m").ordered
+              tell
+            end
+          end
+        end
+      end
+
+      context "when data does not end with newline" do
+        let(:data) { "foo" }
+
+        it "writes prefix on next output nevertheless" do
+          expect($stdout).to receive(:write).with("[the prefix] ").ordered
+          expect($stdout).to receive(:write).with("foo").ordered
+          tell
+          expect($stdout).to receive(:write).with("[the prefix] next\n")
+          user_io.tell("next")
+        end
+      end
+
+      context "when no newline was printed before" do
+        before do
+          expect($stdout).to receive(:write).with("[the prefix] no newline").ordered
+          user_io.tell("no newline", newline: false)
+        end
+
+        it "does not prepend prefix" do
+          expect($stdout).to receive(:write).with("test data").ordered
+          tell
+        end
+
+        it "prints prefix on following output" do
+          expect($stdout).to receive(:write).with("test data").ordered
+          tell
+          expect($stdout).to receive(:write).with("[the prefix] next\n")
+          user_io.tell("next")
+        end
+      end
+    end
+
+    context "when in background" do
+      let(:color_options) { {color: :yellow} }
+      let(:options) { {output_prefix: "foo"} }
+      let(:data) { ["data\n", "in\nchunks", "", "yo\n", ""] }
+
+      let!(:foreground_thread) do
+        @finished = false
+        Thread.new do
+          user_io.background_other_threads
+          sleep 0.1 until @finished
+          user_io.foreground
+        end
+      end
+
+      after { foreground_thread.kill.join }
+
+      it "holds back the output until coming back to foreground" do
+        expect($stdout).to_not receive(:write)
+        tell
+        RSpec::Mocks.space.proxy_for($stdout).reset
+        expect($stdout).to receive(:write).with("[foo] ").ordered
+        expect($stdout).to receive(:write).with("\e[33m").ordered
+        expect($stdout).to receive(:write).with("data").ordered
+        expect($stdout).to receive(:write).with("\n" "\e[22;39m" "[foo] " "\e[33m").ordered
+        expect($stdout).to receive(:write).
+            with("in\n" "\e[22;39m" "[foo] " "\e[33m" "chunks").ordered
+        expect($stdout).to receive(:write).with("yo").ordered
+        expect($stdout).to receive(:write).with("\n").ordered
+        expect($stdout).to receive(:write).with("\e[22;39m").ordered
+        @finished = true
+        foreground_thread.join
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: infopark-user_io
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tilo Prütz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-10 00:00:00.000000000 Z
+date: 2017-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler