termcolorlight 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffa13ca897e6881bb281555422245409cfc950ca
-  data.tar.gz: 8e182856b0a394e7481238d0ba6313df8f889321
+  metadata.gz: ac7c7270e7a4af913ceb1bc407d1ab29218a981a
+  data.tar.gz: ef1686b75a7a44bede28fe31e9445c5b2cb28b48
 SHA512:
-  metadata.gz: 0f123d1175bef301adf5e07f8b85d8fdef1e517a748a392b63ec27a41a017553d213db30fca74c995c90a76d496f550a3a41f8a69f144b6553f9ae19839203b0
-  data.tar.gz: a36cb8766a5c4c014902f2ba377b072a915701be0f77ab8fb5fe1e5a2f9ff89946b91c6b3eb365c3623a36dcc58126afb73c5b175a419122709e35ba1b7927df
+  metadata.gz: a7edf680a26cc6dd614573001e6bf4b247649ab8c9fe9de64483a97621d4bf13c2e1a95703642257588ac3076cc5a4de05453da0d91bf7cc321037a1c177d547
+  data.tar.gz: 7b8207e7e7041eca074828ebb34be141a01e05cce4c2bdb35473d5a7eaa2e2a6d4cc5327340d11d92ad444a9f039ae585c4e68b4d6250d18fee65e447d7f3c01

data/.gitignore

@@ -14,3 +14,5 @@
 mkmf.log
 *.swp
 *.gem
+.DS_Store
+

data/README.md

@@ -29,9 +29,18 @@ TermColorLight.parse("<red>strings</red>")  # => \e[31mstrings\e[0m
 "<red>strings</red>".termcolor  # a ditto
 
 str = "<div>container</div>"
-"<bold><green>#{str.escape}</green></bold>"  # => \e[1m\e[32m<div>container</div>\e[0m\e[1m\e[0m
+"<bold><green>#{str.escape}</green></bold>".termcolor  # => \e[1m\e[32m<div>container</div>\e[0m\e[1m\e[0m
 ```
 
+```ruby
+require "termcolorlight/html"
+str = "<div>container</div>"
+TermColorLight.to_html("<bold><green>#{str.escape}</green></bold>")
+# => <span style="font-weight:bold"><span style="color:lime">&lt;div&gt;container&lt;/div&gt;</span></span>
+```
+
+![HTML ScreenCapture](html_ss.png)
+
 You can use the following tags.
 
 ```
@@ -94,6 +103,13 @@ TermColorLight.parse   0.850000   0.000000   0.850000 (  0.853439)
 
 Oops...
 
+## Changelogs
+
+### version 1.1.0 (2014/10/03)
+
++ add a method **TermColorLight.to_html**
+	- Perfect emuration of terminal
+
 ## Contributing
 
 1. Fork it ( https://github.com/whiteleaf7/termcolorlight/fork )

data/lib/termcolorlight.rb

@@ -8,7 +8,7 @@ require "strscan"
 module TermColorLight
   module_function
 
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 
   TAGS = {
     # foreground colors
@@ -30,7 +30,6 @@ module TermColorLight
 
   def parse(str)
     stack = []
-    current_tag = ""
     ss = StringScanner.new(str.to_s)
     buffer = ""
     until ss.eos?
@@ -78,8 +77,10 @@ module TermColorLight
     buf
   end
 
-  def strip_tag(str)
-    TermColorLight.unescape(str.gsub(/<.+?>/, ""))
+  def strip_tag(str, do_unescape = true)
+    result = str.gsub(/<.+?>/, "")
+    result = TermColorLight.unescape(result) if do_unescape
+    result
   end
 
   def create_escape_sequence(indexes)   # :nodoc:

data/lib/termcolorlight/html.rb

@@ -0,0 +1,176 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2014 whiteleaf. All rights reserved.
+#
+
+require_relative "../termcolorlight"
+
+#
+# TermColorLight.to_html 実装用エクステンション
+#
+module TermColorLight
+  module_function
+
+  # 色定義
+  # フォーマット: "name" => ["暗い色", "明るい色"]
+  @@colors = {
+    "black" => %w(black #888), "white" => %w(#bbb white),
+    "red" => %w(indianred red), "green" => %w(green lime),
+    "yellow" => %w(goldenrod yellow), "blue" => %w(#33c #33f),
+    "magenta" => %w(darkmagenta magenta), "cyan" => %w(darkcyan cyan),
+    "fg_default" => %w(white white),
+    "bg_default" => %w(#333 #333)
+  }
+  @@decoration_styles = {
+    "underline" => "text-decoration:underline",
+    "underscore" => "text-decoration:underline",
+    "bold" => "font-weight:bold",
+    "blink" => "text-decoration:blink",
+    "concealed" => "visibility:hidden",
+  }
+
+  def set_colors(hash)
+    @@colors.merge!(hash)
+  end
+
+  def set_styles(hash)
+    @@decoration_styles.merge!(hash)
+  end
+
+  def default_foreground_color=(color)
+    @@colors["fg_default"] = [color, color]
+  end
+
+  def default_background_color=(color)
+    @@colors["bg_default"] = [color, color]
+  end
+
+  def to_html(str)
+    @@before_fg_color = @@before_bg_color = nil
+    ss = StringScanner.new(str.to_s)
+    result = parse_for_html(ss)
+  end
+
+  def parse_for_html(ss, fgcolor = "fg_default", bgcolor = "bg_default",
+                     intensity = false, reverse = false, parent = nil)
+    buffer = ""
+    until ss.eos?
+      case
+      when ss.scan(/[^<]+/)
+        buffer.concat(ss.matched)
+      when ss.scan(/<([a-z_]+?)>/i)
+        tag = ss[1].downcase
+        unless valid_tag?(tag)
+          raise ParseError, "Unknown tag name (got '#{tag}')"
+        end
+        tmp_fg = fgcolor
+        tmp_bg = bgcolor
+        tmp_intensity = intensity
+        tmp_reverse = reverse
+        influence_of_color = false
+        styles = []
+        case
+        when color_tag?(tag)
+          tmp_fg = tag
+          influence_of_color = true
+        when tag =~ /^on_(.+)$/
+          tmp_bg = $1
+          unless valid_tag?(tmp_bg)
+            raise ParseError, "Unknown tag name (got '#{tag}')"
+          end
+          influence_of_color = true
+        when tag == "bold"
+          tmp_intensity = true
+          influence_of_color = true
+        when tag == "reverse"
+          tmp_reverse = true
+          influence_of_color = true
+        end
+        if influence_of_color
+          styles += build_color(tmp_fg, tmp_bg, tmp_intensity, tmp_reverse)
+        end
+        decoration = @@decoration_styles[tag]
+        styles << decoration if decoration
+        buffer.concat("<span style=\"#{styles.join(";")}\">")
+        buffer.concat(parse_for_html(ss, tmp_fg, tmp_bg, tmp_intensity, tmp_reverse, tag))
+      when ss.scan(/<\/([a-z_]+?)>/i)
+        tag = ss[1].downcase
+        if tag != parent
+          raise ParseError, "Missing end tag for '#{parent}' (got '#{tag}')"
+        end
+        return buffer.concat("</span>")
+      end
+    end
+    if parent
+      raise ParseError, "Missing end tag for '#{parent}'"
+    end
+    buffer
+  end
+
+  def valid_tag?(tag)
+    TAGS.include?(tag)
+  end
+
+  def color_tag?(tag)
+    @@colors.include?(tag)
+  end
+
+  def influence_of_color?(tag)
+    TAGS_INFLUENCE_OF_COLOR.include?(tag)
+  end
+
+  def build_color(fgcolor, bgcolor, intensity, reverse)
+    style = []
+    if reverse
+      fg_intensity = 0
+      bg_intensity = intensity ? 1 : 0
+      tmp = fgcolor
+      fgcolor = bgcolor
+      bgcolor = tmp
+    else
+      fg_intensity = intensity ? 1 : 0
+      bg_intensity = 0
+    end
+    if fgcolor != "fg_default"
+      color = @@colors[fgcolor][fg_intensity]
+      if @@before_fg_color != color
+        style << "color:#{color}"
+        @@before_fg_color = color
+      end
+    end
+    if bgcolor != "bg_default"
+      color = @@colors[bgcolor][bg_intensity]
+      if @@before_bg_color != color
+        style << "background:#{color}"
+        @@before_bg_color = color
+      end
+    end
+    style
+  end
+
+  def output_test_sheets
+    puts <<-HTML
+<html><head>
+<style>body{color:#{@@colors["fg_default"][0]};background:#{@@colors["bg_default"][0]}}</style>
+</head><body><table>
+    HTML
+    @@colors.each_key do |color|
+      next if color =~ /default/
+      puts "<tr><td>"
+      puts to_html("<#{color}>#{color}</#{color}>")
+      puts "</td><td>"
+      puts to_html("<bold><#{color}>#{color}</#{color}></bold>")
+      puts "</td><td>"
+      puts to_html("<on_#{color}>on_#{color}</on_#{color}>")
+      puts "</td><td>"
+      puts to_html("<reverse><bold><#{color}>#{color}</#{color}></bold></reverse>")
+      puts "</td></tr>"
+    end
+    puts "</table></body></html>"
+  end
+end
+
+if $0 == __FILE__
+  TermColorLight.output_test_sheets
+end
+

data/spec/termcolorlight_html_spec.rb

@@ -0,0 +1,170 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2014 whiteleaf. All rights reserved.
+#
+
+require "termcolorlight/html"
+
+describe TermColorLight do
+  describe ".to_html" do
+    context "give color tag" do
+      it do
+        expect(TermColorLight.to_html("<red>red</red>"))
+          .to eq '<span style="color:indianred">red</span>'
+      end
+
+      it "white is not white" do
+        expect(TermColorLight.to_html("<white>white?</white>"))
+          .to eq '<span style="color:#bbb">white?</span>'
+      end
+    end
+
+    context "give bold tag" do
+      it do
+        expect(TermColorLight.to_html("<bold>bold</bold>"))
+          .to eq '<span style="font-weight:bold">bold</span>'
+      end
+
+      it "should be bold when double bold" do
+        expect(TermColorLight.to_html("<bold><bold>bold</bold>bold</bold>"))
+          .to eq '<span style="font-weight:bold"><span style="font-weight:bold">bold</span>bold</span>'
+      end
+    end
+
+    context "give bold and color tag" do
+      it do
+        expect(TermColorLight.to_html("<bold><red>str</red>bold</bold>"))
+          .to eq '<span style="font-weight:bold"><span style="color:red">str</span>bold</span>'
+      end
+
+      it do
+        expect(TermColorLight.to_html("<red><bold>BOLD RED</bold> NORMAL RED</red>"))
+          .to eq '<span style="color:indianred"><span style="color:red;font-weight:bold">BOLD RED</span> NORMAL RED</span>'
+      end
+    end
+
+    context "give underline" do
+      it do
+        expect(TermColorLight.to_html("<underline>str</underline>"))
+          .to eq '<span style="text-decoration:underline">str</span>'
+      end
+    end
+
+    context "give background color" do
+      it do
+        expect(TermColorLight.to_html("<on_red>str</on_red>"))
+          .to eq '<span style="background:indianred">str</span>'
+      end
+
+      it "with bold" do
+        expect(TermColorLight.to_html("<bold><on_green>str</on_green></bold>"))
+          .to eq '<span style="font-weight:bold"><span style="background:green">str</span></span>'
+      end
+
+      it "with bold" do
+        expect(TermColorLight.to_html("<on_green><bold>str</bold> non bold</on_green>"))
+          .to eq '<span style="background:green"><span style="font-weight:bold">str</span> non bold</span>'
+      end
+
+      it "with color tag" do
+        expect(TermColorLight.to_html("<on_cyan>bgcyan <yellow>yellow</yellow> bgcyan</on_cyan>"))
+          .to eq '<span style="background:darkcyan">bgcyan <span style="color:goldenrod">yellow</span> bgcyan</span>'
+      end
+    end
+
+    context "give reverse" do
+      it do
+        expect(TermColorLight.to_html("<reverse>str</reverse>"))
+          .to eq '<span style="color:#333;background:white">str</span>'
+      end
+
+      it "do nothing when double reverse" do
+        expect(TermColorLight.to_html("<reverse><reverse>foo</reverse>bar</reverse>"))
+          .to eq '<span style="color:#333;background:white"><span style="">foo</span>bar</span>'
+      end
+
+      context "with color tag" do
+        it do
+          expect(TermColorLight.to_html("<reverse><white>str</white></reverse>"))
+            .to eq '<span style="color:#333;background:white"><span style="background:#bbb">str</span></span>'
+        end
+
+        it do
+          expect(TermColorLight.to_html("<reverse><blue>str</blue> foo</reverse>"))
+           .to eq '<span style="color:#333;background:white"><span style="background:#33c">str</span> foo</span>'
+        end
+
+        it do
+          expect(TermColorLight.to_html("<blue><reverse>str</reverse></blue>"))
+            .to eq '<span style="color:#33c"><span style="color:#333;background:#33c">str</span></span>'
+        end
+      end
+
+      context "with background tag" do
+        it do
+          expect(TermColorLight.to_html("<reverse><on_red>str</on_red></reverse>"))
+            .to eq '<span style="color:#333;background:white"><span style="color:indianred">str</span></span>'
+        end
+      end
+
+      context "with bold tag" do
+        it do
+          expect(TermColorLight.to_html("<reverse><bold>str</bold></reverse>"))
+            .to eq '<span style="color:#333;background:white"><span style="font-weight:bold">str</span></span>'
+        end
+
+        it do
+          expect(TermColorLight.to_html("<reverse><bold><red>str</red></bold></reverse>"))
+            .to eq '<span style="color:#333;background:white"><span style="font-weight:bold"><span style="background:red">str</span></span></span>'
+        end
+
+        it do
+          expect(TermColorLight.to_html("<reverse><red><bold>str</bold></red></reverse>"))
+            .to eq '<span style="color:#333;background:white"><span style="background:indianred"><span style="background:red;font-weight:bold">str</span></span></span>'
+        end
+
+        it do
+          expect(TermColorLight.to_html("<bold><green><reverse>str</reverse></green></bold>"))
+            .to eq '<span style="font-weight:bold"><span style="color:lime"><span style="color:#333;background:lime">str</span></span></span>'
+        end
+      end
+    end
+
+    context "give entities" do
+      it "should be keep entities" do
+        expect(TermColorLight.to_html("&lt;&gt;&amp;%apos;&nbsp;")).to eq "&lt;&gt;&amp;%apos;&nbsp;"
+      end
+    end
+
+    describe "abnormal" do
+      context "invalid tag" do
+        it "raise error" do
+          expect { TermColorLight.parse("<unknown>hoge</unknown>") }
+            .to raise_error(TermColorLight::ParseError, "Unknown tag name (got 'unknown')")
+        end
+      end
+
+      context "invalid background color" do
+        it "raise error" do
+          expect { TermColorLight.parse("<on_unknown>hoge</on_unknown>") }
+            .to raise_error(TermColorLight::ParseError, "Unknown tag name (got 'on_unknown')")
+        end
+      end
+
+      context "invalid tag order" do
+        it "raise error" do
+          expect { TermColorLight.parse("<bold><red>hoge</bold></red>") }
+            .to raise_error(TermColorLight::ParseError, "Missing end tag for 'red' (got 'bold')")
+        end
+      end
+
+      context "when unclose tag" do
+        it "raise error" do
+          expect { TermColorLight.parse("<red>hoge") }
+            .to raise_error(TermColorLight::ParseError, "Missing end tag for 'red'")
+        end
+      end
+    end
+  end
+end
+

data/spec/termcolorlight_spec.rb

@@ -245,10 +245,15 @@ describe TermColorLight do
   end
 
   describe ".strip_tag" do
-    it do
+    it "should be strop tag and unescaped entity" do
       expect(TermColorLight.strip_tag("<red>&quot;&apos;foo&amp;bar &lt;&gt;</red>"))
         .to eq %!"'foo&bar <>!
     end
+
+    it "shoul be strip tag and NOT unescaped entity" do
+      expect(TermColorLight.strip_tag("<red>&quot;&apos;foo&amp;bar &lt;&gt;</red>", false))
+        .to eq "&quot;&apos;foo&amp;bar &lt;&gt;"
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: termcolorlight
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - whiteleaf7
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-10-02 00:00:00.000000000 Z
 dependencies: []
 description: |
   This gem is library that convert color tags (e.g. <red>str</red>) to
@@ -26,7 +26,10 @@ files:
 - README.md
 - Rakefile
 - benchmark.rb
+- html_ss.png
 - lib/termcolorlight.rb
+- lib/termcolorlight/html.rb
+- spec/termcolorlight_html_spec.rb
 - spec/termcolorlight_spec.rb
 - termcolorlight.gemspec
 homepage: http://github.com/whiteleaf7/termcolorlight
@@ -54,4 +57,5 @@ signing_key:
 specification_version: 4
 summary: convert color tags to ansicolor library
 test_files:
+- spec/termcolorlight_html_spec.rb
 - spec/termcolorlight_spec.rb