cape-cod 0.1.0 → 0.1.1

data/README.md

@@ -1,25 +1,29 @@
 cape-cod
 ========
 
-
+[![Gem Version](https://badge.fury.io/rb/cape-cod.png)]
+(http://badge.fury.io/rb/cape-cod)
 [![Build Status](https://travis-ci.org/fuadsaud/cape-cod.png?branch=master)]
 (https://travis-ci.org/fuadsaud/cape-cod)
 
-cape-cod makes it easy for you to append ANSI es<strong>CAPE-COD</strong>es - HAR! bet you didn't see
-that coming; I know, I know, I'm a genius - to you strings.
+cape-cod makes it easy for you to append ANSI es<strong>cape-cod</strong>es -
+HAR! bet you didn't see that coming; I know, I know, I'm a genius - to your
+strings.
 
 ### *Hey, but don't we have a plenty of gems that do exactly the same thing?*
 
-**YES**. We can cite [colored](http://github.com/defunkt/colored) - by @defunkt -,
-[colorize](http://github.com/fazibear/colorize) - by @fazibear -,
-[term-ansicolor](http://github.com/flori/term-ansicolor), and so on...
-They are really nice gems, and they solve the escape code problem in different manners
-but they're all abandoned, some accumulating 3 years old issues.
+**YES**. We can cite [colored](http://github.com/defunkt/colored),
+[colorize](http://github.com/fazibear/colorize),
+[term-ansicolor](http://github.com/flori/term-ansicolor),
+[ANSI](http://github.com/rubyworks/ANSI) and so on...
+They are really nice gems, and they solve the escape code problem in different
+manners but they're all kind of abandoned, with a lot of lingering issues...
 
-My point with this gem is to implement many of the possible ways of appending ANSI escape
-codes to strings (monkey patching, blocks, etc) and let the user choose whatever he likes.
-I for instance prefer the colored's monkey patch approach, but for some people it
-doesn't suit, so other options should be offered.
+My point with this gem is to implement many of the possible ways of appending
+ANSI escape codes to strings (monkey patching, blocks, etc) and let the user
+choose whatever he likes. I for instance prefer the colored's monkey patch
+approach, but for some people it doesn't suit, so other options should be
+offered.
 
 Please contribute!
 
@@ -31,7 +35,7 @@ Add this line to your applications's gemfile:
 
 then run:
 
-```bundle```
+```bundle install```
 
 or simply:
 
@@ -43,18 +47,23 @@ or simply:
 
 You can include cape-cod in you String class:
 
-```
-  class String; include CapeCod end
+    class String; include CapeCod end
+
+    puts "Praise R'hlor, for the night is dark and full of terrors".red
+
+    puts 'This is BOLD'.bold
+
+    puts 'and this is ITALIC'.fx(:italic) # You should probably avoid *italics* :\
+
+    puts 'Black n white'.fg(:black).on_white
 
-  puts 'Praise R'hlor, for the night is dark and full of terrors'.red
-```
+    puts 'Magenta background'.bg(:magenta)
 
 or use it like this:
 
-```
-  puts CapeCod.yellow('We all live in a yellow submarine!')
-```
+```puts CapeCod.yellow('We all live in a yellow submarine!')```
 
+All the public instance methods are available as module methods.
 
 ## Contributing
 

data/lib/cape-cod.rb

@@ -7,75 +7,159 @@ module CapeCod
 
   require 'cape-cod/version'
 
-  ESCAPE_CODES = {
-    reset:          0,
-    bold:           1,
-    dark:           2,
-    italic:         3,
-    underline:      4,
-    blink:          5,
-    rapid_blink:    6,
-    negative:       7,
-    concealed:      8,
-    strikethrough:  9,
-
-    # Foreground color
-    black:         30,
-    red:           31,
-    green:         32,
-    yellow:        33,
-    blue:          34,
-    magenta:       35,
-    cyan:          36,
-    white:         37,
-
-    # Background color
-    on_black:      40,
-    on_red:        41,
-    on_green:      42,
-    on_yellow:     43,
-    on_blue:       44,
-    on_magenta:    45,
-    on_cyan:       46,
-    on_white:      47,
-    }.freeze
+  @enabled = STDOUT.tty?
+
+  EFFECTS = {
+    reset:         0,
+    bold:          1,
+    dark:          2,
+    italic:        3,
+    underline:     4,
+    blink:         5,
+    rapid_blink:   6,
+    negative:      7,
+    concealed:     8,
+    strikethrough: 9
+  }.freeze
+
+  COLORS = {
+    black:    0,
+    red:      1,
+    green:    2,
+    yellow:   3,
+    blue:     4,
+    magenta:  5,
+    cyan:     6,
+    white:    7,
+  }.freeze
 
   #
-  # Define helper methods for applying the escape codes
+  # Define helper methods for applying the escape codes.
   #
-  ESCAPE_CODES.each do |code, _|
-    define_method code do
-      CapeCod.apply_escape_sequence(code, self)
+  COLORS.each do |color, _|
+
+    #
+    # Instance methods for background and foreground colors.
+    #
+    define_method color do
+      CapeCod.foreground(color, self)
     end
 
-    define_singleton_method code do |obj = '', &block|
+    define_method "on_#{color}".to_s do
+      CapeCod.background(color, self)
+    end
+
+    #
+    # Singleton methods for background and foreground colors.
+    #
+    define_singleton_method color do |obj = ''|
       string = obj.to_s
-      return CapeCod.escape_sequence_for(code) if string.empty? unless block
 
-      string += block.call if block
+      foreground(color, string)
+    end
 
-      CapeCod.apply_escape_sequence(code, string)
+    define_singleton_method "on_#{color}" do |obj = ''|
+      string = obj.to_s
+
+      background(color, string)
     end
   end
 
-  private
+  EFFECTS.each do |effect, _|
 
-  #
-  # Returns the ANSI escape sequence for a given escape +code+.
-  #
-  def self.escape_sequence_for(code)
-    "\e[#{ESCAPE_CODES.fetch(code)}m"
+    #
+    # Instance methods for effects.
+    #
+    define_method effect do
+      CapeCod.effect(effect, self)
+    end
+
+    #
+    # Singleton methods for effects.
+    #
+    define_singleton_method effect do |obj = ''|
+      string = obj.to_s
+
+      effect(effect, string)
+    end
   end
 
-  #
-  # Prepends the given +string+ with the ANSI escape sequence for the given
-  # escape +code+ and append a reset sequence.
-  #
-  def self.apply_escape_sequence(code, string)
-    sequence = escape_sequence_for(code)
+  def foreground(color) # :nodoc:
+    CapeCod.foreground(color, self)
+  end
 
-    return sequence unless string
+  def background(color) # :nodoc:
+    CapeCod.background(color, self)
+  end
+
+  def effect(effect)    # :nodoc:
+    CapeCod.effect(effect, self)
+  end
 
-    sequence << string << escape_sequence_for(:reset)
+  alias_method :color, :foreground
+  alias_method :fg,    :foreground
+  alias_method :bg,    :background
+  alias_method :fx,    :effect
+
+  class << self
+
+    attr_accessor :enabled
+
+    def foreground(color, target) # :nodoc:
+      apply_escape_sequence(color_code_for(color, :foreground), target)
+    end
+
+    def background(color, target) # :nodoc:
+      apply_escape_sequence(color_code_for(color, :background), target)
+    end
+
+    def effect(effect, target) # :nodoc:
+      apply_escape_sequence(effect_code_for(effect), target)
+    end
+
+    alias_method :color, :foreground
+    alias_method :fg,    :foreground
+    alias_method :bg,    :background
+    alias_method :fx,    :effect
+
+    protected
+
+    #
+    # Returns the ANSI escape sequence for the given +color+.
+    #
+    def color_code_for(color, ground)
+      COLORS.fetch(color) + (ground == :foreground ? 30 : 40)
+    end
+
+    #
+    # Returns the ANSI escape sequence for the given +effect+.
+    #
+    def effect_code_for(effect)
+      EFFECTS.fetch(effect)
+    end
+
+    private
+
+    #
+    # Returns the ANSI escape sequence for a given escape +code+.
+    #
+    def escape_sequence_for(code)
+      "\e[#{code}m"
+    end
+
+    #
+    # Prepends the given +string+ with the ANSI escape sequence for the
+    # given escape +code+. In case string is not empty, also appends a
+    # reset sequence.
+    #
+    def apply_escape_sequence(code, string)
+        return string unless self.enabled
+
+        escape_sequence_for(code).tap do |s|
+        unless string.nil? || string.empty?
+          s << string << escape_sequence_for(effect_code_for(:reset))
+        end
+      end
+    end
   end
 end

data/lib/cape-cod/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module CapeCod
-  VERSION = '0.1.0'
-end
+  VERSION = '0.1.1'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cape-cod
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-27 00:00:00.000000000 Z
+date: 2013-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,7 +59,12 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Make your strings look fancy with ANSI escape codes.
+description: ! 'CapeCod offers you simple stupid way of colorizing and applying effects
+  to your
+
+  terminal output, by appending ANSI escape sequences to your strings.
+
+'
 email: fuadksd@gmail.com
 executables: []
 extensions: []