apohllo-colors 0.0.4

data/README.txt

@@ -0,0 +1,79 @@
+= colors
+
+* http://github.com/apohllo/colors
+
+== DESCRIPTION:
+
+Colorful string in Ruby!
+
+== FEATURES/PROBLEMS:
+
+* whole/partial string colorization is  possible
+
+== SYNOPSIS:
+
+Colors is an extension for Ruby String class, which provides colorful strings.
+It uses ANSI control sequences, thus is available in any ANSI-compliant
+terminal.
+
+== INSTALL:
+
+You need RubyGems v. 1.2 
+
+* gem -v 
+* 1.2.0 #=> ok
+
+You need the github.com repository to be added to your sources list:
+
+* gem sources -a http://gems.github.com
+
+Then you can type:
+
+* sudo gem install apohllo-colors
+
+== BASIC USAGE: 
+
+Require the gem:
+
+  require 'colors'
+
+Get the string bold with +hl+:
+  
+  "abc".hl #=> *abc*
+
+Get the string colored:
+  
+  "abc".hl(:red) #=> *abc* (it is red, no kidding :)
+
+Get some words within the string colored (only whole words are colored):
+  
+  "abc abcde abc".hl(:blue, "abc") #=> *abc* abcde *abc*
+
+== LICENSE:
+ 
+(The MIT License)
+
+Copyright (c) 2009 Aleksander Pohl
+
+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.
+
+== FEEDBACK
+
+* mailto:apohllo@o2.pl

data/Rakefile

@@ -0,0 +1,23 @@
+task :default => [:install]
+
+$gem_name = "colors"
+
+desc "Build the gem"
+task :build do
+  sh "gem build #$gem_name.gemspec"
+end
+
+desc "Install the library at local machnie"
+task :install => :build do 
+  sh "sudo gem install #$gem_name -l"
+end
+
+desc "Uninstall the library from local machnie"
+task :uninstall do
+  sh "sudo gem uninstall #$gem_name"
+end
+
+desc "Clean"
+task :clean do
+  sh "rm #$gem_name*.gem" 
+end

data/changelog.txt

@@ -0,0 +1,9 @@
+0.0.4
+  - fix: missing changelog.txt added
+0.0.3
+  - more documentation
+  - constant name changed, when releasing to public
+0.0.2
+  - character trancoding calls removed
+0.0.1
+  - initial implementation with additional calls to_utf, to_iso

data/colors.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name = "colors"
+  s.version = "0.0.4"
+  s.date = "2009-07-15"
+  s.summary = "Ruby String extesion for colored strings"
+  s.email = "apohllo@o2.pl"
+  s.homepage = "http://apohllo.pl"
+  s.description = "Extensions for String highliting"
+  s.has_rdoc = false
+  s.authors = ['Aleksander Pohl']
+  s.files = ["Rakefile", 
+    "colors.gemspec", 
+    'lib/colors.rb', 
+    'lib/colors/string.rb',
+    'features/color.feature', 
+    'README.txt', 
+    'changelog.txt'
+  ]  
+  #s.autorequire = 'lib/colors.rb'
+  s.test_files = [
+    'features/color.feature'
+  ]
+  s.rdoc_options = ["--main", "README.txt"]
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.txt"]
+end
+

data/features/color.feature

@@ -0,0 +1,13 @@
+Feature: String extensions
+  Scenario: colorizing
+    Given I have a string "abc a b"
+    When I highlight it
+    Then I should receive "abc a b"
+    When I highlight "a"
+    Then I should receive "abc a b"
+    When I highlight "abc"
+    Then I should receive "abc a b"
+    When I highlight it with :red
+    Then I should receive "abc a b"
+    When I highlight "abc" with :red
+    Then I should receive "abc a b"

data/lib/colors.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+Dir.glob(File.join(File.dirname(__FILE__), 'colors/**.rb')).sort.each { |f| require f }

data/lib/colors/string.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+class String 
+  HIGHLIGHT = {
+    :end => "",
+    :gray => "",
+    :red => "",
+    :green => "",
+    :yellow => "",
+    :blue => "",
+    :purple => "",
+    :lightblue => "",
+    :white => "",
+    :red_bg => "",
+    :green_bg => "",
+    :yellow_bg => "",
+    :blue_bg => "",
+    :purple_bg => "",
+    :lightblue_bg => "",
+    :white_bg => "",
+    :bold => "",
+    :default => ""
+  }
+
+
+  # Allow string highlighting with Unix terminal codes.
+  # The +type+ of highlighting might be :bold, a color, e.g. :red, :blue
+  # or a background color, e.g. :red_bg, blue_bg, etc.
+  #
+  # If the +word+ is given, only the word will be highlighted. 
+  # It is directly expanded in the Regexp, so you may use meta-characters,
+  # e.g. (John|Frank|Bill). It is also surrounded by anchors, so only
+  # whole words will be highlighted, e.g. "abc abcd".hl(:bold,"abc") 
+  # => *abc* abcd
+  def hl(type=:bold,word=nil)
+    if word
+      self.gsub(/(\s|\A|[[:punct:]])#{word}(\s|\Z|[[:punct:]])/,
+        "\\1" + HIGHLIGHT[type] + word.to_s + HIGHLIGHT[:end] + "\\2")
+    else
+      HIGHLIGHT[type] + self.to_s + HIGHLIGHT[:end]
+    end
+  end
+end
+
+

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: apohllo-colors
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Aleksander Pohl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-15 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Extensions for String highliting
+email: apohllo@o2.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- Rakefile
+- colors.gemspec
+- lib/colors.rb
+- lib/colors/string.rb
+- features/color.feature
+- README.txt
+- changelog.txt
+has_rdoc: true
+homepage: http://apohllo.pl
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby String extesion for colored strings
+test_files: 
+- features/color.feature