cucumber_statistics 1.0.0

data/spec/cucumber_statistics/renderer_helper_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module CucumberStatistics
+  describe RendererHelper do
+
+    describe '#format' do
+      it 'formats milliseconds' do
+        assert_format(0.000123, '< 0.000s')
+      end
+      it 'formats seconds' do
+        assert_format(3.123456, '3.123s')
+      end
+      it 'formats minutes' do
+        assert_format(60, '1m 0.000s')
+        assert_format(60.12345, '1m 0.123s')
+      end
+      it 'formats hours' do
+        assert_format(3600, '1h 0m 0.000s')
+        assert_format(3600.12345, '1h 0m 0.123s')
+      end
+    end
+
+    def assert_format(duration, expectation)
+      expect(RendererHelper.new.format duration).to eq(expectation)
+    end
+  end
+end

data/spec/cucumber_statistics/renderer_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module CucumberStatistics
+  describe Renderer do
+
+    subject(:step_statistics) { StepStatistics.new }
+    subject(:overall_statistics) { OverallStatistics.new }
+
+    before(:each) do
+      # clean up before start, leave after in case we want to inspect it.
+      Configuration.clean_tmp_dir
+
+      overall_statistics.start_time = Time.now - 35
+      overall_statistics.feature_count_inc
+      overall_statistics.scenario_count_inc
+
+      record 'my step 1', 0.000116
+      record 'my step 1', 9.213553
+      record 'my step 2', 0.000117
+      record 'my step 2', 14.204407
+      record 'my step 3', 0.000131
+      record 'my step 3', 3.48993
+      record 'my step 4', 4.21
+      record 'my step 4', 4.21
+
+      overall_statistics.end_time = Time.now
+      step_statistics.calculate
+    end
+
+
+    describe 'render_step_statistics' do
+      it 'should render content' do
+
+        File.exists?(Configuration.result_step_statistics).should be_false
+
+        absolute_file_name = Renderer.render_step_statistics step_statistics, overall_statistics
+        File.exists?(absolute_file_name).should be_true
+
+        #file = File.open(absolute_file_name, 'rb')
+        #file_contents = file.read
+      end
+    end
+
+    def record(step_name, duration)
+      # fake a source for convenience
+      step_statistics.record step_name, duration, '/Users/kross/alienfast/acme/features/account management/admin_cancel_account.feature:8'
+      overall_statistics.step_count_inc
+    end
+  end
+end

data/spec/cucumber_statistics/step_statistics_spec.rb

@@ -0,0 +1,199 @@
+require 'spec_helper'
+
+module CucumberStatistics
+  describe StepStatistics do
+
+    subject(:step_statistics) { StepStatistics.new }
+    subject(:overall_statistics) { OverallStatistics.new }
+
+    describe 'record' do
+      it 'should create a record' do
+        record "my step", 50
+
+        step_statistics.all.count.should == 1
+        step_statistics.all['my step'][:instances].count.should == 1
+        step_statistics.all['my step'][:instances].first.should == 50
+      end
+
+      it 'should support multiple instances of record' do
+        record "my step", 50
+        record "my step", 75
+
+        step_statistics.all.count.should == 1
+        step_statistics.all['my step'][:instances].count.should == 2
+        step_statistics.all['my step'][:instances].first.should == 50
+        step_statistics.all['my step'][:instances].last.should == 75
+      end
+    end
+
+    describe 'calculate' do
+      before(:each) do
+        record "my step", 25
+        record "my step", 50
+        record "my step", 75
+
+        step_statistics.calculate
+      end
+
+      it 'should calculate the total elapsed time' do
+        step_statistics.all["my step"][:total].should == 150
+      end
+
+      it 'should calculate the number of count' do
+        step_statistics.all["my step"][:count].should == 3
+      end
+
+      it 'should calculate the average time' do
+        step_statistics.all["my step"][:average].should == 50
+      end
+
+      it 'should calculate the fastest step' do
+        step_statistics.all["my step"][:fastest].should == 25
+      end
+      
+      it 'should calculate the slowest step' do
+        step_statistics.all["my step"][:slowest].should == 75
+      end
+
+      it 'should calculate the variation' do
+        step_statistics.all["my step"][:variation].should == 50
+      end
+
+      it 'should calculate the standard deviation' do
+        step_statistics.all["my step"][:standard_deviation].should == 25
+      end
+
+      it 'should calculate the variance' do
+        step_statistics.all["my step"][:variance].should == 625
+      end
+    end
+
+    describe 'all' do
+      before(:each) do
+        record "my step 1", 24
+        record "my step 1", 50
+        record "my step 2", 75
+      end
+
+      it 'should return all records' do
+        step_statistics.all.count.should == 2
+        step_statistics.all.each_with_index do |step_name, data, index|
+          case index
+          when 1
+            step_name.should == "my_step 2"
+          when 2
+            step_name.should == "my_step 1"
+          end
+        end
+      end
+    end
+
+    describe 'set operations' do
+      before(:each) do
+        record "my step 1", 25
+        record "my step 1", 50
+        record "my step 2", 49
+        record "my step 2", 51
+        record "my step 3", 75
+        record "my step 3", 10
+
+        step_statistics.calculate
+      end
+
+      describe 'sort_by_property' do
+        it 'should sort all records by any property' do
+          step_statistics.sort_by_property(:total).first.first.should == "my step 1"
+          step_statistics.sort_by_property(:total).last.first.should == "my step 2"
+
+          step_statistics.sort_by_property(:fastest).first.first.should == "my step 3"
+          step_statistics.sort_by_property(:fastest).last.first.should == "my step 2"
+        end
+      end
+
+      describe 'highest_average' do
+        it 'should return the record with the highest average' do
+          step_statistics.highest_average.first.should == "my step 2"
+        end
+      end
+
+      describe 'highest_elapsed_time' do
+        it 'should return the record with the highest elapsed time' do
+          step_statistics.highest_total.first.should == "my step 2"
+        end
+      end
+
+      describe 'greatest_variation' do
+        it 'should return the record with the greatest variation between slow and fast' do
+          step_statistics.highest_variation.first.should == "my step 3"
+        end
+      end
+
+      describe 'step_part_of_total' do
+        it 'should return the total times of each step from largest to smallest' do
+          step_statistics.step_part_of_total.should == [100.0, 85.0, 75.0]
+        end
+      end
+
+      describe 'total_elapsed_time' do
+        it 'should return the count of all steps' do
+          step_statistics.total_elapsed_time.should == 260
+        end
+      end
+
+      describe 'average_times_plot_data' do
+        it 'should return all the averages sorted by average amount descending' do
+          record "my step 1", 25
+          record "my step 1", 50
+          record "my step 2", 49
+          record "my step 2", 51
+          record "my step 3", 75
+          record "my step 3", 10
+
+          step_statistics.calculate
+          
+          step_statistics.average_times_plot_data.should == [50.0, 42.5, 37.5]
+        end
+      end
+
+      describe 'total_times_plot_data' do
+        it 'should return the total times of each step sorted by average amount descending' do
+          record "my step 1", 25
+          record "my step 1", 50
+          record "my step 3", 75
+          record "my step 3", 10
+
+          step_statistics.calculate
+
+          step_statistics.total_times_plot_data.should == [100.0, 170, 150.0]
+        end
+      end
+    end
+
+    describe 'sample_variance' do
+      it 'should calculate the variance' do
+        step_statistics.sample_variance([1,2,3,4,5,6]).should be_within(0.1).of(3.5)
+        step_statistics.sample_variance([2,4,4,4,5,5,7,9]).should be_within(0.1).of(4.57)
+        step_statistics.sample_variance([25,50,75]).should be_within(0.1).of(625)
+      end
+    end
+
+    describe 'standard_deviation' do
+      it 'should calculate the standard deviation' do
+        sample_variance = step_statistics.sample_variance([1,2,3,4,5,6])
+        step_statistics.standard_deviation(sample_variance).should be_within(0.1).of(1.87)
+        
+        sample_variance = step_statistics.sample_variance([2,4,4,4,5,5,7,9])
+        step_statistics.standard_deviation(sample_variance).should be_within(0.1).of(2.13)
+
+        sample_variance = step_statistics.sample_variance([25,50,75])
+        step_statistics.standard_deviation(sample_variance).should be_within(0.1).of(25)
+      end
+    end
+
+    def record(step_name, duration)
+      # fake a source for convenience
+      step_statistics.record step_name, duration, '/Users/kross/alienfast/acme/features/account management/admin_cancel_account.feature:8'
+      #overall_statistics.step_count_inc
+    end
+  end
+end

data/spec/cucumber_statistics/unused_steps_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module CucumberStatistics
+  describe UnusedSteps do
+    subject do
+      UnusedSteps.new
+    end
+
+    describe 'record' do
+      it 'should create a record' do
+        subject.record "my_step", "some code somewhere"
+        subject.all['my_step'].should == "some code somewhere"
+      end
+    end
+
+    describe 'all' do
+      it 'should return all records sorted alphabetically' do
+        subject.record "my_step 3", "some code somewhere 3"
+        subject.record "my_step 2", "some code somewhere 2"
+        subject.record "my_step 1", "some code somewhere 1"
+
+        subject.all.count.should == 3
+        subject.all.each_with_index do |step_name, where, index|
+          case index
+          when 1
+            step_name.should == "my_step 1"
+            where.should == "some code somewhere 1"
+          when 2
+            step_name.should == "my_step 2"
+            where.should == "some code somewhere 1"
+          when 3
+            step_name.should == "my_step 3"
+            where.should == "some code somewhere 1"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["support/**/*.rb"].each {|f| require f}
+
+require 'cucumber_statistics'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: cucumber_statistics
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kevin Ross
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! '    Want to know what is slowing down your build?
+
+'
+email:
+- kevin.ross@alienfast.com.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cucumber_statistics.gemspec
+- lib/cucumber_statistics.rb
+- lib/cucumber_statistics/autoload.rb
+- lib/cucumber_statistics/configuration.rb
+- lib/cucumber_statistics/formatter.rb
+- lib/cucumber_statistics/overall_statistics.rb
+- lib/cucumber_statistics/renderer.rb
+- lib/cucumber_statistics/renderer_helper.rb
+- lib/cucumber_statistics/step_statistics.rb
+- lib/cucumber_statistics/unused_steps.rb
+- lib/cucumber_statistics/version.rb
+- lib/cucumber_statistics/view/step_statistics.html
+- lib/cucumber_statistics/view/step_statistics.html.haml
+- notes.txt
+- spec/cucumber_statistics/configuration_spec.rb
+- spec/cucumber_statistics/renderer_helper_spec.rb
+- spec/cucumber_statistics/renderer_spec.rb
+- spec/cucumber_statistics/step_statistics_spec.rb
+- spec/cucumber_statistics/unused_steps_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/alienfast/cucumber_statistics
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: An cucumber formatter that will gather statistics and generate a single page
+  showing step time metrics.
+test_files:
+- spec/cucumber_statistics/configuration_spec.rb
+- spec/cucumber_statistics/renderer_helper_spec.rb
+- spec/cucumber_statistics/renderer_spec.rb
+- spec/cucumber_statistics/step_statistics_spec.rb
+- spec/cucumber_statistics/unused_steps_spec.rb
+- spec/spec_helper.rb