feature_map 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 206bf1a9f4dcf4bb82658ce1a6e7f3c532b5929521e53c070b4efa92eb4b61b1
-  data.tar.gz: dbde9980709b0d3a28bb2b7319da42a9bbd188aec2c78c9ecbaef6405a95bf96
+  metadata.gz: 1d557f6ea527d73672a53ea6a279e8574a0157d03ffe5da289cc12aa05fec2d3
+  data.tar.gz: 0b5d04be8cfd69f16d8f5ffc8e1ef0b4c7e5fa8de276feb3c776c7d733cce758
 SHA512:
-  metadata.gz: 03b1baec50bb36335af87eabf62885290cfe53516686bded3ac61d6ae660dd9d181d6df817e1b2089f0e3c605dfdf119bedd334d61ae0c9ee1049fe29ee7cd75
-  data.tar.gz: c2c72319780a7043aa1654cf691d53a576275af18ef968fde2777a13b89bba4208c77daed041ff0def4ec15f0851ce1cc9bdf3c4d724e89af28a7c26cd41a8be
+  metadata.gz: 5fa1edc5ba79772619aec3f730147ccffa37a19cc889959192086469757522d72f4c635fa67cb815237c9b0a8e71557c2fb52948e9f9db63b4c1f4338f0ca316
+  data.tar.gz: 7d75f638f6d06921b146d81a590bebb72e9db3ed1229bf833781aca68b9e92a274fb016190af9884ba8800c6ca982945a370634e73af3b9171b0c873c73cfcdc

data/lib/feature_map/commit.rb

@@ -0,0 +1,34 @@
+# typed: strict
+
+module FeatureMap
+  class Commit
+    extend T::Sig
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :sha
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :description
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :pull_request_number
+
+    sig { returns(T::Array[String]) }
+    attr_reader :files
+
+    sig do
+      params(
+        sha: T.nilable(String),
+        description: T.nilable(String),
+        pull_request_number: T.nilable(String),
+        files: T::Array[String]
+      ).void
+    end
+    def initialize(sha: nil, description: nil, pull_request_number: nil, files: [])
+      @sha = sha
+      @description = description
+      @pull_request_number = pull_request_number
+      @files = files
+    end
+  end
+end

data/lib/feature_map/configuration.rb

@@ -15,6 +15,7 @@ module FeatureMap
     const :code_cov, T::Hash[String, T.nilable(String)]
     const :repository, T::Hash[String, T.nilable(String)]
     const :documentation_site, T::Hash[String, T.untyped]
+    const :documentation_site_url, T.nilable(String)
 
     sig { returns(Configuration) }
     def self.fetch
@@ -36,7 +37,8 @@ module FeatureMap
         ignore_feature_definitions: config_hash.fetch('ignore_feature_definitions', false),
         code_cov: config_hash.fetch('code_cov', {}),
         repository: config_hash.fetch('repository', {}),
-        documentation_site: config_hash.fetch('documentation_site', {})
+        documentation_site: config_hash.fetch('documentation_site', {}),
+        documentation_site_url: config_hash.fetch('documentation_site_url', nil)
       )
     end
   end

data/lib/feature_map/private/assignments_file.rb

@@ -1,6 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
+require 'code_ownership'
+
 module FeatureMap
   module Private
     #

data/lib/feature_map/private/release_notification_builder.rb

@@ -0,0 +1,76 @@
+# typed: strict
+# frozen_string_literal: true
+
+module FeatureMap
+  module Private
+    #
+    # This class is responsible for building a release notification message that can be published to a single
+    # team or to an organization as a whole. Currently, the only supported output format is Slack's Block Kit
+    # (see https://app.slack.com/block-kit-builder).
+    #
+    class ReleaseNotificationBuilder
+      extend T::Sig
+
+      BlockKitSection = T.type_alias { T::Hash[String, T.untyped] }
+      BlockKitPayload = T.type_alias { T::Array[T::Hash[String, T.untyped]] }
+
+      class << self
+        extend T::Sig
+
+        sig { params(commits_by_feature: CommitsByFeature).returns(BlockKitPayload) }
+        def build(commits_by_feature)
+          return [] if commits_by_feature.empty?
+
+          feature_names = commits_by_feature.keys.sort
+
+          feature_names.flat_map.with_index do |feature_name, index|
+            # Insert a divider between each feature but not above the first feature nor below the last feature.
+            divider = index.zero? ? [] : [{ type: 'divider' }]
+            divider + [build_feature_section(feature_name, T.must(commits_by_feature[feature_name]))]
+          end
+        end
+
+        private
+
+        sig { params(feature_name: String, commits: T::Array[Commit]).returns(BlockKitSection) }
+        def build_feature_section(feature_name, commits)
+          feature_header_markdown = "*_#{feature_name}_*"
+
+          # If the docs site is hosted at a persistent URL, include a link to the feature show page.
+          if documentation_site_url && feature_name != FeatureMap::NO_FEATURE_KEY
+            feature_header_markdown += " (<#{documentation_site_url}#/#{URI::DEFAULT_PARSER.escape(feature_name)}|View Documentation>)"
+          end
+
+          feature_markdown_lines = [feature_header_markdown]
+          commits.each do |commit|
+            commit_sub_bullet = "• #{commit.description}"
+
+            if repository_url && commit.pull_request_number
+              commit_sub_bullet += " (<#{repository_url}/pull/#{commit.pull_request_number}|##{commit.pull_request_number}>)"
+            end
+
+            feature_markdown_lines << commit_sub_bullet
+          end
+
+          {
+            type: 'section',
+            text: {
+              type: 'mrkdwn',
+              text: feature_markdown_lines.join("\n")
+            }
+          }
+        end
+
+        sig { returns(T.nilable(String)) }
+        def documentation_site_url
+          Private.configuration.documentation_site_url
+        end
+
+        sig { returns(T.nilable(String)) }
+        def repository_url
+          Private.configuration.repository['url']
+        end
+      end
+    end
+  end
+end

data/lib/feature_map/private.rb

@@ -2,6 +2,7 @@
 
 # typed: strict
 
+require 'code_ownership'
 require 'csv'
 
 require 'feature_map/constants'
@@ -27,6 +28,7 @@ require 'feature_map/private/assignment_mappers/file_annotations'
 require 'feature_map/private/assignment_mappers/feature_globs'
 require 'feature_map/private/assignment_mappers/directory_assignment'
 require 'feature_map/private/assignment_mappers/feature_definition_assignment'
+require 'feature_map/private/release_notification_builder'
 
 module FeatureMap
   module Private
@@ -207,6 +209,23 @@ module FeatureMap
         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
+
+      feature_assignments = AssignmentsFile.load_features!
+
+      feature_files = feature_assignments.dig(feature.name, AssignmentsFile::FILES_KEY)
+      return [] if !feature_files || feature_files.empty?
+
+      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
   end
 
   private_constant :Private

data/lib/feature_map.rb

@@ -6,6 +6,7 @@ require 'set'
 require 'sorbet-runtime'
 require 'json'
 require 'yaml'
+require 'feature_map/commit'
 require 'feature_map/code_features'
 require 'feature_map/mapper'
 require 'feature_map/validator'
@@ -14,6 +15,9 @@ require 'feature_map/cli'
 require 'feature_map/configuration'
 
 module FeatureMap
+  ALL_TEAMS_KEY = 'All Teams'
+  NO_FEATURE_KEY = 'No Feature'
+
   module_function
 
   extend T::Sig
@@ -22,6 +26,9 @@ module FeatureMap
   requires_ancestor { Kernel }
   GlobsToAssignedFeatureMap = T.type_alias { T::Hash[String, CodeFeatures::Feature] }
 
+  UpdatedFeaturesByTeam = T.type_alias { T::Hash[String, CommitsByFeature] }
+  CommitsByFeature = T.type_alias { T::Hash[String, T::Array[Commit]] }
+
   sig { params(assignments_file_path: String).void }
   def apply_assignments!(assignments_file_path)
     Private.apply_assignments!(assignments_file_path)
@@ -198,6 +205,45 @@ module FeatureMap
     end
   end
 
+  # Groups the provided list of commits (e.g. the changes being deployed in a release) by both the feature they impact
+  # and the teams responsible for these features. Returns a hash with keys for each team with features modified within
+  # these commits and values that are a hash of features to the set of commits that impact each feature.
+  sig { params(commits: T::Array[Commit]).returns(UpdatedFeaturesByTeam) }
+  def group_commits(commits)
+    commits.each_with_object({}) do |commit, hash|
+      commit_features = commit.files.map do |file|
+        feature = FeatureMap.for_file(file)
+        next nil unless feature
+
+        teams = Private.all_teams_for_feature(feature)
+        team_names = teams.empty? ? [ALL_TEAMS_KEY] : teams.map(&:name)
+
+        team_names.sort.each do |team_name|
+          hash[team_name] ||= {}
+          hash[team_name][feature.name] ||= []
+          hash[team_name][feature.name] << commit unless hash[team_name][feature.name].include?(commit)
+        end
+
+        feature
+      end
+
+      # If the commit did not have any files that relate to a specific feature, include it in a "No Feature" section
+      # of the "All Teams" grouping to avoid it being omitted from the resulting grouped commits entirely.
+      next unless commit_features.compact.empty?
+
+      hash[ALL_TEAMS_KEY] ||= {}
+      hash[ALL_TEAMS_KEY][NO_FEATURE_KEY] ||= []
+      hash[ALL_TEAMS_KEY][NO_FEATURE_KEY] << commit
+    end
+  end
+
+  # Generates a block kit message grouping the provided commits into sections for each feature impacted by the
+  # cheanges.
+  sig { params(commits_by_feature: CommitsByFeature).returns(T::Array[T::Hash[String, T.untyped]]) }
+  def generate_release_notification(commits_by_feature)
+    Private.generate_release_notification(commits_by_feature)
+  end
+
   # Generally, you should not ever need to do this, because once your ruby process loads, cached content should not change.
   # Namely, the set of files, and directories which are tracked for feature assignment should not change.
   # The primary reason this is helpful is for clients of FeatureMap who want to test their code, and each test context

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feature_map
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Beyond Finance
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
+date: 2025-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -195,6 +209,7 @@ files:
 - lib/feature_map/code_features.rb
 - lib/feature_map/code_features/plugin.rb
 - lib/feature_map/code_features/plugins/identity.rb
+- lib/feature_map/commit.rb
 - lib/feature_map/configuration.rb
 - lib/feature_map/constants.rb
 - lib/feature_map/mapper.rb
@@ -217,6 +232,7 @@ files:
 - lib/feature_map/private/glob_cache.rb
 - lib/feature_map/private/lines_of_code_calculator.rb
 - lib/feature_map/private/metrics_file.rb
+- lib/feature_map/private/release_notification_builder.rb
 - lib/feature_map/private/test_coverage_file.rb
 - lib/feature_map/private/test_pyramid_file.rb
 - lib/feature_map/private/todo_inspector.rb