cucumber_characteristics 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e3d4f57847772eaa9465192ddef1993fe7b62f0
+  data.tar.gz: fb97cd1268a644a07e4ead5ef5b9dadc1eb5c04c
+SHA512:
+  metadata.gz: 8a9b8c79ecaf93f5eacb57ddc3112e2747d6d7a1f064828bc3881e724a68f7d1d20fe2feb01f9a5b592af994047fcf7f08c2b4d18a6112384e4aca7960db4268
+  data.tar.gz: 779276a2d2c0788f6ec53dc50a4a2e5cd46f8bf37e081e71d0ad8c2c1fcf39a9b455f7c2c498183a64e796f3dcf8b1265a8d8c1e00493bf74ceeee3a5086daf2

data/.gitignore

@@ -15,3 +15,11 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+/cucumber_version/1.3.5/features/characteristics/cucumber_step_characteristics.html
+/cucumber_version/1.3.5/features/characteristics/cucumber_step_characteristics.json
+/cucumber_version/2.3.3/features/characteristics/cucumber_step_characteristics.html
+/cucumber_version/2.3.3/features/characteristics/cucumber_step_characteristics.json
+/cucumber_version/2.1.0/features/characteristics/cucumber_step_characteristics.html
+/cucumber_version/2.1.0/features/characteristics/cucumber_step_characteristics.json
+/cucumber_version/2.2.0/features/characteristics/cucumber_step_characteristics.html
+/cucumber_version/2.2.0/features/characteristics/cucumber_step_characteristics.json

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/LineLength:
+  Max: 207
+
+# Offense count: 9
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/cucumber_characteristics.rb'
+    - 'lib/cucumber_characteristics/configuration.rb'
+    - 'lib/cucumber_characteristics/cucumber_step_patch.rb'
+    - 'lib/cucumber_characteristics/exporter.rb'
+    - 'lib/cucumber_characteristics/formatter.rb'
+    - 'lib/cucumber_characteristics/profile_data.rb'

data/README.md

@@ -2,6 +2,11 @@
 
 Gem to profile cucumber steps and features.
 
+## Compatibility
+
++ (J)Ruby - 1.9.3 -> 2.3.0
++ Cucumber - 1.3.5, 2.1.x+
+
 ## High level features
 
 Step analysis including
@@ -25,18 +30,27 @@ Other features.
 
 ## Installation
 
+### Step 1
+
 Add this line to your application's Gemfile:
 
     gem 'cucumber_characteristics'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
     $ gem install cucumber_characteristics
 
+
+### Step 2
+
+Add the following line to your cucumber environment file typically found at `features\support\env.rb`
+
+    require 'cucumber_characteristics/autoload'
+
 ## Usage
 
 1. For always-on automatic loading (recommended), add `require 'cucumber_characteristics/autoload'` to `features/support/yourapp_env.rb`.  It is recommended by cucumber that you do not enhance features/support/env.rb so that upgrades are painless (relatively)
@@ -59,6 +73,8 @@ You can configure the export of step characteristics via the following (defaults
       config.relative_path =  'features/characteristics'
     end
 
+This again can be added to your cucumber environment file typically found at `features\support\env.rb`
+
 ## Results
 
 Exported characteristic information is listed out at the end of the cucumber run in a message similar to
@@ -70,7 +86,7 @@ depending on the options specified.
 
 The JSON option is provided for convenience in case there is a further use case/analysis required that is not provided by the gem.
 
-An example can be found [here](features/characteristics/cucumber_step_characteristics.html)
+An example can be found [here](features/characteristics/cucumber_step_characteristics.json)
 
 ## Problem
 
@@ -108,15 +124,35 @@ Possible solutions
 
 As it turns out it was pretty simple to enhance the runtime object to reliably return profile information.
 
+## Developement
+
+1. Install development environment
+
+    `bundle install`
+
+2. Run formatter over default cucumber version
+
+    `bundle exec cucumber`
+
+3. Run tests across all supported cucumber versions
+
+    `bundle exec rake versions:bundle:install`
+
+    `bundle exec rake versions:test`
+
+* NOTE.  When running the cucumber tests failures, pending etc are expected.  All specs should pass *
+
+
 ## Contributing
 
 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
+5. Create new Pull Request (after running tests!)
 
 ## Credits
 1. Ryan Boucher [cucumber_timing_presenter](https://github.com/distributedlife/cucumber_timing_presenter) for inspiration.
 2. AlienFast [cucumber_statistics](https://github.com/alienfast/cucumber_statistics) for inspriation.
 3. [Brandon Hilker](http://brandonhilkert.com/blog/ruby-gem-configuration-patterns/) for gem building tutorials
+4. Nathan Menge for helping QA the ruby 2.3.0 / cucumber 2.3.0 updates

data/Rakefile

@@ -1 +1,45 @@
-require "bundler/gem_tasks"
+require 'rake'
+require 'bundler/gem_tasks'
+
+# Approach to version testing credited to
+#   https://github.com/makandra/cucumber_factory
+
+namespace :versions do
+  namespace :bundle do
+    desc 'Bundle all spec apps'
+    task :install do
+      for_each_directory_of('./cucumber_version/**/Gemfile') do |directory|
+        Bundler.with_clean_env do
+          system("cd #{directory} && bundle install")
+        end
+      end
+    end
+  end
+
+  desc 'Test all supported cucumber versions'
+  task :test do
+    for_each_directory_of('./cucumber_version/**/Gemfile') do |directory|
+      Bundler.with_clean_env do
+        clean_outputs(directory)
+        system("cd #{directory} && bundle exec cucumber --color --format progress -g -r ../../features/ ../../features/")
+        system("bundle exec rspec -r #{directory}/output_path.rb ")
+      end
+    end
+  end
+end
+
+def clean_outputs(dir)
+  ["#{dir}/features/characteristics/cucumber_step_characteristics.json",
+   "#{dir}/features/characteristics/cucumber_step_characteristics.html"
+  ].each do |file|
+    File.delete(file) if File.exist?(file)
+  end
+end
+
+def for_each_directory_of(path)
+  Dir[path].sort.each do |rakefile|
+    directory = File.dirname(rakefile)
+    puts '', "\033[44m#{directory}\033[0m", ''
+    yield(directory)
+  end
+end

data/cucumber_characteristics.gemspec

@@ -4,26 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cucumber_characteristics/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "cucumber_characteristics"
+  spec.name          = 'cucumber_characteristics'
   spec.version       = CucumberCharacteristics::VERSION
-  spec.authors       = ["Stuart Ingram"]
-  spec.email         = ["stuart.ingram@gmail.com"]
-  spec.description   = %q{Gem to profile cucumber steps and features}
-  spec.summary       = %q{Gem to profile cucumber steps and features}
-  spec.homepage      = "https://github.com/singram/cucumber_characteristics"
-  spec.license       = "MIT"
+  spec.authors       = ['Stuart Ingram']
+  spec.email         = ['stuart.ingram@gmail.com']
+  spec.description   = 'Gem to profile cucumber steps and features'
+  spec.summary       = 'Gem to profile cucumber steps and features'
+  spec.homepage      = 'https://github.com/singram/cucumber_characteristics'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   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"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "haml"
+  spec.add_dependency 'cucumber', '>=1.3.5'
+  spec.add_dependency 'haml'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "awesome_print"
-  spec.add_development_dependency 'simplecov',   '0.8.2'
-  spec.add_development_dependency 'rspec',       '2.14'
-  spec.add_development_dependency 'cucumber',       '1.3.5'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'nokogiri'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
 end

data/cucumber_version/1.3.5/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'cucumber', '1.3.5'
+gem 'cucumber_characteristics', path: '../..'

data/cucumber_version/1.3.5/output_path.rb

@@ -0,0 +1 @@
+CHARACTERISTICS_OUTPUT_PATH_PREFIX = File.dirname(__FILE__)

data/cucumber_version/2.0.2/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'cucumber', '2.0.2'
+gem 'cucumber_characteristics', path: '../..'

data/cucumber_version/2.0.2/output_path.rb

@@ -0,0 +1 @@
+CHARACTERISTICS_OUTPUT_PATH_PREFIX = File.dirname(__FILE__)

data/cucumber_version/2.1.0/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'cucumber', '2.1.0'
+gem 'cucumber_characteristics', path: '../..'

data/cucumber_version/2.1.0/output_path.rb

@@ -0,0 +1 @@
+CHARACTERISTICS_OUTPUT_PATH_PREFIX = File.dirname(__FILE__)

data/cucumber_version/2.2.0/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'cucumber', '2.2.0'
+gem 'cucumber_characteristics', path: '../..'

data/cucumber_version/2.2.0/output_path.rb

@@ -0,0 +1 @@
+CHARACTERISTICS_OUTPUT_PATH_PREFIX = File.dirname(__FILE__)

data/cucumber_version/2.3.3/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'cucumber', '2.3.3'
+gem 'cucumber_characteristics', path: '../..'

data/cucumber_version/2.3.3/output_path.rb

@@ -0,0 +1 @@
+CHARACTERISTICS_OUTPUT_PATH_PREFIX = File.dirname(__FILE__)

data/features/characteristics/cucumber_step_characteristics.html

@@ -39,18 +39,19 @@
       </div>
       <div class='alert alert-info'>
         <span>
-          2 Scenarios,
-          8 Steps completed
+          10 Scenarios,
+          36 Steps completed
           <span class='text-muted'>
-            (Passed: 8)<br>
+            (Failed: 2, Passed: 31, Skipped: 2, Undefined: 1)<br>
           </span>
-          Test duration 1.6180s.
+          1/2 failures due to ambiguous matches<br>
+          Test duration 12.5340s.
           <span class='text-muted'>
-            (1.6146s steps, 0.0034s non-steps)
+            (11.9450s steps, 0.5890s non-steps)
           </span>
         </span>
         <span class='text-muted pull-right small'>
-          Finished on 2014-06-26 07:05:36 -0400
+          Finished on 2016-04-10 22:28:08 -0400
         </span>
       </div>
       <ul class='nav nav-tabs'>
@@ -61,7 +62,7 @@
           <a data-toggle='tab' href='#features'>Features</a>
         </li>
         <li>
-          <a data-toggle='tab' href='#unused_steps'>Unused Steps (3)</a>
+          <a data-toggle='tab' href='#unused_steps'>Unused Steps (1)</a>
         </li>
       </ul>
       <div class='tab-content'>
@@ -85,30 +86,80 @@
               </tr>
             </thead>
             <tbody>
-              <tr>
-                <td>
+              <tr class='step_result'>
+                <td class='step'>
                   <abbr title='/^I wait ([\d\.]+) seconds$/'>features/step_definitions/wait_steps.rb:1</abbr>
                 </td>
-                <td>1.6146</td>
-                <td>
-                  <abbr title='features/scenario_outline.feature:4 (x2)&#x000A;features/scenario_outline.feature:5 (x2)&#x000A;features/scenario_outline.feature:6 (x2)&#x000A;features/scenario_outline.feature:7 (x2)'>8</abbr>
-                </td>
-                <td>0.2018</td>
-                <td>0.1024</td>
-                <td>0.3006</td>
-                <td>0.1982</td>
-                <td>0.0049</td>
-                <td>0.0701</td>
-                <td>
+                <td class='total_time'>11.9450</td>
+                <td class='passed_count'>
+                  <abbr title='features/failure.feature:4&#x000A;features/pending.feature:4&#x000A;features/scenario.feature:4&#x000A;features/scenario.feature:5&#x000A;features/scenario.feature:6&#x000A;features/scenario_outline.feature:4 (x2)&#x000A;features/scenario_outline.feature:5 (x2)&#x000A;features/scenario_outline.feature:6 (x2)&#x000A;features/scenario_outline.feature:7 (x2)&#x000A;features/scenario_outline_with_background.feature:4 (x2)&#x000A;features/scenario_outline_with_background.feature:7 (x2)&#x000A;features/scenario_outline_with_background.feature:8 (x2)&#x000A;features/scenario_outline_with_background.feature:9 (x2)&#x000A;features/scenario_outline_with_background.feature:10 (x2)&#x000A;features/scenario_with_background.feature:4 (x2)&#x000A;features/scenario_with_background.feature:7&#x000A;features/scenario_with_background.feature:8&#x000A;features/scenario_with_background.feature:9&#x000A;features/scenario_with_background.feature:12&#x000A;features/scenario_with_background.feature:13&#x000A;features/scenario_with_background.feature:14'>31</abbr>
+                </td>
+                <td class='average_time'>0.3853</td>
+                <td class='fastest_time'>0.1010</td>
+                <td class='slowest_time'>1.0020</td>
+                <td class='variation_time'>0.9010</td>
+                <td class='variance_time'>0.0563</td>
+                <td class='std_dev_time'>0.2372</td>
+                <td class='skipped_count'>
+                  <abbr title='features/failure.feature:6&#x000A;features/pending.feature:6'>2</abbr>
+                </td>
+                <td class='failed_count'>
+                  0
+                </td>
+                <td class='undef_count'>
+                  0
+                </td>
+                <td class='total_count'>33</td>
+              </tr>
+              <tr class='step_result'>
+                <td class='step'>
+                  <abbr title=''>I call a pending step</abbr>
+                </td>
+                <td class='total_time'>-</td>
+                <td class='passed_count'>
+                  0
+                </td>
+                <td class='average_time'>-</td>
+                <td class='fastest_time'>-</td>
+                <td class='slowest_time'>-</td>
+                <td class='variation_time'>-</td>
+                <td class='variance_time'>-</td>
+                <td class='std_dev_time'>-</td>
+                <td class='skipped_count'>
+                  0
+                </td>
+                <td class='failed_count'>
+                  0
+                </td>
+                <td class='undef_count'>
+                  <abbr title='features/pending.feature:5'>1</abbr>
+                </td>
+                <td class='total_count'>1</td>
+              </tr>
+              <tr class='step_result'>
+                <td class='step'>
+                  <abbr title='/^I fail$/'>features/step_definitions/fail_steps.rb:1</abbr>
+                </td>
+                <td class='total_time'>-</td>
+                <td class='passed_count'>
                   0
                 </td>
-                <td>
+                <td class='average_time'>-</td>
+                <td class='fastest_time'>-</td>
+                <td class='slowest_time'>-</td>
+                <td class='variation_time'>-</td>
+                <td class='variance_time'>-</td>
+                <td class='std_dev_time'>-</td>
+                <td class='skipped_count'>
                   0
                 </td>
-                <td>
+                <td class='failed_count'>
+                  <abbr title='features/failure.feature:5'>1</abbr>
+                </td>
+                <td class='undef_count'>
                   0
                 </td>
-                <td>8</td>
+                <td class='total_count'>1</td>
               </tr>
             </tbody>
           </table>
@@ -125,19 +176,126 @@
               </tr>
             </thead>
             <tbody>
-              <tr class=''>
-                <td>features/scenario_outline.feature:3</td>
-                <td>1.6146</td>
-                <td>8</td>
-                <td>passed</td>
-                <td>
+              <tr class='danger feature_result'>
+                <td class='feature'>features/failure.feature:3</td>
+                <td class='total_time'>1.0020</td>
+                <td class='step_count'>3</td>
+                <td class='status'>failed</td>
+                <td class='examples'>
+                </td>
+              </tr>
+              <tr class='danger feature_result'>
+                <td class='feature'>features/ambiguous.feature:3</td>
+                <td class='total_time'>-</td>
+                <td class='step_count'>1</td>
+                <td class='status'>failed</td>
+                <td class='examples'>
+                </td>
+              </tr>
+              <tr class='feature_result warning'>
+                <td class='feature'>features/pending.feature:3</td>
+                <td class='total_time'>1.0020</td>
+                <td class='step_count'>3</td>
+                <td class='status'>undefined</td>
+                <td class='examples'>
+                </td>
+              </tr>
+              <tr class='feature_result'>
+                <td class='feature'>features/scenario_outline_with_background.feature:6</td>
+                <td class='total_time'>3.6130</td>
+                <td class='step_count'>10</td>
+                <td class='status'>passed</td>
+                <td class='examples'>
+                  <button class='btn btn-primary' data-target='#ee4ab50980effe45ea18c9afc38e97e5' data-toggle='modal'>
+                    2 Examples
+                  </button>
+                </td>
+              </tr>
+              <tr class='feature_result'>
+                <td class='feature'>features/scenario_with_background.feature:11</td>
+                <td class='total_time'>2.2050</td>
+                <td class='step_count'>4</td>
+                <td class='status'>passed</td>
+                <td class='examples'>
+                </td>
+              </tr>
+              <tr class='feature_result'>
+                <td class='feature'>features/scenario_outline.feature:3</td>
+                <td class='total_time'>1.6120</td>
+                <td class='step_count'>8</td>
+                <td class='status'>passed</td>
+                <td class='examples'>
                   <button class='btn btn-primary' data-target='#76f61671f111ebbc40b80f6aa9f5f838' data-toggle='modal'>
                     2 Examples
                   </button>
                 </td>
               </tr>
+              <tr class='feature_result'>
+                <td class='feature'>features/scenario.feature:3</td>
+                <td class='total_time'>1.5030</td>
+                <td class='step_count'>3</td>
+                <td class='status'>passed</td>
+                <td class='examples'>
+                </td>
+              </tr>
+              <tr class='feature_result'>
+                <td class='feature'>features/scenario_with_background.feature:6</td>
+                <td class='total_time'>1.0080</td>
+                <td class='step_count'>4</td>
+                <td class='status'>passed</td>
+                <td class='examples'>
+                </td>
+              </tr>
             </tbody>
           </table>
+          <div aria-hidden='true' aria-labelledby='myLargeModalLabel' class='modal fade bs-example-modal-lg' id='ee4ab50980effe45ea18c9afc38e97e5' role='dialog' tabindex='-1'>
+            <div class='modal-dialog modal-lg'>
+              <div class='modal-content'>
+                <div class='modal-header'>
+                  <h4>features/scenario_outline_with_background.feature:6</h4>
+                </div>
+                <div class='modal-body'>
+                  <table class='table table-striped table-bordered table-condensed' id='scenario_outline_with_background_feature_6'>
+                    <thead>
+                      <tr>
+                        <th>Example</th>
+                        <th>Total time</th>
+                        <th>Step count</th>
+                        <th>Status</th>
+                      </tr>
+                    </thead>
+                    <tbody>
+                      <tr class='example_result'>
+                        <td class='example'>| 0.5 | 0.6 | 0.7 |</td>
+                        <td class='total_time'>2.4050</td>
+                        <td class='step_count'>5</td>
+                        <td class='status'>passed</td>
+                      </tr>
+                      <tr class='example_result'>
+                        <td class='example'>| 0.1 | 0.2 | 0.3 |</td>
+                        <td class='total_time'>1.2080</td>
+                        <td class='step_count'>5</td>
+                        <td class='status'>passed</td>
+                      </tr>
+                    </tbody>
+                    <tfooter>
+                      <tr class='example_totals'>
+                        <th></th>
+                        <th class='total_time'>3.6130</th>
+                        <th class='step_count'>10</th>
+                        <th class='status'>passed</th>
+                      </tr>
+                    </tfooter>
+                  </table>
+                </div>
+                <div class='modal-footer'>
+                  <button class='btn btn-default' data-dismiss='modal' type='button'>
+                    Close
+                  </button>
+                </div>
+              </div>
+            </div>
+          </div>
           <div aria-hidden='true' aria-labelledby='myLargeModalLabel' class='modal fade bs-example-modal-lg' id='76f61671f111ebbc40b80f6aa9f5f838' role='dialog' tabindex='-1'>
             <div class='modal-dialog modal-lg'>
               <div class='modal-content'>
@@ -145,7 +303,7 @@
                   <h4>features/scenario_outline.feature:3</h4>
                 </div>
                 <div class='modal-body'>
-                  <table class='table table-striped table-bordered table-condensed'>
+                  <table class='table table-striped table-bordered table-condensed' id='scenario_outline_feature_3'>
                     <thead>
                       <tr>
                         <th>Example</th>
@@ -155,25 +313,25 @@
                       </tr>
                     </thead>
                     <tbody>
-                      <tr class=''>
-                        <td>| 0.3 | 0.2 | 0.1 |</td>
-                        <td>0.8073</td>
-                        <td>4</td>
-                        <td>passed</td>
+                      <tr class='example_result'>
+                        <td class='example'>| 0.3 | 0.2 | 0.1 |</td>
+                        <td class='total_time'>0.8060</td>
+                        <td class='step_count'>4</td>
+                        <td class='status'>passed</td>
                       </tr>
-                      <tr class=''>
-                        <td>| 0.1 | 0.2 | 0.3 |</td>
-                        <td>0.8073</td>
-                        <td>4</td>
-                        <td>passed</td>
+                      <tr class='example_result'>
+                        <td class='example'>| 0.1 | 0.2 | 0.3 |</td>
+                        <td class='total_time'>0.8060</td>
+                        <td class='step_count'>4</td>
+                        <td class='status'>passed</td>
                       </tr>
                     </tbody>
                     <tfooter>
-                      <tr>
+                      <tr class='example_totals'>
                         <th></th>
-                        <th>1.6146</th>
-                        <th>8</th>
-                        <th>passed</th>
+                        <th class='total_time'>1.6120</th>
+                        <th class='step_count'>8</th>
+                        <th class='status'>passed</th>
                       </tr>
                     </tfooter>
                   </table>
@@ -197,16 +355,8 @@
             </thead>
             <tbody>
               <tr>
-                <td>features/step_definitions/ambiguous_steps.rb:1</td>
-                <td>/^I wait some/</td>
-              </tr>
-              <tr>
-                <td>features/step_definitions/ambiguous_steps.rb:4</td>
-                <td>/^I wait some seconds$/</td>
-              </tr>
-              <tr>
-                <td>features/step_definitions/fail_steps.rb:1</td>
-                <td>/^I fail$/</td>
+                <td>features/step_definitions/unused_steps.rb:1</td>
+                <td>/^I am unused/</td>
               </tr>
             </tbody>
           </table>