simplecolor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e29e32da09d330fd55cc5a21481c4b2cd697f15f
+  data.tar.gz: adb0f95981bb5a0d8508303199c99d09313712ec
+SHA512:
+  metadata.gz: e2280f08ed62a8abcba4241bc4119aab09ffc386abc98e5dbf154097ec9402bd8f268af2806ac5e226275a2457665a25a67f7b20bb4dd440e00287bdda91caba
+  data.tar.gz: 5065a32ee415dfc0e9dbba91cf1cc5a6de425bd8bb956ffc9ae81b4e0b8693981beaa31169a3f18182bbee5c088c70ad38b3710b69a0b2d60cf09abdc070b049

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,3 @@
+.yardoc/
+doc/
+pkg/

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "simplecolor Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2013-08-23
+
+* Initial release:
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Damien Robert
+
+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.md

@@ -0,0 +1,66 @@
+# simplecolor
+
+* [Homepage](https://rubygems.org/gems/simplecolor)
+* [Documentation](http://rubydoc.info/gems/simplecolor/frames)
+* [Email](mailto:Damien.Olivier.Robert+gems@gmail.com)
+
+## Description
+
+[rainbow]: https://github.com/sickill/rainbow
+[term-ansicolor]: https://github.com/flori/term-ansicolor
+[paint]: https://github.com/janlelis/paint
+
+A simple library for coloring text output. Heavily inspired by [rainbow],
+[term-ansicolor] and [paint]. I recommend using these gems for more complex
+coloring needs. 
+
+By default this gem does not change the `String` class, unlike [rainbow]. The
+reason I wrote this gem is that when mixed in `String` it only adds two
+methods: `color` and `uncolor`. This is the main reason I don't use
+[term-ansicolor] which is more powerful, but adds more methods when mixed in.
+The gem [paint] is similar to this one, but with more powerful shortcuts
+definitions.
+
+## Features
+
+- No string extensions (suitable for library development)
+
+- Mixing the library in `String` only add two methods: `color` and
+  `uncolor`.
+
+- Supports setting any effects (although most terminals won’t support it)
+
+- Simple to use
+
+
+## Examples
+
+    require 'simplecolor'
+
+    SimpleColor.color("blue", :blue, :bold)
+    SimpleColor.color(:blue,:bold) { "blue" }
+    SimpleColor.color(:blue,:bold) << "blue" << SimpleColor.color(:clear)
+
+    SimpleColor.mix_in_string
+    "blue".color(:blue,:bold)
+    "\e[34m\e[1mblue\e[0m".uncolor
+
+## Requirements
+
+None.
+
+## Install
+
+    $ gem install simplecolor
+
+## Todo
+
+- Support 256 colors
+- Tests
+
+
+## Copyright
+
+Copyright (c) 2013 Damien Robert
+
+MIT License. See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'yard', '~> 0.8'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end
+task :doc => :yard
+
+begin
+  gem 'rubygems-tasks', '~> 0.2'
+  require 'rubygems/tasks'
+
+  Gem::Tasks.new(sign: {checksum: true, pgp: true},
+                 build: {tar: true}, scm: {status: true}) do |tasks|
+    tasks.console.command = 'pry'
+  end
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rubygems-tasks` to install Gem::Tasks."
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test_*.rb']
+end

data/gemspec.yml

@@ -0,0 +1,16 @@
+name: simplecolor
+summary: "Simple color library"
+description: "A simple library for coloring text output. Heavily inspired
+  from term-ansicolor and rainbow, I recommend using these gems for more
+  complex color needs. By default this gem does not do any core extension.
+  When mixed in String it only add two methods: color and uncolor. Paint
+  is another gem similar to this one, but with more powerful shortcuts
+  definitions."
+license: MIT
+authors: Damien Robert
+email: Damien.Olivier.Robert+gems@gmail.com
+homepage: https://rubygems.org/gems/simplecolor
+
+development_dependencies:
+  rubygems-tasks: ~> 0.2
+  yard: ~> 0.8

data/lib/simplecolor.rb

@@ -0,0 +1,3 @@
+require 'simplecolor/version'
+require 'simplecolor/colors'
+require 'simplecolor/simplecolor'

data/lib/simplecolor/colors.rb

@@ -0,0 +1,112 @@
+module SimpleColor
+
+  # Regular expression to scan if there is a clear ANSI effect at end of string
+  CLEAR_REGEXP = /\e\[0m$/
+  # Regular expression to find the end of the current ANSI sequence at
+  # beginning of string, to wrap around in the correct order.
+  COLOR_REGEXP = /^(\e\[([\d;]+)m)*/
+  # Regular expression that is used to scan for ANSI-sequences while
+  # uncoloring strings.
+  COLORED_REGEXP = /\e\[(?:(?:[349]|10)[0-7]|[0-9])?m/
+  
+  #Stolen from paint gem
+  #http://en.wikipedia.org/wiki/ANSI_escape_code
+  
+  # Basic colors (often, the color differs when using the bright effect)
+  # Final color will be 30 + value for foreground and 40 + value for background
+  # 90+value for intense foreground, 100+value for intense background
+  ANSI_COLORS = {
+    :black   => 0,
+    :red     => 1,
+    :green   => 2,
+    :yellow  => 3,
+    :blue    => 4,
+    :magenta => 5,
+    :cyan    => 6,
+    :white   => 7,
+    :default => 9,
+  }
+  
+  ANSI_EFFECTS = {
+    :reset         => 0,  :nothing         => 0,  # usually supported
+    :clear         => 0,  :normal         => 0,  # usually supported
+    :bright        => 1,  :bold            => 1,  # usually supported
+    :faint         => 2,
+    :italic        => 3,
+    :underline     => 4,                          # usually supported
+    :blink         => 5,  :slow_blink      => 5,
+    :rapid_blink   => 6,
+    :inverse       => 7,  :swap            => 7,  # usually supported
+    :conceal       => 8,  :hide            => 9,
+    :default_font  => 10,
+    :font0 => 10, :font1 => 11, :font2 => 12, :font3 => 13, :font4 => 14,
+    :font5 => 15, :font6 => 16, :font7 => 17, :font8 => 18, :font9 => 19,
+    :fraktur       => 20,
+    :bright_off    => 21, :bold_off        => 21, :double_underline => 21,
+    :clean         => 22,
+    :italic_off    => 23, :fraktur_off     => 23,
+    :underline_off => 24,
+    :blink_off     => 25,
+    :inverse_off   => 26, :positive        => 26,
+    :conceal_off   => 27, :show            => 27, :reveal           => 27,
+    :crossed_off   => 29, :crossed_out_off => 29,
+    :frame         => 51,
+    :encircle      => 52,
+    :overline      => 53,
+    :frame_off     => 54, :encircle_off    => 54,
+    :overline_off  => 55,
+  }
+
+  ANSI_COLORS_FOREGROUND = {
+    :black   => 30,
+    :red     => 31,
+    :green   => 32,
+    :yellow  => 33,
+    :blue    => 34,
+    :magenta => 35,
+    :cyan    => 36,
+    :white   => 37,
+    :default => 39,
+  }
+
+  ANSI_COLORS_BACKGROUND = {
+    :on_black   => 40,
+    :on_red     => 41,
+    :on_green   => 42,
+    :on_yellow  => 43,
+    :on_blue    => 44,
+    :on_magenta => 45,
+    :on_cyan    => 46,
+    :on_white   => 47,
+    :on_default => 49,
+  }
+
+  ANSI_COLORS_INTENSE_FOREGROUND = {
+    :intense_black   => 90,
+    :intense_red     => 91,
+    :intense_green   => 92,
+    :intense_yellow  => 93,
+    :intense_blue    => 94,
+    :intense_magenta => 95,
+    :intense_cyan    => 96,
+    :intense_white   => 97,
+    :intense_default => 99,
+  }
+
+  ANSI_COLORS_INTENSE_BACKGROUND = {
+    :on_instance_black   => 100,
+    :on_instance_red     => 101,
+    :on_instance_green   => 102,
+    :on_instance_yellow  => 103,
+    :on_instance_blue    => 104,
+    :on_instance_magenta => 105,
+    :on_instance_cyan    => 106,
+    :on_instance_white   => 107,
+    :on_instance_default => 109,
+  }
+
+  #attributes that can be specified to the color method
+  COLORS = [ANSI_EFFECTS,ANSI_COLORS_FOREGROUND, ANSI_COLORS_BACKGROUND, ANSI_COLORS_INTENSE_FOREGROUND, ANSI_COLORS_INTENSE_BACKGROUND].inject({}){ |a,b| a.merge(b) }
+
+
+end

data/lib/simplecolor/simplecolor.rb

@@ -0,0 +1,82 @@
+module SimpleColor
+  class << self; attr_accessor :enabled; end
+  self.enabled=true
+
+  def colorattributes(*args)
+    if SimpleColor.enabled
+      result=args.map {|col| "\e[#{COLORS[col]}m" }.inject(:+)
+      if SimpleColor.enabled == :shell
+        return "%{"+result+"%}"
+      else
+        return result
+      end
+    else
+      return ''
+    end
+  end
+
+  #Usage:
+  #class Foo
+  #  include SimpleColor::Mixin
+  #  def to_str
+  #    ...
+  #  end
+  #end
+  #foo=Foo.new()
+  #foo.color(:red)
+  module Mixin
+
+    # Returns an uncolored version of the string, that is all
+    # ANSI-sequences are stripped from the string.
+    def uncolor(string = nil)
+      if block_given?
+        yield.to_str.gsub(COLORED_REGEXP, '')
+      elsif string.respond_to?(:to_str)
+        string.to_str.gsub(COLORED_REGEXP, '')
+      elsif respond_to?(:to_str)
+        to_str.gsub(COLORED_REGEXP, '')
+      else
+        ''
+      end
+    end
+
+    #wrap self or the first argument with colors
+    #Examples:
+    #    SimpleColor.color("blue", :blue, :bold)
+    #    SimpleColor.color(:blue,:bold) { "blue" }
+    #    SimpleColor.color(:blue,:bold) << "blue" << SimpleColor.color(:clear)
+    #pareil pour uncolored
+    def color(*args)
+      if respond_to?(:to_str)
+        arg=self.dup
+      elsif block_given?
+        arg = yield
+      elsif args.first.respond_to?(:to_str)
+        arg=args.shift
+      else
+        arg=nil
+      end
+      return arg unless SimpleColor.enabled
+
+      if arg.nil?
+        return SimpleColor.colorattributes(*args)
+      elsif arg.empty?
+        return arg
+      else
+        matched = arg.match(SimpleColor::COLOR_REGEXP)
+        arg.insert(matched.end(0), SimpleColor.colorattributes(*args))
+        arg.concat(SimpleColor.colorattributes(:clear)) unless arg =~ SimpleColor::CLEAR_REGEXP
+        return arg
+      end
+    end
+  end
+
+  #after SimpleColor.mix_in_string, one can do
+  #"blue".color(:blue,:bold)
+  include SimpleColor::Mixin
+  def mix_in_string
+    String.class_eval {include SimpleColor::Mixin}
+  end
+
+  extend self
+end

data/lib/simplecolor/version.rb

@@ -0,0 +1,4 @@
+module SimpleColor
+  # simplecolor version
+  VERSION = "0.1.0"
+end

data/simplecolor.gemspec

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'simplecolor/version'
+                  SimpleColor::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'minitest/autorun'
+
+class MiniTest::Test
+end
+
+MiniTest.autorun

data/test/test_simplecolor.rb

@@ -0,0 +1,12 @@
+require 'helper'
+require 'simplecolor'
+
+class TestSimpleColor < MiniTest::Test
+
+  def test_version
+    version = SimpleColor.const_get('VERSION')
+
+    assert(!version.empty?, 'should have a VERSION constant')
+  end
+
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: simplecolor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damien Robert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 'A simple library for coloring text output. Heavily inspired from term-ansicolor
+  and rainbow, I recommend using these gems for more complex color needs. By default
+  this gem does not do any core extension. When mixed in String it only add two methods:
+  color and uncolor. Paint is another gem similar to this one, but with more powerful
+  shortcuts definitions.'
+email: Damien.Olivier.Robert+gems@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .gitignore
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemspec.yml
+- lib/simplecolor.rb
+- lib/simplecolor/colors.rb
+- lib/simplecolor/simplecolor.rb
+- lib/simplecolor/version.rb
+- simplecolor.gemspec
+- test/helper.rb
+- test/test_simplecolor.rb
+homepage: https://rubygems.org/gems/simplecolor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simple color library
+test_files: []