frogger 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,25 +1,22 @@
 = frogger
-'Hop around your logs'
+'Hop across the logs'
 
-Frogger makes navigating logs easier and more fun.
-
-Navigating 'noise' in your log files can feel like when you are crossing a busy road while attempting to avoid the cars.
+Navigating your log files can feel like you are crossing a busy road while attempting to avoid the cars.
 Frogger makes your log files more fun by adding some 8 bit colour and a some nice formatting.
 
 == Why?
+I created frogger after squinting at the log tail so many times and feeling like a complete idiot as I searched for a needle in a haystack.
 
-Other log enhancing gems are all about tracking performance and other such tasks.
-
-Ignore the traffic and just get across the logs.
-Forget how fast the traffic is, frogger just helps you get across the logs.
+I thought surely this can be more fun.
 
-Frogger is different. When you tail your logs, there is so much 'noise', it's hard to find a safe path through.
-
-I created frogger after squinting at the log tail so many times and feeling like a complete idiot as I searched for my needle in a haystack.
+Other log enhancing gems are all about tracking performance and other such tasks.
+Frogger is not about speed, it's about getting through the logs with the least amount of pain.
 
-I though surely this can be more fun.
+== What it does
 
-Initially I've added a few tricks for working with cucumber log files, but there is more to come.
+Initially I've added a few tricks for working with cucumber log files.
+Run a cucumber feature and tail your log file
+The scenario name and step names will annotate your log file in glorious 8 bit colour
 
 == How
 
@@ -37,8 +34,12 @@ Windows users:
 == Usage
   Just tail your log files like you usually do.
   Eg.
+  
     $ tail -f /log/test.log
     
+  Then run your cucumber tests
+    $ bundle exec cucumber
+    
   And be amazed as your log files become just a little more fun.
   Disclaimer: Increased fun may vary from developer to developer.
 
@@ -56,7 +57,7 @@ Windows users:
 
 == Compatibility
 
-  Currently certified for IWOMM (It works on my machine)
+  No known issues
 
 == Contributing to frogger
  

data/VERSION

@@ -1 +1 @@
-1.0.0
+0.1.1

data/features/enhanced_logger.feature

@@ -0,0 +1,15 @@
+Feature: A developer is ecstatic to discover informative step based logging in their rails log
+  As a developer
+  In order to derive joy and happiness when checking my cucumber logs
+  I want to see rainbows and unicorns when my log files run
+
+Scenario: Step information is written to the rails log
+  Given a cucumber feature is executing against my rails application
+  When I examine the rails log
+  And I do some crazy Inception like test on myself
+  Then I see the following log entries:
+  | Message                                                            | Colour           |
+  | STEP INFORMATION IS WRITTEN TO THE RAILS LOG                       | black_on_green   |
+  | Given a cucumber feature is executing against my rails application | black_on_yellow  |
+  | When I examine the rails log                                       | black_on_yellow  |
+  | And I do some crazy Inception like test on myself                  | black_on_yellow  |

data/features/step_definitions/enhanced_logging_steps.rb

@@ -0,0 +1,56 @@
+class String
+  def black_on_green
+    [self, :black_on_green]
+  end
+  
+  def black_on_blue
+    [self, :black_on_blue]
+  end
+    
+  def black_on_yellow
+    [self, :black_on_yellow]
+  end
+end
+
+class FakeLogger
+  attr_reader :logs
+
+  def initialize
+    @logs = []
+  end
+
+  def reset
+    @logs = []
+  end
+
+  def debug message
+    @logs << message
+  end
+end
+
+module Rails
+  def self.logger
+    @logger ||= FakeLogger.new
+  end
+end
+
+Given /^a cucumber feature is executing against my rails application$/ do
+  #Rails.logger.reset
+end
+
+When /^I examine the rails log$/ do
+end
+
+When /^I do some crazy Inception like test on myself$/ do
+end
+
+Then /^I see the following log entries:$/ do |ast|
+  completed_lines = ast.hashes[0..-2]
+  completed_lines.each do |expected_line|
+    message, colour = expected_line['Message'], expected_line['Colour'].to_sym
+    
+    raise "Did not find expected log entry #{string}" unless Rails.logger.logs.any? do |log|
+      log.first.chomp.strip == message && log[1] == colour
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,2 @@
+require 'pp'
+require File.expand_path "../../../lib/frogger/cucumber", __FILE__

data/frogger.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{frogger}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richie Khoo"]
-  s.date = %q{2011-06-11}
+  s.date = %q{2011-06-15}
   s.description = %q{Navigating noise in your log files can be like trying to cross a busy road and avoid the cars. Frogger makes your log files more fun by adding some good ol' 8 bit color and a bit of formatting.}
   s.email = %q{evolve2k@gmail.com}
   s.extra_rdoc_files = [
@@ -24,14 +24,18 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
+    "features/enhanced_logger.feature",
+    "features/step_definitions/enhanced_logging_steps.rb",
+    "features/support/env.rb",
     "frogger.gemspec",
     "lib/frogger.rb",
+    "lib/frogger/cucumber.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/evolve2k/frogger}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.3}
+  s.rubygems_version = %q{1.7.2}
   s.summary = %q{Frogger makes logs easier to navigate.}
   s.test_files = [
     "spec/spec_helper.rb"
@@ -42,7 +46,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<colored>, [">= 1.2"])
-      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_runtime_dependency(%q<cucumber>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])

data/lib/frogger/cucumber.rb

@@ -0,0 +1,50 @@
+Cucumber::Ast::Background.send(:attr_reader, :raw_steps)
+Cucumber::Ast::Feature.send(:attr_reader, :background)
+
+Before do |scenario|  
+  scenario_background = scenario.feature.send(:background)
+  @frogger_steps = if scenario_background
+    scenario_background.send(:raw_steps) + scenario.raw_steps
+  else
+    scenario.raw_steps
+  end
+  
+  @max_length = scenario.name.length
+  @frogger_steps.each { |step|
+    step_length = "#{step.keyword} #{step.name}".length
+    @max_length  = step_length if step_length > @max_length
+  }
+  @max_length + 6
+  
+  padding = @max_length - 2 - scenario.name.length
+  Rails.logger.debug("\n\n  #{scenario.name.upcase}#{ ' ' * padding }  ".black_on_green)
+  # Rails.logger.debug("\n\n ".black_on_green + ' ' + scenario.name + ' ' + ' '.black_on_green)
+  
+  @step_index = 0
+  print_step(@frogger_steps[@step_index])
+end
+
+AfterStep do |scenario|
+  @step_index += 1
+  print_step(@frogger_steps[@step_index]) if @frogger_steps[@step_index]
+end
+
+def print_step(step)
+  step_to_s = "#{step.keyword}#{step.name}"
+  padding = @max_length - 4 - step_to_s.length
+  padding = 0 if padding < 0
+  if step.background?
+    Rails.logger.debug("\n    #{ step_to_s }#{ ' ' * padding }  ".black_on_blue) unless step == nil
+  else
+    Rails.logger.debug("\n    #{ step_to_s }#{ ' ' * padding }  ".black_on_yellow) unless step == nil  
+    # Rails.logger.debug("\n ".black_on_yellow + ' ' + step_to_s + ' ' + " ".black_on_yellow)
+  end
+end
+
+# module ActiveRecord
+#   class LogSubscriber < ActiveSupport::LogSubscriber
+#     def sql(event)
+#       puts event.payload[:name].gsub(/(.*) Load/, "\\1").inspect
+#     end
+#   end
+# end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: frogger
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Richie Khoo
@@ -15,11 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-11 00:00:00 Z
+date: 2011-06-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: colored
-  prerelease: false
+  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -30,11 +29,11 @@ dependencies:
         - 1
         - 2
         version: "1.2"
-  type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: cucumber
+  name: colored
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -44,11 +43,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: cucumber
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -58,11 +57,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: bundler
+  name: shoulda
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -74,11 +73,11 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  type: :development
   version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: jeweler
+  name: bundler
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -90,11 +89,11 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
-  type: :development
   version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rcov
+  name: jeweler
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -104,8 +103,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
   version_requirements: *id006
+  name: rcov
+  prerelease: false
 description: Navigating noise in your log files can be like trying to cross a busy road and avoid the cars. Frogger makes your log files more fun by adding some good ol' 8 bit color and a bit of formatting.
 email: evolve2k@gmail.com
 executables: []
@@ -123,8 +123,12 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- features/enhanced_logger.feature
+- features/step_definitions/enhanced_logging_steps.rb
+- features/support/env.rb
 - frogger.gemspec
 - lib/frogger.rb
+- lib/frogger/cucumber.rb
 - spec/spec_helper.rb
 homepage: http://github.com/evolve2k/frogger
 licenses: