colorer 0.6.1 → 0.7.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Domizio Demichelis
+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

data/README.rdoc

@@ -13,6 +13,18 @@ Easy ANSI code coloring for strings.
     "an error string".errorize
     "my native (Select Graphic Rendition) string".mysgr
 
+    '    reversed    '.reversed.or('==== reversed ====')
+
+    Colorer.def_strip_ansi
+    plain_text = colored_string.strip_ansi
+
+=== Feedback!!!
+
+This is feedback-driven software. Just send me a line about you and/or what you think about IRT:
+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 pollute String of unwanted methods
@@ -88,6 +100,31 @@ You can also add native SGR (Select Graphic Rendition) parameters (0..109) to an
 
 See http://en.wikipedia.org/wiki/ANSI_colors for a complete list
 
+=== 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 Colorer will output non strict ansi by default. If you want to have strict ansi you can do:
+
+    Colorer.strict_ansi = true
+
+or you can set the COLORER_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:
+
+    Colorer.color?         #=> true/false by default depending on your terminal
+    Colorer.color = true   # force true
+    Colorer.color?         #=> true
+    Colorer.color = false  # force false
+    Colorer.color?         #=> false
+
 == Copyright
 
-Copyright (c) 2010 Domizio Demichelis. See LICENSE for details.
+Copyright (c) 2010-2011 Domizio Demichelis. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+name = 'colorer'
+
+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

@@ -1 +1 @@
-0.6.1
+0.7.0

data/colorer.gemspec

@@ -10,7 +10,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.8.0"])
+  s.add_development_dependency('irt', [">= 1.0.0"])
 
   s.files = `git ls-files -z`.split("\0")
 

data/lib/colorer.rb

@@ -43,8 +43,12 @@ module Colorer
 
   extend self
 
-  @color = RbConfig::CONFIG['host_os'] !~ /mswin|mingw/
+  @color = !!STDOUT.tty? && !!ENV['TERM'] && ENV['TERM'] != 'dumb'
   attr_accessor :color
+  alias_method :color?, :color
+
+  @strict_ansi = !!ENV['COLORER_STRICT_ANSI']
+  attr_accessor :strict_ansi
 
   def def_basic_styles(basic=true, force=false)
     define_styles basic_styles(basic), force
@@ -63,6 +67,7 @@ module Colorer
       end
       puts "    #{caller[0]}"
     end
+    check_or_define_or
     styles.each_pair do |meth, style|
       # allows dummy methods (useful for style overriding)
       if style.nil?
@@ -74,14 +79,31 @@ module Colorer
                 code = s.is_a?(Symbol) ? BASIC_SGR[s] : s
                 raise UnknownSgrCode.new(s) unless code.is_a?(Integer) && (0..109).include?(code)
                 code
-              end.join(';')
+              end
       String.class_eval do
         raise AlreadyDefinedMethod.new(meth, self) if !force && method_defined?(meth)
         define_method(meth) do
-          return self unless (Colorer.color && STDOUT.tty? && ENV['TERM'] && ENV['TERM'] != 'dumb')
-          match(/^\e\[[\d;]+m.*\e\[0m$/) ?
-            sub(/^(\e\[[\d;]+)/, '\1;' + codes) :
-            sprintf("\e[0;%sm%s\e[0m", codes, self)
+          return self unless Colorer.color?
+          if Colorer.strict_ansi
+            match(/^\e\[[\d;]+m.*\e\[0m$/m) ?
+              sub(/^(\e\[[\d;]+)/, '\1;' + codes.join(';')) :
+              sprintf("\e[0;%sm%s\e[0m", codes.join(';'), self)
+          else
+            match(/^(?:\e\[\d+m)+.*\e\[0m$/m) ?
+              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, self)
+          end
+        end
+      end
+    end
+  end
+
+  # strips all ansi SGR codes from self
+  def def_strip_ansi
+    unless 'string'.respond_to?(:strip_ansi)
+      String.class_eval do
+        define_method(:strip_ansi) do
+          gsub(/\e\[[\d;]+m/, '')
         end
       end
     end
@@ -102,4 +124,18 @@ module Colorer
     styles
   end
 
+  def check_or_define_or
+    # defifines the String#or method if not already defined
+    # the String#or will return self when #color? is true
+    # or an alternative string otherwise
+    # e.g.: '    reversed    '.reversed.or('==== reversed ====')
+    unless 'string'.respond_to?(:or)
+      String.class_eval do
+        define_method(:or) do |alternative_string|
+          Colorer.color? ? self : alternative_string
+        end
+      end
+    end
+  end
+
 end

data/test/basic.irt

@@ -3,19 +3,26 @@ Colorer.def_basic_styles true, true
 desc "red"
 'red'.red
 puts _
-test_value_eql? "\e[0;31mred\e[0m"
+_eql? "\e[0;31mred\e[0m"
 
 desc "red bold"
 'red bold'.red.bold
 puts _
-test_value_eql? "\e[0;31;1mred bold\e[0m"
+_eql? "\e[0;31;1mred bold\e[0m"
 
 desc "red bold underline"
 'red bold underline'.red.bold.underline
 puts _
-test_value_eql? "\e[0;31;1;4mred bold underline\e[0m"
+_eql? "\e[0;31;1;4mred bold underline\e[0m"
 
 desc "red bold underline reversed"
 'red bold underline reversed'.red.bold.underline.reversed
 puts _
-test_value_eql? "\e[0;31;1;4;7mred bold underline reversed\e[0m"
+_eql? "\e[0;31;1;4;7mred bold underline reversed\e[0m"
+
+desc "red bold with \\n"
+"red bold with\n".red.bold
+puts _
+_eql? "\e[0;31;1mred bold with\n\e[0m"
+
+

data/test/custom.irt

@@ -1,18 +1,19 @@
 Colorer.def_custom_styles :dummy => nil,
                           :errorize => [ :red, :bold, :underline ],
                           :okeyze => [ :green, :bold ]
+Colorer.strict_ansi = true
 
 desc "errorize"
 'errorize'.errorize
 puts _
-test_value_eql? "\e[0;31;1;4merrorize\e[0m"
+_eql? "\e[0;31;1;4merrorize\e[0m"
 
 desc "okeyze"
 'okeyize'.okeyze
 puts _
-test_value_eql? "\e[0;32;1mokeyize\e[0m"
+_eql? "\e[0;32;1mokeyize\e[0m"
 
 desc "allows dummy styles"
 'dummy'.dummy
 puts _
-test_value_eql?( "dummy" )
+_eql?( "dummy" )

data/test/irt_helper.rb

@@ -1,3 +1,4 @@
 $:.unshift File.expand_path('../../lib', __FILE__)
+Colorer.strict_ansi = true
 
 require 'colorer'

data/test/selected_basic.irt

@@ -3,21 +3,21 @@ Colorer.def_basic_styles([:bold, :red], true)
 desc "red"
 'red'.red
 puts _
-test_value_eql? "\e[0;31mred\e[0m"
+_eql? "\e[0;31mred\e[0m"
 
 desc "red bold"
 'red bold'.red.bold
 puts _
-test_value_eql? "\e[0;31;1mred bold\e[0m"
+_eql? "\e[0;31;1mred bold\e[0m"
 
 desc "onwhite"
 Colorer.def_basic_styles([:onwhite], true)
 'onwhite'.onwhite
 puts _
-test_value_eql? "\e[0;47monwhite\e[0m"
+_eql? "\e[0;47monwhite\e[0m"
 
 
 desc "not underline"
 'not underline'.respond_to? :underline
-test_value_eql? false
+_eql? false
 

data/test/sgr.irt

@@ -4,13 +4,13 @@ Colorer.def_custom_styles :mixed_sgr => [ :bold, 7 ]
 desc "Mixed SGR parameters"
 "Mixed SGR parameters".mixed_sgr
 puts _
-test_value_eql? "\e[0;1;7mMixed SGR parameters\e[0m"
+_eql? "\e[0;1;7mMixed SGR parameters\e[0m"
 
 desc "Basic and custom definition"
 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"
+_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: 5
+  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 1
-  version: 0.6.1
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Domizio Demichelis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-25 00:00:00 -04:00
+date: 2011-01-17 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,12 +26,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 63
+        hash: 23
         segments: 
+        - 1
         - 0
-        - 8
         - 0
-        version: 0.8.0
+        version: 1.0.0
   type: :development
   version_requirements: *id001
 description: Colorer adds the basic ANSI styles to any string, allowing also to define your own stiles
@@ -46,6 +46,7 @@ files:
 - .gitignore
 - LICENSE
 - README.rdoc
+- Rakefile
 - VERSION
 - colorer.gemspec
 - lib/colorer.rb