coverband 4.2.0.alpha → 4.2.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 40372eb3dc52edf4440af29a183eea4354a1695b
-  data.tar.gz: 47215556426f24df1aa12a26dadfb97418f59ce9
+SHA256:
+  metadata.gz: b9aa38073bdae160d98f4b0114909db9e0f3967535df5ed10d92be7ef7f85d58
+  data.tar.gz: f0f4ba2d756e783569f75f2444d613eaf17b46eed1b8ff41103dcf1b95454aa0
 SHA512:
-  metadata.gz: da9ddb6c8ad13165d7fca9332e23d10a69fe96d6eb4aa2589f206375f4f87943a878d16858408118a32cb0cb37c33e647b3da581f78792fb0fe84ee3fe36b83b
-  data.tar.gz: 29f91f8e81dd7f00c3b3fa3718b5d8734cad42c7feb4dbd83b930b3cf7e0e649e3ecb34de4efef5c43c15bf37b4d25c6622bc6118755b413ecce1914ac88aed6
+  metadata.gz: 6d65b43454b8a119b4fbd52577aef646235facde4e6e887a8e6c41ffbed81fd1e3b13282f4a8dd7ab72a47582dec61706ada1b115b869145bb086b435f6f2dbb
+  data.tar.gz: 0b91d57c2f558d8dcfec0452db8c0e8fa7273b19bee982a5ac7fbd1f3da89cac09c154a86bcd21fe89e3c1828328ccf9e3dfd1a68fe9cddafb69a795ee848772

data/changes.md

@@ -69,6 +69,8 @@ Feature Ideas:
 	- todos
 	  - support multiple gem paths (various version managers setup multiple gem paths)
 	  - speed up page load by allowing multiple pages
+- web settings and debug views
+	 - todo improve these views  
 
 ### Coverband 4.1.0.alpha
 

data/lib/coverband/configuration.rb

@@ -8,7 +8,7 @@ module Coverband
                   :redis_namespace, :redis_ttl,
                   :safe_reload_files, :background_reporting_enabled,
                   :background_reporting_sleep_seconds, :test_env,
-                  :web_enable_clear, :gem_details
+                  :web_enable_clear, :gem_details, :web_debug
 
     attr_writer :logger, :s3_region, :s3_bucket, :s3_access_key_id, :s3_secret_access_key
     attr_reader :track_gems
@@ -20,7 +20,7 @@ module Coverband
     def reset
       @root = Dir.pwd
       @root_paths = []
-      @ignore = %w(vendor .erb$ .slim$)
+      @ignore = %w[vendor .erb$ .slim$]
       @additional_files = []
       @reporting_frequency = 0.0
       @verbose = false
@@ -34,6 +34,7 @@ module Coverband
       @track_gems = false
       @gem_details = false
       @groups = {}
+      @web_debug = false
 
       # TODO: should we push these to adapter configs
       @s3_region = nil
@@ -83,6 +84,9 @@ module Coverband
     def track_gems=(value)
       @track_gems = value
       return unless @track_gems
+      # by default we ignore vendor where many deployments put gems
+      # we will remove this default if track_gems is set
+      @ignore.delete('vendor')
       add_group('App', root)
       # TODO: rework support for multiple gem paths
       # currently this supports GEM_HOME (which should be first path)
@@ -115,6 +119,14 @@ module Coverband
       Gem::PathSupport.new(ENV).path.select { |path| File.exist?(path) }
     end
 
+    SKIPPED_SETTINGS = %w[@s3_secret_access_key @store]
+    def to_h
+      instance_variables
+        .each_with_object('gem_paths': gem_paths) do |var, hash|
+          hash[var.to_s.delete('@')] = instance_variable_get(var) unless SKIPPED_SETTINGS.include?(var.to_s)
+        end
+    end
+
     private
 
     def redis_url

data/lib/coverband/reporters/web.rb

@@ -35,6 +35,10 @@ module Coverband
           case request.path_info
           when /.*\.(css|js|gif|png)/
             @static.call(env)
+          when %r{\/settings}
+            [200, { 'Content-Type' => 'text/json' }, [settings]]
+          when %r{\/debug_data}
+            [200, { 'Content-Type' => 'text/json' }, [debug_data]]
           when %r{\/$}
             [200, { 'Content-Type' => 'text/html' }, [index]]
           else
@@ -53,6 +57,14 @@ module Coverband
                                                 open_report: false)
       end
 
+      def settings
+        Coverband.configuration.to_h.to_json
+      end
+
+      def debug_data
+        Coverband.configuration.store.coverage.to_json
+      end
+
       def collect_coverage
         Coverband::Collectors::Coverage.instance.report_coverage(true)
         notice = 'coverband coverage collected'

data/lib/coverband/utils/file_groups.rb

@@ -8,7 +8,8 @@ module Coverband
     class FileGroups
       def initialize(files)
         @grouped = {}
-        filter_to_groups(files)
+        @files = files
+        filter_to_groups
       end
 
       def grouped_results
@@ -17,29 +18,36 @@ module Coverband
 
       private
 
-      def filter_to_groups(files)
+      def filter_to_groups
         grouped_files = []
-        grouped_gems = {}
-        gem_lists = []
         Coverband.configuration.groups.each do |name, filter|
           if name == 'Gems'
-            grouped_gems = files.select { |source_file| source_file.filename =~ /#{filter}/ }.group_by(&:gem_name)
-            gem_lists = grouped_gems.values.map { |gem_files| Coverband::Utils::FileList.new(gem_files) }
-            grouped_files.concat(gem_lists.flatten)
-            @grouped[name] = Coverband::Utils::GemList.new(gem_lists) if gem_lists.flatten.any?
+            gem_lists = gem_files(name, filter)
+            grouped_files.concat(gem_lists.flatten) if gem_lists.flatten.any?
           else
-            @grouped[name] = Coverband::Utils::FileList.new(files.select do |source_file|
-              source_file.filename =~ /#{filter}/
-            end)
+            app_files(name, filter)
             grouped_files += @grouped[name]
           end
         end
-        if !Coverband.configuration.groups.empty? && !(other_files = files.reject do |source_file|
+        if !Coverband.configuration.groups.empty? && !(other_files = @files.reject do |source_file|
                                                          grouped_files.include?(source_file)
                                                        end).empty?
           @grouped['Ungrouped'] = Coverband::Utils::FileList.new(other_files)
         end
       end
+
+      def gem_files(name, filter)
+        grouped_gems = @files.select { |source_file| source_file.filename =~ /#{filter}/ }.group_by(&:gem_name)
+        gem_lists = grouped_gems.values.map { |gem_files| Coverband::Utils::FileList.new(gem_files) }
+        @grouped[name] = Coverband::Utils::GemList.new(gem_lists) if gem_lists.flatten.any?
+        gem_lists
+      end
+
+      def app_files(name, filter)
+        @grouped[name] = Coverband::Utils::FileList.new(@files.select do |source_file|
+          source_file.filename =~ /#{filter}/ && source_file.filename !~ /#{Coverband.configuration.gem_paths.first}/
+        end)
+      end
     end
   end
 end

data/lib/coverband/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coverband
-  VERSION = '4.2.0.alpha'
+  VERSION = '4.2.0.beta'
 end

data/test/test_helper.rb

@@ -95,6 +95,10 @@ def source_fixture(filename)
   File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', filename))
 end
 
+def test_root
+  File.expand_path(File.join(File.dirname(__FILE__)))
+end
+
 # Taken from http://stackoverflow.com/questions/4459330/how-do-i-temporarily-redirect-stderr-in-ruby
 def capture_stderr
   # The output stream must be an IO-like object. In this case we capture it in

data/test/unit/utils/file_groups_test.rb

@@ -2,10 +2,6 @@
 
 require File.expand_path('../../test_helper', File.dirname(__FILE__))
 
-####
-# Thanks for all the help SimpleCov https://github.com/colszowka/simplecov-html
-# initial version of test pulled into Coverband from Simplecov 12/19/2018
-####
 describe Coverband::Utils::FileGroups do
   FAKE_GEM_PATH = 'fake/gem/path'
   subject do
@@ -16,7 +12,7 @@ describe Coverband::Utils::FileGroups do
       Coverband::Utils::SourceFile.new(source_fixture('app/controllers/sample_controller.rb'), controller_lines),
       Coverband::Utils::SourceFile.new("#{FAKE_GEM_PATH}/gem_name.rb", controller_lines)
     ]
-    Coverband.configuration.expects(:gem_paths).returns([FAKE_GEM_PATH])
+    Coverband.configuration.expects(:gem_paths).at_least_once.returns([FAKE_GEM_PATH])
     Coverband.configuration.track_gems = true
     Coverband::Utils::FileGroups.new(files)
   end
@@ -29,3 +25,31 @@ describe Coverband::Utils::FileGroups do
     assert_equal "#{FAKE_GEM_PATH}/gem_name.rb", subject.grouped_results['Gems'].first.first.short_name
   end
 end
+
+describe Coverband::Utils::FileGroups, :vendored_gems do
+  FAKE_VENDOR_GEM_PATH = "#{test_root}/app/vendor/bundle/ruby/2.5.0/gems"
+  subject do
+    controller_lines = [nil, 2, 2, 0, nil, nil, 0, nil, nil, nil]
+    files = [
+      Coverband::Utils::SourceFile.new(source_fixture('sample.rb'), [nil, 1, 1, 1, nil, nil, 1, 1, nil, nil]),
+      Coverband::Utils::SourceFile.new(source_fixture('app/models/user.rb'), [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil]),
+      Coverband::Utils::SourceFile.new(source_fixture('app/controllers/sample_controller.rb'), controller_lines),
+      Coverband::Utils::SourceFile.new("#{FAKE_VENDOR_GEM_PATH}/gem_name.rb", controller_lines)
+    ]
+    Coverband.configuration.expects(:gem_paths).at_least_once.returns([FAKE_VENDOR_GEM_PATH])
+    Coverband.configuration.track_gems = true
+    Coverband::Utils::FileGroups.new(files)
+  end
+
+  it 'has app files' do
+    assert_equal 'test/fixtures/sample.rb', subject.grouped_results['App'].first.short_name
+  end
+
+  it "doesn't include vendor gems in app files app files" do
+    assert_nil subject.grouped_results['App'].select { |files| files.short_name.match(/gem_name/) }.first
+  end
+
+  it 'does has gem files' do
+    assert_equal 'gem_name.rb', subject.grouped_results['Gems'].first.first.short_name
+  end
+end

data/views/layout.erb

@@ -16,11 +16,15 @@
     <div id="wrapper" style="display:none;">
       <div id="header">
         <a href='<%= base_path %>'>Coverband Admin</a> &nbsp;
+        <a href='<%= base_path %>settings'>Settings</a> &nbsp;
         <%= button("#{base_path}collect_coverage", 'force coverage collection') %> &nbsp;
         <%= button("#{base_path}reload_files", 'reload Coverband files') %> &nbsp;
         <% if Coverband.configuration.web_enable_clear %>
           <%= button("#{base_path}clear", 'clear coverage report', delete: true) %>
         <% end %>
+        <% if Coverband.configuration.web_debug %>
+          <a href='<%= base_path %>debug_data'>Debug Data</a> &nbsp;
+        <% end %>
       </div>
       <% if notice.to_s.length > 0 %>
       <div class="notice"><%= notice %></div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 4.2.0.alpha
+  version: 4.2.0.beta
 platform: ruby
 authors:
 - Dan Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-03 00:00:00.000000000 Z
+date: 2019-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -369,8 +369,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Rack middleware to help measure production code usage (LOC runtime usage)