colortail 0.1.6 → 0.1.7

data/.gitignore

@@ -2,3 +2,4 @@ pkg
 doc
 Manifest
 .swp
+tmp/*

data/Changelog.markdown

@@ -1,3 +1,10 @@
+### colortail 0.1.7 2010-05-10
+
+ * FEATURE: Color groupings can now be applied on a per file basis (#10)
+ * FEATURE: Can now pipe input into colortail (#7)
+ * FEATURE: Filename prefixes are now available (-F) (#9)
+ * BUGFIX: Removed "No such group" on match listing (#5)
+
 ### colortail 0.1.6 2010-04-26
 
  * BUGFIX: Lots of bugfixes as a result of finally adding testing

data/README.markdown

@@ -65,9 +65,23 @@ Using ColorTail is similar to using tail. The main assumption is that you will a
 
 #### Tailing with groups
 
-The command below will tail the **/var/log/messages** file using the syslog group. The example config [examples/colortail.rb](http://www.codaset.com/elubow/colortail/source/master/blob/examples/colortail.rb) shows a _syslog_ grouping that is used in command below:
+The command below will tail the **/var/log/messages** file using the syslog group. The example config [examples/colortail.rb](http://www.codaset.com/elubow/colortail/source/master/blob/examples/colortail.rb) shows a _syslog_ grouping that is used in command below (the below 2 commands are equivilent):
 
-   # colortail -g syslog /var/log/messages
+   # colortail -g syslog /var/log/messages   
+   # cat /var/log/messages | colortail -g syslog   
+
+#### Tailing multiple files
+
+To tail multiple files can be confusing, especially when you don't know which file you are seeing. Use the **-F** option to show the filenames at the beginning of each colored line.
+
+   # colortail -F -g syslog /var/log/messages /var/log/secure.log   
+
+#### Tailing multiple files using different color groups
+
+You can also tail multiple files using different color groups. Currently, the separater is *#*. If no grouping is specified with the file or the grouping specified doesn't exist, colortail will default to the one specied on the command line.
+
+   # colortail /var/log/messages#syslog /var/log/secure.log#otherlog   
+   # colortail -g syslog /var/log/messags#nosuchgroup /var/log/secure.log#secure   
 
 ## Caveats and Intended Behaviors ##
 

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/colortail.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{colortail}
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eric Lubow"]
-  s.date = %q{2010-04-26}
+  s.date = %q{2010-05-09}
   s.default_executable = %q{colortail}
   s.description = %q{Tail a file and color lines based on regular expressions within that line. By setting up multiple expression and color groups in the configuration file, you can apply highlighting to a file while its being tailed.}
   s.email = %q{eric@lubow.org}

data/lib/colortail/application.rb

@@ -2,9 +2,16 @@ module ColorTail
 
     class Application
         class << self
+            def version
+                version = File.read("#{File.join(File.dirname(__FILE__), '..')}/../VERSION").chomp!
+                "#{File.basename($0)} v#{version}"
+            end
+            
             def run!(*arguments)
+               require 'fcntl'
+                
                opt = ColorTail::Options.new(arguments) 
-               files = opt[:files]
+               filelist = opt[:files]
                options = opt[:options]
     
                # Deal with any/all options issues
@@ -15,9 +22,16 @@ module ColorTail
     
                # Show the help menu if desired
                if options[:help]
+                   $stderr.puts version()
                    $stderr.puts opt.opts
                    return 1
                end
+               
+               # Show the version
+               if options[:version]
+                   $stderr.puts version()
+                   return 1
+               end
 
    
                # The meat of the program
@@ -25,11 +39,11 @@ module ColorTail
                    # 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])
+                       match_group = config.load_opts(options[:group])
                    else
                        # Create this to ensure we always have a value for this array
-                       @match_group = Array.new
-                       @match_group.push( 'default' => [] )
+                       match_group = Array.new
+                       match_group.push( 'default' => [] )
                    end
 
                    # Display the list of available groups and exit
@@ -42,48 +56,116 @@ module ColorTail
                        end
                        return 1
                    end
-    
-                   # Before we go any further, check for existance of files
-                   @files_exist = false
-                   files.each do |file|
-                       if File.exists?(file)
-                           @files_exist = true
-                           break
-                       end
-                   end
-    
-                   # If we have no files, tell them and show the help
-                   unless @files_exist
-                       $stderr.puts "Please check to make sure the files exist ..."
-                       $stderr.puts opt.opts
-                       return 1
-                   end
-
+                   
+                   # Create the default logging object
                    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|
+                   if match_group.class == Array
+                       match_group.each do |matcher|
                            logger.add_color_matcher( matcher )
                        end
                    else
-                       logger.add_color_matcher( @match_group )
+                       logger.add_color_matcher( match_group )
                    end
-    
-                   # Create a thread for each file
-                   threads = []
-                   files.each do |file|
-                       threads[files.index(file)] = Thread.new {
-                           tailer = ColorTail::TailFile.new( file )
-    
-                           # First display the last 10 lines of each file in ARGV
-                           tailer.interval = 10
-                           tailer.backward( 10 )
-    
-                           # Tail the file and show new lines
-                           tailer.tail { |line|  logger.log( file, line ) }
-                       }
-                       threads[files.index(file)].run
+                   
+                   # Create an empty array of threads
+                   threads = Array.new
+                   
+                   # Set $stdin to be non-blocking
+                   $stdin.fcntl(Fcntl::F_SETFL,Fcntl::O_NONBLOCK)
+                   
+                   begin
+                       threads[0] = Thread.new {
+                           begin
+                               $stdin.each_line do |line|
+                                   if options[:filename_prefix]
+                                       logger.log( nil, line, "STDIN: " )
+                                   else
+                                       logger.log( nil, line )
+                                   end
+                               end
+                           rescue Errno::EAGAIN
+                               # Remove this thread since we won't be reading from $stdin
+                               threads.delete(0)
+                           end
+                       }.run
+                       
+                       # Check to see if there are files in the files array
+                       if filelist.size > 0
+                           # Before we go any further, check for existance of files
+                           @files_exist = false
+                           files = Hash.new
+                           filelist.each do |file|
+                               filename = String.new
+                               group = String.new
+                               filename,group = file.split('#')
+                               if group.nil?
+                                   files[filename] = options[:group]
+                               else
+                                   files[filename] = group
+                               end
+                               
+                               # Check for individual files and ignore file if doesn't exist
+                               if File.exists?(filename)
+                                   @files_exist = true
+                               else
+                                   $stderr.puts("#{filename} does not exist, skipping...")
+                                   filelist.delete(file)
+                               end
+                           end
+                           
+                           # If we have no files, tell them and show the help
+                           if !@files_exist and (threads.class == Array.class and threads.size <= 2)
+                               $stderr.puts "Please check to make sure the files exist ..."
+                               $stderr.puts opt.opts
+                               return 1
+                           end
+                           
+                           # Create a thread for each file
+                           files.each_pair do |filename, grouping|
+                               threads.push Thread.new {
+                                   # Figure out if grouping exists, if not fall back to global default
+                                   if config.group_exists?(grouping)
+                                       # Create a new per file logger object per file
+                                       file_logger = ColorTail::Colorize.new()
+                                       
+                                       # Redefine match_group since we have a new grouping
+                                       match_group = config.load_opts(grouping)
+                                       
+                                       # Add the color match array if we aren't using the default
+                                       if match_group.class == Array
+                                           match_group.each do |matcher|
+                                               file_logger.add_color_matcher( matcher )
+                                           end
+                                       else
+                                           file_logger.add_color_matcher( match_group )
+                                       end
+                                       
+                                   # There is no such group, so we fall back to the default here
+                                   else
+                                       file_logger = logger
+                                   end
+                                   
+                                   # Create the new tailer object
+                                   tailer = ColorTail::TailFile.new( filename )
+
+                                   # First display the last 10 lines of each file in ARGV
+                                   tailer.interval = 10
+                                   tailer.backward( 10 )
+
+                                   # Tail the file and show new lines
+                                   tailer.tail do |line|
+                                       if options[:filename_prefix]
+                                           file_logger.log( filename, line, "#{filename}: ")
+                                       else
+                                           file_logger.log( filename, line )
+                                       end
+                                   end
+                               }.run
+                           end
+                       end
+                       
                    end
 
                    # Let the threads do their real work
@@ -93,15 +175,22 @@ module ColorTail
 
                # If we get a CTRL-C, catch it (rescue) and send it for cleanup
                rescue Interrupt
-                   thread_cleanup(threads)
+                   thread_cleanup(threads) if defined? threads
+               rescue NoInputError
+                   $stderr.puts "Please enter a file to tail..."
+                   $stderr.puts opt.opts
+                   return 1
                end
 
+               # We should never make it here, but just in case...
                return 0
             end
 
             def thread_cleanup(threads)
-                threads.each do |thread|
-                    thread.kill
+                if threads.class == Array.class and threads.size > 0
+                    threads.each do |thread|
+                        thread.kill
+                    end
                 end
                 $stderr.puts "Terminating..."
                 exit
@@ -113,6 +202,9 @@ module ColorTail
     end
 
 
+    class NoInputError < StandardError
+    end
+
     class FileDoesNotExist < StandardError
     end
 

data/lib/colortail/configuration.rb

@@ -4,16 +4,17 @@ module ColorTail
         def initialize(conf)
             @config_file = conf
             if File.exists?(conf)
-                @config = File.read(conf)
+                load @config_file
             else
                 raise FileDoesNotExist, "Config file #{@config_file} cannot be found."
             end
         end
 
-        def colorit(group, groupings)
-            if groupings.class == Hash
-                if groupings.has_key?( group )
-                    return groupings[group]
+        def colorit(group)
+            if Groupings.class == Hash
+                Groupings["default"] = [] unless Groupings.has_key?('default')
+                if Groupings.has_key?( group )
+                    return Groupings[group]
                 else
                     $stderr.puts "No such group '#{group}', falling back to default."
                     return "'default' => []"
@@ -27,11 +28,8 @@ module ColorTail
         # isn't available in the configuration object until after a new object
         # has been instantiated.
         def load_opts(group)
-            colorset = []
-            if File.exists?(@config_file)
-                load @config_file
-                colorset = self.colorit( group, Groupings )
-            end
+            colorset = Array.new
+            colorset = self.colorit( group )
             return colorset
         end
 
@@ -40,6 +38,10 @@ module ColorTail
                 puts "  * #{group}"
             end
         end
+        
+        def group_exists?(key)
+            Groupings.has_key?(key) ? true : false
+        end
     end
 
     class ComplexRecord < StandardError
@@ -65,6 +67,11 @@ module ColorTail
                 o.on( '-g', '--group <group>', 'Specify the color grouping to use for these files' ) do |group|
                     options[:group] = group
                 end
+                
+                options[:filename_prefix] = false
+                o.on( '-F', '--filename_prefix', 'Prefix each colored line with it\'s filename') do
+                    options[:filename_prefix] = true
+                end
 
                 options[:list] = false
                 o.on( '-l', '--list', 'List all the available color groupings' ) do |group|
@@ -81,11 +88,26 @@ module ColorTail
                         raise FileDoesNotExist, "Config file #{file} cannot be found."
                     end
                 end
+                
+                o.on('-V', '--version', "Display version information") do
+                    options[:version] = true
+                end
 
                 options[:help] = false
-                o.on_tail( '-h', '--help', 'Display this help screen' ) do
+                o.on( '-h', '--help', 'Display this help screen' ) do
                     options[:help] = true
                 end
+                
+                o.separator ""
+                o.separator "Examples:"
+                o.separator "  Tail messages and mail log through STDIN with syslog group:"
+                o.separator "    cat /var/log/maillog | #{File.basename($0)} -g syslog /var/log/messages"
+
+                o.separator "  Tail messages with syslog group and maillog with mail group:"
+                o.separator "    #{File.basename($0)} /var/log/messages#syslog /var/log/messages#mail"
+
+                o.separator "  Tail messages with syslog group and maillog with mail group with line prefix:"
+                o.separator "    #{File.basename($0)} -F /var/log/messages#syslog /var/log/messages#mail"
             end
 
             begin

data/test/colortail/test_application.rb

@@ -38,6 +38,18 @@ module TestColortail
              end
          end
 
+         context "With '-V' option and no files" do
+             setup do
+                 ARGV.clear
+                 ARGV.push("-V")
+             end
+
+             should "show the version string" do
+               ColorTail::Application.run!(*ARGV)
+               assert_match /.*\ v/, $stderr.string
+             end
+         end
+
          context "With '-h' option and no files" do
              setup do
                  ARGV.clear

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: colortail
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Eric Lubow
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-26 00:00:00 -04:00
+date: 2010-05-09 00:00:00 -04:00
 default_executable: colortail
 dependencies: 
 - !ruby/object:Gem::Dependency