gitlab-crystalball 0.7.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3059723052c6c3bfe9f58ee458b2ab15ef18aaf4227c4ec3a5eeefd53c8630e1
-  data.tar.gz: 892c339d1bf8bbf599dba57b6bbf45b1f0ab8dfb1c41b2df1c279c22a6df8d24
+  metadata.gz: 4ecaca1010fa8832b924a6acd3e9163175ffa144a13b8d298ee35d5b8baaf546
+  data.tar.gz: 84af3bed1b01cdd235c881e948c033da9a630102ad6133ac3b181df24dc52545
 SHA512:
-  metadata.gz: c9e81eef06568c4b5dd3c757d8507427d448cf48a7f050704c877abc23f5f7711f769e16f3ef75f08aa4797dd4c0fb2120dceb6ca1ce7add83cf7b73f6fcab27
-  data.tar.gz: 71106979d5350594e4344d3404e9bc1bcc282b81c5180ca8e0e51ab73dbb7c760ab35402444e71fcb95cea6c258bf6dab756d6adfecc363b87c4c8ac6bf362a3
+  metadata.gz: e9fac346de4eb92f888b3fe3cad20c5618058f329c76b7c3b08e61b2ac0ac913f2e52f650c568b017cb38280ee4dd62f1ae68c3155eacc31f1efbfdb33e9582c
+  data.tar.gz: d9b2d7d86a787e8bed3c4ade3561d58593f8f146a477babfab4ed63a638b9c2d52059b44777dc250f1eec082f360f285effa1c7054f7569175284b1c78ed549a

data/README.md

@@ -1,7 +1,7 @@
 # Crystalball
 
-![Build Status](https://gitlab.com/acunskis/crystalball/badges/main/pipeline.svg)
-![Test Coverage](https://gitlab.com/acunskis/crystalball/badges/main/coverage.svg?job=rspec)
+![Build Status](https://gitlab.com/gitlab-org/ruby/gems/crystalball/badges/main/pipeline.svg)
+![Test Coverage](https://gitlab.com/gitlab-org/ruby/gems/crystalball/badges/main/coverage.svg?job=rspec%20spec)
 
 Crystalball is a Ruby library which implements [Regression Test Selection mechanism](https://tenderlovemaking.com/2015/02/13/predicting-test-failues.html) originally published by Aaron Patterson.
 Its main purpose is to select a minimal subset of your test suite which should be run to ensure your changes didn't break anything.
@@ -30,11 +30,11 @@ Or install it yourself as:
 
 ## Usage
 
-Please see our [official documentation](https://gitlab.com/acunskis/crystalball/-/blob/main/docs/index.md).
+Please see our [official documentation](https://gitlab.com/gitlab-org/ruby/gems/crystalball/-/blob/main/docs/index.md).
 
 ### Versioning
 
-We use [semantic versioning](https://semver.org/) for our [releases](https://gitlab.com/acunskis/crystalball/-/releases).
+We use [semantic versioning](https://semver.org/) for our [releases](https://gitlab.com/gitlab-org/ruby/gems/crystalball/-/releases).
 
 ## Development
 

data/lib/crystalball/map_generator/coverage_strategy/execution_detector.rb

@@ -8,6 +8,7 @@ module Crystalball
       # Class for detecting code execution path based on coverage information diff
       class ExecutionDetector
         include ::Crystalball::MapGenerator::Helpers::PathFilter
+
         # Detects files affected during example execution. Transforms absolute paths to relative.
         # Exclude paths outside of repository
         #
@@ -15,7 +16,15 @@ module Crystalball
         # @param[Array<String>] list of files affected after example execution
         # @return [Array<String>]
         def detect(before, after)
-          filter after.reject { |file_name, after_coverage| before[file_name] == after_coverage }.keys
+          after.filter_map do |file, coverage|
+            before_cov = before[file]&.fetch(:lines, [])
+            next if before_cov == coverage[:lines]
+
+            path = valid_path(file)
+            next unless path
+
+            path
+          end
         end
       end
     end

data/lib/crystalball/map_generator/coverage_strategy.rb

@@ -12,12 +12,12 @@ module Crystalball
 
       attr_reader :execution_detector
 
-      def initialize(execution_detector = ExecutionDetector.new)
+      def initialize(execution_detector: ExecutionDetector.new)
         @execution_detector = execution_detector
       end
 
       def after_register
-        Coverage.start unless Coverage.running?
+        Coverage.start(lines: true) unless Coverage.running?
       end
 
       # Adds to the example_map's used files the ones the ones in which

data/lib/crystalball/map_generator/helpers/path_filter.rb

@@ -5,19 +5,38 @@ module Crystalball
     module Helpers
       # Helper module to filter file paths
       module PathFilter
-        attr_reader :root_path
+        attr_reader :root_path, :exclude_prefixes
 
         # @param [String] root_path - absolute path to root folder of repository
-        def initialize(root_path = Dir.pwd)
+        # @param [Array] exclude_prefixes - list of prefixes to filter out from paths
+        def initialize(root_path = Dir.pwd, exclude_prefixes: [])
           @root_path = root_path
+          @exclude_prefixes = exclude_prefixes
         end
 
         # @param [Array<String>] paths
-        # @return relatve paths inside root_path only
+        # @return relative paths inside root_path only
         def filter(paths)
-          paths
-            .select { |file_name| file_name.start_with?(root_path) }
-            .map { |file_name| file_name.sub("#{root_path}/", "") }
+          paths.filter_map do |path|
+            next unless path.start_with?(root_path)
+
+            valid_path(path)
+          end
+        end
+
+        private
+
+        # Return relative path if it is a valid path
+        #
+        # @param path [String]
+        # @return [<String, nil>]
+        def valid_path(path)
+          return unless path.start_with?(root_path)
+
+          relative_path = path.sub("#{root_path}/", "")
+          return if exclude_prefixes&.any? { |prefix| relative_path.start_with?(prefix) }
+
+          relative_path
         end
       end
     end

data/lib/crystalball/map_generator/object_sources_detector.rb

@@ -13,11 +13,12 @@ module Crystalball
       attr_reader :definition_tracer, :hierarchy_fetcher
 
       def initialize(
-        root_path:,
+        root_path: Dir.pwd,
         definition_tracer: DefinitionTracer.new(root_path),
-        hierarchy_fetcher: HierarchyFetcher.new
+        hierarchy_fetcher: HierarchyFetcher.new,
+        exclude_prefixes: []
       )
-        super(root_path)
+        super(root_path, exclude_prefixes: exclude_prefixes)
 
         @definition_tracer = definition_tracer
         @hierarchy_fetcher = hierarchy_fetcher

data/lib/crystalball/map_generator/oneshot_coverage_strategy.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "coverage"
+require "crystalball/map_generator/base_strategy"
+
+require_relative "helpers/path_filter"
+
+module Crystalball
+  class MapGenerator
+    # Map generator strategy based on harvesting Coverage information during example execution
+    class OneshotCoverageStrategy
+      include BaseStrategy
+      include Helpers::PathFilter
+
+      def after_register
+        raise "Coverage must not be started for oneshot_line strategy" if Coverage.running?
+      end
+
+      # Adds to the example_map's used files the ones the ones in which
+      # the coverage has changed after the tests runs.
+      # @param [Crystalball::ExampleGroupMap] example_map - object holding example metadata and used files
+      # @param [RSpec::Core::Example] example - a RSpec example
+      def call(example_map, example)
+        Coverage.start(oneshot_lines: true)
+        yield example_map, example
+        paths = Coverage.result.keys
+        example_map.push(*filter(paths))
+      end
+    end
+  end
+end

data/lib/crystalball/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Crystalball
-  VERSION = "0.7.2"
+  VERSION = "0.8.1"
 end

data/lib/crystalball.rb

@@ -16,6 +16,7 @@ require "crystalball/execution_map"
 require "crystalball/map_generator"
 require "crystalball/map_generator/configuration"
 require "crystalball/map_generator/coverage_strategy"
+require "crystalball/map_generator/oneshot_coverage_strategy"
 require "crystalball/map_generator/allocated_objects_strategy"
 require "crystalball/map_generator/described_class_strategy"
 require "crystalball/map_storage/yaml_storage"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-crystalball
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.1
 platform: ruby
 authors:
 - Developer Experience Team
 bindir: bin
 cert_chain: []
-date: 2025-05-08 00:00:00.000000000 Z
+date: 2025-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -23,6 +23,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
@@ -247,6 +261,7 @@ files:
 - lib/crystalball/map_generator/object_sources_detector.rb
 - lib/crystalball/map_generator/object_sources_detector/definition_tracer.rb
 - lib/crystalball/map_generator/object_sources_detector/hierarchy_fetcher.rb
+- lib/crystalball/map_generator/oneshot_coverage_strategy.rb
 - lib/crystalball/map_generator/parser_strategy.rb
 - lib/crystalball/map_generator/parser_strategy/processor.rb
 - lib/crystalball/map_generator/strategies_collection.rb
@@ -285,14 +300,14 @@ files:
 - lib/crystalball/source_diff/file_diff.rb
 - lib/crystalball/source_diff/formatting_checker.rb
 - lib/crystalball/version.rb
-homepage: https://gitlab.com/acunskis/crystalball
+homepage: https://gitlab.com/gitlab-org/ruby/gems/crystalball
 licenses: []
 metadata:
-  bug_tracker_uri: https://gitlab.com/acunskis/crystalball/-/issues
-  changelog_uri: https://gitlab.com/acunskis/crystalball/-/releases
-  documentation_uri: https://gitlab.com/acunskis/crystalball/-/blob/main/docs/index.md
-  source_code_uri: https://gitlab.com/acunskis/crystalball/-/tree/main
-  wiki_uri: https://gitlab.com/acunskis/crystalball/-/wikis/home
+  bug_tracker_uri: https://gitlab.com/gitlab-org/ruby/gems/crystalball/-/issues
+  changelog_uri: https://gitlab.com/gitlab-org/ruby/gems/crystalball/-/releases
+  documentation_uri: https://gitlab.com/gitlab-org/ruby/gems/crystalball/-/blob/main/docs/index.md
+  source_code_uri: https://gitlab.com/gitlab-org/ruby/gems/crystalball/-/tree/main
+  wiki_uri: https://gitlab.com/gitlab-org/ruby/gems/crystalball/-/wikis/home
   rubygems_mfa_required: 'false'
 rdoc_options: []
 require_paths: