rspec-big-infer 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db7e04301f8aeda4523f3570a1a6d289c94007a1b2b9b39b0eceff30172f2f41
+  data.tar.gz: 9227adbe57bf51c7e37586260b3008b48fff17f1075c93eb14a9ff6992e8de7d
+SHA512:
+  metadata.gz: a5849499d80ad460d82531ce4ad5fc61f4bb3e6678364c11fd673ddb049f6b6f6dc0828327ef6cdcb400c544ef8ea0f0fed4d00e919232bb15a1460b71f740fe
+  data.tar.gz: b17753f2062279b0ca231da662612f19eb30b7d4639c2870647b971dba515cf60a86b16115f8198d617f138c34f73cfc4c7bd95b372674941525a80a7401b481

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.5.7
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.14
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+# rspec failure tracking
+.rspec_status

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  NewCops: enable
+  Include:
+    - 'exe/**/*'
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/MultilineBlockChain:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rspec-big-infer.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.7"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 iPePe.pl Open Source Software
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,18 @@
+# Rspec::Big::Infer
+
+`rspec-big-infer` is a set of helper tools that help working (testing) with big projects.
+
+## Installation
+
+Execute this command to add gem to your application's Gemfile:
+
+```ruby
+bundle add rspec-big-infer
+```
+
+## Usage - infer which tests to run based on the changes in the codebase
+
+1. Generate tests map with: `bundle exec rspec --dry-run --format Rspec::Big::Infer::Formatter --out tmp/rspec_infer.json`
+  * 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.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rspec/big/infer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/rspec-big-infer

@@ -0,0 +1,22 @@
+#!/bin/env ruby
+# frozen_string_literal: true
+
+require "json"
+
+# Load the examples from the JSON file
+if ARGV[0]
+  path = 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
+
+else
+  warn "Usage: git diff --name-only origin/develop | rspec-big-infer <path to JSON test map file>"
+  exit 1
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rspec/core/formatters/json_formatter"
+
+module Rspec
+  module Big
+    module Infer
+      class Formatter < RSpec::Core::Formatters::JsonFormatter
+        ::RSpec::Core::Formatters.register self
+
+        private
+
+        def format_example(example)
+          return unless example.example_group.described_class.is_a?(Class)
+
+          {
+            test_file_path: relative_path(example.file_path),
+            described_class_defined_source_location: source_location(example.example_group.described_class),
+          }
+        end
+
+        def source_location(klass)
+          relative_path(klass.const_source_location(klass.name).first)
+        end
+
+        def relative_path(path)
+          if path.start_with?('./')
+            path.sub('./', '')
+          elsif path.start_with?('/')
+            path.sub(%r{^#{Dir.pwd}/}, '')
+          else
+            path
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Big
+    module Infer
+      VERSION = "0.5.0"
+    end
+  end
+end

data/lib/rspec/big/infer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "infer/version"
+require_relative "infer/formatter"
+
+module Rspec
+  module Big
+    module Infer
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end

data/publish.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+rm -f rspec-big-infer-*.gem
+gem build rspec-big-infer.gemspec
+gem push rspec-big-infer-*.gem

data/rspec-big-infer.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/rspec/big/infer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-big-infer"
+  spec.version       = Rspec::Big::Infer::VERSION
+  spec.authors       = ["Patryk Ptasinski"]
+  spec.email         = ["patryk@ipepe.pl"]
+
+  spec.summary       = "Infer which RSpec test files to run based on currently changed files"
+  spec.homepage      = "https://github.com/ipepe-oss/rspec-big-infer"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.1.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = ["rspec-big-infer"]
+  spec.require_paths = ["lib"]
+  spec.add_dependency "rspec-core", "~> 3"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/rspec/big/infer.rbs

@@ -0,0 +1,8 @@
+module Rspec
+  module Big
+    module Infer
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: rspec-big-infer
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Patryk Ptasinski
+bindir: exe
+cert_chain: []
+date: 2025-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+email:
+- patryk@ipepe.pl
+executables:
+- rspec-big-infer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rspec-big-infer
+- lib/rspec/big/infer.rb
+- lib/rspec/big/infer/formatter.rb
+- lib/rspec/big/infer/version.rb
+- publish.sh
+- rspec-big-infer.gemspec
+- sig/rspec/big/infer.rbs
+homepage: https://github.com/ipepe-oss/rspec-big-infer
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  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
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Infer which RSpec test files to run based on currently changed files
+test_files: []