class Bundler::Definition

Attributes

dependencies[R]
locked_deps[R]
platforms[R]
ruby_version[R]
sources[R]

Public Class Methods

build(gemfile, lockfile, unlock) click to toggle source

Given a gemfile and lockfile creates a Bundler definition

@param gemfile [Pathname] Path to Gemfile @param lockfile [Pathname,nil] Path to Gemfile.lock @param unlock [Hash, Boolean, nil] Gems that have been requested

to be updated or true if all gems should be updated

@return [Bundler::Definition]

# File lib/bundler/definition.rb, line 18
def self.build(gemfile, lockfile, unlock)
  unlock ||= {}
  gemfile = Pathname.new(gemfile).expand_path

  unless gemfile.file?
    raise GemfileNotFound, "#{gemfile} not found"
  end

  Dsl.evaluate(gemfile, lockfile, unlock)
end
new(lockfile, dependencies, sources, unlock, ruby_version = nil, optional_groups = []) click to toggle source

How does the new system work?

  • Load information from Gemfile and Lockfile

  • Invalidate stale locked specs

  • All specs from stale source are stale

  • All specs that are reachable only through a stale dependency are stale.

  • If all fresh dependencies are satisfied by the locked

specs, then we can try to resolve locally.

@param lockfile [Pathname] Path to Gemfile.lock @param dependencies [Array(Bundler::Dependency)] array of dependencies from Gemfile @param sources [Bundler::SourceList] @param unlock [Hash, Boolean, nil] Gems that have been requested

to be updated or true if all gems should be updated

@param #ruby_version [Bundler::RubyVersion, nil] Requested Ruby Version @param optional_groups [Array(String)] A list of optional groups

# File lib/bundler/definition.rb, line 48
def initialize(lockfile, dependencies, sources, unlock, ruby_version = nil, optional_groups = [])
  @unlocking = unlock == true || !unlock.empty?

  @dependencies    = dependencies
  @sources         = sources
  @unlock          = unlock
  @optional_groups = optional_groups
  @remote          = false
  @specs           = nil
  @ruby_version    = ruby_version

  @lockfile_contents      = ""
  @locked_bundler_version = nil

  if lockfile && File.exist?(lockfile)
    @lockfile_contents = Bundler.read_file(lockfile)
    locked = LockfileParser.new(@lockfile_contents)
    @platforms      = locked.platforms
    @locked_bundler_version = locked.bundler_version

    if unlock != true
      @locked_deps    = locked.dependencies
      @locked_specs   = SpecSet.new(locked.specs)
      @locked_sources = locked.sources
    else
      @unlock         = {}
      @locked_deps    = []
      @locked_specs   = SpecSet.new([])
      @locked_sources = []
    end
  else
    @unlock         = {}
    @platforms      = []
    @locked_deps    = []
    @locked_specs   = SpecSet.new([])
    @locked_sources = []
  end

  @unlock[:gems] ||= []
  @unlock[:sources] ||= []

  current_platform = Bundler.rubygems.platforms.map { |p| generic(p) }.compact.last
  @new_platform = !@platforms.include?(current_platform)
  @platforms |= [current_platform]

  @path_changes = converge_paths
  eager_unlock = expand_dependencies(@unlock[:gems])
  @unlock[:gems] = @locked_specs.for(eager_unlock).map { |s| s.name }

  @source_changes = converge_sources
  @dependency_changes = converge_dependencies
  @local_changes = converge_locals

  fixup_dependency_types!
end

Public Instance Methods

current_dependencies() click to toggle source
# File lib/bundler/definition.rb, line 178
def current_dependencies
  dependencies.reject { |d| !d.should_include? }
end
ensure_equivalent_gemfile_and_lockfile(explicit_flag = false) click to toggle source
# File lib/bundler/definition.rb, line 332
def ensure_equivalent_gemfile_and_lockfile(explicit_flag = false)
  msg = "You are trying to install in deployment mode after changing\n"              "your Gemfile. Run `bundle install` elsewhere and add the\n"              "updated Gemfile.lock to version control."

  unless explicit_flag
    msg += "\n\nIf this is a development machine, remove the Gemfile "                 "freeze \nby running `bundle install --no-deployment`."
  end

  added =   []
  deleted = []
  changed = []

  gemfile_sources = sources.lock_sources
  if @locked_sources != gemfile_sources
    new_sources = gemfile_sources - @locked_sources
    deleted_sources = @locked_sources - gemfile_sources

    if new_sources.any?
      added.concat new_sources.map { |source| "* source: #{source}" }
    end

    if deleted_sources.any?
      deleted.concat deleted_sources.map { |source| "* source: #{source}" }
    end
  end

  new_deps = @dependencies - @locked_deps
  deleted_deps = @locked_deps - @dependencies

  if new_deps.any?
    added.concat new_deps.map { |d| "* #{pretty_dep(d)}" }
  end

  if deleted_deps.any?
    deleted.concat deleted_deps.map { |d| "* #{pretty_dep(d)}" }
  end

  both_sources = Hash.new { |h,k| h[k] = [] }
  @dependencies.each { |d| both_sources[d.name][0] = d }
  @locked_deps.each  { |d| both_sources[d.name][1] = d.source }

  both_sources.each do |name, (dep, lock_source)|
    if (dep.nil? && !lock_source.nil?) || (!dep.nil? && !lock_source.nil? && !lock_source.can_lock?(dep))
      gemfile_source_name = (dep && dep.source) || 'no specified source'
      lockfile_source_name = lock_source || 'no specified source'
      changed << "* #{name} from `#{gemfile_source_name}` to `#{lockfile_source_name}`"
    end
  end

  msg << "\n\nYou have added to the Gemfile:\n"     << added.join("\n") if added.any?
  msg << "\n\nYou have deleted from the Gemfile:\n" << deleted.join("\n") if deleted.any?
  msg << "\n\nYou have changed in the Gemfile:\n"   << changed.join("\n") if changed.any?
  msg << "\n"

  raise ProductionError, msg if added.any? || deleted.any? || changed.any?
end
fixup_dependency_types!() click to toggle source
# File lib/bundler/definition.rb, line 104
def fixup_dependency_types!
  # XXX This is a temporary workaround for a bug when using rubygems 1.8.15
  # where Gem::Dependency#== matches Gem::Dependency#type. As the lockfile
  # doesn't carry a notion of the dependency type, if you use
  # add_development_dependency in a gemspec that's loaded with the gemspec
  # directive, the lockfile dependencies and resolved dependencies end up
  # with a mismatch on #type.
  # Test coverage to catch a regression on this is in gemspec_spec.rb
  @dependencies.each do |d|
    if ld = @locked_deps.find { |l| l.name == d.name }
      ld.instance_variable_set(:@type, d.type)
    end
  end
end
groups() click to toggle source
# File lib/bundler/definition.rb, line 240
def groups
  dependencies.map { |d| d.groups }.flatten.uniq
end
has_local_dependencies?() click to toggle source
# File lib/bundler/definition.rb, line 232
def has_local_dependencies?
  !sources.path_sources.empty? || !sources.git_sources.empty?
end
has_rubygems_remotes?() click to toggle source
# File lib/bundler/definition.rb, line 228
def has_rubygems_remotes?
  sources.rubygems_sources.any? {|s| s.remotes.any? }
end
index() click to toggle source
# File lib/bundler/definition.rb, line 205
def index
  @index ||= Index.build do |idx|
    dependency_names = @dependencies.map { |d| d.name }

    sources.all_sources.each do |source|
      source.dependency_names = dependency_names.dup
      idx.add_source source.specs
      dependency_names -= pinned_spec_names(source.specs)
      dependency_names.push(*source.unmet_deps).uniq!
    end
  end
end
lock(file, preserve_bundled_with = false) click to toggle source
# File lib/bundler/definition.rb, line 244
def lock(file, preserve_bundled_with = false)
  contents = to_lock

  # Convert to \r\n if the existing lock has them
  # i.e., Windows with `git config core.autocrlf=true`
  contents.gsub!(/\n/, "\r\n") if @lockfile_contents.match("\r\n")

  if @locked_bundler_version
    locked_major = @locked_bundler_version.segments.first
    current_major = Gem::Version.create(Bundler::VERSION).segments.first

    if updating_major = locked_major < current_major
      Bundler.ui.warn "Warning: the lockfile is being updated to Bundler #{current_major}, "                            "after which you will be unable to return to Bundler #{@locked_bundler_version.segments.first}."
    end
  end

  preserve_bundled_with ||= !updating_major && (Bundler.settings[:frozen] || !@unlocking)
  return if lockfiles_equal?(@lockfile_contents, contents, preserve_bundled_with)

  if Bundler.settings[:frozen]
    Bundler.ui.error "Cannot write a changed lockfile while frozen."
    return
  end

  File.open(file, 'wb'){|f| f.puts(contents) }
rescue Errno::EACCES
  raise Bundler::InstallError,
    "There was an error while trying to write to Gemfile.lock. It is likely that \n"          "you need to allow write permissions for the file at path: \n"          "#{File.expand_path(file)}"
end
lock_version() click to toggle source

Returns the version of Bundler that is creating or has created Gemfile.lock. Used in to_lock.

# File lib/bundler/definition.rb, line 279
def lock_version
  if @locked_bundler_version && @locked_bundler_version < Gem::Version.new(Bundler::VERSION)
    new_version = Bundler::VERSION
  end

  new_version || @locked_bundler_version || Bundler::VERSION
end
missing_specs() click to toggle source
# File lib/bundler/definition.rb, line 164
def missing_specs
  missing = []
  resolve.materialize(requested_dependencies, missing)
  missing
end
new_platform?() click to toggle source
# File lib/bundler/definition.rb, line 160
def new_platform?
  @new_platform
end
new_specs() click to toggle source
# File lib/bundler/definition.rb, line 152
def new_specs
  specs - @locked_specs
end
removed_specs() click to toggle source
# File lib/bundler/definition.rb, line 156
def removed_specs
  @locked_specs - specs
end
requested_specs() click to toggle source
# File lib/bundler/definition.rb, line 170
def requested_specs
  @requested_specs ||= begin
    groups = requested_groups
    groups.map! { |g| g.to_sym }
    specs_for(groups)
  end
end
resolve() click to toggle source

Resolve all the dependencies specified in Gemfile. It ensures that dependencies that have been already resolved via locked file and are fresh are reused when resolving dependencies

@return [SpecSet] resolved dependencies

# File lib/bundler/definition.rb, line 193
def resolve
  @resolve ||= begin
    last_resolve = converge_locked_specs
    if Bundler.settings[:frozen] || (!@unlocking && nothing_changed?)
      last_resolve
    else
      # Run a resolve against the locally available gems
      last_resolve.merge Resolver.resolve(expanded_dependencies, index, source_requirements, last_resolve)
    end
  end
end
resolve_remotely!() click to toggle source
# File lib/bundler/definition.rb, line 125
def resolve_remotely!
  raise "Specs already loaded" if @specs
  @remote = true
  sources.remote!
  specs
end
resolve_with_cache!() click to toggle source
# File lib/bundler/definition.rb, line 119
def resolve_with_cache!
  raise "Specs already loaded" if @specs
  sources.cached!
  specs
end
rubygems_index() click to toggle source

used when frozen is enabled so we can find the bundler spec, even if (say) a git gem is not checked out.

# File lib/bundler/definition.rb, line 220
def rubygems_index
  @rubygems_index ||= Index.build do |idx|
    sources.rubygems_sources.each do |rubygems|
      idx.add_source rubygems.specs
    end
  end
end
spec_git_paths() click to toggle source
# File lib/bundler/definition.rb, line 236
def spec_git_paths
  sources.git_sources.map {|s| s.path.to_s }
end
specs() click to toggle source

For given dependency list returns a SpecSet with Gemspec of all the required dependencies.

1. The method first resolves the dependencies specified in Gemfile
2. After that it tries and fetches gemspec of resolved dependencies

@return [Bundler::SpecSet]

# File lib/bundler/definition.rb, line 138
def specs
  @specs ||= begin
    specs = resolve.materialize(Bundler.settings[:cache_all_platforms] ? dependencies : requested_dependencies)

    unless specs["bundler"].any?
      local = Bundler.settings[:frozen] ? rubygems_index : index
      bundler = local.search(Gem::Dependency.new('bundler', VERSION)).last
      specs["bundler"] = bundler if bundler
    end

    specs
  end
end
specs_for(groups) click to toggle source
# File lib/bundler/definition.rb, line 182
def specs_for(groups)
  deps = dependencies.select { |d| (d.groups & groups).any? }
  deps.delete_if { |d| !d.should_include? }
  specs.for(expand_dependencies(deps))
end
to_lock() click to toggle source
# File lib/bundler/definition.rb, line 287
def to_lock
  out = ""

  sources.lock_sources.each do |source|
    # Add the source header
    out << source.to_lock
    # Find all specs for this source
    resolve.
      select { |s| source.can_lock?(s) }.
      # This needs to be sorted by full name so that
      # gems with the same name, but different platform
      # are ordered consistently
      sort_by { |s| s.full_name }.
      each do |spec|
        next if spec.name == 'bundler'
        out << spec.to_lock
      end
    out << "\n"
  end

  out << "PLATFORMS\n"

  platforms.map { |p| p.to_s }.sort.each do |p|
    out << "  #{p}\n"
  end

  out << "\n"
  out << "DEPENDENCIES\n"

  handled = []
  dependencies.
    sort_by { |d| d.to_s }.
    each do |dep|
      next if handled.include?(dep.name)
      out << dep.to_lock
      handled << dep.name
  end

  # Record the version of Bundler that was used to create the lockfile
  out << "\nBUNDLED WITH\n"
  out << "   #{lock_version}\n"

  out
end
validate_ruby!() click to toggle source
# File lib/bundler/definition.rb, line 391
def validate_ruby!
  return unless ruby_version

  if diff = ruby_version.diff(Bundler.ruby_version)
    problem, expected, actual = diff

    msg = case problem
    when :engine
      "Your Ruby engine is #{actual}, but your Gemfile specified #{expected}"
    when :version
      "Your Ruby version is #{actual}, but your Gemfile specified #{expected}"
    when :engine_version
      "Your #{Bundler.ruby_version.engine} version is #{actual}, but your Gemfile specified #{ruby_version.engine} #{expected}"
    when :patchlevel
      if !expected.is_a?(String)
        "The Ruby patchlevel in your Gemfile must be a string"
      else
        "Your Ruby patchlevel is #{actual}, but your Gemfile specified #{expected}"
      end
    end

    raise RubyVersionMismatch, msg
  end
end

Private Instance Methods

converge_dependencies() click to toggle source
# File lib/bundler/definition.rb, line 519
def converge_dependencies
  (@dependencies + @locked_deps).each do |dep|
    if dep.source
      dep.source = sources.get(dep.source)
    end
  end
  Set.new(@dependencies) != Set.new(@locked_deps)
end
converge_locals() click to toggle source

Get all locals and override their matching sources. Return true if any of the locals changed (for example, they point to a new revision) or depend on new specs.

# File lib/bundler/definition.rb, line 458
def converge_locals
  locals = []

  Bundler.settings.local_overrides.map do |k,v|
    spec   = @dependencies.find { |s| s.name == k }
    source = spec && spec.source
    if source && source.respond_to?(:local_override!)
      source.unlock! if @unlock[:gems].include?(spec.name)
      locals << [ source, source.local_override!(v) ]
    end
  end

  locals.any? do |source, changed|
    changed || specs_changed?(source) { |o| source.class == o.class && source.uri == o.uri }
  end
end
converge_locked_specs() click to toggle source

Remove elements from the locked specs that are expired. This will most commonly happen if the Gemfile has changed since the lockfile was last generated

# File lib/bundler/definition.rb, line 531
def converge_locked_specs
  deps = []

  # Build a list of dependencies that are the same in the Gemfile
  # and Gemfile.lock. If the Gemfile modified a dependency, but
  # the gem in the Gemfile.lock still satisfies it, this is fine
  # too.
  locked_deps_hash = @locked_deps.inject({}) { |hsh, dep| hsh[dep] = dep; hsh }
  @dependencies.each do |dep|
    locked_dep = locked_deps_hash[dep]

    if in_locked_deps?(dep, locked_dep) || satisfies_locked_spec?(dep)
      deps << dep
    elsif dep.source.is_a?(Source::Path) && dep.current_platform? && (!locked_dep || dep.source != locked_dep.source)
      @locked_specs.each do |s|
        @unlock[:gems] << s.name if s.source == dep.source
      end

      dep.source.unlock! if dep.source.respond_to?(:unlock!)
      dep.source.specs.each { |s| @unlock[:gems] << s.name }
    end
  end

  converged = []
  @locked_specs.each do |s|
    # Replace the locked dependency's source with the equivalent source from the Gemfile
    dep = @dependencies.find { |d| s.satisfies?(d) }
    s.source = (dep && dep.source) || sources.get(s.source)

    # Don't add a spec to the list if its source is expired. For example,
    # if you change a Git gem to Rubygems.
    next if s.source.nil? || @unlock[:sources].include?(s.name)
    # If the spec is from a path source and it doesn't exist anymore
    # then we just unlock it.

    # Path sources have special logic
    if s.source.instance_of?(Source::Path)
      other = s.source.specs[s].first

      # If the spec is no longer in the path source, unlock it. This
      # commonly happens if the version changed in the gemspec
      next unless other

      deps2 = other.dependencies.select { |d| d.type != :development }
      # If the dependencies of the path source have changed, unlock it
      next unless s.dependencies.sort == deps2.sort
    end

    converged << s
  end

  resolve = SpecSet.new(converged)
  resolve = resolve.for(expand_dependencies(deps, true), @unlock[:gems])
  diff    = @locked_specs.to_a - resolve.to_a

  # Now, we unlock any sources that do not have anymore gems pinned to it
  sources.all_sources.each do |source|
    next unless source.respond_to?(:unlock!)

    unless resolve.any? { |s| s.source == source }
      source.unlock! if !diff.empty? && diff.any? { |s| s.source == source }
    end
  end

  resolve
end
converge_paths() click to toggle source
# File lib/bundler/definition.rb, line 475
def converge_paths
  sources.path_sources.any? do |source|
    specs_changed?(source) do |ls|
      ls.class == source.class && ls.path == source.path
    end
  end
end
converge_sources() click to toggle source
# File lib/bundler/definition.rb, line 483
def converge_sources
  changes = false

  # Get the Rubygems sources from the Gemfile.lock
  locked_gem_sources = @locked_sources.select { |s| s.kind_of?(Source::Rubygems) }
  # Get the Rubygems remotes from the Gemfile
  actual_remotes = sources.rubygems_remotes

  # If there is a Rubygems source in both
  if !locked_gem_sources.empty? && !actual_remotes.empty?
    locked_gem_sources.each do |locked_gem|
      # Merge the remotes from the Gemfile into the Gemfile.lock
      changes = changes | locked_gem.replace_remotes(actual_remotes)
    end
  end

  # Replace the sources from the Gemfile with the sources from the Gemfile.lock,
  # if they exist in the Gemfile.lock and are `==`. If you can't find an equivalent
  # source in the Gemfile.lock, use the one from the Gemfile.
  changes = changes | sources.replace_sources!(@locked_sources)

  sources.all_sources.each do |source|
    # If the source is unlockable and the current command allows an unlock of
    # the source (for example, you are doing a `bundle update <foo>` of a git-pinned
    # gem), unlock it. For git sources, this means to unlock the revision, which
    # will cause the `ref` used to be the most recent for the branch (or master) if
    # an explicit `ref` is not used.
    if source.respond_to?(:unlock!) && @unlock[:sources].include?(source.name)
      source.unlock!
      changes = true
    end
  end

  changes
end
dependencies_for_source_changed?(source) click to toggle source
# File lib/bundler/definition.rb, line 448
def dependencies_for_source_changed?(source)
  deps_for_source = @dependencies.select { |s| s.source == source }
  locked_deps_for_source = @locked_deps.select { |s| s.source == source }

  deps_for_source != locked_deps_for_source
end
expand_dependencies(dependencies, remote = false) click to toggle source
# File lib/bundler/definition.rb, line 613
def expand_dependencies(dependencies, remote = false)
  deps = []
  dependencies.each do |dep|
    dep = Dependency.new(dep, ">= 0") unless dep.respond_to?(:name)
    next unless remote || dep.current_platform?
    dep.gem_platforms(@platforms).each do |p|
      deps << DepProxy.new(dep, p) if remote || p == generic(Gem::Platform.local)
    end
  end
  deps
end
expanded_dependencies() click to toggle source
# File lib/bundler/definition.rb, line 609
def expanded_dependencies
  @expanded_dependencies ||= expand_dependencies(dependencies, @remote)
end
in_locked_deps?(dep, locked_dep) click to toggle source
# File lib/bundler/definition.rb, line 598
def in_locked_deps?(dep, locked_dep)
  # Because the lockfile can't link a dep to a specific remote, we need to
  # treat sources as equivalent anytime the locked dep has all the remotes
  # that the Gemfile dep does.
  locked_dep && locked_dep.source && dep.source && locked_dep.source.include?(dep.source)
end
lockfiles_equal?(current, proposed, preserve_bundled_with) click to toggle source
# File lib/bundler/definition.rb, line 664
def lockfiles_equal?(current, proposed, preserve_bundled_with)
  if preserve_bundled_with
    pattern = /\n\n#{LockfileParser::BUNDLED}\n\s+#{Gem::Version::VERSION_PATTERN}\n/
    current.sub(pattern, "\n") == proposed.sub(pattern, "\n")
  else
    current == proposed
  end
end
nothing_changed?() click to toggle source
# File lib/bundler/definition.rb, line 421
def nothing_changed?
  !@source_changes && !@dependency_changes && !@new_platform && !@path_changes && !@local_changes
end
pinned_spec_names(specs) click to toggle source
# File lib/bundler/definition.rb, line 646
def pinned_spec_names(specs)
  names = []
  specs.each do |s|
    # TODO when two sources without blocks is an error, we can change
    # this check to !s.source.is_a?(Source::LocalRubygems). For now,
    # we need to ask every Rubygems for every gem name.
    if s.source.is_a?(Source::Git) || s.source.is_a?(Source::Path)
      names << s.name
    end
  end
  names.uniq!
  names
end
pretty_dep(dep, source = false) click to toggle source
# File lib/bundler/definition.rb, line 425
def pretty_dep(dep, source = false)
  msg  = "#{dep.name}"
  msg << " (#{dep.requirement})" unless dep.requirement == Gem::Requirement.default
  msg << " from the `#{dep.source}` source" if source && dep.source
  msg
end
requested_dependencies() click to toggle source
# File lib/bundler/definition.rb, line 625
def requested_dependencies
  groups = requested_groups
  groups.map! { |g| g.to_sym }
  dependencies.reject { |d| !d.should_include? || (d.groups & groups).empty? }
end
requested_groups() click to toggle source
# File lib/bundler/definition.rb, line 660
def requested_groups
  self.groups - Bundler.settings.without - @optional_groups + Bundler.settings.with
end
satisfies_locked_spec?(dep) click to toggle source
# File lib/bundler/definition.rb, line 605
def satisfies_locked_spec?(dep)
  @locked_specs.any? { |s| s.satisfies?(dep) && (!dep.source || s.source.include?(dep.source)) }
end
source_requirements() click to toggle source
# File lib/bundler/definition.rb, line 631
def source_requirements
  # Load all specs from remote sources
  index

  # Record the specs available in each gem's source, so that those
  # specs will be available later when the resolver knows where to
  # look for that gemspec (or its dependencies)
  source_requirements = {}
  dependencies.each do |dep|
    next unless dep.source
    source_requirements[dep.name] = dep.source.specs
  end
  source_requirements
end
specs_changed?(source, &block) click to toggle source

Check if the specs of the given source changed according to the locked source. A block should be in order to specify how the locked version of the source should be found.

# File lib/bundler/definition.rb, line 436
def specs_changed?(source, &block)
  locked = @locked_sources.find(&block)

  if locked
    unlocking = @locked_specs.any? do |locked_spec|
      locked_spec.source.class == locked.class && locked_spec.source != locked
    end
  end

  !locked || unlocking || dependencies_for_source_changed?(locked) || source.specs != locked.specs
end