bracken 0.1.0 → 0.1.1

data/Rakefile

@@ -4,7 +4,7 @@ rescue LoadError
   abort 'Please `gem install shoe` to get started.'
 end
 
-Shoe.tie('bracken', '0.1.0', 'Bracken, at present, is a glorified logfile tailer.') do |spec|
+Shoe.tie('bracken', '0.1.1', 'Bracken, at present, is a glorified logfile tailer.') do |spec|
   spec.add_runtime_dependency 'open4'
 
   spec.add_development_dependency 'cucumber'

data/bracken.gemspec

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bracken}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matthew Todd"]
+  s.date = %q{2009-10-28}
+  s.default_executable = %q{bracken}
+  s.email = %q{matthew.todd@gmail.com}
+  s.executables = ["bracken"]
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.files = ["Rakefile", "bracken.gemspec", "README.rdoc", "bin/bracken", "examples/console.rb", "examples/syslog.rb", "examples/system.rb", "features/step_definitions", "features/step_definitions/bracken_steps.rb", "features/support", "features/support/env.rb", "features/tailing.feature", "lib/bracken", "lib/bracken/application.rb", "lib/bracken/configuration", "lib/bracken/configuration/builder.rb", "lib/bracken/configuration/options.rb", "lib/bracken/configuration.rb", "lib/bracken/logfile", "lib/bracken/logfile/filter.rb", "lib/bracken/logfile/stream.rb", "lib/bracken/logfile.rb", "lib/bracken.rb", "test/configuration_builder_test.rb", "test/configuration_options_test.rb", "test/configuration_test.rb", "test/logfile_filter_test.rb", "test/logfile_test.rb", "test/test_helper.rb"]
+  s.rdoc_options = ["--main", "README.rdoc", "--title", "bracken-0.1.1", "--inline-source"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Bracken, at present, is a glorified logfile tailer.}
+
+  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_development_dependency(%q<shoe>, [">= 0"])
+      s.add_runtime_dependency(%q<open4>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<fakefs>, [">= 0"])
+      s.add_development_dependency(%q<jeremymcanally-matchy>, [">= 0"])
+      s.add_development_dependency(%q<redgreen>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoe>, [">= 0"])
+      s.add_dependency(%q<open4>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<fakefs>, [">= 0"])
+      s.add_dependency(%q<jeremymcanally-matchy>, [">= 0"])
+      s.add_dependency(%q<redgreen>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoe>, [">= 0"])
+    s.add_dependency(%q<open4>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<fakefs>, [">= 0"])
+    s.add_dependency(%q<jeremymcanally-matchy>, [">= 0"])
+    s.add_dependency(%q<redgreen>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/examples/syslog.rb

@@ -0,0 +1,13 @@
+# To run this example:
+#   RUBYOPT=rubygems ./bin/bracken -c examples/syslog.rb
+
+path = '/Users/mtodd/Code/hcts-logfiles/syslog.0'
+# path = '/var/log/syslog'
+
+file(path) do
+  on 'dovecot',      /pop3-login/
+  on 'fetchmail',    /reading message/
+  on 'fetchmail',    /skipping message/
+  on 'postfix/smtp', /bounce/
+  on 'pppd',         /peer authentication/
+end

data/examples/system.rb

@@ -0,0 +1,4 @@
+# To run this example:
+#   RUBYOPT=rubygems ./bin/bracken -c examples/system.rb
+
+file '/var/log/system.log'

data/features/step_definitions/bracken_steps.rb

@@ -6,6 +6,10 @@ When /^another process appends "([^\"]*)" to "([^\"]*)"$/ do |contents, path|
   write_to_file(path, contents, 'a')
 end
 
+When /^another process renames "([^\"]*)" to "([^\"]*)"$/ do |old_path, new_path|
+  rename_file(old_path, new_path)
+end
+
 When /^I run (.*)$/ do |command|
   run(command)
 end

data/features/support/env.rb

@@ -12,8 +12,12 @@ class WorkingDirectory
     @working_directory ||= Pathname.new(Dir.mktmpdir)
   end
 
+  def rename_file(old_path, new_path)
+    file(old_path).rename(file(new_path))
+  end
+
   def write_to_file(path, contents, mode='w')
-    working_directory.join(path).open(mode) { |file| file.puts(contents) }
+    file(path).open(mode) { |file| file.puts(contents) }
   end
 
   def run(command)
@@ -30,6 +34,10 @@ class WorkingDirectory
 
   private
 
+  def file(path)
+    working_directory.join(path)
+  end
+
   def rejigger_the_path(command)
     "/usr/bin/env -i PATH='#{PROJECT_ROOT.join('bin')}:#{ENV['PATH']}' RUBYLIB='#{PROJECT_ROOT.join('lib')}' RUBYOPT=rubygems #{command}"
   end

data/features/tailing.feature

@@ -17,6 +17,34 @@ Feature: Tailing
     When another process appends "Line Two" to "syslog"
     Then I should see "Line Two" on standard out
 
+  Scenario: Tailing a file that gets rotated away
+    Given these are the contents of "config.rb":
+      """
+      file 'syslog'
+      """
+    And these are the contents of "syslog":
+      """
+      Line One
+      """
+    When I run bracken -c config.rb
+    Then I should see "Line One" on standard out
+    When another process renames "syslog" to "syslog.0"
+    And another process appends "Line Two" to "syslog"
+    Then I should see "Line Two" on standard out
+
+  Scenario: Tailing a file with a custom number of lines
+    Given these are the contents of "config.rb":
+      """
+      file 'syslog'
+      """
+    And these are the contents of "syslog":
+      """
+      Line One
+      Line Two
+      """
+    When I run bracken -c config.rb -n 1
+    Then I should see "Line Two" on standard out
+
   Scenario: Tailing and filtering an existing file
     Given these are the contents of "config.rb":
       """

data/lib/bracken/configuration/builder.rb

@@ -23,7 +23,7 @@ module Bracken
       end
 
       def file(path, &block)
-        configuration.files << Logfile.new(path)
+        configuration.files << Logfile.new(path, configuration.options.number_of_lines)
 
         if block_given?
           instance_eval(&block)

data/lib/bracken/configuration/options.rb

@@ -5,18 +5,24 @@ module Bracken
 
     class Options
       attr_reader :configuration_file
+      attr_reader :number_of_lines
 
       def initialize
         @configuration_file = '/etc/bracken.rb'
+        @number_of_lines    = 1000
       end
 
       def parse(arguments)
         arguments.extend(::OptionParser::Arguable)
 
         arguments.options do |opts|
-          opts.on('-c', '--config-file PATH', 'Read configuration from PATH.', '[/etc/bracken.rb]') do |path|
+          opts.on('-c', '--config-file=PATH', 'Read configuration from PATH.', '[/etc/bracken.rb]') do |path|
             @configuration_file = path
           end
+
+          opts.on('-n', '--lines=N', Integer, 'Tail the last N lines from each file.', '[1000]') do |number|
+            @number_of_lines = number
+          end
         end.parse!
       end
     end

data/lib/bracken/logfile.rb

@@ -5,16 +5,18 @@ require 'open4'
 module Bracken
   class Logfile
     attr_reader :filters
+    attr_reader :number_of_lines
     attr_reader :path
 
-    def initialize(path)
-      @filters = []
-      @path    = path
+    def initialize(path, number_of_lines)
+      @filters         = []
+      @number_of_lines = number_of_lines
+      @path            = path
     end
 
     def stream
       @stream ||= begin
-        pid, _, out, _ = Open4.popen4("tail -f #{path}")
+        pid, _, out, _ = Open4.popen4("tail -n #{number_of_lines} -F #{path}")
 
         out.extend(Stream)
         out.logfile = self

data/test/configuration_options_test.rb

@@ -18,5 +18,26 @@ class ConfigurationOptionsTest < Test::Unit::TestCase
       @options.parse(%w(--config-file config.rb))
       @options.configuration_file.should == 'config.rb'
     end
+
+    should 'default the number of lines to 1000' do
+      @options.parse(%w())
+      @options.number_of_lines.should == 1000
+    end
+
+    should 'use the number of lines from -n' do
+      @options.parse(%w(-n 10))
+      @options.number_of_lines.should == 10
+    end
+
+    should 'use the number of lines from --lines' do
+      @options.parse(%w(--lines 10))
+      @options.number_of_lines.should == 10
+    end
+
+    should 'require a number for number of lines' do
+      lambda {
+        @options.parse(%w(--lines a))
+      }.should raise_error(OptionParser::InvalidArgument)
+    end
   end
 end

data/test/logfile_test.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 class LogfileTest < Test::Unit::TestCase
   context '#stream' do
     setup do
-      @logfile = Logfile.new(__FILE__)
+      @logfile = Logfile.new(__FILE__, 5)
     end
 
     should 'return a selectable, killable IO object tailing the file' do
@@ -12,7 +12,7 @@ class LogfileTest < Test::Unit::TestCase
       stream = reads.first
 
       begin
-        stream.gets.should == File.readlines(__FILE__)[-10]
+        stream.gets.should == File.readlines(__FILE__)[-5]
       ensure
         stream.kill
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bracken
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Matthew Todd
@@ -92,9 +92,12 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - Rakefile
+- bracken.gemspec
 - README.rdoc
 - bin/bracken
 - examples/console.rb
+- examples/syslog.rb
+- examples/system.rb
 - features/step_definitions/bracken_steps.rb
 - features/support/env.rb
 - features/tailing.feature
@@ -121,7 +124,7 @@ rdoc_options:
 - --main
 - README.rdoc
 - --title
-- bracken-0.1.0
+- bracken-0.1.1
 - --inline-source
 require_paths: 
 - lib