simplecov-parallel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e92642ff81ef2e617345126a45380f06cc55a23a
+  data.tar.gz: 4eda4cf6cc80c3dbd4e2a22f603fe6e97d2d7e80
+SHA512:
+  metadata.gz: 4563472ac7358a32d559f0ebeada789dbcf0424558bd96931948f4ef86619967a4f27e104c058be4565cc8a9f338a661a2d3459699bfc7ebb35a133ba74592e9
+  data.tar.gz: ee2d6183d9213721c54fbfa849453364f1778ce1085af9932b4fc212f401dd63ac84ffd83019c966fd8e71ce1295184c55b6069c21c20b002ed6c9d7bce6b353

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/examples.txt
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  Exclude:
+    - fixtures/**/*
+    - vendor/**/*
+  TargetRubyVersion: 2.1
+
+Metrics/LineLength:
+  Max: 100
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - spec/**/*
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyElse:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Exclude:
+    - '*.gemspec'
+
+Style/SingleLineBlockParams:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# simplecov 0.12.0 has a bug in result merger and the bugfix is not yet released.
+# https://github.com/colszowka/simplecov/pull/513
+gem 'simplecov', github: 'colszowka/simplecov'
+
+group :development, :test do
+  gem 'rake', '~> 11.0'
+  gem 'rspec', '~> 3.5'
+  gem 'rubocop', '~> 0.42'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yuji Nakayama
+
+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

@@ -0,0 +1,63 @@
+# SimpleCov::Parallel
+
+**SimpleCov::Parallel** is a SimpleCov extension for parallelism support.
+Currently only [CircleCI parallelism](https://circleci.com/docs/parallelism/) is supported.
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+# simplecov 0.12.0 has a bug in result merger and the bugfix is not yet released.
+# https://github.com/colszowka/simplecov/pull/513
+gem 'simplecov', github: 'colszowka/simplecov'
+gem 'simplecov-parallel'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+You just need to invoke `SimpleCov::Parallel.activate` before start tracking coverage:
+
+```ruby
+# spec/spec_helper.rb
+require 'simplecov/parallel'
+SimpleCov::Parallel.activate
+SimpleCov.start
+```
+
+SimpleCov::Parallel automatically detects the best parallelism support for the current environment.
+
+You can use any formatter transparently
+since SimpleCov::Parallel merges the results into `SimpleCov.result`,
+which is a basic API of SimpleCov.
+
+## CircleCI
+
+When using SimpleCov::Parallel on CircleCI:
+
+* [Add `parallel: true`](https://circleci.com/docs/parallel-manual-setup/)
+  to the test command (e.g. `rspec`) in your `circle.yml`.
+* [Set up parallelism](https://circleci.com/docs/setting-up-parallelism/)
+  for your project from the CircleCI web console.
+
+```yaml
+# circle.yml
+test:
+  override:
+    - bundle exec rspec:
+        parallel: true
+        files:
+          - spec/**/*_spec.rb
+```
+
+The formatter will be executed only on the first node (`CIRCLE_NODE_INDEX` is `0`).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new do |task|
+  task.verbose = false
+end
+
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]
+
+task ci: [:spec, :rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'simplecov/parallel'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,12 @@
+machine:
+  ruby:
+    version: 2.3.1
+
+dependencies:
+  post:
+    - bundle install:
+        pwd: fixtures
+
+test:
+  override:
+    - bundle exec rake ci

data/fixtures/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/examples.txt
+/spec/reports/
+/tmp/

data/fixtures/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/fixtures/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'rspec', '~> 3.5'
+# simplecov 0.12.0 has a bug in result merger and the bugfix is not yet released.
+# https://github.com/colszowka/simplecov/pull/513
+gem 'simplecov', github: 'colszowka/simplecov'
+gem 'simplecov-parallel', path: '..'

data/fixtures/lib/dependent/a.rb

@@ -0,0 +1,11 @@
+module A
+  module_function
+
+  def foo
+    puts :foo
+  end
+
+  def bar
+    puts :bar
+  end
+end

data/fixtures/lib/dependent/b.rb

@@ -0,0 +1,17 @@
+require 'dependent/a'
+
+module B
+  module_function
+
+  def foo
+    2.times do
+      A.foo
+    end
+  end
+
+  def bar
+    2.times do
+      A.bar
+    end
+  end
+end

data/fixtures/lib/dependent/c.rb

@@ -0,0 +1,15 @@
+module C
+  module_function
+
+  def foo
+    if true
+      puts :foo
+    end
+  end
+
+  def bar
+    if false
+      puts :bar
+    end
+  end
+end

data/fixtures/lib/dependent/d.rb

@@ -0,0 +1,15 @@
+module D
+  module_function
+
+  def foo(bool)
+    if bool
+      puts :foo
+    end
+  end
+
+  def bar(bool)
+    if !bool
+      puts :bar
+    end
+  end
+end

data/fixtures/lib/independent/a.rb

@@ -0,0 +1,11 @@
+module A
+  module_function
+
+  def foo
+    puts :foo
+  end
+
+  def bar
+    puts :bar
+  end
+end

data/fixtures/lib/independent/b.rb

@@ -0,0 +1,15 @@
+module B
+  module_function
+
+  def foo
+    2.times do
+      puts :foo
+    end
+  end
+
+  def bar
+    2.times do
+      puts :bar
+    end
+  end
+end

data/fixtures/lib/independent/c.rb

@@ -0,0 +1,15 @@
+module C
+  module_function
+
+  def foo
+    if true
+      puts :foo
+    end
+  end
+
+  def bar
+    if false
+      puts :bar
+    end
+  end
+end

data/fixtures/lib/independent/d.rb

@@ -0,0 +1,15 @@
+module D
+  module_function
+
+  def foo(bool)
+    if bool
+      puts :foo
+    end
+  end
+
+  def bar(bool)
+    if !bool
+      puts :bar
+    end
+  end
+end

data/fixtures/spec/dependent/a_spec.rb

@@ -0,0 +1,2 @@
+require 'dependent/a'
+A.foo

data/fixtures/spec/dependent/b_spec.rb

@@ -0,0 +1,2 @@
+require 'dependent/b'
+B.foo

data/fixtures/spec/dependent/c_spec.rb

@@ -0,0 +1,2 @@
+require 'dependent/c'
+C.foo

data/fixtures/spec/dependent/d_spec.rb

@@ -0,0 +1,2 @@
+require 'dependent/d'
+D.foo(true)

data/fixtures/spec/independent/a_spec.rb

@@ -0,0 +1,2 @@
+require 'independent/a'
+A.foo

data/fixtures/spec/independent/b_spec.rb

@@ -0,0 +1,2 @@
+require 'independent/b'
+B.foo

data/fixtures/spec/independent/c_spec.rb

@@ -0,0 +1,2 @@
+require 'independent/c'
+C.foo

data/fixtures/spec/independent/d_spec.rb

@@ -0,0 +1,2 @@
+require 'independent/d'
+D.foo(true)

data/fixtures/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+FileUtils.rmtree('coverage')
+
+module SimpleCov
+  class DumpFormatter
+    def format(result)
+      json = JSON.pretty_generate(result.original_result.sort.to_h)
+      path = File.join(SimpleCov.coverage_path, 'dump.json')
+      File.write(path, json)
+    end
+  end
+end
+
+require 'circleci/parallel'
+CircleCI::Parallel.configuration.mock_mode = true
+
+require 'simplecov/parallel'
+SimpleCov::Parallel.activate
+SimpleCov.start do
+  formatter SimpleCov::DumpFormatter
+  add_filter '/spec/'
+end

data/lib/simplecov/parallel.rb

@@ -0,0 +1,54 @@
+require 'simplecov'
+require 'simplecov/parallel/adapter/circleci'
+
+module SimpleCov
+  # Provides parallelism support for SimpleCov.
+  module Parallel
+    NoAdapterAvailableError = Class.new(StandardError)
+
+    class << self
+      # Activates SimpleCov parallelism support for the current environment.
+      # This modifies some SimpleCov configuration options so you should configure SimpleCov before
+      # invoking this method.
+      # When no adapter is available in the current environment, it does nothing.
+      #
+      # @example
+      #   require 'simplecov/parallel'
+      #   SimpleCov::Parallel.activate
+      #   SimpleCov.start
+      #
+      # @see .activate!
+      def activate
+        activate!
+      rescue NoAdapterAvailableError # rubocop:disable Lint/HandleExceptions
+      end
+
+      # Activates SimpleCov parallelism support for the current environment.
+      # This modifies some SimpleCov configuration options so you should configure SimpleCov before
+      # invoking this method.
+      #
+      # @raise NoAdapterAvailableError when no adapter is available in the current environment
+      #
+      # @example
+      #   require 'simplecov/parallel'
+      #   SimpleCov::Parallel.activate! if ENV['CIRCLECI']
+      #   SimpleCov.start
+      #
+      # @see .activate!
+      def activate!
+        if available_adapter_classes.empty?
+          raise NoAdapterAvailableError,
+                'No SimpleCov::Parallel adapter is available in the current environment.'
+        end
+
+        available_adapter_classes.first.new.activate
+      end
+
+      private
+
+      def available_adapter_classes
+        Adapter::Base.all_adapters.select(&:available?)
+      end
+    end
+  end
+end

data/lib/simplecov/parallel/adapter/base.rb

@@ -0,0 +1,24 @@
+module SimpleCov
+  module Parallel
+    module Adapter
+      # @api private
+      class Base
+        def self.inherited(subclass)
+          all_adapters << subclass
+        end
+
+        def self.all_adapters
+          @all_adapters ||= []
+        end
+
+        def self.available?
+          raise NotImplementedError
+        end
+
+        def activate
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/simplecov/parallel/adapter/circleci.rb

@@ -0,0 +1,100 @@
+require 'simplecov/parallel/adapter/base'
+
+module SimpleCov
+  module Parallel
+    module Adapter
+      # @api private
+      class CircleCI < Base
+        def self.available?
+          ENV.key?('CIRCLECI')
+        end
+
+        def activate
+          require 'circleci/parallel'
+          require 'fileutils'
+
+          SimpleCov.command_name("#{SimpleCov.command_name} #{current_node.name}")
+
+          SimpleCov.at_exit do
+            puts 'Merging SimpleCov result into the master node...'
+            export_slave_node_result
+            join_nodes_and_merge_slave_node_results
+            merge_and_format_master_node_result
+          end
+        end
+
+        private
+
+        def export_slave_node_result
+          return if current_node.master?
+
+          # Export result to coverage/.resultset.json
+          # https://github.com/colszowka/simplecov/blob/v0.12.0/lib/simplecov.rb#L89
+          raise 'SimpleCov.use_merging must be set to true' unless SimpleCov.use_merging
+          SimpleCov.result
+
+          FileUtils.copy(
+            SimpleCov::ResultMerger.resultset_path,
+            ::CircleCI::Parallel.local_data_dir
+          )
+        end
+
+        def join_nodes_and_merge_slave_node_results
+          ::CircleCI::Parallel.configuration.after_download do
+            merge_slave_node_results
+          end
+
+          ::CircleCI::Parallel.join
+        end
+
+        def merge_and_format_master_node_result
+          return unless current_node.master?
+
+          # Invoking `SimpleCov.result` here merges the master node data into the slave node data.
+          # `SimpleCov.result.format!` is the default behavior of at_exit:
+          # https://github.com/colszowka/simplecov/blob/v0.12.0/lib/simplecov/configuration.rb#L172
+          SimpleCov.result.format!
+        end
+
+        def merge_slave_node_results
+          Dir.glob('node*') do |node_dir|
+            results = load_results_from_dir(node_dir)
+            merge_and_save_results_to_dir(results, SimpleCov.coverage_path)
+          end
+        end
+
+        def load_results_from_dir(dir)
+          with_changing_resultset_path(dir) do
+            SimpleCov::ResultMerger.results
+          end
+        end
+
+        def merge_and_save_results_to_dir(results, dir)
+          with_changing_resultset_path(dir) do
+            results.each { |result| SimpleCov::ResultMerger.store_result(result) }
+          end
+        end
+
+        def with_changing_resultset_path(dir)
+          # Actually we don't want to do this hack but changing resultset_path by modifying
+          # SimpleCov.root and SimpleCov.coverage_dir does not work well because .root is used in
+          # the root filter, which is invoked from SimpleCov::Result#initialize.
+          # https://github.com/colszowka/simplecov/blob/v0.12.0/lib/simplecov/defaults.rb#L9
+          unbound_method = SimpleCov::ResultMerger.method(:resultset_path).unbind
+
+          SimpleCov::ResultMerger.define_singleton_method(:resultset_path) do
+            File.join(dir, '.resultset.json')
+          end
+
+          yield
+        ensure
+          unbound_method.bind(SimpleCov::ResultMerger)
+        end
+
+        def current_node
+          ::CircleCI::Parallel.current_node
+        end
+      end
+    end
+  end
+end

data/lib/simplecov/parallel/version.rb

@@ -0,0 +1,13 @@
+module SimpleCov
+  module Parallel
+    module Version
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+
+      def self.to_s
+        [MAJOR, MINOR, PATCH].join('.')
+      end
+    end
+  end
+end

data/simplecov-parallel.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simplecov/parallel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simplecov-parallel'
+  spec.version       = SimpleCov::Parallel::Version.to_s
+  spec.authors       = ['Yuji Nakayama']
+  spec.email         = ['nkymyj@gmail.com']
+
+  spec.summary       = 'SimpleCov extension for parallelism support'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/increments/simplecov-parallel'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'circleci-parallel', '~> 0.4'
+  spec.add_runtime_dependency 'simplecov', '~> 0.12'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-parallel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuji Nakayama
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: circleci-parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description: SimpleCov extension for parallelism support
+email:
+- nkymyj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- fixtures/.gitignore
+- fixtures/.rspec
+- fixtures/Gemfile
+- fixtures/lib/dependent/a.rb
+- fixtures/lib/dependent/b.rb
+- fixtures/lib/dependent/c.rb
+- fixtures/lib/dependent/d.rb
+- fixtures/lib/independent/a.rb
+- fixtures/lib/independent/b.rb
+- fixtures/lib/independent/c.rb
+- fixtures/lib/independent/d.rb
+- fixtures/spec/dependent/a_spec.rb
+- fixtures/spec/dependent/b_spec.rb
+- fixtures/spec/dependent/c_spec.rb
+- fixtures/spec/dependent/d_spec.rb
+- fixtures/spec/independent/a_spec.rb
+- fixtures/spec/independent/b_spec.rb
+- fixtures/spec/independent/c_spec.rb
+- fixtures/spec/independent/d_spec.rb
+- fixtures/spec/spec_helper.rb
+- lib/simplecov/parallel.rb
+- lib/simplecov/parallel/adapter/base.rb
+- lib/simplecov/parallel/adapter/circleci.rb
+- lib/simplecov/parallel/version.rb
+- simplecov-parallel.gemspec
+homepage: https://github.com/increments/simplecov-parallel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: SimpleCov extension for parallelism support
+test_files: []