frogger 0.1.2 → 0.2.0

data/Gemfile

@@ -1,16 +1,10 @@
 source "http://rubygems.org"
 
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-gem 'colored', '>= 1.2'
-gem "cucumber", ">= 0"
+gem 'colored',  '>= 1.2'
+gem 'cucumber', '>= 0.10.5'
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development, :test do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
-end
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.5.2'
+  gem 'rspec',   '2.6.0'
+end

data/Gemfile.lock

@@ -19,8 +19,14 @@ GEM
       rake
     json (1.5.1)
     rake (0.9.2)
-    rcov (0.9.9)
-    shoulda (2.11.3)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
     term-ansicolor (1.0.5)
 
 PLATFORMS
@@ -29,7 +35,6 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0.0)
   colored (>= 1.2)
-  cucumber
+  cucumber (>= 0.10.5)
   jeweler (~> 1.5.2)
-  rcov
-  shoulda
+  rspec (= 2.6.0)

data/README.textile

@@ -0,0 +1,67 @@
+h1. frogger
+
+'Hop across the logs'
+
+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 some nice formatting.
+
+h2. 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.
+
+I thought surely this can be more fun.
+
+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.
+
+h2. What it does
+
+Run a cucumber feature and tail your log file, the scenario name and step names will be annotated in your log file in glorious 8 bit colour.
+
+h2. How
+
+Add this to your Gemfile:
+
+<pre><code>gem 'frogger'</code></pre>
+    
+*Windows users:* You will need the Win32 Console Ansi gem.  Get it by running this from the command line:
+
+<pre><code>gem install win32console</code></pre>
+
+
+h2. Usage
+
+Just tail your log files like you usually do.
+
+<pre><code>$ tail -f /log/test.log</code></pre>
+  
+Then run your cucumber tests
+
+<pre><code>$ bundle exec cucumber</code></pre>
+  
+And be amazed as your log files become just a little more fun. Disclaimer: Increased fun may vary from developer to developer.
+
+h2. Who?
+
+Richie Khoo is a developer from Melbourne, Australia. Don't be shy, you can follow me on twitter via "@evolve2k":http://twitter.com/evolve2k
+
+Special thanks to: 
+"Pat Allan":http://twitter.com/pat, "Keith Pitt":http://twitter.com/keithpitt, "Jared Fraser"::http://twitter.com/modsognir, "Thomas Sinclair":http://twitter.com/anathematic, "Mark Ryall":http://twitter.com/markryall, "Nathan Sampimon":http://twitter.com/nathan_scott and everyone else at Australian Rails Camp 9 who helped me with the code and understanding the inner workings of cucumber.
+
+h2. Compatibility
+
+No known issues
+
+h2. Contributing to frogger
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add rspec tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+h2. Copyright
+
+Copyright (c) 2011 Richie Khoo. See LICENSE.txt for further details.

data/Rakefile

@@ -31,13 +31,6 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
 task :default => :test
 
 require 'rake/rdoctask'

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/features/support/env.rb

@@ -1,2 +1,3 @@
-require 'pp'
-require File.expand_path "../../../lib/frogger/cucumber", __FILE__
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
+
+require 'frogger'

data/frogger.gemspec

@@ -5,23 +5,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{frogger}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richie Khoo"]
-  s.date = %q{2011-06-15}
+  s.date = %q{2011-06-28}
   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 = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.textile"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.textile",
     "Rakefile",
     "VERSION",
     "features/enhanced_logger.feature",
@@ -30,6 +30,8 @@ Gem::Specification.new do |s|
     "frogger.gemspec",
     "lib/frogger.rb",
     "lib/frogger/cucumber.rb",
+    "lib/frogger/frog.rb",
+    "spec/frogger/frog_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/evolve2k/frogger}
@@ -38,6 +40,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.7.2}
   s.summary = %q{Frogger makes logs easier to navigate.}
   s.test_files = [
+    "spec/frogger/frog_spec.rb",
     "spec/spec_helper.rb"
   ]
 
@@ -46,26 +49,23 @@ 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_runtime_dependency(%q<cucumber>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<cucumber>, [">= 0.10.5"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["= 2.6.0"])
     else
       s.add_dependency(%q<colored>, [">= 1.2"])
-      s.add_dependency(%q<cucumber>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0.10.5"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["= 2.6.0"])
     end
   else
     s.add_dependency(%q<colored>, [">= 1.2"])
-    s.add_dependency(%q<cucumber>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0.10.5"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["= 2.6.0"])
   end
 end
 

data/lib/frogger.rb

@@ -1,2 +1,7 @@
+require 'colored'
+
 module Frogger
-end
+end
+
+require 'frogger/frog'
+require 'frogger/cucumber' if defined?(Cucumber)

data/lib/frogger/cucumber.rb

@@ -1,52 +1,9 @@
-require 'colored'
-
-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])
+Before do |scenario|
+  @frog = Frogger::Frog.new scenario
+  @frog.log_scenario
+  @frog.log_step
 end
 
-AfterStep do |scenario|
-  @step_index += 1
-  print_step(@frogger_steps[@step_index]) if @frogger_steps[@step_index]
+AfterStep do
+  @frog.log_step
 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

data/lib/frogger/frog.rb

@@ -0,0 +1,56 @@
+class Frogger::Frog
+  attr_reader   :scenario, :logger
+  attr_accessor :step_index
+  
+  def initialize(scenario, logger = default_logger)
+    @scenario   = scenario
+    @logger     = logger
+    @step_index = 0
+  end
+  
+  def log_scenario
+    padding = max_length - 2 - scenario.name.length
+    logger.debug(
+      "\n\n  #{scenario.name.upcase}#{ ' ' * padding }  ".black_on_green
+    )
+  end
+  
+  def log_step
+    return if step.nil?
+    
+    step_to_s = "#{step.keyword}#{step.name}"
+    padding = [max_length - 4 - step_to_s.length, 0].max
+    
+    logger.debug "\n    #{ step_to_s }#{ ' ' * padding }  ".black_on_yellow
+    
+    self.step_index += 1
+  end
+  
+  private
+  
+  def default_logger
+    Rails.logger
+  end
+  
+  def steps
+    @steps ||= background_steps + scenario.raw_steps
+  end
+  
+  def step
+    steps[step_index]
+  end
+  
+  def background
+    @background ||= scenario.feature.instance_variable_get(:@background)
+  end
+  
+  def background_steps
+    background.nil? ? [] : background.instance_variable_get(:@raw_steps)
+  end
+  
+  def max_length
+    @max_length ||= steps.inject(scenario.name.length) { |max, step|
+      [max, "#{step.keyword} #{step.name}".length].max
+    } + 6
+  end
+end

data/spec/frogger/frog_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+module Rails
+  def self.logger
+    :rails_logger
+  end
+end
+
+describe Frogger::Frog do
+  let(:frog) { Frogger::Frog.new(scenario, custom_logger) }
+  let(:scenario) { double('Scenario', :raw_steps => [step], :name => 'Foo') }
+  let(:custom_logger) { double('Custom Logger', :debug => true) }
+  let(:step) { double('Step', :keyword => 'When', :name => ' something happens') }
+  
+  before :each do
+    scenario.stub_chain(:feature, :instance_variable_get).and_return(nil)
+  end
+  
+  describe '#logger' do
+    it "is the logger passed in when initialised" do
+      frog = Frogger::Frog.new(scenario, custom_logger)
+      frog.logger.should == custom_logger 
+    end
+    
+    it "defaults to the Rails logger" do
+      frog = Frogger::Frog.new(scenario)
+      frog.logger.should == Rails.logger       
+    end
+  end
+  
+  describe '#log_scenario' do
+    it "prints the scenario name in black on green" do
+      custom_logger.should_receive(:debug).with("\n\n  FOO                          ".black_on_green)
+      frog.log_scenario
+    end
+  end
+  
+  describe '#log_step' do
+    it "prints the step name in black on yellow" do
+      custom_logger.should_receive(:debug).with("\n    When something happens     ".black_on_yellow)
+      frog.log_step
+    end
+    
+    it "increments the step index" do
+      step_index = frog.step_index
+      frog.log_step
+      frog.step_index.should == step_index + 1
+    end
+  end
+  
+  describe '#step_index' do
+    it "defaults to 0" do
+      frog.step_index.should == 0
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,3 @@
 $LOAD_PATH << File.join(File.dirname(__FILE__),"..","lib")
-require 'spec'
-require 'frogger'
+require 'rspec'
+require 'frogger'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: frogger
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Richie Khoo
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 Z
+date: 2011-06-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -39,30 +39,18 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 61
         segments: 
         - 0
-        version: "0"
+        - 10
+        - 5
+        version: 0.10.5
   version_requirements: *id002
   name: cucumber
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id003
-  name: shoulda
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -73,12 +61,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  version_requirements: *id004
+  version_requirements: *id003
   name: bundler
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -89,22 +77,24 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
-  version_requirements: *id005
+  version_requirements: *id004
   name: jeweler
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 23
         segments: 
+        - 2
+        - 6
         - 0
-        version: "0"
-  version_requirements: *id006
-  name: rcov
+        version: 2.6.0
+  version_requirements: *id005
+  name: rspec
   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
@@ -114,13 +104,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.textile
 files: 
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - features/enhanced_logger.feature
@@ -129,6 +119,8 @@ files:
 - frogger.gemspec
 - lib/frogger.rb
 - lib/frogger/cucumber.rb
+- lib/frogger/frog.rb
+- spec/frogger/frog_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/evolve2k/frogger
 licenses: 
@@ -164,4 +156,5 @@ signing_key:
 specification_version: 3
 summary: Frogger makes logs easier to navigate.
 test_files: 
+- spec/frogger/frog_spec.rb
 - spec/spec_helper.rb

data/README.rdoc

@@ -1,75 +0,0 @@
-= frogger
-'Hop across the logs'
-
-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.
-
-I thought surely this can be more fun.
-
-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.
-
-== What it does
-
-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
-
-  1. Add this to your Gemfile:
-      gem 'frogger'
-
-  2. Add this to your cucumber env.rb file, below your cucumber requires:
-      require 'frogger/cucumber'
-    
-Windows users:
-  You will need the Win32 Console Ansi gem.  Get it by running this from the command line:
-    gem install win32console
-
-
-== 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.
-
-  Try it on cucumber logs, we've done some fun things there.
-  Eg.
-    $ tail -f /log/cucumber.log
-
-== Who?
-
-  Richie Khoo is a developer from Melbourne, Australia. Don't be shy, you can follow me on twitter via @evolve2k
-
-  Special thanks to: 
-  Keith Pitt(@keithpitt), Pat Allan(@pat), Jared Fraser(@modsognir), Thomas Sinclair(@anathematic), mark_ryal(@markryall), Nathan Sampimon(@nathan_scott)
-  and everyone else at Australian RailsCamp 9 who helped me with the code and understanding the inner workings of cucumber.
-
-== Compatibility
-
-  No known issues
-
-== Contributing to frogger
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add rspec tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Richie Khoo. See LICENSE.txt for
-further details.