feature_map 1.2.4 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '097b75ea1f00eafc127a2e43452ae185b1e3682d209c39ec96ab07c3ef75fe20'
-  data.tar.gz: eefa91bf65f4c9abcbddc8924bc80597596522f9d9a489ff60d02ed21a7ab77e
+  metadata.gz: 20d96ad4e61fb28fc9891cf32dd7e6102dbfb6d48d4a114973390cb5fc2fc805
+  data.tar.gz: 951a84a6a993a8b03b7899c51b5e55e3ab3fcf356f90e122574658a3696da5cd
 SHA512:
-  metadata.gz: 3ae23faf8405ea7436cdd10cc20c08673bff4447997eef2849ba3e2261c9edf50be6715ccbe0829adfe099fd91c7f18e829d29dd11aefe8238ee5bc126fa55a2
-  data.tar.gz: 43c0a7372afa58dbb1bc301f2331ef9f6fe51d466d90e9223953ee7050548251ad6512dd7e62b5d41fe266280e6d1d02735651a468bb10db76bab208eaaeaab3
+  metadata.gz: 3256049f99d24a887bc0644cbb64a1c7bcd8a305b23b019a864d68f84c101b342e742d236dfe85d1739cbc88dc4a42130b7fc25e5fc4de744a939f2ea3a77934
+  data.tar.gz: 57f6b8091fa32823b5f199c0f0cad7fa8b0be3b15eabb9ecee7f16e2357be7234cd2931a8f2a6ecf984792b7a56103f9956a3241c2cae9130c0cfe48e9baf7da

data/README.md

@@ -31,8 +31,8 @@ Contributions are welcome and appreciated. Here's how to get started:
 
 - clone repo: `$ git clone git@github.com:Beyond-Finance/feature_map.git`
 - install dependencies: `$ bundle install`
-- run tests: `$ bundle exec rspec`
-- run Rubocop: `$ bundle exec rubocop`
+- run tests: `$ bin/rspec`
+- run Rubocop: `$ bin/rubocop`
 
 That's it! Assuming you can complete all of these steps without any error or issues, you should be good to go.
 
@@ -42,13 +42,13 @@ The documentation site is a React application which is built on the Vite framewo
 
 Compilation of the build asset is done via `npm run build` from within the [docs](./docs) folder.  This compiles the React app into a single static file which is placed in [./lib/feature_map/private/docs/index.html](./lib/feature_map/private/docs/index.html]).
 
-The documentation site may be run locally to aid in development via `bin/docs`.  It uses sample data found in [docs/src/data/sample_config.js](./docs/src/data/sample_config.js).
+The documentation site may be run locally to aid in development via `bin/docs`.  It will generate test coverage and metrics data, and make it available to the docs site running in development mode.
 
 More information on the development of the documentation site may be found in the [Docs Readme](./docs/README.md).
 
 ### README Site
 
-The README site is built with Jekyll and TailwindCSS and is hosted via GitHub Pages at:  https://beyond-finance.github.io/feature_map.  It can be run locally to aid in development via `bin/readme`.
+The README site is built with Jekyll and TailwindCSS and is hosted via GitHub Pages at: [https://beyond-finance.github.io/feature_map](https://beyond-finance.github.io/feature_map/).  It can be run locally to aid in development via `bin/readme`.
 
 ### Publication
 

data/bin/bundle

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($PROGRAM_NAME) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV.fetch('BUNDLER_VERSION', nil)
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless 'update'.start_with?(ARGV.first || ' ') # must be running `bundle update`
+
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+
+      bundler_version = Regexp.last_match(1)
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV.fetch('BUNDLE_GEMFILE', nil)
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path('../Gemfile', __dir__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when 'gems.rb' then gemfile.sub(/\.rb$/, '.locked')
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+
+    Regexp.last_match(1)
+  end
+
+  def bundler_requirement
+    @bundler_requirement ||=
+      env_var_version ||
+      cli_arg_version ||
+      bundler_requirement_for(lockfile_version)
+  end
+
+  def bundler_requirement_for(version)
+    return "#{Gem::Requirement.default}.a" unless version
+
+    bundler_gem_version = Gem::Version.new(version)
+
+    bundler_gem_version.approximate_recommendation
+  end
+
+  def load_bundler!
+    ENV['BUNDLE_GEMFILE'] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem 'bundler', bundler_requirement
+    end
+    return if gem_error.nil?
+
+    require_error = activation_error_handling do
+      require 'bundler/version'
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path('bundler', 'bundle')
+end

data/bin/docs

@@ -5,5 +5,23 @@ if ! gem list foreman -i --silent; then
   gem install foreman
 fi
 
-cd docs && npm install && cd ..
+COVERAGE_FILE="coverage/.resultset.json"
+
+if [ ! -f $COVERAGE_FILE ] || [ $(find $COVERAGE_FILE -mtime +7 -print 2>/dev/null) ]; then
+  echo "###############################################"
+  echo "# No test coverage file found.  Regenerating. #"
+  echo "###############################################"
+
+  bin/rspec
+  bin/featuremap test_coverage --use-simplecov --simplecov-path $COVERAGE_FILE
+else
+  echo "#############################################################"
+  echo "# Using recent coverage file.  If you'd like to regenerate: #"
+  echo "# > rm $COVERAGE_FILE                             #"
+  echo "#############################################################"
+fi
+
+bin/featuremap docs
+cat .feature_map/docs/feature-map-config.js | sed 's/window\.FEATURE_MAP_CONFIG = /export const sampleConfig = /' > docs/sample_config.js
+cd docs && npm install && npm run lint:fix && cd ..
 exec foreman start -f Procfile.docs "$@"

data/bin/featuremap

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
 
+# NOTE:  bundler/setup is required to reference local library code
+#        rather than a system installed version of feature_map.
+require 'bundler/setup'
 require 'feature_map'
 FeatureMap::Cli.run!(ARGV)

data/bin/jekyll

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'jekyll' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('jekyll', 'jekyll')

data/bin/readme

@@ -6,4 +6,5 @@ if ! gem list foreman -i --silent; then
 fi
 
 cp ./lib/feature_map/private/docs/index.html ./readme/example-docs-site.html
+cd readme && npm i && cd ..
 exec foreman start -f Procfile.readme "$@"

data/bin/rspec

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/lib/feature_map/cli.rb

@@ -1,3 +1,4 @@
+# @feature Core Library
 require 'optparse'
 require 'pathname'
 require 'fileutils'
@@ -152,30 +153,67 @@ module FeatureMap
     end
 
     def self.test_coverage!(argv)
+      options = {
+        source: :codecov,
+        simplecov_paths: []
+      }
+
       parser = OptionParser.new do |opts|
         opts.banner = <<~MSG
           Usage: bin/featuremap test_coverage [options] [code_cov_commit_sha].
-          Note:  Requires environment variable `CODECOV_API_TOKEN`.
+
+          Options:
+            --use-simplecov             Use SimpleCov instead of CodeCov
+            --simplecov-path PATH       Path to a SimpleCov resultset.json file (can be specified multiple times)
+
+          Note:#{'  '}
+            - CodeCov mode requires environment variable `CODECOV_API_TOKEN`
+            - CodeCov mode uses the provided commit SHA or defaults to the latest commit on main
+            - SimpleCov mode requires at least one path to be specified with --simplecov-path
+            - SimpleCov and CodeCov modes cannot be used together
         MSG
 
+        opts.on('--use-simplecov', 'Use SimpleCov instead of CodeCov') do
+          options[:source] = :simplecov
+        end
+
+        opts.on('--simplecov-path PATH', 'Use SimpleCov JSON resultset file instead of CodeCov.  May be specified multiple times.') do |path|
+          options[:simplecov_paths] << path
+        end
+
         opts.on('--help', 'Shows this prompt') do
           puts opts
           exit
         end
       end
+
       args = parser.order!(argv)
       parser.parse!(args)
       non_flag_args = argv.reject { |arg| arg.start_with?('--') }
       custom_commit_sha = non_flag_args[0]
 
-      code_cov_token = ENV.fetch('CODECOV_API_TOKEN', '')
-      raise 'Please specify a CodeCov API token in your environment as `CODECOV_API_TOKEN`' if code_cov_token.empty?
+      case options[:source]
+      when :codecov
+        code_cov_token = ENV.fetch('CODECOV_API_TOKEN', '')
+        raise 'Please specify a CodeCov API token in your environment as `CODECOV_API_TOKEN`' if code_cov_token.empty?
+
+        # If no commit SHA was provided in the CLI command args, use the most recent commit of the main branch in the upstream remote.
+        commit_sha = custom_commit_sha || `git log -1 --format=%H origin/main`.chomp
+        puts "Pulling test coverage statistics for commit #{commit_sha}"
 
-      # If no commit SHA was providid in the CLI command args, use the most recent commit of the main branch in the upstream remote.
-      commit_sha = custom_commit_sha || `git log -1 --format=%H origin/main`.chomp
-      puts "Pulling test coverage statistics for commit #{commit_sha}"
+        FeatureMap.gather_test_coverage!(commit_sha, code_cov_token)
+      when :simplecov
+        missing_paths = options[:simplecov_paths].reject { |path| File.exist?(path) }
+        raise 'Error: When using --use-simplecov, you must specify at least one path with --simplecov-path.' if options[:simplecov_paths].empty?
+        raise "SimpleCov results file not found: #{missing_paths.join(', ')}" if missing_paths.any?
+        raise 'Error: Cannot specify a commit SHA when using --simplecov. These options are incompatible.' if custom_commit_sha
 
-      FeatureMap.gather_test_coverage!(commit_sha, code_cov_token)
+        puts "Gathering test coverage statistics from SimpleCov files: #{options[:simplecov_paths].join(', ')}"
+
+        FeatureMap.gather_simplecov_test_coverage!(options[:simplecov_paths])
+      else
+        raise 'Invalid source'
+      end
 
       puts OutputColor.green('FeatureMap test coverage statistics collected.')
       puts 'View the resulting test coverage for each feature in .feature_map/test-coverage.yml'

data/lib/feature_map/code_features.rb

@@ -1,3 +1,4 @@
+# @feature Code Features
 # frozen_string_literal: true
 
 require 'yaml'

data/lib/feature_map/commit.rb

@@ -1,3 +1,4 @@
+# @feature Core Library
 module FeatureMap
   class Commit
     attr_reader :sha

data/lib/feature_map/configuration.rb

@@ -1,3 +1,4 @@
+# @feature Core Library
 module FeatureMap
   class Configuration
     attr_reader :assigned_globs

data/lib/feature_map/constants.rb

@@ -1,3 +1,4 @@
+# @feature Core Library
 # frozen_string_literal: true
 
 module FeatureMap

data/lib/feature_map/mapper.rb

@@ -1,3 +1,4 @@
+# @feature Core Library
 # frozen_string_literal: true
 
 module FeatureMap

data/lib/feature_map/output_color.rb

@@ -1,3 +1,4 @@
+# @feature Core Library
 # frozen_string_literal: true
 
 module OutputColor

data/lib/feature_map/private/additional_metrics_file.rb

@@ -1,3 +1,4 @@
+# @feature Metrics Storage
 # frozen_string_literal: true
 
 module FeatureMap

data/lib/feature_map/private/assignment_applicator.rb

@@ -1,3 +1,4 @@
+# @feature Feature Assignment
 # frozen_string_literal: true
 
 module FeatureMap

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

@@ -13,6 +13,13 @@ module FeatureMap
           return @@map_files_to_features if @@map_files_to_features&.keys && @@map_files_to_features.keys.count.positive?
 
           @@map_files_to_features = CodeFeatures.all.each_with_object({}) do |feature, map| # rubocop:disable Style/ClassVars
+            # NOTE:  The FeatureDefinitionAssignment naively assumes that all
+            #        features will have a definition yaml file.  This comes from
+            #        the CodeOwnership implementation which does require these
+            #        files to exist.  This is not true in repositories using the
+            #        feature_definitions.csv style of feature definition.
+            next if feature.config_yml.nil?
+
             map[feature.config_yml] = feature
           end
         end
@@ -27,6 +34,13 @@ module FeatureMap
           return {} if Private.configuration.ignore_feature_definitions
 
           CodeFeatures.all.each_with_object({}) do |feature, map|
+            # NOTE:  The FeatureDefinitionAssignment naively assumes that all
+            #        features will have a definition yaml file.  This comes from
+            #        the CodeOwnership implementation which does require these
+            #        files to exist.  This is not true in repositories using the
+            #        feature_definitions.csv style of feature definition.
+            next if feature.config_yml.nil?
+
             map[feature.config_yml] = feature
           end
         end

data/lib/feature_map/private/assignments_file.rb

@@ -1,3 +1,4 @@
+# @feature Feature Assignment
 # frozen_string_literal: true
 
 require 'code_ownership'

data/lib/feature_map/private/code_cov.rb

@@ -1,3 +1,4 @@
+# @feature Testing Tools
 # frozen_string_literal: true
 
 require 'faraday'

data/lib/feature_map/private/cyclomatic_complexity_calculator.rb

@@ -1,3 +1,4 @@
+# @feature Metrics Calculation
 # frozen_string_literal: true
 
 require 'parser/current'