rspec-big-infer 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78e761a682c1b7714b753d094a6fc3243828b036f5ae1f2d9e8d1b54dc0e1a08
-  data.tar.gz: 5b94f872e3112278687d9af0274b04cc1ea752f8b7527655ba053e19504cd6fe
+  metadata.gz: 2d2ddea7669bd0be18eee681c20b8e6d5088a1a2002c53ab52af10c7f60935fa
+  data.tar.gz: ffa4f684720c88b363c5df24fecb54b7879650e2c44ed644028706e07d36abef
 SHA512:
-  metadata.gz: 1aeda066d27c1538ca9a4ab999654cb34f22b87c69800db4e23b23c640dee232e3270e97969e5873b093b754bdab23310c2674670c674dca0f3fe2bdaae32daf
-  data.tar.gz: bd4d76f00a3b41e896722539ce40eb0ce060dc6ff361e0b44295612d0240de6b7ab1fda46808cced918ab2a41b3d4404718bba76d3c6f779390a6e6ffe08e125
+  metadata.gz: 41423c065b1d9c97f6993f3f8f06b18cc5252f608e1f42278245b4ac1d6772c1b8524971cfb2ee21ded17e2382828e44703267c2d6dc6b0f100b13c826b07517
+  data.tar.gz: b038efc5501ac5007eb20858ec29e257b43ce04eaa41e4d28d19e1324daffef0e669ce38b9c35aef6ba07d5aebdac2c045e571c85fd26e46751db05f2ad7415d

data/Gemfile

@@ -10,3 +10,7 @@ gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 
 gem "rubocop", "~> 1.7"
+
+group :development do
+  gem "rspec", "~> 3"
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    rspec-big-infer (0.7.0)
+      rspec-core (~> 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    diff-lcs (1.6.2)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    minitest (5.25.5)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    regexp_parser (2.10.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.4)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
+    rubocop (1.76.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.45.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rspec (~> 3)
+  rspec-big-infer!
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.6.7

data/README.md

@@ -16,3 +16,30 @@ bundle add rspec-big-infer
   * It works based on `described_class` and `const_source_location`
 2. (optional) Printout tests that will be run based on infer: `git diff --name-only --diff-filter=D origin/develop | bundle exec rspec-big-infer tmp/rspec_infer.json`
 3. Run tests with `bundle exec rspec $(git diff --name-only --diff-filter=D origin/develop | bundle exec rspec-big-infer tmp/rspec_infer.json)` to run tests based on the changes in the codebase.
+
+## Example runner file
+
+`bin/run-infer-rspec`
+```bash
+#!/bin/bash
+
+set -e
+
+if [ -z "$(git status --porcelain)" ]; then
+  echo "Working directory is clean. Proceeding with the infer script..."
+else
+  echo "WARNING! Changes detected in the working directory. Infer script will not work correctly"
+fi
+
+echo "Updating git repository to get the latest changes from develop branch..."
+git fetch origin develop > /dev/null 2>&1 || echo "Warning: Could not fetch from origin/develop. Continuing without update."
+
+echo "Calculating relationships between files..."
+bundle exec rspec --dry-run --format RSpec::Big::Infer::Formatter --out tmp/rspec_infer.json 2> /dev/null
+
+echo "Parsing rspec_infer.json and suggesting tests to run..."
+git diff --name-only origin/develop | bundle exec rspec-big-infer tmp/rspec_infer.json
+
+echo "Running the tests..."
+bundle exec rspec $(git diff --name-only origin/develop | bundle exec rspec-big-infer tmp/rspec_infer.json)
+```

data/docs/adr/0001-add-rspec-development-dependency.md

@@ -0,0 +1,15 @@
+# 0001 Add RSpec development dependency
+
+Date: 2025-05-22
+
+## Status
+Accepted
+
+## Context
+RSpec is used for testing this gem, but it was not included in the Gemfile. Without it, running specs via Bundler fails.
+
+## Decision
+Add `gem "rspec", "~> 3"` under the `development` group in the Gemfile. Running `bundle install` will lock the dependency.
+
+## Consequences
+Developers can run `bundle exec rake spec` without globally installed RSpec. The gemspec remains unchanged.

data/docs/adr/0001-use-env-ruby-for-shebang.md

@@ -0,0 +1,16 @@
+# 1. Use `/usr/bin/env ruby` for shebang
+
+Date: 2025-06-05
+
+## Status
+Accepted
+
+## Context
+The executable `exe/rspec-big-infer` previously used `#!/bin/env ruby` as its shebang.
+Some systems do not provide `/bin/env`, but most provide `/usr/bin/env`.
+
+## Decision
+Update the shebang line in `exe/rspec-big-infer` to `#!/usr/bin/env ruby` to increase portability.
+
+## Consequences
+The script now uses the more common path for `env`, improving compatibility across environments.

data/exe/rspec-big-infer

@@ -1,4 +1,4 @@
-#!/bin/env ruby
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require "json"
@@ -9,12 +9,14 @@ if ARGV[0]
   all_rspec_examples = JSON.parse(File.read(path))["examples"]
   changed_files = $stdin.read.split("\n")
 
-  all_rspec_examples.compact.uniq.each do |test|
-    if changed_files.include?(test["described_class_defined_source_location"]) ||
-       changed_files.include?(test["test_file_path"])
-      puts test["test_file_path"]
-    end
-  end
+  puts(
+    all_rspec_examples.compact.map do |test|
+      if changed_files.include?(test["described_class_defined_source_location"]) ||
+        changed_files.include?(test["test_file_path"])
+        test["test_file_path"]
+      end
+    end.compact.uniq.join("\n")
+  )
 
 else
   warn "Usage: git diff --name-only origin/develop | rspec-big-infer <path to JSON test map file>"

data/lib/rspec/big/infer/formatter.rb

@@ -12,7 +12,9 @@ module RSpec
         private
 
         def format_example(example)
-          return unless example.example_group.described_class.is_a?(Class)
+          return if already_processed?(example.file_path)
+
+          already_processed!(example.file_path)
 
           {
             test_file_path: relative_path(example.file_path),
@@ -21,6 +23,8 @@ module RSpec
         end
 
         def source_location(klass)
+          return unless klass.is_a?(Class)
+
           relative_path(klass.const_source_location(klass.name).first)
         end
 
@@ -33,6 +37,19 @@ module RSpec
             path
           end
         end
+
+        def already_processed!(test_file_path)
+          # Prevents the formatter from processing the same file multiple times
+          @already_processed ||= Set.new
+          return if @already_processed.include?(test_file_path)
+
+          @already_processed.add(test_file_path)
+        end
+
+        def already_processed?(test_file_path)
+          @already_processed ||= Set.new
+          @already_processed.include?(test_file_path)
+        end
       end
     end
   end

data/lib/rspec/big/infer/version.rb

@@ -3,7 +3,7 @@
 module RSpec
   module Big
     module Infer
-      VERSION = "0.7.0"
+      VERSION = "0.8.0"
     end
   end
 end

data/lib/rspec/big/infer.rb

@@ -8,7 +8,7 @@ module RSpec
   module Big
     module Infer
       class Error < StandardError; end
-      # Your code goes here...
+      # Provides helper tools for inferring which specs to run.
     end
   end
 end

data/rspec-big-infer.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = ["rspec-big-infer"]
   spec.require_paths = ["lib"]
   spec.add_dependency "rspec-core", "~> 3"
+  spec.add_development_dependency "rspec", "~> 3"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-big-infer
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Patryk Ptasinski
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-22 00:00:00.000000000 Z
+date: 2025-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -23,6 +24,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description:
 email:
 - patryk@ipepe.pl
 executables:
@@ -34,11 +50,14 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docs/adr/0001-add-rspec-development-dependency.md
+- docs/adr/0001-use-env-ruby-for-shebang.md
 - exe/rspec-big-infer
 - lib/rspec/big/infer.rb
 - lib/rspec/big/infer/formatter.rb
@@ -53,6 +72,7 @@ metadata:
   homepage_uri: https://github.com/ipepe-oss/rspec-big-infer
   source_code_uri: https://github.com/ipepe-oss/rspec-big-infer
   changelog_uri: https://github.com/ipepe-oss/rspec-big-infer
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -67,7 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Infer which RSpec test files to run based on currently changed files
 test_files: []