Class: Bundler::Definition

Inherits:
Object
  • Object
show all
Includes:
GemHelpers
Defined in:
lib/bundler/definition.rb

Constant Summary

Constants included from GemHelpers

GemHelpers::GENERICS, GemHelpers::GENERIC_CACHE

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from GemHelpers

generic, generic_local_platform, platform_specificity_match, select_best_platform_match

Constructor Details

#initialize(lockfile, dependencies, sources, unlock, ruby_version = nil, optional_groups = []) ⇒ Definition

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.

Parameters:

  • lockfile (Pathname)

    Path to Gemfile.lock

  • dependencies (Array(Bundler::Dependency))

    array of dependencies from Gemfile

  • sources (Bundler::SourceList)
  • unlock (Hash, Boolean, nil)

    Gems that have been requested to be updated or true if all gems should be updated

  • ruby_version (Bundler::RubyVersion, nil) (defaults to: nil)

    Requested Ruby Version

  • optional_groups (Array(String)) (defaults to: [])

    A list of optional groups



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/bundler/definition.rb', line 54

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               = lockfile
  @lockfile_contents      = String.new
  @locked_bundler_version = nil
  @locked_ruby_version    = nil

  if lockfile && File.exist?(lockfile)
    @lockfile_contents = Bundler.read_file(lockfile)
    @locked_gems = LockfileParser.new(@lockfile_contents)
    @locked_platforms = @locked_gems.platforms
    @platforms = @locked_platforms.dup
    @locked_bundler_version = @locked_gems.bundler_version
    @locked_ruby_version = @locked_gems.ruby_version

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

  @unlock[:gems] ||= []
  @unlock[:sources] ||= []
  @unlock[:ruby] ||= if @ruby_version && locked_ruby_version_object
    @ruby_version.diff(locked_ruby_version_object)
  end
  @unlocking ||= @unlock[:ruby] ||= (!@locked_ruby_version ^ !@ruby_version)

  add_current_platform unless Bundler.settings[:frozen]

  converge_path_sources_to_gemspec_sources
  @path_changes = converge_paths
  @source_changes = converge_sources

  unless @unlock[:lock_shared_dependencies]
    eager_unlock = expand_dependencies(@unlock[:gems])
    @unlock[:gems] = @locked_specs.for(eager_unlock).map(&:name)
  end

  @gem_version_promoter = create_gem_version_promoter

  @dependency_changes = converge_dependencies
  @local_changes = converge_locals

  @requires = compute_requires

  fixup_dependency_types!
end

Instance Attribute Details

#dependenciesObject (readonly)

Returns the value of attribute dependencies



10
11
12
# File 'lib/bundler/definition.rb', line 10

def dependencies
  @dependencies
end

#gem_version_promoterObject (readonly)

Returns the value of attribute gem_version_promoter



10
11
12
# File 'lib/bundler/definition.rb', line 10

def gem_version_promoter
  @gem_version_promoter
end

#locked_depsObject (readonly)

Returns the value of attribute locked_deps



10
11
12
# File 'lib/bundler/definition.rb', line 10

def locked_deps
  @locked_deps
end

#locked_gemsObject (readonly)

Returns the value of attribute locked_gems



10
11
12
# File 'lib/bundler/definition.rb', line 10

def locked_gems
  @locked_gems
end

#platformsObject (readonly)

Returns the value of attribute platforms



10
11
12
# File 'lib/bundler/definition.rb', line 10

def platforms
  @platforms
end

#requiresObject (readonly)

Returns the value of attribute requires



10
11
12
# File 'lib/bundler/definition.rb', line 10

def requires
  @requires
end

#ruby_versionObject (readonly)

Returns the value of attribute ruby_version



10
11
12
# File 'lib/bundler/definition.rb', line 10

def ruby_version
  @ruby_version
end

Class Method Details

.build(gemfile, lockfile, unlock) ⇒ Bundler::Definition

Given a gemfile and lockfile creates a Bundler definition

Parameters:

  • gemfile (Pathname)

    Path to Gemfile

  • lockfile (Pathname, nil)

    Path to Gemfile.lock

  • unlock (Hash, Boolean, nil)

    Gems that have been requested to be updated or true if all gems should be updated

Returns:

Raises:



27
28
29
30
31
32
33
34
# File 'lib/bundler/definition.rb', line 27

def self.build(gemfile, lockfile, unlock)
  unlock ||= {}
  gemfile = Pathname.new(gemfile).expand_path

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

  Dsl.evaluate(gemfile, lockfile, unlock)
end

Instance Method Details

#add_current_platformObject



526
527
528
529
530
# File 'lib/bundler/definition.rb', line 526

def add_current_platform
  current_platform = Bundler.local_platform
  add_platform(current_platform) if Bundler.settings[:specific_platform]
  add_platform(generic(current_platform))
end

#add_platform(platform) ⇒ Object



516
517
518
519
# File 'lib/bundler/definition.rb', line 516

def add_platform(platform)
  @new_platform ||= !@platforms.include?(platform)
  @platforms |= [platform]
end

#create_gem_version_promoterObject



141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/bundler/definition.rb', line 141

def create_gem_version_promoter
  locked_specs =
    if @unlocking && @locked_specs.empty? && !@lockfile_contents.empty?
      # Definition uses an empty set of locked_specs to indicate all gems
      # are unlocked, but GemVersionPromoter needs the locked_specs
      # for conservative comparison.
      Bundler::SpecSet.new(@locked_gems.specs)
    else
      @locked_specs
    end
  GemVersionPromoter.new(locked_specs, @unlock[:gems])
end

#current_dependenciesObject



228
229
230
# File 'lib/bundler/definition.rb', line 228

def current_dependencies
  dependencies.select(&:should_include?)
end

#ensure_equivalent_gemfile_and_lockfile(explicit_flag = false) ⇒ Object

Raises:



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
# File 'lib/bundler/definition.rb', line 405

def ensure_equivalent_gemfile_and_lockfile(explicit_flag = false)
  msg = String.new
  msg << "You are trying to install in deployment mode after changing\n" \
         "your Gemfile. Run `bundle install` elsewhere and add the\n" \
         "updated #{Bundler.default_lockfile.relative_path_from(SharedHelpers.pwd)} to version control."

  unless explicit_flag
    msg << "\n\nIf this is a development machine, remove the #{Bundler.default_gemfile} " \
           "freeze \nby running `bundle install --no-deployment`."
  end

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

  new_platforms = @platforms - @locked_platforms
  deleted_platforms = @locked_platforms - @platforms
  added.concat new_platforms.map {|p| "* platform: #{p}" }
  deleted.concat deleted_platforms.map {|p| "* platform: #{p}" }

  gemfile_sources = sources.lock_sources

  new_sources = gemfile_sources - @locked_sources
  deleted_sources = @locked_sources - gemfile_sources

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

  # Check if it is possible that the source is only changed thing
  if (new_deps.empty? && deleted_deps.empty?) && (!new_sources.empty? && !deleted_sources.empty?)
    new_sources.reject! {|source| source.is_a_path? && source.path.exist? }
    deleted_sources.reject! {|source| source.is_a_path? && source.path.exist? }
  end

  if @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

  added.concat new_deps.map {|d| "* #{pretty_dep(d)}" } if new_deps.any?
  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)|
    next unless (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

  msg << "\n\n#{change_reason.split(", ").join("\n")}\n"
  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? || !nothing_changed?
end

#find_indexed_specs(current_spec) ⇒ Object



536
537
538
# File 'lib/bundler/definition.rb', line 536

def find_indexed_specs(current_spec)
  index[current_spec.name].select {|spec| spec.match_platform(current_spec.platform) }.sort_by(&:version)
end

#find_resolved_spec(current_spec) ⇒ Object



532
533
534
# File 'lib/bundler/definition.rb', line 532

def find_resolved_spec(current_spec)
  specs.find_by_name_and_platform(current_spec.name, current_spec.platform)
end

#fixup_dependency_types!Object



126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/bundler/definition.rb', line 126

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

#groupsObject



294
295
296
# File 'lib/bundler/definition.rb', line 294

def groups
  dependencies.map(&:groups).flatten.uniq
end

#has_local_dependencies?Boolean

Returns:

  • (Boolean)


286
287
288
# File 'lib/bundler/definition.rb', line 286

def has_local_dependencies?
  !sources.path_sources.empty? || !sources.git_sources.empty?
end

#has_rubygems_remotes?Boolean

Returns:

  • (Boolean)


282
283
284
# File 'lib/bundler/definition.rb', line 282

def has_rubygems_remotes?
  sources.rubygems_sources.any? {|s| s.remotes.any? }
end

#indexObject



257
258
259
260
261
262
263
264
265
266
267
268
269
270
# File 'lib/bundler/definition.rb', line 257

def index
  @index ||= Index.build do |idx|
    dependency_names = @dependencies.map(&: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.concat(source.unmet_deps).uniq!
    end
    idx << Gem::Specification.new("ruby\0", RubyVersion.system.to_gem_version_with_patchlevel)
    idx << Gem::Specification.new("rubygems\0", Gem::VERSION)
  end
end

#lock(file, preserve_unknown_sections = false) ⇒ Object



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/bundler/definition.rb', line 298

def lock(file, preserve_unknown_sections = 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_unknown_sections ||= !updating_major && (Bundler.settings[:frozen] || !@unlocking)
  return if lockfiles_equal?(@lockfile_contents, contents, preserve_unknown_sections)

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

  SharedHelpers.filesystem_access(file) do |p|
    File.open(p, "wb") {|f| f.puts(contents) }
  end
end

#locked_bundler_versionObject



328
329
330
331
332
333
334
# File 'lib/bundler/definition.rb', line 328

def locked_bundler_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

#locked_ruby_versionObject



336
337
338
339
340
341
342
343
# File 'lib/bundler/definition.rb', line 336

def locked_ruby_version
  return unless ruby_version
  if @unlock[:ruby] || !@locked_ruby_version
    Bundler::RubyVersion.system
  else
    @locked_ruby_version
  end
end

#locked_ruby_version_objectObject



345
346
347
348
349
350
351
352
353
354
355
# File 'lib/bundler/definition.rb', line 345

def locked_ruby_version_object
  return unless @locked_ruby_version
  @locked_ruby_version_object ||= begin
    unless version = RubyVersion.from_string(@locked_ruby_version)
      raise LockfileError, "The Ruby version #{@locked_ruby_version} from " \
        "#{@lockfile} could not be parsed. " \
        "Try running bundle update --ruby to resolve this."
    end
    version
  end
end

#missing_dependenciesObject



214
215
216
217
218
# File 'lib/bundler/definition.rb', line 214

def missing_dependencies
  missing = []
  resolve.materialize(current_dependencies, missing)
  missing
end

#missing_specsObject



208
209
210
211
212
# File 'lib/bundler/definition.rb', line 208

def missing_specs
  missing = []
  resolve.materialize(requested_dependencies, missing)
  missing
end

#new_platform?Boolean

Returns:

  • (Boolean)


204
205
206
# File 'lib/bundler/definition.rb', line 204

def new_platform?
  @new_platform
end

#new_specsObject



196
197
198
# File 'lib/bundler/definition.rb', line 196

def new_specs
  specs - @locked_specs
end

#remove_platform(platform) ⇒ Object

Raises:



521
522
523
524
# File 'lib/bundler/definition.rb', line 521

def remove_platform(platform)
  return if @platforms.delete(Gem::Platform.new(platform))
  raise InvalidOption, "Unable to remove the platform `#{platform}` since the only platforms are #{@platforms.join ", "}"
end

#removed_specsObject



200
201
202
# File 'lib/bundler/definition.rb', line 200

def removed_specs
  @locked_specs - specs
end

#requested_specsObject



220
221
222
223
224
225
226
# File 'lib/bundler/definition.rb', line 220

def requested_specs
  @requested_specs ||= begin
    groups = requested_groups
    groups.map!(&:to_sym)
    specs_for(groups)
  end
end

#resolveSpecSet

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

Returns:

  • (SpecSet)

    resolved dependencies



243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'lib/bundler/definition.rb', line 243

def resolve
  @resolve ||= begin
    last_resolve = converge_locked_specs
    if Bundler.settings[:frozen] || (!@unlocking && nothing_changed?)
      Bundler.ui.debug("Found no changes, using resolution from the lockfile")
      last_resolve
    else
      # Run a resolve against the locally available gems
      Bundler.ui.debug("Found changes from the lockfile, re-resolving dependencies because #{change_reason}")
      last_resolve.merge Resolver.resolve(expanded_dependencies, index, source_requirements, last_resolve, gem_version_promoter, additional_base_requirements_for_resolve, platforms)
    end
  end
end

#resolve_remotely!Object



160
161
162
163
164
165
# File 'lib/bundler/definition.rb', line 160

def resolve_remotely!
  raise "Specs already loaded" if @specs
  @remote = true
  sources.remote!
  specs
end

#resolve_with_cache!Object



154
155
156
157
158
# File 'lib/bundler/definition.rb', line 154

def resolve_with_cache!
  raise "Specs already loaded" if @specs
  sources.cached!
  specs
end

#rubygems_indexObject

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



274
275
276
277
278
279
280
# File 'lib/bundler/definition.rb', line 274

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_pathsObject



290
291
292
# File 'lib/bundler/definition.rb', line 290

def spec_git_paths
  sources.git_sources.map {|s| s.path.to_s }
end

#specsBundler::SpecSet

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

Returns:



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/bundler/definition.rb', line 173

def specs
  @specs ||= begin
    begin
      specs = resolve.materialize(Bundler.settings[:cache_all_platforms] ? dependencies : requested_dependencies)
    rescue GemNotFound => e # Handle yanked gem
      gem_name, gem_version = extract_gem_info(e)
      locked_gem = @locked_specs[gem_name].last
      raise if locked_gem.nil? || locked_gem.version.to_s != gem_version || !@remote
      raise GemNotFound, "Your bundle is locked to #{locked_gem}, but that version could not " \
                         "be found in any of the sources listed in your Gemfile. If you haven't changed sources, " \
                         "that means the author of #{locked_gem} has removed it. You'll need to update your bundle " \
                         "to a different version of #{locked_gem} that hasn't been removed in order to install."
    end
    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) ⇒ Object



232
233
234
235
236
# File 'lib/bundler/definition.rb', line 232

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_lockObject



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'lib/bundler/definition.rb', line 357

def to_lock
  out = String.new

  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(&:full_name).
      each do |spec|
        next if spec.name == "bundler"
        out << spec.to_lock
      end
    out << "\n"
  end

  out << "PLATFORMS\n"

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

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

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

  if locked_ruby_version
    out << "\nRUBY VERSION\n"
    out << "   #{locked_ruby_version}\n"
  end

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

  out
end

#validate_platforms!Object

Raises:



504
505
506
507
508
509
510
511
512
513
514
# File 'lib/bundler/definition.rb', line 504

def validate_platforms!
  return if @platforms.any? do |bundle_platform|
    Bundler.rubygems.platforms.any? do |local_platform|
      MatchPlatform.platforms_match?(bundle_platform, local_platform)
    end
  end

  raise ProductionError, "Your bundle only supports platforms #{@platforms.map(&:to_s)} " \
    "but your local platforms are #{Bundler.rubygems.platforms.map(&:to_s)}, and " \
    "there's no compatible match between those two lists."
end

#validate_ruby!Object



479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'lib/bundler/definition.rb', line 479

def validate_ruby!
  return unless ruby_version

  if diff = ruby_version.diff(Bundler::RubyVersion.system)
    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::RubyVersion.system.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

#validate_runtime!Object



474
475
476
477
# File 'lib/bundler/definition.rb', line 474

def validate_runtime!
  validate_ruby!
  validate_platforms!
end