acclaim 0.4.1 → 0.5.0

data/acclaim.version

@@ -1 +1 @@
-0.4.1
+0.5.0

data/lib/acclaim.rb

@@ -7,6 +7,7 @@ end
 
 %w(
 
+acclaim/ansi
 acclaim/command
 acclaim/gem
 acclaim/option

data/lib/acclaim/ansi.rb

@@ -0,0 +1,193 @@
+require 'ribbon'
+
+module Acclaim
+
+  # ANSI escape codes for colors and effects.
+  #
+  # @see http://en.wikipedia.org/wiki/ANSI_escape_code ANSI escape code
+  # @see Acclaim::CoreExtensions::String::ANSI
+  # @author Matheus Afonso Martins Moreira
+  # @since 0.5.0
+  module ANSI
+  end
+
+  class << ANSI
+
+    # Extends the String class with an object-oriented ANSI escape code API.
+    #
+    # @see Acclaim::CoreExtensions::String::ANSI
+    def extend_string!
+      require 'acclaim/core_extensions/string/ansi'
+    end
+
+    # Colors from the standard color pallete.
+    #
+    # @return [Array<Symbol>] available colors
+    # @see foreground_color
+    # @see background_color
+    # @see supported_effects
+    def supported_colors
+      colors.keys
+    end
+
+    alias available_colors supported_colors
+
+    # Text effects that can be applied.
+    #
+    # @return [Array<Symbol>] available text effects
+    # @see effects
+    # @see supported_colors
+    def supported_effects
+      text_effects.keys
+    end
+
+    alias available_effects supported_effects
+
+    # Applies foreground color to the given string.
+    #
+    # @param [String, #to_s] string the string the color will be applied to
+    # @param [Symbol] color the name of the color that will be applied
+    # @return [String] new string with the color applied
+    # @see background_color
+    # @see supported_colors
+    def foreground_color(string, color)
+      apply_color_to string, color, foreground_offset
+    end
+
+    # Applies background color to the given string.
+    #
+    # @param [String, #to_s] string the string the color will be applied to
+    # @param [Symbol] color the name of the color that will be applied
+    # @return [String] new string with the color applied
+    # @see foreground_color
+    # @see supported_colors
+    def background_color(string, color)
+      apply_color_to string, color, background_offset
+    end
+
+    # Applies text effects to the given string.
+    #
+    # @param [String, #to_s] string the string the effects will be applied to
+    # @param [Array<Symbol>] effects the text effects to apply
+    # @return [String] new string with the text effects applied
+    # @see supported_effects
+    def effects(string, *effects)
+      apply_escape_codes_to string do
+        effects.select do |effect|
+          text_effects.has_key? effect
+        end.map do |effect|
+          text_effects[effect]
+        end
+      end
+    end
+
+    private
+
+    # Computes the color escape code and applies it to the string.
+    #
+    # @param [String, #to_s] string the string the color will be applied to
+    # @param [Symbol] color the name of the color that will be applied
+    # @param [Integer] offset background or foreground color code offset
+    # @return [String] new string with the color applied
+    def apply_color_to(string, color, offset)
+      apply_escape_code_to string do
+        offset + colors[color] if colors.has_key? color
+      end
+    end
+
+    # Applies the escape codes returned by the block to the given string.
+    #
+    # @note A reset escape code will be appended to the string if it does not
+    #   end with one.
+    #
+    # @param [String, #to_s] string the string the code will be applied to
+    # @yieldreturn [Integer, Array<Integer>] escape code(s) to apply
+    # @return [String] new string with the escape codes applied
+    def apply_escape_codes_to(string)
+      string.to_s.dup.tap do |string|
+        [*yield].map(&:to_i).each do |escape_code|
+          string.prepend select_graphic_rendition escape_code
+        end
+
+        code = reset
+        string.concat code unless self =~ /#{Regexp.escape code}\z/ix
+      end
+    end
+
+    alias apply_escape_code_to apply_escape_codes_to
+
+    # Escape code that resets all SGR settings.
+    #
+    # @return [String] reset escape code
+    def reset
+      select_graphic_rendition
+    end
+
+    # Creates a Select Graphic Rendition (SGR) escape code.
+    #
+    # @param [Integer] parameter the SGR parameter
+    # @return [String] escape code string
+    def select_graphic_rendition(parameter = 0)
+      "\e[#{parameter}m"
+    end
+
+    alias sgr select_graphic_rendition
+
+    # Foreground color SGR parameter offset.
+    #
+    # @return [Integer] the offset where background colors start
+    # @see background_offset
+    # @see colors
+    def foreground_offset
+      30
+    end
+
+    # Background color SGR parameter offset.
+    #
+    # @return [Integer] the offset where foreground colors start
+    # @see foreground_offset
+    # @see colors
+    def background_offset
+      40
+    end
+
+    # Color names mapped to their escape codes.
+    #
+    # @note These values should be used with an appropriate offset.
+    #
+    # @return [Hash] colors associated with their escape codes
+    # @see foreground_offset
+    # @see background_offset
+    def colors
+      @colors ||= Ribbon.wrap do
+        black 0
+        red 1
+        green 2
+        yellow 3
+        blue 4
+        magenta 5
+        cyan 6
+        white 7
+        ribbon.default 9
+      end.to_hash
+    end
+
+    # Text effects mapped to their escape codes.
+    #
+    # @return [Hash] effects associated with their escape codes
+    def text_effects
+      @text_effects ||= Ribbon.wrap do
+        bright bold 1
+        faint 2
+        italic 3
+        underline 4
+        blink 5
+        negative inverse reverse 7
+        conceal hide 8
+        strikethrough strikeout crossed_out 9
+      end.to_hash
+    end
+
+  end
+
+end

data/lib/acclaim/core_extensions.rb

@@ -0,0 +1,16 @@
+module Acclaim
+
+  # Acclaim extensions to the Ruby standard library.
+  #
+  # @author Matheus Afonso Martins Moreira
+  # @since 0.5.0
+  module CoreExtensions
+  end
+
+end
+
+%w(
+
+acclaim/core_extensions/string
+
+).each { |file| require file }

data/lib/acclaim/core_extensions/string.rb

@@ -0,0 +1,18 @@
+module Acclaim
+  module CoreExtensions
+
+    # Acclaim extensions to the String class.
+    #
+    # @author Matheus Afonso Martins Moreira
+    # @since 0.5.0
+    module String
+    end
+
+  end
+end
+
+%w(
+
+acclaim/core_extensions/string/ansi
+
+).each { |file| require file }

data/lib/acclaim/core_extensions/string/ansi.rb

@@ -0,0 +1,49 @@
+require 'acclaim/ansi'
+
+module Acclaim
+  module CoreExtensions
+    module String
+
+      # Object-oriented ANSI escape code API.
+      #
+      # @see Acclaim::ANSI Acclaim::ANSI
+      # @author Matheus Afonso Martins Moreira
+      # @since 0.5.0
+      module ANSI
+
+        # Applies foreground color to this string.
+        #
+        # @param [Symbol] color the name of the color that will be applied
+        # @return [String] new string with the color applied
+        # @see #background
+        # @see Acclaim::ANSI.supported_colors
+        def foreground(color)
+          Acclaim::ANSI.foreground_color self, color
+        end
+
+        # Applies background color to this string.
+        #
+        # @param [Symbol] color the name of the color that will be applied
+        # @return [String] new string with the color applied
+        # @see #foreground
+        # @see Acclaim::ANSI.supported_colors
+        def background(color)
+          Acclaim::ANSI.background_color self, color
+        end
+
+        # Applies text effects to this string.
+        #
+        # @param [Array<Symbol>] effects the text effects to apply
+        # @return [String] new string with the text effects applied
+        # @see Acclaim::ANSI.supported_effects
+        def effects(*effects)
+          Acclaim::ANSI.effects self, *effects
+        end
+
+      end
+
+      ::String.send :include, ANSI
+
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acclaim
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-22 00:00:00.000000000 Z
+date: 2012-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jewel
@@ -122,6 +122,7 @@ files:
 - acclaim.gemspec
 - acclaim.version
 - lib/acclaim.rb
+- lib/acclaim/ansi.rb
 - lib/acclaim/command.rb
 - lib/acclaim/command/dsl.rb
 - lib/acclaim/command/dsl/root.rb
@@ -130,6 +131,9 @@ files:
 - lib/acclaim/command/help/template/command.erb
 - lib/acclaim/command/parser.rb
 - lib/acclaim/command/version.rb
+- lib/acclaim/core_extensions.rb
+- lib/acclaim/core_extensions/string.rb
+- lib/acclaim/core_extensions/string/ansi.rb
 - lib/acclaim/gem.rb
 - lib/acclaim/option.rb
 - lib/acclaim/option/arity.rb
@@ -168,7 +172,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 603733755456817877
+      hash: 1568560335460056762
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -177,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 603733755456817877
+      hash: 1568560335460056762
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24