terminal 0.0.1.alpha.2 → 0.0.1.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 487092c63dea202f02bd076d7e4158eea89bd58a
-  data.tar.gz: 6199129f8e34c4216edb4300334305e9b3846deb
+  metadata.gz: a2a0074192ba83af5ba05e56242ba68423254d87
+  data.tar.gz: df0a7b8db3e1db4dd26b95f4b13fbc9bfba55019
 SHA512:
-  metadata.gz: db1e32fcb67aa51ffaa827864a0bbabb2d1bbd96853df00e4b8696fa1ea7d2c5f27f4d7a0015140524e2912dbfbf1fcca3a6493191cb7631cd3930cb67fc8200
-  data.tar.gz: fcdda1990aec64e1bbd7795f2f10b7fe133abeeb754782b85a9041b8e0823ecab7bbee44d27b7e9f6f938e5ebfbab50903ccaa0106688059e329fca8446e1f43
+  metadata.gz: 834c6b10127a1c3f040f0a611b8da5276e546f6b2b83b3d9b38f7dd7add2bd7ee05d804aee29426a345db8a36ac3ae610a4a37fa9229feb03e81f5a017f964f8
+  data.tar.gz: b93a742431b08e4af2087e19903e0f97840056cdf939746ee6755575230a7be639a3821932cf6be22332d4b118d96367979f156a717fa303b71ba3b2add29ffa

data/.gitignore

@@ -20,3 +20,6 @@ tmp
 *.o
 *.a
 mkmf.log
+examples/*.raw
+examples/*.rendered
+examples/*.html

data/Readme.md

@@ -47,6 +47,15 @@ terminal output.txt
 
 With `rspec`, you'll need to use the `--tty` and `--color` options to force it to output colors.
 
+We also provide a utility to preview the rendered version in a web browser. Simply append `--preview` to the command,
+and when the render has finished, it will open in your web browser with a before/after show.
+
+```bash
+rspec --color --tty | terminal --preview
+```
+
+![logo](http://buildboxhq.github.io/terminal/images/preview.png)
+
 ### 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`.
@@ -60,6 +69,21 @@ echo $(curl $JOB_LOG_URL -s | jq '.content') | terminal
 
 For more information on the Buildbox Builds API, see: https://buildbox.io/docs/api/builds
 
+## Generating Fixtures
+
+To generate a fixture, first create a test case inside the `examples` folder. See the `curl.sh`
+file as an example. You can then generate a `.raw` and `.rendered` file by running:
+
+```bash
+./generate curl.sh
+```
+
+You should then move the `raw` and `rendered` files to the `fixtures` folder.
+
+```bash
+mv examples/*{raw,rendered} spec/fixtures
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/terminal/fork )

data/bin/terminal

@@ -17,8 +17,23 @@ See https://buildboxhq.github.io/terminal for more information.
   usage
 end
 
+preview = ARGV.delete('--preview')
+
 if ($stdin.tty? && ARGV.empty?) || ARGV.delete('-h') || ARGV.delete('--help')
   help
 else
-  puts Terminal.render(ARGF.read)
+  raw = ARGF.read
+  rendered = Terminal.render(raw)
+
+  if preview
+    require 'tempfile'
+
+    tempfile = Tempfile.new([ 'preview', '.html' ])
+    tempfile.write(Terminal::Preview.new(raw, rendered).render)
+    tempfile.close
+
+    exec %{open "#{tempfile.path}"}
+  else
+    puts rendered
+  end
 end

data/examples/curl.sh

@@ -0,0 +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

data/examples/generate

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'pty'
+$:.unshift(File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib'))
+
+require 'terminal'
+
+output = ""
+read_io, write_io, pid = nil
+
+file = ARGV[0]
+
+read_io, write_io, pid = PTY.spawn("./#{file}")
+
+write_io.close
+
+loop do
+  fds, = IO.select([read_io], nil, nil, 5)
+  if fds
+    # should have some data to read
+    begin
+      chunk = read_io.read_nonblock(10240)
+      if block_given?
+        yield chunk
+      end
+      output += chunk
+    rescue Errno::EAGAIN, Errno::EWOULDBLOCK
+      # do select again
+    rescue EOFError, Errno::EIO # EOFError from OSX, EIO is raised by ubuntu
+      break
+    end
+  end
+  # if fds are empty, timeout expired - run another iteration
+end
+
+read_io.close
+Process.waitpid(pid)
+
+raw = output.chomp.strip
+rendered = Terminal.render(output)
+
+File.open("#{file}.raw", "w") { |file| file.write(raw) }
+File.open("#{file}.rendered", "w") { |file| file.write(rendered) }
+File.open("#{file}.html", "w") { |file| file.write(Terminal::Preview.new(raw, rendered).render) }

data/lib/terminal.rb

@@ -4,6 +4,7 @@ require "terminal/color"
 require "terminal/reset"
 require "terminal/renderer"
 require "terminal/cli"
+require "terminal/preview"
 
 module Terminal
   def self.render(output)

data/lib/terminal/preview.rb

@@ -0,0 +1,30 @@
+require 'erb'
+
+module Terminal
+  class Preview
+    class Binding < Struct.new(:raw, :rendered)
+      def get_binding
+        binding
+      end
+    end
+
+    def initialize(raw, rendered)
+      @raw = raw
+      @rendered = rendered
+    end
+
+    def render
+      template = File.read(template_path)
+      renderer = ERB.new(template)
+      binding = Binding.new(@raw, @rendered)
+
+      renderer.result(binding.get_binding)
+    end
+
+    private
+
+    def template_path
+      File.join(File.expand_path(File.dirname(__FILE__)), 'templates/preview.html.erb')
+    end
+  end
+end

data/lib/terminal/templates/preview.html.erb

@@ -0,0 +1,99 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <style>
+    .code {
+      background: #171717;
+      border-radius: 5px;
+      color: white;
+      padding: 30px;
+      margin-bottom: 15px;
+      word-break: break-word;
+      white-space: pre-wrap;
+      overflow-wrap: break-word;
+    }
+
+    .code pre {
+      margin: 0;
+      padding: 0;
+      font-family: Monaco, courier;
+      font-size: 12px;
+      line-height: 20px;
+    }
+
+    /* yellow */
+    .c33 {
+      color: #c6c502;
+    }
+
+    /* green */
+    .c32 {
+      color: #00bd02;
+    }
+
+    /* intense green */
+    .c1 {
+      color: #5ef765;
+    }
+
+    /* red */
+    .c31 {
+      color: #e10c02;
+    }
+
+    /* blue */
+    .c34 {
+      color: #8db7e0;
+    }
+
+    /* magent */
+    .c35 {
+      color: #ceacde;
+    }
+
+    /* cyan */
+    .c36 {
+      color: #00cdd9;
+    }
+
+    /* black (but we can't use black, so a diff color) */
+    .c30 {
+      color: #666;
+    }
+
+    /* grey */
+    .c90 {
+      color: #838887;
+    }
+
+    body {
+      margin: 0;
+      padding: 0;
+    }
+
+    .previews {
+      overflow: hidden;
+      padding: 20px;
+    }
+
+    .preview-left, .preview-right {
+      width: 50%;
+      float: left;
+    }
+
+    .preview-left .code {
+      margin-right: 10px;
+    }
+
+    .preview-right .code {
+      margin-left: 10px;
+    }
+    </style>
+  </head>
+  <body>
+    <div class="previews">
+      <div class="preview-left"><div class="code"><pre><%= raw %></pre></div></div>
+      <div class="preview-right"><div class="code"><pre><%= rendered %></pre></div></div>
+    </div>
+  </body>
+</html>

data/lib/terminal/version.rb

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

data/spec/fixtures/curl.sh.raw

@@ -0,0 +1,4 @@
+$ curl -o /tmp/file.txt https://example.com/file.txt
+  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
+                                 Dload  Upload   Total   Spent    Left  Speed
+
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
  0     0    0     0    0     0      0      0 --:--:--  0:00:01 --:--:--     0

data/spec/fixtures/curl.sh.rendered

@@ -0,0 +1,4 @@
+<span class='c90'>$</span> curl -o &#47;tmp&#47;file.txt https:&#47;&#47;example.com&#47;file.txt
+  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
+                                 Dload  Upload   Total   Spent    Left  Speed
+100   364  100   364    0     0    153      0  0:00:02  0:00:02 --:--:--   153

data/spec/spec_helper.rb

@@ -2,3 +2,23 @@ require 'bundler/setup'
 Bundler.setup
 
 require 'terminal'
+
+class Fixture
+  def self.path
+    File.join(File.expand_path(File.dirname(__FILE__)), 'fixtures')
+  end
+
+  def self.for(name)
+    raw = File.read(File.join(path, "#{name}.raw"))
+    rendered = File.read(File.join(path, "#{name}.rendered"))
+
+    new(raw, rendered)
+  end
+
+  attr_reader :raw, :rendered
+
+  def initialize(raw, rendered)
+    @raw = raw
+    @rendered = rendered
+  end
+end

data/spec/terminal/renderer_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Terminal::Renderer do
+  let(:renderer) { Terminal::Renderer.new }
+
+  describe "rendering of curl.sh" do
+    it "returns the expected result" do
+      fixture = Fixture.for("curl.sh")
+
+      expect(renderer.render(fixture.raw)).to eql(fixture.rendered)
+    end
+  end
+
+  describe "#render" do
+    let(:hello_output) { "he\e[81mllo" }
+
+    it "closes colors that get opened" do
+      raw = "he\e[81mllo"
+
+      expect(renderer.render(raw)).to eql("he<span class='c81'>llo</span>")
+    end
+
+    it "backspaces colors" do
+      raw = "he\e[81m\e[90m\bllo"
+
+      expect(renderer.render(raw)).to eql("hello")
+    end
+
+    it "starts overwriting characters when you \\r midway through somehing" do
+      raw = "hello\rb"
+
+      expect(renderer.render(raw)).to eql("bello")
+    end
+
+    it "colors across multiple lines" do
+      raw = "\e[81mhello\n\nfriend\e[0m"
+
+      expect(renderer.render(raw)).to eql("<span class='c81'>hello\n&nbsp;\nfriend</span>")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha.2
+  version: 0.0.1.alpha.3
 platform: ruby
 authors:
 - Keith Pitt
@@ -79,13 +79,19 @@ files:
 - Rakefile
 - Readme.md
 - bin/terminal
+- examples/curl.sh
+- examples/generate
 - lib/terminal.rb
 - lib/terminal/cli.rb
 - lib/terminal/color.rb
 - lib/terminal/node.rb
+- lib/terminal/preview.rb
 - lib/terminal/renderer.rb
 - lib/terminal/reset.rb
+- lib/terminal/templates/preview.html.erb
 - lib/terminal/version.rb
+- spec/fixtures/curl.sh.raw
+- spec/fixtures/curl.sh.rendered
 - spec/spec_helper.rb
 - spec/terminal/renderer_spec.rb
 - terminal.gemspec
@@ -114,5 +120,7 @@ signing_key:
 specification_version: 4
 summary: Renders ASCII as HTML
 test_files:
+- spec/fixtures/curl.sh.raw
+- spec/fixtures/curl.sh.rendered
 - spec/spec_helper.rb
 - spec/terminal/renderer_spec.rb