coverband 4.2.6 → 5.0.0.rc.5

data/lib/coverband/reporters/console_report.rb

@@ -12,7 +12,7 @@ module Coverband
         scov_style_report.each_pair do |file, usage|
           # TODO: In Coverband 5 deprecate none hash format
           if usage.is_a?(Hash)
-            Coverband.configuration.logger.info "#{file}: #{usage['data']}"
+            Coverband.configuration.logger.info "#{file}: #{usage["data"]}"
           else
             Coverband.configuration.logger.info "#{file}: #{usage}"
           end

data/lib/coverband/reporters/html_report.rb

@@ -3,16 +3,15 @@
 module Coverband
   module Reporters
     class HTMLReport < Base
-      attr_accessor :filtered_report_files, :open_report, :static, :notice,
-                    :base_path, :filename
+      attr_accessor :filtered_report_files, :open_report, :notice,
+        :base_path, :filename
 
       def initialize(store, options = {})
         coverband_reports = Coverband::Reporters::Base.report(store, options)
         self.open_report = options.fetch(:open_report) { true }
-        self.static = options.fetch(:static) { true }
         # TODO: refactor notice out to top level of web only
         self.notice = options.fetch(:notice) { nil }
-        self.base_path = options.fetch(:base_path) { nil }
+        self.base_path = options.fetch(:base_path) { "./" }
         self.filename = options.fetch(:filename) { nil }
 
         self.filtered_report_files = self.class.fix_reports(coverband_reports)
@@ -20,16 +19,12 @@ module Coverband
 
       def file_details
         Coverband::Utils::HTMLFormatter.new(filtered_report_files,
-                                            base_path: base_path,
-                                            notice: notice).format_source_file!(filename)
+          base_path: base_path,
+          notice: notice).format_source_file!(filename)
       end
 
       def report
-        if static?
-          report_static_site
-        else
-          report_dynamic_html
-        end
+        report_dynamic_html
       end
 
       def report_data
@@ -38,31 +33,16 @@ module Coverband
 
       private
 
-      def static?
-        static
-      end
-
-      def report_static_site
-        Coverband::Utils::HTMLFormatter.new(filtered_report_files).format_static_html!
-        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
-
       def report_dynamic_html
         Coverband::Utils::HTMLFormatter.new(filtered_report_files,
-                                            base_path: base_path,
-                                            notice: notice).format_dynamic_html!
+          base_path: base_path,
+          notice: notice).format_dynamic_html!
       end
 
       def report_dynamic_data
         Coverband::Utils::HTMLFormatter.new(filtered_report_files,
-                                            base_path: base_path,
-                                            notice: notice).format_dynamic_data!
+          base_path: base_path,
+          notice: notice).format_dynamic_data!
       end
     end
   end

data/lib/coverband/reporters/web.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require "coverband"
+
 begin
-  require 'rack'
+  require "rack"
 rescue LoadError
-  puts 'error loading Coverband web reporter as Rack is not available'
+  puts "error loading Coverband web reporter as Rack is not available"
 end
 
 module Coverband
@@ -11,28 +13,28 @@ module Coverband
     class Web
       attr_reader :request
 
-      def initialize
-        full_path = Gem::Specification.find_by_name('coverband').full_gem_path
+      def init_web
+        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/])
+          root: File.expand_path("public", full_path),
+          urls: [/.*\.css/, /.*\.js/, /.*\.gif/, /.*\.png/])
       end
 
       def check_auth
         return true unless Coverband.configuration.password
 
-        auth_header = request.get_header('HTTP_AUTHORIZATION')
+        auth_header = request.get_header("HTTP_AUTHORIZATION")
         return unless auth_header
 
-        Coverband.configuration.password == Base64.decode64(auth_header.split[1]).split(':')[1]
+        Coverband.configuration.password == Base64.decode64(auth_header.split[1]).split(":")[1]
       end
 
       def call(env)
         @request = Rack::Request.new(env)
 
-        return [401, { 'www-authenticate' => 'Basic realm=""' }, ['']] unless check_auth
+        return [401, {"www-authenticate" => 'Basic realm=""'}, [""]] unless check_auth
 
-        request_path_info = (request.path_info == '') ? '/' : request.path_info
+        request_path_info = request.path_info == "" ? "/" : request.path_info
         if request.post?
           case request_path_info
           when %r{\/clear_view_tracking_file}
@@ -44,40 +46,40 @@ module Coverband
           when %r{\/clear}
             clear
           else
-            [404, { 'Content-Type' => 'text/html' }, ['404 error!']]
+            [404, {"Content-Type" => "text/html"}, ["404 error!"]]
           end
         else
           case request_path_info
           when /.*\.(css|js|gif|png)/
             @static.call(env)
           when %r{\/settings}
-            [200, { 'Content-Type' => 'text/html' }, [settings]]
+            [200, {"Content-Type" => "text/html"}, [settings]]
           when %r{\/view_tracker_data}
-            [200, { 'Content-Type' => 'text/json' }, [view_tracker_data]]
+            [200, {"Content-Type" => "text/json"}, [view_tracker_data]]
           when %r{\/view_tracker}
-            [200, { 'Content-Type' => 'text/html' }, [view_tracker]]
+            [200, {"Content-Type" => "text/html"}, [view_tracker]]
           when %r{\/enriched_debug_data}
-            [200, { 'Content-Type' => 'text/json' }, [enriched_debug_data]]
+            [200, {"Content-Type" => "text/json"}, [enriched_debug_data]]
           when %r{\/debug_data}
-            [200, { 'Content-Type' => 'text/json' }, [debug_data]]
+            [200, {"Content-Type" => "text/json"}, [debug_data]]
           when %r{\/load_file_details}
-            [200, { 'Content-Type' => 'text/json' }, [load_file_details]]
+            [200, {"Content-Type" => "text/json"}, [load_file_details]]
           when %r{\/$}
-            [200, { 'Content-Type' => 'text/html' }, [index]]
+            [200, {"Content-Type" => "text/html"}, [index]]
           else
-            [404, { 'Content-Type' => 'text/html' }, ['404 error!']]
+            [404, {"Content-Type" => "text/html"}, ["404 error!"]]
           end
         end
       end
 
       def index
-        notice = "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params['notice'])}<br/>"
-        notice = request.params['notice'] ? notice : ''
+        notice = "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params["notice"])}<br/>"
+        notice = request.params["notice"] ? notice : ""
         Coverband::Reporters::HTMLReport.new(Coverband.configuration.store,
-                                             static: false,
-                                             base_path: base_path,
-                                             notice: notice,
-                                             open_report: false).report
+          static: false,
+          base_path: base_path,
+          notice: notice,
+          open_report: false).report
       end
 
       def settings
@@ -85,11 +87,11 @@ module Coverband
       end
 
       def view_tracker
-        notice = "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params['notice'])}<br/>"
-        notice = request.params['notice'] ? notice : ''
+        notice = "<strong>Notice:</strong> #{Rack::Utils.escape_html(request.params["notice"])}<br/>"
+        notice = request.params["notice"] ? notice : ""
         Coverband::Utils::HTMLFormatter.new(nil,
-                                            notice: notice,
-                                            base_path: base_path).format_view_tracker!
+          notice: notice,
+          base_path: base_path).format_view_tracker!
       end
 
       def view_tracker_data
@@ -102,62 +104,62 @@ module Coverband
 
       def enriched_debug_data
         Coverband::Reporters::HTMLReport.new(Coverband.configuration.store,
-                                             static: false,
-                                             base_path: base_path,
-                                             notice: '',
-                                             open_report: false).report_data
+          static: false,
+          base_path: base_path,
+          notice: "",
+          open_report: false).report_data
       end
 
       def load_file_details
-        filename = request.params['filename']
+        filename = request.params["filename"]
         Coverband::Reporters::HTMLReport.new(Coverband.configuration.store,
-                                             filename: filename,
-                                             base_path: base_path,
-                                             open_report: false).file_details
+          filename: filename,
+          base_path: base_path,
+          open_report: false).file_details
       end
 
       def clear
         if Coverband.configuration.web_enable_clear
           Coverband.configuration.store.clear!
-          notice = 'coverband coverage cleared'
+          notice = "coverband coverage cleared"
         else
-          notice = 'web_enable_clear isnt enabled in your configuration'
+          notice = "web_enable_clear isnt enabled in your configuration"
         end
-        [301, { 'Location' => "#{base_path}?notice=#{notice}" }, []]
+        [301, {"Location" => "#{base_path}?notice=#{notice}"}, []]
       end
 
       def clear_file
         if Coverband.configuration.web_enable_clear
-          filename = request.params['filename']
+          filename = request.params["filename"]
           Coverband.configuration.store.clear_file!(filename)
           notice = "coverage for file #{filename} cleared"
         else
-          notice = 'web_enable_clear isnt enabled in your configuration'
+          notice = "web_enable_clear isnt enabled in your configuration"
         end
-        [301, { 'Location' => "#{base_path}?notice=#{notice}" }, []]
+        [301, {"Location" => "#{base_path}?notice=#{notice}"}, []]
       end
 
       def clear_view_tracking
         if Coverband.configuration.web_enable_clear
           tracker = Coverband::Collectors::ViewTracker.new(store: Coverband.configuration.store)
           tracker.reset_recordings
-          notice = 'view tracking reset'
+          notice = "view tracking reset"
         else
-          notice = 'web_enable_clear isnt enabled in your configuration'
+          notice = "web_enable_clear isnt enabled in your configuration"
         end
-        [301, { 'Location' => "#{base_path}/view_tracker?notice=#{notice}" }, []]
+        [301, {"Location" => "#{base_path}/view_tracker?notice=#{notice}"}, []]
       end
 
       def clear_view_tracking_file
         if Coverband.configuration.web_enable_clear
           tracker = Coverband::Collectors::ViewTracker.new(store: Coverband.configuration.store)
-          filename = request.params['filename']
+          filename = request.params["filename"]
           tracker.clear_file!(filename)
           notice = "coverage for file #{filename} cleared"
         else
-          notice = 'web_enable_clear isnt enabled in your configuration'
+          notice = "web_enable_clear isnt enabled in your configuration"
         end
-        [301, { 'Location' => "#{base_path}/view_tracker?notice=#{notice}" }, []]
+        [301, {"Location" => "#{base_path}/view_tracker?notice=#{notice}"}, []]
       end
 
       private
@@ -167,8 +169,11 @@ module Coverband
       # mount Coverband::Web, at: '/coverage'
       # "/coverage/collect_coverage?" become:
       # /coverage/
+      # NOTE: DO NOT let standardrb `autofix` this to regex match
+      # %r{\/.*\/}.match?(request.path) ? request.path.match("\/.*\/")[0] : "/"
+      # ^^ the above is NOT valid Ruby 2.3/2.4 even though rubocop / standard think it is
       def base_path
-        request.path =~ %r{\/.*\/} ? request.path.match("\/.*\/")[0] : '/'
+        request.path =~ %r{\/.*\/} ? request.path.match("\/.*\/")[0] : "/"
       end
     end
   end

data/lib/coverband/utils/absolute_file_converter.rb

@@ -25,9 +25,9 @@ module Coverband
                                     relative_filename = relative_path
                                     local_filename = relative_filename
                                     @roots.each do |root|
-                                      relative_filename = relative_filename.sub(/^#{root}/, './')
+                                      relative_filename = relative_filename.sub(/^#{root}/, "./")
                                       # once we have a relative path break out of the loop
-                                      break if relative_filename.start_with? './'
+                                      break if relative_filename.start_with? "./"
                                     end
                                     # the filename for our reports is expected to be a full path.
                                     # roots.last should be roots << current_root}/
@@ -36,10 +36,10 @@ module Coverband
                                     # above only works for app files
                                     # we need to rethink some of this logic
                                     # gems aren't at project root and can have multiple locations
-                                    local_root = @roots.find do |root|
-                                      File.exist?(relative_filename.gsub('./', root))
-                                    end
-                                    local_root ? relative_filename.gsub('./', local_root) : local_filename
+                                    local_root = @roots.find { |root|
+                                      File.exist?(relative_filename.gsub("./", root))
+                                    }
+                                    local_root ? relative_filename.gsub("./", local_root) : local_filename
                                   end
       end
     end

data/lib/coverband/utils/html_formatter.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'erb'
-require 'cgi'
-require 'fileutils'
-require 'digest/sha1'
-require 'time'
+require "erb"
+require "cgi"
+require "fileutils"
+require "digest/sha1"
+require "time"
 
 ####
 # Thanks for all the help SimpleCov https://github.com/colszowka/simplecov-html
@@ -17,14 +17,10 @@ module Coverband
 
       def initialize(report, options = {})
         @notice = options.fetch(:notice) { nil }
-        @base_path = options.fetch(:base_path) { nil }
+        @base_path = options.fetch(:base_path) { "./" }
         @coverage_result = Coverband::Utils::Results.new(report) if report
       end
 
-      def format_static_html!
-        format(@coverage_result)
-      end
-
       def format_dynamic_html!
         format_html(@coverage_result)
       end
@@ -47,41 +43,41 @@ module Coverband
         if source_file
           formatted_source_file(@coverage_result, source_file)
         else
-          'File No Longer Available'
+          "File No Longer Available"
         end
       end
 
       private
 
       def format_settings
-        template('settings').result(binding)
+        template("settings").result(binding)
       end
 
       def format_view_tracker
-        template('view_tracker').result(binding)
+        template("view_tracker").result(binding)
       end
 
       def format(result)
-        Dir[File.join(File.dirname(__FILE__), '../../../public/*')].each do |path|
+        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)
+        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)
+        template("layout").result(binding)
       end
 
       def format_data(result)
-        template('data').result(binding)
+        template("data").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")))
+        ERB.new(File.read(File.join(File.dirname(__FILE__), "../../../views/", "#{name}.erb")))
       end
 
       def output_path
@@ -97,90 +93,70 @@ module Coverband
       end
 
       def served_html?
-        !static_html?
-      end
-
-      def static_html?
-        base_path.nil?
+        true
       end
 
       def assets_path(name)
-        if static_html?
-          File.join(name)
-        else
-          File.join(base_path, name)
-        end
+        File.join(base_path, name)
       end
 
       def button(url, title, opts = {})
         delete = opts.fetch(:delete) { false }
-        button_css = delete ? 'coveraband-button del' : 'coveraband-button'
+        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>'
+        button + "</form>"
       end
 
       def display_nav(nav_options = {})
-        template('nav').result(binding)
+        template("nav").result(binding)
       end
 
       # Returns the html for the given source_file
       def formatted_source_file(result, source_file)
-        template('source_file').result(binding)
+        template("source_file").result(binding)
       rescue Encoding::CompatibilityError => e
         puts "Encoding error file:#{source_file.filename} Coverband/ERB error #{e.message}."
       end
 
       # Returns the html to ajax load a given source_file
       def formatted_source_file_loader(result, source_file)
-        template('source_file_loader').result(binding)
+        template("source_file_loader").result(binding)
       rescue Encoding::CompatibilityError => e
         puts "Encoding error file:#{source_file.filename} Coverband/ERB error #{e.message}."
       end
 
       # Returns a table containing the given source files
       def formatted_file_list(title, result, source_files, options = {})
-        title_id = title.gsub(/^[^a-zA-Z]+/, '').gsub(/[^a-zA-Z0-9\-\_]/, '')
+        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
         options = options
 
-        if title == 'Gems'
-          template('gem_list').result(binding)
-        else
-          template('file_list').result(binding)
-        end
-      end
-
-      def view_gems?
-        Coverband.configuration.track_gems
-      end
-
-      def gem_details?
-        Coverband.configuration.gem_details
+        template("file_list").result(binding)
       end
 
       def coverage_css_class(covered_percent)
         if covered_percent.nil?
-          ''
+          ""
         elsif covered_percent > 90
-          'green'
+          "green"
         elsif covered_percent > 80
-          'yellow'
+          "yellow"
         else
-          'red'
+          "red"
         end
       end
 
       def strength_css_class(covered_strength)
         if covered_strength > 1
-          'green'
+          "green"
         elsif covered_strength == 1
-          'yellow'
+          "yellow"
         else
-          'red'
+          "red"
         end
       end
 
@@ -193,7 +169,7 @@ module Coverband
         if time
           "<abbr class=\"timeago\" title=\"#{time.iso8601}\">#{time.iso8601}</abbr>"
         else
-          'Not Available'
+          "Not Available"
         end
       end
 
@@ -201,11 +177,6 @@ module Coverband
         source_file.short_name
       end
 
-      def link_to_gem_list(gem_name)
-        gem_id = gem_name.gsub(/^[^a-zA-Z]+/, '').gsub(/[^a-zA-Z0-9\-\_]/, '')
-        %(<a href="##{gem_id}" class="gem-link" title="#{gem_name}">#{gem_name}</a>)
-      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