tco 0.0.1 → 0.1.0

data/lib/tco/parser.rb

@@ -0,0 +1,199 @@
+# tco - terminal colouring application and library
+# Copyright (c) 2013, 2014 Radek Pazdera
+
+# 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.
+
+module Tco
+  class Token
+    attr_reader :type
+
+    def initialize(type, value)
+      @type = type
+      @value = value
+    end
+
+    def to_s
+      @value
+    end
+  end
+
+  class Segment
+    attr_reader :value, :params
+
+    def initialize(value, params)
+      @value = value
+      @params = params
+    end
+
+    def to_s
+      @value
+    end
+
+    # For rspec assertions
+    def ==(other)
+      @value == other.value && @params == other.params
+    end
+  end
+
+  class Parser
+    def initialize(default_style=nil)
+      @default_params = {
+        :base_style => nil,
+        :fg => nil,
+        :bg => nil,
+        :bright => false,
+        :underline => false
+      }
+
+      if default_style
+        @default_params[:fg] = default_style.fg
+        @default_params[:bg] = default_style.bg
+        @default_params[:bright] = default_style.bright
+        @default_params[:underline] = default_style.underline
+      end
+    end
+
+    def parse(string)
+      lexer string
+      parser
+      @segments
+    end
+
+    private
+    def submit_token(type, value)
+      return if value == ""
+
+      if type == :normal && @tokens.length > 0 && @tokens[-1].type == :normal
+        prev = @tokens.pop
+        @tokens.push Token.new :normal, prev.to_s + value
+      else
+        @tokens.push Token.new type, value
+      end
+    end
+
+    def lexer(in_str)
+      state = :default
+      @tokens = []
+      token = ""
+
+      in_str.split("").each do |c|
+        case state
+        when :default
+          case c
+          when "{"
+            submit_token :normal, token
+            token = c
+
+            state = :o_br
+          when "}"
+            submit_token :normal, token
+            token = c
+
+            state = :c_br
+          else
+            token << c
+          end
+        when :o_br
+          case c
+          when "{"
+            state = :definition
+          else
+            state = :default
+          end
+          token << c
+        when :definition
+          case c
+          when /[a-zA-Z0-9\:\-#]/
+            token << c
+          when /\s/
+            submit_token :definition, token
+            token = ""
+
+            state = :default
+          else
+            token << c
+            state = :default
+          end
+        when :c_br
+          token << c
+          if c == "}"
+            submit_token :end, token
+            token = ""
+          end
+          state = :default
+        end
+      end
+      submit_token :normal, token unless token == ""
+    end
+
+    def add_segment(t, params)
+      return if t.to_s == ""
+
+      if @segments.length > 0 && @segments[-1].params == params
+        prev = @segments.pop
+        @segments.push Segment.new prev.to_s + t.to_s, params
+      else
+        @segments.push Segment.new t.to_s, params
+      end
+    end
+
+    def parser
+      @segments = []
+      params = @default_params
+
+      stack = []
+      @tokens.each do |t|
+        case t.type
+        when :definition
+          prev_params = params
+          stack.push params
+
+          params = prev_params.clone
+
+          df = t.to_s[2..-1]
+          if df.include? ":"
+            c = df.split ":"
+            c.push "" if df[-1] == ":"
+
+            params[:fg] = c[0] unless c[0] == "" || c[0] == "-"
+            params[:bg] = c[1] unless c[1] == "" || c[1] == "-"
+            params[:bright] = true if c.length > 2 && c[2].include?("b")
+            params[:underline] = true if c.length > 2 && c[2].include?("u")
+          else
+            params[:base_style] = df
+            params[:fg] = nil
+            params[:bg] = nil
+            params[:bright] = false
+            params[:underline] = false
+          end
+        when :end
+          if stack.length > 0
+            params = stack.pop
+          else
+            add_segment t, params
+          end
+        else
+          add_segment t, params
+        end
+      end
+    end
+  end
+end

data/lib/tco/style.rb

@@ -0,0 +1,51 @@
+# tco - terminal colouring application and library
+# copyright (c) 2013, 2014 radek pazdera
+
+# 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.
+
+module Tco
+  class Style
+    attr_accessor :fg, :bg, :bright, :underline
+
+    def initialize(fg=nil, bg=nil, bright=false, underline=false)
+      @fg = fg
+      @bg = bg
+      @bright = bright
+      @underline = underline
+    end
+
+    def to_a
+      [@fg, @bg, @bright, @underline]
+    end
+
+    def to_h
+      {:fg => @fg, :bg => @bg, :bright => @bright, :underline => @underline}
+    end
+
+    def to_ary
+      to_a
+    end
+
+    def ==(o)
+      @fg == o.fg && @bg == o.bg && @bright == o.bright && @underline == o.underline
+    end
+  end
+end

data/lib/tco/version.rb

@@ -0,0 +1,26 @@
+# tco - terminal colouring application and library
+# Copyright (c) 2013, 2014 Radek Pazdera
+
+# 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.
+
+module Tco
+  VERSION = "0.1.0"
+end

data/spec/parser_spec.rb

@@ -0,0 +1,166 @@
+# tco - terminal colouring application and library
+# Copyright (c) 2013, 2014 Radek Pazdera
+
+# 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.
+
+require "utils"
+
+require "tco/parser"
+
+RSpec.configure do |c|
+  c.include Utils
+end
+
+describe Tco do
+  describe Tco::Parser do
+    before :all do
+      @p = Tco::Parser.new
+    end
+
+    it "handles no definitions" do
+      string = "London"
+      expected = [
+        Tco::Segment.new("London", get_params)
+      ]
+
+      segments = @p.parse string
+      segments.should == expected
+    end
+
+    it "works with fg colour only" do
+      string = "The City of {{grey: London}}, UK"
+      expected = [
+        Tco::Segment.new("The City of ", get_params),
+        Tco::Segment.new("London", get_params(nil, "grey")),
+        Tco::Segment.new(", UK", get_params)
+      ]
+
+      segments = @p.parse string
+      segments.should == expected
+    end
+
+    it "works with bg colour only" do
+      string = "The City of {{-:red London}}, UK"
+      expected = [
+        Tco::Segment.new("The City of ", get_params),
+        Tco::Segment.new("London", get_params(nil, nil, "red")),
+        Tco::Segment.new(", UK", get_params)
+      ]
+
+      segments = @p.parse string
+      segments.should == expected
+    end
+
+    it "works with both colours" do
+      string = "The City of {{grey:red London}}, UK"
+      expected = [
+        Tco::Segment.new("The City of ", get_params),
+        Tco::Segment.new("London", get_params(nil, "grey", "red")),
+        Tco::Segment.new(", UK", get_params)
+      ]
+
+      segments = @p.parse string
+      segments.should == expected
+    end
+
+    it "makes it bold" do
+      string = "The City of {{::b London}}, UK"
+      expected = [
+        Tco::Segment.new("The City of ", get_params),
+        Tco::Segment.new("London", get_params(nil, nil, nil, true)),
+        Tco::Segment.new(", UK", get_params)
+      ]
+
+      segments = @p.parse string
+      segments.should == expected
+    end
+
+    it "underlines the text" do
+      string = "The City of {{::u London}}, UK"
+      expected = [
+        Tco::Segment.new("The City of ", get_params),
+        Tco::Segment.new("London", get_params(nil, nil, nil, false, true)),
+        Tco::Segment.new(", UK", get_params)
+      ]
+
+      segments = @p.parse string
+      segments.should == expected
+    end
+
+    it "works with a style" do
+      string = "The City of {{alert London}}, UK"
+      expected = [
+        Tco::Segment.new("The City of ", get_params),
+        Tco::Segment.new("London", get_params("alert")),
+        Tco::Segment.new(", UK", get_params)
+      ]
+
+      segments = @p.parse string
+      segments.should == expected
+    end
+
+    it "can be nested" do
+      string = "The {{alert City of {{grey:red London}},}} UK"
+      expected = [
+        Tco::Segment.new("The ", get_params),
+        Tco::Segment.new("City of ", get_params("alert")),
+        Tco::Segment.new("London", get_params("alert", "grey", "red")),
+        Tco::Segment.new(",", get_params("alert")),
+        Tco::Segment.new(" UK", get_params)
+      ]
+
+      segments = @p.parse string
+      segments.should == expected
+    end
+
+    it "doesn't process empty template" do
+      string = "London {{}}"
+      expected = [
+        Tco::Segment.new("London {{}}", get_params),
+      ]
+
+      segments = @p.parse string
+      segments.should == expected
+    end
+
+    it "doesn't process template without a space" do
+      string = "{{grey:redLondon}}"
+      expected = [
+        Tco::Segment.new("{{grey:redLondon}}", get_params),
+      ]
+
+      segments = @p.parse string
+      segments.should == expected
+    end
+
+    it "ignores mismatched endings" do
+      string = "}} {{grey:red London}} }}"
+      expected = [
+        Tco::Segment.new("}} ", get_params),
+        Tco::Segment.new("London", get_params(nil, "grey", "red")),
+        Tco::Segment.new(" }}", get_params),
+      ]
+
+      segments = @p.parse string
+      segments.should == expected
+    end
+  end
+end

data/spec/string_ext_spec.rb

@@ -0,0 +1,106 @@
+# tco - terminal colouring application and library
+# Copyright (c) 2013, 2014 Radek Pazdera
+
+# 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.
+
+require "tco"
+require "tco/config"
+
+describe Tco do
+  describe "String class extension" do
+    before :all do
+      config = Tco::Config.new
+      config.options["palette"] = "extended"
+      config.options["output"] = "raw"
+      Tco::reconfigure config
+    end
+
+    describe "#fg" do
+      it "works with references" do
+        result = "London".fg "@17"
+        result.should eql "\e[38;5;17mLondon\e[0m"
+      end
+
+      it "works with rgb" do
+        result = "London".fg "#00005f"
+        result.should eql "\e[38;5;17mLondon\e[0m"
+      end
+
+      it "works with hex" do
+        result = "London".fg "0x00005f"
+        result.should eql "\e[38;5;17mLondon\e[0m"
+      end
+
+      it "works with names" do
+        result = "London".fg "black"
+        result.should eql "\e[38;5;0mLondon\e[0m"
+      end
+    end
+
+    describe "#bg" do
+      it "works with references" do
+        result = "London".bg "@17"
+        result.should eql "\e[48;5;17mLondon\e[0m"
+      end
+
+      it "works with rgb" do
+        result = "London".bg "#00005f"
+        result.should eql "\e[48;5;17mLondon\e[0m"
+      end
+
+      it "works with hex" do
+        result = "London".bg "0x00005f"
+        result.should eql "\e[48;5;17mLondon\e[0m"
+      end
+
+      it "works with names" do
+        result = "London".bg "black"
+        result.should eql "\e[48;5;0mLondon\e[0m"
+      end
+    end
+
+    describe "#bright" do
+      it "makes the fond bold" do
+        result = "London".bright
+        result.should eql "\e[1mLondon\e[0m"
+      end
+    end
+
+    describe "#underline" do
+      it "underlines the text" do
+        result = "London".underline
+        result.should eql "\e[4mLondon\e[0m"
+      end
+    end
+
+    it "can be combined" do
+      result = "London".bright.underline.fg("@17").bg("@17")
+      result.should eql "\e[48;5;17m\e[38;5;17m\e[4m\e[1mLondon\e[0m\e[0m\e[0m\e[0m"
+    end
+
+    describe "#decorate" do
+      it "processes templates" do
+        result = " {{::u London}} ".decorate
+        result.should eql " \e[4mLondon\e[0m "
+      end
+    end
+  end
+end