colortail 0.1.5 → 0.1.6

data/Changelog.markdown

@@ -1,3 +1,7 @@
+### colortail 0.1.6 2010-04-26
+
+ * BUGFIX: Lots of bugfixes as a result of finally adding testing
+
 ### colortail 0.1.5 2010-04-21
 
  * BUGFIX: Fixed crash on non-existant config file (#2)

data/TODO.markdown

@@ -2,9 +2,4 @@
   * Allow different groupings per file
   * Allow multiple color groupings per file
 
-* 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

@@ -1 +1 @@
-0.1.5
+0.1.6

data/colortail.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{colortail}
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eric Lubow"]
-  s.date = %q{2010-04-21}
+  s.date = %q{2010-04-26}
   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}
@@ -33,6 +33,8 @@ Gem::Specification.new do |s|
      "lib/colortail.rb",
      "lib/colortail/application.rb",
      "lib/colortail/configuration.rb",
+     "test/colortail/test_application.rb",
+     "test/colortail/test_configuration.rb",
      "test/helper.rb",
      "test/test_colortail.rb"
   ]
@@ -42,7 +44,9 @@ Gem::Specification.new do |s|
   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/colortail/test_application.rb",
+     "test/colortail/test_configuration.rb",
+     "test/helper.rb",
      "test/test_colortail.rb",
      "examples/colortail.rb"
   ]

data/lib/colortail.rb

@@ -30,7 +30,13 @@ module ColorTail
             :hidden => 8
         }
     
-        @@color_matchers = []
+        attr_accessor :color_matchers
+
+        def initialize()
+            # This is an instance variable in case we tail
+            # multiple files with different groupings
+            @color_matchers = Array.new
+        end
 
         def log(filename, message, line_prefix=nil)
             # Add the filename to the message
@@ -39,7 +45,7 @@ module ColorTail
             color = :none
             attribute = nil
 
-            @@color_matchers.each do |filter|
+            @color_matchers.each do |filter|
                 if message =~ filter[:match]
                         color = filter[:color]
                         attribute = filter[:attribute]
@@ -67,7 +73,7 @@ module ColorTail
         end
 
         def add_color_matcher( options )
-            @@color_matchers.push( options )
+            @color_matchers.push( options )
         end
     end
 

data/lib/colortail/application.rb

@@ -8,16 +8,19 @@ module ColorTail
                options = opt[:options]
     
                # Deal with any/all options issues
-               if options[:invalid_argument]
-                   $stderr.puts options[:invalid_argument]
+               if opt[:invalid_argument]
+                   $stderr.puts opt[:invalid_argument]
                    options[:help] = true
                end
     
+               # Show the help menu if desired
                if options[:help]
                    $stderr.puts opt.opts
                    return 1
                end
-    
+
+   
+               # The meat of the program
                begin
                    # Read the config file if it exists
                    if File.exists?(options[:conf])
@@ -40,6 +43,22 @@ module ColorTail
                        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
+
                    logger = ColorTail::Colorize.new()
 
                    # Add the color match array if we aren't using the default
@@ -74,13 +93,13 @@ module ColorTail
 
                # If we get a CTRL-C, catch it (rescue) and send it for cleanup
                rescue Interrupt
-                   cleanup(threads)
+                   thread_cleanup(threads)
                end
 
                return 0
             end
 
-            def cleanup(threads)
+            def thread_cleanup(threads)
                 threads.each do |thread|
                     thread.kill
                 end
@@ -90,6 +109,9 @@ module ColorTail
         end
     end
 
+    class Cleanup
+    end
+
 
     class FileDoesNotExist < StandardError
     end

data/lib/colortail/configuration.rb

@@ -6,7 +6,7 @@ module ColorTail
             if File.exists?(conf)
                 @config = File.read(conf)
             else
-                raise FileDoesNotExist, "Config file #{file} cannot be found."
+                raise FileDoesNotExist, "Config file #{@config_file} cannot be found."
             end
         end
 
@@ -15,7 +15,8 @@ module ColorTail
                 if groupings.has_key?( group )
                     return groupings[group]
                 else
-                    raise ComplexRecord, "No such group '#{group}' in config file"
+                    $stderr.puts "No such group '#{group}', falling back to default."
+                    return "'default' => []"
                 end
             else
                 raise ComplexRecord, "Config file syntax error"
@@ -93,6 +94,9 @@ module ColorTail
                 self[:options] = options
             rescue OptionParser::InvalidOption => e
                 self[:invalid_argument] = e.message
+                @opts.parse(args, flags={ :delete_invalid_opts => true })
+                self[:files] = args
+                self[:options] = options
             end
         end
     end

data/test/colortail/test_application.rb

@@ -0,0 +1,86 @@
+require 'helper'
+
+module TestColortail
+
+  class ApplicationTest < Test::Unit::TestCase
+    # No context name necessary since this is to redirect $stdout
+    context "" do
+      setup do
+          ARGV.clear
+
+          @stdout_orig = $stdout
+          $stdout = StringIO.new
+      end
+
+      teardown do
+          $stdout = @stdout_orig
+      end
+
+      context "" do
+        setup do
+          @stderr_orig = $stderr
+          $stderr = StringIO.new
+        end
+        
+        teardown do
+          $stderr = @stderr_orig
+        end
+
+         
+         context "With no options or files" do
+             setup do
+                 ARGV.clear
+             end
+
+             should "show the help menu" do
+               ColorTail::Application.run!(*ARGV)
+               assert_match "Usage:", $stderr.string
+             end
+         end
+
+         context "With '-h' option and no files" do
+             setup do
+                 ARGV.clear
+                 ARGV.push("-h")
+             end
+
+             should "show the help menu" do
+               ColorTail::Application.run!(*ARGV)
+               assert_match "Usage:", $stderr.string
+             end
+         end
+
+         context "With non-existant option and no files" do
+             setup do
+                 ARGV.clear
+                 ARGV.push("-zdfkjlsd")
+             end
+
+             should "show the help menu" do
+               ColorTail::Application.run!(*ARGV)
+               assert_match "invalid option:", $stderr.string
+             end
+         end
+        
+         should "kill all threads and exit cleanly with the word 'Terminating...'" do
+           threads = Array.new
+           threads.push(Thread.new { sleep }, Thread.new { sleep })
+           assert_equal 2, threads.size
+           assert_equal "sleep", threads[0].status
+           assert_equal "sleep", threads[1].status
+           begin
+             ColorTail::Application.thread_cleanup(threads)
+           rescue SystemExit => e
+             assert_equal "Terminating...\n", $stderr.string
+             assert_equal 0, e.status
+           end
+           assert_equal false, threads[0].status
+           assert_equal false, threads[1].status
+         end
+      end
+      
+    end
+    
+  end
+
+end

data/test/colortail/test_configuration.rb

@@ -0,0 +1,117 @@
+require 'helper'
+
+module TestColortail
+
+  class OptionsTest < Test::Unit::TestCase
+    # No context name necessary since this is to redirect $stdout
+    context "" do
+      setup do
+          ARGV.clear
+
+          @stdout_orig = $stdout
+          $stdout = StringIO.new
+      end
+
+      teardown do
+          $stdout = @stdout_orig
+      end
+
+      should "return an options object with no arguments" do
+          @opt = ColorTail::Options.new(ARGV)
+          assert_equal @opt.class, ColorTail::Options
+      end
+      
+      context "With a valid options class instance" do
+        setup do
+          ARGV.clear
+          @opt = ColorTail::Options.new(ARGV)
+        end
+        
+        should "have the group value set as default" do
+          assert_equal @opt[:options][:group], "default"
+        end
+
+        should "have the help switch set to false" do
+          assert_equal @opt[:options][:help], false
+        end
+
+        should "have the show list switch set to false" do
+          assert_equal @opt[:options][:list], false
+        end
+
+        should "have an empty files array" do
+          assert_equal @opt[:files].size, 0
+        end
+
+        should "have a possible config file to test for" do
+          assert_not_nil @opt[:options][:conf]
+        end
+      end
+      
+      should "raise FileDoesNotExist error on non-existant config file" do
+        ARGV.clear
+        config_file = String.new
+        ARGV.push("-c",config_file)
+        assert_raise( ColorTail::FileDoesNotExist ) { @opt = ColorTail::Options.new(ARGV) }
+      end
+      
+    end
+  end
+
+
+  class ConfigurationTest < Test::Unit::TestCase
+    # No context name necessary since this is to redirect $stdout
+    context "" do
+      setup do
+          ARGV.clear
+
+          @stdout_orig = $stdout
+          $stdout = StringIO.new
+      end
+
+      teardown do
+          $stdout = @stdout_orig
+      end
+
+      
+      should "raise a FileDoesNotExist error for non-existant file" do
+          config_file = String.new
+          assert_raise( ColorTail::FileDoesNotExist ) { @config = ColorTail::Configuration.new(config_file) }
+      end
+      
+      context "With a valid configuration instance" do
+        setup do
+          @stderr_orig = $stderr
+          $stderr = StringIO.new
+          
+          @config_file = File.join(File.dirname(__FILE__), '..', '..', 'examples', 'colortail.rb')
+          
+          @config = ColorTail::Configuration.new("#{@config_file}")
+        end
+        
+        teardown do
+          $stderr = @stderr_orig
+        end
+        
+        should "be a valid configuration instance" do
+          assert_equal @config.class, ColorTail::Configuration
+        end
+        
+        should "fallback to 'default' grouping when a non-existent match_group is specified" do
+          @match_group = @config.load_opts('doesNotExist')
+          assert_match "No such group '", $stderr.string
+          assert_equal @match_group, "'default' => []"
+        end
+        
+        should "display match groups" do
+          @match_group = @config.load_opts('default')
+          @config.display_match_groups()
+          assert_match "  * ", $stdout.string
+        end
+      end
+      
+
+    end
+  end
+  
+end

data/test/helper.rb

@@ -7,4 +7,8 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'colortail'
 
 class Test::Unit::TestCase
+  
+  class TestNotImplemented < StandardError
+  end
+  
 end

data/test/test_colortail.rb

@@ -1,7 +1,67 @@
 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"
+module TestColortail
+
+  class ColortailTest < Test::Unit::TestCase
+    # No context name necessary since this is to redirect $stdout
+    context "" do
+      setup do
+          ARGV.clear
+
+          @stdout_orig = $stdout
+          $stdout = StringIO.new
+      end
+
+      teardown do
+          $stdout = @stdout_orig
+      end
+
+      context "With valid logger class" do
+        setup do
+          @logger = ColorTail::Colorize.new()
+        end
+        
+        should "be a valid logger class" do
+            @class = @logger.class
+            assert_equal @class, ColorTail::Colorize
+        end
+
+        should "show a line with no prefix" do
+            @logger.show('My test line', nil)
+            assert_equal $stdout.string, "My test line\n"
+        end
+
+        should "show a line with 'filename:' as a prefix" do
+            @logger.show('My test line', 'filename:')
+            assert_equal $stdout.string, "filename:My test line\n"
+        end
+        
+        should "add nothing to the color matchers class variable with an empty match group" do
+            match_group = Array.new
+            assert_equal match_group, @logger.color_matchers
+            match_group.push( 'default' => [] )
+            @logger.add_color_matcher( 'default' => [] )
+            assert_equal match_group, @logger.color_matchers
+        end
+        
+        context "and an empty match group" do
+          setup do
+            @logger.add_color_matcher( 'default' => [] )
+          end
+
+          should "say 'My test line' with no prefix" do
+            @logger.log('testfile','My test line')
+            assert_equal $stdout.string, "\e[0mMy test line\e[0m\n"
+          end
+
+          should "say 'My test line' with 'testfile: ' as the prefix" do
+            @logger.log('testfile','My test line','testfile: ')
+            assert_equal $stdout.string, "\e[0mtestfile:\e[0m\e[0mMy test line\e[0m\n"
+          end
+        end
+      end
+
+    end
   end
-end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: colortail
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Eric Lubow
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-21 00:00:00 -04:00
+date: 2010-04-26 00:00:00 -04:00
 default_executable: colortail
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,6 +56,8 @@ files:
 - lib/colortail.rb
 - lib/colortail/application.rb
 - lib/colortail/configuration.rb
+- test/colortail/test_application.rb
+- test/colortail/test_configuration.rb
 - test/helper.rb
 - test/test_colortail.rb
 has_rdoc: true
@@ -87,6 +89,8 @@ signing_key:
 specification_version: 3
 summary: Tail a file and color lines based on regular expressions within that line
 test_files: 
+- test/colortail/test_application.rb
+- test/colortail/test_configuration.rb
 - test/helper.rb
 - test/test_colortail.rb
 - examples/colortail.rb