cukeregator 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2011 ThoughtWorks, Inc.
+
+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/README.textile

@@ -0,0 +1,50 @@
+h2. Cukeregator
+
+Provides a summary view of multiple "cucumber":https://github.com/aslakhellesoy/cucumber html output files.
+
+h3. Examples
+
+* With the gem installed, from within your project directory:
+
+<pre>
+      $ cukeregator tmp/cucumber*.html > parallel_run_summary.html
+</pre>
+
+This command will aggregate the results of however many output files are matched by the shell glob, and write those results to a document with the same kind of summary as the normal cuke output.  It also lists the summary for each individual results file, and links back to it whenever you want the detail.
+
+* A demo from within your local clone of this git repo:
+
+<pre>
+      $ ./bin/cukeregator fixtures/*.html > cukeregated.html
+</pre>
+
+Summarizes my test files, which are filtered samples from the 0.9.4 Cucumber project's feature suite.
+
+h3. Tests
+
+<pre>
+  $ rake
+</pre>
+
+h3. Installation
+
+<pre>
+  $ gem install cukeregator
+</pre>
+
+h3. Dependencies
+
+@Nokogiri@ is used to parse the cucumber files, as well as to build the summary file.
+
+
+h3. TODO's
+
+* styling
+* handle 'undefined' status explicitly
+
+h3. We'll See
+
+* dump Nokogiri for Haml?  (Would have to hand parse in the reader without Nokogiri.)
+* enable STDIN as source of file list input in the bin?
+* Rake task as cmd line convenince?
+* path list option for cases when a glob won't work?

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+task :default do
+  Rake.application.tasks_in_scope(["cukeregator:test"]).each do |t|
+    t.invoke
+  end
+end
+
+namespace :cukeregator do
+
+  task :readme do
+    require 'redcloth'
+    puts RedCloth.new(File.read("README.textile")).to_html
+  end
+
+  namespace :test do
+    desc "unit specs"
+    RSpec::Core::RakeTask.new(:unit) do |t|
+      t.pattern = "spec/cukeregator/*_spec.rb"
+      t.rspec_opts = ["--color" , "--format" , "doc" ]
+    end
+  end
+
+  RDOC_OPTS = ["--all" , "--quiet" , "--line-numbers" , "--inline-source", 
+    "--main", "README.textile", 
+    "--title", "Cukeregator: many into one"]
+  XTRA_RDOC = %w{README.textile LICENSE }
+
+  Rake::RDocTask.new do |rd|
+    rd.rdoc_dir = "doc/rdoc"
+    rd.rdoc_files.include("**/*.rb")
+    rd.rdoc_files.add(XTRA_RDOC)
+    rd.options = RDOC_OPTS
+  end
+
+  spec = Gem::Specification.new do |s|
+    s.name = 'cukeregator'
+    s.version = '0.1.0'
+    s.rubyforge_project = s.name
+
+    s.platform = Gem::Platform::RUBY
+    s.has_rdoc = true
+    s.extra_rdoc_files = XTRA_RDOC
+    s.rdoc_options += RDOC_OPTS
+    s.summary = "aggregates many cucumber results files into one summary page"
+    s.description = s.summary
+    s.author = "Tim Camper"
+    s.email = 'twcamper@thoughtworks.com'
+    s.homepage = 'http://github.com/twcamper/cukeregator'
+    s.required_ruby_version = '>= 1.8.7'
+    s.add_dependency('nokogiri', '>= 1.4.0')
+    s.default_executable = "cukeregator"
+    s.executables = [s.default_executable]
+
+    s.files =  %w(LICENSE README.textile Rakefile) + 
+      FileList["lib/**/*.{rb,css}", "bin/*"].to_a
+
+    s.require_path = "lib"
+  end
+
+  Rake::GemPackageTask.new(spec) do |p|
+    p.need_zip = true
+    p.need_tar = true
+    p.gem_spec = spec
+  end
+end

data/bin/cukeregator

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path("#{File.dirname(__FILE__)}/../") + '/lib/cukeregator'
+
+puts Cukeregator::HtmlGenerator.new(Cukeregator::Aggregator.new(ARGV)).doc

data/lib/cukeregator/aggregator.rb

@@ -0,0 +1,101 @@
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+module Cukeregator
+  module SummaryFormatter
+    def count(which)
+      total = yield("total_#{which}s".to_sym)
+      "#{total} #{which}#{'s' if total> 1}"
+    end
+    def totals_inner_html(&block)
+      totals = count(:scenario, &block) 
+      totals += status_counts(:scenario, &block)
+      totals += "<br />"
+      totals += count(:step, &block)
+      totals += status_counts(:step, &block)
+    end
+    def status_counts(which)
+      totals = yield("#{which}_totals".to_sym)
+      counts = [:failed, :skipped, :undefined, :pending, :passed].map do |status|
+        "#{totals[status]} #{status}" if totals[status] > 0
+      end.compact
+      " (#{counts.join(', ')})"
+    end
+    def duration_inner_html(s)
+      "Combined Duration <strong>#{s}</strong>"
+    end
+    extend(SummaryFormatter)
+  end
+  class Aggregator
+    include Status
+
+    attr_reader :docs
+
+    def initialize(files)
+      @docs = files.map do |f|
+        HtmlReader.new(File.read(f), f)
+      end
+    end
+
+    def scenario_totals
+      @scenario_totals ||= sum_hash(:scenario_totals)
+    end
+
+    def total_scenarios
+      @total_scenarios ||= sum(:total_scenarios)
+    end
+
+    def totals_inner_html
+      SummaryFormatter.totals_inner_html {|method| self.send(method) }
+    end
+    
+    def duration_inner_html
+      SummaryFormatter.duration_inner_html(duration_string)
+    end
+    def total_steps
+      @total_steps ||= sum(:total_steps)
+    end
+
+    def step_totals
+      @step_totals ||= sum_hash(:step_totals)
+    end
+
+    def duration
+      @duration ||= @docs.inject(0) do |result, doc|
+        result += doc.duration
+        result
+      end
+    end
+
+    def duration_string
+      hours = (duration / 3600).to_i
+      min_sec = duration % 3600
+      minutes = (min_sec / 60).to_i
+      seconds = min_sec % 60
+
+      s = ""
+      s += "#{hours}h" if hours > 0
+      s += "#{minutes}m"
+      s += "#{seconds.to_s[0..5]}s"
+      s
+    end
+
+    private
+
+    def sum(which)
+      docs.inject(0) do |result, doc|
+        result += doc.send(which)
+        result
+      end
+    end
+
+    def sum_hash(which)
+      h = Hash.new(0) 
+      docs.each do |d|
+        d.send(which).each do |key, value|
+          h[key] += value
+        end
+      end
+      h
+    end
+
+  end
+end

data/lib/cukeregator/html_generator.rb

@@ -0,0 +1,97 @@
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+module Cukeregator
+  class HtmlGenerator
+    def initialize(aggregator)
+      @aggregator = aggregator
+      @doc = new_doc
+    end
+
+    def doc
+      @doc.root << head
+      @doc.root << body
+      @doc.to_html
+    end
+
+    def new_doc
+      doc =Nokogiri::XML::Document.new
+      root = Nokogiri::XML::Node.new('html', doc)
+      root.create_internal_subset( 'html', "-//W3C//DTD XHTML 1.0 Strict//EN", "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd")
+      doc << root
+      doc
+    end
+
+    def head
+      h = new_node(:head)
+      title = new_node(:title)
+      title.content = "All Cucumber Results"
+      h << title
+      h << inline_css
+      h
+    end
+
+    def body
+      b = new_node(:body)
+      b << summary
+      b << cucumbers
+      b
+    end
+
+    def summary
+      s = new_node(:div, @aggregator.status)
+      s['id'] = "summary"
+      s << summary_p(@aggregator, 'totals')
+      s << summary_p(@aggregator, 'duration')
+      s
+    end
+
+    def cucumbers
+      c = new_node(:table)
+      c['id'] = "cucumbers"
+      tb = new_node(:tbody)
+      @aggregator.docs.each do |doc_data|
+        tb << row(doc_data)
+      end
+      c << tb
+      c
+    end
+
+    def row(doc_data)
+      tr = new_node(:tr, doc_data.status)
+      td = new_node(:td, 'result-detail')
+      td << link_for(doc_data.path)
+      tr << td
+
+      td = new_node(:td, 'result-summary')
+      td << summary_p(doc_data, 'totals')
+      td << summary_p(doc_data, 'duration')
+      tr << td
+      tr
+    end
+
+    def link_for(path)
+      a  = new_node(:a)
+      a['href'] = path
+      a.content = path
+      a
+    end
+
+    def new_node(name, class_name = nil)
+      n = Nokogiri::XML::Node.new(name.to_s, @doc)
+      n['class'] = class_name.to_s if class_name
+      n
+    end
+
+    def summary_p(o, which)
+      p  = new_node(:p, which)
+      p.inner_html = o.send("#{which}_inner_html")
+      p
+    end
+
+    def inline_css
+      style = new_node(:style)
+      style['type'] = 'text/css'
+      style.content = "\n#{File.read(File.expand_path(File.dirname(__FILE__)) + '/style.css')}"
+      style
+    end
+  end
+end

data/lib/cukeregator/html_reader.rb

@@ -0,0 +1,73 @@
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+module Cukeregator
+
+  class HtmlReader
+    include Status
+
+    attr_reader :totals_inner_html, :total_scenarios, :scenario_totals, :total_steps, :step_totals
+    attr_reader :duration_inner_html, :duration, :path
+
+    def initialize(html, path)
+      @scripts             = parse_scripts(Nokogiri::HTML(html))
+      @path                = path
+      @duration            = parse_duration
+      @total_scenarios, @scenario_totals = parse_totals(:scenario)
+      @total_steps,     @step_totals     = parse_totals(:step)
+    end
+
+    def totals_inner_html
+      @totals_inner_html ||= js_string(:totals)
+    end
+
+    def duration_inner_html
+      @duration_inner_html ||= js_string(:duration)
+    end
+
+    private
+    def parse_totals(which)
+      totals_inner_html =~ /(\d+) #{which}s? \(([^\)]+)/
+      total = $1
+      raise("no total string found for '#{which}'") unless total
+      breakdown = $2
+      raise("no breakdown string found for '#{which}'") unless breakdown
+      return total.to_i, to_hash(breakdown)
+    end
+    
+    def parse_duration
+      time_string = duration_inner_html[/(\d+h)?\d+m\d+\.\d\d\ds/]
+      hours_minutes_seconds = time_string.split(/[hms]/)
+
+      duration = 0.0
+      if hours_minutes_seconds.size == 3
+        duration += hours_minutes_seconds.shift.to_f * 3600.0
+      end
+      duration += hours_minutes_seconds[0].to_f * 60.0
+      duration += hours_minutes_seconds[1].to_f
+      duration
+    end
+
+    def js_string(which)
+      js = @scripts.grep(/#{which}/).to_s
+      js =~ /innerHTML[=\s]+"([^\"]+)/
+      inner_html = $1
+      raise "no innerHTML found for '#{which}' in scripts" unless inner_html
+      inner_html
+    end
+
+    def to_hash(s)
+      result = Hash.new(0)
+      s.split(',').each do | pair|
+        count, name = pair.strip.split(' ')
+        result[name.to_sym] = count.to_i
+      end
+      result
+    end
+
+    # our data lies in javascript functions at the bottom of the body, because
+    # Aslak can't put up the totals until the suite completes
+    def parse_scripts(doc)
+      doc.search("body script").map {|script| script.text }
+    end
+
+  end
+end

data/lib/cukeregator/status.rb

@@ -0,0 +1,11 @@
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+module Cukeregator
+  module Status
+    def status
+      return :failed if scenario_totals[:failed] > 0
+      return :passed if scenario_totals[:passed] > 0
+      return :pending if scenario_totals[:pending] > 0
+      return :undefined
+    end
+  end
+end

data/lib/cukeregator/style.css

@@ -0,0 +1,3 @@
+.passed { background-color: #65C400 }
+.failed { background-color: #C40D0D }
+.pending { background-color: #FAF834 }

data/lib/cukeregator.rb

@@ -0,0 +1,24 @@
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+require 'rubygems'
+require 'nokogiri'
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
+require 'cukeregator/status'
+require 'cukeregator/html_reader'
+require 'cukeregator/aggregator'
+require 'cukeregator/html_generator'
+
+module Cukeregator
+
+  def print(files)
+    files.each do |f|
+      puts File.read f
+    end
+  end
+
+  def docs(files)
+    Aggregator.new(files).docs
+  end
+
+
+  extend(Cukeregator)
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: cukeregator
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tim Camper
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-27 00:00:00 -04:00
+default_executable: cukeregator
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id001
+description: aggregates many cucumber results files into one summary page
+email: twcamper@thoughtworks.com
+executables: 
+- cukeregator
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+- LICENSE
+files: 
+- LICENSE
+- README.textile
+- Rakefile
+- lib/cukeregator/aggregator.rb
+- lib/cukeregator/html_generator.rb
+- lib/cukeregator/html_reader.rb
+- lib/cukeregator/status.rb
+- lib/cukeregator.rb
+- lib/cukeregator/style.css
+- bin/cukeregator
+has_rdoc: true
+homepage: http://github.com/twcamper/cukeregator
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --all
+- --quiet
+- --line-numbers
+- --inline-source
+- --main
+- README.textile
+- --title
+- "Cukeregator: many into one"
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: cukeregator
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: aggregates many cucumber results files into one summary page
+test_files: []
+