terminal 0.1.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09dfff4392ea46e4a5144da077dcab6bd7d2de74
-  data.tar.gz: ff847cde4fbb22554c860fc29aaede5965c529f1
+  metadata.gz: 4f11cc567d402255f58454144255b1f72881b70e
+  data.tar.gz: df412b25640995f4ee16c04e01bf0de484771f25
 SHA512:
-  metadata.gz: 288d154ac92e734370a9e629da2d35f1117c6772ee3cd2cabe3b87641bdc7bd1ade693ec2f3d9a563fa7b96384a271fd0ea25020a8d467e5812aea3e0896e42b
-  data.tar.gz: 7cb708606953a5bfa8d9945130a3a7c5a4b2c8624354e1f18136c0309f813600678975cbb8dab5a739637e1275bc012c6b7d3ef1b04957bc191e676dd0d8c3cb
+  metadata.gz: 81ea8c713c6b2d49f2bc8b6b0c7c1f82298cb435b25f58a166eedb5ef33a74d9b0171f146b168a0cc2778fb2945df88a0133485b97402f582e8964b998349919
+  data.tar.gz: 2f68cdd314e1503a8227d986497fbf047fe437956dc9a799f1f2b6773d31b22feade0c8c5c06d68f5a8072a385953dc0c4d073465680fcf547d996baddb08a09

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    terminal (0.1)
+    terminal (0.1.1)
       escape_utils (~> 1.0)
 
 GEM

data/Readme.md

@@ -1,4 +1,4 @@
-![logo](http://buildboxhq.github.io/terminal/images/logo.svg)
+![logo](http://buildbox.github.io/terminal/images/logo.svg)
 
 [![Gem Version](https://badge.fury.io/rb/terminal.png)](https://rubygems.org/gems/terminal)
 
@@ -54,7 +54,7 @@ and when the render has finished, it will open in your web browser with a before
 rspec --color --tty | terminal --preview
 ```
 
-![logo](http://buildboxhq.github.io/terminal/images/preview.png)
+![logo](http://buildbox.github.io/terminal/images/preview.png)
 
 ### With the Buildbox API
 
@@ -63,8 +63,8 @@ First install [jq](http://stedolan.github.io/jq/), if you have [Homebrew](http:/
 Then, you can:
 
 ```bash
-$JOB_LOG_URL="https://api.buildbox.io/v1/accounts/[account]/projects/[project]/builds/[build]/jobs/[job]/log?api_key=[api-key]"
-echo $(curl $JOB_LOG_URL -s | jq '.content') | terminal
+export JOB_LOG_URL="https://api.buildbox.io/v1/accounts/[account]/projects/[project]/builds/[build]/jobs/[job]/log?api_key=[api-key]"
+curl $JOB_LOG_URL -s | jq '.content' -r | terminal
 ```
 
 For more information on the Buildbox Builds API, see: https://buildbox.io/docs/api/builds

data/lib/terminal/renderer.rb

@@ -2,6 +2,41 @@ require 'escape_utils'
 
 module Terminal
   class Renderer
+    # If the string (which is a regex) matches, it'll split on that space, so we
+    # end up with an array of special characters and normal characters, i.e:
+    # [ '\n', '\r', 'a', 'b', '\e123m' ]
+    SPLIT_BY_CHARACTERS = [
+      # \n moves the cursor to a new line
+      # \r moves the cursor to the begining of the line
+      # \b moves the cursor back one
+      '[\n\r\b]',
+
+      # [K Erases from the current cursor position to the end of the current line.
+      '\e\[0?K',
+
+      # Clears tab at the current position
+      '\e\[0?[Gg]',
+
+      # [1K Erases from the current cursor position to the start of the current line.
+      # [2K Erases the entire current line.
+      '\e\[[1-2]K',
+
+      # \e[?D move the cursor back ? many characters
+      '\e\[[\d;]+D',
+
+      # \e[0m reset color information
+      # \e[?m use the ? color going forward
+      '\e\[[\d;]+m',
+
+      # Random escpae sequences
+      '\e',
+
+      # Every other character
+      '.'
+    ]
+
+    SPLIT_BY_CHARACTERS_REGEX = Regexp.new(SPLIT_BY_CHARACTERS.join("|"))
+
     def render(output)
       return "" if output.nil? || output.strip.length == 0
 
@@ -32,14 +67,9 @@ module Terminal
 
     private
 
-    # \n moves the cursor to a new line
-    # \r moves the cursor to the begining of the line
-    # \b moves the cursor back one
-    # \e[0m reset color information
-    # \e[?m use the ? color going forward
     def emulate_terminal_rendering(string)
       # Splits the output into intersting parts.
-      parts = string.scan(/[\n\r\b]|\e\[[\d;]+m|\e|./)
+      parts = string.scan(SPLIT_BY_CHARACTERS_REGEX)
 
       lines = []
 
@@ -58,11 +88,27 @@ module Terminal
       parts.each do |char|
         case char
         when "\n"
+          # Starts writing from a new line
           lines << line
           line = []
           cursor = 0
         when "\r"
+          # Returns the writing cursor back to the begining of the line
           cursor = 0
+        when "\e[G", "\e[0G", "\e[g"
+          # TODO: I have no idea how these characters are supposed to work,
+          # but this seems to be produce nicer results that what currently
+          # gets rendered.
+          cursor = 0
+        when "\e[K", "\e[0K"
+          # erases everything after the cursor
+          line = line.fill(" ", cursor..line.length)
+        when "\e[1K"
+          # erases everything before the cursor
+          line = line.fill(" ", 0..cursor)
+        when "\e[2K"
+          # erase entire line
+          line = Array.new(line.length, " ")
         when "\b"
           pointer = cursor-1
 
@@ -79,6 +125,13 @@ module Terminal
 
             pointer -= 1
           end
+        when /\e\[(\d+)D/
+          backwards = $1.to_i
+
+          new_position = cursor - backwards
+          new_position = 0 if new_position < 0
+
+          cursor = new_position
         when /\A\e\[(.*)m\z/
           color_code = $1.to_s
 

data/lib/terminal/version.rb

@@ -1,3 +1,3 @@
 module Terminal
-  VERSION = "0.1.1"
+  VERSION = "0.2"
 end

data/spec/terminal/renderer_spec.rb

@@ -49,5 +49,47 @@ describe Terminal::Renderer do
 
       expect(renderer.render(raw)).to eql("<span class='c81'>hello\n&nbsp;\nfriend</span>")
     end
+
+    it "allows you to control the cursor backwards" do
+      raw = "this is good\e[4Dpoop and stuff"
+
+      expect(renderer.render(raw)).to eql("this is poop and stuff")
+    end
+
+    it "doesn't blow up if you go back too many characters" do
+      raw = "this is good\e[100Dpoop and stuff"
+
+      expect(renderer.render(raw)).to eql("poop and stuff")
+    end
+
+    it "ignores \\e1[K" do
+      raw = "hello friend\e[K!"
+
+      expect(renderer.render(raw)).to eql("hello friend!")
+    end
+
+    it "ignores \\e1[0K" do
+      raw = "hello friend\e[0K!"
+
+      expect(renderer.render(raw)).to eql("hello friend!")
+    end
+
+    it "handles \\e[0G ghetto style" do
+      raw = "hello friend\e[Ggoodbye buddy!"
+
+      expect(renderer.render(raw)).to eql("goodbye buddy!")
+    end
+
+    it "allows erasing the current line up to a point" do
+      raw = "hello friend\e[1K!"
+
+      expect(renderer.render(raw)).to eql("            !")
+    end
+
+    it "allows clearing of the current line" do
+      raw = "hello friend\e[2K!"
+
+      expect(renderer.render(raw)).to eql("            !")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terminal
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
 platform: ruby
 authors:
 - Keith Pitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-10 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils