coverband 4.0.0 → 4.0.1.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e6ed1439cbb698007f0c628bc07432f3d597e713ee87685fb41cabfa33edf22
-  data.tar.gz: e1f162c8e5040c28df54e3fe152f732cdb980c876a32bf45ea2d09d948fe26bc
+  metadata.gz: b703432acb6be1cb77cb0e34fd86bc8e0480463d94a9bdb45f20e66ba34e75f1
+  data.tar.gz: 43c3afcd4f7287463218f53591ebf6182ab1b27a38e3c211663e9b906af39e6b
 SHA512:
-  metadata.gz: 0d5f63d15179790437c051a6f6b593dace6fb55f391a2659b5034ad97f61df7438b8722690c83f1fc7856db1e6b62bb1e70c0e696aec6388ee1e78c330e509c5
-  data.tar.gz: d468749b5be0582264dfc866f1e34784fce75415352cfeb803d960aa3cde86cf78ac7272e2d9963d7c879c075c0f1e650d5b87d9198184c264a314dc0aeed1ac
+  metadata.gz: 0ddcd44028f889ec0521929a3df8e316a9f66468dbff070a9be8d4a5a80242caf643ea8129eca6bb3affbad07ae500068348a155047af67081a3e5561418ff03
+  data.tar.gz: 18b93fa61005315692a8ed102deb4143778dbc8560e99bbcc0dc0a08b3ccd7919209444b567c10600d165aca9ee36306357d769175fd9a323f2f248c9cc09e01

data/.rubocop.yml

@@ -50,10 +50,6 @@ Style/NumericLiteralPrefix:
   Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
-Style/MethodMissingSuper:
-  Enabled: true
-Style/MissingRespondToMissing:
-  Enabled: false
 Performance/Casecmp:
   Enabled: false
 Layout/EmptyLinesAroundArguments:

data/changes.md

@@ -2,11 +2,10 @@
 
 ### Research Alternative Redis formats
 
-* Look at alternative storage formats for Redis
-  * [redis bitmaps](http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps/)
-  * [redis bitfield](https://stackoverflow.com/questions/47100606/optimal-way-to-store-array-of-integers-in-redis-database)
-* Add support for [zadd](http://redis.io/topics/data-types-intro) so one could determine single call versus multiple calls on a line, letting us determine the most executed code in production.
-
+- Look at alternative storage formats for Redis
+  - [redis bitmaps](http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps/)
+  - [redis bitfield](https://stackoverflow.com/questions/47100606/optimal-way-to-store-array-of-integers-in-redis-database)
+- Add support for [zadd](http://redis.io/topics/data-types-intro) so one could determine single call versus multiple calls on a line, letting us determine the most executed code in production.
 
 ### Coverband 4.X
 
@@ -29,14 +28,14 @@ Will be the fully modern release that drops maintenance legacy support in favor
   - lists current config options
   - eventually allow updating remote config
   - full theming
-  - list redis data dump for debugging 
+  - list redis data dump for debugging
 - additional adapters: Memcache, S3, and ActiveRecord
 - add articles / podcasts like prontos readme https://github.com/prontolabs/pronto
 - Add detailed Gem usage report, if we collect and send gem usage we can give percentage of gem code used, which should help application developers know when to remove gem dependencies (0%) or perhaps inline single methods for little usage (using <= 5%) for example.
 - add additional config / protection options on Coverage clear
 - add meta data information first seen last recorded to the coverage report views (probably need to drop simplecov for that).
-   - more details in this issue: https://github.com/danmayer/coverband/issues/118 
-- Make good video on setup, install, usage 
+  - more details in this issue: https://github.com/danmayer/coverband/issues/118
+- Make good video on setup, install, usage
 
 ### Coverband_jam_session
 
@@ -48,8 +47,8 @@ Feature Ideas:
 - move to SimpleCov console out, or make similar console tabular output
 - Possibly add ability to record code run for a given route
 - integrate recording with deploy tag or deploy timestamp
-   - diff code usage across deployed versions
-   - what methods increased usage or decreased
+  - diff code usage across deployed versions
+  - what methods increased usage or decreased
 - Improve client code api, around manual usage of sampling (like event usage)
 - ability to change the Coverband config at runtime by changing the config pushed to the Redis hash. In memory cache around the changes to only make that call periodically.
 - Opposed to just showing code usage on a route allow 'tagging' events which would record line coverage for that tag (this would allow tagging all code that modified an ActiveRecord model for example
@@ -59,23 +58,30 @@ Feature Ideas:
 - allow only to collect coverage based on route (limiting or scoped coverage)
 - coverage over some other variable like a set of alpha users
 - document how to use this on staging / selenium test suite runs
-   - possible add API to pull report at end of run 
+  - possible add API to pull report at end of run
 
 # Alpha
 
-### Coverband 4.0.0
+### Coverband 4.0.1.alpha
 
-* Add support for Railties integration
-* Reduce configuration options
-* Default to background reporting vs middleware reporting
-* Resolves issue requiring submitting initial coverage data pre-fork
-* Simplified setup with just works sensible defaults for configuration out of the box
-* Fixes on the pilot release of background reporting in 3.0.1
-* Rake tasks automatically configured
-* Updated and simplified documentation
+- drops simplecov runtime dependency
+  - still used to measure our own code coverage ;)
+- thanks SimpleCov for all the years of solid HTML reporting, and support!
 
 # Released
 
+### Coverband 4.0.0
+
+- Add support for Railties integration
+- Reduce configuration options
+- Default to background reporting vs middleware reporting
+- Resolves issue requiring submitting initial coverage data pre-fork
+- Simplified setup with just works sensible defaults for configuration out of the box
+- Fixes on the pilot release of background reporting in 3.0.1
+- Rake tasks automatically configured
+- Updated and simplified documentation
+- Thanks to Kbaum for all the extensive feedback on the PR
+
 ### Coverband 3.X
 
 Will be a stable and fast release that drops maintenance legacy support in favor of increased performance and maintainability.
@@ -86,50 +92,49 @@ Will be a stable and fast release that drops maintenance legacy support in favor
   - drop collectors adapter
   - reduced configuration options
 - add memory benchmarks showing memory overhead of coverband
-- use full stack tests to prove no memory leaks when used in Rails 
+- use full stack tests to prove no memory leaks when used in Rails
 
 ### Coverband 3.0.1
 
-* update documentation around verification steps (https://github.com/danmayer/coverband/issues/135), thanks @kbaum
-* resolve coverage drift issue, https://github.com/danmayer/coverband/issues/118, thanks for MD5 hash ideas @dnasseri and @kbaum
-* first version of background thread coverage reporting https://github.com/danmayer/coverband/pull/138, thanks @kbaum
-* auto-detection of Rack & Rails thanks @kbaum
-* improved tests allowing exceptions to raise in tests @kbaum
-* add support for both aws-sdk 1.x and 2.x thanks @jared
-* adds memory test ensuring no memory leaks
-* full stack Rails tests for Rails 4 and 5 thanks @kbaum
+- update documentation around verification steps (https://github.com/danmayer/coverband/issues/135), thanks @kbaum
+- resolve coverage drift issue, https://github.com/danmayer/coverband/issues/118, thanks for MD5 hash ideas @dnasseri and @kbaum
+- first version of background thread coverage reporting https://github.com/danmayer/coverband/pull/138, thanks @kbaum
+- auto-detection of Rack & Rails thanks @kbaum
+- improved tests allowing exceptions to raise in tests @kbaum
+- add support for both aws-sdk 1.x and 2.x thanks @jared
+- adds memory test ensuring no memory leaks
+- full stack Rails tests for Rails 4 and 5 thanks @kbaum
 
 ### Coverband 3.0.0
 
-* drops Tracepoint
-* drops Ruby <= 2.3.0
-* drops JSON Gem dependency
-* drops various other features not needed without Tracepoint
-   * memory cache, sampling, restricted to app folders, etc 
-* standardizes on Coverage array format vs sparse hash
-* rewrites store methods, for 60X perf
-  * implemented for Redis and File store
-* improved mountable web interface
-
+- drops Tracepoint
+- drops Ruby <= 2.3.0
+- drops JSON Gem dependency
+- drops various other features not needed without Tracepoint
+  - memory cache, sampling, restricted to app folders, etc
+- standardizes on Coverage array format vs sparse hash
+- rewrites store methods, for 60X perf
+  - implemented for Redis and File store
+- improved mountable web interface
 
 # 2.0.3
 
-* don''t include docs in the gemfile thanks @bquorning
-* pipeline_redis to reduce network overhead thanks @Kallin
-* various additional benchmarks @danmayer
-* Filter out files with no coverage thanks  @kbaum
+- don''t include docs in the gemfile thanks @bquorning
+- pipeline_redis to reduce network overhead thanks @Kallin
+- various additional benchmarks @danmayer
+- Filter out files with no coverage thanks @kbaum
 
 ### 2.0.2
 
-* fix possible nil error on files that changed since initial recording @viktor-silakov
-* add improve error logging in verbose mode (stacktrace) @viktor-silakov
-* improved logging level support @viktor-silakov
-* launch Coverband demo and integrate into Readme / Documentation
-* fix on baseline to show an issue by @viktor-silakov
-* remove all coverband:baseline related features and documentation
-* dropped Sinatra requirement for web mountable page
-* fix on filestore by @danrabinowitz
-* fixes to the MemoryCacheStore by @kbaum
+- fix possible nil error on files that changed since initial recording @viktor-silakov
+- add improve error logging in verbose mode (stacktrace) @viktor-silakov
+- improved logging level support @viktor-silakov
+- launch Coverband demo and integrate into Readme / Documentation
+- fix on baseline to show an issue by @viktor-silakov
+- remove all coverband:baseline related features and documentation
+- dropped Sinatra requirement for web mountable page
+- fix on filestore by @danrabinowitz
+- fixes to the MemoryCacheStore by @kbaum
 
 ### 2.0.1
 

data/coverband.gemspec

@@ -31,9 +31,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rack'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'test-unit'
 
-  # used for benchmarking and tests
+  # TODO: used for benchmarking and tests I think we have other better benchmarking
+  # perhaps time to drop this and refactor.
   spec.add_development_dependency 'classifier-reborn'
   # add when debugging
   # require 'byebug'; byebug
@@ -45,8 +47,4 @@ Gem::Specification.new do |spec|
   # quality adapter, I think this is more honest about requirements and reduces confusion
   # without this there was a race condition on calling coverband configure before redis was loaded
   spec.add_runtime_dependency 'redis'
-  # TODO: make an optional dependency for simplecov reports
-  # also likely should just require simplecov-html not the whole lib
-  # I tried this but it was harder than I thought
-  spec.add_runtime_dependency 'simplecov', '> 0.11.1'
 end

data/lib/coverband.rb

@@ -10,10 +10,15 @@ require 'coverband/adapters/base'
 require 'coverband/adapters/redis_store'
 require 'coverband/adapters/file_store'
 require 'coverband/utils/s3_report'
+require 'coverband/utils/html_formatter'
+require 'coverband/utils/result'
+require 'coverband/utils/file_list'
+require 'coverband/utils/source_file'
+require 'coverband/utils/lines_classifier'
 require 'coverband/utils/railtie' if defined? ::Rails::Railtie
 require 'coverband/collectors/coverage'
 require 'coverband/reporters/base'
-require 'coverband/reporters/simple_cov_report'
+require 'coverband/reporters/html_report'
 require 'coverband/reporters/console_report'
 require 'coverband/integrations/background'
 require 'coverband/integrations/rack_server_check'

data/lib/coverband/reporters/html_report.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Coverband
+  module Reporters
+    class HTMLReport < Base
+      def self.report(store, options = {})
+        scov_style_report = super(store, options)
+        open_report = options.fetch(:open_report) { true }
+        html = options.fetch(:html) { false }
+
+        # list all files, even if not tracked by Coverband (0% coverage)
+        tracked_glob = "#{current_root}/{app,lib,config}/**/*.{rb}"
+        report_files = Coverband::Utils::Result.add_not_loaded_files(scov_style_report, tracked_glob)
+        # apply coverband filters
+        filtered_report_files = {}
+        report_files.each_pair do |file, data|
+          next if Coverband.configuration.ignore.any? { |i| file.match(i) }
+          filtered_report_files[file] = data
+        end
+
+        if html
+          Coverband::Utils::HTMLFormatter.new(filtered_report_files).format_html!
+        else
+          Coverband::Utils::HTMLFormatter.new(filtered_report_files).format!
+          if open_report
+            `open #{Coverband.configuration.root}/coverage/index.html`
+          else
+            Coverband.configuration.logger.info 'report is ready and viewable: open coverage/index.html'
+          end
+
+          Coverband::Utils::S3Report.instance.persist! if Coverband.configuration.s3_bucket
+        end
+      end
+    end
+  end
+end

data/lib/coverband/reporters/web.rb

@@ -9,7 +9,7 @@ module Coverband
       attr_reader :request
 
       def initialize
-        full_path = Gem::Specification.find_by_name('simplecov-html').full_gem_path
+        full_path = Gem::Specification.find_by_name('coverband').full_gem_path
         @static = Rack::Static.new(self,
                                    root: File.expand_path('public', full_path),
                                    urls: [/.*\.css/, /.*\.js/, /.*\.gif/, /.*\.png/])
@@ -71,13 +71,9 @@ module Coverband
       end
 
       def show
-        html = Coverband::Utils::S3Report.instance.retrieve
-        # HACK: the static HTML assets to link to the path where this was mounted
-        html = html.gsub("src='", "src='#{base_path}")
-        html = html.gsub("href='", "href='#{base_path}")
-        html = html.gsub('loading.gif', "#{base_path}loading.gif")
-        html = html.gsub('/images/', "#{base_path}images/")
-        html
+        html = Coverband::Reporters::HTMLReport.report(Coverband.configuration.store,
+                                                            html: true, open_report: false)
+        fix_html_paths(html)
       end
 
       def collect_update_and_view
@@ -87,7 +83,7 @@ module Coverband
       end
 
       def update_report
-        Coverband::Reporters::SimpleCovReport.report(Coverband.configuration.store, open_report: false)
+        Coverband::Reporters::HTMLReport.report(Coverband.configuration.store, open_report: false)
         notice = 'coverband coverage updated'
         [301, { 'Location' => "#{base_path}?notice=#{notice}" }, []]
       end
@@ -105,10 +101,8 @@ module Coverband
       end
 
       def reload_files
-        if Coverband.configuration.safe_reload_files
-          Coverband.configuration.safe_reload_files.each do |safe_file|
-            load safe_file
-          end
+        Coverband.configuration&.safe_reload_files&.each do |safe_file|
+          load safe_file
         end
         # force reload
         Coverband.configure
@@ -118,6 +112,15 @@ module Coverband
 
       private
 
+      def fix_html_paths(html)
+        # HACK: the static HTML assets to link to the path where this was mounted
+        html = html.gsub("src='", "src='#{base_path}")
+        html = html.gsub("href='", "href='#{base_path}")
+        html = html.gsub('loading.gif', "#{base_path}loading.gif")
+        html = html.gsub('/images/', "#{base_path}images/")
+        html.gsub("./assets/#{Coverband::VERSION}/", '')
+      end
+
       def button(url, title)
         button = "<form action='#{url}' method='post'>"
         button += "<button type='submit'>#{title}</button>"

data/lib/coverband/utils/file_list.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+####
+# Thanks for all the help SimpleCov https://github.com/colszowka/simplecov
+# initial version pulled into Coverband from Simplecov 12/04/2018
+#
+# An array of  SourceFile instances with additional collection helper
+# methods for calculating coverage across them etc.
+####
+module Coverband
+  module Utils
+    class FileList < Array
+      # Returns the count of lines that have coverage
+      def covered_lines
+        return 0.0 if empty?
+        map { |f| f.covered_lines.count }.inject(:+)
+      end
+
+      # Returns the count of lines that have been missed
+      def missed_lines
+        return 0.0 if empty?
+        map { |f| f.missed_lines.count }.inject(:+)
+      end
+
+      # Returns the count of lines that are not relevant for coverage
+      def never_lines
+        return 0.0 if empty?
+        map { |f| f.never_lines.count }.inject(:+)
+      end
+
+      # Returns the count of skipped lines
+      def skipped_lines
+        return 0.0 if empty?
+        map { |f| f.skipped_lines.count }.inject(:+)
+      end
+
+      # Computes the coverage based upon lines covered and lines missed for each file
+      # Returns an array with all coverage percentages
+      def covered_percentages
+        map(&:covered_percent)
+      end
+
+      # Finds the least covered file and returns that file's name
+      def least_covered_file
+        sort_by(&:covered_percent).first.filename
+      end
+
+      # Returns the overall amount of relevant lines of code across all files in this list
+      def lines_of_code
+        covered_lines + missed_lines
+      end
+
+      # Computes the coverage based upon lines covered and lines missed
+      # @return [Float]
+      def covered_percent
+        return 100.0 if empty? || lines_of_code.zero?
+        Float(covered_lines * 100.0 / lines_of_code)
+      end
+
+      # Computes the strength (hits / line) based upon lines covered and lines missed
+      # @return [Float]
+      def covered_strength
+        return 0.0 if empty? || lines_of_code.zero?
+        Float(map { |f| f.covered_strength * f.lines_of_code }.inject(:+) / lines_of_code)
+      end
+    end
+  end
+end

data/lib/coverband/utils/html_formatter.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'cgi'
+require 'fileutils'
+require 'digest/sha1'
+require 'time'
+
+####
+# Thanks for all the help SimpleCov https://github.com/colszowka/simplecov-html
+# initial version pulled into Coverband from Simplecov 12/04/2018
+####
+module Coverband
+  module Utils
+    class HTMLFormatter
+      def initialize(report)
+        @coverage_result = Coverband::Utils::Result.new(report)
+      end
+
+      def format!
+        format(@coverage_result)
+      end
+
+      def format_html!
+        format_html(@coverage_result)
+      end
+
+      private
+
+      def format(result)
+        Dir[File.join(File.dirname(__FILE__), '../../../public/*')].each do |path|
+          FileUtils.cp_r(path, asset_output_path)
+        end
+
+        File.open(File.join(output_path, 'index.html'), 'wb') do |file|
+          file.puts template('layout').result(binding)
+        end
+      end
+
+      def format_html(result)
+        template('layout').result(binding)
+      end
+
+      # Returns the an erb instance for the template of given name
+      def template(name)
+        ERB.new(File.read(File.join(File.dirname(__FILE__), '../../../views/', "#{name}.erb")))
+      end
+
+      def output_path
+        "#{File.expand_path(Coverband.configuration.root)}/coverage"
+      end
+
+      def asset_output_path
+        return @asset_output_path if defined?(@asset_output_path) && @asset_output_path
+        @asset_output_path = File.join(output_path, 'assets', Coverband::VERSION)
+        FileUtils.mkdir_p(@asset_output_path)
+        @asset_output_path
+      end
+
+      def assets_path(name)
+        File.join('./assets', Coverband::VERSION, name)
+      end
+
+      # Returns the html for the given source_file
+      def formatted_source_file(source_file)
+        template('source_file').result(binding)
+      rescue Encoding::CompatibilityError => e
+        puts "Encoding problems with file #{source_file.filename}. Coverband/ERB can't handle non ASCII characters in filenames. Error: #{e.message}."
+      end
+
+      # Returns a table containing the given source files
+      def formatted_file_list(title, source_files)
+        title_id = title.gsub(/^[^a-zA-Z]+/, '').gsub(/[^a-zA-Z0-9\-\_]/, '')
+        # Silence a warning by using the following variable to assign to itself:
+        # "warning: possibly useless use of a variable in void context"
+        # The variable is used by ERB via binding.
+        title_id = title_id
+        template('file_list').result(binding)
+      end
+
+      def coverage_css_class(covered_percent)
+        if covered_percent > 90
+          'green'
+        elsif covered_percent > 80
+          'yellow'
+        else
+          'red'
+        end
+      end
+
+      def strength_css_class(covered_strength)
+        if covered_strength > 1
+          'green'
+        elsif covered_strength == 1
+          'yellow'
+        else
+          'red'
+        end
+      end
+
+      # Return a (kind of) unique id for the source file given. Uses SHA1 on path for the id
+      def id(source_file)
+        Digest::SHA1.hexdigest(source_file.filename)
+      end
+
+      def timeago(time)
+        "<abbr class=\"timeago\" title=\"#{time.iso8601}\">#{time.iso8601}</abbr>"
+      end
+
+      def shortened_filename(source_file)
+        source_file.filename.sub(Coverband.configuration.root, '.').gsub(/^\.\//, '')
+      end
+
+      def link_to_source_file(source_file)
+        %(<a href="##{id source_file}" class="src_link" title="#{shortened_filename source_file}">#{shortened_filename source_file}</a>)
+      end
+    end
+  end
+end