gouteur 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 174d0cdcc37fbca2d808a91be97a17feb70140ef403de6f95f91b0ce74e8beda
-  data.tar.gz: 6f886d8d85c43065b821371a916e44414580a5e5ead255d811916942d9387b70
+  metadata.gz: 56cca423043e101ebc4014b3b5bb4bc8edf1dd27ce25493b6ec918fe6da669c8
+  data.tar.gz: a92f38d08ce56549acae5b6696e2519f0cbef9820750bb29cef419f867448ccc
 SHA512:
-  metadata.gz: 7806e1a42dacd49fa222c7eb9c73f21373786540c7a8d2c06ae8bba06dfb71a5d98e8e81ff6bfcda063da86b91d377c7a2b01ab2a5ee4e6bf0fdeac638a472b6
-  data.tar.gz: 84c3649159b02083c7ac31d94e14657a04807cc05f99f41cea3ea35939106394e88337118ce2c72a384fa6ec0c41f83d3c92bf3ccd9ff980c6fcdde9b4e9b571
+  metadata.gz: 56dfc4cb69657e92322d1e7105bb8d2df73de9b230673758eb98842ec39b5033e56d7d7c6ba39a41a8149734c0db6898157844b7f3b31427febd9b5711cbef2b
+  data.tar.gz: 9b5ceb4857337045681e84448301cafb8985f441816c8f9188706f70b5e95f736b62d739bc90d0abe9f46a4888ff6b59702d3c511e79b193d65ec8beaa337318

data/.github/workflows/build.yml

@@ -8,7 +8,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby: [ '2.5', '3.0', 'ruby-head' ]
+        ruby: [ '2.6', '3.0', 'ruby-head' ]
 
     steps:
       - uses: actions/checkout@v2

data/.rubocop.yml

@@ -6,11 +6,20 @@ AllCops:
   SuggestExtensions: false
   TargetRubyVersion: 2.5
 
+Gemspec/RequireMFA:
+  Enabled: false
+
 Layout/LineLength:
   Max: 80
 
 Lint/AmbiguousBlockAssociation:
   Enabled: false
 
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
+Style/FetchEnvVar:
+  Enabled: false
+
 Style/FrozenStringLiteralComment:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
 
+## [1.1.0] - 2023-02-21
+
+### Added
+
+- Added force flag to force testing, irrespective of version constraints
+- Support passing dotfile repo names to CLI
+- Support setting custom names for repos in dotfile
+- Support git SSH/SCP addresses
+
+## [1.0.2] - 2022-09-24
+
+### Fixed
+
+- Fixed error message when a repo's `before` task fails
+- Fixed dependency version mismatch detection for recent bundler versions
+
 ## [1.0.1] - 2021-03-09
 
 ### Fixed

data/Gemfile

@@ -13,4 +13,4 @@ gem 'relaxed-rubocop'
 
 gem 'example_repo', '0.1.0', path: './spec/gouteur/example_repo'
 
-gem 'byebug'
+gem 'debug'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gouteur (1.0.0)
+    gouteur (1.1.0)
 
 PATH
   remote: spec/gouteur/example_repo
@@ -12,48 +12,57 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    byebug (11.1.3)
-    diff-lcs (1.4.4)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    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.1)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.0.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
     relaxed-rubocop (2.5)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    reline (0.3.2)
+      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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.9.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.45.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+      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.0.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  byebug
+  debug
   example_repo (= 0.1.0)!
   gouteur!
   rake (~> 13.0)

data/README.md

@@ -37,7 +37,9 @@ repos:
     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
 ```
 
 Then simply `bundle exec gouteur` or add the rake task to your Rakefile:
@@ -64,7 +66,11 @@ tasks: 'rspec --pattern "**/{,*}{keyword1,keyword2}{,*,*/**/*}_spec.rb"'`
 From the shell:
 
 ```shell
+# example: check one dependent repo
 gouteur 'https://github.com/foo/bar'
+
+# see other usage options:
+gouteur --help
 ```
 
 From Ruby:
@@ -86,7 +92,6 @@ Possible future improvements:
 - support more sources of code, e.g. latest release, private GitHub repositories
 - improve performance by tracing & rerunning only specs/tests that use the gem
 - save time in MiniTest by forcing it to run in fail-fast mode like RSpec
-- add help output and more options to the CLI executable
 - other ideas? open an issue!
 
 ## License

data/lib/gouteur/checker.rb

@@ -3,15 +3,16 @@ require 'yaml'
 module Gouteur
   # main process class
   class Checker
-    attr_reader :repo
+    attr_reader :repo, :force
 
-    def self.call(repo, silent: false)
-      new(repo, silent: silent).call
+    def self.call(repo, silent: false, force: repo&.force?)
+      new(repo, silent: silent, force: force).call
     end
 
-    def initialize(repo, silent: false)
+    def initialize(repo, silent: false, force: repo&.force?)
       @repo = repo
       @silent = silent
+      @force = force
     end
 
     def call
@@ -21,7 +22,8 @@ module Gouteur
 
       run_tasks(adapted: false)
 
-      create_adapted_gemfile
+      repo.gemfile.create_adapted(drop_version_constraint: force)
+      repo.remove_host_from_gemspecs if force
       install_adapted_bundle or return handle_incompatible_semver
 
       run_tasks(adapted: true)
@@ -58,36 +60,6 @@ module Gouteur
       )
     end
 
-    def create_adapted_gemfile
-      content = File.exist?(gemfile_path) ? File.read(gemfile_path) : ''
-      adapted_content = adapt_gemfile_content(content)
-      File.open(adapted_gemfile_path, 'w') { |f| f.puts(adapted_content) }
-    end
-
-    def adapt_gemfile_content(content)
-      new_entry = "gem '#{Host.name}', path: '#{Host.root}' # set by gouteur "
-
-      existing_ref_pattern =
-        /^ *gem +(?<q>'|")#{Host.name}\k<q>(?<v> *,\s*(?<q2>'|")[^'"]+\k<q2>*)?/
-
-      if content =~ existing_ref_pattern
-        content.gsub(existing_ref_pattern) do
-          # keep version specification if there was one
-          new_entry.sub(/(?=, path:)/, Regexp.last_match[:v].to_s)
-        end
-      else
-        "#{content}\n#{new_entry}\n"
-      end
-    end
-
-    def gemfile_path
-      repo.bundle.gemfile_path
-    end
-
-    def adapted_gemfile_path
-      "#{repo.bundle.gemfile_path}.gouteur"
-    end
-
     def install_adapted_bundle
       result = repo.bundle.install(env: adaptation_env)
       if result.success?
@@ -105,7 +77,7 @@ module Gouteur
     def indicates_incompatible_semver?(result)
       result.exitstatus == BUNDLER_INCOMPATIBLE_VERSION_CODE ||
         result.exitstatus == BUNDLER_GEM_NOT_FOUND_CODE &&
-          result.stderr =~ /following version/
+          result.stderr =~ /following gems matching|following version/
     end
 
     def handle_incompatible_semver
@@ -116,7 +88,7 @@ module Gouteur
 
     def adaptation_env
       {
-        'BUNDLE_GEMFILE' => adapted_gemfile_path,
+        'BUNDLE_GEMFILE' => repo.gemfile.adapted_path,
         'SPEC_OPTS' => '--fail-fast', # saves time with rspec tasks
       }
     end

data/lib/gouteur/cli.rb

@@ -1,9 +1,13 @@
+require 'optparse'
+
 module Gouteur
   # command line interface - prints to stdout and returns true or false
   module CLI
     module_function
 
-    def call(args = ARGV)
+    def call(argv = ARGV)
+      args = option_parser.parse!(argv)
+
       repos = pick_repos(args)
       if repos.empty?
         puts '', Message.no_repos, ''
@@ -11,16 +15,54 @@ module Gouteur
       end
 
       repos.all? do |repo|
-        success, message = Gouteur::Checker.call(repo)
+        success, message = Gouteur::Checker.call(repo, force: !!@force)
         puts '', message, ''
         success
       end
     end
 
+    def option_parser
+      @force = false
+
+      OptionParser.new do |opts|
+        opts.banner = <<~SH
+          Usage: gouteur [repos] [options]
+
+          Examples:
+            gouteur https://github.com/me/my_repo
+            gouteur my_repo # my_repo must be listed in .gouteur.yml
+
+        SH
+
+        opts.separator 'Options:'
+
+        opts.on("-f", "--force", "Force tests, override version constraints") do
+          @force = true
+        end
+
+        opts.on("-v", "--version", "Show gouteur version") do
+          puts "gouteur #{Gouteur::VERSION}"
+          exit
+        end
+
+        opts.on("-h", "--help", "Show this help") do
+          puts opts
+          exit
+        end
+      end
+    end
+
     def pick_repos(args)
-      repos = args.map { |arg| Gouteur::Repo.new(uri: arg) }
-      repos = Dotfile.repos if repos.empty?
-      repos
+      dotfile_repos = Dotfile.repos
+      return dotfile_repos if args.empty?
+
+      args.map do |arg|
+        if dotfile_repo = dotfile_repos.find { |r| r.name == arg }
+          dotfile_repo
+        else
+          Gouteur::Repo.new(uri: arg)
+        end
+      end
     end
   end
 end

data/lib/gouteur/gemfile.rb

@@ -0,0 +1,66 @@
+module Gouteur
+  # Gemfile of a repository that depends on the library under test
+  class Gemfile
+    attr_reader :original_path
+
+    def initialize(original_path)
+      @original_path = original_path
+    end
+
+    def adapted_path
+      "#{original_path}.gouteur"
+    end
+
+    def content
+      File.exist?(original_path) ? File.read(original_path) : ''
+    end
+
+    def create_adapted(drop_version_constraint: false)
+      adapted_content = self.class.adapt(
+        content,
+        drop_version_constraint: drop_version_constraint,
+      )
+      File.open(adapted_path, 'w') { |f| f.puts(adapted_content) }
+    end
+
+    def self.adapt(content, drop_version_constraint: false)
+      new_entry = "gem '#{Host.name}', path: '#{Host.root}' # set by gouteur "
+
+      existing_ref_pattern =
+        /
+          ^\s*gem\W+#{Host.name}\W
+          (?<version>
+            \s*,\s*
+            (?:
+                #{VERSION_NUMBER_PATTERN}
+              |
+                \[(?:\s*#{VERSION_NUMBER_PATTERN}\s*,?\s*)+\]
+            )
+          )?
+        /x
+
+      return "#{content}\n#{new_entry}\n" unless content =~ existing_ref_pattern
+
+      content.gsub(existing_ref_pattern) do
+        if drop_version_constraint
+          new_entry
+        else
+          # keep version specification if there was one
+          new_entry.sub(/(?=, path:)/, Regexp.last_match[:version].to_s)
+        end
+      end
+    end
+
+    VERSION_NUMBER_PATTERN =
+      /
+          \d+\.\d+ # float
+        |
+          \d+ # int
+        |
+          (?:%[qQ]?)?
+          (?:
+            '[^']+'|"[^"]+"|\[[^\]]+\]|\{[^}]+\}|\([^)]+\)|<[^>]+>
+          ) # string literal
+      /x.freeze
+  end
+end

data/lib/gouteur/message.rb

@@ -75,6 +75,8 @@ module Gouteur
         The new version number of `#{Host.name}` is incompatible with the version requirements specified by `#{repo}`.
 
         Releasing incompatible versions is considered OK by default, so tasks will be SKIPPED in this case. If you want gouteur to FAIL in this case, set the `locked` flag.
+
+        Use the `force` flag to override this version constraint and run the tests anyway.
       MSG
     end
 
@@ -84,7 +86,7 @@ module Gouteur
 
         The new version number of `#{Host.name}` is incompatible with the version requirements specified by `#{repo}`.
 
-        Incompatible version numbers can be allowed by removing the `locked` flag. This will make gouteur SKIP the tasks in this case.
+        Incompatible version numbers can be allowed by removing the `locked` flag. This will make gouteur SKIP the tasks in this case unless the `force` flag is set.
       MSG
     end
 

data/lib/gouteur/repo.rb

@@ -6,13 +6,22 @@ module Gouteur
     attr_reader :uri, :name, :ref, :tasks
     alias to_s name
 
-    def initialize(uri:, ref: nil, before: [], tasks: 'rake', locked: false)
-      @uri    = URI.parse(uri)
-      @name   = extract_name_from_uri(uri)
+    def initialize(
+      uri:,
+      name:   nil,
+      ref:    nil,
+      before: [],
+      tasks:  'rake',
+      locked: false,
+      force:  false
+    )
+      @uri    = uri
+      @name   = name || extract_name_from_uri(uri)
       @ref    = ref
       @before = Array(before)
       @tasks  = Array(tasks)
       @locked = !!locked
+      @force  = !!force
     end
 
     def fetch
@@ -35,10 +44,26 @@ module Gouteur
       @bundle ||= Gouteur::Bundle.new(clone_path)
     end
 
+    def gemfile
+      @gemfile ||= Gouteur::Gemfile.new(bundle.gemfile_path)
+    end
+
     def locked?
       @locked
     end
 
+    def force?
+      @force
+    end
+
+    def remove_host_from_gemspecs
+      Dir[File.join(clone_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)
+      end
+    end
+
     private
 
     def extract_name_from_uri(uri)

data/lib/gouteur/shell.rb

@@ -29,7 +29,7 @@ module Gouteur
       attr_reader :stdout, :stderr, :exitstatus
 
       def initialize(args:, pwd:, stdout:, stderr:, status:)
-        @args = args
+        @args = Array(args)
         @pwd = pwd
         @stdout = stdout
         @stderr = stderr

data/lib/gouteur/version.rb

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

data/lib/gouteur.rb

@@ -4,6 +4,7 @@ require 'gouteur/bundle'
 require 'gouteur/checker'
 require 'gouteur/cli'
 require 'gouteur/dotfile'
+require 'gouteur/gemfile'
 require 'gouteur/host'
 require 'gouteur/message'
 require 'gouteur/repo'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gouteur
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Janosch Müller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2023-02-21 00:00:00.000000000 Z
 dependencies: []
 description: Run tests of dependent gems against your changes.
 email:
@@ -39,6 +39,7 @@ files:
 - lib/gouteur/checker.rb
 - lib/gouteur/cli.rb
 - lib/gouteur/dotfile.rb
+- lib/gouteur/gemfile.rb
 - lib/gouteur/host.rb
 - lib/gouteur/message.rb
 - lib/gouteur/rake_task.rb
@@ -67,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: See if your lib is still digestible.