terminal 0.3.beta1 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4b4dd150fe6a6cfcad302893bdd602885b6dffd
-  data.tar.gz: f2caa188722eca09b14e8f404ff96b837b6b9652
+  metadata.gz: b7b151475b60fc04b00cc33d7aa7b5248d3b3cbc
+  data.tar.gz: 9f6f38830a8df2fbd617dac67c18d8c363eb2c35
 SHA512:
-  metadata.gz: c658ae729a6ef14725497173d11eb8169aaaa0f04387e8a84a32c0461447a805b6d08cbb5b71a1f6fd78292d841ee4b30f0f54f853fbd36aa83f6d4fa8929634
-  data.tar.gz: 35e07c07b55db481be848513ee9838d529e8dfc12e7b5b22d44da79078994284e9f039c4704e788dc965bd0a47e5de5ba012192a9c2298506f0dc7934b562401
+  metadata.gz: 742af5d46b76221b4555dc0ce42c44bdf68cc35367cd164f682aec455888b19f87a40afe195e1fe7abe310ce8750570646d389ecc44771394abff6dad1c7f7f0
+  data.tar.gz: e33305bb8f16ffc673e48dcf4c90393727c27fd19e1832e174823573b6b07e15dcb0b58d1b4e64a2cfd2e28ad00ae29df8627e46d71e72eba6c0e97efe8f35cf

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    terminal (0.2)
+    terminal (0.3)
       escape_utils (~> 1.0)
+      gemoji (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,6 +11,7 @@ GEM
     benchmark-ips (2.0.0)
     diff-lcs (1.2.5)
     escape_utils (1.0.1)
+    gemoji (2.0.0)
     hirb (0.7.2)
     method_profiler (2.0.1)
       hirb (>= 0.6.0)

data/Readme.md

@@ -30,6 +30,36 @@ gem install terminal
 Terminal.render("...")
 ```
 
+### Rails Integration
+
+You can use Terminal directly within your Ruby on Rails application. First require the gem
+in your Gemfile:
+
+```ruby
+gem "terminal"
+```
+
+Then in your `app/assets/application.css` file:
+
+```css
+/* require "terminal" */
+```
+
+Now in your views:
+
+```
+<div class="code"><%= Terminal.render(output)</div>
+```
+
+### Emojis :+1:
+
+Terminal converts unicode to proper `<img>` tags. We use the [gemoji](https://github.com/github/gemoji)
+gem to do this. The path to the assets can be customized by passing the `:emoji_asset_path` option to `Terminal.render`
+
+```ruby
+Terminal.render(output, emoji_asset_path: "https://your.cdn.com/images/emoji")
+```
+
 ### Command Line
 
 Terminal ships with a command line utility. For example, you can pipe `rspec` output to it:

data/app/assets/stylesheets/terminal.css

@@ -5,10 +5,10 @@
 .term-fg34 { color: #8db7e0; } /* blue */
 .term-fg35 { color: #ceacde; } /* magenta */
 .term-fg36 { color: #00cdd9; } /* cyan */
-.term-fg90 { color: #838887; } /* grey */
 
 /* high intense colors */
 .term-fgi1 { color: #5ef765; }
+.term-fgi90 { color: #838887; } /* grey */
 
 /* background colors */
 .term-bg42 { background: #99ff5f; }

data/lib/terminal.rb

@@ -6,7 +6,7 @@ require "terminal/preview"
 require "terminal/engine" if defined?(Rails)
 
 module Terminal
-  def self.render(output)
-    Terminal::Renderer.new(output).render
+  def self.render(output, options = {})
+    Terminal::Renderer.new(output, options).render
   end
 end

data/lib/terminal/renderer.rb

@@ -1,12 +1,18 @@
 require 'escape_utils'
+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
 
-    def initialize(output)
+    def initialize(output, options = {})
       @output = output
+
+      @options = options
+      @options[:emoji_asset_path] ||= "/assets/emojis"
+
       @screen = Screen.new
     end
 
@@ -49,7 +55,10 @@ module Terminal
       output = escape_html(output)
 
       # Now convert the colors to HTML
-      convert_to_html(output)
+      output = convert_to_html(output)
+
+      # And emojify
+      replace_unicode_with_emoji(output)
     end
 
     private
@@ -156,5 +165,24 @@ module Terminal
     def split_by_escape_character(string)
       string.scan(/[\n\r\b]|\e\[[\d;]*[#{ESCAPE_CONTROL_CHARACTERS}]|./)
     end
+
+    def replace_unicode_with_emoji(string)
+      string.gsub(EMOJI_UNICODE_REGEXP) do |match|
+        emoji_image_from_unicode(match)
+      end
+    end
+
+    def emoji_image_from_unicode(unicode)
+      emoji = Emoji.find_by_unicode(unicode)
+
+      if emoji
+        name = ":#{emoji.name}:"
+        path = File.join(@options[:emoji_asset_path], emoji.image_filename)
+
+        %(<img alt="#{name}" title="#{name}" src="#{path}" class="emoji" width="20" height="20" />)
+      else
+        unicode
+      end
+    end
   end
 end

data/lib/terminal/version.rb

@@ -1,3 +1,3 @@
 module Terminal
-  VERSION = "0.3.beta1"
+  VERSION = "0.3"
 end

data/spec/terminal/renderer_spec.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'spec_helper'
 
 describe Terminal::Renderer do
@@ -192,6 +194,12 @@ describe Terminal::Renderer do
 
       expect(render(raw)).to eql("hi amazing \e[12 nom nom nom friends")
     end
+
+    it "renders unicode emoji" do
+      raw = "this is great 👍"
+
+      expect(render(raw)).to eql(%{this is great <img alt=":+1:" title=":+1:" src="/assets/emojis/unicode/1f44d.png" class="emoji" width="20" height="20" />})
+    end
   end
 
   private

data/spec/terminal/screen_spec.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'spec_helper'
 
 describe Terminal::Screen do

data/terminal.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "escape_utils", "~> 1.0"
+  spec.add_dependency "gemoji", "~> 2.0"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal
 version: !ruby/object:Gem::Version
-  version: 0.3.beta1
+  version: '0.3'
 platform: ruby
 authors:
 - Keith Pitt
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -155,9 +169,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