gouteur 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56cca423043e101ebc4014b3b5bb4bc8edf1dd27ce25493b6ec918fe6da669c8
-  data.tar.gz: a92f38d08ce56549acae5b6696e2519f0cbef9820750bb29cef419f867448ccc
+  metadata.gz: ec10a96202fe527dacc5f4bf12342b15bd6f97e1ee34ea061ed09b9493185d56
+  data.tar.gz: df1daa88ea3074c2007573a76234c1db4e006e2d6c9994f65b585c070d739fd8
 SHA512:
-  metadata.gz: 56dfc4cb69657e92322d1e7105bb8d2df73de9b230673758eb98842ec39b5033e56d7d7c6ba39a41a8149734c0db6898157844b7f3b31427febd9b5711cbef2b
-  data.tar.gz: 9b5ceb4857337045681e84448301cafb8985f441816c8f9188706f70b5e95f736b62d739bc90d0abe9f46a4888ff6b59702d3c511e79b193d65ec8beaa337318
+  metadata.gz: edfc25b8299250c7770d68745b17df443d5757a01234eae0d826efa6232a14faacc10ced6bceaf982a0a7749fcfd5e9cfe734bdd3bcee10cc8e9ae41e3523274
+  data.tar.gz: 4cedcee12cf24b8318567df163f7a9ebb6617124185564d0568dad4a11f180b6a81967e409ee1c642bc68557303f585f3c52100ac6e020a874d9e4b73cc62f18

data/.github/workflows/build.yml

@@ -8,10 +8,10 @@ jobs:
 
     strategy:
       matrix:
-        ruby: [ '2.6', '3.0', 'ruby-head' ]
+        ruby: [ '3.5', '4.0' ]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
@@ -21,8 +21,11 @@ jobs:
           git config --global init.defaultBranch main
           git config --global user.email "testuser@example.com"
           git config --global user.name "Test User"
-          gem install bundler -v 2.2.8
+          gem update --system
+          gem install bundler -v 4.0.9
           bundle install --jobs 4
-      - name: Run the specs
+      - name: Build
         run: |
-          bundle exec rspec
+          bundle exec rake
+      - uses: codecov/codecov-action@v3
+        if: matrix.ruby == '4.0'

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [1.2.0] - 2026-04-04
+
+### Added
+
+- Support for repos where the bundle is in a subdirectory
+
 ## [1.1.0] - 2023-02-21
 
 ### Added

data/Gemfile

@@ -3,14 +3,12 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in gouteur.gemspec
 gemspec
 
+gem 'debug'
+gem 'example_repo', '0.1.0', path: './spec/gouteur/example_repo'
 gem 'rake', '~> 13.0'
-
+gem 'relaxed-rubocop'
 gem 'rspec', '~> 3.0'
-
 gem 'rubocop', '~> 1.7'
-
-gem 'relaxed-rubocop'
-
-gem 'example_repo', '0.1.0', path: './spec/gouteur/example_repo'
-
-gem 'debug'
+if RUBY_VERSION.to_f >= 3.0
+  gem "simplecov-cobertura"
+end

data/Gemfile.lock

@@ -11,52 +11,88 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    debug (1.7.1)
-      irb (>= 1.5.0)
-      reline (>= 0.3.1)
-    diff-lcs (1.5.0)
-    io-console (0.6.0)
-    irb (1.6.2)
-      reline (>= 0.3.0)
-    json (2.6.3)
-    parallel (1.22.1)
-    parser (3.2.1.0)
+    ast (2.4.3)
+    date (3.5.1)
+    debug (1.11.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    erb (6.0.2)
+    io-console (0.8.2)
+    irb (1.17.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.19.3)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.28.0)
+    parser (3.3.11.1)
       ast (~> 2.4.1)
+      racc
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    psych (5.3.1)
+      date
+      stringio
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.7.0)
+    rake (13.3.1)
+    rdoc (7.2.0)
+      erb
+      psych (>= 4.0.0)
+      tsort
+    regexp_parser (2.12.0)
     relaxed-rubocop (2.5)
-    reline (0.3.2)
+    reline (0.6.3)
       io-console (~> 0.5)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rexml (3.4.4)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.45.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    rubocop (1.86.0)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.26.0)
-      parser (>= 3.2.1.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.4.2)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (3.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    stringio (3.2.0)
+    tsort (0.2.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
 
 PLATFORMS
   ruby
@@ -69,6 +105,7 @@ DEPENDENCIES
   relaxed-rubocop
   rspec (~> 3.0)
   rubocop (~> 1.7)
+  simplecov-cobertura
 
 BUNDLED WITH
-   2.2.8
+  4.0.9

data/README.md

@@ -2,6 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/gouteur.svg)](http://badge.fury.io/rb/gouteur)
 [![Build Status](https://github.com/jaynetics/gouteur/workflows/build/badge.svg)](https://github.com/jaynetics/gouteur/actions)
+[![Coverage](https://codecov.io/gh/jaynetics/gouteur/branch/main/graph/badge.svg?token=519NAAEQFC)](https://codecov.io/gh/jaynetics/gouteur)
 
 Treat the people that use your gem like royalty! Send for a [gouteur](https://en.wikipedia.org/wiki/Food_taster) before serving them something new!
 
@@ -29,17 +30,12 @@ Add `gouteur` to the development dependencies of your gem.
 
 ### Recommended usage
 
-Create a `.gouteur.yml` in the root of your project:
+Create a `.gouteur.yml` in the root of your project and add the gems you want to test against:
 
 ```yml
 repos:
   - uri: https://github.com/someone/some_gem
-    ref: some_specific_branch # optional, default is the default branch
-    before: setup_special_dependency # optional, bundle is always installed
-    tasks: ['rspec', 'rake foo'] # optional, default is `rake`
-    name: cool_gem # optional, defaults to repo name from uri, e.g. `some_gem`
-    locked: true # optional, prevents setting an incompatible VERSION
-    force: true # optional, forces test even if VERSION is incompatible
+  - uri: https://github.com/someone/another_gem
 ```
 
 Then simply `bundle exec gouteur` or add the rake task to your Rakefile:
@@ -52,13 +48,30 @@ Gouteur::RakeTask.new
 task default: %i[rspec gouteur]
 ```
 
-Pro tip: for large repos, running only relevant specs can speed up things a lot, e.g.:
+Pro tip: gouteur executes the default rake task of each gem by default, but for large repos, running only relevant specs can speed up things a lot, e.g.:
 
 ```yml
-tasks: 'rspec spec/known_relevant_spec.rb'
+repos:
+  - uri: some_gem_uri
+    tasks: 'rspec spec/known_relevant_spec.rb'
+  - uri: some_other_uri
+    tasks: 'rspec --pattern "**/{,*}{keyword1,keyword2}{,*,*/**/*}_spec.rb"'`
 ```
+
+### Other configuration options
+
+There are many other configuration options. All except the `uri` are optional.
+
 ```yml
-tasks: 'rspec --pattern "**/{,*}{keyword1,keyword2}{,*,*/**/*}_spec.rb"'`
+repos:
+  - uri: https://github.com/someone/some_gem
+    ref: some_specific_branch # default is the default branch
+    subdir: the_actual_gem # if gem is in a subdir of the repo
+    before: setup_special_dependency # bundle is always installed
+    tasks: ['rspec', 'rake foo'] # default is `rake`
+    name: cool_gem # defaults to repo name from uri, e.g. `some_gem`
+    locked: true # prevents setting an incompatible VERSION
+    force: true # forces test even if VERSION is incompatible
 ```
 
 ### Manual usage
@@ -88,6 +101,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jaynet
 
 Possible future improvements:
 
+- verbose mode
 - consider caching of dependent repositories in CI, e.g. in GitHub workflows
 - support more sources of code, e.g. latest release, private GitHub repositories
 - improve performance by tracing & rerunning only specs/tests that use the gem

data/Rakefile

@@ -7,7 +7,7 @@ require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i[rubocop spec]
 
 require_relative 'lib/gouteur/rake_task'
 Gouteur::RakeTask.new

data/lib/gouteur/bundle.rb

@@ -16,7 +16,7 @@ module Gouteur
     end
 
     def exec(task, env: {})
-      name = task.sub(/bundle exec +/, '')
+      name = task.sub(/bundle +exec +/, '')
       Shell.run(%W[bundle exec #{name}], pwd: path, env: env)
     end
 

data/lib/gouteur/message.rb

@@ -14,7 +14,7 @@ module Gouteur
 
     def success(repo:)
       <<~MSG
-        👨‍🍳 #{random_word_for_tasty.capitalize}!
+        👨‍🍳👍 #{random_word_for_tasty.capitalize}!
 
         Your changes to `#{Host.name}` are fine for `#{repo}`. All tasks succeeded.
       MSG
@@ -58,7 +58,7 @@ module Gouteur
 
     def broken_after_update(repo:, task:, output:, error:)
       <<~MSG
-        👨‍🍳 #{random_word_for_disgusting.capitalize}!
+        👨‍🍳👎 #{random_word_for_disgusting.capitalize}!
 
         Task `#{task}` failed for `#{repo}` after inserting the new code of `#{Host.name}`.
 

data/lib/gouteur/repo.rb

@@ -3,7 +3,7 @@ require 'uri'
 module Gouteur
   # a repository of code that depends on the library under test
   class Repo
-    attr_reader :uri, :name, :ref, :tasks
+    attr_reader :uri, :name, :ref, :tasks, :subdir
     alias to_s name
 
     def initialize(
@@ -13,7 +13,8 @@ module Gouteur
       before: [],
       tasks:  'rake',
       locked: false,
-      force:  false
+      force:  false,
+      subdir: nil
     )
       @uri    = uri
       @name   = name || extract_name_from_uri(uri)
@@ -22,10 +23,12 @@ module Gouteur
       @tasks  = Array(tasks)
       @locked = !!locked
       @force  = !!force
+      @subdir = subdir
     end
 
     def fetch
       cloned? ? pull : clone
+      validate_subdir if subdir
     end
 
     def prepare
@@ -40,8 +43,12 @@ module Gouteur
       File.join(store_dir, name)
     end
 
+    def bundle_path
+      subdir ? File.join(clone_path, subdir) : clone_path
+    end
+
     def bundle
-      @bundle ||= Gouteur::Bundle.new(clone_path)
+      @bundle ||= Gouteur::Bundle.new(bundle_path)
     end
 
     def gemfile
@@ -57,7 +64,7 @@ module Gouteur
     end
 
     def remove_host_from_gemspecs
-      Dir[File.join(clone_path, '*.gemspec')].each do |gemspec_path|
+      Dir[File.join(bundle_path, '*.gemspec')].each do |gemspec_path|
         content = File.read(gemspec_path)
         new_content = content.gsub(/^.+_dependency.+\b#{Host.name}\b.+$/, '')
         File.write(gemspec_path, new_content)
@@ -66,6 +73,11 @@ module Gouteur
 
     private
 
+    def validate_subdir
+      File.directory?(bundle_path) ||
+        raise(Error, "subdirectory `#{subdir}` not found in `#{name}`")
+    end
+
     def extract_name_from_uri(uri)
       uri[%r{git(?:hub|lab)\.com/[^/]+/([^/]+)}, 1] ||
         uri.split('/').last.to_s[/[a-z0-9\-_]+/i] ||

data/lib/gouteur/version.rb

@@ -1,3 +1,3 @@
 module Gouteur
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gouteur
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Janosch Müller
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Run tests of dependent gems against your changes.
 email:
@@ -19,7 +18,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/build.yml"
-- ".github/workflows/lint.yml"
 - ".gitignore"
 - ".gouteur.yml"
 - ".rspec"
@@ -53,7 +51,6 @@ metadata:
   homepage_uri: https://github.com/jaynetics/gouteur
   source_code_uri: https://github.com/jaynetics/gouteur
   changelog_uri: https://github.com/jaynetics/gouteur/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -68,8 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: See if your lib is still digestible.
 test_files: []

data/.github/workflows/lint.yml

@@ -1,29 +0,0 @@
-# based on https://github.com/rails/rails/blob/4a78dcb/.github/workflows/rubocop.yml
-
-name: rubocop linting
-
-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: 3.0
-    - name: Cache gems
-      uses: actions/cache@v1
-      with:
-        path: vendor/bundle
-        key: ${{ runner.os }}-rubocop-${{ hashFiles('**/Gemfile.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-rubocop-
-    - name: Install gems
-      run: |
-        bundle config path vendor/bundle
-        bundle install --jobs 4 --retry 3
-    - name: Run rubocop
-      run: bundle exec rubocop