terminal 0.0.1.alpha → 0.0.1.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bfa777b9424757d7607650d21662d2a97986253
-  data.tar.gz: ef1d951d1e07c1feda0ffa1d8992cf56eea77460
+  metadata.gz: 487092c63dea202f02bd076d7e4158eea89bd58a
+  data.tar.gz: 6199129f8e34c4216edb4300334305e9b3846deb
 SHA512:
-  metadata.gz: 1d336c6efb98167cfeb871a32b219abeaf6299cdf21782d42e83fa861fb73fb36eceec9da4644a48078917d0cec364002b1c043eddaa4cbb5d1aaa98d87d3c0e
-  data.tar.gz: 29439ee72bea5d033cd551551e4b71caad28ce69c800a7e41e4f8252beac2eba836574c28143064b84750816ee2c9e04fac466eb7409f27753e7dfdd1929a2e3
+  metadata.gz: db1e32fcb67aa51ffaa827864a0bbabb2d1bbd96853df00e4b8696fa1ea7d2c5f27f4d7a0015140524e2912dbfbf1fcca3a6493191cb7631cd3930cb67fc8200
+  data.tar.gz: fcdda1990aec64e1bbd7795f2f10b7fe133abeeb754782b85a9041b8e0823ecab7bbee44d27b7e9f6f938e5ebfbab50903ccaa0106688059e329fca8446e1f43

data/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.verbose = false
+end
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,94 @@
+![logo](http://buildboxhq.github.io/terminal/images/logo.png)
+
+[![Gem Version](https://badge.fury.io/rb/terminal.png)](https://rubygems.org/gems/terminal)
+
+Terminal takes any arbitrary crazy shell output (ASCII), and turns it into beautifully rendered HTML.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'terminal'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install terminal
+```
+
+## Usage
+
+```ruby
+Terminal.render("...")
+```
+
+### Command Line
+
+Terminal ships with a command line utility. For example, you can pipe `rspec` output to it:
+
+```bash
+rspec --color --tty | terminal
+```
+
+Or use output saved earlier:
+
+```bash
+rspec --tty --color > output.txt
+terminal output.txt
+```
+
+With `rspec`, you'll need to use the `--tty` and `--color` options to force it to output colors.
+
+### With the Buildbox API
+
+First install [jq](http://stedolan.github.io/jq/), if you have [Homebrew](http://brew.sh/) installed, you can just `brew install jq`.
+
+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
+```
+
+For more information on the Buildbox Builds API, see: https://buildbox.io/docs/api/builds
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/terminal/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Licence
+
+> Copyright (c) 2014 Keith Pitt, Buildbox
+>
+> MIT License
+>
+> Permission is hereby granted, free of charge, to any person obtaining
+> a copy of this software and associated documentation files (the
+> "Software"), to deal in the Software without restriction, including
+> without limitation the rights to use, copy, modify, merge, publish,
+> distribute, sublicense, and/or sell copies of the Software, and to
+> permit persons to whom the Software is furnished to do so, subject to
+> the following conditions:
+>
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/terminal

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib'))
+
+require 'terminal'
+
+def help
+  puts <<-usage
+Usage:
+  $ cat output.text | terminal
+  $ terminal output.text
+
+Help:
+  $ terminal -h
+
+See https://buildboxhq.github.io/terminal for more information.
+  usage
+end
+
+if ($stdin.tty? && ARGV.empty?) || ARGV.delete('-h') || ARGV.delete('--help')
+  help
+else
+  puts Terminal.render(ARGF.read)
+end

data/lib/terminal.rb

@@ -1,5 +1,12 @@
 require "terminal/version"
+require "terminal/node"
+require "terminal/color"
+require "terminal/reset"
+require "terminal/renderer"
+require "terminal/cli"
 
 module Terminal
-  # Your code goes here...
+  def self.render(output)
+    Terminal::Renderer.new.render(output)
+  end
 end

data/lib/terminal/cli.rb

@@ -0,0 +1,16 @@
+module Terminal
+  class CLI
+    def self.run(*args, file)
+      new(args, file).run
+    end
+
+    def initialize(args, file)
+      @args = args
+      @file = file
+    end
+
+    def run
+      puts @file
+    end
+  end
+end

data/lib/terminal/color.rb

@@ -0,0 +1,7 @@
+module Terminal
+  class Color < Terminal::Node
+    def to_debug
+      "[color:#{@code}]"
+    end
+  end
+end

data/lib/terminal/node.rb

@@ -0,0 +1,15 @@
+module Terminal
+  class Node
+    def initialize(code)
+      @code = code
+    end
+
+    def to_s
+      "\e[#{@code}m"
+    end
+
+    def to_debug
+      "[node:#{@code}]"
+    end
+  end
+end

data/lib/terminal/renderer.rb

@@ -0,0 +1,169 @@
+require 'escape_utils'
+
+module Terminal
+  class Renderer
+    def render(output)
+      return "" if output.nil? || output.strip.length == 0
+
+      # Limit the entire size of the output to 4 meg (4 * megabyte * kilabyte)
+      max_total_size = 4 * 1024 * 1024
+      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 #{number_to_human_size(max_total_size)} limit for logs."
+      end
+
+      # Limit each line to (x) chars
+      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")
+
+      # Now do the terminal rendering
+      output = emulate_terminal_rendering(sanitize(output))
+
+      # Replace empty lines with a non breaking space.
+      output.gsub(/$^/, "&nbsp;")
+    end
+
+    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|[^\n\r\b\e]+/)
+
+      lines = []
+
+      index = 0
+      length = string.length
+
+      line = []
+      cursor = 0
+
+      # Every time a color is found, we increment this
+      # counter, every time it resets, we decrement.
+      # We do this so we close all the open spans at the
+      # end of the output.
+      colors_opened = 0
+
+      parts.each do |char|
+        case char
+        when "\n"
+          lines << line
+          line = []
+          cursor = 0
+        when "\r"
+          cursor = 0
+        when "\b"
+          pointer = cursor-1
+
+          # Seek backwards until something that isn't a color is reached.
+          # Colors aren't affected by \b
+          while pointer > 0
+            char_at_pointer = line[pointer]
+            break unless char_at_pointer.kind_of?(Terminal::Color)
+
+            pointer -= 1
+          end
+
+          cursor -= (cursor - pointer)
+        when "\e"
+          # Seek the next few characters to tell if theres a color present
+          seeked = string[index..(index + 10)]
+
+          # Does the next lot of characters look like a color code?
+          matched = seeked.to_s.match(/\A\e\[(.*)m\z/)
+
+          # If it does, skip over the characters that are the color,
+          # and track it at a single color object in the line. We do this
+          # so when we \b after a color, we skip back across the whole color
+          # not just the last character in the color sequence.
+          if matched
+            color_code = matched[1].to_s
+
+            # Determine what sort of color code it is.
+            if color_code == "0"
+              line[cursor] = Terminal::Reset.new(colors_opened)
+
+              colors_opened = 0
+            else
+              line[cursor] = Terminal::Color.new(color_code)
+
+              colors_opened += 1
+            end
+
+            index += 3 + color_code.length
+            cursor += 1
+
+            next
+          end
+        else
+          line[cursor] = char
+          cursor += 1
+        end
+
+        # The cursor can't go back furthur than 0, so if you \b at the begining
+        # of a line, nothing happens.
+        cursor = 0 if cursor < 0
+
+        index += 1
+      end
+
+      # Add back in the last line if the end of the output
+      # didn't end with a \n
+      lines << line if line.any?
+
+      # Be sure to reset any unclosed colors.
+      if colors_opened > 0
+        lines << [ Terminal::Reset.new(colors_opened) ]
+      end
+
+      # Join all the strings back together again
+      lines = lines.map do |parts|
+        completed_line = parts.map(&:to_s).join("")
+      end.join("\n")
+
+      # Now escape all the things
+      lines = EscapeUtils.escape_html(lines)
+
+      matches = []
+
+      # Now we can easily gsub colors like a baws
+      lines.gsub!(/\e\[([0-9;]+)m/) do |match|
+        color_codes = $1.split(';')
+
+        if color_codes == [ "0" ]
+          "</span>"
+        else
+          classes = color_codes.map { |code| "c#{code}" }
+
+          "<span class='#{classes.join(" ")}'>"
+        end
+      end
+
+      lines
+    end
+
+    def sanitize(string)
+      string = string.dup.force_encoding('UTF-8')
+      if string.valid_encoding?
+        string
+      else
+        string.
+          force_encoding('ASCII-8BIT').
+          encode!('UTF-8',
+                  invalid: :replace,
+                  undef:   :replace)
+      end
+    end
+  end
+end

data/lib/terminal/reset.rb

@@ -0,0 +1,16 @@
+module Terminal
+  class Reset < Terminal::Node
+    def initialize(opened)
+      @opened = opened
+      @code = "0"
+    end
+
+    def to_s
+      super * @opened
+    end
+
+    def to_debug
+      "[reset:#{@opened}]"
+    end
+  end
+end

data/lib/terminal/version.rb

@@ -1,3 +1,3 @@
 module Terminal
-  VERSION = "0.0.1.alpha"
+  VERSION = "0.0.1.alpha.2"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'terminal'

data/terminal.gemspec

@@ -18,6 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "escape_utils", "~> 1.0"
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: terminal
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.0.1.alpha.2
 platform: ruby
 authors:
 - Keith Pitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-08 00:00:00.000000000 Z
+date: 2014-07-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: escape_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +52,42 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Renders ASCII as HTML
 email:
 - me@keithpitt.com
-executables: []
+executables:
+- terminal
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- LICENSE.txt
-- README.md
 - Rakefile
+- Readme.md
+- bin/terminal
 - lib/terminal.rb
+- lib/terminal/cli.rb
+- lib/terminal/color.rb
+- lib/terminal/node.rb
+- lib/terminal/renderer.rb
+- lib/terminal/reset.rb
 - lib/terminal/version.rb
+- spec/spec_helper.rb
+- spec/terminal/renderer_spec.rb
 - terminal.gemspec
 homepage: https://github.com/buildboxhq/terminal
 licenses:
@@ -77,4 +113,6 @@ rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Renders ASCII as HTML
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/terminal/renderer_spec.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 Keith Pitt
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,29 +0,0 @@
-# Terminal
-
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'terminal'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install terminal
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/terminal/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request