usps-support 0.2.13 → 0.2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e225f56b0f2b17cbce8ea9137659b586d8ff4c796a083ec5db20d35f8c26cfb4
-  data.tar.gz: 590d80b46235f48e09d6d3fc7e6cae11bb54067ee044e4b9b4d58d9e22fc1d86
+  metadata.gz: 06f5b7ef7a2a7b3899721c10fe6a0bdf0d75f3dd04b21cb31c6acdb47908b314
+  data.tar.gz: 2557beb4fe11739cbd23aeb977fde8637f821c1e41613a1c8bf2a9ed45d56249
 SHA512:
-  metadata.gz: 79cea6dfcd0103ce0216a46dbe63a17e52703a7cf98bf583c6badc189c528d73d090f4fdc9d4caeda2e59837a5967f596939c9fe2b697bd2c80124592cb12866
-  data.tar.gz: 55b2469eaf39c0dd8cd300fe6c24503bb16746854a038cac55cd13c5e63e47726f3360f4a59e669b570bcb61c65a331520b8f45c55ff44bc2878a85b762324f2
+  metadata.gz: a67296ed9f3f3e85bfc4e01ec8d7bdf6fb1a5b347ba32e64273f9c8ae9445a4d0d8b223600eea5c14e400e0da75030cdad94fdd6a9e7db8e52dde74de82b1932
+  data.tar.gz: 25b0c7077bc8ada1775b16bb8bcf8dfe71ac3acd29f37c7899294305ec4aa58ddd1f8b690a99b4f22ef6a177f1e6962b7c07fe015f208a05d5016164ab53d67c

data/lib/usps/support/lib/simple_cov/filters_parser.rb

@@ -0,0 +1,84 @@
+module Usps::Support::Lib::SimpleCov
+  # Parser for converting hash filter definition into individual coverage filters
+  #
+  # Example config:
+  #
+  # {
+  #   ignored_category_header: {
+  #     spec: '*',
+  #     app: {
+  #       controllers: %w[example_1],
+  #       helpers: 'example_2',
+  #       models: {
+  #         members: %w[example_3],
+  #         _: %w[example_4]
+  #       }
+  #     }
+  #   }
+  # }
+  #
+  # This config would generate the following coverage filters:
+  #
+  #   - `/spec`
+  #   - `/app/controllers/example_1.rb`
+  #   - `/app/helpers/example_2.rb`
+  #   - `/app/models/members/example_3.rb`
+  #   - `/app/models/example_4.rb`
+  #
+  class FiltersParser
+    attr_reader :filters_config
+
+    def self.paths(...) = new(...).paths
+
+    def initialize(filters_config)
+      @filters_config = filters_config
+      @dir = []
+      @paths = []
+    end
+
+    def paths
+      return @paths if @paths.any?
+
+      filters_config.each_value { parse_data(it) }
+
+      @paths
+    end
+
+  private
+
+    def parse_data(data)
+      case data
+      when '*' then filter_dir
+      when String then filter_file(data)
+      when Array then data.each { filter_file(it) }
+      when Hash then walk(data)
+      else
+        raise "Unrecognized filter format: #{data.inspect}"
+      end
+    end
+
+    def walk(hash)
+      hash.each do |dir, sub_data|
+        with(dir) { parse_data(sub_data) }
+      end
+    end
+
+    def with(dir)
+      @dir << dir.to_s
+      yield
+      @dir.pop
+    end
+
+    def filter_dir
+      @paths << dir_path
+    end
+
+    def filter_file(filename)
+      @paths << File.join(dir_path, "#{filename}.rb")
+    end
+
+    def dir_path
+      "/#{File.join(@dir)}".sub(%r{/_}, '') if @dir.any?
+    end
+  end
+end

data/lib/usps/support/lib/simple_cov/uncovered_lines_formatter.rb

@@ -0,0 +1,49 @@
+module Usps::Support::Lib::SimpleCov
+  # Simple coverage formatter to display paths of any uncovered lines
+  #
+  # Intended to make it quicker to know what was uncovered, especially when
+  # running in GitHub Actions
+  #
+  # rubocop:disable Rails/Output
+  class UncoveredLinesFormatter
+    attr_reader :uncovered_files
+
+    def format(result)
+      @uncovered_files = result.files.reject { it.missed_lines.empty? }
+      return unless uncovered_files.any?
+
+      puts 'Uncovered lines:'
+      uncovered_files.each { report(it) }
+    end
+
+  private
+
+    def report(file)
+      missed = pad(file.missed_lines.size)
+      total = pad(file.lines_of_code)
+      percent = file.covered_percent.round(2).to_s.rjust(5, ' ')
+
+      puts "  [#{missed} / #{total} : #{percent}%] #{file.filename}"
+      puts "    Lines: #{line_number_ranges(file).join(', ')}"
+    end
+
+    def pad(number) = number.to_s.rjust(max_line_count_length, ' ')
+
+    def max_line_count_length
+      @max_line_count_length ||= uncovered_files.map(&:lines_of_code).max.to_s.length
+    end
+
+    def line_number_ranges(file)
+      file
+        .missed_lines
+        .map(&:line_number)
+        .chunk
+        .with_index { |number, index| number - index }
+        .map do |_diff, group|
+          first, *, last = group
+          last.nil? ? first : "#{first}-#{last}"
+        end
+    end
+  end
+  # rubocop:enable Rails/Output
+end

data/lib/usps/support/lib/simple_cov.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Usps::Support::Lib
+  # SimpleCov extensions
+  #
+  module SimpleCov; end
+end
+
+require_relative 'simple_cov/filters_parser'
+require_relative 'simple_cov/uncovered_lines_formatter'

data/lib/usps/support/lib.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Shared Rails libraries
+#
+module Usps::Support::Lib; end
+
+require_relative 'lib/simple_cov'

data/lib/usps/support/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Support
-    VERSION = '0.2.13'
+    VERSION = '0.2.15'
   end
 end

data/lib/usps/support.rb

@@ -12,6 +12,7 @@ end
 
 require_relative 'support/helpers'
 require_relative 'support/models'
+require_relative 'support/lib'
 
 # :nocov:
 require 'usps/support/railtie' if defined?(Rails)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-support
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.2.15
 platform: ruby
 authors:
 - Julian Fiander
@@ -69,6 +69,10 @@ files:
 - lib/usps/support/helpers/git_helper.rb
 - lib/usps/support/helpers/react_helper.rb
 - lib/usps/support/helpers/scss_helper.rb
+- lib/usps/support/lib.rb
+- lib/usps/support/lib/simple_cov.rb
+- lib/usps/support/lib/simple_cov/filters_parser.rb
+- lib/usps/support/lib/simple_cov/uncovered_lines_formatter.rb
 - lib/usps/support/models.rb
 - lib/usps/support/models/dynamo_db.rb
 - lib/usps/support/models/git_hub.rb