termcolorlight 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28b23d731c9a8c265527f0a6677348b9d1239a2e
+  data.tar.gz: 8cef95a72714128501ab9efe486b2b26de59b78b
+SHA512:
+  metadata.gz: 33ca0d6f75a7f5805238ea67eaafa72093988bc41fb9b508e5702ad2431c507214d5d141ec29d680a26e97c9f9ad26de32fb7e7b9350a8a54a9f32a700772f36
+  data.tar.gz: 21d0b782675993fb7cb93af9353695d027b43fea17c4f6ee0011356e7c1abf582a733f14440c53e982557ee9447bf5df41dab658b7c9e6c6cc2b18b4044122be

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp
+*.gem

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in termcolorlight.gemspec
+gemspec
+
+gem "rspec"
+gem "rake"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 whiteleaf7
+
+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

@@ -0,0 +1,56 @@
+# TermColorLight
+
+This gem is library that convert color tags (e.g. `<red>str</red>` ) to
+ansicolor(vt100 escape sequence).
+
+Lightweight version of TermColor.gem.
+No use other gems, it is very simply.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'termcolorlight'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install termcolorlight
+
+## Usage
+
+```ruby
+require "termcolorlight"
+
+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
+```
+
+You can use the following tags.
+
+```
+# forground tags
+black, red, green, yellow, blue, magenta, cyan, white, gray
+
+# background tags
+on_black, on_red, on_green, on_yellow, on_blue, on_magenta, on_cyan, on_white, on_gray
+
+# decorations
+bold, dark, underline, underscore, blink, reverse, concealed
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/whiteleaf7/termcolorlight/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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/termcolorlight.rb

@@ -0,0 +1,111 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2014 whiteleaf. All rights reserved.
+#
+
+require "strscan"
+
+module TermColorLight
+  extend self
+
+  VERSION = "1.0.0"
+
+  TAGS = {
+    # foreground colors
+    "black" => "30", "red" => "31", "green" => "32", "yellow" => "33",
+    "blue" => "34", "magenta" => "35", "cyan" => "36", "white" => "37",
+    "gray" => "37",
+    # background colors
+    "on_black" => "40", "on_red" => "41", "on_green" => "42", "on_yellow" => "43",
+    "on_blue" => "44", "on_magenta" => "45", "on_cyan" => "46", "on_white" => "47",
+    "on_gray" => "47",
+    # decorations
+    "bold" => "1", "dark" => "2", "underline" => "4", "underscore" => "4", "blink" => "5",
+    "reverse" => "7", "concealed" => "8",
+  }
+
+  ENTITIES = Hash[*%w(& &amp; < &lt; > &gt; " &quot; ' &apos;)]
+
+  class ParseError < StandardError; end
+
+  def parse(str)
+    stack = []
+    current_tag = ""
+    ss = StringScanner.new(str.to_s)
+    buffer = ""
+    until ss.eos?
+      case
+      when ss.scan(/[^<]+/)
+        buffer.concat(ss.matched)
+      when ss.scan(/<([a-z_]+?)>/i)
+        tag_name = ss[1].downcase
+        tag_index = TAGS[tag_name]
+        unless tag_index
+          raise ParseError, "Unknown tag name (got '#{tag_name}')"
+        end
+        stack.push(tag_index)
+        buffer.concat(create_escape_sequence(tag_index))
+      when ss.scan(/<\/([a-z_]+?)>/i)
+        tag_name = ss[1].downcase
+        expect_tag_index = stack.pop
+        if TAGS[tag_name] != expect_tag_index
+          expect_tag_name = tags_select_by_index(expect_tag_index)
+          raise ParseError, "Missing end tag for '#{expect_tag_name}' (got '#{tag_name}')"
+        end
+        buffer.concat("\e[0m#{create_escape_sequence(stack)}")
+      end
+    end
+    unless stack.empty?
+      for_tag_name = tags_select_by_index(stack.pop)
+      raise ParseError, "Missing end tag for '#{for_tag_name}'"
+    end
+    TermColorLight.unescape(buffer)
+  end
+
+  def escape(str)
+    buf = str.to_s.dup
+    ENTITIES.each do |entity|
+      buf.gsub!(*entity)
+    end
+    buf
+  end
+
+  def unescape(str)
+    buf = str.to_s.dup
+    ENTITIES.invert.each do |entity|
+      buf.gsub!(*entity)
+    end
+    buf
+  end
+
+  def strip_tag(str)
+    TermColorLight.unescape(str.gsub(/<.+?>/, ""))
+  end
+
+  def create_escape_sequence(indexes)   # :nodoc:
+    unless indexes.kind_of?(Array)
+      return "\e[#{indexes}m"
+    end
+    result = ""
+    indexes.each do |index|
+      result.concat("\e[#{index}m")
+    end
+    result
+  end
+
+  def tags_select_by_index(index)   # :nodoc:
+    TAGS.select { |_, idx|
+      idx == index
+    }.keys[0]
+  end
+end
+
+class String
+  def termcolor
+    TermColorLight.parse(self)
+  end
+
+  def escape
+    TermColorLight.escape(self)
+  end
+end

data/spec/termcolorlight_spec.rb

@@ -0,0 +1,267 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2014 whiteleaf. All rights reserved.
+#
+
+require "termcolorlight"
+
+describe TermColorLight do
+  describe ".parse" do
+    context "nil" do
+      it { expect(TermColorLight.parse(nil)).to eq "" }
+    end
+
+    context "give non-string" do
+      it "should be string" do
+        expect(TermColorLight.parse(0)).to eq "0"
+      end
+    end
+
+    context "blank" do
+      it { expect(TermColorLight.parse("")).to eq "" }
+    end
+
+    # memo:
+    # 0:black, 1:red, 2:green, 3:yellow, 4:blue, 5:magenta, 6:cyan, 7:white
+
+    context "color tag" do
+      it "black" do
+        res = TermColorLight.parse("<black>hoge</black>")
+        expect(res).to eq "\e[30mhoge\e[0m"
+      end
+      it "red" do
+        res = TermColorLight.parse("<red>hoge</red>")
+        expect(res).to eq "\e[31mhoge\e[0m"
+      end
+      it "green" do
+        res = TermColorLight.parse("<green>hoge</green>")
+        expect(res).to eq "\e[32mhoge\e[0m"
+      end
+      it "yellow" do
+        res = TermColorLight.parse("<yellow>hoge</yellow>")
+        expect(res).to eq "\e[33mhoge\e[0m"
+      end
+      it "blue" do
+        res = TermColorLight.parse("<blue>hoge</blue>")
+        expect(res).to eq "\e[34mhoge\e[0m"
+      end
+      it "magenta" do
+        res = TermColorLight.parse("<magenta>hoge</magenta>")
+        expect(res).to eq "\e[35mhoge\e[0m"
+      end
+      it "cyan" do
+        res = TermColorLight.parse("<cyan>hoge</cyan>")
+        expect(res).to eq "\e[36mhoge\e[0m"
+      end
+      it "white" do
+        res = TermColorLight.parse("<white>hoge</white>")
+        expect(res).to eq "\e[37mhoge\e[0m"
+      end
+      it "gray is white" do
+        res = TermColorLight.parse("<gray>hoge</gray>")
+        expect(res).to eq "\e[37mhoge\e[0m"
+      end
+    end
+
+    context "background color tag" do
+      it "black" do
+        res = TermColorLight.parse("<on_black>hoge</on_black>")
+        expect(res).to eq "\e[40mhoge\e[0m"
+      end
+      it "red" do
+        res = TermColorLight.parse("<on_red>hoge</on_red>")
+        expect(res).to eq "\e[41mhoge\e[0m"
+      end
+      it "green" do
+        res = TermColorLight.parse("<on_green>hoge</on_green>")
+        expect(res).to eq "\e[42mhoge\e[0m"
+      end
+      it "yellow" do
+        res = TermColorLight.parse("<on_yellow>hoge</on_yellow>")
+        expect(res).to eq "\e[43mhoge\e[0m"
+      end
+      it "blue" do
+        res = TermColorLight.parse("<on_blue>hoge</on_blue>")
+        expect(res).to eq "\e[44mhoge\e[0m"
+      end
+      it "magenta" do
+        res = TermColorLight.parse("<on_magenta>hoge</on_magenta>")
+        expect(res).to eq "\e[45mhoge\e[0m"
+      end
+      it "cyan" do
+        res = TermColorLight.parse("<on_cyan>hoge</on_cyan>")
+        expect(res).to eq "\e[46mhoge\e[0m"
+      end
+      it "white" do
+        res = TermColorLight.parse("<on_white>hoge</on_white>")
+        expect(res).to eq "\e[47mhoge\e[0m"
+      end
+      it "gray is white" do
+        res = TermColorLight.parse("<on_gray>hoge</on_gray>")
+        expect(res).to eq "\e[47mhoge\e[0m"
+      end
+    end
+
+    context "decoration tag" do
+      context "underline" do
+        it do
+          res = TermColorLight.parse("<underline>hoge</underline>")
+          expect(res).to eq "\e[4mhoge\e[0m"
+        end
+
+        it do
+          res = TermColorLight.parse("<underline><red>hoge</red></underline>")
+          expect(res).to eq "\e[4m\e[31mhoge\e[0m\e[4m\e[0m"
+        end
+      end
+
+      context "bold" do
+        it do
+          res = TermColorLight.parse("<bold>hoge</bold>")
+          expect(res).to eq "\e[1mhoge\e[0m"
+        end
+
+        context "with color tag" do
+          context "when before bold" do
+            it do
+              res = TermColorLight.parse("<bold><red>hoge</red></bold>")
+              expect(res).to eq "\e[1m\e[31mhoge\e[0m\e[1m\e[0m"
+            end
+          end
+
+          context "when after bold" do
+            it do
+              res = TermColorLight.parse("<red><bold>hoge</bold></red>")
+              expect(res).to eq "\e[31m\e[1mhoge\e[0m\e[31m\e[0m"
+            end
+          end
+        end
+      end
+
+      context "reverse" do
+        it do
+          res = TermColorLight.parse("<reverse>hoge</reverse>")
+          expect(res).to eq "\e[7mhoge\e[0m"
+        end
+      end
+
+      context "blink" do
+        it do
+          expect(TermColorLight.parse("<blink>hoge</blink>")).to eq "\e[5mhoge\e[0m"
+        end
+      end
+
+      context "dark" do
+        it do
+          expect(TermColorLight.parse("<dark>hoge</dark>")).to eq "\e[2mhoge\e[0m"
+        end
+      end
+
+      context "concealed" do
+        it do
+          expect(TermColorLight.parse("<concealed>hoge</concealed>")).to eq "\e[8mhoge\e[0m"
+        end
+      end
+
+      context "mixed decorate" do
+        it do
+          res = TermColorLight.parse("abc<reverse>d<bold>e<red>f" \
+            "<underline>g</underline>h</red>i</bold></reverse>jk")
+          expect(res).to eq "abc\e[7m\d\e[1me\e[31mf\e[4mg\e[0m" \
+            "\e[7m\e[1m\e[31mh\e[0m\e[7m\e[1mi\e[0m\e[7m\e[0mjk"
+        end
+      end
+    end
+
+    context "ignore case" do
+      it do
+        expect(TermColorLight.parse("<RED>hoge</RED>")).to eq "\e[31mhoge\e[0m"
+      end
+    end
+
+    context "with escaped tag" do
+      it do
+        res = TermColorLight.parse("&lt;red&gt;hoge&lt;/red&gt;")
+        expect(res).to eq "<red>hoge</red>"
+      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
+
+  describe ".escape" do
+    it "should be escaped string" do
+      res = TermColorLight.escape("<red>&hoge</red>")
+      expect(res).to eq "&lt;red&gt;&amp;hoge&lt;/red&gt;"
+    end
+
+    context "give non-string" do
+      context "when nil" do
+        it "should be ''" do
+          expect(TermColorLight.escape(nil)).to eq ""
+        end
+      end
+      context "when integer" do
+        it "should be string" do
+          expect(TermColorLight.escape(0)).to eq "0"
+        end
+      end
+    end
+  end
+
+  describe ".unescape" do
+    it do
+      expect(TermColorLight.unescape("&lt;red&gt;&amp;hoge&apos;&quot;&lt;/red&gt;"))
+        .to eq %!<red>&hoge'"</red>!
+    end
+  end
+
+  describe ".strip_tag" do
+    it do
+      expect(TermColorLight.strip_tag("<red>&quot;&apos;foo&amp;bar &lt;&gt;</red>"))
+        .to eq %!"'foo&bar <>!
+    end
+  end
+end
+
+describe String do
+  context "#termcolor" do
+    it do
+      expect("<red>hoge</red>".termcolor).to eq "\e[31mhoge\e[0m"
+    end
+  end
+
+  context "#escape" do
+    it "should be escaped string" do
+      expect("<red>hoge</red>".escape).to eq "&lt;red&gt;hoge&lt;/red&gt;"
+    end
+  end
+end

data/termcolorlight.gemspec

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2014 whiteleaf. All rights reserved.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'termcolorlight'
+
+Gem::Specification.new do |spec|
+  spec.name          = "termcolorlight"
+  spec.version       = TermColorLight::VERSION
+  spec.authors       = ["whiteleaf7"]
+  spec.email         = ["2nd.leaf@gmail.com"]
+  spec.summary       = "convert color tags to ansicolor library"
+  spec.description = <<-EOS
+This gem is library that convert color tags (e.g. `<red>str</red>` ) to
+ansicolor(vt100 escape sequence).
+
+Lightweight version of TermColor.gem.
+No use other gems, it is very simply.
+  EOS
+  spec.homepage      = "http://github.com/whiteleaf7/termcolorlight"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: termcolorlight
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- whiteleaf7
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-05 00:00:00.000000000 Z
+dependencies: []
+description: |
+  This gem is library that convert color tags (e.g. `<red>str</red>` ) to
+  ansicolor(vt100 escape sequence).
+
+  Lightweight version of TermColor.gem.
+  No use other gems, it is very simply.
+email:
+- 2nd.leaf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/termcolorlight.rb
+- spec/termcolorlight_spec.rb
+- termcolorlight.gemspec
+homepage: http://github.com/whiteleaf7/termcolorlight
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: convert color tags to ansicolor library
+test_files:
+- spec/termcolorlight_spec.rb