ansi_chameleon 0.0.1

data/Changelog

@@ -0,0 +1,2 @@
+0.0.1 (January 30, 2012)
+  Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyrigth (c) 2012 Jacek Mikrut
+
+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,106 @@
+AnsiChameleon
+=============
+
+AnsiChameleon is a Ruby Gem that **colorizes text terminal output** by converting custom HTML-like tags into color ANSI escape sequences.
+
+Installation
+------------
+
+As a Ruby Gem, AnsiChameleon can be installed either by running
+
+```bash
+  gem install ansi_chameleon
+```
+
+or adding
+
+```ruby
+  gem "ansi_chameleon"
+```
+
+to the Gemfile and then invoking `bundle install`.
+
+Usage
+-----
+
+For **single use**:
+
+```ruby
+  require "ansi_chameleon"
+
+  puts AnsiChameleon.render(
+    "There are <number>3</number> oranges on the table.",
+    :number => { :fg_color => :blue }
+  )
+```
+
+For **multiple use** this is more efficient:
+
+```ruby
+  require "ansi_chameleon"
+
+  text_renderer = AnsiChameleon::TextRenderer.new(:number => { :fg_color => :blue })
+
+  puts text_renderer.render("There are <number>2</number> oranges on the table.")
+  puts text_renderer.render("Now, there is only <number>1</number> orange.")
+```
+
+Details
+-------
+
+In order to produce a colorized output AnsiChameleon needs a **text** and a **style sheet**.
+
+### Text
+
+Text to colorize is expected to include HTML-like tags of custom names, that will then be converted according to the rules defined in provided style sheet.
+
+Tags not included in the style sheet but found in the text being rendered are put to the output without modification.
+
+### Style sheet
+
+A style sheet is simply a CSS-like Hash structure with keys that correspond to custom tag names and property names:
+
+```ruby
+  style_sheet = {
+    # default style declarations (for text not wrapped in tags)
+    :fg_color => :green,
+    :bg_color => :black,
+
+    :number => {
+      # style declarations for <number> tag
+      :fg_color => :blue,
+    },
+    :message => {
+      # style declarations for <message> tag
+      :fg_color => :red,
+      :bg_color => :white,
+
+      :number => {
+        # style declarations for <number> tag nested in <message> tag
+        :fg_color => :inherit
+      }
+    }
+  }
+```
+
+Tag names in a style sheet can be written as either :symbols or "strings".
+
+#### Properties
+
+* `:foreground_color` (aliases: `:foreground`, `:fg_color`)
+* `:background_color` (aliases: `:background`, `:bg_color`)
+
+    Available color values: `:black`, `:red`, `:green`, `:yellow`, `:blue`, `:magenta`, `:cyan`, `:white`.
+
+* `:effect`
+
+    Available effect values: `:none`, `:bright`, `:underline`, `:blink`, `:reverse`.
+
+Also, the `:inherit` value can be set for a property, which means that its value will be inherited from the surrounding tag (or be the default value).
+
+Similarly to tag names, property names and values can be provided as :symbols or "strings".
+
+License
+-------
+
+License is included in the LICENSE file.

data/lib/ansi_chameleon.rb

@@ -0,0 +1,14 @@
+require "ansi_chameleon/version"
+require "ansi_chameleon/array_utils"
+require "ansi_chameleon/sequence_generator"
+require "ansi_chameleon/style_property_name_translator"
+require "ansi_chameleon/style_sheet_handler"
+require "ansi_chameleon/text_rendering"
+require "ansi_chameleon/text_renderer"
+
+module AnsiChameleon
+
+  def self.render(text, style_sheet)
+    TextRenderer.new(style_sheet).render(text)
+  end
+end

data/lib/ansi_chameleon/array_utils.rb

@@ -0,0 +1,20 @@
+module AnsiChameleon
+  module ArrayUtils
+
+    def self.item_spread_map(array, items)
+      remaining_items = items.dup
+
+      map = array.inject('') do |agg, array_item|
+        if array_item == remaining_items.first
+          agg << '1'
+          remaining_items.shift
+        else
+          agg << '0'
+        end
+        agg
+      end
+
+      remaining_items.any? ? nil : map
+    end
+  end
+end

data/lib/ansi_chameleon/sequence_generator.rb

@@ -0,0 +1,32 @@
+module AnsiChameleon
+  module SequenceGenerator
+
+    class UnknownColorName  < ArgumentError; end
+    class UnknownEffectName < ArgumentError; end
+
+    COLORS = [:black, :red, :green, :yellow, :blue, :magenta, :cyan, :white]
+    EFFECTS = { :none => 0, :bright => 1, :underline => 4, :blink => 5, :reverse => 7 }
+
+    def self.effect_code(name)
+      EFFECTS[name.to_sym] or raise UnknownEffectName.new("Unknown effect name #{name.inspect}")
+    end
+
+    def self.foreground_color_code(name)
+      index = COLORS.index(name.to_sym) or raise UnknownColorName.new("Unknown foreground color name #{name.inspect}")
+      30 + index
+    end
+
+    def self.background_color_code(name)
+      index = COLORS.index(name.to_sym) or raise UnknownColorName.new("Unknown background color name #{name.inspect}")
+      40 + index
+    end
+
+    def self.generate(effect_name, foreground_color_name=nil, background_color_name=nil)
+      if effect_name.to_sym == :reset
+        "\033[0m"
+      else
+        "\033[#{effect_code(effect_name)};#{foreground_color_code(foreground_color_name)};#{background_color_code(background_color_name)}m"
+      end
+    end
+  end
+end

data/lib/ansi_chameleon/style_property_name_translator.rb

@@ -0,0 +1,19 @@
+module AnsiChameleon
+  module StylePropertyNameTranslator
+
+    def self.translate(property_name)
+      case property_name
+
+      when :background_color, :background, :bg_color
+        :background_color_name
+
+      when :foreground_color, :foreground, :fg_color
+        :foreground_color_name
+
+      when :effect
+        :effect_name
+
+      end
+    end
+  end
+end

data/lib/ansi_chameleon/style_sheet_handler.rb

@@ -0,0 +1,53 @@
+module AnsiChameleon
+  class StyleSheetHandler
+
+    def initialize(style_sheet_hash, property_name_translator=nil)
+      @tag_names = []
+      @default_values = {}
+      @map = {}
+      @property_name_translator = property_name_translator
+      populate_map(style_sheet_hash)
+    end
+
+    attr_reader :tag_names, :default_values, :map, :property_name_translator
+
+    def value_for(*tag_names_chain, property_name)
+      strongest = strongest_style_definition(*(tag_names_chain.map { |tag_name| tag_name.to_sym }), property_name.to_sym)
+      strongest && strongest[:value]
+    end
+
+    private
+
+    def populate_map(style_definition_hash, tag_names_chain=[])
+      style_definition_hash.each do |key, value|
+
+        case value
+        when Hash
+          tag_name = key.to_sym
+
+          @tag_names << tag_name unless @tag_names.include?(tag_name)
+          populate_map(value, tag_names_chain + [tag_name])
+
+        else
+          property_name = property_name_translator ? property_name_translator.translate(key) : key.to_sym
+
+          @map[property_name] ||= []
+          @map[property_name] << { :value => value, :tag_names_chain => tag_names_chain }
+          @default_values[property_name] = value if tag_names_chain.none?
+
+        end
+      end
+    end
+
+    def strongest_style_definition(*tag_names_chain, property_name)
+      (@map[property_name] || [])
+        .map { |entry|
+          entry.merge(:item_spread_map => AnsiChameleon::ArrayUtils.item_spread_map(tag_names_chain, entry[:tag_names_chain])) }
+        .select { |entry|
+          not entry[:item_spread_map].nil? }
+        .compact
+        .max_by { |entry|
+          entry[:item_spread_map].reverse }
+    end
+  end
+end

data/lib/ansi_chameleon/text_renderer.rb

@@ -0,0 +1,62 @@
+module AnsiChameleon
+  class TextRenderer
+
+    def initialize(style_sheet)
+      @style_sheet_handler = StyleSheetHandler.new(style_sheet, StylePropertyNameTranslator)
+    end
+
+    def render(text)
+      text_rendering = TextRendering.new(@style_sheet_handler)
+
+      chunks(text).each do |chunk|
+        case
+        when opening_tag?(chunk)
+          text_rendering.push_opening_tag(tag_name(chunk))
+
+        when closing_tag?(chunk)
+          text_rendering.push_closing_tag(tag_name(chunk))
+
+        else
+          text_rendering.push_text(chunk)
+
+        end
+      end
+
+      text_rendering.to_s
+    end
+
+    private
+
+    def tag_names_regex
+      @tag_names_regex ||= @style_sheet_handler.tag_names.map { |tag_name| "(?<=<#{tag_name}>)|(?<=<\/#{tag_name}>)|(?=<\/?#{tag_name}>)" }.join('|')
+    end
+
+    def chunk_regex
+      @chunk_regex ||= /(?<= |\t)|(?= |\t)#{'|' + tag_names_regex unless tag_names_regex.empty?}/
+    end
+
+    def opening_tag_regex
+      @opening_tag_regex ||= /^<(?<=[^\/])(?:#{@style_sheet_handler.tag_names.join('|')})>$/
+    end
+
+    def closing_tag_regex
+      @closing_tag_regex ||= /^<\/#{@style_sheet_handler.tag_names.join('|')}>$/
+    end
+
+    def chunks(text)
+      text.split(chunk_regex)
+    end
+
+    def opening_tag?(chunk)
+      chunk =~ opening_tag_regex
+    end
+
+    def closing_tag?(chunk)
+      chunk =~ closing_tag_regex
+    end
+
+    def tag_name(chunk)
+      chunk.match(/^<\/?(?<tag_name>.*)>$/)[:tag_name].to_sym
+    end
+  end
+end

data/lib/ansi_chameleon/text_rendering.rb

@@ -0,0 +1,76 @@
+module AnsiChameleon
+  class TextRendering
+
+    DEFAULT_STYLE = {
+      :effect_name           => :none,
+      :foreground_color_name => :white,
+      :background_color_name => :black
+    }
+
+    def initialize(style_sheet_handler)
+      @style_sheet_handler = style_sheet_handler
+      @stack = []
+      @current_style = DEFAULT_STYLE.merge(@style_sheet_handler.default_values)
+
+      @rendered_text = ''
+      @rendered_text << sequence_for(@current_style)
+    end
+
+    def push_opening_tag(tag_name)
+      @stack.push({ :tag_name => tag_name, :outer_style => @current_style })
+
+      @current_style = deduce_current_style
+      @rendered_text << sequence_for(@current_style)
+    end
+
+    def push_closing_tag(tag_name)
+      unless tag_names_chain.last == tag_name
+        raise SyntaxError.new("Encountered </#{tag_name}> tag that had not been opened yet")
+      end
+
+      @current_style = @stack.pop[:outer_style]
+      @rendered_text << sequence_for(@current_style)
+    end
+
+    def push_text(text)
+      @rendered_text << text
+    end
+
+    def to_s
+      if @stack.any?
+        tag_names = @stack.map { |data| "<#{data[:tag_name]}>" }.join(', ')
+        msg_prefix = @stack.size == 1 ? "Tag #{tag_names} has" : "Tags #{tag_names} have"
+        raise SyntaxError.new(msg_prefix + " been opened but not closed yet")
+      end
+
+      @rendered_text + AnsiChameleon::SequenceGenerator.generate(:reset)
+    end
+
+    private
+
+    def sequence_for(style)
+      AnsiChameleon::SequenceGenerator.generate(
+        style[:effect_name],
+        style[:foreground_color_name],
+        style[:background_color_name]
+      )
+    end
+
+    def tag_names_chain
+      @stack.map { |data| data[:tag_name] }
+    end
+
+    def property_names
+      DEFAULT_STYLE.keys
+    end
+
+    def deduce_current_style
+      property_names.inject({}) do |style, property_name|
+        property_value = @style_sheet_handler.value_for(*tag_names_chain, property_name)
+        style[property_name] = [:inherit, nil].include?(property_value) ? @current_style[property_name] : property_value
+        style
+      end
+    end
+
+  end
+end

data/lib/ansi_chameleon/version.rb

@@ -0,0 +1,3 @@
+module AnsiChameleon
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: ansi_chameleon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jacek Mikrut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &86851630 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *86851630
+description: Colorizes text terminal output by converting custom HTML-like tags into
+  color ANSI escape sequences.
+email: jacekmikrut.software@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ansi_chameleon/array_utils.rb
+- lib/ansi_chameleon/version.rb
+- lib/ansi_chameleon/sequence_generator.rb
+- lib/ansi_chameleon/text_rendering.rb
+- lib/ansi_chameleon/style_property_name_translator.rb
+- lib/ansi_chameleon/style_sheet_handler.rb
+- lib/ansi_chameleon/text_renderer.rb
+- lib/ansi_chameleon.rb
+- README.md
+- LICENSE
+- Changelog
+homepage: http://github.com/jacekmikrut/ansi_chameleon
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Text terminal output coloring tool.
+test_files: []