knapsack_pro 0.39.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edaac63877b452e0ced9674b15c70e2b6cdd7a23
-  data.tar.gz: 4f3758d26a0de86ce21db7b410a98a59c5d3fe33
+  metadata.gz: 2b643c8be1b319ebbee7eba6e71a1c9006086129
+  data.tar.gz: b75182aa4e028e1192fdaf3562ff77ecef0c38d7
 SHA512:
-  metadata.gz: 0fd7cc1022087c4d508c3ef2d8ec2589626cf724f9689cdc3d9f0bf366b9583145fb901dde61ca9defb67929e00bdbf93931e9b8b516bedd0e74ce9e05e3e62c
-  data.tar.gz: a04c3a24dfebb12475dd2d6aeedb06532df428b831c84eff157bb1187089fd2ef9d8f4d90ea72edf3a008066bde89db3411cd7498e4bfb4a498b6fea26fa36bb
+  metadata.gz: be387a13a2f6e29459ad46a46a8c8ff3d350e50d3ea3b3e6672214d2c00832797e8b3aabae7bca7629fe072573e51f4a5c25440d2c9de9106cefb938482dd229
+  data.tar.gz: 22d8a26c14cb995c3399e3a5ab438d1c08e247f72d88412ad5853df903ded0cfa055fdc582f231b53dacf7f5ae29c6185c78b9e3673f609a28b85ec419f1fba5

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * TODO
 
+### 0.40.0
+
+* Replace rake task installer `knapsack_pro:install` with online installation guide. Remove `tty-prompt` gem dependency.
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/39
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.39.0...v0.40.0
+
 ### 0.39.0
 
 * Remove timecop gem from required dependencies list.

data/README.md

@@ -19,7 +19,7 @@ __Would you like to try knapsack_pro gem?__ You can [get API token here](http://
 
 ## Is knapsack_pro gem free?
 
-* If your __project is open source__ then you can use Knapsack Pro for free. Just add a link back to the page http://knapsackpro.com and please let me know via email (arturtrzop@gmail.com). I will mark your account on KnapsackPro.com as open source.
+* If your __project is open source__ then you can use Knapsack Pro for free. Please let me know via email (arturtrzop@gmail.com) and I will mark your account on KnapsackPro.com as open source.
 
 * If your __project is commercial__ then I'd like to get feedback from you and work closely together to validate if the solution I'm building provide a value for the users. Switching to paid plan is a good way to validate that and a way to get support from happy users. Maybe you will be the next one who will join and support the project. Thanks!
 
@@ -161,9 +161,7 @@ Add this lines at the bottom of `Rakefile` if your project has it:
 KnapsackPro.load_tasks if defined?(KnapsackPro)
 ```
 
-Run installer to get started. It will ask you a few questions and generate instruction steps for your project.
-
-    $ bundle exec rake knapsack_pro:install
+__Please check [online installation guide](http://docs.knapsackpro.com/knapsack_pro-ruby/guide/#questions) to get started.__ It will ask you a few questions and generate instruction steps for your project.
 
 You can read next section only if you want to better understand optional gem configuration and features.
 
@@ -672,7 +670,7 @@ Such configuration will generate matrix with 2 following ENV rows:
     KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=rspec-token KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER=cucumber-token KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST=minitest-token KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH=spinach-token
     KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 KNAPSACK_PRO_TEST_SUITE_TOKEN_RSPEC=rspec-token KNAPSACK_PRO_TEST_SUITE_TOKEN_CUCUMBER=cucumber-token KNAPSACK_PRO_TEST_SUITE_TOKEN_MINITEST=minitest-token KNAPSACK_PRO_TEST_SUITE_TOKEN_SPINACH=spinach-token
 
-More info about global and matrix ENV configuration in [travis docs](http://docs.travis-ci.com/user/build-configuration/#Environment-variables).
+More info about global and matrix ENV configuration in [travis docs](https://docs.travis-ci.com/user/customizing-the-build/#Build-Matrix).
 
 #### Info for semaphoreapp.com users
 

data/knapsack_pro.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'rake', '>= 0'
-  spec.add_dependency 'tty-prompt', '~> 0.7'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rspec', '~> 3.0', '>= 2.0.0'

data/lib/knapsack_pro/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '0.39.0'
+  VERSION = '0.40.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 0.39.0
+  version: 0.40.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-12 00:00:00.000000000 Z
+date: 2017-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: tty-prompt
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -276,7 +262,6 @@ files:
 - lib/tasks/cucumber.rake
 - lib/tasks/encrypted_branch_names.rake
 - lib/tasks/encrypted_test_file_names.rake
-- lib/tasks/install.rake
 - lib/tasks/minitest.rake
 - lib/tasks/queue/rspec.rake
 - lib/tasks/rspec.rake

data/lib/tasks/install.rake

@@ -1,357 +0,0 @@
-require 'knapsack_pro'
-require 'tty-prompt'
-
-def step_for_rspec(prompt)
-  prompt.say "Step for RSpec", color: :yellow
-  prompt.say "Add at the beginning of your spec/spec_helper.rb:"
-
-  prompt.say %{
-require 'knapsack_pro'
-KnapsackPro::Adapters::RSpecAdapter.bind
-  }, color: :cyan
-end
-
-def step_for_minitest(prompt)
-  prompt.say "Step for Minitest", color: :yellow
-  prompt.say "Add at the beginning of your test/test_helper.rb:"
-
-  prompt.say %{
-require 'knapsack_pro'
-knapsack_pro_adapter = KnapsackPro::Adapters::MinitestAdapter.bind
-knapsack_pro_adapter.set_test_helper_path(__FILE__)
-  }, color: :cyan
-end
-
-def step_for_cucumber(prompt)
-  prompt.say "Step for Cucumber", color: :yellow
-  prompt.say "Create file features/support/knapsack_pro.rb and add there:"
-
-  prompt.say %{
-require 'knapsack_pro'
-KnapsackPro::Adapters::CucumberAdapter.bind
-  }, color: :cyan
-end
-
-def step_for_spinach(prompt)
-  prompt.say "Step for Spinach", color: :yellow
-  prompt.say "Create file features/support/knapsack_pro.rb and add there:"
-
-  prompt.say %{
-require 'knapsack_pro'
-KnapsackPro::Adapters::SpinachAdapter.bind
-  }, color: :cyan
-end
-
-def step_for_vcr(prompt)
-  prompt.say "Step for VCR/WebMock/FakeWeb gems", color: :yellow
-  prompt.say "Add Knapsack Pro API subdomain to ignore hosts"
-  prompt.say "in spec/spec_helper.rb or wherever is your VCR configuration:"
-
-  prompt.say %{
-require 'vcr'
-VCR.configure do |config|
-  config.hook_into :webmock # or :fakeweb
-  config.ignore_hosts('localhost', '127.0.0.1', '0.0.0.0', 'api.knapsackpro.com')
-end
-
-# add below when you hook into webmock
-require 'webmock/rspec'
-WebMock.disable_net_connect!(:allow => ['api.knapsackpro.com'])
-
-# add below when you use FakeWeb
-require 'fakeweb'
-FakeWeb.allow_net_connect = %r[^https?://api\.knapsackpro\.com]
-  }, color: :cyan
-
-  puts
-
-  prompt.say "Ensure you have require false in Gemfile for webmock gem when VCR is hook into it. Thanks to that webmock configuration in spec_helper.rb is loaded properly."
-
-  prompt.say %{
-group :test do
-  gem 'vcr'
-  gem 'webmock', require: false
-  gem 'fakeweb', require: false # example when you use fakeweb
-end
-  }, color: :cyan
-end
-
-def step_for_ci_circle(prompt, answers)
-  prompt.say "Step for https://circleci.com", color: :yellow
-  prompt.say "Update circle.yml in your project:"
-
-  str = ''
-  answers[:testing_tools].each do |tool|
-    str << %{
-    # Step for #{tool}
-    - bundle exec rake knapsack_pro:#{tool}:
-        parallel: true # Caution: there are 8 spaces indentation!
-    }
-  end
-
-  prompt.say((%{
-test:
-  override:} + str), color: :cyan)
-
-  puts
-  prompt.say "Please read this section about example for CircleCI 1.0 and CircleCI 2.0 platform:"
-  prompt.say "https://github.com/KnapsackPro/knapsack_pro-ruby#info-for-circleci-users"
-
-  puts
-  set_api_tokens_on_ci(prompt, answers)
-end
-
-def step_for_ci_gitlab(prompt, answers)
-  prompt.say "Step for Gitlab CI https://about.gitlab.com/features/gitlab-ci-cd/", color: :yellow
-  prompt.say "Update .gitlab-ci.yml in your project as in this example:"
-  prompt.say "https://github.com/KnapsackPro/knapsack_pro-ruby#info-for-gitlab-ci-users"
-
-  puts
-  set_api_tokens_on_ci(prompt, answers)
-end
-
-def step_for_ci_travis(prompt, answers)
-  prompt.say "Step for https://travis-ci.org", color: :yellow
-  prompt.say "You can parallelize your builds across virtual machines with travis matrix feature."
-  prompt.say "https://docs.travis-ci.com/user/speeding-up-the-build/#Parallelizing-your-builds-across-virtual-machines"
-  puts
-  prompt.say "Update .travis.yml"
-
-  prompt.say %{
-script:
-  }, color: :cyan
-
-  answers[:testing_tools].each do |tool|
-    prompt.say %{
-  # Step for #{tool}
-  - "bundle exec rake knapsack_pro:#{tool}"
-    }, color: :cyan
-  end
-
-  prompt.say %{
-env:
-  global:
-    - KNAPSACK_PRO_CI_NODE_TOTAL=2
-  }, color: :cyan
-
-  prompt.say %{
-  matrix:
-    - KNAPSACK_PRO_CI_NODE_INDEX=0
-    - KNAPSACK_PRO_CI_NODE_INDEX=1
-  }, color: :cyan
-
-  puts
-  prompt.say "If you want more parallel jobs then update accordingly:"
-  tip_ci_node_total_and_index(prompt)
-
-  puts
-  prompt.say "Open travis settings in web interface to add there Knapsack Pro API token."
-  puts
-  set_api_tokens_on_ci(prompt, answers)
-end
-
-def step_for_ci_buildkite(prompt, answers)
-  prompt.say "Step for https://buildkite.com", color: :yellow
-  prompt.say "Please configure the parallelism parameter in your build step and run the appropiate command in your build:"
-
-  answers[:testing_tools].each do |tool|
-    prompt.say %{
-# Step for #{tool}
-bundle exec rake knapsack_pro:#{tool}
-    }, color: :cyan
-  end
-
-  puts
-  prompt.say "Please read this section about example usage for Rails project with Docker and without it:"
-  prompt.say "https://github.com/KnapsackPro/knapsack_pro-ruby#info-for-buildkitecom-users"
-
-  puts
-  set_api_tokens_on_ci(prompt, answers)
-end
-
-def step_for_ci_semaphore(prompt, answers)
-  prompt.say "Step for https://semaphoreci.com", color: :yellow
-  prompt.say "Set knapsack pro command for each parallel thread. Here is example:"
-
-  answers[:testing_tools].each do |tool|
-    puts
-    prompt.say "Step for #{tool}"
-    prompt.say %{
-# Thread 1
-bundle exec rake knapsack_pro:#{tool}
-
-# Thread 2
-bundle exec rake knapsack_pro:#{tool}
-    }, color: :cyan
-  end
-
-  puts
-  set_api_tokens_on_ci(prompt, answers)
-end
-
-def step_for_ci_snap_ci(prompt, answers)
-  prompt.say "Step for https://snap-ci.com", color: :yellow
-  prompt.say "Please configure number of workers for your project in configuration settings in order to enable parallelism."
-  prompt.say "Next thing is to set below commands to be executed in your stage:"
-
-  answers[:testing_tools].each do |tool|
-    prompt.say %{
-# Step for #{tool}
-bundle exec rake knapsack_pro:#{tool}
-    }, color: :cyan
-  end
-
-  puts
-  set_api_tokens_on_ci(prompt, answers)
-end
-
-def step_for_ci_jenkins(prompt, answers)
-  prompt.say "Step for Jenkins", color: :yellow
-  prompt.say "Please visit page to see example Jenkinsfile:"
-  prompt.say "https://github.com/KnapsackPro/knapsack_pro-ruby#info-for-jenkins-users"
-  puts
-end
-
-def step_for_ci_other(prompt, answers)
-  prompt.say "Step for other CI provider", color: :yellow
-  prompt.say "Set below global variables on your CI server."
-  puts
-
-  prompt.say "Git installed on the CI server will be used to determine branch name and current commit hash."
-
-  prompt.say %{
-KNAPSACK_PRO_REPOSITORY_ADAPTER=git
-  }, color: :cyan
-  puts
-
-prompt.say "Path to the project repository on CI server, for instance:"
-  prompt.say %{
-KNAPSACK_PRO_PROJECT_DIR=/home/ubuntu/my-app-repository
-  }, color: :cyan
-  puts
-
-  prompt.say "You can learn more about those variables here:"
-  prompt.say "https://github.com/KnapsackPro/knapsack_pro-ruby#when-you-set-global-variable-knapsack_pro_repository_adaptergit-required-when-ci-provider-is-not-supported"
-  puts
-
-  set_api_tokens_on_ci(prompt, answers)
-
-  # set test run command on CI server
-  prompt.say "Set test run command on CI server", color: :yellow
-  prompt.say "You must set command responsible for running tests for each CI node."
-  prompt.say "Let's assume you have 2 CI nodes. Here are commands you need to run for each CI node."
-
-  answers[:testing_tools].each do |tool|
-    puts
-    prompt.say "Step for #{tool}"
-    prompt.say %{
-# Command for first CI node
-$ KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 bundle exec rake knapsack_pro:#{tool}
-
-# Command for second CI node
-$ KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 bundle exec rake knapsack_pro:#{tool}
-    }, color: :cyan
-  end
-  puts
-  prompt.say "If you have more CI nodes then update accordingly:"
-  tip_ci_node_total_and_index(prompt)
-  puts
-end
-
-def tip_ci_node_total_and_index(prompt)
-  prompt.say %{
-KNAPSACK_PRO_CI_NODE_TOTAL - total number of your CI nodes
-KNAPSACK_PRO_CI_NODE_INDEX - starts from 0, it's index of each CI node
-  }, color: :cyan
-end
-
-def set_api_tokens_on_ci(prompt, answers)
-  prompt.say "Set API token", color: :yellow
-  prompt.say "You must set different API token on your CI server for each test suite you have:"
-  puts
-
-  str = ''
-  answers[:testing_tools].each do |tool|
-    str << "KNAPSACK_PRO_TEST_SUITE_TOKEN_#{tool.upcase}\n"
-  end
-  prompt.say str, color: :cyan
-
-  prompt.say "You can generate more API tokens after sign in on https://knapsackpro.com"
-  puts
-end
-
-namespace :knapsack_pro do
-  task :install do
-    prompt = TTY::Prompt.new
-    answers = {}
-
-    puts
-    prompt.say "Welcome to knapsack_pro gem installer."
-    puts
-
-    TESTING_TOOLS_CHOICES = {
-      'RSpec' => :rspec,
-      'Minitest' => :minitest,
-      'Cucumber' => :cucumber,
-      'Spinach' => :spinach,
-    }
-    answers[:testing_tools] = []
-    while answers[:testing_tools].empty?
-      answers[:testing_tools] = prompt.multi_select("Choose your testing tools:", TESTING_TOOLS_CHOICES)
-    end
-
-    answers[:has_vcr] = prompt.yes?('Do you use VCR, WebMock or FakeWeb gem?')
-
-    CI_PROVIDER_CHOICES = {
-      'https://circleci.com' => :circle,
-      'https://travis-ci.org' => :travis,
-      'https://buildkite.com' => :buildkite,
-      'https://semaphoreci.com' => :semaphore,
-      'https://snap-ci.com' => :snap_ci,
-      'Gitlab CI' => :gitlab,
-      'Jenkins' => :jenkins,
-      'other' => :other,
-    }
-    answers[:ci] = prompt.select("What is your CI provider?", CI_PROVIDER_CHOICES)
-
-    puts
-
-    # Instructions how to set up the gem
-    puts
-    puts
-    prompt.say "###### Please follow below instructions to finish configuration ######", color: :green
-    puts
-
-    answers[:testing_tools].each do |tool|
-      send("step_for_#{tool}", prompt)
-      puts
-    end
-
-    if answers[:has_vcr]
-      step_for_vcr(prompt)
-      puts
-    end
-
-    send("step_for_ci_#{answers[:ci]}", prompt, answers)
-
-    prompt.say "Final step", color: :yellow
-    prompt.say "Now you are ready to use the gem!"
-    puts
-    prompt.say "Please push a new commit to repository so knapsack_pro gem will record time execution of your test suite."
-    puts
-    prompt.say "Go to user dashboard https://knapsackpro.com/dashboard and click build metrics link next to your API token. Click show link on recent build and ensure the time execution data were recorded for all your CI nodes. You should see info that build subsets were collected."
-    puts
-    prompt.say "Your second test suite run on CI will be parallelized with optimal test suite split if first run was recorded correctly."
-    puts
-    puts
-    prompt.say "Later you may want to learn about Queue Mode and how to enable it:"
-    prompt.say "https://github.com/KnapsackPro/knapsack_pro-ruby#queue-mode"
-    puts
-    puts
-    prompt.say "You can learn more about custom configuration and other features:"
-    prompt.say "https://knapsackpro.com/features"
-    prompt.say "https://github.com/KnapsackPro/knapsack_pro-ruby#table-of-contents"
-    puts
-    prompt.say "###### Please follow above instructions to finish configuration ######", color: :green
-  end
-end