coverband 4.0.1.alpha → 4.0.1.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: b703432acb6be1cb77cb0e34fd86bc8e0480463d94a9bdb45f20e66ba34e75f1
-  data.tar.gz: 43c3afcd4f7287463218f53591ebf6182ab1b27a38e3c211663e9b906af39e6b
+SHA1:
+  metadata.gz: 287311c05b4d4bc1e85d1a8cc19d9a5630551fa8
+  data.tar.gz: f73c312bb5c4eceff8dd48e92d9191e5c57d80e9
 SHA512:
-  metadata.gz: 0ddcd44028f889ec0521929a3df8e316a9f66468dbff070a9be8d4a5a80242caf643ea8129eca6bb3affbad07ae500068348a155047af67081a3e5561418ff03
-  data.tar.gz: 18b93fa61005315692a8ed102deb4143778dbc8560e99bbcc0dc0a08b3ccd7919209444b567c10600d165aca9ee36306357d769175fd9a323f2f248c9cc09e01
+  metadata.gz: 2fd7fa9ceae554e6dba27834be7527b2df2a8160b68079124de97f3e986a0141dea24e467832c85881dd3f6753506b1fdc060d72226a0f009daf7c3dde66500c
+  data.tar.gz: 55566a5fef66122bcd908b6fb1d488727f55dabff12e0dfa0d73530727555c9bd6b6d7e104b1e14d9ebf5950984c7a82aaaa011e7aba68d32c923646d3a2f071

data/.gitignore

@@ -5,7 +5,7 @@
 .yardoc
 .idea/
 .ruby-version
-Gemfile.lock
+Gemfile*lock
 InstalledFiles
 _yardoc
 coverage

data/.rubocop.yml

@@ -10,8 +10,6 @@ Metrics/LineLength:
   Max: 120
 Metrics/BlockNesting:
   Max: 5
-Bundler/OrderedGems:
-  Enabled: false
 Metrics/CyclomaticComplexity:
   Enabled: false
 Metrics/PerceivedComplexity:
@@ -20,19 +18,13 @@ 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:
+Style/AccessorMethodName:
   Enabled: false
-Style/FormatStringToken:
+Style/PredicateName:
   Enabled: false
 Style/TernaryParentheses:
   Enabled: false
@@ -52,11 +44,9 @@ Style/ClassAndModuleChildren:
   Enabled: false
 Performance/Casecmp:
   Enabled: false
-Layout/EmptyLinesAroundArguments:
-  Enabled: true
-Layout/MultilineMethodCallIndentation:
+Style/MultilineMethodCallIndentation:
   Enabled: true
-Layout/MultilineOperationIndentation:
+Style/MultilineOperationIndentation:
   Enabled: true
 Lint/RescueException:
   Enabled: true
@@ -64,6 +54,6 @@ Lint/ShadowingOuterLocalVariable:
   Enabled: true
 Style/FormatString:
   Enabled: true
-Security/Eval:
+Lint/Eval:
   Enabled: true
 

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - "2.3"
   - "2.4"
   - "2.5"
+  - "2.6"
 gemfile:
   - Gemfile
   - Gemfile.rails4

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013 Dan Mayer
+Copyright (c) 2010-2018 Dan Mayer
 
 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

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Dan Mayer
+Copyright (c) 2010-2018 Dan Mayer
 
 MIT License
 

data/README.md

@@ -1,6 +1,7 @@
 # Coverband
 
-Build Status: [![Build Status](https://travis-ci.org/danmayer/coverband.svg?branch=master)](https://travis-ci.org/danmayer/coverband)
+[![Build Status](https://travis-ci.org/danmayer/coverband.svg?branch=master)](https://travis-ci.org/danmayer/coverband)
+[![Coverage Status](https://coveralls.io/repos/github/danmayer/coverband/badge.svg?branch=master)](https://coveralls.io/github/danmayer/coverband?branch=master)
 
 <p align="center">
   <a href="#key-features">Key Features</a> •
@@ -8,7 +9,6 @@ Build Status: [![Build Status](https://travis-ci.org/danmayer/coverband.svg?bran
   <a href="#configuration">Configuration</a> •
   <a href="#coverband-demo">Coverband Demo</a> •
   <a href="#how-to-use">How To Use</a> •
-  <a href="#usage">Usage</a> •
   <a href="#license">License</a> •
   <a href="/changes.md">Change Log / Roadmap</a>
 </p>
@@ -144,6 +144,23 @@ Below is my Coverband workflow, which hopefully will help other best use this li
 * After Coverband has been verified to be working on production, I let it run for a few weeks.
 * Then I view the report and start submitting PRs for the team to review delete large related sets of code that no longer are in use.
 
+### Coverband Web Endpoint
+
+The web endpoint is a barebones endpoint that you can either expose direct (after authentication) or you can just link to the actions you wish to expose. The index is intended as a example to showcase all the features.
+
+![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_web.png)
+> The web index as available on the Coverband Demo site
+
+* __collect data, update report, & view:__ This does everything need to view up to date Coverage 
+   * it triggers a coverage collection on the current webserver process
+   * it generates a new html coverage report and pushes it to S3
+   * it then loads that report for you to view
+* __view coverage report:__ Don't need to update the data just view the current report
+* __update coverage data (collect coverage):__ This triggers coverage collection on the current webserver process
+* __update coverage report (rebuild report):__ This will rebuild the HTML report from the latest available data
+* __clear coverage report:__ This will clear the coverage data. This wipes out all collected data (__dangerous__)
+* __reload Coverband files:__ This has Coverband reload files as configured (force reload of some files that might not capture Coverage on boot)
+
 ### Example apps
 
 - [Rails 5.2.x App](https://github.com/danmayer/coverage_demo)

data/Rakefile

@@ -13,7 +13,7 @@ Rake::TestTask.new(:test) do |test|
   # exclude benchmark from the tests as the way it functions resets code coverage during executions
   # test.pattern = 'test/unit/*_test.rb'
   # using test files opposed to pattern as it outputs which files are run
-  test.test_files = FileList['test/unit/*_test.rb']
+  test.test_files = FileList['test/unit/**/*_test.rb']
   test.verbose = true
 end
 

data/changes.md

@@ -36,6 +36,8 @@ Will be the fully modern release that drops maintenance legacy support in favor
 - 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
+- See if we can add support for views / templates
+  - using this technique https://github.com/ioquatix/covered 	
 
 ### Coverband_jam_session
 
@@ -67,6 +69,7 @@ Feature Ideas:
 - drops simplecov runtime dependency
   - still used to measure our own code coverage ;)
 - thanks SimpleCov for all the years of solid HTML reporting, and support!
+- reduced the S3 dependencies to minimal set (not loading all of aws-sdk), ensured they are optional
 
 # Released
 

data/coverband.gemspec

@@ -7,7 +7,7 @@ require 'coverband/version'
 Gem::Specification.new do |spec|
   spec.name          = 'coverband'
   spec.version       = Coverband::VERSION
-  spec.authors       = ['Dan Mayer']
+  spec.authors       = ['Dan Mayer', 'Karl Baum']
   spec.email         = ['dan@mayerdan.com']
   spec.description   = 'Rack middleware to help measure production code usage (LOC runtime usage)'
   spec.summary       = 'Rack middleware to help measure production code usage (LOC runtime usage)'
@@ -22,21 +22,24 @@ Gem::Specification.new do |spec|
   # to test support for sdk 1, uncomment this line
   # spec.add_development_dependency 'aws-sdk', '~> 1'
   # to test sdk 2 use this one
-  spec.add_development_dependency 'aws-sdk', '~> 2'
+  spec.add_development_dependency 'aws-sdk-s3', '~> 1'
   spec.add_development_dependency 'benchmark-ips'
   spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'capybara'
   spec.add_development_dependency 'm'
   spec.add_development_dependency 'memory_profiler'
-  spec.add_development_dependency 'mocha', '~> 0.14.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'mocha', '~> 1.7.0'
   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'
+
 
   # 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'
+  spec.add_development_dependency 'coveralls'
   # add when debugging
   # require 'byebug'; byebug
   spec.add_development_dependency 'pry-byebug'

data/lib/coverband.rb

@@ -34,13 +34,12 @@ module Coverband
   end
 
   def self.configure(file = nil)
-    configuration_file = file || CONFIG_FILE
-
+    configuration_file = file || ENV.fetch('COVERBAND_CONFIG', CONFIG_FILE)
     configuration
     if block_given?
       yield(configuration)
     elsif File.exist?(configuration_file)
-      require configuration_file
+      load configuration_file
     else
       configuration.logger&.debug('using default configuration')
     end

data/lib/coverband/configuration.rb

@@ -12,6 +12,10 @@ module Coverband
     attr_writer :logger, :s3_region, :s3_bucket, :s3_access_key_id, :s3_secret_access_key
 
     def initialize
+      reset
+    end
+
+    def reset
       @root = Dir.pwd
       @root_paths = []
       @ignore = %w(vendor .erb$ .slim$)
@@ -35,7 +39,7 @@ module Coverband
     end
 
     def logger
-      @logger ||= if defined?(Rails)
+      @logger ||= if defined?(Rails.logger)
                     Rails.logger
                   else
                     Logger.new(STDOUT)

data/lib/coverband/integrations/background.rb

@@ -4,28 +4,37 @@ module Coverband
   class Background
     @semaphore = Mutex.new
 
+    def self.stop
+      @semaphore.synchronize do
+        if @thread
+          @thread.exit
+          @thread = nil
+        end
+      end
+    end
+
     def self.start
-      return if @background_reporting_running
+      return if @thread
 
       logger = Coverband.configuration.logger
       @semaphore.synchronize do
-        return if @background_reporting_running
+        binding.pry if defined?($debug) && $debug
+        return if @thread
         logger&.debug('Coverband: Starting background reporting')
-
-        @background_reporting_running = true
         sleep_seconds = Coverband.configuration.background_reporting_sleep_seconds
-        Thread.new do
+        @thread = Thread.new do
           loop do
             Coverband::Collectors::Coverage.instance.report_coverage(true)
             logger&.debug("Coverband: Reported coverage via thread. Sleeping #{sleep_seconds}s") if Coverband.configuration.verbose
             sleep(sleep_seconds)
           end
         end
-
-        at_exit do
-          Coverband::Collectors::Coverage.instance.report_coverage(true)
-          logger&.debug('Coverband: Reported coverage before exit')
-        end
+        binding.pry if defined?($debug) && $debug
+      end
+      at_exit do
+        stop
+        Coverband::Collectors::Coverage.instance.report_coverage(true)
+        logger&.debug('Coverband: Reported coverage before exit')
       end
     end
   end

data/lib/coverband/reporters/html_report.rb

@@ -7,6 +7,8 @@ module Coverband
         scov_style_report = super(store, options)
         open_report = options.fetch(:open_report) { true }
         html = options.fetch(:html) { false }
+        notice = options.fetch(:notice) { nil }
+        base_path = options.fetch(:base_path) { nil }
 
         # list all files, even if not tracked by Coverband (0% coverage)
         tracked_glob = "#{current_root}/{app,lib,config}/**/*.{rb}"
@@ -19,7 +21,9 @@ module Coverband
         end
 
         if html
-          Coverband::Utils::HTMLFormatter.new(filtered_report_files).format_html!
+          Coverband::Utils::HTMLFormatter.new(filtered_report_files,
+                                              base_path: base_path,
+                                              notice: notice).format_html!
         else
           Coverband::Utils::HTMLFormatter.new(filtered_report_files).format!
           if open_report

data/lib/coverband/reporters/web.rb

@@ -4,7 +4,6 @@ require 'rack'
 
 module Coverband
   module Reporters
-    # TODO: move to reports and drop need for S3 allow reading from adapters?
     class Web
       attr_reader :request
 
@@ -20,12 +19,8 @@ module Coverband
 
         if request.post?
           case request.path_info
-          when %r{\/collect_update_and_view}
-            collect_update_and_view
           when %r{\/clear}
             clear
-          when %r{\/update_report}
-            update_report
           when %r{\/collect_coverage}
             collect_coverage
           when %r{\/reload_files}
@@ -37,8 +32,6 @@ module Coverband
           case request.path_info
           when /.*\.(css|js|gif|png)/
             @static.call(env)
-          when %r{\/show}
-            [200, { 'Content-Type' => 'text/html' }, [show]]
           when %r{\/}
             [200, { 'Content-Type' => 'text/html' }, [index]]
           else
@@ -47,45 +40,14 @@ module Coverband
         end
       end
 
-      # TODO: move to file or template
       def index
         notice = "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params['notice'])}<br/>"
         notice = request.params['notice'] ? notice : ''
-        %(
-<html>
-  #{notice}
-  <ul>
-    <li><a href='#{base_path}'>Coverband Web Admin Index</a></li>
-    <li>#{button("#{base_path}collect_update_and_view", 'collect data, update report, & view')}</li>
-    <li><a href='#{base_path}show'>view coverage report</a></li>
-    <li>#{button("#{base_path}collect_coverage", 'update coverage data (collect coverage)')}</li>
-    <li>#{button("#{base_path}update_report", 'update coverage report (rebuild report)')}</li>
-    <li>#{button("#{base_path}clear", 'clear coverage report')}</li>
-    <li>#{button("#{base_path}reload_files", 'reload Coverband files')}</li>
-  </ul>
-  <br/>
-  version: #{Coverband::VERSION}<br/>
-  <a href='https://github.com/danmayer/coverband'>Coverband</a>
-</html>
-)
-      end
-
-      def show
-        html = Coverband::Reporters::HTMLReport.report(Coverband.configuration.store,
-                                                            html: true, open_report: false)
-        fix_html_paths(html)
-      end
-
-      def collect_update_and_view
-        collect_coverage
-        update_report
-        [301, { 'Location' => "#{base_path}show" }, []]
-      end
-
-      def update_report
-        Coverband::Reporters::HTMLReport.report(Coverband.configuration.store, open_report: false)
-        notice = 'coverband coverage updated'
-        [301, { 'Location' => "#{base_path}?notice=#{notice}" }, []]
+        Coverband::Reporters::HTMLReport.report(Coverband.configuration.store,
+                                                html: true,
+                                                base_path: base_path,
+                                                notice: notice,
+                                                open_report: false)
       end
 
       def collect_coverage
@@ -112,28 +74,13 @@ 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>"
-        button + '</form>'
-      end
-
       # This method should get the root mounted endpoint
       # for example if the app is mounted like so:
       # mount Coverband::Web, at: '/coverage'
       # "/coverage/collect_coverage?" become:
       # /coverage/
       def base_path
-        request.path.match("\/.*\/") ? request.path.match("\/.*\/")[0] : '/'
+        request.path =~ %r{\/.*\/} ? request.path.match("\/.*\/")[0] : '/'
       end
     end
   end

data/lib/coverband/utils/html_formatter.rb

@@ -13,7 +13,11 @@ require 'time'
 module Coverband
   module Utils
     class HTMLFormatter
-      def initialize(report)
+      attr_reader :notice, :base_path
+
+      def initialize(report, options = {})
+        @notice = options.fetch(:notice) { nil }
+        @base_path = options.fetch(:base_path) { nil }
         @coverage_result = Coverband::Utils::Result.new(report)
       end
 
@@ -58,7 +62,19 @@ module Coverband
       end
 
       def assets_path(name)
-        File.join('./assets', Coverband::VERSION, name)
+        if base_path
+          File.join(base_path, name)
+        else
+          File.join(name)
+        end
+      end
+
+      def button(url, title, opts = {})
+        delete = opts.fetch(:delete) { false }
+        button_css = delete ? 'coveraband-button del' : 'coveraband-button'
+        button = "<form action='#{url}' class='coverband-admin-form' method='post'>"
+        button += "<button class='#{button_css}' type='submit'>#{title}</button>"
+        button + '</form>'
       end
 
       # Returns the html for the given source_file