terminal 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54b22e3e05336e785b66eaead924b54a341c3938
-  data.tar.gz: 0a2f52dd360a0fafeb918ce605ba28c63202aac5
+  metadata.gz: ef903d157312bb149fac82a78546b0d92f7280a2
+  data.tar.gz: cfd561ae29ce4c0157cb8daf2226ca3f9c1e515f
 SHA512:
-  metadata.gz: 65c72b0e4cbba9ff22208bbe619678d362391c22e213143825e9ed2e54ae211e7b3f30b72251408a9ffac04dae4f7484acd938d8d1c7864f87da286a3e90776a
-  data.tar.gz: 056609e233229daeb9ee4b6f95c1cd84f76ce4a10591a97413da6370050061807bed57d291dd8f7e7875f054576620c677332d675dd3c667c09a937fb5d19956
+  metadata.gz: fafa7d5e0e0072b81e2f90ca3b91c300d11b7f71a51dfc62d2b22d3abbae2a5d8c322d8d5a2a181693d2e5ffff98acf3f8507ab931711ea9c043f311eab8a823
+  data.tar.gz: 85727be39d6e58c6dac422f02a567644eb337bdbeb4cec280a99a42634421daa8ec9a6e573b79b913d2f4cad868088b8f4c11c997d40e3d633cc87726aec21c3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    terminal (0.3.2)
+    terminal (0.3.3)
       escape_utils (~> 1.0)
       gemoji (~> 2.0)
 

data/app/assets/stylesheets/terminal.css

@@ -11,12 +11,15 @@
   white-space: pre-wrap;
 }
 
+.term-fg1 { } /* don't bold beccause it looks weird */
+.term-fg4 { text-decoration: underline; } /* underline */
+
 .term-fg30 { color: #666; } /* black (but we can't use black, so a diff color) */
 .term-fg31 { color: #e10c02; } /* red */
-.term-fg32 { color: #00bd02; } /* green */
+.term-fg32 { color: #99ff5e; } /* green */
 .term-fg33 { color: #c6c502; } /* yellow */
 .term-fg34 { color: #8db7e0; } /* blue */
-.term-fg35 { color: #ceacde; } /* magenta */
+.term-fg35 { color: #f271fb; } /* magenta */
 .term-fg36 { color: #00cdd9; } /* cyan */
 
 /* high intense colors */
@@ -25,6 +28,10 @@
 
 /* background colors */
 .term-bg42 { background: #99ff5f; }
+.term-bg40 { background: #676767; }
+
+/* custom foreground/background combos for readability */
+.term-fg31.term-bg40 { color: #F8A39F; }
 
 /* xterm colors */
 .term-fgx16 { color: #000000; }

data/bin/terminal

@@ -13,18 +13,29 @@ Usage:
 
 Help:
   $ terminal -h
+  $ terminal --help
+
+Version:
+  $ terminal -v
+  $ terminal --version
 
 Preview in the browser:
   $ terminal --preview
 
-See https://buildboxhq.github.io/terminal for more information.
+See https://buildbox.github.io/terminal for more information.
   usage
 end
 
+def version
+  puts "terminal v#{Terminal::VERSION}"
+end
+
 preview = ARGV.delete('--preview')
 
 if ($stdin.tty? && ARGV.empty?) || ARGV.delete('-h') || ARGV.delete('--help')
   help
+elsif ARGV.delete('-v') || ARGV.delete('--version')
+  version
 else
   raw = ARGF.read
   rendered = Terminal.render(raw)

data/examples/curl.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
 
 echo -e "\033[90m$\033[0m curl -o /tmp/file.txt https://example.com/file.txt"
-curl -o /tmp/buildbox-agent.tar.gz https://github.com/buildboxhq/buildbox-agent/releases/download/v0.1-alpha/buildbox-agent-darwin-386.tar.gz
+curl -o /tmp/buildbox-agent.tar.gz https://github.com/buildbox/buildbox-agent/releases/download/v0.1-alpha/buildbox-agent-darwin-386.tar.gz

data/lib/terminal.rb

@@ -1,4 +1,5 @@
 require "terminal/version"
+require "terminal/cache"
 require "terminal/screen"
 require "terminal/renderer"
 require "terminal/cli"

data/lib/terminal/cache.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+module Terminal
+  module Cache
+    extend self
+
+    def cache(table, key, &block)
+      @cache ||= {}
+      @cache[table] ||= {}
+      @cache[table][key] ||= yield
+    end
+  end
+end

data/lib/terminal/renderer.rb

@@ -5,10 +5,16 @@ require 'emoji'
 
 module Terminal
   class Renderer
-    EMOJI_UNICODE_REGEXP = /[\u{1f600}-\u{1f64f}]|[\u{2702}-\u{27b0}]|[\u{1f680}-\u{1f6ff}]|[\u{24C2}-\u{1F251}]|[\u{1f300}-\u{1f5ff}]/
-    ESCAPE_CONTROL_CHARACTERS = "qQmKGgKAaBbCcDd"
     MEGABYTES = 1024 * 1024
 
+    EMOJI_UNICODE_REGEXP = /[\u{1f600}-\u{1f64f}]|[\u{2702}-\u{27b0}]|[\u{1f680}-\u{1f6ff}]|[\u{24C2}-\u{1F251}]|[\u{1f300}-\u{1f5ff}]/
+    EMOJI_IGNORE = [ "heavy_check_mark".freeze, "heavy_multiplication_x".freeze ]
+
+    ESCAPE_CONTROL_CHARACTERS = "qQmKGgKAaBbCcDd".freeze
+    ESCAPE_CAPTURE_REGEX = /\e\[(.*)([#{ESCAPE_CONTROL_CHARACTERS}])/
+
+    INTERESTING_PARTS_REGEX=/[\n\r\b]|\e\[[\d;]*[#{ESCAPE_CONTROL_CHARACTERS}]|./
+
     def initialize(output, options = {})
       @output = output
 
@@ -19,30 +25,14 @@ module Terminal
     end
 
     def render
-      return "" if @output.nil? || @output.strip.length == 0
+      return "" if @output.nil?
 
       # First duplicate the string, because we're going to be editing and chopping it
       # up directly.
-      output = @output.dup
+      output = @output.to_s.dup
 
-      # Limit the entire size of the output to 4 meg
-      max_total_size = 4 * MEGABYTES
-      if output.bytesize > max_total_size
-        output = output.byteslice(0, max_total_size)
-        output << "\n\nWarning: Terminal has chopped off the rest of the build as it's over the allowed 4 megabyte limit for logs."
-      end
-
-      # Limit each line to (x) chars
-      # TODO: Move this to the screen
-      max_line_length = 50_000
-      output = output.split("\n").map do |line|
-        if line.length > max_line_length
-          line = line[0..max_line_length]
-          line << " Warning: Terminal has chopped the rest of this line off as it's over the allowed #{max_line_length} characters per line limit."
-        else
-          line
-        end
-      end.join("\n")
+      output = check_size(output)
+      output = check_line_lengths(output)
 
       # Force encoding on the output first
       force_encoding!(output)
@@ -54,17 +44,45 @@ module Terminal
       output = convert_screen_to_string
 
       # Escape any HTML
-      output = escape_html(output)
+      escaped_html = escape_html(output)
 
       # Now convert the colors to HTML
-      output = convert_to_html(output)
+      convert_to_html!(escaped_html)
 
       # And emojify
-      replace_unicode_with_emoji(output)
+      replace_unicode_with_emoji!(escaped_html)
+
+      escaped_html
     end
 
     private
 
+    def check_size(output)
+      # Limit the entire size of the output to 4 meg
+      max_total_size = 4 * MEGABYTES
+      if output.bytesize > max_total_size
+        new_output = output.byteslice(0, max_total_size)
+        new_output << "\n\nWarning: Terminal has chopped off the rest of the build as it's over the allowed 4 megabyte limit for logs."
+        new_output
+      else
+        output
+      end
+    end
+
+    def check_line_lengths(output)
+      # Limit each line to (x) chars
+      # TODO: Move this to the screen
+      max_line_length = 50_000
+       output.split("\n".freeze).map do |line|
+        if line.length > max_line_length
+          line = line[0..max_line_length]
+          line << " Warning: Terminal has chopped the rest of this line off as it's over the allowed #{max_line_length} characters per line limit."
+        else
+          line
+        end
+      end.join("\n".freeze)
+    end
+
     def force_encoding!(string)
       string.force_encoding('UTF-8')
 
@@ -75,29 +93,58 @@ module Terminal
       end
     end
 
+    # Scan the string to create an array of interesting things, for example
+    # it would look like this:
+    # [ '\n', '\r', 'a', 'b', '\e123m' ]
+    def split_by_escape_character(string)
+      string.scan(INTERESTING_PARTS_REGEX)
+    end
+
     def render_to_screen(string)
       # The when cases are ordered by most likely, the lest checks it has to go
       # through before matching, the faster the render will be. Colors are
       # usually most likey, so that's first.
       split_by_escape_character(string).each do |char|
-        # Hackers way of not having to run a regex over every
-        # character.
-        if char.length == 1
-          case char
-          when "\n"
+        if char == "\n".freeze
+          @screen.x = 0
+          @screen.y += 1
+        elsif char == "\r".freeze
+          @screen.x = 0
+        elsif char == "\b".freeze
+          @screen.x -= 1
+        elsif char[0] == "\e".freeze && char.length > 1
+          sequence = char.match(ESCAPE_CAPTURE_REGEX)
+
+          instruction = sequence[1]
+          code = sequence[2]
+
+          if code == "".freeze
+            # no-op - an empty \e
+          elsif code == "m".freeze
+            @screen.color(instruction)
+          elsif code == "G".freeze || code == "g".freeze
             @screen.x = 0
-            @screen.y += 1
-          when "\r"
-            @screen.x = 0
-          when "\r"
-            @screen.x = 0
-          when "\b"
-            @screen.x -= 1
-          else
-            @screen << char
+          elsif code == "K".freeze || code == "k".freeze
+            if instruction == nil || instruction == "0".freeze
+              # clear everything after the current x co-ordinate
+              @screen.clear(@screen.y, @screen.x, Screen::END_OF_LINE)
+            elsif instruction == "1".freeze
+              # clear everything before the current x co-ordinate
+              @screen.clear(@screen.y, Screen::START_OF_LINE, @screen.x)
+            elsif instruction == "2".freeze
+              @screen.clear(@screen.y, Screen::START_OF_LINE, Screen::END_OF_LINE)
+            end
+          elsif code == "A".freeze
+            @screen.up(instruction)
+          elsif code == "B".freeze
+            @screen.down(instruction)
+          elsif code == "C".freeze
+            @screen.foward(instruction)
+          elsif code == "D".freeze
+            @screen.backward(instruction)
           end
         else
-          handle_escape_code(char)
+          @screen << char
         end
       end
     end
@@ -110,67 +157,20 @@ module Terminal
       @screen.to_s
     end
 
-    def handle_escape_code(sequence)
-      # Escapes have the following: \e [ (instruction) (code)
-      parts = sequence.match(/\e\[(.*)([#{ESCAPE_CONTROL_CHARACTERS}])/)
-
-      instruction = parts[1].to_s
-      code = parts[2].to_s
-
-      case code
-      when ""
-        # no-op - an empty \e
-      when "m"
-        @screen.color(instruction)
-      when "G", "g"
-        @screen.x = 0
-      when "K", "k"
-        case instruction
-        when nil, "0"
-          # clear everything after the current x co-ordinate
-          @screen.clear(@screen.y, @screen.x, Screen::END_OF_LINE)
-        when "1"
-          # clear everything before the current x co-ordinate
-          @screen.clear(@screen.y, Screen::START_OF_LINE, @screen.x)
-        when "2"
-          @screen.clear(@screen.y, Screen::START_OF_LINE, Screen::END_OF_LINE)
-        end
-      when "A"
-        @screen.up(instruction)
-      when "B"
-        @screen.down(instruction)
-      when "C"
-        @screen.foward(instruction)
-      when "D"
-        @screen.backward(instruction)
-      end
-    end
+    def convert_to_html!(string)
+      string.gsub!("\terminal[0]", "</span>")
 
-    def convert_to_html(string)
-      string = string.gsub(/\e\[([^;m]+);([^;m]+)?;m/) do |match|
-        if $2
-          %{<span class='term-#{$1} term-#{$2}'>}
-        else
-          %{<span class='term-#{$1}'>}
-        end
+      string.gsub!(/\terminal\[([^\]]+)\]/) do |match|
+        %{<span class='#{$1}'>}
       end
 
-      string = string.gsub("\e[0m", "</span>")
-
       # Replace empty lines with a non breaking space.
-      string.gsub(/$^/, "&nbsp;")
-    end
-
-    # Scan the string to create an array of interesting things, for example
-    # it would look like this:
-    # [ '\n', '\r', 'a', 'b', '\e123m' ]
-    def split_by_escape_character(string)
-      string.scan(/[\n\r\b]|\e\[[\d;]*[#{ESCAPE_CONTROL_CHARACTERS}]|./)
+      string.gsub!(/$^/, "&nbsp;")
     end
 
-    def replace_unicode_with_emoji(string)
-      string.gsub(EMOJI_UNICODE_REGEXP) do |match|
-        emoji_image_from_unicode(match)
+    def replace_unicode_with_emoji!(string)
+      string.gsub!(EMOJI_UNICODE_REGEXP) do |match|
+        Terminal::Cache.cache(:emoji, match) { emoji_image_from_unicode(match) }
       end
     end
 
@@ -181,7 +181,7 @@ module Terminal
     def emoji_image_from_unicode(unicode)
       emoji = Emoji.find_by_unicode(unicode)
 
-      if emoji
+      if emoji && !EMOJI_IGNORE.include?(emoji.name)
         name = ":#{emoji.name}:"
         path = File.join(@options[:emoji_asset_path], emoji.image_filename)
 

data/lib/terminal/screen.rb

@@ -27,27 +27,11 @@
 
 module Terminal
   class Screen
-    class Node < Struct.new(:blob, :fg, :bg)
+    class Node < Struct.new(:blob, :style)
       def ==(value)
         blob == value
       end
 
-      # Every node has a style, a foreground style, and a background
-      # style. This method returns what essentially becomes the escape
-      # sequence:
-      #
-      # \e[fg;bg;
-      #
-      # As the screen is turned into a string, the style is used to compare
-      # whether or not a new escape sequence is required.
-      def style
-        if fg || bg
-          "#{fg};#{bg};"
-        else
-          nil
-        end
-      end
-
       def to_s
         blob
       end
@@ -55,7 +39,7 @@ module Terminal
 
     END_OF_LINE = :end_of_line
     START_OF_LINE = :start_of_line
-    EMPTY = Node.new(" ")
+    EMPTY = Node.new(" ", [])
 
     attr_reader :x, :y
 
@@ -63,7 +47,10 @@ module Terminal
       @x = 0
       @y = 0
       @screen = []
-      @fg = nil
+
+      @fg_color = nil
+      @bg_color = nil
+      @other_colors = []
     end
 
     def write(character)
@@ -81,21 +68,28 @@ module Terminal
       end
 
       # Write the character to the slot
-      line[@x] = Node.new(character, @fg, @bg)
+      line[@x] = Node.new(character, [ @fg_color, @bg_color, *@other_colors ].compact)
     end
 
     def <<(character)
       write(character)
       @x += 1
-      character
     end
 
     def x=(value)
-      @x = value > 0 ? value : 0
+      if value > 0
+        @x = value
+      else
+        @x = 0
+      end
     end
 
     def y=(value)
-      @y = value > 0 ? value : 0
+      if value > 0
+        @y = value
+      else
+        @y = 0
+      end
     end
 
     def clear(y, x_start, x_end)
@@ -117,54 +111,60 @@ module Terminal
     # Changes the current foreground color that all new characters
     # will be written with.
     def color(color_code)
-      # Reset all styles
-      if color_code == "0"
-        @fg = nil
-        @bg = nil
-        return color_code
-      end
-
-      # Reset foreground color only
-      if color_code == "39"
-        @fg = nil
-        return color_code
-      end
-
-      # Reset background color only
-      if color_code == "49"
-        @bg = nil
-        return color_code
-      end
-
-      colors = color_code.to_s.split(";")
+      colors = color_code.scan(/\d+/)
 
       # Extended set foreground x-term color
       if colors[0] == "38" && colors[1] == "5"
-        return @fg = "fgx#{colors[2]}"
+        return @fg_color = "term-fgx#{colors[2]}"
       end
 
       # Extended set background x-term color
       if colors[0] == "48" && colors[1] == "5"
-        return @bg = "bgx#{colors[2]}"
+        return @bg_color = "term-bgx#{colors[2]}"
       end
 
-      # If multiple colors are defined, i.e. \e[30;42m\e
-      # then loop through each one, and assign it to @fg
-      # or @bg
+      # If multiple colors are defined, i.e. \e[30;42m\e then loop through each
+      # one, and assign it to @fg_color or @bg_color
       colors.each do |cc|
-        # If the number is between 30–37, then it's a foreground color,
-        # if it's 40–47, then it's a background color. 90-97 is like the regular
-        # foreground 30-37, but it's high intensity
-        #
-        # I don't use ranges and a select because I've found that to be rather
-        # slow.
         c_integer = cc.to_i
-        if c_integer >= 30 && c_integer <= 37
-          @fg = "fg#{cc}"
+
+        # Reset all styles
+        if c_integer == 0
+          @fg_color = nil
+          @bg_color = nil
+          @other_colors = []
+
+        # Primary (default) font
+        elsif c_integer == 10
+          # no-op
+
+        # Reset foreground color only
+        elsif c_integer ==  39
+          @fg_color = nil
+
+        # Reset background color only
+        elsif c_integer ==  49
+          @bg_color = nil
+
+        # 30–37, then it's a foreground color
+        elsif c_integer >= 30 && c_integer <= 37
+          @fg_color = "term-fg#{cc}"
+
+        # 40–47, then it's a background color.
         elsif c_integer >= 40 && c_integer <= 47
-          @bg = "bg#{cc}"
+          @bg_color = "term-bg#{cc}"
+
+        # 90-97 is like the regular fg color, but high intensity
         elsif c_integer >= 90 && c_integer <= 97
-          @fg = "fgi#{cc}"
+          @fg_color = "term-fgi#{cc}"
+
+        # 100-107 is like the regular bg color, but high intensity
+        elsif c_integer >= 100 && c_integer <= 107
+          @fg_color = "term-bgi#{cc}"
+
+        # 1-9 random other styles
+        elsif c_integer >= 1 && c_integer <= 9
+          @other_colors << "term-fg#{cc}"
         end
       end
     end
@@ -231,8 +231,8 @@ module Terminal
         line.each do |node|
           # If there is no previous node, and the current node has a color
           # (first node in a line) then add the escape character.
-          if !previous && node.style
-            buffer << "\e[#{node.style}m"
+          if !previous && node.style.length > 0
+            buffer << "\terminal[#{node.style.join(" ")}]"
 
             # Increment the open style counter
             open_styles += 1
@@ -242,14 +242,14 @@ module Terminal
           elsif previous && previous.style != node.style
             # If the new node has no style, that means that all the styles
             # have been closed.
-            if !node.style
+            if node.style.length == 0
               # Add our reset escape character
-              buffer << "\e[0m"
+              buffer << "\terminal[0]"
 
               # Decrement the open style counter
               open_styles -= 1
             else
-              buffer << "\e[#{node.style}m"
+              buffer << "\terminal[#{node.style.join(" ")}]"
 
               # Increment the open style counter
               open_styles += 1
@@ -264,7 +264,7 @@ module Terminal
         end
 
         # Be sure to close off any open styles for this line
-        open_styles.times { buffer << "\e[0m" }
+        open_styles.times { buffer << "\terminal[0]" }
 
         # Add a new line as long as this line isn't the last
         buffer << "\n" if line_index != last_line_index
@@ -276,7 +276,11 @@ module Terminal
     private
 
     def parse_integer(value)
-      value.nil? || value == "" ? 1 : value.to_i
+      if value == nil || value == ""
+        1
+      else
+        value.to_i
+      end
     end
   end
 end

data/lib/terminal/version.rb

@@ -1,3 +1,3 @@
 module Terminal
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/script/benchmark

@@ -6,15 +6,23 @@ require 'terminal'
 require 'benchmark/ips'
 require 'timeout'
 
-Benchmark.ips do |bm|
-  Dir.glob("spec/fixtures/*.raw").each do |file|
-    output = File.read(file)
-    basename = File.basename(file)
+def benchmark(bm, file)
+  output = File.read(file)
+  basename = File.basename(file)
+
+  bm.report basename do
+    Timeout.timeout(100) do
+      Terminal.render(output)
+    end
+  end
+end
 
-    bm.report basename do
-      Timeout.timeout(100) do
-        Terminal.render(output)
-      end
+Benchmark.ips do |bm|
+  if ARGV[0]
+    benchmark(bm, ARGV[0])
+  else
+    Dir.glob("spec/fixtures/*.raw").each do |file|
+      benchmark(bm, file)
     end
   end
 end

data/script/profile_methods

@@ -7,9 +7,14 @@ require 'method_profiler'
 
 screen_profiler = MethodProfiler.observe(Terminal::Screen)
 render_profiler = MethodProfiler.observe(Terminal::Renderer)
-iterations = 10
 
-Dir.glob("spec/fixtures/*.raw").each do |file|
+iterations = if ARGV[1]
+               ARGV[1].to_i
+             else
+               10
+             end
+
+def profile(file, iterations)
   output = File.read(file)
   basename = File.basename(file)
 
@@ -17,5 +22,11 @@ Dir.glob("spec/fixtures/*.raw").each do |file|
   iterations.times { Terminal.render(output) }
 end
 
+if ARGV[0]
+  profile(ARGV[0], iterations)
+else
+  Dir.glob("spec/fixtures/*.raw").each { |file| profile(file, iterations) }
+end
+
 puts screen_profiler.report
 puts render_profiler.report

data/spec/terminal/renderer_spec.rb

@@ -203,9 +203,27 @@ describe Terminal::Renderer do
 
     it "returns nothing if the unicode emoji can't be found" do
       expect(Emoji).to receive(:unicodes_index) { {} }
-      raw = "this is great 👍"
+      raw = "this is great 😎"
+
+      expect(render(raw)).to eql(%{this is great 😎})
+    end
+
+    it "leaves the tick emoji alone (it looks better and is colored)" do
+      raw = "works ✔"
+
+      expect(render(raw)).to eql(%{works ✔})
+    end
+
+    it "leaves the ✖ emoji alone as well" do
+      raw = "broke ✖"
+
+      expect(render(raw)).to eql(%{broke ✖})
+    end
+
+    it "handles colors with 3 attributes" do
+      raw = "\e[0;10;4m\e[1m\e[34mgood news\e[0;10m\n\neveryone"
 
-      expect(render(raw)).to eql(%{this is great 👍})
+      expect(render(raw)).to eql("<span class='term-fg34 term-fg4 term-fg1'>good news</span>\n&nbsp;\neveryone")
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terminal
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Keith Pitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -131,6 +131,7 @@ files:
 - examples/pikachu.ansi
 - examples/pikachu.sh
 - lib/terminal.rb
+- lib/terminal/cache.rb
 - lib/terminal/cli.rb
 - lib/terminal/engine.rb
 - lib/terminal/preview.rb