bundler-resolutions 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a6def9961c77861086b6b58177a934945938362e2125ba5dc49b8a6c06efdff
-  data.tar.gz: ccef554f38761f9916843d675f70ef7189ef8a7070bdb3d9b2e466e2eed998de
+  metadata.gz: ca66a89bbd900f1f8c14ff704e6e4155fd4dc768f05d3c16f1d3eb18a0a57d19
+  data.tar.gz: 77aa2e3521124d04f3c6cb4422fef1e417b0c6c705a840f728696bddefa35aa8
 SHA512:
-  metadata.gz: '01507905d1b9402c1efc92f9509b5aeef2b858d18c3b3e8555af937e1b479dc4b2711f87eed3ef87b8d64bfb7285bb299322a5925d43013e6dac6afa2128b5ba'
-  data.tar.gz: c85660a42a9149ffcded4f649ef8b2d9413da63eb435d9c8231be3fcdf26dc6aebea0a6608bd1206298ac3caf47b01681a573cecc4e92b0dc3b6638a893b219d
+  metadata.gz: e453be51627d50ffa3186b27c2ee4926805e4f1d11c26a061cdfd94960f83286513b036f228e0ad2029730308cfbcd08a663b62c6faead45fa26291c78e13c21
+  data.tar.gz: 1c0681c2f8b334f3c85073d693900f3898d87343ed912f50f7fd1823a0986ac546979bf8dba447e7d39bbe5bd06765476aefeb6a703152a3befd09316b7f5577

data/README.md

@@ -33,7 +33,7 @@ gems:
 
 `Gemfile`:
 ```ruby
-gem 'bundler-resolutions'
+gem "bundler-resolutions", path: "../", install_if: -> { require Gem::Specification.find_by_name('bundler-resolutions').gem_dir + "/lib/bundler/resolutions"; true }
 gem "rails"
 ```
 

data/lib/bundler/resolutions/config.rb

@@ -9,13 +9,24 @@ module Bundler
 
       class << self
         def load_config(config = nil)
+          location = "config hash"
           raw_hash = if config.is_a?(Hash)
                        config
                      else
-                       YAML.safe_load_file(find_config(config))
+                       location = find_config(config)
+                       YAML.safe_load_file(location)
                      end
-          gems = raw_hash.fetch("gems")
-          gems.transform_values { |version| Gem::Requirement.new(version.split(",")) }
+          gems = raw_hash.fetch("gems") {
+            raise <<~ERR
+              No 'gems' key found in #{location}. Please ensure the file is formatted correctly.
+
+              Data was:
+              #{raw_hash.inspect}
+            ERR
+          }
+          gems.transform_values { |reqs|
+            Array(reqs).flat_map { |v| v.split(",") }.map { |req| Gem::Requirement.new(req) }
+          }
         end
 
         private def find_config(config = nil)
@@ -25,8 +36,8 @@ module Bundler
           env_file = ENV["BUNDLER_RESOLUTIONS_CONFIG"]
           return env_file if env_file
 
-          # Otherwise find it in the file tree
-          dir = Dir.pwd
+          # Otherwise find it above where `BUNDLE_GEMFILE` is located, or pwd if not set
+          dir = ENV["BUNDLE_GEMFILE"] ? File.dirname(ENV["BUNDLE_GEMFILE"]) : Dir.pwd
           until File.exist?(File.join(dir, CONFIG_FILE_NAME))
             dir = File.dirname(dir)
             raise "Could not find #{CONFIG_FILE_NAME}" if dir == "/"

data/lib/bundler/resolutions/version.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative "../resolutions"
-
 module Bundler
   class Resolutions
-    VERSION = "0.3.0"
+    VERSION = "0.5.0"
   end
 end
+
+require_relative "../resolutions"

data/lib/bundler/resolutions.rb

@@ -2,6 +2,7 @@
 
 require "yaml"
 require_relative "resolutions/config"
+require_relative "resolutions/version"
 
 module Bundler
   class Resolutions
@@ -15,19 +16,24 @@ module Bundler
 
     class << self
       def instance
-        @instance ||= new
+        @instance ||= new # rubocop:disable ThreadSafety/ClassInstanceVariable
+      end
+
+      # You can debug with BUNDLER_RESOLUTIONS_DEBUG=gem_name or BUNDLER_RESOLUTIONS_DEBUG=true
+      # to see all messages.
+      def log(message, gem = nil)
+        return if ENV["BUNDLER_RESOLUTIONS_DEBUG"].nil?
+        unless ENV["BUNDLER_RESOLUTIONS_DEBUG"] == "true" ||
+               ENV["BUNDLER_RESOLUTIONS_DEBUG"].split(",").include?(gem)
+          return
+        end
+
+        puts "bundler-resolutions: #{message}"
       end
     end
 
     # A module we prepend to Bundler::Resolutions::Resolver
-    # :reek:ModuleInitialize
     module Resolver
-      # Override the initializer in the resolver
-      def initialize(*args)
-        Bundler::Resolutions.instance.add_concrete_resolutions_for(args.first)
-        super
-      end
-
       # This overrides the default behaviour of the resolver to filter out versions that don't
       # satisfy the requirements specified in .bundler-resolutions.yml.
       def filtered_versions_for(package)
@@ -36,79 +42,66 @@ module Bundler
     end
 
     def constrain_versions_for(results, package)
+      log("Constraining versions for #{package} with results: #{results.map(&:to_s)}")
       results.select do |pkg|
-        req = resolutions_for(package.name)
-        if req
-          log("making sure #{package} is satisfied by #{req}")
-          req.satisfied_by?(pkg.version)
-        else
+        reqs = resolutions_for(package.name)
+        if reqs.nil?
           true
-        end
-      end
-    end
-
-    def add_concrete_resolutions_for(base)
-      base.requirements.each do |bundler_dependency|
-        requirement_name = bundler_dependency.name
-        resolutions = resolutions_for(requirement_name)
-
-        if resolutions
-          log(<<~MSG, requirement_name)
-            has resolutions for concrete dependency '#{requirement_name}': #{resolutions}
-          MSG
         else
-          log("has no resolutions for concrete dependency '#{requirement_name}'", requirement_name)
-          next
+          log("making sure #{package} / #{pkg} is satisfied by #{reqs.map(&:to_s)}")
+          reqs.all? { |req| req.satisfied_by?(pkg.version) }
         end
-
-        bundler_resolutions_reqs = resolutions.requirements
-        apply_resolutions_for_concrete_gem(bundler_dependency, bundler_resolutions_reqs)
       end
     end
 
-    private def resolutions_for(package_name)
+    def resolutions_for(package_name)
       config[package_name]
     end
 
-    # You can debug with BUNDLER_RESOLUTIONS_DEBUG=gem_name or BUNDLER_RESOLUTIONS_DEBUG=true
-    # to see all messages.
-    private def log(message, gem = nil)
-      return unless ENV["BUNDLER_RESOLUTIONS_DEBUG"]
-      return if gem && !ENV["BUNDLER_RESOLUTIONS_DEBUG"].split(",").include?(gem)
+    def log(message, gem = nil) = self.class.log(message, gem)
 
-      puts "bundler-resolutions: #{message}"
-    end
-
-    private def apply_resolutions_for_concrete_gem(bundler_dependency, bundler_resolutions_reqs)
-      requirement_name = bundler_dependency.name
-      bundler_resolutions_reqs.each do |r|
-        # If the concrete requirement is already in the Gemfile, skip it
-        requirements = bundler_dependency.requirement.requirements
-        if requirements.include?(r)
-          # We don't want to double up / dupe the same requirements
-          log(<<~MSG, requirement_name)
-            Skipping adding requirements to gem concretely specified in Gemfile as it
-            was already present: #{requirement_name}: #{bundler_dependency}
-          MSG
-          next
-        end
-
-        # Otherwise add the additional requirement
-        before_req = bundler_dependency.to_s
-        # If there were no requirements before, there is a default one for ">= 0". We need to
-        # remove that so when we add the new one the implicit ">= 0" is not present, as it normally
-        # isn't written out to lockfiles.
-        requirements.clear if bundler_dependency.requirement == DEFAULT_GEM_REQUIREMENT
-        # Add the new requirement
-        requirements << r
-        after_req = bundler_dependency.to_s
-
-        log(<<~MSG, requirement_name)
-          Adding concrete constraints for #{requirement_name}. Before: #{before_req}. After: #{after_req}.
-        MSG
+    module Definition
+      def check_lockfile
+        super
+        invalids = @locked_specs.to_a.select { |lazy_specification|
+          reqs = Bundler::Resolutions.instance.resolutions_for(lazy_specification.name)
+          next if reqs.nil?
+
+          # rubocop:disable Layout/LineLength
+          if reqs.all? { |req| req.satisfied_by?(lazy_specification.version) }
+            Bundler::Resolutions.log "#{lazy_specification.name} (#{lazy_specification.version}) is satisfied by the current lockfile version."
+            nil
+          else
+            Bundler::Resolutions.log "#{lazy_specification.name} (#{lazy_specification.version}) is NOT satisfied by the current lockfile version."
+            lazy_specification
+          end
+          # rubocop:enable Layout/LineLength
+        }
+        @locked_specs.delete(invalids)
       end
     end
   end
 end
 
+# Check if the methods exists before we prepend them, to avoid issues with Bundler versions
+# that do not have this method.
+{
+  Bundler::Resolver => :filtered_versions_for,
+  Bundler::Definition => :nothing_changed?,
+}.each do |klass, method|
+  next if klass.instance_methods.include?(method) || klass.private_instance_methods.include?(method)
+
+  raise <<~ERR
+        Bundler version #{Bundler::VERSION} is not compatible with bundler-resolutions #{Bundler::Resolutions::VERSION}
+    The method '#{method}' is not defined in '#{klass}'. This is likely due to a refactoring of a new
+    Bundler version. Please check the bundler-resolutions changelog and the Bundler changelog
+    to see if this is a known issue, or submit a bug report to bundler-resolutions.
+  ERR
+end
+
+# This is needed so we can trigger a rebuild of the lock file if just the yaml has changed.
+Bundler::Definition.prepend(Bundler::Resolutions::Definition)
+# This removes the transitive dependency versions that do not satisfy the yaml config.
 Bundler::Resolver.prepend(Bundler::Resolutions::Resolver)
+
+Bundler::Resolutions.log("bundler-resolutions #{Bundler::Resolutions::VERSION} loaded")

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundler-resolutions
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Harry Lascelles
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-03 00:00:00.000000000 Z
+date: 2025-07-15 00:00:00.000000000 Z
 dependencies: []
 description: A bundler plugin to enforce resolutions without specifying a concrete
   dependency
@@ -32,6 +33,7 @@ metadata:
   source_code_uri: https://github.com/hlascelles/bundler-resolutions/
   bug_tracker_uri: https://github.com/hlascelles/bundler-resolutions/issues
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -46,7 +48,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: A bundler plugin to enforce resolutions without specifying a concrete dependency
 test_files: []