coverband 2.0.3 → 3.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d6a0e6c24d29f4b432cd6a514b5c1bbca2e699d
-  data.tar.gz: d2ef15b6d6b100396b265068acdf1d4d83394823
+  metadata.gz: ff8f54b9c75fc882bc548834903c232af3ff9e74
+  data.tar.gz: 72cbf124e7484c096bc8316f8940a5d1128ba4de
 SHA512:
-  metadata.gz: fd0b35c4a1abceebcda0791290dc71e0fc382c4980c87d09639371a2d4f048b0d79b3938b18c3facbe5e78fcf25c2f1aa8d3766eaca761dd590ecc71138410d9
-  data.tar.gz: d0104388613abebf8575d4701b8cda4ff0caaaa5f14d57c72535c7cf68d178f432ac584a7f9c700e625b724c542b78827d5964ab24573e81562bf0b5688e8dd0
+  metadata.gz: f964fca6d95868d170694bb4dfb5a064b9d8df717e63a5d79b941dda8beaa6e6acbc3b149f98891030538da8c5b88d46a89edfbd9d97e668230e802fa222102e
+  data.tar.gz: de616d37895b9446425e2947d435db919776019f8658d45183430de3c95675e40591e49bcf0539a5306389f1ee52f5ae15372fa2521b13a71ead5a738ff79340

data/.gitignore

@@ -5,7 +5,6 @@
 .yardoc
 .idea/
 .ruby-version
-.rubocop.yml
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.rubocop.yml

@@ -0,0 +1,73 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - docs/**/*
+Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120
+Metrics/BlockNesting:
+  Max: 5
+Bundler/OrderedGems:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/BlockNesting:
+  Max: 10
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Max: 10
+Naming/AccessorMethodName:
+  Enabled: false
+Naming/PredicateName:
+  Enabled: false
+Style/FormatStringToken:
+  Enabled: false
+Style/TernaryParentheses:
+  Enabled: false
+Style/MutableConstant:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: true
+Style/GuardClause:
+  Enabled: true
+Style/NumericPredicate:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/NumericLiteralPrefix:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/MethodMissingSuper:
+  Enabled: true
+Style/MissingRespondToMissing:
+  Enabled: false
+Performance/Casecmp:
+  Enabled: false
+Layout/EmptyLinesAroundArguments:
+  Enabled: true
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+Layout/MultilineOperationIndentation:
+  Enabled: true
+Lint/RescueException:
+  Enabled: true
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+Style/FormatString:
+  Enabled: true
+Security/Eval:
+  Enabled: true
+

data/.travis.yml

@@ -1,8 +1,5 @@
 language: ruby
 rvm:
-  - "2.0"
-  - "2.1"
-  - "2.2"
   - "2.3"
   - "2.4"
   - "2.5"

data/README.md

@@ -179,7 +179,7 @@ module MyApplication
     # any files that get loaded as part of railties will have no coverage
     config.before_initialize do
       require 'coverage'
-      Coverband::Collectors::Base.instance.start
+      Coverband::Collectors::Coverage.instance.start
     end
 
   end
@@ -380,9 +380,9 @@ require 'rails'
 # Capture code coverage during our cron jobs
 class CoverageRunner < ::Rails::Railtie
   runner do
-    Coverband::Collectors::Base.instance.start
+    Coverband::Collectors::Coverage.instance.start
     at_exit do
-      Coverband::Collectors::Base.instance.report_coverage
+      Coverband::Collectors::Coverage.instance.report_coverage
     end
   end
 end

data/changes.md

@@ -4,22 +4,41 @@
 
 Will be the fully modern release that drops maintenance legacy support in favor of increased performance, ease of use, and maintainability.
 
-* expects to drop Tracepoint collection engine
-* expects to drop anything below Ruby 2.3
-* Release will be aimed as significantly simplifying ease of use
-   * expects to drop the concept of baseline recordings
-   * improve support for eager-loading
-   * add built-in support for easy loading via Railties
-   * expects to add safe list support to force reload files one wants coverage on that may happen outside of the standard load order
-   * built in support for activejob, sidekiq, and other common frameworks
-* code route tracing (entry point to all code executed for example /some_path -> code coverage of that path)
+- expects to drop Tracepoint collection engine
+- expects to drop anything below Ruby 2.3
+- Release will be aimed as significantly simplifying ease of use
+  - near zero config setup for Rails apps
+  - add built-in support for easy loading via Railties
+  - built in support for activejob, sidekiq, and other common frameworks
+  - reduced configuration options
+- options on reporting
+  - background reporting
+  - or middleware reporting
+- improved web reporting
+  - no longer relying directly on HTML in S3 but dynamically generated from any adapter
+- additional adapters including Memcache, S3, and ActiveRecord
+
+### Coverband_jam_session
+
+This is a possible gem to host experimental or more complex features, which would require tuning, configuration, and performance trade offs
+
+- additional adapters (tracepoint, ruby-profiler, etc)
+- code route tracing (entry point to all code executed for example /some_path -> code coverage of that path)
+- tagging of reported Coverage
+- allow only to collect coverage based on route (limiting or scoped coverage)
+- coverage over some other variable like a set of alpha users
 
 # Alpha
 
-### 3.0.0
+### Coverband 3.0
+
+* drops Tracepoint
+* drops Ruby <= 2.3.0
+* rewrites redis store, for 60X perf
+* drops various other features not needed without Tracepoint
+* standardizes on Coverage array format vs sparse hash
 
-* drop Tracepoint
-* background thread reporter
+# Released
 
 # 2.0.3
 
@@ -28,9 +47,6 @@ Will be the fully modern release that drops maintenance legacy support in favor
 * various additional benchmarks @danmayer
 * Filter out files with no coverage thanks  @kbaum
 
-
-# Released
-
 ### 2.0.2
 
 * fix possible nil error on files that changed since initial recording @viktor-silakov
@@ -45,50 +61,50 @@ Will be the fully modern release that drops maintenance legacy support in favor
 
 ### 2.0.1
 
-* add support for fine grained S3 configuration via Coverband config, thanks @a0s
-  * https://github.com/danmayer/coverband/pull/98
-* Using the file argument to self.configure in lib/coverband.rb, thanks @ThomasOwens
-  * https://github.com/danmayer/coverband/pull/100
-* added redis improvements allowing namespace and TTL thx @oded-zahavi
-* fix warnings about duplicate method definition
-* Add support for safe_reload_files based on full file path
-* Add support for Sinatra admin control endpoints
-* improved documentation
+- add support for fine grained S3 configuration via Coverband config, thanks @a0s
+  - https://github.com/danmayer/coverband/pull/98
+- Using the file argument to self.configure in lib/coverband.rb, thanks @ThomasOwens
+  - https://github.com/danmayer/coverband/pull/100
+- added redis improvements allowing namespace and TTL thx @oded-zahavi
+- fix warnings about duplicate method definition
+- Add support for safe_reload_files based on full file path
+- Add support for Sinatra admin control endpoints
+- improved documentation
 
 ### 2.0.0
 
 Major release with various backwards compatibility breaking changes (generally related to the configuration). The 2.0 lifecycle will act as a mostly easy upgrade that supports past users looking to move to the much faster new Coverage Adapter.
 
-* Continues to support Ruby 2.0 and up
-* supports multiple collect engines, introducing the concept of multiple collector adapters
-* extends the concepts of multiple storage adapters, enabling additional authors to help support Kafka, graphite, other adapters
-* old require based loading, but working towards deprecating the entire baseline concept
-* Introduces massive performance enhancements by moving to Ruby `Coverage` based collection
-   * Opposed to sampling this is now a reporting frequency, when using `Coverage` collector
-* Reduced configuration complexity
-* Refactoring the code preparing for more varied storage and reporting options
-* Drop Redis as a gem runtime_dependency
+- Continues to support Ruby 2.0 and up
+- supports multiple collect engines, introducing the concept of multiple collector adapters
+- extends the concepts of multiple storage adapters, enabling additional authors to help support Kafka, graphite, other adapters
+- old require based loading, but working towards deprecating the entire baseline concept
+- Introduces massive performance enhancements by moving to Ruby `Coverage` based collection
+  - Opposed to sampling this is now a reporting frequency, when using `Coverage` collector
+- Reduced configuration complexity
+- Refactoring the code preparing for more varied storage and reporting options
+- Drop Redis as a gem runtime_dependency
 
 ### 1.5.0
 
 This is a significant release with significant refactoring a stepping stone for a 2.0 release.
 
-* staging a changes.md document!
-* refactored out full abstraction for stores
-* supports hit counts vs binary covered / not covered for lines
-  * this will let you find density of code usage just not if it was used
-  * this is a slight performance hit, so you can fall back to the old system if you want `redisstore.new(@redis, array: true)`
-  * this is the primary new feature in 1.5.0
-* Redis has configurable base name, so I can safely change storage formats between releases
-* improved documentation
-* supports `SimpleCov.root`
-* show files that were never touched
-* apply coverband filters to ignore files in report not just collection
-* improved test coverage
-* improved benchmarks including support for multiple stores ;)
+- staging a changes.md document!
+- refactored out full abstraction for stores
+- supports hit counts vs binary covered / not covered for lines
+  - this will let you find density of code usage just not if it was used
+  - this is a slight performance hit, so you can fall back to the old system if you want `redisstore.new(@redis, array: true)`
+  - this is the primary new feature in 1.5.0
+- Redis has configurable base name, so I can safely change storage formats between releases
+- improved documentation
+- supports `SimpleCov.root`
+- show files that were never touched
+- apply coverband filters to ignore files in report not just collection
+- improved test coverage
+- improved benchmarks including support for multiple stores ;)
 
 ### 1.3.1
 
-* This was a small fix release addressing some issues
-* mostly readme updates
-* last release prior to having a changes document!
+- This was a small fix release addressing some issues
+- mostly readme updates
+- last release prior to having a changes document!

data/coverband.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'benchmark-ips'
   # add when debugging
   # require 'byebug'; byebug
-  #spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'byebug'
   # deprecate when dropping support for older ruby
   spec.add_runtime_dependency 'json'
   # todo make an optional dependency for simplecov reports

data/lib/coverband.rb

@@ -7,17 +7,15 @@ require 'coverband/version'
 require 'coverband/configuration'
 require 'coverband/adapters/base'
 require 'coverband/adapters/redis_store'
-require 'coverband/adapters/memory_cache_store'
 require 'coverband/adapters/file_store'
-require 'coverband/collectors/base'
-require 'coverband/collectors/trace'
+require 'coverband/utils/s3_report_writer'
 require 'coverband/collectors/coverage'
 require 'coverband/reporters/base'
 require 'coverband/reporters/simple_cov_report'
 require 'coverband/reporters/console_report'
 require 'coverband/reporters/web'
-require 'coverband/middleware'
-require 'coverband/s3_report_writer'
+require 'coverband/integrations/middleware'
+require 'coverband/integrations/background'
 
 module Coverband
   CONFIG_FILE = './config/coverband.rb'
@@ -35,11 +33,16 @@ module Coverband
     elsif File.exist?(configuration_file)
       require configuration_file
     else
-      raise ArgumentError, "configure requires a block, the existance of a #{CONFIG_FILE} in your project, or a path to a config file passed in to configure"
+      msg = "configure requires a block, #{CONFIG_FILE} in project, or file path passed in configure"
+      raise ArgumentError, msg
     end
   end
 
   def self.configuration
     self.configuration_data ||= Configuration.new
   end
+
+  def self.start
+    Coverband::Collectors::Coverage.instance
+  end
 end

data/lib/coverband/adapters/base.rb

@@ -11,7 +11,7 @@ module Coverband
         raise 'abstract'
       end
 
-      def save_report(report)
+      def save_report(_report)
         raise 'abstract'
       end
 
@@ -23,9 +23,29 @@ module Coverband
         raise 'abstract'
       end
 
-      def covered_lines_for_file(file)
+      def covered_lines_for_file(_file)
         raise 'abstract'
       end
+
+      protected
+
+      def merge_reports(new_report, old_report)
+        keys = (new_report.keys + old_report.keys).uniq
+        keys.each do |file|
+          new_report[file] = if new_report[file] && old_report[file]
+                               array_add(new_report[file], old_report[file])
+                             elsif new_report[file]
+                               new_report[file]
+                             else
+                               old_report[file]
+                             end
+        end
+        new_report
+      end
+
+      def array_add(latest, original)
+        latest.map.with_index { |v, i| (v && original[i]) ? v + original[i] : nil }
+      end
     end
   end
 end

data/lib/coverband/adapters/file_store.rb

@@ -2,6 +2,11 @@
 
 module Coverband
   module Adapters
+    ###
+    # FilesStore store a merged coverage file to local disk
+    # Generally this is for testing and development
+    # Not recommended for production deployment
+    ###
     class FileStore < Base
       attr_accessor :path
 
@@ -17,17 +22,8 @@ module Coverband
       end
 
       def save_report(report)
-        results = existing_data(path)
-        report.each_pair do |file, values|
-          if results.key?(file)
-            # convert the keys to "3" opposed to 3
-            values = JSON.parse(values.to_json)
-            results[file].merge!(values) { |_k, old_v, new_v| old_v.to_i + new_v.to_i }
-          else
-            results[file] = values
-          end
-        end
-        File.open(path, 'w') { |f| f.write(results.to_json) }
+        merge_reports(report, coverage)
+        save_coverage(report)
       end
 
       def coverage
@@ -46,6 +42,10 @@ module Coverband
 
       private
 
+      def save_coverage(report)
+        File.open(path, 'w') { |f| f.write(report.to_json) }
+      end
+
       def existing_data(path)
         if File.exist?(path)
           JSON.parse(File.read(path))

data/lib/coverband/adapters/redis_store.rb

@@ -2,94 +2,59 @@
 
 module Coverband
   module Adapters
+    ###
+    # RedisStore store a merged coverage file to redis
+    ###
     class RedisStore < Base
-      BASE_KEY = 'coverband2'
+      BASE_KEY = 'coverband3'
 
       def initialize(redis, opts = {})
-        @redis = redis
+        @redis           = redis
         @ttl             = opts[:ttl]
         @redis_namespace = opts[:redis_namespace]
       end
 
       def clear!
-        @redis.smembers(base_key).each { |key| @redis.del("#{base_key}.#{key}") }
         @redis.del(base_key)
       end
 
-      def base_key
-        @base_key ||= [BASE_KEY, @redis_namespace].compact.join('.')
-      end
-
       def save_report(report)
-        store_array(base_key, report.keys)
-
-        file_keys = report.keys.map {|file| "#{base_key}.#{file}"}
-        existing_records = existing_records(file_keys)
-        combined_report = combined_report(file_keys, report, existing_records)
-        pipelined_save(combined_report)
+        # Note: This could lead to slight races
+        # where multiple processes pull the old coverage and add to it then push
+        # the Coverband 2 had the same issue,
+        # and the tradeoff has always been acceptable
+        merge_reports(report, coverage)
+        save_coverage(base_key, report)
       end
 
       def coverage
-        data = {}
-        redis.smembers(base_key).each do |key|
-          data[key] = covered_lines_for_file(key)
-        end
-        data
+        get_report(base_key)
       end
 
       def covered_files
-        redis.smembers(base_key)
+        coverage.keys
       end
 
       def covered_lines_for_file(file)
-        @redis.hgetall("#{base_key}.#{file}")
+        coverage[file]
       end
 
       private
 
       attr_reader :redis
-      
-      def pipelined_save(combined_report)
-        redis.pipelined do
-          combined_report.each do |file, values|
-            existing = values[:existing]
-            new = values[:new]
-            unless values.empty?
-              # in redis all file_keys are strings
-              new_string_values = Hash[new.map {|k, val| [k.to_s, val]}]
-              new_string_values.merge!(existing) {|_k, old_v, new_v| old_v.to_i + new_v.to_i}
-              redis.mapped_hmset(file, new_string_values)
-              redis.expire(file, @ttl) if @ttl
-            end
-          end
-        end
-      end
 
-      def existing_records(file_keys)
-        redis.pipelined do
-          file_keys.each do |key|
-            redis.hgetall(key)
-          end
-        end
+      def base_key
+        @base_key ||= [BASE_KEY, @redis_namespace].compact.join('.')
       end
 
-      def combined_report(file_keys, report, existing_records)
-        combined_report = {}
-
-        file_keys.each_with_index do |key, i|
-          combined_report[key] = {
-            new: report.values[i],
-            existing: existing_records[i]
-          }
-        end
-        
-        return combined_report
+      def save_coverage(key, data)
+        redis.set key, data.to_json
+        redis.expire(key, @ttl) if @ttl
       end
 
-      def store_array(key, values)
-        redis.sadd(key, values) unless values.empty?
-        redis.expire(key, @ttl) if @ttl
-        values
+      def get_report(key)
+        data = redis.get key
+        data ? JSON.parse(data) : {}
       end
     end
   end