indy 0.1.1

data/.autotest

@@ -0,0 +1,18 @@
+begin
+  require 'autotest/growl'
+rescue Exception
+  puts %{
+Autotest/Autospec can use Growl (growl.info|growlforwindows.com) to assist with reporting errors.
+This would require Growl for the appropriate platform (MAC|Windows) and the Ruby gem 'karl-autotest-growl'
+}
+  sleep 4
+end
+
+Autotest.add_hook(:initialize) {|at|
+  at.add_exception %r{^\.git}  # ignore Version Control System
+  at.add_exception %r{^./tmp}  # ignore temp files, lest autotest will run again, and again...
+  at.add_mapping(%r{^lib/.*\.rb$}) {|f, _|
+    Dir['spec/**/*.rb']
+  }
+  nil
+}

data/.gitignore

@@ -0,0 +1,2 @@
+nbproject
+

data/.rspec

@@ -0,0 +1 @@
+--color

data/History.txt

@@ -0,0 +1,11 @@
+=== 0.1.1 / 2011-01-13
+
+* Scope search by time (after, before, around, or within)
+* Explicit format string can be provided to parse non-standard log times
+* Reopen (or rewind) source for each #search
+* Source parameter creates an IO object (StringIO, File, or Process)
+
+=== 0.1.0 / 2010-12-13
+
+* Search by exact match or regular expression
+* Search with custom pattern

data/README.md

@@ -0,0 +1,132 @@
+Indy: A Log Archaeology Tool
+====================================
+
+Synopsis
+--------
+
+Log files are often searched for particular strings but it does not often treat the logs themselves as data structures.  Indy attempts to deliver logs with more powerful features by allowing the ability: to collect segments of a log from particular time; find a particular event; or monitor/reflect on a log to see if a particular event occurred (or not occurred).
+
+Installation
+------------
+
+To install Indy use the following command:
+
+    $ gem install indy
+    
+(Add `sudo` if you're installing under a POSIX system as root)
+
+Usage
+-----
+
+## Require Indy
+
+    require 'indy'
+
+## Specify your Source
+
+### As a process or command
+
+    Indy.search( {:cmd => 'ssh user@system "bash --login -c \"cat /var/log/standard.log\" "'} ).for(:severity => 'INFO')
+
+### As a file
+
+    Indy.search('logpath/output.log').for(:application => 'MyApp')
+
+### As a string
+
+    log_string = %{
+        2000-09-07 14:07:41 INFO  MyApp - Entering application.
+        2000-09-07 14:07:41 INFO  MyApp - Exiting application. }
+
+    Indy.search(log_string).for(:message => 'Entering application')
+
+## Specify your Pattern
+
+The default search pattern resembles something you might find:
+
+    YYYY-MM-DD HH:MM:SS SEVERITY APPLICATION_NAME - MESSAGE
+
+### Default Log Pattern
+  
+   Indy.search(source).for(:severity => 'INFO')
+   Indy.search(source).for(:application => 'MyApp', :severity => 'DEBUG')
+
+### Custom Log Pattern
+
+If the default pattern is obviously not strong enough for you, brew your own.
+To do so, specify a pattern and each of the match with their symbolic name.
+
+    # HH:MM:SS SEVERITY APPLICATION#METHOD - MESSAGE
+    custom_pattern = "^(\d{2}:\d{2}:\d{2})\s*(INFO|DEBUG|WARN|ERROR)\s*([^#]+)#([^\s]+)\s*-\s*(.+)$"
+
+    Indy.search(source).with(custom_pattern,:time,:severity,:application,:method,:message).for(:severity => 'INFO', :method => 'allocate')
+
+### Explicit Time Format
+
+By default, Indy tries to guess your time format (courtesy of DateTime#parse). If you supply an explicit time format, it will use DateTime#strptime, as well as try to guess.
+
+This is required when log data uses a non-standard date format, e.g.: U.S. format 12-31-2000
+
+    # 12-31-2011 23:59:59
+    Indy.new(:time_format => '%m-%d-%Y %H:%M:%S', :source => LOG_FILE).for(:all)
+
+## Match Criteria
+
+### Exact Match
+
+    Indy.search(source).for(:message => 'Entering Application')
+    Indy.search(source).for(:severity => 'INFO')
+
+### Exact Match with multiple parameters
+
+    Indy.search(source).for(:message => 'Entering Application', :application => 'MyApp')
+    Indy.search(source).for(:severity => 'INFO', :application => 'MyApp')
+
+### Time Scope
+
+    Indy.search(source).after(:time => '2011-01-13 13:40:00').for(:all)
+    Indy.search(source).before(:time => '2010-12-31 23:59:59').for(:all)
+    Indy.search(source).around(:time => '2011-01-01 00:00:00', :span => 2).for(:all) # 2 minutes around New Year's Eve
+    Indy.search(source).within(:time => ['2011-01-01 00:00:00','2011-02-01 00:00:00']).for(:severity => 'ERROR', :application => 'MyApp')
+
+### Partial Match
+
+    Indy.search(source).like(:message => 'Memory')
+
+### Partial Match with multiple parameters
+
+    Indy.search(source).like(:severity => '(?:INFO|DEBUG)', :message => 'Memory')
+
+## Process the Results
+
+    entries = Indy.search(source).for(:message => 'Entering Application')
+
+    Indy.search(source).for(:message => 'Entering Application').each do |entry|
+        puts entry
+    end
+
+LICENSE
+-------
+
+(The MIT License)
+
+Copyright (c) 2010 Franklin Webber
+
+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/Rakefile

@@ -0,0 +1,68 @@
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require "cucumber/rake/task"
+require "yard"
+require "city"
+
+desc 'Default: run tests'
+task :default => :test
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+desc "Run performance specs"
+RSpec::Core::RakeTask.new(:perf) do |t|
+  t.pattern = "./performance/**/*_spec.rb"
+end
+
+desc "Run features"
+Cucumber::Rake::Task.new(:features) do |task|
+  task.cucumber_opts = ["features", "-f progress"]
+end
+
+desc "Run all reports, specs and features"
+task :all do
+  puts "\nProfiling report"
+  Rake::Task['perf'].invoke
+  puts "\nCode Coverage report"
+  Rake::Task['coverage'].invoke
+  puts "\nFlog results"
+  Rake::Task['flog'].invoke
+  puts "\nSpec Tests"
+  Rake::Task['spec'].invoke
+  puts "\nCucumber features"
+  Rake::Task['features'].invoke
+end
+
+desc "Run tests"
+task :test do
+  Rake::Task['spec'].invoke
+  Rake::Task['features'].invoke
+end
+
+desc "Flog the code! (*nix only)"
+task :flog do
+  system('find lib -name \*.rb | xargs flog')
+end
+
+desc "Detailed Flog report! (*nix only)"
+task :flog_detail do
+  system('find lib -name \*.rb | xargs flog -d')
+end
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec', '--exclude', 'gems', '-T']
+end
+
+
+YARD::Rake::CitydocTask.new do |t|
+  t.files   = ['features/**/*', 'lib/**/*.rb']
+  t.options = ['--private']
+end

data/autotest/discover.rb

@@ -0,0 +1,2 @@
+Autotest.add_discovery { "rspec2" }
+

data/cucumber.yml

@@ -0,0 +1,6 @@
+## YAML Template.
+---
+default: -p base
+base: --format rerun --out rerun.txt --format pretty
+autotest: --format pretty --color
+autotest-all: --format pretty --color

data/features/after_time.feature

@@ -0,0 +1,41 @@
+@time @after
+Feature: Finding log messages after a particular time
+  As an Indy user I am able to find all log messages that have happened after a specified time
+
+  Background:
+    Given the following log:
+    """
+    2000-09-07 14:07:41 INFO  MyApp - Entering application.
+    2000-09-07 14:07:42 DEBUG MyApp - Focusing application.
+    2000-09-07 14:07:43 DEBUG MyApp - Blurring application.
+    2000-09-07 14:07:44 WARN  MyApp - Low on Memory.
+    2000-09-07 14:07:45 ERROR MyApp - Out of Memory.
+    2000-09-07 14:07:46 INFO  MyApp - Exiting application.
+    """
+
+
+  Scenario: Count of entries after a specified time
+    When searching the log for all entries after the time 2000-09-07 14:07:44
+    Then I expect to have found 2 log entries
+
+  Scenario: Count of entries after and including a specified time
+    When searching the log for all entries after and including the time 2000-09-07 14:07:44
+    Then I expect to have found 3 log entries
+
+
+  Scenario: Count of entries after a specified time
+    When searching the log for all entries after the time 2000-09-07 14:07:40
+    Then I expect to have found 6 log entries
+
+
+  Scenario: Particular entry after the specified time
+    When searching the log for all entries after the time 2000-09-07 14:07:41
+    Then I expect the first entry to be:
+    """
+    2000-09-07 14:07:42 DEBUG MyApp - Focusing application.
+    """
+
+
+  Scenario: No entries after the specified time
+    When searching the log for all entries after the time 2000-09-07 14:07:50
+    Then I expect to have found no log entries

data/features/application.feature

@@ -0,0 +1,33 @@
+@application
+Feature: Finding log entries by application
+  As an Indy user I am able to create an instance and find all logs related to a particular application.
+
+  Background:
+    Given the following log:
+    """
+    2000-09-07 14:07:41 INFO  MyApp - Entering application.
+
+    2000-09-07 14:07:41 INFO  MyApp - Exiting application.
+    """
+
+    
+  Scenario: Count of entries for a specific application
+    When searching the log for the application 'MyApp'
+    Then I expect to have found 2 log entries
+    
+    
+  Scenario: Particular entry for a specific application
+    When searching the log for the application 'MyApp'
+    Then I expect the first entry to be:
+    """
+    2000-09-07 14:07:41 INFO  MyApp - Entering application.
+    """
+    Then I expect the last entry to be:
+    """
+    2000-09-07 14:07:41 INFO  MyApp - Exiting application.
+    """
+
+    
+  Scenario: No entries for a specific application
+    When searching the log for the application 'YourApp'
+    Then I expect to have found no log entries

data/features/around_time.feature

@@ -0,0 +1,34 @@
+@time @around
+Feature: Finding log messages around a particular time
+  As an Indy user I am able to find all log messages that have happened around a specified time
+
+  Background:
+    Given the following log:
+      """
+      2000-09-07 14:07:41 INFO  MyApp - Entering application.
+      2000-09-07 14:17:43 DEBUG MyApp - Focusing application.
+      2000-09-07 14:27:43 DEBUG MyApp - Blurring application.
+      2000-09-07 14:37:43 WARN  MyApp - Low on Memory.
+      2000-09-07 14:47:43 ERROR MyApp - Out of Memory.
+      2000-09-07 14:57:46 INFO  MyApp - Exiting application.
+      """
+
+  Scenario: Count of entries for a time span around a specified time
+    When searching the log for all entries 31 minutes around the time 2000-09-07 14:27:43
+    Then I expect to have found 3 log entries
+
+  Scenario: Count of entries for a time span before a specified time
+    When searching the log for all entries 11 minutes before the time 2000-09-07 14:27:43
+    Then I expect to have found 1 log entries
+
+  Scenario: Count of entries for a time span after a specified time
+    When searching the log for all entries 31 minutes after the time 2000-09-07 14:27:43
+    Then I expect to have found 3 log entries
+
+Scenario: Count of entries for a time span before and including a specified time
+    When searching the log for all entries 11 minutes before and including the time 2000-09-07 14:47:43
+    Then I expect to have found 2 log entries
+
+  Scenario: Count of entries for a time span after and including a specified time
+    When searching the log for all entries 31 minutes after and including the time 2000-09-07 14:17:43
+    Then I expect to have found 3 log entries

data/features/before_time.feature

@@ -0,0 +1,34 @@
+@time @before
+Feature: Finding log messages before a particular time
+  As an Indy user I am able to find all log messages that have happened before a specified time
+
+  Background:
+    Given the following log:
+    """
+    2000-09-07 14:07:41 INFO  MyApp - Entering application.
+    2000-09-07 14:07:42 DEBUG MyApp - Focusing application.
+    2000-09-07 14:07:43 DEBUG MyApp - Blurring application.
+    2000-09-07 14:07:44 WARN  MyApp - Low on Memory.
+    2000-09-07 14:07:45 ERROR MyApp - Out of Memory.
+    2000-09-07 14:07:46 INFO  MyApp - Exiting application.
+    """
+
+
+  Scenario: Count of entries before a specifed time
+    When searching the log for all entries before the time 2000-09-07 14:07:44
+    Then I expect to have found 3 log entries
+
+  Scenario: Count of entries before and including a specifed time
+    When searching the log for all entries before and including the time 2000-09-07 14:07:44
+    Then I expect to have found 4 log entries
+
+  Scenario: Particular entry before the specified time
+    When searching the log for all entries before the time 2000-09-07 14:07:43
+    Then I expect the last entry to be:
+    """
+    2000-09-07 14:07:42 DEBUG MyApp - Focusing application.
+    """
+
+  Scenario: No entries before the specified time
+    When searching the log for all entries before the time 2000-09-07 14:07:40
+    Then I expect to have found no log entries

data/features/custom_pattern.feature

@@ -0,0 +1,52 @@
+@log_level
+Feature: Finding log entries with a custom pattern
+  As an Indy user I am able to find all log entries that match my custom log pattern
+
+  Background:
+    Given the following log:
+    """
+    14:07:41 INFO  MyApp#initialize - Entering application.
+    14:07:42 DEBUG MyApp#panel - Focusing application.
+    14:07:43 DEBUG MyApp#panel - Blurring application.
+    14:07:44 WARN  MyApp#allocate - Low on Memory.
+    14:07:45 ERROR MyApp#allocate - Out of Memory.
+    14:07:46 INFO  MyApp#exit - Exiting application.
+    """
+    And the custom pattern (time,severity,application,method,message):
+    """
+    ^(\d{2}:\d{2}:\d{2})\s*(INFO|DEBUG|WARN|ERROR)\s*([^#]+)#([^\s]+)\s*-\s*(.+)$
+    """
+	
+  Scenario: Count of entries at specified log level
+    When searching the log for the log severity INFO
+    Then I expect to have found 2 log entries
+    
+  
+  Scenario: Particular entry at the specified log level
+    When searching the log for the log severity INFO
+    Then I expect the first entry to be:
+    """
+    14:07:41 INFO  MyApp#initialize - Entering application.
+    """
+    And I expect the last entry to be:
+    """
+    14:07:46 INFO  MyApp#exit - Exiting application.
+    """
+    
+    
+  Scenario: No entries at the specified log level
+    When searching the log for the log severity SEVERE
+    Then I expect to have found no log entries
+    
+    
+  Scenario: Find entries at the custom field
+    When searching the log for the exact match of custom field method "allocate"
+    Then I expect to have found 2 log entries
+    Then I expect the first entry to be:
+    """
+    14:07:44 WARN  MyApp#allocate - Low on Memory.
+    """
+    And I expect the last entry to be:
+    """
+    14:07:45 ERROR MyApp#allocate - Out of Memory.
+    """