coverband 5.1.0.rcmailer.2 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 356bd2d155bece44c71e186cc25072ede61e25e3e8236c311cd2c160c93fd6b0
-  data.tar.gz: 609ac60c8757360b59ad63051e14357635bd2395b0ba9ba09add3140505415c7
+  metadata.gz: a5cd2e1c2877aa5eefb57baf7b1c51c5e708ef8d5869f01b51a37c3b6e37c931
+  data.tar.gz: 4f0a6bc520d84917f989b3c13ec1c5bba2d6ab04db26fb87331cfed536b142f9
 SHA512:
-  metadata.gz: 929208aaadba979be02db9eb55153f91515c14bed94c94de7115255ea89413b87547518a6bbf11f250df506f8604dd1f64c9582b6536a4595943fd2692736776
-  data.tar.gz: 37ca9ec442e80223284a4b5e9ec6234d1fbff014270f7b9e905db71a9c7513e700a07417f47a123ecbc4b561b0adc075f2e68dd328763599c0f8b2676c555d08
+  metadata.gz: cb077ceeb315e92dd7f51e355057d855b00701e05d8b4ef7836ff8cae624c2db71ba0ce67ac6e3be5dd5fb87182c4a68d8e8d1ab3c6e4554f2d792db9f214c65
+  data.tar.gz: 0ab9e096d137f1babd34b3cc32899095b6b3f0f87bb0a9aee7d987bf8b116b1815a3fc630ad0f1f73d4550563c2cf08a4bb9e8e20e8c9553dd9246d0dee6414a

data/Gemfile

@@ -7,11 +7,8 @@ gemspec
 
 # add when debugging
 # require 'byebug'; byebug
-if ENV["CI"]
-  # skipping pry-byebug as it has issues on Ruby 2.3 on travis
-  # and we don't really need it on CI
-else
-  gem "pry-byebug", platforms: [:mri, :mingw, :x64_mingw]
+unless ENV["CI"]
+  gem "pry-byebug"
 end
 
 gem "rails", "~>5"

data/README.md

@@ -12,6 +12,7 @@
   <a href="#installation">Installation</a> •
   <a href="#coverband-web-ui">Coverband Web UI</a> •
   <a href="#advanced-config">Advanced Config</a> •
+  <a href="#newer-features">Newer Features</a> •
   <a href="#license">License</a> •
   <a href="/changes.md">Change Log / Roadmap</a> •
   <a href="/CODE_OF_CONDUCT.md">Code of Conduct</a>
@@ -33,6 +34,7 @@ The primary goal of Coverband is giving deep insight into your production runtim
 - Development mode, offers deep insight of code usage details (number of LOC execution during single request, etc) during development.
 - Mountable web interface to easily share reports
 
+
 # Installation
 
 ## Redis
@@ -337,6 +339,30 @@ gem 'coverband', require: ['alternative_coverband_patch']
 
 This conflict happens when a ruby method is patched twice, once using module prepend, and once using method aliasing. See this ruby issue for details. The fix is to apply all patches the same way. Coverband by default will apply its patch using prepend, but you can change that to method aliasing by adding require: ['alternative_coverband_patch'] to the gem line as shown above.
 
+# Newer Features
+
+### Dead Method Scanning (ruby 2.6+)
+
+Rake task that outputs dead methods based on current coverage data:
+
+```
+bundle exec rake coverband:dead_methods
+```
+
+Outputs:
+
+```
+---------------------------------------------------------------------------------------------------
+| file                                  | class           | method                  | line_number |
+| ./config/routes.rb                    | AdminConstraint | matches?                | 20          |
+| ./app/controllers/home_controller.rb  | HomeController  | trigger_jobs            | 8           |
+| ./app/controllers/home_controller.rb  | HomeController  | data_tracer             | 14          |
+| ./app/controllers/posts_controller.rb | PostsController | edit                    | 22          |
+| ./app/controllers/posts_controller.rb | PostsController | destroy_bad_dangerously | 73          |
+---------------------------------------------------------------------------------------------------
+```
+
+
 # Prerequisites
 
 - Coverband 3.0.X+ requires Ruby 2.3+

data/changes.md

@@ -55,19 +55,19 @@ Will be the fully modern release that drops maintenance legacy support in favor
 
 ### Coverband 5.0.4
 
-- ?
+- add support for tracking email view templates/partials
 
 # Released
 
 ### Coverband 5.0.3
 
-- fix for non standard root paths for view_tracker thx @markshawtoronto 
+- fix for non standard root paths for view_tracker thx @markshawtoronto
 - support basic auth for Rack prior to 2.0 thx @kadru
 
 ### Coverband 5.0.2
 
 - change default port of local server
-- update on readme about issue with scout app, thanks @mrbongiolo 
+- update on readme about issue with scout app, thanks @mrbongiolo
 - fix on configuration page not loading when redis can't load
 
 ### Coverband 5.0.1
@@ -82,13 +82,7 @@ Will be the fully modern release that drops maintenance legacy support in favor
   - drops static report support
   - drops gem support
   - only loaded web reporter files when required
-- configuration improvements
-	- improved load order allowing more time for ENV vars (better dotenv, figaro, rails secrets support)
-	- all config options can be set via coverband config, not requiring ENV var support
-	- deprecation notices on soon to be removed config options
-	- config exceptions on invalid configuration combinations
-	- additional testing around configurations
-	- improved defaults and reduced configuration options
+- configuration improvements - improved load order allowing more time for ENV vars (better dotenv, figaro, rails secrets support) - all config options can be set via coverband config, not requiring ENV var support - deprecation notices on soon to be removed config options - config exceptions on invalid configuration combinations - additional testing around configurations - improved defaults and reduced configuration options
 - improved resque patching pattern
 - improved default ignores
 - additional adapters

data/coverband.gemspec

@@ -8,16 +8,18 @@ Gem::Specification.new do |spec|
   spec.name = "coverband"
   spec.version = Coverband::VERSION
   spec.authors = ["Dan Mayer", "Karl Baum"]
-  spec.email = ["dan@mayerdan.com"]
-  spec.description = "Rack middleware to measure production code usage (LOC runtime usage)"
-  spec.summary = "Rack middleware to measure production code usage (LOC runtime usage)"
+  spec.email = %w[dan@mayerdan.com]
+  spec.description =
+    "Rack middleware to measure production code usage (LOC runtime usage)"
+  spec.summary =
+    "Rack middleware to measure production code usage (LOC runtime usage)"
   spec.homepage = "https://github.com/danmayer/coverband"
   spec.license = "MIT"
 
   spec.files = `git ls-files`.split("\n").reject { |f| f.start_with?("docs") }
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = %w[lib]
 
   spec.add_development_dependency "benchmark-ips"
   spec.add_development_dependency "capybara"

data/lib/coverband/utils/dead_methods.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: ntrue
+
+require "coverband/utils/method_definition_scanner"
+
+module Coverband
+  module Utils
+    module ArrayToTableInConsole
+      refine Array do
+        def to_table
+          column_sizes =
+            reduce([]) { |lengths, row|
+              row.each_with_index.map do |iterand, index|
+                [lengths[index] || 0, iterand.to_s.length].max
+              end
+            }
+          puts head =
+                 "-" * (column_sizes.inject(&:+) + (3 * column_sizes.count) + 1)
+          each do |row|
+            row = row.fill(nil, row.size..(column_sizes.size - 1))
+            row =
+              row.each_with_index.map { |v, i|
+                v.to_s + " " * (column_sizes[i] - v.to_s.length)
+              }
+            puts "| " + row.join(" | ") + " |"
+          end
+          puts head
+        end
+      end
+    end
+
+    class DeadMethods
+      using ArrayToTableInConsole
+      def self.scan(file_path:, coverage:)
+        MethodDefinitionScanner.scan(file_path).reject do |method_definition|
+          method_definition.body.coverage?(coverage)
+        end
+      end
+
+      def self.scan_all
+        coverage = Coverband.configuration.store.coverage
+        coverage.flat_map do |file_path, coverage|
+          scan(file_path: file_path, coverage: coverage["data"])
+        end
+      end
+
+      def self.output_all
+        rows =
+          scan_all.each_with_object(
+            [%w[file class method line_number]]
+          ) { |dead_method, rows|
+            rows <<
+              [
+                dead_method.file_path,
+                dead_method.class_name,
+                dead_method.name,
+                dead_method.first_line_number
+              ]
+          }
+        rows.to_table
+      end
+    end
+  end
+end

data/lib/coverband/utils/method_definition_scanner.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+if defined?(RubyVM::AbstractSyntaxTree)
+  module Coverband
+    module Utils
+      class MethodDefinitionScanner
+        attr_reader :path
+
+        def initialize(path)
+          @path = path
+        end
+
+        def scan
+          scan_node(RubyVM::AbstractSyntaxTree.parse_file(path), nil)
+        end
+
+        def self.scan(path)
+          new(path).scan
+        end
+
+        class MethodBody
+          def initialize(method_definition)
+            @method_definition = method_definition
+          end
+
+          def coverage?(file_coverage)
+            body_coverage =
+              file_coverage[(first_line_number - 1)..(last_line_number - 1)]
+            body_coverage.map(&:to_i).any?(&:positive?)
+          end
+
+          private
+
+          def first_line_number
+            @method_definition.first_line_number + 1
+          end
+
+          def last_line_number
+            @method_definition.last_line_number - 1
+          end
+        end
+
+        class MethodDefinition
+          attr_reader :last_line_number,
+            :first_line_number,
+            :name,
+            :class_name,
+            :file_path
+
+          def initialize(
+            first_line_number:,
+            last_line_number:,
+            name:,
+            class_name:,
+            file_path:
+          )
+            @first_line_number = first_line_number
+            @last_line_number = last_line_number
+            @name = name
+            @class_name = class_name
+            @file_path = file_path
+          end
+
+          def body
+            MethodBody.new(self)
+          end
+        end
+
+        private
+
+        def scan_node(node, class_name)
+          definitions = []
+          return definitions unless node.is_a?(RubyVM::AbstractSyntaxTree::Node)
+          current_class = node.type == :CLASS ? node.children.first.children.last : class_name
+          if node.type == :DEFN
+            definitions <<
+              MethodDefinition.new(
+                first_line_number: node.first_lineno,
+                last_line_number: node.last_lineno,
+                name: node.children.first,
+                class_name: current_class,
+                file_path: path
+              )
+          end
+          definitions + scan_children(node, current_class)
+        end
+
+        def scan_children(node, current_class)
+          node.children.flatten.compact.map { |child|
+            scan_node(child, current_class)
+          }.flatten
+        end
+      end
+    end
+  end
+end

data/lib/coverband/utils/tasks.rb

@@ -9,11 +9,25 @@ namespace :coverband do
     Coverband::Reporters::ConsoleReport.report(Coverband.configuration.store)
   end
 
+  if defined?(RubyVM::AbstractSyntaxTree)
+    require "coverband/utils/dead_methods"
+
+    desc "Output all dead methods"
+    task :dead_methods do
+      Coverband::Utils::DeadMethods.output_all
+    end
+  end
+
   desc "report runtime Coverband code coverage"
   task :coverage_server do
-    Rake.application["environment"].invoke if Rake::Task.task_defined?("environment")
-    Coverband.configuration.store.merge_mode = true if Coverband.configuration.store.is_a?(Coverband::Adapters::FileStore)
-    Rack::Server.start app: Coverband::Reporters::Web.new, Port: ENV.fetch("COVERBAND_COVERAGE_PORT", 9022).to_i
+    if Rake::Task.task_defined?("environment")
+      Rake.application["environment"].invoke
+    end
+    if Coverband.configuration.store.is_a?(Coverband::Adapters::FileStore)
+      Coverband.configuration.store.merge_mode = true
+    end
+    Rack::Server.start app: Coverband::Reporters::Web.new,
+                       Port: ENV.fetch("COVERBAND_COVERAGE_PORT", 9022).to_i
   end
 
   ###

data/lib/coverband/version.rb

@@ -5,5 +5,5 @@
 # use format '4.2.1.rc.1' ~> 4.2.1.rc to prerelease versions like v4.2.1.rc.2 and v4.2.1.rc.3
 ###
 module Coverband
-  VERSION = "5.1.0.rcmailer.2"
+  VERSION = '5.1.0'
 end

data/test/coverband/utils/dead_methods_test.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require File.expand_path("../../test_helper", File.dirname(__FILE__))
+
+if defined?(RubyVM::AbstractSyntaxTree)
+  require "coverband/utils/dead_methods"
+  module Coverband
+    module Utils
+      class DeadMethodsTest < Minitest::Test
+        attr_accessor :coverband
+
+        def setup
+          super
+          @coverband = Coverband::Collectors::Coverage.instance
+        end
+
+        def test_dog_dead_methods
+          file_path = require_unique_file
+          coverage = [nil, nil, 1, 1, 0, nil, nil]
+          dead_methods =
+            DeadMethods.scan(file_path: file_path, coverage: coverage)
+          assert_equal(1, dead_methods.length)
+          dead_method = dead_methods.first
+          assert_equal(4, dead_method.first_line_number)
+          assert_equal(6, dead_method.last_line_number)
+          assert_equal(file_path, dead_method.file_path)
+        end
+
+        def test_all_dead_methods
+          require_unique_file
+          @coverband.report_coverage
+          dead_methods = DeadMethods.scan_all
+          dead_method = dead_methods.find { |method| method.class_name == :Dog }
+          assert(dead_method)
+          assert_equal(4, dead_method.first_line_number)
+          assert_equal(6, dead_method.last_line_number)
+        end
+
+        def test_output_all
+          require_unique_file
+          @coverband.report_coverage
+          DeadMethods.output_all
+        end
+
+        def test_dog_methods_not_dead
+          file = require_unique_file
+          coverage = [nil, nil, 1, 1, 1, nil, nil]
+          assert_empty(DeadMethods.scan(file_path: file, coverage: coverage))
+        end
+      end
+    end
+  end
+end

data/test/coverband/utils/method_definition_scanner_test.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require File.expand_path("../../test_helper", File.dirname(__FILE__))
+
+if defined?(RubyVM::AbstractSyntaxTree)
+  require "coverband/utils/method_definition_scanner"
+  module Coverband
+    module Utils
+      class MethodBodyTest < Minitest::Test
+        def test_no_method_body_coverage
+          method_body =
+            MethodDefinitionScanner::MethodBody.new(
+              MethodDefinitionScanner::MethodDefinition.new(
+                first_line_number: 4,
+                last_line_number: 6,
+                name: :bark,
+                class_name: :Dog,
+                file_path: "./test/dog.rb"
+              )
+            )
+          refute(method_body.coverage?([nil, nil, 1, 1, 0, nil, 1]))
+        end
+
+        def test_method_body_coverage
+          method_body =
+            MethodDefinitionScanner::MethodBody.new(
+              MethodDefinitionScanner::MethodDefinition.new(
+                first_line_number: 4,
+                last_line_number: 6,
+                name: :bark,
+                class_name: :Dog,
+                file_path: "./test/dog.rb"
+              )
+            )
+          assert(method_body.coverage?([nil, nil, 1, 1, 1, nil, 1]))
+        end
+      end
+
+      class MethodDefinitionScannerTest < Minitest::Test
+        def test_scan
+          method_definitions = MethodDefinitionScanner.scan("./test/dog.rb")
+          assert(method_definitions)
+          assert_equal(1, method_definitions.length)
+          method_definition = method_definitions.first # assert_equal(4, method.first_line)
+          assert_equal(4, method_definition.first_line_number)
+          assert_equal(6, method_definition.last_line_number)
+          assert_equal(:bark, method_definition.name)
+          assert_equal(:Dog, method_definition.class_name)
+        end
+
+        def test_scan_large_class
+          method_definitions =
+            MethodDefinitionScanner.scan("./test/fixtures/casting_invitor.rb")
+          method_first_line_numbers =
+            method_definitions.map(&:first_line_number)
+          assert_equal(
+            [6, 13, 17, 35, 40, 44, 48, 52],
+            method_first_line_numbers
+          )
+          method_last_line_numbers = method_definitions.map(&:last_line_number)
+          assert_equal(
+            [11, 15, 31, 38, 42, 46, 50, 59],
+            method_last_line_numbers
+          )
+          method_names = method_definitions.map(&:name)
+          assert_equal(
+            %i[
+              initialize
+              valid?
+              deliver
+              invalid_invitees
+              invitee_list
+              valid_message?
+              valid_invitees?
+              create_invitation
+            ],
+            method_names
+          )
+          class_names = method_definitions.map(&:class_name)
+          assert_equal(8.times.map { :CastingInviter }, class_names)
+        end
+      end
+    end
+  end
+end

data/test/fixtures/casting_invitor.rb

@@ -0,0 +1,60 @@
+class CastingInviter
+  EMAIL_REGEX = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/
+
+  attr_reader :message, :invitees, :casting
+
+  def initialize(attributes = {})
+    @message = attributes[:message] || ""
+    @invitees = attributes[:invitees] || ""
+    @sender = attributes[:sender]
+    @casting = attributes[:casting]
+  end
+
+  def valid?
+    valid_message? && valid_invitees?
+  end
+
+  def deliver
+    if valid?
+      invitee_list.each do |email|
+        invitation = create_invitation(email)
+        Mailer.invitation_notification(invitation, @message)
+      end
+    else
+      failure_message =
+        "Your #{
+          @casting
+        } message couldn’t be sent. Invitees emails or message are invalid"
+      invitation = create_invitation(@sender)
+      Mailer.invitation_notification(invitation, failure_message)
+    end
+  end
+
+  private
+
+  def invalid_invitees
+    @invalid_invitees ||=
+      invitee_list.map { |item| item unless item.match(EMAIL_REGEX) }.compact
+  end
+
+  def invitee_list
+    @invitee_list ||= @invitees.gsub(/\s+/, "").split(/[\n,;]+/)
+  end
+
+  def valid_message?
+    @message.present?
+  end
+
+  def valid_invitees?
+    invalid_invitees.empty?
+  end
+
+  def create_invitation(email)
+    Invitation.create(
+      casting: @casting,
+      sender: @sender,
+      invitee_email: email,
+      status: "pending"
+    )
+  end
+end

data/test/test_helper.rb

@@ -3,6 +3,7 @@
 original_verbosity = $VERBOSE
 $VERBOSE = nil
 require "rubygems"
+require "pry-byebug" unless ENV["CI"]
 require "simplecov"
 require "coveralls"
 require "minitest/autorun"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 5.1.0.rcmailer.2
+  version: 5.1.0
 platform: ruby
 authors:
 - Dan Mayer
 - Karl Baum
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -312,11 +312,13 @@ files:
 - lib/coverband/reporters/html_report.rb
 - lib/coverband/reporters/web.rb
 - lib/coverband/utils/absolute_file_converter.rb
+- lib/coverband/utils/dead_methods.rb
 - lib/coverband/utils/file_hasher.rb
 - lib/coverband/utils/file_list.rb
 - lib/coverband/utils/html_formatter.rb
 - lib/coverband/utils/jruby_ext.rb
 - lib/coverband/utils/lines_classifier.rb
+- lib/coverband/utils/method_definition_scanner.rb
 - lib/coverband/utils/railtie.rb
 - lib/coverband/utils/relative_file_converter.rb
 - lib/coverband/utils/result.rb
@@ -385,10 +387,12 @@ files:
 - test/coverband/reporters/html_test.rb
 - test/coverband/reporters/web_test.rb
 - test/coverband/utils/absolute_file_converter_test.rb
+- test/coverband/utils/dead_methods_test.rb
 - test/coverband/utils/file_hasher_test.rb
 - test/coverband/utils/file_list_test.rb
 - test/coverband/utils/html_formatter_test.rb
 - test/coverband/utils/lines_classifier_test.rb
+- test/coverband/utils/method_definition_scanner_test.rb
 - test/coverband/utils/relative_file_converter_test.rb
 - test/coverband/utils/result_test.rb
 - test/coverband/utils/results_test.rb
@@ -399,6 +403,7 @@ files:
 - test/fake_app/basic_rack.rb
 - test/fixtures/app/controllers/sample_controller.rb
 - test/fixtures/app/models/user.rb
+- test/fixtures/casting_invitor.rb
 - test/fixtures/never.rb
 - test/fixtures/sample.rb
 - test/fixtures/skipped.rb
@@ -468,7 +473,7 @@ homepage: https://github.com/danmayer/coverband
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -479,12 +484,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Rack middleware to measure production code usage (LOC runtime usage)
 test_files:
@@ -517,10 +522,12 @@ test_files:
 - test/coverband/reporters/html_test.rb
 - test/coverband/reporters/web_test.rb
 - test/coverband/utils/absolute_file_converter_test.rb
+- test/coverband/utils/dead_methods_test.rb
 - test/coverband/utils/file_hasher_test.rb
 - test/coverband/utils/file_list_test.rb
 - test/coverband/utils/html_formatter_test.rb
 - test/coverband/utils/lines_classifier_test.rb
+- test/coverband/utils/method_definition_scanner_test.rb
 - test/coverband/utils/relative_file_converter_test.rb
 - test/coverband/utils/result_test.rb
 - test/coverband/utils/results_test.rb
@@ -531,6 +538,7 @@ test_files:
 - test/fake_app/basic_rack.rb
 - test/fixtures/app/controllers/sample_controller.rb
 - test/fixtures/app/models/user.rb
+- test/fixtures/casting_invitor.rb
 - test/fixtures/never.rb
 - test/fixtures/sample.rb
 - test/fixtures/skipped.rb