colortail 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+doc
+Manifest
+.swp

data/ChangeLog.markdown

@@ -0,0 +1,3 @@
+### colortail 0.0.0 2010-04-19
+
+ * Initial release

data/Changelog.markdown

@@ -0,0 +1,3 @@
+### colortail 0.0.0 2010-04-19
+
+ * Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Eric Lubow
+
+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.markdown

@@ -0,0 +1,51 @@
+# ColorTail #
+
+What does ColorTail do for me?
+
+ColorTail provides a cool way for you to configure how logfiles (or any other files for that matter) look when you tail them.
+
+## Installation ##
+
+### Install the gem ##
+    gem install colortail
+
+## Using ColorTail ##
+
+By default, ColorTail does absolutely nothing other than just tail a file normally (similar to the trust old unix tool 'tail -f').  But what good what writing a gem be if it just mimiced existing functionality.
+
+## Conifguring ColorTail ##
+
+Configuring ColorTail is easy.  In your home directory, create a file .colortailrc.  This file will contain a group of ruby arrays similar to the ones laid out in the example config **examples/colortail.rb**.  These arrays are called groups.  Any group can be loaded via the command line using the **-g** switch (more on this below).
+
+The standard configuration file is **.colortailrc**.  It needs to be in the format of a Ruby hash.
+
+## Usage ##
+
+Using ColorTail is similar to using tail. The main assumption is that you will always be _indefinitely_ tail'ing a file. Currently ColorTail only allows for tailing 1 file.
+
+#### Tailing with groups
+
+The command below will tail the **/var/log/messages** file using the syslog group. The example config **examples/colortail.rb** shows a _syslog_ grouping that is used in command below:
+
+   # colortail -g syslog /var/log/messages
+
+## Author ##
+
+Eric Lubow <eric at lubow dot org>
+
+  * Web: [http://eric.lubow.org/](http://eric.lubow.org)
+  * Twitter: [elubow](http://twitter.com/elubow)
+
+## Note on Patches/Pull Requests
+ 
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Add tests for it. This is important so I don't break it in a
+    future version unintentionally.
+  * Commit, do not mess with rakefile, version, or history.
+    (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+  * Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Eric Lubow. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "colortail"
+    gem.executables = "colortail"
+    gem.summary = "Tail a file and color lines based on regular expressions within that line"
+    gem.description = "Tail a file and color lines based on regular expressions within that line"
+    gem.email = "eric@lubow.org"
+    gem.homepage = "http://codaset.com/elubow/colortail"
+    gem.authors = ["Eric Lubow"]
+    gem.add_dependency 'file-tail'
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "colortail #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO.markdown

@@ -0,0 +1,9 @@
+* General
+  * Added multithreading to allow for tailing multiple files simultaneously
+
+* Add Testing
+
+* Add option to tail file (-f) or work like tail with (-XX) which is a line count
+
+* Errors
+  * Handle when there is no 'group' in config file

data/VERSION

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

data/bin/colortail

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'colortail'
+
+exit ColorTail::Application.run!(*ARGV)

data/colortail.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{colortail}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eric Lubow"]
+  s.date = %q{2010-04-19}
+  s.default_executable = %q{colortail}
+  s.description = %q{Tail a file and color lines based on regular expressions within that line}
+  s.email = %q{eric@lubow.org}
+  s.executables = ["colortail"]
+  s.extra_rdoc_files = [
+    "ChangeLog.markdown",
+     "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "Changelog.markdown",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "TODO.markdown",
+     "VERSION",
+     "bin/colortail",
+     "colortail.gemspec",
+     "examples/colortail.rb",
+     "examples/test.log",
+     "lib/colortail.rb",
+     "lib/colortail/application.rb",
+     "lib/colortail/configuration.rb",
+     "test/helper.rb",
+     "test/test_colortail.rb"
+  ]
+  s.homepage = %q{http://codaset.com/elubow/colortail}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Tail a file and color lines based on regular expressions within that line}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_colortail.rb",
+     "examples/colortail.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<file-tail>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<file-tail>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<file-tail>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/examples/colortail.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'colortail'
+
+Groupings = {
+
+  # This default matching scheme
+  'default' => [],
+  
+  # Matchers for syslog
+  'syslog' => [ 
+      { :match => /EMERGENCY/,    :color => :red,     :attribute => :reverse },
+      { :match => /FATAL/,        :color => :red,     :attribute => :bright },
+      { :match => /CRITICAL/,     :color => :red },
+      { :match => /DEBUG/,        :color => :green },
+      { :match => /ERROR/,        :color => :green },
+      { :match => /INFO/,         :color => :none },
+      { :match => /WARN/,         :color => :yellow }
+  ]
+
+}

data/examples/test.log

@@ -0,0 +1,6 @@
+2010-04-14 12:51:21,088 NONE     Starting new creation process
+2010-04-15 02:18:12,693 ERROR    Error 1064: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'yes''' at line 1
+2010-04-15 12:51:21,088 DEBUG    Debugging enabled
+2010-04-15 12:51:21,123 INFO     Creating new File
+2010-04-15 12:51:21,242 CRITICAL Cannot proceed without -F/--force option
+2010-04-15 12:52:27,852 EMERGENCY Shutting down immediately

data/lib/colortail.rb

@@ -0,0 +1,77 @@
+require 'rubygems'
+require 'file/tail'
+
+dir = File.dirname(__FILE__) + '/colortail'
+
+require dir + '/application'
+require dir + '/configuration'
+
+module ColorTail
+    class Colorize
+        COLORS = {
+            :none => "0",
+            :black => "30",
+            :red => "31",
+            :green => "32",
+            :yellow => "33",
+            :blue => "34",
+            :magenta => "35",
+            :cyan => "36",
+            :white => "37"
+        }
+    
+        ATTRIBUTES = {
+            :bright => 1,
+            :dim => 2,
+            :underscore => 4,
+            :blink => 5,
+            :reverse => 7,
+            :hidden => 8
+        }
+    
+        @@color_matchers = []
+
+        def log(filename, message, line_prefix=nil)
+            # Add the filename to the message
+            message = "#{message}"
+
+            color = :none
+            attribute = nil
+
+            @@color_matchers.each do |filter|
+                if message =~ filter[:match]
+                        color = filter[:color]
+                        attribute = filter[:attribute]
+                        message = filter[:prepend] + message unless filter[:prepend].nil?
+                        break
+                end
+            end
+
+            if color != :hide
+                current_color = COLORS[color]
+                current_attribute = ATTRIBUTES[attribute]
+
+                line_prefix = colorit(line_prefix.to_s, current_color, current_attribute, nil) unless line_prefix.nil?
+                show(colorit(message, current_color, current_attribute), line_prefix)
+            end
+        end
+
+        def show(message,prefix)
+            puts "#{prefix}#{message}"
+        end
+    
+        def colorit(message, color, attribute, nl = "\n")
+            attribute = "#{attribute};" if attribute
+            "\e[#{attribute}#{color}m" + message.strip + "\e[0m#{nl}"
+        end
+
+        def add_color_matcher( options )
+            @@color_matchers.push( options )
+        end
+    end
+
+
+    class TailFile < File
+        include File::Tail
+    end
+end

data/lib/colortail/application.rb

@@ -0,0 +1,57 @@
+module ColorTail
+
+    class Application
+        class << self
+            def run!(*arguments)
+               opt = ColorTail::Options.new(arguments) 
+               files = opt[:files]
+               options = opt[:options]
+    
+               # Deal with any/all options issues
+               if options[:invalid_argument]
+                   $stderr.puts options[:invalid_argument]
+                   options[:help] = true
+               end
+    
+               if options[:help]
+                   $stderr.puts options.opts
+                   return 1
+               end
+    
+               begin
+                   # Read the config file if it exists
+                   if File.exists?(options[:conf])
+                       config = ColorTail::Configuration.new(options[:conf])
+                       @match_group = config.load_opts(options[:group])
+                   else
+                       # Create this to ensure we always have a value for this array
+                       @match_group = Array.new
+                   end
+    
+                   logger = ColorTail::Colorize.new()
+
+                   # Add the color match array if we aren't using the default
+                   if @match_group.class == Array
+                       @match_group.each do |matcher|
+                           logger.add_color_matcher( matcher )
+                       end
+                   else
+                       logger.add_color_matcher( @match_group )
+                   end
+    
+    
+                   # XXX TODO Just tail the first file
+                   tailer = ColorTail::TailFile.new( files[0] )
+                   tailer.interval = 10
+                   tailer.backward( 10 )
+                   tailer.tail { |line|  logger.log( files[0], line ) }
+               end
+            end
+        end
+    end
+
+
+    class FileDoesNotExist < StandardError
+    end
+
+end

data/lib/colortail/configuration.rb

@@ -0,0 +1,87 @@
+module ColorTail
+
+    class Configuration
+        def initialize(conf)
+            @config_file = conf
+            if File.exists?(conf)
+                @config = File.read(conf)
+            else
+                raise FileDoesNotExist, "Config file #{file} cannot be found."
+            end
+        end
+
+        def colorit(group, groupings)
+            if groupings.class == Hash
+                if groupings.has_key?( group )
+                    return groupings[group]
+                else
+                    raise ComplexRecord, "No such group '#{group}' in config file"
+                end
+            else
+                raise ComplexRecord, "Config file syntax error"
+            end
+        end
+
+        # Load everything from the config file here since the colorit() method
+        # isn't available in the configuration object until after a new object
+        # has been instantiated.
+        def load_opts(group)
+            require @config_file
+            colorset = self.colorit( group, Groupings )
+            return colorset
+        end
+    end
+
+    class ComplexRecord < StandardError
+    end
+
+    class Options < Hash
+        attr_reader :opts, :orig_args
+
+        def initialize(args)
+            super()
+
+            user_home = ENV['HOME']
+
+            @orig_args = args.clone
+
+            options = {}
+            
+            require 'optparse'
+            @opts = OptionParser.new do |o|
+                o.banner = "Usage: #{File.basename($0)} <file>"
+            
+                options[:group] = 'default'
+                o.on( '-g', '--group <group>', 'Specify the color grouping to use for these files' ) do |group|
+                    options[:group] = group
+                end
+
+                o.separator ""
+            
+                options[:conf] = "#{user_home}/.colortailrc"
+                o.on( '-c', '--conf <FILE>', 'Specify an alternate config file' ) do |file|
+                    if File.exists?(file)
+                        options[:conf] = file
+                    else
+                        raise FileDoesNotExist, "Config file #{file} cannot be found."
+                    end
+                end
+
+                options[:help] = false
+                o.on( '-h', '--help', 'Display this help screen' ) do
+                    options[:help] = true
+                    exit
+                end
+            end
+
+            begin
+                @opts.parse!(args)
+                self[:files] = args
+                self[:options] = options
+            rescue OptionParser::InvalidOption => e
+                self[:invalid_argument] = e.message
+            end
+        end
+    end
+
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'colortail'
+
+class Test::Unit::TestCase
+end

data/test/test_colortail.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestColortail < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: colortail
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Eric Lubow
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-19 00:00:00 -04:00
+default_executable: colortail
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: file-tail
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Tail a file and color lines based on regular expressions within that line
+email: eric@lubow.org
+executables: 
+- colortail
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog.markdown
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- Changelog.markdown
+- LICENSE
+- README.markdown
+- Rakefile
+- TODO.markdown
+- VERSION
+- bin/colortail
+- colortail.gemspec
+- examples/colortail.rb
+- examples/test.log
+- lib/colortail.rb
+- lib/colortail/application.rb
+- lib/colortail/configuration.rb
+- test/helper.rb
+- test/test_colortail.rb
+- ChangeLog.markdown
+has_rdoc: true
+homepage: http://codaset.com/elubow/colortail
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Tail a file and color lines based on regular expressions within that line
+test_files: 
+- test/helper.rb
+- test/test_colortail.rb
+- examples/colortail.rb