colorit 0.3.0

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+
+
+## 0.3.0
+
+* added support for regular expressions for color'd strings
+* gem-ified and prepared for testability
+
+## 0.2.0
+
+* added black as color (black on white)
+
+## 0.1.0
+
+* refactored to be able to pipe to colorit
+* removed hard dependency to Perl and `tail` (d'oh!)

data/README.md

@@ -0,0 +1,50 @@
+# colorit
+
+Colorit colors your console outputs with the use of regular expressions and marks words for you in fancy colors.
+
+## Example
+
+This simple example will `tail -f` the systems auth.log file and mark all occurences of *root* in red and of *CRON* in green.
+
+```bash
+tail -f /var/log/auth.log | colorit --red root --green CRON
+```
+
+The next is another easy example that will mark the file names in blue, when more than one log file is tail'd:
+
+```bash
+tail -f /var/log/*.log | colorit --blue "==> (.*) <=="
+```
+
+## Installation
+
+* `[sudo] gem install colorit`
+
+## Author
+
+Original author: Dominik Liebler <liebler.dominik@googlemail.com>
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2012 Dominik Liebler
+
+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/bin/colorit

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib = ::File.expand_path('../../lib', __FILE__)
+require "#{lib}/colorit"
+
+colorit_command = Colorit::Command.new(Colorit::Config.new)
+colorit_command.parse_options
+colorit_command.run(ARGF)

data/lib/colorit.rb

@@ -0,0 +1,14 @@
+lib = File.expand_path('../../lib', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+module Colorit
+  def self.load_modules
+    require 'colorit/colors'
+    require 'colorit/string'
+    require 'colorit/version'
+    require 'colorit/command'
+    require 'colorit/config'
+  end
+end
+
+Colorit.load_modules

data/lib/colorit/colors.rb

@@ -0,0 +1,34 @@
+module Colorit
+  module Colors
+    include Enumerable
+
+    COLORS = {
+        :reset    => "\e[0m",
+        :red      => "\e[1;37;41m",
+        :black    => "\e[1;30;47m",
+        :green    => "\e[1;32m",
+        :yellow   => "\e[1;33m",
+        :blue     => "\e[1;34m",
+        :magenta  => "\e[1;35m",
+        :cyan	  => "\e[1;36m",
+    }
+
+    # to implement Enumerable
+    #
+    def self.each(&block)
+      self.all().each(&block)
+    end
+
+    # get reset preset
+    #
+    def self.reset
+      Colorit::Colors::COLORS[:reset]
+    end
+
+    # get all "real" colors
+    #
+    def self.all
+      Colorit::Colors::COLORS.reject {|k,v| k == :reset }
+    end
+  end
+end

data/lib/colorit/command.rb

@@ -0,0 +1,74 @@
+require 'optparse'
+
+module Colorit
+  class Command
+    #
+    # @param Colorit::Config config
+    #
+    def initialize(config)
+      @config = config
+    end
+
+    def parse_options
+      OptionParser.new do |opts|
+        opts.banner = "Usage: colorit [options]"
+
+        # add a CLI option to every color
+        Colorit::Colors.each do |key,color|
+          opts.on("-#{key.to_s[0]}", "--#{key} WORD", "highlight WORD in #{color}#{key}#{Colorit::Colors.reset()}") do |word|
+            @config.send(key, word)
+          end
+        end
+
+        opts.on('--debug', 'show debug output') do
+          @config.debug = true
+        end
+
+        opts.on_tail("--version", "show version") do
+          puts Colorit::VERSION.join('.')
+          exit
+        end
+      end.parse!
+    end
+
+    # run the command line tool on the stream_source (ARGF in most cases)
+    #
+    def run(stream_source)
+      colors = prepare_patterns
+
+      begin
+        stream_source.each do |line|
+          colors.each do |color, pattern|
+            line = line.colorize(pattern, color)
+          end
+
+          puts line
+        end
+      rescue SystemExit, Interrupt
+        # do nothing but leaving the loop to exit ...
+      end
+    end
+
+    private
+
+    # prepare all regexp patterns for all colors
+    #
+    # @return Hash
+    #
+    def prepare_patterns
+      colors = {}
+      @config.colors.each do |color, words|
+        if words.length > 1
+          word_pattern = (words.map { |h| "(#{h})" }).join('|')
+          word_pattern = Regexp.new(word_pattern)
+        else
+          word_pattern = Regexp.new(words[0])
+        end
+
+        colors[color] = word_pattern
+      end
+
+      colors
+    end
+  end
+end

data/lib/colorit/config.rb

@@ -0,0 +1,26 @@
+module Colorit
+  class Config
+    attr_reader :colors, :debug
+
+    # add setters for every color
+    #
+    Colorit::Colors.each do |key,value|
+      if key != :reset
+        define_method(key) do |word|
+          @colors[key] = [] unless @colors.include?(key)
+          @colors[key] << word
+        end
+      end
+    end
+
+    def initialize
+      @debug = false
+      @colors = {}
+    end
+
+    def debug=(debug)
+      # todo: ensure boolean here!
+      @debug = debug
+    end
+  end
+end

data/lib/colorit/string.rb

@@ -0,0 +1,12 @@
+# monkey-patch String to color strings and patterns in strings
+#
+class String
+
+  # colorize an arbitrary string
+  #
+  def colorize(pattern, color)
+    gsub(pattern) do
+      Colorit::Colors.all[color] + $& + Colorit::Colors.reset()
+    end
+  end
+end

data/lib/colorit/version.rb

@@ -0,0 +1,3 @@
+module Colorit
+  VERSION = %w(0 3 0) unless defined?(::Colorit::VERSION)
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: colorit
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Dominik Liebler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-12 00:00:00.000000000 Z
+dependencies: []
+description: colorit colors your console outputs using regular expressions to emphasize
+  special words in e.g. logfiles
+email:
+- liebler.dominik@googlemail.com
+executables:
+- colorit
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/colorit
+- lib/colorit/colors.rb
+- lib/colorit/command.rb
+- lib/colorit/config.rb
+- lib/colorit/string.rb
+- lib/colorit/version.rb
+- lib/colorit.rb
+- README.md
+- CHANGELOG.md
+homepage: https://github.com/domnikl/colorit
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: colors your console outputs
+test_files: []