feature_map 1.2.0 → 1.2.1

data/lib/feature_map/private/documentation_site.rb

@@ -74,6 +74,7 @@ module FeatureMap
           feature_metrics: MetricsFile::FeaturesContent,
           feature_test_coverage: TestCoverageFile::FeaturesContent,
           feature_test_pyramid: TestPyramidFile::FeaturesContent,
+          feature_additional_metrics: AdditionalMetricsFile::FeaturesContent,
           project_configuration: T::Hash[T.untyped, T.untyped],
           git_ref: String
         ).void
@@ -83,6 +84,7 @@ module FeatureMap
         feature_metrics,
         feature_test_coverage,
         feature_test_pyramid,
+        feature_additional_metrics,
         project_configuration,
         git_ref
       )
@@ -95,7 +97,8 @@ module FeatureMap
             assignments: feature_assignments[feature_name],
             metrics: feature_metrics[feature_name],
             test_coverage: feature_test_coverage[feature_name],
-            test_pyramid: feature_test_pyramid[feature_name]
+            test_pyramid: feature_test_pyramid[feature_name],
+            additional_metrics: feature_additional_metrics[feature_name]
           )
         end
 

data/lib/feature_map/private/feature_metrics_calculator.rb

@@ -11,18 +11,22 @@ module FeatureMap
       CYCLOMATIC_COMPLEXITY_METRIC = 'cyclomatic_complexity'
       LINES_OF_CODE_METRIC = 'lines_of_code'
       TODO_LOCATIONS_METRIC = 'todo_locations'
+      COMPLEXITY_RATIO_METRIC = 'complexity_ratio'
+      ENCAPSULATION_RATIO_METRIC = 'encapsulation_ratio'
 
       SUPPORTED_METRICS = T.let([
         ABC_SIZE_METRIC,
         CYCLOMATIC_COMPLEXITY_METRIC,
         LINES_OF_CODE_METRIC,
-        TODO_LOCATIONS_METRIC
+        TODO_LOCATIONS_METRIC,
+        COMPLEXITY_RATIO_METRIC,
+        ENCAPSULATION_RATIO_METRIC
       ].freeze, T::Array[String])
 
       FeatureMetrics = T.type_alias do
         T::Hash[
           String, # metric name
-          T.any(Integer, Float, T::Hash[String, String]) # score or todo locations with messages
+          T.any(Integer, T.nilable(Float), T::Hash[String, String]) # score or todo locations with messages
         ]
       end
 
@@ -31,15 +35,15 @@ module FeatureMap
         metrics = file_paths.map { |file| calculate_for_file(file) }
 
         # Handle numeric metrics
-        aggregate_metrics = SUPPORTED_METRICS.each_with_object({}) do |metric_key, agg|
-          next if metric_key == TODO_LOCATIONS_METRIC
-
+        aggregate_metrics = [ABC_SIZE_METRIC, CYCLOMATIC_COMPLEXITY_METRIC, LINES_OF_CODE_METRIC].each_with_object({}) do |metric_key, agg|
           agg[metric_key] = metrics.sum { |m| m[metric_key] || 0 }
         end
 
-        # Merge all todo locations
+        # Handle additional supported metrics
         todo_locations = metrics.map { |m| m[TODO_LOCATIONS_METRIC] }.compact.reduce({}, :merge)
         aggregate_metrics[TODO_LOCATIONS_METRIC] = todo_locations
+        aggregate_metrics[COMPLEXITY_RATIO_METRIC] = complexity_ratio(aggregate_metrics)
+        aggregate_metrics[ENCAPSULATION_RATIO_METRIC] = encapsulation_ratio(file_paths, aggregate_metrics)
 
         aggregate_metrics
       end
@@ -71,6 +75,20 @@ module FeatureMap
           TODO_LOCATIONS_METRIC => todo_locations
         )
       end
+
+      sig { params(aggregate_metrics: T::Hash[String, T.untyped]).returns(T.nilable(Float)) }
+      def self.complexity_ratio(aggregate_metrics)
+        return 0.0 if aggregate_metrics[LINES_OF_CODE_METRIC].nil? || aggregate_metrics[CYCLOMATIC_COMPLEXITY_METRIC].nil? || aggregate_metrics[CYCLOMATIC_COMPLEXITY_METRIC].zero?
+
+        aggregate_metrics[LINES_OF_CODE_METRIC].to_f / aggregate_metrics[CYCLOMATIC_COMPLEXITY_METRIC]
+      end
+
+      sig { params(file_paths: T.nilable(T::Array[String]), aggregate_metrics: T::Hash[String, T.untyped]).returns(T.nilable(Float)) }
+      def self.encapsulation_ratio(file_paths, aggregate_metrics)
+        return 0.0 if file_paths.nil? || aggregate_metrics[LINES_OF_CODE_METRIC].nil? || aggregate_metrics[LINES_OF_CODE_METRIC].zero?
+
+        file_paths.length.to_f / aggregate_metrics[LINES_OF_CODE_METRIC]
+      end
     end
   end
 end

data/lib/feature_map/private/metrics_file.rb

@@ -20,7 +20,7 @@ module FeatureMap
       FeatureMetrics = T.type_alias do
         T::Hash[
           String,
-          T.any(Integer, Float, T::Hash[String, String])
+          T.any(Integer, T.nilable(Float), T::Hash[String, String])
         ]
       end
 

data/lib/feature_map/private/test_coverage_file.rb

@@ -11,6 +11,8 @@ module FeatureMap
     class TestCoverageFile
       extend T::Sig
 
+      COVERAGE_RATIO = 'coverage_ratio'
+
       class FileContentError < StandardError; end
 
       FEATURES_KEY = 'features'
@@ -64,7 +66,7 @@ module FeatureMap
         feature_test_coverage = T.let({}, FeaturesContent)
 
         Private.feature_file_assignments.each do |feature_name, files|
-          feature_test_coverage[feature_name] = T.let({ 'lines' => 0, 'hits' => 0, 'misses' => 0 }, FeatureCoverage)
+          feature_test_coverage[feature_name] = T.let({ 'lines' => 0, 'hits' => 0, 'misses' => 0, 'coverage_ratio' => 0 }, FeatureCoverage)
 
           files.each_with_object(T.must(feature_test_coverage[feature_name])) do |file_path, coverage|
             next unless coverage_stats[file_path]
@@ -75,6 +77,12 @@ module FeatureMap
 
             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
         end
 
         { FEATURES_KEY => feature_test_coverage }

data/lib/feature_map/private.rb

@@ -20,6 +20,7 @@ require 'feature_map/private/documentation_site'
 require 'feature_map/private/code_cov'
 require 'feature_map/private/test_coverage_file'
 require 'feature_map/private/test_pyramid_file'
+require 'feature_map/private/additional_metrics_file'
 require 'feature_map/private/feature_plugins/assignment'
 require 'feature_map/private/validations/files_have_features'
 require 'feature_map/private/validations/features_up_to_date'
@@ -104,11 +105,15 @@ module FeatureMap
       # and review the feature documentation without this data.
       feature_test_coverage = TestCoverageFile.path.exist? ? TestCoverageFile.load_features! : {}
 
+      # Additional metrics must be calculated after the initial metrics are loaded
+      feature_additional_metrics = AdditionalMetricsFile.path.exist? ? AdditionalMetricsFile.load_features! : {}
+
       DocumentationSite.generate(
         feature_assignments,
         feature_metrics,
         feature_test_coverage,
         feature_test_pyramid,
+        feature_additional_metrics,
         configuration.raw_hash,
         T.must(git_ref || configuration.repository['main_branch'])
       )
@@ -137,6 +142,14 @@ module FeatureMap
       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! : {}
+
+      AdditionalMetricsFile.write!(feature_metrics, feature_test_coverage, configuration.raw_hash['documentation_site']['health'])
+    end
+
     # 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)) }

data/lib/feature_map.rb

@@ -135,6 +135,11 @@ module FeatureMap
     Private.gather_test_coverage!(commit_sha, code_cov_token)
   end
 
+  sig { void }
+  def generate_additional_metrics!
+    Private.generate_additional_metrics!
+  end
+
   # Given a backtrace from either `Exception#backtrace` or `caller`, find the
   # first line that corresponds to a file with an assigned feature
   sig { params(backtrace: T.nilable(T::Array[String]), excluded_features: T::Array[CodeFeatures::Feature]).returns(T.nilable(CodeFeatures::Feature)) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feature_map
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Beyond Finance
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-07 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: github-pages
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '232'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '232'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -203,7 +217,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- bin/docs
 - bin/featuremap
+- bin/readme
 - lib/feature_map.rb
 - lib/feature_map/cli.rb
 - lib/feature_map/code_features.rb
@@ -215,6 +231,7 @@ files:
 - lib/feature_map/mapper.rb
 - lib/feature_map/output_color.rb
 - lib/feature_map/private.rb
+- lib/feature_map/private/additional_metrics_file.rb
 - lib/feature_map/private/assignment_applicator.rb
 - lib/feature_map/private/assignment_mappers/directory_assignment.rb
 - lib/feature_map/private/assignment_mappers/feature_definition_assignment.rb