feature_map 1.2.2 → 1.2.3

data/lib/feature_map/private/test_coverage_file.rb

@@ -1,4 +1,3 @@
-# typed: strict
 # frozen_string_literal: true
 
 module FeatureMap
@@ -9,44 +8,21 @@ module FeatureMap
     # a variety of engineering team utilities (e.g. PR/release announcements, documentation generation, etc).
     #
     class TestCoverageFile
-      extend T::Sig
-
-      COVERAGE_RATIO = 'coverage_ratio'
-
       class FileContentError < StandardError; end
 
+      COVERAGE_RATIO = 'coverage_ratio'
       FEATURES_KEY = 'features'
 
-      FeatureName = T.type_alias { String }
-      CoverageStat = T.type_alias { String }
-
-      FeatureCoverage = T.type_alias do
-        T::Hash[
-          CoverageStat,
-          Integer
-        ]
-      end
-
-      FeaturesContent = T.type_alias do
-        T::Hash[
-          FeatureName,
-          FeatureCoverage
-        ]
-      end
-
-      sig { params(coverage_stats: CodeCov::TestCoverageStats).void }
       def self.write!(coverage_stats)
         FileUtils.mkdir_p(path.dirname) if !path.dirname.exist?
 
         path.write([header_comment, "\n", generate_content(coverage_stats).to_yaml].join)
       end
 
-      sig { returns(Pathname) }
       def self.path
         Pathname.pwd.join('.feature_map/test-coverage.yml')
       end
 
-      sig { returns(String) }
       def self.header_comment
         <<~HEADER
           # STOP! - DO NOT EDIT THIS FILE MANUALLY
@@ -61,34 +37,31 @@ module FeatureMap
         HEADER
       end
 
-      sig { params(coverage_stats: CodeCov::TestCoverageStats).returns(T::Hash[String, FeaturesContent]) }
       def self.generate_content(coverage_stats)
-        feature_test_coverage = T.let({}, FeaturesContent)
+        feature_test_coverage = {}
 
         Private.feature_file_assignments.each do |feature_name, files|
-          feature_test_coverage[feature_name] = T.let({ 'lines' => 0, 'hits' => 0, 'misses' => 0, 'coverage_ratio' => 0 }, FeatureCoverage)
+          feature_test_coverage[feature_name] = { 'lines' => 0, 'hits' => 0, 'misses' => 0, 'coverage_ratio' => 0 }
 
-          files.each_with_object(T.must(feature_test_coverage[feature_name])) do |file_path, coverage|
+          files.each_with_object(feature_test_coverage[feature_name]) do |file_path, coverage|
             next unless coverage_stats[file_path]
 
-            coverage['lines'] = T.must(coverage['lines']) + (T.must(coverage_stats[file_path])['lines'] || 0)
-            coverage['hits'] = T.must(coverage['hits']) + (T.must(coverage_stats[file_path])['hits'] || 0)
-            coverage['misses'] = T.must(coverage['misses']) + (T.must(coverage_stats[file_path])['misses'] || 0)
+            coverage['lines'] = coverage['lines'] + (coverage_stats[file_path]['lines'] || 0)
+            coverage['hits'] = coverage['hits'] + (coverage_stats[file_path]['hits'] || 0)
+            coverage['misses'] = coverage['misses'] + (coverage_stats[file_path]['misses'] || 0)
 
             coverage
           end
-
-          T.must(feature_test_coverage[feature_name])[COVERAGE_RATIO] = if T.must(T.must(feature_test_coverage[feature_name])['lines']).zero?
-                                                                          0
-                                                                        else
-                                                                          ((T.must(feature_test_coverage[feature_name])['hits'].to_f / T.must(T.must(feature_test_coverage[feature_name])['lines'])) * 100).round
-                                                                        end
+          feature_test_coverage[feature_name][COVERAGE_RATIO] = if feature_test_coverage[feature_name]['lines'].zero?
+                                                                  0
+                                                                else
+                                                                  ((feature_test_coverage[feature_name]['hits'].to_f / feature_test_coverage[feature_name]['lines']) * 100).round
+                                                                end
         end
 
         { FEATURES_KEY => feature_test_coverage }
       end
 
-      sig { returns(FeaturesContent) }
       def self.load_features!
         test_coverage_content = YAML.load_file(path)
 

data/lib/feature_map/private/test_pyramid_file.rb

@@ -1,4 +1,3 @@
-# typed: strict
 # frozen_string_literal: true
 
 module FeatureMap
@@ -9,37 +8,10 @@ module FeatureMap
     # (e.g. PR/release announcements, documentation generation, etc).
     #
     class TestPyramidFile
-      extend T::Sig
-
       class FileContentError < StandardError; end
 
       FEATURES_KEY = 'features'
 
-      FeatureName = T.type_alias { String }
-      PyramidStat = T.type_alias { String }
-
-      FeaturePyramid = T.type_alias do
-        T::Hash[
-          PyramidStat,
-          Integer
-        ]
-      end
-
-      FeaturesContent = T.type_alias do
-        T::Hash[
-          FeatureName,
-          FeaturePyramid
-        ]
-      end
-
-      sig do
-        params(
-          unit_examples: T::Array[T::Hash[T.untyped, T.untyped]],
-          integration_examples: T::Array[T::Hash[T.untyped, T.untyped]],
-          regression_examples: T::Array[T::Hash[T.untyped, T.untyped]],
-          regression_assignments: T::Hash[T.untyped, T.untyped]
-        ).void
-      end
       def self.write!(unit_examples, integration_examples, regression_examples, regression_assignments)
         FileUtils.mkdir_p(path.dirname) if !path.dirname.exist?
 
@@ -56,12 +28,10 @@ module FeatureMap
         path.write([header_comment, "\n", { FEATURES_KEY => content }.to_yaml].join)
       end
 
-      sig { returns(Pathname) }
       def self.path
         Pathname.pwd.join('.feature_map/test-pyramid.yml')
       end
 
-      sig { returns(String) }
       def self.header_comment
         <<~HEADER
           # STOP! - DO NOT EDIT THIS FILE MANUALLY
@@ -76,14 +46,6 @@ module FeatureMap
         HEADER
       end
 
-      sig do
-        params(
-          unit_examples: T::Hash[T.untyped, T.untyped],
-          integration_examples: T::Hash[T.untyped, T.untyped],
-          regression_examples: T::Hash[T.untyped, T.untyped],
-          regression_file_assignments: T::Hash[T.untyped, T.untyped]
-        ).returns(FeaturesContent)
-      end
       def self.generate_content(unit_examples, integration_examples, regression_examples, regression_file_assignments)
         Private.feature_file_assignments.reduce({}) do |content, (feature_name, files)|
           regression_files = regression_file_assignments[feature_name] || []
@@ -118,7 +80,6 @@ module FeatureMap
         end
       end
 
-      sig { returns(FeaturesContent) }
       def self.load_features!
         test_coverage_content = YAML.load_file(path)
 
@@ -131,14 +92,12 @@ module FeatureMap
         raise FileContentError, "No feature test coverage file found at #{path}. Use `bin/featuremap test_coverage` to generate it and try again."
       end
 
-      sig { params(examples: T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])).returns(T::Array[Integer]) }
       def self.split(examples)
         return [0, 0] if examples.nil?
 
         examples.partition { |ex| ex['status'] == 'passed' }.map(&:count)
       end
 
-      sig { params(pathlike: String).returns(String) }
       def self.filepath(pathlike)
         File
           .join(File.dirname(pathlike), File.basename(pathlike, '.*'))

data/lib/feature_map/private/todo_inspector.rb

@@ -1,50 +1,36 @@
-# typed: strict
 # frozen_string_literal: true
 
 module FeatureMap
   module Private
     class TodoInspector
-      extend T::Sig
-
-      ENTERING_COMMENT = T.let(
-        /
-          (#{(Constants::SINGLE_LINE_COMMENT_PATTERNS + Constants::MULTILINE_COMMENT_START_PATTERNS).join('|')})
-        /x.freeze,
-        Regexp
-      )
-
-      EXITING_COMMENT = T.let(
-        /
-          (#{(Constants::SINGLE_LINE_COMMENT_PATTERNS + Constants::MULTILINE_COMMENT_END_PATTERNS).join('|')})
-        /x.freeze,
-        Regexp
-      )
-
-      TODO_PATTERN = T.let(
-        /
-          TODO:?\s* # TODO with optional colon with whitespace
-          (?<content>.*?) # The actual TODO content
-          (#{Constants::MULTILINE_COMMENT_END_PATTERNS.join('|')})?$ # ignores comment end patterns
-        /xi.freeze,
-        Regexp
-      )
-
-      sig { params(file_path: String).void }
+      ENTERING_COMMENT = /
+        (#{(Constants::SINGLE_LINE_COMMENT_PATTERNS + Constants::MULTILINE_COMMENT_START_PATTERNS).join('|')})
+      /x.freeze
+
+      EXITING_COMMENT = /
+        (#{(Constants::SINGLE_LINE_COMMENT_PATTERNS + Constants::MULTILINE_COMMENT_END_PATTERNS).join('|')})
+      /x.freeze
+
+      TODO_PATTERN = /
+        TODO:?\s* # TODO with optional colon with whitespace
+        (?<content>.*?) # The actual TODO content
+        (#{Constants::MULTILINE_COMMENT_END_PATTERNS.join('|')})?$ # ignores comment end patterns
+      /xi.freeze
+
       def initialize(file_path)
         @file_path = file_path
       end
 
-      sig { returns(T::Hash[String, String]) }
       def calculate
         todos = {}
         content = File.read(@file_path)
-        in_comment = T.let(false, T::Boolean)
+        in_comment = false
 
         content.each_line.with_index do |line, index|
           in_comment ||= line.match?(ENTERING_COMMENT)
 
           if in_comment && (match = line.match(TODO_PATTERN))
-            todos["#{@file_path}:#{index + 1}"] = T.must(match[:content]).strip
+            todos["#{@file_path}:#{index + 1}"] = match[:content].strip
           end
 
           in_comment &&= !line.match?(EXITING_COMMENT)

data/lib/feature_map/private/validations/features_up_to_date.rb

@@ -1,14 +1,9 @@
-# typed: strict
-
 module FeatureMap
   module Private
     module Validations
       class FeaturesUpToDate
-        extend T::Sig
-        extend T::Helpers
         include Validator
 
-        sig { override.params(files: T::Array[String], autocorrect: T::Boolean, stage_changes: T::Boolean).returns(T::Array[String]) }
         def validation_errors(files:, autocorrect: true, stage_changes: true)
           return [] if Private.configuration.skip_features_validation
 
@@ -16,7 +11,7 @@ module FeatureMap
           expected_content_lines = AssignmentsFile.expected_contents_lines
 
           features_file_up_to_date = actual_content_lines == expected_content_lines
-          errors = T.let([], T::Array[String])
+          errors = []
 
           if !features_file_up_to_date
             if autocorrect

data/lib/feature_map/private/validations/files_have_features.rb

@@ -1,16 +1,11 @@
-# typed: strict
-
 require 'code_ownership'
 
 module FeatureMap
   module Private
     module Validations
       class FilesHaveFeatures
-        extend T::Sig
-        extend T::Helpers
         include Validator
 
-        sig { override.params(files: T::Array[String], autocorrect: T::Boolean, stage_changes: T::Boolean).returns(T::Array[String]) }
         def validation_errors(files:, autocorrect: true, stage_changes: true)
           cache = Private.glob_cache
           file_mappings = cache.mapper_descriptions_that_map_files(files)
@@ -18,14 +13,14 @@ module FeatureMap
             mapper_descriptions.count.zero?
           end
 
-          errors = T.let([], T::Array[String])
+          errors = []
 
           # When a set of teams are configured that require assignments, ignore any files NOT
           # assigned to one of these teams.
           unless Private.configuration.require_assignment_for_teams.nil?
             files_not_mapped_at_all.filter! do |file, _mappers|
               file_team = CodeOwnership.for_file(file)
-              file_team && T.must(Private.configuration.require_assignment_for_teams).include?(file_team.name)
+              file_team && Private.configuration.require_assignment_for_teams.include?(file_team.name)
             end
           end
 

data/lib/feature_map/private/validations/files_have_unique_features.rb

@@ -1,14 +1,9 @@
-# typed: strict
-
 module FeatureMap
   module Private
     module Validations
       class FilesHaveUniqueFeatures
-        extend T::Sig
-        extend T::Helpers
         include Validator
 
-        sig { override.params(files: T::Array[String], autocorrect: T::Boolean, stage_changes: T::Boolean).returns(T::Array[String]) }
         def validation_errors(files:, autocorrect: true, stage_changes: true)
           cache = Private.glob_cache
           file_mappings = cache.mapper_descriptions_that_map_files(files)
@@ -16,7 +11,7 @@ module FeatureMap
             mapper_descriptions.count > 1
           end
 
-          errors = T.let([], T::Array[String])
+          errors = []
 
           if files_mapped_by_multiple_mappers.any?
             errors << <<~MSG

data/lib/feature_map/private.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# typed: strict
-
 require 'code_ownership'
 require 'csv'
 
@@ -11,6 +9,8 @@ require 'feature_map/private/cyclomatic_complexity_calculator'
 require 'feature_map/private/lines_of_code_calculator'
 require 'feature_map/private/todo_inspector'
 require 'feature_map/private/feature_metrics_calculator'
+require 'feature_map/private/health_calculator'
+require 'feature_map/private/percentile_metrics_calculator'
 require 'feature_map/private/assignments_file'
 require 'feature_map/private/assignment_applicator'
 require 'feature_map/private/metrics_file'
@@ -33,45 +33,29 @@ require 'feature_map/private/release_notification_builder'
 
 module FeatureMap
   module Private
-    extend T::Sig
-
-    FeatureName = T.type_alias { String }
-    FileList = T.type_alias { T::Array[String] }
-    FeatureFiles = T.type_alias do
-      T::Hash[
-        FeatureName,
-        FileList
-      ]
-    end
-
-    sig { params(assignments_file_path: String).void }
     def self.apply_assignments!(assignments_file_path)
       assignments = CSV.read(assignments_file_path)
       AssignmentApplicator.apply_assignments!(assignments)
     end
 
-    sig { returns(Configuration) }
     def self.configuration
-      @configuration ||= T.let(@configuration, T.nilable(Configuration))
       @configuration ||= Configuration.fetch
     end
 
     # This is just an alias for `configuration` that makes it more explicit what we're doing instead of just calling `configuration`.
     # This is necessary because configuration may contain extensions of feature map, so those extensions should be loaded prior to
     # calling APIs that provide feature assignment information.
-    sig { returns(Configuration) }
+
     def self.load_configuration!
       configuration
     end
 
-    sig { void }
     def self.bust_caches!
       @configuration = nil
       @tracked_files = nil
       @glob_cache = nil
     end
 
-    sig { params(files: T::Array[String], autocorrect: T::Boolean, stage_changes: T::Boolean).void }
     def self.validate!(files:, autocorrect: true, stage_changes: true)
       AssignmentsFile.update_cache!(files) if AssignmentsFile.use_features_cache?
 
@@ -91,7 +75,6 @@ module FeatureMap
       MetricsFile.write!
     end
 
-    sig { params(git_ref: T.nilable(String)).void }
     def self.generate_docs!(git_ref)
       feature_assignments = AssignmentsFile.load_features!
       feature_metrics = MetricsFile.load_features!
@@ -115,18 +98,10 @@ module FeatureMap
         feature_test_pyramid,
         feature_additional_metrics,
         configuration.raw_hash,
-        T.must(git_ref || configuration.repository['main_branch'])
+        git_ref || configuration.repository['main_branch']
       )
     end
 
-    sig do
-      params(
-        unit_path: String,
-        integration_path: String,
-        regression_path: T.nilable(String),
-        regression_assignments_path: T.nilable(String)
-      ).void
-    end
     def self.generate_test_pyramid!(unit_path, integration_path, regression_path, regression_assignments_path)
       unit_examples = JSON.parse(File.read(unit_path))&.fetch('examples')
       integration_examples = JSON.parse(File.read(integration_path))&.fetch('examples')
@@ -135,14 +110,12 @@ module FeatureMap
       TestPyramidFile.write!(unit_examples, integration_examples, regression_examples, regression_assignments)
     end
 
-    sig { params(commit_sha: String, code_cov_token: String).void }
     def self.gather_test_coverage!(commit_sha, code_cov_token)
       coverage_stats = CodeCov.fetch_coverage_stats(commit_sha, code_cov_token)
 
       TestCoverageFile.write!(coverage_stats)
     end
 
-    sig { void }
     def self.generate_additional_metrics!
       feature_metrics = MetricsFile.load_features!
       feature_test_coverage = TestCoverageFile.path.exist? ? TestCoverageFile.load_features! : {}
@@ -152,7 +125,6 @@ module FeatureMap
 
     # Returns a string version of the relative path to a Rails constant,
     # or nil if it can't find something
-    sig { params(klass: T.nilable(T.any(T::Class[T.anything], Module))).returns(T.nilable(String)) }
     def self.path_from_klass(klass)
       if klass
         path = Object.const_source_location(klass.to_s)&.first
@@ -167,13 +139,10 @@ module FeatureMap
     #
     # The output of this function is string pathnames relative to the root.
     #
-    sig { returns(T::Array[String]) }
     def self.tracked_files
-      @tracked_files ||= T.let(@tracked_files, T.nilable(T::Array[String]))
       @tracked_files ||= Dir.glob(configuration.assigned_globs) - Dir.glob(configuration.unassigned_globs)
     end
 
-    sig { params(file: String).returns(T::Boolean) }
     def self.file_tracked?(file)
       # Another way to accomplish this is
       # (Dir.glob(configuration.assigned_globs) - Dir.glob(configuration.unassigned_globs)).include?(file)
@@ -190,7 +159,6 @@ module FeatureMap
       in_assigned_globs && !in_unassigned_globs && File.exist?(file)
     end
 
-    sig { params(feature_name: String, location_of_reference: String).returns(CodeFeatures::Feature) }
     def self.find_feature!(feature_name, location_of_reference)
       found_feature = CodeFeatures.find(feature_name)
       if found_feature.nil?
@@ -200,9 +168,7 @@ module FeatureMap
       end
     end
 
-    sig { returns(GlobCache) }
     def self.glob_cache
-      @glob_cache ||= T.let(@glob_cache, T.nilable(GlobCache))
       @glob_cache ||= if AssignmentsFile.use_features_cache?
                         AssignmentsFile.to_glob_cache
                       else
@@ -210,20 +176,18 @@ module FeatureMap
                       end
     end
 
-    sig { returns(FeatureFiles) }
     def self.feature_file_assignments
-      glob_cache.raw_cache_contents.values.each_with_object(T.let({}, FeatureFiles)) do |assignment_map_cache, feature_files|
+      glob_cache.raw_cache_contents.values.each_with_object({}) do |assignment_map_cache, feature_files|
         assignment_map_cache.to_h.each do |path, feature|
-          feature_files[feature.name] ||= T.let([], FileList)
+          feature_files[feature.name] ||= []
           files = Dir.glob(path).reject { |glob_entry| File.directory?(glob_entry) }
-          files.each { |file| T.must(feature_files[feature.name]) << file }
+          files.each { |file| feature_files[feature.name] << file }
         end
 
         feature_files
       end
     end
 
-    sig { params(feature: CodeFeatures::Feature).returns(T::Array[CodeTeams::Team]) }
     def self.all_teams_for_feature(feature)
       return [] if configuration.skip_code_ownership
 
@@ -235,7 +199,6 @@ module FeatureMap
       feature_files.map { |file| CodeOwnership.for_file(file) }.compact.uniq
     end
 
-    sig { params(commits_by_feature: CommitsByFeature).returns(ReleaseNotificationBuilder::BlockKitPayload) }
     def self.generate_release_notification(commits_by_feature)
       ReleaseNotificationBuilder.build(commits_by_feature)
     end

data/lib/feature_map/validator.rb

@@ -1,26 +1,13 @@
-# typed: strict
-
 module FeatureMap
   module Validator
-    extend T::Sig
-    extend T::Helpers
-
-    interface!
-
-    sig { abstract.params(files: T::Array[String], autocorrect: T::Boolean, stage_changes: T::Boolean).returns(T::Array[String]) }
     def validation_errors(files:, autocorrect: true, stage_changes: true); end
 
     class << self
-      extend T::Sig
-
-      sig { params(base: T::Class[Validator]).void }
       def included(base)
-        @validators ||= T.let(@validators, T.nilable(T::Array[T::Class[Validator]]))
         @validators ||= []
         @validators << base
       end
 
-      sig { returns(T::Array[Validator]) }
       def all
         (@validators || []).map(&:new)
       end