feature_map 1.2.2 → 1.2.3

data/lib/feature_map/private/assignment_applicator.rb

@@ -1,12 +1,8 @@
-# typed: strict
 # frozen_string_literal: true
 
 module FeatureMap
   module Private
     class AssignmentApplicator
-      extend T::Sig
-
-      sig { params(assignments: T::Array[T::Array[T.nilable(String)]]).void }
       def self.apply_assignments!(assignments)
         file_to_feature_map = map_files_to_feature
         assignments.each do |(filepath, feature)|
@@ -17,7 +13,6 @@ module FeatureMap
         end
       end
 
-      sig { params(filepath: String, feature: String).void }
       def self.apply_assignment(filepath, feature)
         return apply_to_directory(filepath, feature) if File.directory?(filepath)
 
@@ -42,7 +37,6 @@ module FeatureMap
         end
       end
 
-      sig { params(file: T::Array[String], filepath: String, feature: String).void }
       def self.apply_to_apex(file, filepath, feature)
         File.open(filepath, 'w') do |f|
           f.write("// @feature #{feature}\n\n")
@@ -50,14 +44,12 @@ module FeatureMap
         end
       end
 
-      sig { params(filepath: String, feature: String).void }
       def self.apply_to_directory(filepath, feature)
         feature_path = File.join(filepath, '.feature')
 
         File.write(feature_path, "#{feature}\n")
       end
 
-      sig { params(file: T::Array[String], filepath: String, feature: String).void }
       def self.apply_to_html(file, filepath, feature)
         File.open(filepath, 'w') do |f|
           f.write("<!-- @feature #{feature} -->\n\n")
@@ -65,7 +57,6 @@ module FeatureMap
         end
       end
 
-      sig { params(file: T::Array[String], filepath: String, feature: String).void }
       def self.apply_to_javascript(file, filepath, feature)
         File.open(filepath, 'w') do |f|
           f.write("// @feature #{feature}\n\n")
@@ -73,7 +64,6 @@ module FeatureMap
         end
       end
 
-      sig { params(file: T::Array[String], filepath: String, feature: String).void }
       def self.apply_to_ruby(file, filepath, feature)
         File.open(filepath, 'w') do |f|
           # NOTE:  No spacing newline; doing so would separate
@@ -86,7 +76,6 @@ module FeatureMap
         end
       end
 
-      sig { params(file: T::Array[String], filepath: String, feature: String).void }
       def self.apply_to_xml(file, filepath, feature)
         # NOTE:  Installation of top-level comments in some XML files (notably, in Salesforce)
         #        breaks parsing.  Instead, we'll insert them right after the opening XML declaration.
@@ -99,7 +88,6 @@ module FeatureMap
         end
       end
 
-      sig { returns(T::Hash[String, String]) }
       def self.map_files_to_feature
         Private.feature_file_assignments.reduce({}) do |content, (feature_name, files)|
           mapped_files = files.to_h { |f| [f, feature_name] }

data/lib/feature_map/private/assignment_mappers/directory_assignment.rb

@@ -1,29 +1,19 @@
 # frozen_string_literal: true
 
-# typed: true
-
 module FeatureMap
   module Private
     module AssignmentMappers
       class DirectoryAssignment
-        extend T::Sig
         include Mapper
 
         FEATURE_DIRECTORY_ASSIGNMENT_FILE_NAME = '.feature'
 
-        @@directory_cache = T.let({}, T::Hash[String, T.nilable(CodeFeatures::Feature)]) # rubocop:disable Style/ClassVars
+        @@directory_cache = {} # rubocop:disable Style/ClassVars
 
-        sig do
-          override.params(file: String)
-            .returns(T.nilable(CodeFeatures::Feature))
-        end
         def map_file_to_feature(file)
           map_file_to_relevant_feature(file)
         end
 
-        sig do
-          override.params(cache: GlobsToAssignedFeatureMap, files: T::Array[String]).returns(GlobsToAssignedFeatureMap)
-        end
         def update_cache(cache, files)
           globs_to_feature(files)
         end
@@ -36,14 +26,8 @@ module FeatureMap
         # but in practice this is not of consequence because in reality we never really want to generate feature assignments for only a
         # subset of files, but rather we want feature assignments for all files.
         #
-        sig do
-          override.params(files: T::Array[String])
-            .returns(T::Hash[String, CodeFeatures::Feature])
-        end
         def globs_to_feature(files)
-          # The T.unsafe is because the upstream RBI is wrong for Pathname.glob
-          T
-            .unsafe(Pathname)
+          Pathname
             .glob(File.join('**/', FEATURE_DIRECTORY_ASSIGNMENT_FILE_NAME))
             .map(&:cleanpath)
             .each_with_object({}) do |pathname, res|
@@ -53,19 +37,16 @@ module FeatureMap
           end
         end
 
-        sig { override.returns(String) }
         def description
           'Feature Assigned in .feature'
         end
 
-        sig { override.void }
         def bust_caches!
           @@directory_cache = {} # rubocop:disable Style/ClassVars
         end
 
         private
 
-        sig { params(file: Pathname).returns(CodeFeatures::Feature) }
         def feature_for_directory_assignment_file(file)
           raw_feature_value = File.foreach(file).first.strip
 
@@ -80,10 +61,9 @@ module FeatureMap
         # and `.feature` in that order, stopping at the first file to actually exist.
         # If the provided file is a directory, it will look for `.feature` in that directory and then upwards.
         # We do additional caching so that we don't have to check for file existence every time.
-        sig { params(file: String).returns(T.nilable(CodeFeatures::Feature)) }
         def map_file_to_relevant_feature(file)
           file_path = Pathname.new(file)
-          feature = T.let(nil, T.nilable(CodeFeatures::Feature))
+          feature = nil
 
           if File.directory?(file)
             feature = get_feature_from_assignment_file_within_directory(file_path)
@@ -97,7 +77,7 @@ module FeatureMap
 
           (path_components.length - 1).downto(0).each do |i|
             feature = get_feature_from_assignment_file_within_directory(
-               Pathname.new(File.join(*T.unsafe(path_components[0...i])))
+               Pathname.new(File.join(*path_components[0...i]))
              )
             return feature unless feature.nil?
           end
@@ -105,7 +85,6 @@ module FeatureMap
           feature
         end
 
-        sig { params(directory: Pathname).returns(T.nilable(CodeFeatures::Feature)) }
         def get_feature_from_assignment_file_within_directory(directory)
           potential_directory_assignment_file = directory.join(FEATURE_DIRECTORY_ASSIGNMENT_FILE_NAME)
 
@@ -125,7 +104,6 @@ module FeatureMap
           feature
         end
 
-        sig { params(file: Pathname).returns(String) }
         def glob_for_directory_assignment_file(file)
           unescaped = file.dirname.cleanpath.join('**/**').to_s
 

data/lib/feature_map/private/assignment_mappers/feature_definition_assignment.rb

@@ -1,21 +1,14 @@
 # frozen_string_literal: true
 
-# typed: true
-
 module FeatureMap
   module Private
     module AssignmentMappers
       class FeatureDefinitionAssignment
-        extend T::Sig
         include Mapper
 
-        @@map_files_to_features = T.let(@map_files_to_features, T.nilable(T::Hash[String, CodeFeatures::Feature])) # rubocop:disable Style/ClassVars
+        @@map_files_to_features = @map_files_to_features # rubocop:disable Style/ClassVars
         @@map_files_to_features = {} # rubocop:disable Style/ClassVars
 
-        sig do
-          params(files: T::Array[String])
-          .returns(T::Hash[String, CodeFeatures::Feature])
-        end
         def map_files_to_features(files)
           return @@map_files_to_features if @@map_files_to_features&.keys && @@map_files_to_features.keys.count.positive?
 
@@ -24,20 +17,12 @@ module FeatureMap
           end
         end
 
-        sig do
-          override.params(file: String)
-            .returns(T.nilable(CodeFeatures::Feature))
-        end
         def map_file_to_feature(file)
           return nil if Private.configuration.ignore_feature_definitions
 
           map_files_to_features([file])[file]
         end
 
-        sig do
-          override.params(files: T::Array[String])
-            .returns(T::Hash[String, CodeFeatures::Feature])
-        end
         def globs_to_feature(files)
           return {} if Private.configuration.ignore_feature_definitions
 
@@ -46,19 +31,14 @@ module FeatureMap
           end
         end
 
-        sig { override.void }
         def bust_caches!
           @@map_files_to_features = {} # rubocop:disable Style/ClassVars
         end
 
-        sig do
-          override.params(cache: GlobsToAssignedFeatureMap, files: T::Array[String]).returns(GlobsToAssignedFeatureMap)
-        end
         def update_cache(cache, files)
           globs_to_feature(files)
         end
 
-        sig { override.returns(String) }
         def description
           'Feature definition file assignment'
         end

data/lib/feature_map/private/assignment_mappers/feature_globs.rb

@@ -1,22 +1,15 @@
 # frozen_string_literal: true
 
-# typed: true
-
 module FeatureMap
   module Private
     module AssignmentMappers
       class FeatureGlobs
-        extend T::Sig
         include Mapper
         include Validator
 
-        @@map_files_to_features = T.let(@map_files_to_features, T.nilable(T::Hash[String, FeatureMap::CodeFeatures::Feature])) # rubocop:disable Style/ClassVars
+        @@map_files_to_features = @map_files_to_features # rubocop:disable Style/ClassVars
         @@map_files_to_features = {} # rubocop:disable Style/ClassVars
 
-        sig do
-          params(files: T::Array[String])
-          .returns(T::Hash[String, FeatureMap::CodeFeatures::Feature])
-        end
         def map_files_to_features(files)
           return @@map_files_to_features if @@map_files_to_features&.keys && @@map_files_to_features.keys.count.positive?
 
@@ -29,17 +22,8 @@ module FeatureMap
           end
         end
 
-        class MappingContext < T::Struct
-          const :glob, String
-          const :feature, FeatureMap::CodeFeatures::Feature
-        end
-
-        class GlobOverlap < T::Struct
-          extend T::Sig
-
-          const :mapping_contexts, T::Array[MappingContext]
-
-          sig { returns(String) }
+        MappingContext = Struct.new(:glob, :feature, keyword_init: true)
+        GlobOverlap = Struct.new(:mapping_contexts, keyword_init: true) do
           def description
             # These are sorted only to prevent non-determinism in output between local and CI environments.
             sorted_contexts = mapping_contexts.sort_by { |context| context.feature.config_yml.to_s }
@@ -51,21 +35,18 @@ module FeatureMap
           end
         end
 
-        sig do
-          returns(T::Array[GlobOverlap])
-        end
         def find_overlapping_globs
-          mapped_files = T.let({}, T::Hash[String, T::Array[MappingContext]])
+          mapped_files = {}
           FeatureMap::CodeFeatures.all.each_with_object({}) do |feature, _map|
             FeaturePlugins::Assignment.for(feature).assigned_globs.each do |glob|
               Dir.glob(glob).each do |filename|
                 mapped_files[filename] ||= []
-                T.must(mapped_files[filename]) << MappingContext.new(glob: glob, feature: feature)
+                mapped_files[filename] << MappingContext.new(glob: glob, feature: feature)
               end
             end
           end
 
-          overlaps = T.let([], T::Array[GlobOverlap])
+          overlaps = []
           mapped_files.each_value do |mapping_contexts|
             if mapping_contexts.count > 1
               overlaps << GlobOverlap.new(mapping_contexts: mapping_contexts)
@@ -79,25 +60,14 @@ module FeatureMap
           end
         end
 
-        sig do
-          override.params(file: String)
-            .returns(T.nilable(FeatureMap::CodeFeatures::Feature))
-        end
         def map_file_to_feature(file)
           map_files_to_features([file])[file]
         end
 
-        sig do
-          override.params(cache: GlobsToAssignedFeatureMap, files: T::Array[String]).returns(GlobsToAssignedFeatureMap)
-        end
         def update_cache(cache, files)
           globs_to_feature(files)
         end
 
-        sig do
-          override.params(files: T::Array[String])
-            .returns(T::Hash[String, FeatureMap::CodeFeatures::Feature])
-        end
         def globs_to_feature(files)
           FeatureMap::CodeFeatures.all.each_with_object({}) do |feature, map|
             FeaturePlugins::Assignment.for(feature).assigned_globs.each do |assigned_glob|
@@ -106,21 +76,18 @@ module FeatureMap
           end
         end
 
-        sig { override.void }
         def bust_caches!
           @@map_files_to_features = {} # rubocop:disable Style/ClassVars
         end
 
-        sig { override.returns(String) }
         def description
           'Feature-specific assigned globs'
         end
 
-        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)
           overlapping_globs = AssignmentMappers::FeatureGlobs.new.find_overlapping_globs
 
-          errors = T.let([], T::Array[String])
+          errors = []
 
           if overlapping_globs.any?
             errors << <<~MSG

data/lib/feature_map/private/assignment_mappers/file_annotations.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# typed: strict
-
 module FeatureMap
   module Private
     module AssignmentMappers
@@ -15,45 +13,31 @@ module FeatureMap
       #     ...
       #   }
       class FileAnnotations
-        extend T::Sig
         include Mapper
 
         # NOTE:  regex 'x' arg ignores whitespace within the _construction_ of the regex.
         #        regex 'm' arg allows the regex to _execute_ on multiline strings.
-        SINGLE_LINE_ANNOTATION_PATTERN = T.let(
-          /
-            \s* # Any amount of whitespace
-            (#{Constants::SINGLE_LINE_COMMENT_PATTERNS.join('|')}) # Single line comment start
-            \s* # Any amount of whitespace, not including newlines
-            @feature\s # We find the feature annotation followed by one space
-            (?<feature>.*?$) # A named capture grabs the rest as the feature until the line ends
-          /x.freeze,
-          Regexp
-        )
-        MULTILINE_ANNOTATION_PATTERN = T.let(
-          /
-            (?:#{Constants::MULTILINE_COMMENT_START_PATTERNS.join('|')}) # Any comment start
-            .*? # Followed by any characters, including newlines, until...
-            @feature\s # We find the feature annotation followed by one space
-            (?<feature>.*?$) # A named capture grabs the rest as the feature until the line ends
-          /xm.freeze,
-          Regexp
-        )
+        SINGLE_LINE_ANNOTATION_PATTERN = /
+          \s* # Any amount of whitespace
+          (#{Constants::SINGLE_LINE_COMMENT_PATTERNS.join('|')}) # Single line comment start
+          \s* # Any amount of whitespace, not including newlines
+          @feature\s # We find the feature annotation followed by one space
+          (?<feature>.*?$) # A named capture grabs the rest as the feature until the line ends
+        /x.freeze
+
+        MULTILINE_ANNOTATION_PATTERN = /
+          (?:#{Constants::MULTILINE_COMMENT_START_PATTERNS.join('|')}) # Any comment start
+          .*? # Followed by any characters, including newlines, until...
+          @feature\s # We find the feature annotation followed by one space
+          (?<feature>.*?$) # A named capture grabs the rest as the feature until the line ends
+        /xm.freeze
+
         DESCRIPTION = 'Annotations at the top of file'
 
-        sig do
-          override.params(file: String)
-            .returns(T.nilable(CodeFeatures::Feature))
-        end
         def map_file_to_feature(file)
           file_annotation_based_feature(file)
         end
 
-        sig do
-          override
-            .params(files: T::Array[String])
-            .returns(T::Hash[String, CodeFeatures::Feature])
-        end
         def globs_to_feature(files)
           files.each_with_object({}) do |filename_relative_to_root, mapping|
             feature = file_annotation_based_feature(filename_relative_to_root)
@@ -63,9 +47,6 @@ module FeatureMap
           end
         end
 
-        sig do
-          override.params(cache: GlobsToAssignedFeatureMap, files: T::Array[String]).returns(GlobsToAssignedFeatureMap)
-        end
         def update_cache(cache, files)
           # We map files to nil features so that files whose annotation have been removed will be properly
           # overwritten (i.e. removed) from the cache.
@@ -89,23 +70,21 @@ module FeatureMap
           cache
         end
 
-        sig { params(lines: T::Array[String]).returns(T.nilable(String)) }
         def identify_feature_from(lines)
           matched_single_line_feature = lines.join("\n").match(SINGLE_LINE_ANNOTATION_PATTERN)
           matched_multiline_feature = lines.join("\n").match(MULTILINE_ANNOTATION_PATTERN)
           matched_feature = matched_single_line_feature || matched_multiline_feature
           return if matched_feature.nil?
 
-          T.must(matched_feature
-           .values_at(:feature)
-           .first)
-           .gsub(/#{Constants::MULTILINE_COMMENT_END_PATTERNS.join('|')}/, '')
-           .strip
+          matched_feature
+                     .values_at(:feature)
+                     .first
+                     .gsub(/#{Constants::MULTILINE_COMMENT_END_PATTERNS.join('|')}/, '')
+                     .strip
         rescue ArgumentError => e
           raise unless e.message.include?('invalid byte sequence')
         end
 
-        sig { params(filename: String).returns(T.nilable(CodeFeatures::Feature)) }
         def file_annotation_based_feature(filename)
           # Not too sure what the following comment means but it was carried over from the code_ownership repo, so
           # I've opted to leave it unchanged in case it is helpful for future engineers:
@@ -131,7 +110,6 @@ module FeatureMap
           )
         end
 
-        sig { params(filename: String).void }
         def remove_file_annotation!(filename)
           if file_annotation_based_feature(filename)
             filepath = Pathname.new(filename)
@@ -145,12 +123,10 @@ module FeatureMap
           end
         end
 
-        sig { override.returns(String) }
         def description
           DESCRIPTION
         end
 
-        sig { override.void }
         def bust_caches!; end
       end
     end

data/lib/feature_map/private/assignments_file.rb

@@ -1,4 +1,3 @@
-# typed: strict
 # frozen_string_literal: true
 
 require 'code_ownership'
@@ -11,8 +10,6 @@ module FeatureMap
     # PR/release announcements, documentation generation, etc).
     #
     class AssignmentsFile
-      extend T::Sig
-
       class FileContentError < StandardError; end
 
       FILES_KEY = 'files'
@@ -21,42 +18,6 @@ module FeatureMap
       FEATURES_KEY = 'features'
       FEATURE_FILES_KEY = 'files'
 
-      FeatureName = T.type_alias { String }
-      FilePath = T.type_alias { String }
-      MapperDescription = T.type_alias { String }
-
-      FileDetails = T.type_alias do
-        T::Hash[
-          String,
-          T.any(FeatureName, MapperDescription)
-        ]
-      end
-
-      FilesContent = T.type_alias do
-        T::Hash[
-          FilePath,
-          FileDetails
-        ]
-      end
-
-      FileList = T.type_alias { T::Array[String] }
-      TeamList = T.type_alias { T::Array[String] }
-
-      FeatureDetails = T.type_alias do
-        T::Hash[
-          String,
-          T.any(FileList, TeamList)
-        ]
-      end
-
-      FeaturesContent = T.type_alias do
-        T::Hash[
-          FeatureName,
-          FeatureDetails
-        ]
-      end
-
-      sig { returns(T::Array[String]) }
       def self.actual_contents_lines
         if path.exist?
           content = path.read
@@ -70,7 +31,6 @@ module FeatureMap
         end
       end
 
-      sig { returns(T::Array[T.nilable(String)]) }
       def self.expected_contents_lines
         cache = Private.glob_cache.raw_cache_contents
 
@@ -84,9 +44,9 @@ module FeatureMap
           # set of files assigned to a feature change, which should be explicitly tracked.
         HEADER
 
-        files_content = T.let({}, FilesContent)
-        files_by_feature = T.let({}, T::Hash[FeatureName, FileList])
-        features_content = T.let({}, FeaturesContent)
+        files_content = {}
+        files_by_feature = {}
+        features_content = {}
 
         cache.each do |mapper_description, assignment_map_cache|
           assignment_map_cache = assignment_map_cache.sort_by do |glob, _feature|
@@ -94,10 +54,10 @@ module FeatureMap
           end
 
           assignment_map_cache.to_h.each do |path, feature|
-            files_content[path] = T.let({ FILE_FEATURE_KEY => feature.name, FILE_MAPPER_KEY => mapper_description }, FileDetails)
+            files_content[path] = { FILE_FEATURE_KEY => feature.name, FILE_MAPPER_KEY => mapper_description }
 
             files_by_feature[feature.name] ||= []
-            T.must(files_by_feature[feature.name]) << path
+            files_by_feature[feature.name] << path
           end
         end
 
@@ -111,10 +71,10 @@ module FeatureMap
           # repo/application.
           next if expanded_files.empty?
 
-          features_content[feature.name] = T.let({ 'files' => expanded_files.sort }, FeatureDetails)
+          features_content[feature.name] = { 'files' => expanded_files.sort }
 
           if !Private.configuration.skip_code_ownership
-            T.must(features_content[feature.name])['teams'] = expanded_files.map { |file| CodeOwnership.for_file(file)&.name }.compact.uniq.sort
+            features_content[feature.name]['teams'] = expanded_files.map { |file| CodeOwnership.for_file(file)&.name }.compact.uniq.sort
           end
         end
 
@@ -126,18 +86,15 @@ module FeatureMap
         ]
       end
 
-      sig { void }
       def self.write!
         FileUtils.mkdir_p(path.dirname) if !path.dirname.exist?
         path.write(expected_contents_lines.join("\n"))
       end
 
-      sig { returns(Pathname) }
       def self.path
         Pathname.pwd.join('.feature_map/assignments.yml')
       end
 
-      sig { params(files: T::Array[String]).void }
       def self.update_cache!(files)
         cache = Private.glob_cache
         # Each mapper returns a new copy of the cache subset related to that mapper,
@@ -149,14 +106,12 @@ module FeatureMap
         end
       end
 
-      sig { returns(T::Boolean) }
       def self.use_features_cache?
         AssignmentsFile.path.exist? && !Private.configuration.skip_features_validation
       end
 
-      sig { returns(GlobCache) }
       def self.to_glob_cache
-        raw_cache_contents = T.let({}, GlobCache::CacheShape)
+        raw_cache_contents = {}
         features_by_name = CodeFeatures.all.each_with_object({}) do |feature, map|
           map[feature.name] = feature
         end
@@ -175,7 +130,6 @@ module FeatureMap
         GlobCache.new(raw_cache_contents)
       end
 
-      sig { returns(FeaturesContent) }
       def self.load_features!
         assignments_content = YAML.load_file(path)