colorer 0.4.0 → 0.5.0

data/README.rdoc

@@ -5,9 +5,9 @@ Easy ANSI code coloring for strings.
 == Synopsis
 
     require 'colorer'
-    Colorer.define_styles :basic => true,
-                          :errorize => [ :red, :bold, :underline ],
-                          :mysgr => [ :red, 8 ]
+    Colorer.def_basic_styles
+    Colorer.def_custom_styles :errorize => [ :red, :bold, :underline ],
+                              :mysgr => [ :red, 8 ]
 
     "a red bold underlined text on white background".red.bold.underline.onwhite
     "an error string".errorize
@@ -22,20 +22,22 @@ Easy ANSI code coloring for strings.
 
 === Basic Styles
 
-You can define the basic styles for any string by using the reserved name :basic:
+You can define the basic styles for any string by using the def_basic_styles method:
 
     # all basic styles
-    Colorer.define_styles :basic => true
+    Colorer.def_basic_styles
     "a string".green.bold.reversed.underline...
 
     # a few basic styles
-    Colorer.define_styles :basic => [:bold, :reversed]
+    Colorer.define_styles [:bold, :reversed]
     "a string".bold.reversed
 
     # one basic style
-    Colorer.define_styles :basic => :red
+    Colorer.define_styles :red
     "a string".red
 
+==== Basic Styles List
+
 * clear
 * bold
 * underline
@@ -62,11 +64,11 @@ You can define the basic styles for any string by using the reserved name :basic
 
 === Custom Styles
 
-You can define your own custom styles:
+You can define your own custom styles by aggregating any basic styles names:
 
-    Colorer.define_styles :errorize => [ :red, :bold, :underline ],
-                          :okize => [ :green, :bold ],
-                          :crazyize => [ :magenta, :onyellow, :bold, :underline ]
+    Colorer.def_custom_styles :errorize => [ :red, :bold, :underline ],
+                              :okize => [ :green, :bold ],
+                              :crazyize => [ :magenta, :onyellow, :bold, :underline ]
 
     error_string.errorize
     # same as
@@ -78,13 +80,11 @@ You can define your own custom styles:
     # same as
     crazy_string.magenta.onyellow.bold.underline
 
-Notice: you cannot use :basic as a custom name, since it is the reserved name used to define the basic styles.
-
 === SGR Styles
 
 You can also add native SGR (Select Graphic Rendition) parameters (0..109) to any style:
 
-    Colorer.define_styles :mysgr => [ :red, 8 ]
+    Colorer.def_custom_styles :mysgr => [ :red, 8 ]
 
 See http://en.wikipedia.org/wiki/ANSI_colors for a complete list
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/colorer.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.summary = 'Easy ANSI code coloring for strings'
   s.description = 'Colorer adds the basic ANSI styles to any string, allowing also to define your own stiles'
 
-  s.add_development_dependency('irt', [">= 0.7.1"])
+  s.add_development_dependency('irt', [">= 0.7.7"])
 
   s.files = `git ls-files -z`.split("\0")
 

data/lib/colorer.rb

@@ -46,18 +46,22 @@ module Colorer
   @color = true
   attr_accessor :color
 
+  def def_basic_styles(basic=true, force=false)
+    define_styles basic_styles(basic), force
+  end
+
+  def def_custom_styles(styles, force=false)
+    define_styles styles, force
+  end
+
   def define_styles(styles, force=false)
-    if basic = styles.delete(:basic)
-      basic_styles = {}
-      case basic
-      when TrueClass
-        basic_styles = BASIC_SGR
-      when Array
-        basic.each{|k| basic_styles[k] = BASIC_SGR[k]}
-      when Symbol
-        basic_styles[basic] = BASIC_SGR[basic]
+    unless caller[0].match(/def_basic_styles|def_custom_styles/)
+      puts 'DEPRECATION WARNING: :define_styles has been deprecated. Use def_basic_styles and def_custom_styles instead'
+      if styles.keys.include?(:basic)
+        puts 'DEPRECATION WARNING: :basic is not a reserved name anymore: please use def_basic_styles to define the basic methods'
+        styles = basic_styles(styles.delete(:basic)).merge(styles)
       end
-      styles = basic_styles.merge(styles)
+      puts "    #{caller[0]}"
     end
     styles.each_pair do |meth, style|
       style = [style] unless style.is_a?(Array)
@@ -78,4 +82,19 @@ module Colorer
     end
   end
 
+  private
+
+  def basic_styles(basic)
+    styles = {}
+    case basic
+    when TrueClass
+      styles = BASIC_SGR
+    when Array
+      basic.each{|k| styles[k] = BASIC_SGR[k]}
+    when Symbol
+      styles[basic] = BASIC_SGR[basic]
+    end
+    styles
+  end
+
 end

data/test/basic.irt

@@ -1,6 +1,6 @@
 require 'colorer'
 
-Colorer.define_styles({:basic => true}, true)
+Colorer.def_basic_styles true, true
 
 desc "red"
 'red'.red

data/test/custom.irt

@@ -1,6 +1,6 @@
 require 'colorer'
 
-Colorer.define_styles :errorize => [ :red, :bold, :underline ],
+Colorer.def_custom_styles :errorize => [ :red, :bold, :underline ],
 :okeyze => [ :green, :bold ]
 
 desc "errorize"

data/test/selected_basic.irt

@@ -1,6 +1,6 @@
 require 'colorer'
 
-Colorer.define_styles({:basic => [:bold, :red]}, true)
+Colorer.def_basic_styles([:bold, :red], true)
 
 desc "red"
 'red'.red
@@ -13,7 +13,7 @@ puts _
 test_value_eql? "\e[0;31;1mred bold\e[0m"
 
 desc "onwhite"
-Colorer.define_styles({:basic => :onwhite}, true)
+Colorer.def_basic_styles([:onwhite], true)
 'onwhite'.onwhite
 puts _
 test_value_eql? "\e[0;47monwhite\e[0m"

data/test/sgr.irt

@@ -1,6 +1,6 @@
 require 'colorer'
 
-Colorer.define_styles :mixed_sgr => [ :bold, 7 ]
+Colorer.def_custom_styles :mixed_sgr => [ :bold, 7 ]
 
 
 desc "Mixed SGR parameters"
@@ -9,7 +9,8 @@ puts _
 test_value_eql? "\e[0;1;7mMixed SGR parameters\e[0m"
 
 desc "Basic and custom definition"
-Colorer.define_styles({:basic => true, :goo => [7], :guu => 4}, 1)
+Colorer.def_basic_styles true, true
+Colorer.def_custom_styles({:goo => [7], :guu => 4}, 1)
 "Basic and custom definition".green.goo.guu
 puts _
 test_value_eql? "\e[0;32;7;4mBasic and custom definition\e[0m"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: colorer
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Domizio Demichelis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-20 00:00:00 -04:00
+date: 2010-10-21 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,12 +26,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 13
         segments: 
         - 0
         - 7
-        - 1
-        version: 0.7.1
+        - 7
+        version: 0.7.7
   type: :development
   version_requirements: *id001
 description: Colorer adds the basic ANSI styles to any string, allowing also to define your own stiles