semaphore_cucumber_booster_config 1.2.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5691d3e9fe17f86e85b76a5fa9259bf203b77beb
-  data.tar.gz: ac9277bddca09570ee842921cb317a167fdf22c3
+  metadata.gz: d7b1bd2ba271d3f4d92d7819e796ef440c311cb9
+  data.tar.gz: db7e0c303076f2ad732585feb44cfb9b13bb93b2
 SHA512:
-  metadata.gz: db92126e314a3ca17879b3162f738a390f7c89418e6bbe628b00f52737db7071c58234e6095d052ead9a5a9fd3f5a137109f9438348b250467199a55bfb591da
-  data.tar.gz: 2e30ae2831d05464d5446fbd8102f2c287c348e82bb3e8cdba0aa4a365573881f0861bd318919e9d5baa8c32c1f974d45456a635aee59270c67a420ef1b20a2a
+  metadata.gz: f82d5ee3131c858147d34ce2ca4e242dfa9ef33f44e018777582c98168ff1593f8c6ecf8c81dd65734d608432b1eb2ee0169d28af773435ff239691fd483c63a
+  data.tar.gz: b32f41e453e1c390402c9f5645adb2c78d195e6b4d7b409c16675ccad8002d922315679e0eb10867687a30325f5d67613b93a34f7e07afaa64425c10d446ab03

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Rendered Text
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,20 +1,23 @@
-# CucumberBoosterConfig
+# Cucumber Booster Config
 
-[![Build
-Status](https://semaphoreci.com/api/v1/projects/b5ad1293-4dd1-425d-8c00-b42ceca09c75/527737/badge.svg)](https://semaphoreci.com/renderedtext/cucumber_booster_config)
+[![Build Status](https://semaphoreci.com/api/v1/projects/b5ad1293-4dd1-425d-8c00-b42ceca09c75/527737/badge.svg)](https://semaphoreci.com/renderedtext/cucumber_booster_config)
+[![Gem Version](https://badge.fury.io/rb/semaphore_cucumber_booster_config.svg)](https://badge.fury.io/rb/semaphore_cucumber_booster_config)
 
-Injects additional configuration for Cucumber so that it outputs JSON suitable
-for auto-parallelism without affecting stdout.
+Injects additional configuration for Cucumber so that it outputs JSON report suitable
+for estimation of the [split configuration](https://github.com/renderedtext/test-boosters#split-configuration) for the next build.
+
+Cucumber Booster Config is primarily used as [Test Boosters gem](https://github.com/renderedtext/test-boosters) dependency.
+Boosters help you with distribution of your test files across many parallel jobs and optimize your build time. Find out more about [Boosters](https://semaphoreci.com/docs/about-boosters.html).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "cucumber_booster_config", :source => "https://gem.fury.io/renderedtext/"
+gem "semaphore_cucumber_booster_config"
 ```
 
-## Usage
+## Usage from the CLI
 
 ```
 $ cucumber-booster-config help inject
@@ -46,20 +49,40 @@ default: --format pretty features --profile semaphoreci
 ---
 ```
 
+## Usage from other scripts
+
+You can invoke the injector script programaticaly too:
+
+``` ruby
+current_path = Dir.pwd
+output_report_path = "/tmp/cucumber_report.json"
+
+CucumberBoosterConfig::Injection.new(current_path, output_report_path).run
+```
+
+This is how Test Boosters gem is using it to configure Cucumber.
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bundle exec rspec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
 ### How to release a new version
 
-Change version number in `lib/cucumber_booster_config/version.rb`, commit and push your changes.
-This will propagate the gemspec and subsequently `.gem` file that is generated on Gemfury.
+Bump version number in `lib/cucumber_booster_config/version.rb`, commit and
+push your changes.
 
-Semaphore is currently configured to push new versions to Gemfury.
-If version hasn't changed, Gemfury will simply ignore the update.
+Semaphore is currently configured to push new versions to Rubygems.
+If version hasn't changed, Rubygems will simply ignore the update.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/renderedtext/cucumber_booster_config.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/renderedtext/cucumber_booster_config.
+
+## License
+
+The gem is available as open source under the terms of the [MIT license](LICENSE).

data/cucumber_booster_config.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "thor", "~> 0.19.1"
+  spec.add_dependency "thor", [">= 0.19.1", "< 2.0"]
 
   spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec"
 end

data/lib/cucumber_booster_config.rb

@@ -1,3 +1,5 @@
+require "fileutils"
+
 require "cucumber_booster_config/cli"
 require "cucumber_booster_config/injection"
 require "cucumber_booster_config/version"

data/lib/cucumber_booster_config/cli.rb

@@ -2,11 +2,16 @@ require "thor"
 
 module CucumberBoosterConfig
   class CLI < Thor
+
     desc "inject PATH", "inject Semaphore's Cucumber configuration in project PATH"
     option :dry_run, :type => :boolean
     def inject(path)
       puts "Running in #{path}"
-      Injection.new(path, :dry_run => options[:dry_run]).run
+
+      report_path = "cucumber_report.json"
+
+      Injection.new(path, report_path, :dry_run => options[:dry_run]).run
     end
+
   end
 end

data/lib/cucumber_booster_config/cucumber_file.rb

@@ -2,7 +2,6 @@ module CucumberBoosterConfig
 
   class CucumberFile
 
-    SEMAPHORE_PROFILE = "semaphoreci: --format json --out=~/cucumber_report.json"
     DEFAULT_PROFILE = "default: --format pretty --profile semaphoreci features"
 
     def initialize(path, dry_run)
@@ -10,7 +9,7 @@ module CucumberBoosterConfig
       @dry_run = dry_run
     end
 
-    def configure_for_autoparallelism
+    def configure_for_autoparallelism(report_path)
       load_file_content
 
       if dry_run?
@@ -20,8 +19,11 @@ module CucumberBoosterConfig
         puts "---"
       end
 
-      define_semaphore_profile
-      include_semaphore_profile
+
+      unless semaphore_profile_defined? && semaphore_profile_included?
+        define_semaphore_profile(report_path)
+        include_semaphore_profile
+      end
 
       if dry_run?
         puts "Content after:"
@@ -48,10 +50,11 @@ module CucumberBoosterConfig
       File.open(@path, "w") { |f| @new_lines.each { |line| f.puts line } }
     end
 
-    def define_semaphore_profile
-      puts "Inserting Semaphore configuration"
+    def define_semaphore_profile(report_path)
+      puts "Inserting Semaphore configuration for json report"
+      puts "Report path: #{report_path}"
 
-      @new_lines << "#{SEMAPHORE_PROFILE}\n"
+      @new_lines << "semaphoreci: --format json --out=#{report_path}\n"
     end
 
     def include_semaphore_profile
@@ -73,5 +76,13 @@ module CucumberBoosterConfig
         @new_lines << DEFAULT_PROFILE
       end
     end
+
+    def semaphore_profile_defined?
+      @original_lines.any? { |line| line.include?("semaphoreci:") }
+    end
+
+    def semaphore_profile_included?
+      @original_lines.any? { |line| line.include?("--profile semaphoreci") }
+    end
   end
 end

data/lib/cucumber_booster_config/injection.rb

@@ -9,8 +9,9 @@ module CucumberBoosterConfig
       "config/cucumber.yml"
     ]
 
-    def initialize(path, options = {})
+    def initialize(path, report_path, options = {})
       @path = path
+      @report_path = report_path
       @dry_run = options.fetch(:dry_run, false)
     end
 
@@ -28,13 +29,22 @@ module CucumberBoosterConfig
     end
 
     def run
+      if no_profile_files?
+        puts "No cucumber profile files found. Creating empty cucumber.yml file"
+        FileUtils.touch("cucumber.yml")
+      end
+
       find_profile_files.each do |path|
-        CucumberFile.new(path, @dry_run).configure_for_autoparallelism
+        CucumberFile.new(path, @dry_run).configure_for_autoparallelism(@report_path)
       end
     end
 
     private
 
+    def no_profile_files?
+      find_profile_files.empty?
+    end
+
     def cucumber_file_path(file_name)
       File.join(@path, file_name)
     end

data/lib/cucumber_booster_config/version.rb

@@ -1,3 +1,3 @@
 module CucumberBoosterConfig
-  VERSION = "1.2.0".freeze
+  VERSION = "1.4.2".freeze
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: semaphore_cucumber_booster_config
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Marko Anastasov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-19 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.19.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.19.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +84,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -108,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Cucumber configuration injection for autoparallelism.