cucumber_statistics 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWFjYzc0M2VmMzkzOTI2MGZkMzAyNWFjMDM5ODVmOTc2NDRkMWI5Yw==
+  data.tar.gz: !binary |-
+    YjhjZTczMmMwYjEyYTc0Y2M4ZTI4YTZhNDQxMjc5NWJkOGI2Njc0MQ==
+SHA512:
+  metadata.gz: !binary |-
+    NDFkNGUyNjNmZGI2ZjdkZGIyYTI4MTUwOTNhNjBjNmNkY2I0NWY5NjhjODgx
+    NjIyODQ1NzRjNzI3MzE1MTdmNWMzMGU2NWZjMWMwMGUyYjQyY2I0OTBmYTkz
+    MzZjMTQ0YWE2OTRmOGVkNzA1NTIwNzg2MjBkM2Q0ZmNhYzk0YTU=
+  data.tar.gz: !binary |-
+    MjViMTU4NTdjYWVjY2I1MjY1MmNkMzgyODljN2Q0MGQ1ZmJmM2RhY2Y2NWJi
+    Yjc2OTlmZGUwYTViZmMxYjZlN2Y5NGQxNjY1YzYyOWRiNDk5NDhmOWM4Yzc2
+    ZDU1MDFhNjcwODVkNDg3YWRmMGIyZjU5YWE1Y2U0NTk1YTA5Nzk=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.idea

data/.rvmrc

@@ -0,0 +1,3 @@
+rvm use ruby-1.9.3@cucumber_statistics --create
+# CI
+# rvm use ruby-2.0.0@dropinhq-develop --create

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,46 @@
+Copyright (c) 2014 AlienFast, LLC
+
+MIT License
+
+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.
+
+-----------------------------------------------------------------------------------------------------------------------
+Some code originally authored by Ryan Boucher https://github.com/distributedlife/cucumber_timing_presenter
+
+Copyright (c) 2012 Ryan Boucher
+
+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.md

@@ -0,0 +1,44 @@
+# Cucumber Statistics
+
+A cucumber formatter that will gather statistics and generate a single page showing step time metrics.
+
+## Installation
+
+1. Add `gem 'cucumber_statistics'` to your `Gemfile`
+
+2. Or `gem install 'cucumber_statistics`
+
+## Configuration
+
+1. For always-on automatic loading (recommended), add `require 'cucumber_statistics/autoload'` to `features/support/env.rb` or other support file.
+
+2. Or, add it to your `cucumber.yml` by adding `--format CucumberStatistics::Formatter` i.e.
+
+    `std_opts = "-r features/support/ -r features/step_definitions --quiet --format CucumberStatistics::Formatter --format progress --format junit -o test-reports --strict --tags ~@wip --tags ~@todo"`
+
+3. Or, use it via command line with the `--format CucumberStatistics::Formatter` option.
+
+## Results
+
+Look in the `./tmp/cucumber_statistics` for the generated html document.
+
+## Why?
+
+It should be fast and easy to find long running steps.  This generates a bootstrap styled page with a sortable table, where the outliers are clearly identified.  It should be fast and easy to diagnose problems.
+
+## Contributing
+
+Please contribute!
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+Credit to Ryan Boucher [cucumber_timing_presenter](https://github.com/distributedlife/cucumber_timing_presenter) for the original code used to gather statistics.
+
+## Copyright
+
+Copyright (c) 2014 AlienFast. See [LICENSE.txt](https://github.com/alienfast/cucumber_statistics/blob/master/LICENSE.txt) for further details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+# add rspec task
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec
+task :test => :spec

data/cucumber_statistics.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cucumber_statistics/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "cucumber_statistics"
+  spec.version     = CucumberStatistics::VERSION
+  spec.authors     = ["Kevin Ross"]
+  spec.email       = ["kevin.ross@alienfast.com.com"]
+  spec.summary     = <<-TEXT
+    An cucumber formatter that will gather statistics and generate a single page showing step time metrics.
+  TEXT
+  spec.description = <<-TEXT
+    Want to know what is slowing down your build?
+  TEXT
+
+
+  spec.homepage    = "http://github.com/alienfast/cucumber_statistics"
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files`.split($/).reject { |f| f =~ /^samples\// }
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  # development
+  #spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 2.14.1'
+
+  # runtime
+  spec.add_runtime_dependency 'haml'
+  spec.add_runtime_dependency 'tilt'
+  spec.add_runtime_dependency 'cucumber'
+  spec.add_runtime_dependency 'virtus'
+end

data/lib/cucumber_statistics.rb

@@ -0,0 +1,6 @@
+require 'cucumber_statistics/configuration'
+require 'cucumber_statistics/step_statistics'
+require 'cucumber_statistics/overall_statistics'
+require 'cucumber_statistics/unused_steps'
+require 'cucumber_statistics/formatter'
+require 'cucumber_statistics/renderer'

data/lib/cucumber_statistics/autoload.rb

@@ -0,0 +1,3 @@
+AfterConfiguration do |configuration|
+  configuration.options[:formats] << ['CucumberStatistics::Formatter', nil]
+end

data/lib/cucumber_statistics/configuration.rb

@@ -0,0 +1,57 @@
+require 'fileutils'
+
+module CucumberStatistics
+  class Configuration
+
+    class << self
+
+      $tmp_path = 'tmp/cucumber_statistics'
+
+      def clean_tmp_dir
+        FileUtils.rm_r tmp_dir
+      end
+
+      def tmp_dir
+        dir = resolve_path_from_root $tmp_path
+        FileUtils.mkdir_p dir unless File.exists? dir
+
+        dir
+      end
+
+      def tmp_file(filename)
+        "#{tmp_dir}/#{filename}"
+      end
+
+      def result_step_statistics
+        tmp_file('step_statistics.html')
+      end
+
+
+      def resolve_path_from_root(relative_path)
+        if defined?(Rails)
+          Rails.root.join(relative_path)
+        elsif defined?(Rake.original_dir)
+          File.expand_path(relative_path, Rake.original_dir)
+        else
+          File.expand_path(relative_path, Dir.pwd)
+        end
+      end
+      #
+      #def all_usage_results
+      #  File.expand_path('templates/all_usage_results.html', File.dirname(__FILE__))
+      #end
+      #
+      #def unused_steps
+      #  File.expand_path('templates/unused_steps.html', File.dirname(__FILE__))
+      #end
+      #
+      #def step_times_of_whole
+      #  File.expand_path('templates/step_times_of_whole.html', File.dirname(__FILE__))
+      #end
+      #
+      #def step_average_and_total
+      #  File.expand_path('templates/step_average_and_total.html', File.dirname(__FILE__))
+      #end
+    end
+  end
+end

data/lib/cucumber_statistics/formatter.rb

@@ -0,0 +1,68 @@
+module CucumberStatistics
+  class Formatter
+    def initialize(step_mother, io, options)
+      @step_mother = step_mother
+      @io = io
+      @options = options
+
+      @overall_statistics = OverallStatistics.new
+      @step_statistics = StepStatistics.new
+      @unused_steps = UnusedSteps.new
+    end
+
+    #----------------------------------------------------
+    # Step callbacks
+    #----------------------------------------------------
+    def before_step(step)
+      @step_start_time = Time.now
+    end
+
+    def before_step_result(*args)
+      @step_duration = Time.now - @step_start_time
+    end
+
+    def after_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line)
+
+      step_definition = step_match.step_definition
+      unless step_definition.nil? # nil if it's from a scenario outline
+        @step_statistics.record step_definition.regexp_source, @step_duration, file_colon_line
+      end
+    end
+
+
+    #----------------------------------------------------
+    # Overall callbacks
+    #----------------------------------------------------
+    #def before_feature(feature)
+    #end
+    def scenario_name(keyword, name, file_colon_line, source_indent)
+      @overall_statistics.scenario_count_inc
+    end
+
+    def after_step(step)
+      @overall_statistics.step_count_inc
+    end
+
+    def after_feature(feature)
+      @overall_statistics.feature_count_inc
+    end
+
+    def before_features(features)
+      @overall_statistics.start_time = Time.now
+    end
+
+    def after_features(features)
+
+      @overall_statistics.end_time = Time.now
+
+      # gather unused steps
+      @step_mother.unmatched_step_definitions.each do |step_definition|
+        @unused_steps.record step_definition.regexp_source, step_definition.file_colon_line
+      end
+
+      @step_statistics.calculate
+
+      Renderer.render_step_statistics @step_statistics, @overall_statistics
+    end
+  end
+end

data/lib/cucumber_statistics/overall_statistics.rb

@@ -0,0 +1,29 @@
+require 'virtus'
+
+module CucumberStatistics
+  class OverallStatistics
+    include Virtus.model
+
+    attribute :start_time, Time
+    attribute :end_time, Time
+    attribute :feature_count, Integer, default: 0
+    attribute :scenario_count, Integer, default: 0
+    attribute :step_count, Integer, default: 0
+
+    def duration
+      end_time - start_time
+    end
+
+    def feature_count_inc
+      self.feature_count += 1
+    end
+
+    def scenario_count_inc
+      self.scenario_count += 1
+    end
+
+    def step_count_inc
+      self.step_count += 1
+    end
+  end
+end

data/lib/cucumber_statistics/renderer.rb

@@ -0,0 +1,25 @@
+require 'haml'
+require 'tilt/haml'
+require 'cucumber_statistics/renderer_helper'
+
+module CucumberStatistics
+  class Renderer
+
+    class << self
+
+      $renderer_helper ||=
+
+      def render_step_statistics(step_statistics, overall_statistics)
+        template = Tilt::HamlTemplate.new(File.expand_path('../view/step_statistics.html.haml', __FILE__))
+        rendered_content = template.render(RendererHelper.new, step_statistics: step_statistics, overall_statistics: overall_statistics)
+
+        absolute_file_name = Configuration.result_step_statistics
+        File.open(absolute_file_name, 'w') do |f|
+          f.write rendered_content
+        end
+
+        absolute_file_name
+      end
+    end
+  end
+end

data/lib/cucumber_statistics/renderer_helper.rb

@@ -0,0 +1,73 @@
+module CucumberStatistics
+
+  class RendererHelper
+
+    def name_td(step_results)
+      %{<td title="#{step_results[1][:file]}">#{step_results[0]}</td>}
+    end
+
+    def time_td(step_results, metric, *warning_step_results)
+      duration = step_results[1][metric]
+
+      %{<td #{warning_class(step_results, warning_step_results)} data-value="#{duration}">#{format(duration)}</td>}
+    end
+
+    def warning_class(step_results, warning_step_results)
+
+      if warning_step_results.nil? || warning_step_results.empty?
+        should_warn = false
+      else
+        should_warn = (step_results[0].eql? warning_step_results[0][0])
+      end
+      if should_warn
+        %{class="danger"}
+      else
+        ''
+      end
+    end
+
+    def count_td(step_results, metric)
+      value = step_results[1][metric]
+      %{<td data-value="#{value}">#{value}</td>}
+    end
+
+    def format (ts)
+
+      return '-' if ts.nil? || ts == 0
+
+      #find the seconds
+      seconds = ts % 60
+
+      #find the minutes
+      minutes = (ts / 60) % 60
+
+      #find the hours
+      hours = (ts/3600)
+
+      formatted_h = hours.to_i
+      formatted_m = minutes.to_i
+      formatted_s = seconds.to_i
+      formatted_ms = Time.at(seconds).utc.strftime("%3N")
+
+      # http://apidock.com/ruby/DateTime/strftime
+      if hours >= 1
+        #result = Time.at(ts).utc.strftime("%Hh %Mm %S.%3Ns")
+        result = "#{formatted_h}h #{formatted_m}m #{formatted_s}.#{formatted_ms}s"
+      elsif minutes >= 1
+        #result = Time.at(ts).utc.strftime("%Mm %S.%3Ns")
+        result = "#{formatted_m}m #{formatted_s}.#{formatted_ms}s"
+      elsif formatted_ms.to_i == 0 && formatted_s == 0 && formatted_h == 0
+        result = "< #{formatted_s}.#{formatted_ms}s"
+      else
+        #result = Time.at(ts).utc.strftime("%S.%3Ns")
+        result = "#{formatted_s}.#{formatted_ms}s"
+      end
+
+      result
+    end
+
+    def format_date_time (time)
+      time.strftime("%m/%d/%Y at %I:%M%p")
+    end
+  end
+end