knapsack_pro 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91df3d774c26fdede31c284eca7c6f42d131ee06
-  data.tar.gz: 055e753fa5d44ec2b169f0fc25e58fe82bb83b1b
+  metadata.gz: 9ea0d407156f643fed5db989df1a3b7c0d42abf3
+  data.tar.gz: 817cccd4845d5910117e651e24e5a47cbeae9965
 SHA512:
-  metadata.gz: f940e5476c14416b157571136c8a7df7e5c95144b50f095a6a3e19e854d541f87fabaaec4bdf78defd4a48cea96eaa162026e59aa463e5a9a757227d505b459d
-  data.tar.gz: 0da62860473be46822d3ba3bbce637c2b98ff620cd0b0fee463dce414c4fa9c0fdce81c8b1ac25c6e91a495daa43115d931f028e3c6d3413d8c603a475d68a3b
+  metadata.gz: c437b67fa33dcd7d14bfd63608d1e9dd5181ed75de43f1f11439839c9604af943c4592b67ef84eb2ea96aae08c926b588200f38504f34053de072c7665f92ed4
+  data.tar.gz: 3d2fb45f5a0d7ac0ac35cb1100c357f10b09f128c27612b2cfa91b4d0680cd8c662f1779a5af33804a38f9c0e128bf01bb2e58fd312f2df8942d8b0953db45ba

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 * TODO
 
+### 0.6.0
+
+* Add support for Cucumber 2
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.5.0...v0.6.0
+
 ### 0.5.0
 
 * Remove active support dependency so knapsack_pro gem can be used with rails 2.

data/README.md

@@ -14,13 +14,13 @@ The knapsack_pro gem supports:
 * [Minitest](http://docs.seattlerb.org/minitest/)
 * [Turnip](https://github.com/jnicklas/turnip)
 
-__Would you like to try knapsack_pro gem?__ Please fill the [sign up form](https://docs.google.com/forms/d/1S8b5I-W2wr4_8C0tKu9AiW9y_5vq3SW9j2MMUql-hjE/viewform?c=0&w=1&hl=en).
+__Would you like to try knapsack_pro gem?__ You can [get API token here](http://knapsackpro.com).
 
 # How knapsack_pro works?
 
 ## Basics
 
-Basically it will track your branches, commits and on how many CI nodes you are running tests.
+Basically it will track your branches, commits and for how many CI nodes you are running tests.
 Collected data about test time execution will be send to API where test suite split is done.
 Next time when you will run tests you will get proper test files for each CI node in order to achieve comparable time execution on each CI node.
 
@@ -47,19 +47,19 @@ For instance when you will run tests with rake knapsack_pro:rspec then:
 - [Update gem](#update-gem)
 - [Installation](#installation)
 - [How to set up](#how-to-set-up)
-  - [Usage](#usage)
+  - [Usage (How to set up 1 of 3)](#usage-how-to-set-up-1-of-3)
     - [Step for RSpec](#step-for-rspec)
     - [Step for Cucumber](#step-for-cucumber)
     - [Step for Minitest](#step-for-minitest)
     - [Custom configuration](#custom-configuration)
-  - [Setup your CI server](#setup-your-ci-server)
+  - [Setup your CI server (How to set up 2 of 3)](#setup-your-ci-server-how-to-set-up-2-of-3)
     - [Set API key token](#set-api-key-token)
     - [Set knapsack_pro command to execute tests](#set-knapsack_pro-command-to-execute-tests)
+  - [Repository adapter (How to set up 3 of 3)](#repository-adapter-how-to-set-up-3-of-3)
+    - [When you NOT set global variable `KNAPSACK_PRO_REPOSITORY_ADAPTER` (default)](#when-you-not-set-global-variable-knapsack_pro_repository_adapter-default)
+    - [When you set global variable `KNAPSACK_PRO_REPOSITORY_ADAPTER=git` (required when CI provider is not supported)](#when-you-set-global-variable-knapsack_pro_repository_adaptergit-required-when-ci-provider-is-not-supported)
 - [Extra configuration for CI server](#extra-configuration-for-ci-server)
   - [Info about ENV variables](#info-about-env-variables)
-    - [Repository adapter](#repository-adapter)
-      - [When you set global variable `KNAPSACK_PRO_REPOSITORY_ADAPTER=git` (optional)](#when-you-set-global-variable-knapsack_pro_repository_adaptergit-optional)
-      - [When you NOT set global variable `KNAPSACK_PRO_REPOSITORY_ADAPTER` (default)](#when-you-not-set-global-variable-knapsack_pro_repository_adapter-default)
     - [Environment variables for debugging gem](#environment-variables-for-debugging-gem)
   - [Passing arguments to rake task](#passing-arguments-to-rake-task)
     - [Passing arguments to rspec](#passing-arguments-to-rspec)
@@ -103,11 +103,19 @@ Add this line at the bottom of `Rakefile` if your project has it:
 KnapsackPro.load_tasks if defined?(KnapsackPro)
 ```
 
+If you are using [VCR gem](https://github.com/vcr/vcr) then add Knapsack Pro API subdomain to [ignore hosts](https://www.relishapp.com/vcr/vcr/v/2-9-3/docs/configuration/ignore-request):
+
+```ruby
+VCR.configure do |config|
+  config.ignore_hosts 'localhost', '127.0.0.1', '0.0.0.0', 'api.knapsackpro.com'
+end
+```
+
 ## How to set up
 
-### Usage
+### Usage (How to set up 1 of 3)
 
-You can find here example of rails app with already configured knapsack_pro.
+__Tip:__ You can find here example of rails app with already configured knapsack_pro.
 
 https://github.com/KnapsackPro/rails-app-with-knapsack_pro
 
@@ -159,7 +167,7 @@ KnapsackPro.logger = Logger.new(STDOUT)
 KnapsackPro.logger.level = Logger::INFO
 ```
 
-### Setup your CI server
+### Setup your CI server (How to set up 2 of 3)
 
 #### Set API key token
 
@@ -195,34 +203,38 @@ You can add `KNAPSACK_PRO_TEST_FILE_PATTERN` if your tests are not in default di
     # Step for Minitest
     $ KNAPSACK_PRO_TEST_FILE_PATTERN="directory_with_tests/**{,/*/**}/*_test.rb" KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:minitest
 
-__Tip:__ If you are using one of supported CI providers then instead of above steps you should [take a look on this](#supported-ci-providers).
+__Tip:__ If you use one of supported CI providers then instead of above steps you should [take a look on this](#supported-ci-providers).
 
-## Extra configuration for CI server
+__Tip 2:__ If you use one of unsupported CI providers ([here is list of supported CI providers](#supported-ci-providers)) then you should [set KNAPSACK_PRO_REPOSITORY_ADAPTER=git](#when-you-set-global-variable-knapsack_pro_repository_adaptergit-required-when-ci-provider-is-not-supported).
 
-### Info about ENV variables
+### Repository adapter (How to set up 3 of 3)
 
-By default knapsack_pro gem [supports a few CI providers](#supported-ci-providers) so you don't need to set environment variables.
-In case when you use other CI provider for instance [Jenkins](https://jenkins-ci.org) etc then you need to provide configuration via below environment variables.
+#### When you NOT set global variable `KNAPSACK_PRO_REPOSITORY_ADAPTER` (default)
 
-`KNAPSACK_PRO_CI_NODE_TOTAL` - total number CI nodes you have.
+By default `KNAPSACK_PRO_REPOSITORY_ADAPTER` variable has no value so knapsack_pro will try to get info about branch name and commit hash from [supported CI](#supported-ci-providers) (CI providers have branch, commit, project directory stored as environment variables). In case when you use other CI provider like Jenkins then please set below variables on your own.
 
-`KNAPSACK_PRO_CI_NODE_INDEX` - index of current CI node starts from 0. Second CI node should have `KNAPSACK_PRO_CI_NODE_INDEX=1`.
+`KNAPSACK_PRO_BRANCH` - It's branch name. You run tests on this branch.
 
-#### Repository adapter
+`KNAPSACK_PRO_COMMIT_HASH` - Commit hash. You run tests for this commit.
+
+You can also use git as repository adapter to determine branch and commit hash, please see below section.
 
-##### When you set global variable `KNAPSACK_PRO_REPOSITORY_ADAPTER=git` (optional)
+#### When you set global variable `KNAPSACK_PRO_REPOSITORY_ADAPTER=git` (required when CI provider is not supported)
 
 `KNAPSACK_PRO_REPOSITORY_ADAPTER` - When it has value `git` then your local version of git on CI server will be used to get info about branch name and commit hash. You need to set also `KNAPSACK_PRO_PROJECT_DIR` with project directory path.
 
 `KNAPSACK_PRO_PROJECT_DIR` - Path to the project on CI node for instance `/home/ubuntu/my-app-repository`. It should be main directory of your repository.
 
-##### When you NOT set global variable `KNAPSACK_PRO_REPOSITORY_ADAPTER` (default)
+## Extra configuration for CI server
 
-By default `KNAPSACK_PRO_REPOSITORY_ADAPTER` variable has no value so knapsack_pro will try to get info about branch name and commit hash from [supported CI](#supported-ci-providers) (CI providers have branch, commit, project directory stored as environment variables). In case when you use other CI provider like Jenkins then please set below variables on your own.
+### Info about ENV variables
 
-`KNAPSACK_PRO_BRANCH` - It's branch name. You run tests on this branch.
+By default knapsack_pro gem [supports a few CI providers](#supported-ci-providers) so you don't need to set some environment variables.
+In case when you use other CI provider for instance [Jenkins](https://jenkins-ci.org) etc then you need to provide configuration via below environment variables.
 
-`KNAPSACK_PRO_COMMIT_HASH` - Commit hash. You run tests for this commit.
+`KNAPSACK_PRO_CI_NODE_TOTAL` - total number CI nodes you have.
+
+`KNAPSACK_PRO_CI_NODE_INDEX` - index of current CI node starts from 0. Second CI node should have `KNAPSACK_PRO_CI_NODE_INDEX=1`.
 
 #### Environment variables for debugging gem
 

data/lib/knapsack_pro/adapters/cucumber_adapter.rb

@@ -3,17 +3,23 @@ module KnapsackPro
     class CucumberAdapter < BaseAdapter
       TEST_DIR_PATTERN = 'features/**{,/*/**}/*.feature'
 
-      def self.test_path(scenario_or_outline_table)
-        if scenario_or_outline_table.respond_to?(:file)
-          scenario_or_outline_table.file
+      def self.test_path(object)
+        if Cucumber::VERSION.to_i >= 2
+          test_case = object
+          test_case.location.file
         else
-          scenario_or_outline_table.scenario_outline.file
+          scenario_or_outline_table = object
+          if scenario_or_outline_table.respond_to?(:file)
+            scenario_or_outline_table.file
+          else
+            scenario_or_outline_table.scenario_outline.file
+          end
         end
       end
 
       def bind_time_tracker
-        Around do |scenario_or_outline_table, block|
-          KnapsackPro.tracker.current_test_path = KnapsackPro::Adapters::CucumberAdapter.test_path(scenario_or_outline_table)
+        Around do |object, block|
+          KnapsackPro.tracker.current_test_path = KnapsackPro::Adapters::CucumberAdapter.test_path(object)
           KnapsackPro.tracker.start_timer
           block.call
           KnapsackPro.tracker.stop_timer

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/knapsack_pro/adapters/cucumber_adapter_spec.rb

@@ -13,48 +13,91 @@ describe KnapsackPro::Adapters::CucumberAdapter do
   end
 
   describe '.test_path' do
-    subject { described_class.test_path(scenario_or_outline_table) }
+    context 'when Cucumber version 1' do
+      subject { described_class.test_path(scenario_or_outline_table) }
 
-    context 'when scenario' do
-      let(:scenario_file) { 'features/scenario.feature' }
-      let(:scenario_or_outline_table) { double(file: scenario_file) }
+      before { stub_const('Cucumber::VERSION', '1') }
 
-      it { should eql scenario_file }
-    end
+      context 'when scenario' do
+        let(:scenario_file) { 'features/scenario.feature' }
+        let(:scenario_or_outline_table) { double(file: scenario_file) }
 
-    context 'when scenario outline' do
-      let(:scenario_outline_file) { 'features/scenario_outline.feature' }
-      let(:scenario_or_outline_table) do
-        double(scenario_outline: double(file: scenario_outline_file))
+        it { should eql scenario_file }
       end
 
-      it { should eql scenario_outline_file }
+      context 'when scenario outline' do
+        let(:scenario_outline_file) { 'features/scenario_outline.feature' }
+        let(:scenario_or_outline_table) do
+          double(scenario_outline: double(file: scenario_outline_file))
+        end
+
+        it { should eql scenario_outline_file }
+      end
+    end
+
+    context 'when Cucumber version 2' do
+      let(:file) { 'features/a.feature' }
+      let(:test_case) { double(location: double(file: file)) } # Cucumber 2
+
+      subject { described_class.test_path(test_case) }
+
+      before { stub_const('Cucumber::VERSION', '2') }
+
+      it { should eql file }
     end
   end
 
   describe 'bind methods' do
     describe '#bind_time_tracker' do
       let(:file) { 'features/a.feature' }
-      let(:scenario) { double(file: file) }
       let(:block) { double }
       let(:tracker) { instance_double(KnapsackPro::Tracker) }
       let(:logger) { instance_double(Logger) }
       let(:global_time) { 'Global time: 01m 05s' }
 
-      it do
-        expect(subject).to receive(:Around).and_yield(scenario, block)
-        allow(KnapsackPro).to receive(:tracker).and_return(tracker)
-        expect(tracker).to receive(:current_test_path=).with(file)
-        expect(tracker).to receive(:start_timer)
-        expect(block).to receive(:call)
-        expect(tracker).to receive(:stop_timer)
+      context 'when Cucumber version 1' do
+        let(:scenario) { double(file: file) }
 
-        expect(::Kernel).to receive(:at_exit).and_yield
-        expect(KnapsackPro::Presenter).to receive(:global_time).and_return(global_time)
-        expect(KnapsackPro).to receive(:logger).and_return(logger)
-        expect(logger).to receive(:info).with(global_time)
+        before { stub_const('Cucumber::VERSION', '1.3.20') }
+
+        it do
+          expect(subject).to receive(:Around).and_yield(scenario, block)
+          allow(KnapsackPro).to receive(:tracker).and_return(tracker)
+          expect(tracker).to receive(:current_test_path=).with(file)
+          expect(tracker).to receive(:start_timer)
+          expect(block).to receive(:call)
+          expect(tracker).to receive(:stop_timer)
+
+          expect(::Kernel).to receive(:at_exit).and_yield
+          expect(KnapsackPro::Presenter).to receive(:global_time).and_return(global_time)
+          expect(KnapsackPro).to receive(:logger).and_return(logger)
+          expect(logger).to receive(:info).with(global_time)
+
+          subject.bind_time_tracker
+        end
+      end
+
+      context 'when Cucumber version 2' do
+        let(:test_case) { double(location: double(file: file)) }
+
+        # complex version name to ensure we can catch that too
+        before { stub_const('Cucumber::VERSION', '2.0.0.rc.5') }
+
+        it do
+          expect(subject).to receive(:Around).and_yield(test_case, block)
+          allow(KnapsackPro).to receive(:tracker).and_return(tracker)
+          expect(tracker).to receive(:current_test_path=).with(file)
+          expect(tracker).to receive(:start_timer)
+          expect(block).to receive(:call)
+          expect(tracker).to receive(:stop_timer)
+
+          expect(::Kernel).to receive(:at_exit).and_yield
+          expect(KnapsackPro::Presenter).to receive(:global_time).and_return(global_time)
+          expect(KnapsackPro).to receive(:logger).and_return(logger)
+          expect(logger).to receive(:info).with(global_time)
 
-        subject.bind_time_tracker
+          subject.bind_time_tracker
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2016-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake