terminal 0.0.1.alpha.3 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2a0074192ba83af5ba05e56242ba68423254d87
-  data.tar.gz: df0a7b8db3e1db4dd26b95f4b13fbc9bfba55019
+  metadata.gz: d516a6b1b58bab0cc47218e13a03e77ad2cf00e0
+  data.tar.gz: 5cbcd3804c846cc919e4e5c3cb043fd8a4239164
 SHA512:
-  metadata.gz: 834c6b10127a1c3f040f0a611b8da5276e546f6b2b83b3d9b38f7dd7add2bd7ee05d804aee29426a345db8a36ac3ae610a4a37fa9229feb03e81f5a017f964f8
-  data.tar.gz: b93a742431b08e4af2087e19903e0f97840056cdf939746ee6755575230a7be639a3821932cf6be22332d4b118d96367979f156a717fa303b71ba3b2add29ffa
+  metadata.gz: 2972ffd87796ed75c73ed8f72e54864c0d6d092c5d658ea0b36f58f8c1fb90251867c786977e8e2916df83398d2b3dddaac6f24f352e192dc7b1aa979887eb42
+  data.tar.gz: 00807d190ecb2c6c194e6bad44700e60591e5eb00e6b23277b734d8dafe600132341063afddc5c8823f96fc0a41cb59fe25a02412c505b58259506ab838aafd6

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    terminal (0.0.1)
+      escape_utils (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    escape_utils (1.0.1)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  rake
+  rspec
+  terminal!

data/Readme.md

@@ -1,8 +1,8 @@
-![logo](http://buildboxhq.github.io/terminal/images/logo.png)
+![logo](http://buildboxhq.github.io/terminal/images/logo.svg)
 
 [![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.
+Terminal is a Ruby library for converting arbitrary shell output (with ANSI) into beautifully rendered HTML. See http://www.termsys.demon.co.uk/vtansi.htm for more information about ANSI Terminal Control Escape Sequences.
 
 ## Installation
 

data/bin/terminal

@@ -13,6 +13,9 @@ Usage:
 Help:
   $ terminal -h
 
+Preview in the browser:
+  $ terminal --preview
+
 See https://buildboxhq.github.io/terminal for more information.
   usage
 end

data/examples/ascii.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+ASCII=`cat homer.txt`
+
+echo -e "\033[33m$ASCII\033[0m"

data/examples/homer.txt

@@ -0,0 +1,18 @@
+   ___  _____
+ .'/,-Y"     "~-.
+ l.Y             ^.
+ /\               _\_
+i            ___/"   "\
+|          /"   "\   o !
+l         ]     o !__./
+ \ _  _    \.___./    "~\
+  X \/ \            ___./
+ ( \ ___.   _..--~~"   ~`-.
+  ` Z,--   /               \
+    \__.  (   /       ______)
+      \   l  /-----~~" /
+       Y   \          /
+       |    "x______.^
+       |           \
+       j            Y
+                    ->Homer<-

data/lib/terminal/renderer.rb

@@ -39,7 +39,7 @@ module Terminal
     # \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]+/)
+      parts = string.scan(/[\n\r\b]|\e\[[\d;]+m|\e|./)
 
       lines = []
 
@@ -66,46 +66,35 @@ module Terminal
         when "\b"
           pointer = cursor-1
 
-          # Seek backwards until something that isn't a color is reached.
+          # Seek backwards until something that isn't a color is reached. When we
+          # reach it (probably a string) remove the last character of it.
           # Colors aren't affected by \b
-          while pointer > 0
+          while pointer >= 0
             char_at_pointer = line[pointer]
-            break unless char_at_pointer.kind_of?(Terminal::Color)
+
+            unless char_at_pointer.kind_of?(Terminal::Node)
+              line[pointer] = char_at_pointer[0..-2]
+              break
+            end
 
             pointer -= 1
           end
+        when /\A\e\[(.*)m\z/
+          color_code = $1.to_s
 
-          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
+          # Determine what sort of color code it is.
+          if color_code == "0"
+            line[cursor] = Terminal::Reset.new(colors_opened)
 
-            index += 3 + color_code.length
-            cursor += 1
+            colors_opened = 0
+          else
+            line[cursor] = Terminal::Color.new(color_code)
 
-            next
+            colors_opened += 1
           end
+
+          index += char.length
+          cursor += 1
         else
           line[cursor] = char
           cursor += 1
@@ -118,15 +107,15 @@ module Terminal
         index += 1
       end
 
+      # Be sure to reset any unclosed colors on the last line
+      if colors_opened > 0
+        line << Terminal::Reset.new(colors_opened)
+      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("")

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

@@ -6,7 +6,7 @@
       background: #171717;
       border-radius: 5px;
       color: white;
-      padding: 30px;
+      padding: 15px;
       margin-bottom: 15px;
       word-break: break-word;
       white-space: pre-wrap;

data/lib/terminal/version.rb

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

data/spec/fixtures/ascii.sh.raw

@@ -0,0 +1,18 @@
+   ___  _____
+ .'/,-Y"     "~-.
+ l.Y             ^.
+ /\               _\_
+i            ___/"   "\
+|          /"   "\   o !
+l         ]     o !__./
+ \ _  _    \.___./    "~\
+  X \/ \            ___./
+ ( \ ___.   _..--~~"   ~`-.
+  ` Z,--   /               \
+    \__.  (   /       ______)
+      \   l  /-----~~" /
+       Y   \          /
+       |    "x______.^
+       |           \
+       j            Y
+                    ->Homer<-

data/spec/fixtures/ascii.sh.rendered

@@ -0,0 +1,18 @@
+<span class='c33'>   ___  _____
+ .&#39;&#47;,-Y&quot;     &quot;~-.
+ l.Y             ^.
+ &#47;\               _\_
+i            ___&#47;&quot;   &quot;\
+|          &#47;&quot;   &quot;\   o !
+l         ]     o !__.&#47;
+ \ _  _    \.___.&#47;    &quot;~\
+  X \&#47; \            ___.&#47;
+ ( \ ___.   _..--~~&quot;   ~`-.
+  ` Z,--   &#47;               \
+    \__.  (   &#47;       ______)
+      \   l  &#47;-----~~&quot; &#47;
+       Y   \          &#47;
+       |    &quot;x______.^
+       |           \
+       j            Y
+                    -&gt;Homer&lt;-</span>

data/spec/spec_helper.rb

@@ -3,22 +3,14 @@ Bundler.setup
 
 require 'terminal'
 
-class Fixture
-  def self.path
-    File.join(File.expand_path(File.dirname(__FILE__)), 'fixtures')
-  end
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
 
-  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
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
 end

data/spec/support/fixture.rb

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

@@ -11,19 +11,25 @@ describe Terminal::Renderer do
     end
   end
 
-  describe "#render" do
-    let(:hello_output) { "he\e[81mllo" }
+  describe "rendering of ascii.sh" do
+    it "returns the expected result" do
+      fixture = Fixture.for("ascii.sh")
 
+      expect(renderer.render(fixture.raw)).to eql(fixture.rendered)
+    end
+  end
+
+  describe "#render" do
     it "closes colors that get opened" do
-      raw = "he\e[81mllo"
+      raw = "he\033[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"
+    it "skips over colors when backspacing" do
+      raw = "he\e[32m\e[33m\bllo"
 
-      expect(renderer.render(raw)).to eql("hello")
+      expect(renderer.render(raw)).to eql("h<span class='c32'><span class='c33'>llo</span></span>")
     end
 
     it "starts overwriting characters when you \\r midway through somehing" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terminal
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha.3
+  version: '0.1'
 platform: ruby
 authors:
 - Keith Pitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-09 00:00:00.000000000 Z
+date: 2014-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -76,11 +76,14 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- Gemfile.lock
 - Rakefile
 - Readme.md
 - bin/terminal
+- examples/ascii.sh
 - examples/curl.sh
 - examples/generate
+- examples/homer.txt
 - lib/terminal.rb
 - lib/terminal/cli.rb
 - lib/terminal/color.rb
@@ -90,9 +93,12 @@ files:
 - lib/terminal/reset.rb
 - lib/terminal/templates/preview.html.erb
 - lib/terminal/version.rb
+- spec/fixtures/ascii.sh.raw
+- spec/fixtures/ascii.sh.rendered
 - spec/fixtures/curl.sh.raw
 - spec/fixtures/curl.sh.rendered
 - spec/spec_helper.rb
+- spec/support/fixture.rb
 - spec/terminal/renderer_spec.rb
 - terminal.gemspec
 homepage: https://github.com/buildboxhq/terminal
@@ -110,9 +116,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.3.0
@@ -120,7 +126,10 @@ signing_key:
 specification_version: 4
 summary: Renders ASCII as HTML
 test_files:
+- spec/fixtures/ascii.sh.raw
+- spec/fixtures/ascii.sh.rendered
 - spec/fixtures/curl.sh.raw
 - spec/fixtures/curl.sh.rendered
 - spec/spec_helper.rb
+- spec/support/fixture.rb
 - spec/terminal/renderer_spec.rb