In Files

  • bundler/gem_version_promoter.rb

Class/Module Index [+]

Quicksearch

Bundler::GemVersionPromoter

This class contains all of the logic for determining the next version of a Gem to update to based on the requested level (patch, minor, major). Primarily designed to work with Resolver which will provide it the list of available dependency versions as found in its index, before returning it to to the resolution engine to select the best version.

Constants

DEBUG

Attributes

level[R]
locked_specs[R]
prerelease_specified[RW]
strict[RW]

By default, strict is false, meaning every available version of a gem is returned from sort_versions. The order gives preference to the requested level (:patch, :minor, :major) but in complicated requirement cases some gems will by necessity by promoted past the requested level, or even reverted to older versions.

If strict is set to true, the results from #sort_versions will be truncated, eliminating any version outside the current level scope. This can lead to unexpected outcomes or even VersionConflict exceptions that report a version of a gem not existing for versions that indeed do existing in the referenced source.

unlock_gems[R]

Public Class Methods

new(locked_specs = SpecSet.new([]), unlock_gems = []) click to toggle source

Given a list of #locked_specs and a list of gems to unlock creates a GemVersionPromoter instance.

@param #locked_specs [SpecSet] All current locked specs. Unlike Definition

where this list is empty if all gems are being updated, this should
always be populated for all gems so this class can properly function.

@param #unlock_gems [String] List of gem names being unlocked. If empty,

all gems will be considered unlocked.

@return [GemVersionPromoter]

 
               # File bundler/gem_version_promoter.rb, line 37
def initialize(locked_specs = SpecSet.new([]), unlock_gems = [])
  @level = :major
  @strict = false
  @locked_specs = locked_specs
  @unlock_gems = unlock_gems
  @sort_versions = {}
  @prerelease_specified = {}
end
            

Public Instance Methods

level=(value) click to toggle source

@param value [Symbol] One of three Symbols: :major, :minor or :patch.

 
               # File bundler/gem_version_promoter.rb, line 47
def level=(value)
  v = case value
      when String, Symbol
        value.to_sym
  end

  raise ArgumentError, "Unexpected level #{v}. Must be :major, :minor or :patch" unless [:major, :minor, :patch].include?(v)
  @level = v
end
            
major?() click to toggle source

@return [bool] Convenience method for testing value of level variable.

 
               # File bundler/gem_version_promoter.rb, line 91
def major?
  level == :major
end
            
minor?() click to toggle source

@return [bool] Convenience method for testing value of level variable.

 
               # File bundler/gem_version_promoter.rb, line 96
def minor?
  level == :minor
end
            
sort_versions(dep, spec_groups) click to toggle source

Given a Dependency and an Array of SpecGroups of available versions for a gem, this method will return the Array of SpecGroups sorted (and possibly truncated if strict is true) in an order to give preference to the current level (:major, :minor or :patch) when resolution is deciding what versions best resolve all dependencies in the bundle. @param dep [Dependency] The Dependency of the gem. @param spec_groups [SpecGroup] An array of SpecGroups for the same gem

named in the @dep param.

@return [SpecGroup] A new instance of the SpecGroup Array sorted and

possibly filtered.
 
               # File bundler/gem_version_promoter.rb, line 67
def sort_versions(dep, spec_groups)
  before_result = "before sort_versions: #{debug_format_result(dep, spec_groups).inspect}" if DEBUG

  @sort_versions[dep] ||= begin
    gem_name = dep.name

    # An Array per version returned, different entries for different platforms.
    # We only need the version here so it's ok to hard code this to the first instance.
    locked_spec = locked_specs[gem_name].first

    if strict
      filter_dep_specs(spec_groups, locked_spec)
    else
      sort_dep_specs(spec_groups, locked_spec)
    end.tap do |specs|
      if DEBUG
        puts before_result
        puts " after sort_versions: #{debug_format_result(dep, specs).inspect}"
      end
    end
  end
end