timestamped-scenarios 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+example/cuke.html

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in timestamped-scenarios.gemspec
+gemspec

data/README.md

@@ -0,0 +1,23 @@
+What?
+==
+This gem provides custom cucumber formatters which append a test run timestamp to each scenario name as it is generated. a `Timestamped::PrettyFormatter` and `Timestamped::HtmlFormatter` are supplied already, but you can use the `AddsTimestamp` module to dynamically add timestamping to pretty much any Cucumber formatter.
+
+Why?
+==
+My CI system is set up to record a screen capture movie of each test run. I use these timestamps to easily find a specific scenario's behaviour as recorded in the movie.
+
+How?
+==
+Install the gem with 
+      gem install timestamped-scenarios
+and then simply ask cucumber to use the custom formatters with
+      --format 'Timestamped::HtmlFormatter'
+      --format 'Timestamped::PrettyFormatter'
+
+You can also configure cucumber to use the formatters in your rake cucumber task, or by using a cucumber.yml config file. Check out the cucumber.yml file in the example directory to see how this is done.
+
+You can create additional Formatter subclasses as required by using the `Timestamped::AddsTimestamp#formatter_with_timestamped_scenario_names` method.
+
+Credits
+==
+Many thanks to Caleb Clausen for his metaprogramming wizardry, which cleaned up my implementation of `AddsTimestamp` greatly.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/example/cucumber.yml

@@ -0,0 +1 @@
+default: --format 'Timestamped::HtmlFormatter' --out cuke.html --format 'Timestamped::PrettyFormatter' the.feature

data/example/step_definitions/steps.rb

@@ -0,0 +1,4 @@
+Given /^I wait (\d+\.?\d*) seconds$/ do |seconds|
+  seconds = seconds.to_f
+  sleep(seconds)
+end

data/example/the.feature

@@ -0,0 +1,10 @@
+Feature: demonstration
+
+Scenario: The First
+ Given I wait 5 seconds
+
+Scenario: The Second
+ Given I wait 0.7 seconds
+ Given I wait 3 seconds
+
+Scenario: The Third

data/lib/timestamped/adds_timestamp.rb

@@ -0,0 +1,25 @@
+module Timestamped
+  module AddsTimestamp
+
+    # we'll assume that the test run starts around the time this 
+    # file is evaluated. Pretty hacky, and not terribly accurate, but
+    # I think it's good enough
+    TEST_RUN_START = Time.now
+      
+    def self.formatter_with_timestamped_scenario_names(formatter_class)
+      Class.new( formatter_class ){ include AddsTimestamp }
+    end
+
+    def scenario_name(keyword, name, file_colon_line, source_indent)
+      name = append_timestamp_to(name)
+      super( keyword, name, file_colon_line, source_indent )
+    end
+
+
+    def append_timestamp_to( name )
+      ts = Time.now - TEST_RUN_START
+      formatted_timestamp = "%i:%02i" % [ts.to_i/60,(ts%60).round]
+      "#{name} [#{formatted_timestamp}]"
+    end
+  end
+end

data/lib/timestamped/html_formatter.rb

@@ -0,0 +1,7 @@
+require 'timestamped/adds_timestamp'
+
+require 'cucumber/formatter/html'
+module Timestamped
+  HtmlFormatter = AddsTimestamp.formatter_with_timestamped_scenario_names(Cucumber::Formatter::Html)
+end
+

data/lib/timestamped/pretty_formatter.rb

@@ -0,0 +1,7 @@
+require 'timestamped/adds_timestamp'
+
+require 'cucumber/formatter/pretty'
+module Timestamped
+  PrettyFormatter = AddsTimestamp.formatter_with_timestamped_scenario_names(Cucumber::Formatter::Pretty)
+end
+

data/lib/timestamped/version.rb

@@ -0,0 +1,3 @@
+module Timestamped
+  VERSION = "0.1.0"
+end

data/timestamped-scenarios.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "timestamped/version"
+
+Gem::Specification.new do |s|
+  s.name        = "timestamped-scenarios"
+  s.version     = Timestamped::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Pete Hodgson"]
+  s.email       = ["gems@thepete.net"]
+  s.homepage    = "http://rubygems.org/gems/timestamped-scenarios"
+  s.summary     = %q{custom cucumber formatters which append timestamps to each scenario's name as it is executed}
+  s.description = %q{custom cucumber formatters which append timestamps to each scenario's name as it is executed}
+
+  s.add_dependency "cucumber"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: timestamped-scenarios
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pete Hodgson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-20 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: custom cucumber formatters which append timestamps to each scenario's name as it is executed
+email: 
+- gems@thepete.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- example/cucumber.yml
+- example/step_definitions/steps.rb
+- example/the.feature
+- lib/timestamped/adds_timestamp.rb
+- lib/timestamped/html_formatter.rb
+- lib/timestamped/pretty_formatter.rb
+- lib/timestamped/version.rb
+- timestamped-scenarios.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/timestamped-scenarios
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: custom cucumber formatters which append timestamps to each scenario's name as it is executed
+test_files: []
+