knapsack 1.14.1 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17e19f79ce5fe6a536b8138b32a4f1a19336e299
-  data.tar.gz: e31a13218770a3502655c1874388be080fc05128
+  metadata.gz: 88a3472c6e1c45824bd4d8774fedf2fe49346094
+  data.tar.gz: 396262940e1fc174523938abb47274e8aad33e59
 SHA512:
-  metadata.gz: 1ea92ca2ee9e9070cacb6ffbea7c9f009d9ece71df6e3c7ef65a9889297d02c8290c9edbcf9e36c0d043dcf2624eaf31235c05164d3c2bed8cf6a22d676d1202
-  data.tar.gz: 18c51cae4f2f8a27095b09b7d03626ece0739fa77136501f50c217f119acc569d1c7e418efcf1b52640f14ac2dbd665b0b341fc46e14e8a5c5baf3c053f1764a
+  metadata.gz: eb192cc001f8201e14fb2a46811fd06ebb53be23f14b49ec81308bc0f35dccf726b0ad63cc3cbf3f191fc29ff44a56edd96e7694a42569bdcc67d8af479a11ad
+  data.tar.gz: dab3225d6b4833d4edb57880768c5fba4f9f64b59cb4b454b1b9d635759ff66937a42afcd2b8f235427a14a3952bfaee23eeb6aa06a179451e3e0f16e39d9676

data/.travis.yml

@@ -3,12 +3,11 @@ sudo: false
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.5
-  - 2.2.0
   - 2.2.2
   - 2.2.3
   - 2.3.0
   - 2.3.1
+  - 2.4.2
 addons:
   code_climate:
     repo_token: 38686058eed480dd0fcf8bce9015733e0bae88e44e30f4a1ac63df8aec2f86d8

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * TODO
 
+### 1.15.0
+
+* Add support for Cucumber 3.
+
+    https://github.com/ArturT/knapsack/pull/68
+
+https://github.com/ArturT/knapsack/compare/v1.14.1...v1.15.0
+
 ### 1.14.1
 
 * Update RSpec timing adapter to be more resilient.

data/README.md

@@ -12,6 +12,8 @@
 [codeclimate]: https://codeclimate.com/github/ArturT/knapsack
 [coverage]: https://codeclimate.com/github/ArturT/knapsack
 
+Follow us on [Twitter @KnapsackPro](https://twitter.com/KnapsackPro) and give Like on [Facebook KnapsackPro](https://www.facebook.com/KnapsackPro)
+
 **Knapsack splits tests across CI nodes and makes sure that tests will run comparable time on each node.**
 
 Parallel tests across CI server nodes based on each test file's time execution. Knapsack generates a test time execution report and uses it for future test runs.
@@ -24,15 +26,21 @@ The knapsack gem supports:
 * [Spinach](https://github.com/codegram/spinach)
 * [Turnip](https://github.com/jnicklas/turnip)
 
-### Without Knapsack
+### Without Knapsack - bad test suite split
 
 ![Without Knapsack gem](docs/images/without_knapsack.png)
 
-### With Knapsack
+### With Knapsack - better test suite split
 
 ![With Knapsack gem](docs/images/with_knapsack.png)
 
-### Features
+### With Knapsack Pro - optimal test suite split
+
+[Watch 1 minute video how Queue Mode works](https://knapsackpro.com/?utm_source=github&utm_medium=readme&utm_campaign=knapsack_gem&utm_content=video#x-play-how-it-works-video)
+
+[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/pkdLzKlnlQg/0.jpg)](https://knapsackpro.com/?utm_source=github&utm_medium=readme&utm_campaign=knapsack_gem&utm_content=video#x-play-how-it-works-video)
+
+### Features in knapsack vs knapsack_pro
 
 | Feature | knapsack gem | knapsack_pro gem
 | --- | :---: | :---:
@@ -42,10 +50,6 @@ The knapsack gem supports:
 | Test suite split based on most up to date tests time execution data | ✘ | ✔
 | [Show all features](https://knapsackpro.com/features?utm_source=github&utm_medium=readme&utm_campaign=knapsack_gem&utm_content=show_all_features) | |
 
-__Play video how dynamic rspec allocation works__
-
-[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/pkdLzKlnlQg/0.jpg)](https://knapsackpro.com/?utm_source=github&utm_medium=readme&utm_campaign=knapsack_gem&utm_content=video#video)
-
 How knapsack_pro makes my life easier as opposed to regular knapsack gem?
 
 * The knapsack_pro version has queue mode designed for optimal test suite split thanks to dynamic tests allocation.
@@ -53,7 +57,7 @@ How knapsack_pro makes my life easier as opposed to regular knapsack gem?
 * The knapsack_pro version tracks all you branches so when your test code changes the knapsack_pro tries to provide you as optimal test suite split as possible. 
 * When your test codebase changes over time you need to manually generate a new knapsack report in free gem version which is extra overhead and waste of time of the developer.
 
-**Would you like to try [knapsack_pro gem](https://github.com/KnapsackPro/knapsack_pro-ruby) with more features and free access for early users? Please [visit Knapsack Pro](http://knapsackpro.com?utm_source=github&utm_medium=readme&utm_campaign=knapsack_gem&utm_content=try_knapsack_pro).**
+**Only [knapsack_pro gem](https://github.com/KnapsackPro/knapsack_pro-ruby) has Queue Mode feature that saves optimal amount of time? Please [visit Knapsack Pro](http://knapsackpro.com?utm_source=github&utm_medium=readme&utm_campaign=knapsack_gem&utm_content=try_knapsack_pro).**
 
 ### Presentations about knapsack gem
 
@@ -102,6 +106,7 @@ How knapsack_pro makes my life easier as opposed to regular knapsack gem?
   - [What time offset warning means?](#what-time-offset-warning-means)
   - [How to generate knapsack report?](#how-to-generate-knapsack-report)
   - [What does "leftover specs" mean?](#what-does-leftover-specs-mean)
+  - [Why some of test files are still in "leftover specs" after I generate a new report?](#why-some-of-test-files-are-still-in-leftover-specs-after-i-generate-a-new-report)
   - [How can I run tests from multiple directories?](#how-can-i-run-tests-from-multiple-directories)
   - [How to update existing knapsack report for a few test files?](#how-to-update-existing-knapsack-report-for-a-few-test-files)
   - [How to run tests for particular CI node in your development environment](#how-to-run-tests-for-particular-ci-node-in-your-development-environment)
@@ -356,6 +361,7 @@ Here is an example for test configuration in your `circleci.yml` file.
 For the first time run all tests on a single CI node with enabled report generator.
 
 ```yaml
+# CircleCI 1.0
 test:
   override:
     # Step for RSpec
@@ -371,6 +377,37 @@ test:
     - KNAPSACK_GENERATE_REPORT=true bundle exec spinach
 ```
 
+```YAML
+# CircleCI 2.0
+- run:
+  name: Step for RSpec
+  command: |
+    # export word is important here!
+    export KNAPSACK_GENERATE_REPORT=true
+    bundle exec rspec spec
+
+- run:
+  name: Step for Cucumber
+  command: |
+    # export word is important here!
+    export KNAPSACK_GENERATE_REPORT=true
+    bundle exec cucumber features
+
+- run:
+  name: Step for Minitest
+  command: |
+    # export word is important here!
+    export KNAPSACK_GENERATE_REPORT=true
+    bundle exec rake test
+
+- run:
+  name: Step for Spinach
+  command: |
+    # export word is important here!
+    export KNAPSACK_GENERATE_REPORT=true
+    bundle exec rspec spinach
+```
+
 After tests pass on your CircleCI machine your should copy knapsack json report which is rendered at the end of rspec/cucumber/minitest results. Save it into your repository as `knapsack_rspec_report.json`, `knapsack_cucumber_report.json`, `knapsack_minitest_report.json` or `knapsack_spinach_report.json` file and commit.
 
 #### Step 2
@@ -378,6 +415,7 @@ After tests pass on your CircleCI machine your should copy knapsack json report
 Now you should update test command and enable parallel. Please remember to add additional containers for your project in CircleCI settings.
 
 ```yaml
+# CircleCI 1.0
 test:
   override:
     # Step for RSpec
@@ -397,6 +435,25 @@ test:
         parallel: true # Caution: there are 8 spaces indentation!
 ```
 
+```YAML
+# CircleCI 2.0
+- run:
+  name: Step for RSpec
+  command: bundle exec rake knapsack:rspec
+
+- run:
+  name: Step for Cucumber
+  command: bundle exec rake knapsack:cucumber
+
+- run:
+  name: Step for Minitest
+  command: bundle exec rake knapsack:minitest
+
+- run:
+  name: Step for Spinach
+  command: bundle exec rake knapsack:spinach
+```
+
 Now everything should works. You will get warning at the end of rspec/cucumber/minitest results if time execution will take too much.
 
 ### Info for Travis users
@@ -652,6 +709,10 @@ The leftover specs mean we don't have recorded time execution for those test fil
 The reason might be that someone added a new test file after knapsack report was generated. Another reason might be an empty spec file.
 If you have a lot of leftover specs then you can [generate knapsack report again](#how-to-generate-knapsack-report) to improve you test distribution across CI nodes.
 
+### Why some of test files are still in "leftover specs" after I generate a new report?
+
+If test file is empty or has only pending tests then it cannot be recorded so it will end up in leftovers specs list.
+
 ### How can I run tests from multiple directories?
 
 The test file pattern config option supports any glob pattern handled by [`Dir.glob`](http://ruby-doc.org/core-2.2.0/Dir.html#method-c-glob) and can be configured to pull test files from multiple directories. An example of this when using RSpec would be `"{spec,engines/**/spec}/**{,/*/**}/*_spec.rb"`. For complex cases like this, the test directory can't be extracted and must be specified manually using the `KNAPSACK_TEST_DIR` environment variable:

data/lib/knapsack/adapters/cucumber_adapter.rb

@@ -61,7 +61,11 @@ module Knapsack
       private
 
       def Around(*tag_expressions, &proc)
-        ::Cucumber::RbSupport::RbDsl.register_rb_hook('around', tag_expressions, proc)
+        if ::Cucumber::VERSION.to_i >= 3
+          ::Cucumber::Glue::Dsl.register_rb_hook('around', tag_expressions, proc)
+        else
+          ::Cucumber::RbSupport::RbDsl.register_rb_hook('around', tag_expressions, proc)
+        end
       end
     end
   end

data/lib/knapsack/version.rb

@@ -1,3 +1,3 @@
 module Knapsack
-  VERSION = '1.14.1'
+  VERSION = '1.15.0'
 end

data/spec/knapsack/adapters/cucumber_adapter_spec.rb

@@ -1,11 +1,34 @@
 describe Knapsack::Adapters::CucumberAdapter do
   context do
-    before do
-      allow(::Cucumber::RbSupport::RbDsl).to receive(:register_rb_hook)
-      allow(Kernel).to receive(:at_exit)
+    context 'when Cucumber version 1' do
+      before do
+        stub_const('Cucumber::VERSION', '1.3.20')
+        allow(::Cucumber::RbSupport::RbDsl).to receive(:register_rb_hook)
+        allow(Kernel).to receive(:at_exit)
+      end
+
+      it_behaves_like 'adapter'
+    end
+
+    context 'when Cucumber version 2' do
+      before do
+        stub_const('Cucumber::VERSION', '2')
+        allow(::Cucumber::RbSupport::RbDsl).to receive(:register_rb_hook)
+        allow(Kernel).to receive(:at_exit)
+      end
+
+      it_behaves_like 'adapter'
     end
 
-    it_behaves_like 'adapter'
+    context 'when Cucumber version 3' do
+      before do
+        stub_const('Cucumber::VERSION', '3.0.0')
+        allow(::Cucumber::Glue::Dsl).to receive(:register_rb_hook)
+        allow(Kernel).to receive(:at_exit)
+      end
+
+      it_behaves_like 'adapter'
+    end
   end
 
   describe 'bind methods' do

data/spec/support/fakes/cucumber.rb

@@ -1,5 +1,6 @@
-# https://github.com/cucumber/cucumber/blob/master/lib/cucumber/rb_support/rb_dsl.rb
 module Cucumber
+  # Cucumber 1 and 2
+  # https://github.com/cucumber/cucumber-ruby/blob/v2.99.0/lib/cucumber/rb_support/rb_dsl.rb
   module RbSupport
     class RbDsl
       class << self
@@ -9,4 +10,16 @@ module Cucumber
       end
     end
   end
+
+  # Cucumber 3
+  # https://github.com/cucumber/cucumber-ruby/blob/v3.0.0/lib/cucumber/glue/dsl.rb
+  module Glue
+    class Dsl
+      class << self
+        def register_rb_hook(phase, tag_names, proc)
+          proc.call
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 1.15.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-25 00:00:00.000000000 Z
+date: 2017-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -286,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Knapsack splits tests across CI nodes and makes sure that tests will run