knapsack_pro 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a406890fbfce1279d3666a454506cdcbd6304056
-  data.tar.gz: 1f6a678e6b2d02275961acacef5d30aa77fa2faf
+  metadata.gz: 331541f2ecd345ac6c68562799b8b00d774a82ee
+  data.tar.gz: 6f2c4dc59a7283f77351fd640dc2632c57db07e1
 SHA512:
-  metadata.gz: 641c3902159b91e7df6beba94c3f857620f36bce4e54e24f33c23844359eef8aae98235293c23acb4b7ac2bcf6509629f12e38530ae55d4a24457c6d96f30ee1
-  data.tar.gz: 5362880512e95bc8f559db2c42d517c5eb011fe0861db353cafee5b55094386b9fdd69529b7dcb3cf8b1d1286d337e2b63f990fcae02022fcd2e1ea01acb5e4f
+  metadata.gz: ceaace21c1274a31e97c0ce6e6d7addb1c99b834242c45dc558f783845b03dc1720eabcf2b1d36325da61f8f96955b35574fd64d64453e5cde9e1b5d131aee59
+  data.tar.gz: b966ee4bb2bc7f7938bbaec8a4db8e850618645177ed36e88fcac5430d11be66eaacf26037955601ff03cac61235ddb5126d22b024a361640c0e28d02dc3f9cc

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 * TODO
 
+### 0.13.0
+
+* Add installer to get started with the knapsack_pro gem.
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v0.12.0...v0.13.0
+
 ### 0.12.0
 
 * Add support for Minitest::SharedExamples

data/README.md

@@ -15,7 +15,7 @@ The knapsack_pro gem supports:
 * [Spinach](https://github.com/codegram/spinach)
 * [Turnip](https://github.com/jnicklas/turnip)
 
-__Would you like to try knapsack_pro gem?__ You can [get API token here](http://knapsackpro.com).
+__Would you like to try knapsack_pro gem?__ You can [get API token here](http://knapsackpro.com?utm_source=github&utm_medium=readme&utm_campaign=knapsack_pro-ruby_gem&utm_content=get_api_token).
 
 ## Is knapsack_pro gem free?
 
@@ -109,7 +109,7 @@ end
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 
 Add this lines at the bottom of `Rakefile` if your project has it:
@@ -118,6 +118,14 @@ 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
+
+You can read next section only if you want to better understand optional gem configuration and features.
+
+## How to set up
+
 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
@@ -130,8 +138,6 @@ end
 WebMock.disable_net_connect!(:allow => 'api.knapsackpro.com') if defined?(WebMock)
 ```
 
-## How to set up
-
 ### Usage (How to set up 1 of 3)
 
 __Tip:__ You can find here example of rails app with already configured knapsack_pro.
@@ -184,7 +190,7 @@ require 'knapsack_pro'
 
 # CUSTOM_CONFIG_GOES_HERE
 
-KnapsackPro::Adapters::CucumberAdapter.bind
+KnapsackPro::Adapters::SpinachAdapter.bind
 ```
 
 #### Custom configuration
@@ -427,7 +433,7 @@ Please remember to add additional containers for your project in CircleCI settin
 
 #### Info for Travis users
 
-You can parallel your builds across virtual machines with [travis matrix feature](http://docs.travis-ci.com/user/speeding-up-the-build/#Parallelizing-your-builds-across-virtual-machines). Edit `.travis.yml`
+You can parallelize your builds across virtual machines with [travis matrix feature](http://docs.travis-ci.com/user/speeding-up-the-build/#Parallelizing-your-builds-across-virtual-machines). Edit `.travis.yml`
 
 ```yaml
 script:
@@ -554,7 +560,7 @@ To run specs for Knapsack Pro gem type:
 
 ## Contributing
 
-1. Fork it ( https://github.com/ArturT/knapsack/fork )
+1. Fork it ( https://github.com/KnapsackPro/knapsack_pro-ruby )
 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`)

data/knapsack_pro.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rake', '>= 0'
   spec.add_dependency 'timecop', '>= 0.1.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.12.0'
+  VERSION = '0.13.0'
 end

data/lib/tasks/install.rake

@@ -0,0 +1,302 @@
+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 gem", 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 %{
+VCR.configure do |config|
+  config.ignore_hosts 'localhost', '127.0.0.1', '0.0.0.0', 'api.knapsackpro.com'
+end
+
+WebMock.disable_net_connect!(:allow => 'api.knapsackpro.com') if defined?(WebMock)
+  }, 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
+  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
+  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_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 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,
+      '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 "Now you are ready to use the gem!"
+    prompt.say "Please push a new commit to repository so knapsack_pro gem will record time execution of your test suite."
+    prompt.say "Your second tests run on CI will be parallelized with optimal test suite split."
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - ArturT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-04 00:00:00.000000000 Z
+date: 2016-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.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
@@ -249,6 +263,7 @@ files:
 - lib/knapsack_pro/version.rb
 - lib/tasks/cucumber.rake
 - lib/tasks/encrypted_test_file_names.rake
+- lib/tasks/install.rake
 - lib/tasks/minitest.rake
 - lib/tasks/rspec.rake
 - lib/tasks/salt.rake