dye 0.1.0

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## Eclipse
+.loadpath
+.project

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 Domizio Demichelis
+
+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.rdoc

@@ -0,0 +1,132 @@
+= colorer
+
+Easy ANSI code coloring for strings in libraries.
+
+== Synopsis
+
+    require 'dye'
+
+    # you can use directly use Dye.dye for basic styles
+    Dye.dye "a red bold underlined text on white background", :red, :bold, :underline, :onwhite
+
+    # you can define custom styles in your classes or modules
+    module MyModule
+      extend self
+      CUSTOM_STYLES = { :errorize => [ :red, :bold, :underline ],
+                        :mysgr => [ :red, 8 ] }
+      define_dye_method CUSTOM_STYLES
+    end
+
+    # use the custom styles
+    MyModule.dye "an error string", :errorize
+    MyModule.dye "my native (Select Graphic Rendition) string", :mysgr
+
+    # and use also the basic styles
+    MyModule.dye "red bold string", :red, :bold
+
+    # or use mixed custom and basic
+    MyModule.dye "red bold string", :mysgr, :bold
+
+    # you can eventually modify/add to the custom styles
+    CUSTOM_STYLES[:another] = [:green, :bold]
+    # and the style will be available right away
+    MyModule.dye "another style", :another
+
+    # you can also define the dye method as an instance method
+    any_instance.class.define_dye_method custom_styles
+
+    # and use it on the instance
+    any_instance.dye "any string", :any_style
+
+    # back to plain text
+    plain_text = Dye.strip_ansi(ansi_string)
+
+=== Feedback!!!
+
+This is feedback-driven software. Just send me a line about you and/or what you think about it:
+that will be a wonderful contribution that will help me to keep improving (and documenting) this software.
+
+My email address is ddnexus at gmail.com ... waiting for your. Ciao.
+
+== Features
+
+* Does not define methods in String
+* Allows you to define basic styles by just requiring the lib
+* Allows you to easily add your own custom styles
+* Allows extended (Select Graphic Rendition) parameters
+
+=== Difference with the Colorer gem
+
+The Colorer gem is meant for using in your own application, it's a cool way to style string, but it
+is not the perfect fit for libraries. Indeed it defines an instance method for each style, and that
+might clash if another library defines the same style. That's not a problem for applications.
+
+The Dye gem instead does not have the same problem, although its syntax is not so cool as the Colorer's one.
+
+==== Basic Styles List
+
+* clear
+* bold
+* underline
+* blinking
+* reversed
+
+* black
+* red
+* green
+* yellow
+* blue
+* magenta
+* cyan
+* white
+
+* onblack
+* onred
+* ongreen
+* onyellow
+* onblue
+* onmagenta
+* oncyan
+* onwhite
+
+=== Custom Styles
+
+You can define your own custom styles by aggregating any basic styles names,
+besides can also add native SGR (Select Graphic Rendition) parameters (0..109) to any style::
+
+    custom_styles = { :errorize => [ :red, :bold, :underline ],
+                      :okize => [ :green, :bold ],
+                      :crazyize => [ :magenta, :onyellow, :bold, :underline ],
+                      :mysgr => [ :red, 8 ] }
+    define_dye_method custom_styles
+
+See http://en.wikipedia.org/wiki/ANSI_colors for a complete list of SGR codes.
+
+=== Strict ANSI
+
+Some terminals don't parse composite SGR styles correctly, and need separate SGR for each.
+
+    puts "\e[7;31;46mSTRING\e[0m"         # strict_ansi == true (may be difficult to parse)
+    puts "\e[7m\e[31m\e[46mSTRING\e[0m"   # strict_ansi == false
+
+On the other way most of the terminals that parse them correctly can parse also separate SGRs,
+so Dye will output non strict ansi by default. If you want to have strict ansi you can do:
+
+    Dye.strict_ansi = true
+
+or you can set the DYE_ANSI_STRICT environment variable for a system wide setting.
+
+=== Color
+
+The color is true by defealut on a non-dumb tty terminal, anyway you can force it
+by explicitly setting it:
+
+    Dye.color?         #=> true/false by default depending on your terminal
+    Dye.color = true   # force true
+    Dye.color?         #=> true
+    Dye.color = false  # force false
+    Dye.color?         #=> false
+
+== Copyright
+
+Copyright (c) 2010-2011 Domizio Demichelis. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+name = 'dye'
+
+def ensure_clean(action, force=false)
+  if !force && ! `git status -s`.empty?
+    puts <<-EOS.gsub(/^ {6}/, '')
+      Rake task aborted: the working tree is dirty!
+      If you know what you are doing you can use \`rake #{action}[force]\`"
+    EOS
+    exit(1)
+  end
+end
+
+desc "Install the gem"
+task :install, :force do |t, args|
+  ensure_clean(:install, args.force)
+  orig_version = version = File.read('VERSION').strip
+  begin
+    commit_id = `git log -1 --format="%h" HEAD`.strip
+    version = "#{orig_version}.#{commit_id}"
+    File.open('VERSION', 'w') {|f| f.puts version }
+    gem_name = "#{name}-#{version}.gem"
+    sh %(gem build #{name}.gemspec)
+    sh %(gem install #{gem_name} --local)
+    puts <<-EOS.gsub(/^ {6}/, '')
+
+      *******************************************************************************
+      *                                   NOTICE                                    *
+      *******************************************************************************
+      * The version id of locally installed gems is comparable to a --pre version:  *
+      * i.e. it is alphabetically ordered (not numerically ordered), besides it     *
+      * includes the sah1 commit id which is not aphabetically ordered, so be sure  *
+      * your application picks the version you really intend to use                 *
+      *******************************************************************************
+
+    EOS
+  ensure
+    remove_entry_secure gem_name, true
+    File.open('VERSION', 'w') {|f| f.puts orig_version }
+  end
+end
+
+desc %(Remove all the "#{name}" installed gems and executables and install this version)
+task :clean_install, :force do |t, args|
+  ensure_clean(:install, args.force)
+  sh %(gem uninstall #{name} --all --ignore-dependencies --executables)
+  Rake::Task['install'].invoke(args.force)
+end
+
+desc "Push the gem to rubygems.org"
+task :push, :force do |t, args|
+  begin
+    ensure_clean(:push, args.force)
+    version = File.read('VERSION').strip
+    gem_name = "#{name}-#{version}.gem"
+    sh %(gem build #{name}.gemspec)
+    sh %(gem push #{gem_name})
+  ensure
+    remove_entry_secure gem_name, true
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/dye.gemspec

@@ -0,0 +1,26 @@
+name = File.basename( __FILE__, '.gemspec' )
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+require 'date'
+
+Gem::Specification.new do |s|
+
+  s.authors = ["Domizio Demichelis"]
+  s.email = 'dd.nexus@gmail.com'
+  s.homepage = 'http://github.com/ddnexus/dye'
+  s.summary = 'Easy ANSI code coloring for strings in libraries'
+  s.description = 'Dye adds the basic ANSI styles to any string, allowing also to define your own stiles'
+
+  s.add_development_dependency('irt', [">= 1.0.0"])
+
+  s.files = `git ls-files -z`.split("\0")
+
+  s.name = name
+  s.version = version
+  s.date = Date.today.to_s
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+
+end
+

data/lib/dye.rb

@@ -0,0 +1,100 @@
+class Object
+
+  def define_dye_method(custom_styles={})
+      define_method(:dye) do |string, *names|
+        return string unless Dye.color?
+        codes = names.map do |name|
+                  case
+                  when custom_styles.has_key?(name)
+                    Dye.sgr_names_to_codes *custom_styles[name]
+                  when Dye::BASIC_SGR.has_key?(name)
+                    Dye::BASIC_SGR[name]
+                  else
+                    raise Dye::UnknownSgrCode.new(name)
+                  end
+                end.flatten
+        Dye.apply_codes string, *codes
+      end
+  end
+
+end
+
+
+module Dye
+
+  extend self
+
+  VERSION = File.read(File.expand_path('../../VERSION', __FILE__)).strip
+
+  class UnknownSgrCode < Exception
+    def initialize(sgr)
+      super("#{sgr.inspect} is unknown")
+    end
+  end
+
+  # Select Graphic Rendition
+  BASIC_SGR = {
+    :clear     => 0,
+    :bold      => 1,
+    :underline => 4,
+    :blinking  => 5,
+    :reversed  => 7,
+
+    :black     => 30,
+    :red       => 31,
+    :green     => 32,
+    :yellow    => 33,
+    :blue      => 34,
+    :magenta   => 35,
+    :cyan      => 36,
+    :white     => 37,
+
+    :onblack   => 40,
+    :onred     => 41,
+    :ongreen   => 42,
+    :onyellow  => 43,
+    :onblue    => 44,
+    :onmagenta => 45,
+    :oncyan    => 46,
+    :onwhite   => 47
+  }
+
+  @color = !!STDOUT.tty? && !!ENV['TERM'] && ENV['TERM'] != 'dumb'
+  attr_accessor :color
+  alias_method :color?, :color
+
+  @strict_ansi = !!ENV['DYE_STRICT_ANSI']
+  attr_accessor :strict_ansi
+
+  def dye(string, *sgr_names)
+    return string unless color?
+    apply_codes string, sgr_names_to_codes(*sgr_names)
+  end
+
+  def strip_ansi(string)
+    string.gsub(/\e\[[\d;]+m/, '')
+  end
+
+  def sgr_names_to_codes(*names)
+    names.map do |n|
+      next if n.nil?
+      code = n.is_a?(Symbol) ? BASIC_SGR[n] : n
+      raise UnknownSgrCode.new(n) unless code.is_a?(Integer) && (0..109).include?(code)
+      code
+    end
+  end
+
+  def apply_codes(string, *codes)
+    codes.compact!
+    return string if codes.empty?
+    if strict_ansi
+      string.match(/^\e\[[\d;]+m.*\e\[0m$/m) ?
+        string.sub(/^(\e\[[\d;]+)/, '\1;' + codes.join(';')) :
+        sprintf("\e[0;%sm%s\e[0m", codes.join(';'), string)
+    else
+      string.match(/^(?:\e\[\d+m)+.*\e\[0m$/m) ?
+        string.sub(/^((?:\e\[\d+m)+)/, '\1' + codes.map{|c| "\e[#{c}m" }.join) :
+        sprintf("\e[0m%s%s\e[0m", codes.map{|c| "\e[#{c}m" }.join, string)
+    end
+  end
+end

data/test/basic.irt

@@ -0,0 +1,26 @@
+desc "red"
+Dye.dye 'red', :red
+puts _
+_eql? "\e[0;31mred\e[0m"
+
+desc "red bold"
+Dye.dye 'red bold', :red, :bold
+puts _
+_eql? "\e[0;31;1mred bold\e[0m"
+
+desc "red bold underline"
+Dye.dye 'red bold underline', :red, :bold, :underline
+puts _
+_eql? "\e[0;31;1;4mred bold underline\e[0m"
+
+desc "red bold underline reversed"
+Dye.dye 'red bold underline reversed', :red, :bold, :underline, :reversed
+puts _
+_eql? "\e[0;31;1;4;7mred bold underline reversed\e[0m"
+
+desc "red bold with \\n"
+Dye.dye "red bold with\n", :red, :bold
+puts _
+_eql? "\e[0;31;1mred bold with\n\e[0m"
+
+

data/test/custom.irt

@@ -0,0 +1,27 @@
+custom_styles = { :dummy => nil,
+                  :errorize => [ :red, :bold, :underline ],
+                  :okeyze => [ :green, :bold ] }
+self.class.define_dye_method custom_styles
+
+desc "errorize"
+dye 'errorize', :errorize
+puts _
+_eql? "\e[0;31;1;4merrorize\e[0m"
+
+desc "okeyze"
+dye 'okeyize', :okeyze
+puts _
+_eql? "\e[0;32;1mokeyize\e[0m"
+
+desc "allows dummy styles"
+dye 'dummy', :dummy
+puts _
+_eql?( "dummy" )
+
+custom_styles[:added] = :blue
+
+desc "add to  custom styles"
+dye 'added', :added
+puts _
+_eql?( "\e[0;34madded\e[0m" )
+

data/test/irt_helper.rb

@@ -0,0 +1,4 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'dye'
+Dye.strict_ansi = true
+

data/test/module.irt

@@ -0,0 +1,18 @@
+module MyModule
+  extend self
+  define_dye_method
+end
+
+desc 'module call'
+MyModule.dye 'My Module', :green, :bold
+puts _
+_eql?( "\e[0;32;1mMy Module\e[0m" )
+
+class MyInstance; end
+
+desc 'instance call'
+obj = MyInstance.new
+obj.class.define_dye_method
+obj.dye 'My Instance', :reversed, :yellow
+puts _
+_eql?( "\e[0;7;33mMy Instance\e[0m" )

data/test/sgr.irt

@@ -0,0 +1,16 @@
+custom_styles = { :mixed_sgr => [ :bold, 7 ] }
+
+self.class.define_dye_method custom_styles
+
+desc "Mixed SGR parameters"
+dye "Mixed SGR parameters", :mixed_sgr
+puts _
+_eql? "\e[0;1;7mMixed SGR parameters\e[0m"
+
+desc "Basic and custom definition"
+custom_styles.merge!({:goo => [7], :guu => 4})
+dye "Basic and custom definition", :green, :goo, :guu
+puts _
+_eql? "\e[0;32;7;4mBasic and custom definition\e[0m"
+
+

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: dye
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Domizio Demichelis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-31 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: irt
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+description: Dye adds the basic ANSI styles to any string, allowing also to define your own stiles
+email: dd.nexus@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- dye.gemspec
+- lib/dye.rb
+- test/basic.irt
+- test/custom.irt
+- test/irt_helper.rb
+- test/module.irt
+- test/sgr.irt
+has_rdoc: true
+homepage: http://github.com/ddnexus/dye
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easy ANSI code coloring for strings in libraries
+test_files: []
+