coverband 4.2.7 → 5.0.0.rc.3

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

data/lib/coverband/utils/railtie.rb

@@ -10,7 +10,7 @@ module Coverband
   Rails::Engine.prepend(RailsEagerLoad)
 
   class Railtie < Rails::Railtie
-    initializer 'coverband.configure' do |app|
+    initializer "coverband.configure" do |app|
       begin
         app.middleware.use Coverband::BackgroundMiddleware
 
@@ -19,12 +19,12 @@ module Coverband
           Coverband.configuration.view_tracker = CoverbandViewTracker
 
           ActiveSupport::Notifications.subscribe(/render_partial.action_view|render_template.action_view/) do |name, start, finish, id, payload|
-            CoverbandViewTracker.track_views(name, start, finish, id, payload) unless name.include?('!')
+            CoverbandViewTracker.track_views(name, start, finish, id, payload) unless name.include?("!")
           end
         end
       rescue Redis::CannotConnectError => error
         Coverband.configuration.logger.info "Redis is not available (#{error}), Coverband not configured"
-        Coverband.configuration.logger.info 'If this is a setup task like assets:precompile feel free to ignore'
+        Coverband.configuration.logger.info "If this is a setup task like assets:precompile feel free to ignore"
       end
     end
 
@@ -36,8 +36,20 @@ module Coverband
       end
     end
 
+    config.before_configuration do
+      unless ENV["COVERBAND_DISABLE_AUTO_START"]
+        begin
+          Coverband.configure
+          Coverband.start
+        rescue Redis::CannotConnectError => error
+          Coverband.configuration.logger.info "Redis is not available (#{error}), Coverband not configured"
+          Coverband.configuration.logger.info "If this is a setup task like assets:precompile feel free to ignore"
+        end
+      end
+    end
+
     rake_tasks do
-      load 'coverband/utils/tasks.rb'
+      load "coverband/utils/tasks.rb"
     end
   end
 end

data/lib/coverband/utils/relative_file_converter.rb

@@ -24,8 +24,8 @@ module Coverband
         @cache[file] ||= begin
                            relative_file = file
                            @roots.each do |root|
-                             relative_file = file.gsub(/^#{root}/, '.')
-                             break relative_file if relative_file.start_with?('.')
+                             relative_file = file.gsub(/^#{root}/, ".")
+                             break relative_file if relative_file.start_with?(".")
                            end
                            relative_file
                          end

data/lib/coverband/utils/result.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'digest/sha1'
-require 'forwardable'
+require "digest/sha1"
+require "forwardable"
 
 ####
 # Thanks for all the help SimpleCov https://github.com/colszowka/simplecov
@@ -31,9 +31,9 @@ module Coverband
       def initialize(original_result)
         @original_result = (original_result || {}).freeze
 
-        @files = Coverband::Utils::FileList.new(@original_result.map do |filename, coverage|
+        @files = Coverband::Utils::FileList.new(@original_result.map { |filename, coverage|
           Coverband::Utils::SourceFile.new(filename, coverage) if File.file?(filename)
-        end.compact.sort_by(&:short_name))
+        }.compact.sort_by(&:short_name))
       end
 
       # Returns all filenames for source files contained in this result
@@ -41,11 +41,6 @@ module Coverband
         files.map(&:filename)
       end
 
-      # Returns a Hash of groups for this result. Define groups using Coverband.add_group 'Models', 'app/models'
-      def groups
-        @groups ||= FileGroups.new(files).grouped_results
-      end
-
       # Defines when this result has been created. Defaults to Time.now
       def created_at
         @created_at ||= Time.now
@@ -60,8 +55,8 @@ module Coverband
           Dir[tracked_files].each do |file|
             absolute = File.expand_path(file)
             result[absolute] ||= {
-              'data' => Array.new(File.foreach(absolute).count) { 0 },
-              'never_loaded' => true
+              "data" => Array.new(File.foreach(absolute).count) { 0 },
+              "never_loaded" => true
             }
           end
         end

data/lib/coverband/utils/results.rb

@@ -45,16 +45,6 @@ module Coverband
         eager_file.relevant_lines - eager_file.covered_lines_count
       end
 
-      ###
-      # TODO: Groups still have some issues, this should be generic for groups, but right now gem_name
-      # is specifically called out, need to revisit all gorups code.
-      ###
-      def group_file_list_with_type(group, file_list, results_type)
-        return unless get_results(results_type)
-
-        get_results(results_type).groups[group].find { |gem_files| gem_files.first.gem_name == file_list.first.gem_name }
-      end
-
       def file_from_path_with_type(full_path, results_type = :merged)
         return unless get_results(results_type)
 

data/lib/coverband/utils/source_file.rb

@@ -32,14 +32,14 @@ module Coverband
         alias number line_number
 
         def initialize(src, line_number, coverage)
-          raise ArgumentError, 'Only String accepted for source' unless src.is_a?(String)
-          raise ArgumentError, 'Only Integer accepted for line_number' unless line_number.is_a?(Integer)
-          raise ArgumentError, 'Only Integer and nil accepted for coverage' unless coverage.is_a?(Integer) || coverage.nil?
+          raise ArgumentError, "Only String accepted for source" unless src.is_a?(String)
+          raise ArgumentError, "Only Integer accepted for line_number" unless line_number.is_a?(Integer)
+          raise ArgumentError, "Only Integer and nil accepted for coverage" unless coverage.is_a?(Integer) || coverage.nil?
 
-          @src         = src
+          @src = src
           @line_number = line_number
-          @coverage    = coverage
-          @skipped     = false
+          @coverage = coverage
+          @skipped = false
         end
 
         # Returns true if this is a line that should have been covered, but was not
@@ -71,10 +71,10 @@ module Coverband
         # The status of this line - either covered, missed, skipped or never. Useful i.e. for direct use
         # as a css class in report generation
         def status
-          return 'skipped' if skipped?
-          return 'never' if never?
-          return 'missed' if missed?
-          return 'covered' if covered?
+          return "skipped" if skipped?
+          return "never" if never?
+          return "missed" if missed?
+          return "covered" if covered?
         end
       end
 
@@ -89,17 +89,17 @@ module Coverband
       attr_reader :last_updated_at
       # meta data that the file was never loaded during boot or runtime
       attr_reader :never_loaded
-      NOT_AVAILABLE = 'not available'
+      NOT_AVAILABLE = "not available"
 
       def initialize(filename, file_data)
         @filename = filename
         @runtime_relavant_lines = nil
         if file_data.is_a?(Hash)
-          @coverage = file_data['data']
+          @coverage = file_data["data"]
           @first_updated_at = @last_updated_at = NOT_AVAILABLE
-          @first_updated_at = Time.at(file_data['first_updated_at']) if file_data['first_updated_at']
-          @last_updated_at =  Time.at(file_data['last_updated_at']) if file_data['last_updated_at']
-          @never_loaded = file_data['never_loaded'] || false
+          @first_updated_at = Time.at(file_data["first_updated_at"]) if file_data["first_updated_at"]
+          @last_updated_at = Time.at(file_data["last_updated_at"]) if file_data["last_updated_at"]
+          @never_loaded = file_data["never_loaded"] || false
         else
           # TODO: Deprecate this code path this was backwards compatability from 3-4
           @coverage = file_data
@@ -117,14 +117,14 @@ module Coverband
 
       # The path to this source file relative to the projects directory
       def project_filename
-        @filename.sub(/^#{Coverband.configuration.root}/, '')
+        @filename.sub(/^#{Coverband.configuration.root}/, "")
       end
 
       # The source code for this file. Aliased as :source
       def src
         # We intentionally read source code lazily to
         # suppress reading unused source code.
-        @src ||= File.open(filename, 'rb', &:readlines)
+        @src ||= File.open(filename, "rb", &:readlines)
       end
       alias source src
 
@@ -138,9 +138,9 @@ module Coverband
       def build_lines
         coverage_exceeding_source_warn if coverage.size > src.size
 
-        lines = src.map.with_index(1) do |src, i|
+        lines = src.map.with_index(1) { |src, i|
           Coverband::Utils::SourceFile::Line.new(src, i, coverage[i - 1])
-        end
+        }
 
         process_skipped_lines(lines)
       end
@@ -241,23 +241,14 @@ module Coverband
       # was at the start of the file name
       # I had previously patched this in my local Rails app
       def short_name
-        filename.sub(/^#{Coverband.configuration.root}/, '.')
-                .sub(%r{^.*\/gems\/}, '.')
-                .gsub(%r{^\.\/}, '')
+        filename.sub(/^#{Coverband.configuration.root}/, ".")
+          .gsub(%r{^\.\/}, "")
       end
 
       def relative_path
         RelativeFileConverter.convert(filename)
       end
 
-      def gem?
-        filename =~ %r{^.*\/gems\/}
-      end
-
-      def gem_name
-        gem? ? short_name.split('/').first.gsub(%r{^\.}, '') : nil
-      end
-
       private
 
       # ruby 1.9 could use Float#round(places) instead