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

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from GemHelpers

generic, generic_local_platform, generic_local_platform_is_ruby?, local_platform, platform_specificity_match, same_deps, same_specificity, select_all_platform_match, select_best_local_platform_match, select_best_platform_match, sort_and_filter_best_platform_match, sort_best_platform_match

Constructor Details

#initialize(lockfile, dependencies, sources, unlock, ruby_version = nil, optional_groups = [], gemfiles = []) ⇒ 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



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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/bundler/definition.rb', line 60

def initialize(lockfile, dependencies, sources, unlock, ruby_version = nil, optional_groups = [], gemfiles = [])
  if [true, false].include?(unlock)
    @unlocking_bundler = false
    @unlocking = unlock
  else
    @unlocking_bundler = unlock.delete(:bundler)
    @unlocking = unlock.any? {|_k, v| !Array(v).empty? }
  end

  @dependencies    = dependencies
  @sources         = sources
  @unlock          = unlock
  @optional_groups = optional_groups
  @prefer_local    = false
  @specs           = nil
  @ruby_version    = ruby_version
  @gemfiles        = gemfiles

  @lockfile               = lockfile
  @lockfile_contents      = String.new

  @locked_bundler_version = nil
  @resolved_bundler_version = nil

  @locked_ruby_version = nil
  @new_platforms = []
  @removed_platform = nil

  if lockfile_exists?
    @lockfile_contents = Bundler.read_file(lockfile)
    @locked_gems = LockfileParser.new(@lockfile_contents)
    @locked_platforms = @locked_gems.platforms
    @most_specific_locked_platform = @locked_gems.most_specific_locked_platform
    @platforms = @locked_platforms.dup
    @locked_bundler_version = @locked_gems.bundler_version
    @locked_ruby_version = @locked_gems.ruby_version
    @originally_locked_deps = @locked_gems.dependencies
    @originally_locked_specs = SpecSet.new(@locked_gems.specs)
    @locked_checksums = @locked_gems.checksums

    if unlock != true
      @locked_deps    = @originally_locked_deps
      @locked_specs   = @originally_locked_specs
      @locked_sources = @locked_gems.sources
    else
      @unlock         = {}
      @locked_deps    = {}
      @locked_specs   = SpecSet.new([])
      @locked_sources = []
    end
  else
    @unlock         = {}
    @locked_gems    = nil
    @locked_platforms = []
    @most_specific_locked_platform = nil
    @platforms      = []
    @locked_deps    = {}
    @locked_specs   = SpecSet.new([])
    @originally_locked_deps = {}
    @originally_locked_specs = @locked_specs
    @locked_sources = []
    @locked_checksums = Bundler.feature_flag.lockfile_checksums?
  end

  locked_gem_sources = @locked_sources.select {|s| s.is_a?(Source::Rubygems) }
  @multisource_allowed = locked_gem_sources.size == 1 && locked_gem_sources.first.multiple_remotes? && Bundler.frozen_bundle?

  if @multisource_allowed
    unless sources.aggregate_global_source?
      msg = "Your lockfile contains a single rubygems source section with multiple remotes, which is insecure. Make sure you run `bundle install` in non frozen mode and commit the result to make your lockfile secure."

      Bundler::SharedHelpers.major_deprecation 2, msg
    end

    @sources.merged_gem_lockfile_sections!(locked_gem_sources.first)
  end

  @sources_to_unlock = @unlock.delete(: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)

  @current_platform_missing = add_current_platform unless Bundler.frozen_bundle?

  converge_path_sources_to_gemspec_sources
  @path_changes = converge_paths
  @source_changes = converge_sources

  @explicit_unlocks = @unlock.delete(:gems) || []

  if @unlock[:conservative]
    @gems_to_unlock = @explicit_unlocks.any? ? @explicit_unlocks : @dependencies.map(&:name)
  else
    eager_unlock = @explicit_unlocks.map {|name| Dependency.new(name, ">= 0") }
    @gems_to_unlock = @locked_specs.for(eager_unlock, platforms).map(&:name).uniq
  end

  @dependency_changes = converge_dependencies
  @local_changes = converge_locals

  check_lockfile
end

Class Attribute Details

.no_lockObject

Do not create or modify a lockfile (Makes #lock a noop)



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

def no_lock
  @no_lock
end

Instance Attribute Details

#dependenciesObject (readonly)

Returns the value of attribute dependencies.



14
15
16
# File 'lib/bundler/definition.rb', line 14

def dependencies
  @dependencies
end

#gemfilesObject (readonly)

Returns the value of attribute gemfiles.



14
15
16
# File 'lib/bundler/definition.rb', line 14

def gemfiles
  @gemfiles
end

#locked_checksumsObject (readonly)

Returns the value of attribute locked_checksums.



14
15
16
# File 'lib/bundler/definition.rb', line 14

def locked_checksums
  @locked_checksums
end

#locked_depsObject (readonly)

Returns the value of attribute locked_deps.



14
15
16
# File 'lib/bundler/definition.rb', line 14

def locked_deps
  @locked_deps
end

#locked_gemsObject (readonly)

Returns the value of attribute locked_gems.



14
15
16
# File 'lib/bundler/definition.rb', line 14

def locked_gems
  @locked_gems
end

#lockfileObject (readonly)

Returns the value of attribute lockfile.



14
15
16
# File 'lib/bundler/definition.rb', line 14

def lockfile
  @lockfile
end

#platformsObject (readonly)

Returns the value of attribute platforms.



14
15
16
# File 'lib/bundler/definition.rb', line 14

def platforms
  @platforms
end

#ruby_versionObject (readonly)

Returns the value of attribute ruby_version.



14
15
16
# File 'lib/bundler/definition.rb', line 14

def ruby_version
  @ruby_version
end

#source_requirements=(value) ⇒ Object

Sets the attribute source_requirements

Parameters:

  • value

    the value to set the attribute source_requirements to.



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

def source_requirements=(value)
  @source_requirements = value
end

#sourcesObject (readonly)

Returns the value of attribute sources.



14
15
16
# File 'lib/bundler/definition.rb', line 14

def sources
  @sources
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:



33
34
35
36
37
38
39
40
# File 'lib/bundler/definition.rb', line 33

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_checksumsObject



529
530
531
532
533
534
535
# File 'lib/bundler/definition.rb', line 529

def add_checksums
  @locked_checksums = true

  setup_domain!(add_checksums: true)

  specs # force materialization to real specifications, so that checksums are fetched
end

#add_platform(platform) ⇒ Object



501
502
503
504
505
506
# File 'lib/bundler/definition.rb', line 501

def add_platform(platform)
  return if @platforms.include?(platform)

  @new_platforms << platform
  @platforms << platform
end

#bundler_version_to_lockObject



396
397
398
# File 'lib/bundler/definition.rb', line 396

def bundler_version_to_lock
  @resolved_bundler_version || Bundler.gem_version
end

#check!Object



168
169
170
171
172
173
174
175
176
177
178
# File 'lib/bundler/definition.rb', line 168

def check!
  # If dependencies have changed, we need to resolve remotely. Otherwise,
  # since we'll be resolving with a single local source, we may end up
  # locking gems under the wrong source in the lockfile, and missing lockfile
  # checksums
  resolve_remotely! if @dependency_changes

  # Now do a local only resolve, to verify if any gems are missing locally
  sources.local_only!
  resolve
end

#current_dependenciesObject



271
272
273
# File 'lib/bundler/definition.rb', line 271

def current_dependencies
  filter_relevant(dependencies)
end

#current_locked_dependenciesObject



275
276
277
# File 'lib/bundler/definition.rb', line 275

def current_locked_dependencies
  filter_relevant(locked_dependencies)
end

#deleted_depsObject



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

def deleted_deps
  @deleted_deps ||= locked_dependencies - @dependencies
end

#dependencies_for(groups) ⇒ Object



304
305
306
307
308
309
310
311
# File 'lib/bundler/definition.rb', line 304

def dependencies_for(groups)
  groups.map!(&:to_sym)
  deps = current_dependencies # always returns a new array
  deps.select! do |d|
    d.groups.intersect?(groups)
  end
  deps
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
# File 'lib/bundler/definition.rb', line 405

def ensure_equivalent_gemfile_and_lockfile(explicit_flag = false)
  return unless Bundler.frozen_bundle?

  raise ProductionError, "Frozen mode is set, but there's no lockfile" unless lockfile_exists?

  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}" }

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

  both_sources = Hash.new {|h, k| h[k] = [] }
  current_dependencies.each {|d| both_sources[d.name][0] = d }
  current_locked_dependencies.each {|d| both_sources[d.name][1] = d }

  both_sources.each do |name, (dep, lock_dep)|
    next if dep.nil? || lock_dep.nil?

    gemfile_source = dep.source || default_source
    lock_source = lock_dep.source || default_source
    next if lock_source.include?(gemfile_source)

    gemfile_source_name = dep.source ? gemfile_source.to_gemfile : "no specified source"
    lockfile_source_name = lock_dep.source ? lock_source.to_gemfile : "no specified source"
    changed << "* #{name} from `#{lockfile_source_name}` to `#{gemfile_source_name}`"
  end

  reason = nothing_changed? ? "some dependencies were deleted from your gemfile" : change_reason
  msg = String.new
  msg << "#{reason.capitalize.strip}, but the lockfile can't be updated because frozen mode is set"
  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\nRun `bundle install` elsewhere and add the updated #{SharedHelpers.relative_gemfile_path} to version control.\n"

  unless explicit_flag
    suggested_command = unless Bundler.settings.locations("frozen").keys.include?(:env)
      "bundle config set frozen false"
    end
    msg << "If this is a development machine, remove the #{SharedHelpers.relative_lockfile_path} " \
           "freeze by running `#{suggested_command}`." if suggested_command
  end

  raise ProductionError, msg if added.any? || deleted.any? || changed.any? || !nothing_changed?
end

#filter_relevant(dependencies) ⇒ Object



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

def filter_relevant(dependencies)
  platforms_array = [generic_local_platform].freeze
  dependencies.select do |d|
    d.should_include? && !d.gem_platforms(platforms_array).empty?
  end
end

#gem_version_promoterObject



164
165
166
# File 'lib/bundler/definition.rb', line 164

def gem_version_promoter
  @gem_version_promoter ||= GemVersionPromoter.new
end

#groupsObject



349
350
351
# File 'lib/bundler/definition.rb', line 349

def groups
  dependencies.flat_map(&:groups).uniq
end

#lock(file_or_preserve_unknown_sections = false, preserve_unknown_sections_or_unused = false) ⇒ Object



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
# File 'lib/bundler/definition.rb', line 353

def lock(file_or_preserve_unknown_sections = false, preserve_unknown_sections_or_unused = false)
  if [true, false, nil].include?(file_or_preserve_unknown_sections)
    target_lockfile = lockfile
    preserve_unknown_sections = file_or_preserve_unknown_sections
  else
    target_lockfile = file_or_preserve_unknown_sections
    preserve_unknown_sections = preserve_unknown_sections_or_unused

    suggestion = if target_lockfile == lockfile
      "To fix this warning, remove it from the `Definition#lock` call."
    else
      "Instead, instantiate a new definition passing `#{target_lockfile}`, and call `lock` without a file argument on that definition"
    end

    msg = "`Definition#lock` was passed a target file argument. #{suggestion}"

    Bundler::SharedHelpers.major_deprecation 2, msg
  end

  write_lock(target_lockfile, preserve_unknown_sections)
end

#locked_dependenciesObject



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

def locked_dependencies
  @locked_deps.values
end

#locked_ruby_versionObject



375
376
377
378
379
380
381
382
# File 'lib/bundler/definition.rb', line 375

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



384
385
386
387
388
389
390
391
392
393
394
# File 'lib/bundler/definition.rb', line 384

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_specsObject



243
244
245
# File 'lib/bundler/definition.rb', line 243

def missing_specs
  resolve.missing_specs_for(requested_dependencies)
end

#missing_specs?Boolean

Returns:

  • (Boolean)


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/bundler/definition.rb', line 247

def missing_specs?
  missing = missing_specs
  return false if missing.empty?
  Bundler.ui.debug "The definition is missing #{missing.map(&:full_name)}"
  true
rescue BundlerError => e
  @resolve = nil
  @resolver = nil
  @resolution_packages = nil
  @source_requirements = nil
  @specs = nil

  Bundler.ui.debug "The definition is missing dependencies, failed to resolve & materialize locally (#{e})"
  true
end

#new_depsObject



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

def new_deps
  @new_deps ||= @dependencies - locked_dependencies
end

#new_specsObject



235
236
237
# File 'lib/bundler/definition.rb', line 235

def new_specs
  specs - @locked_specs
end

#no_resolve_needed?Boolean

Returns:

  • (Boolean)


519
520
521
# File 'lib/bundler/definition.rb', line 519

def no_resolve_needed?
  !resolve_needed?
end

#normalize_platformsObject



495
496
497
498
499
# File 'lib/bundler/definition.rb', line 495

def normalize_platforms
  @platforms = resolve.normalize_platforms!(current_dependencies, platforms)

  @resolve = SpecSet.new(resolve.for(current_dependencies, @platforms))
end

#nothing_changed?Boolean

Returns:

  • (Boolean)


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

def nothing_changed?
  !something_changed?
end

#prefer_local!Object



221
222
223
# File 'lib/bundler/definition.rb', line 221

def prefer_local!
  @prefer_local = true
end

#remotely!Object



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

def remotely!
  sources.cached!
  sources.remote!
end

#remove_platform(platform) ⇒ Object

Raises:



508
509
510
511
512
513
# File 'lib/bundler/definition.rb', line 508

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

#removed_specsObject



239
240
241
# File 'lib/bundler/definition.rb', line 239

def removed_specs
  @locked_specs - specs
end

#requested_dependenciesObject



267
268
269
# File 'lib/bundler/definition.rb', line 267

def requested_dependencies
  dependencies_for(requested_groups)
end

#requested_specsObject



263
264
265
# File 'lib/bundler/definition.rb', line 263

def requested_specs
  specs_for(requested_groups)
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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/bundler/definition.rb', line 318

def resolve
  @resolve ||= if Bundler.frozen_bundle?
    Bundler.ui.debug "Frozen, using resolution from the lockfile"
    @locked_specs
  elsif no_resolve_needed?
    if deleted_deps.any?
      Bundler.ui.debug "Some dependencies were deleted, using a subset of the resolution from the lockfile"
      SpecSet.new(filter_specs(@locked_specs, @dependencies - deleted_deps))
    else
      Bundler.ui.debug "Found no changes, using resolution from the lockfile"
      if @removed_platform || @locked_gems.may_include_redundant_platform_specific_gems?
        SpecSet.new(filter_specs(@locked_specs, @dependencies))
      else
        @locked_specs
      end
    end
  else
    if lockfile_exists?
      Bundler.ui.debug "Found changes from the lockfile, re-resolving dependencies because #{change_reason}"
    else
      Bundler.ui.debug "Resolving dependencies because there's no lockfile"
    end

    start_resolution
  end
end

#resolve_remotely!Object



210
211
212
213
214
# File 'lib/bundler/definition.rb', line 210

def resolve_remotely!
  remotely!

  resolve
end

#resolve_with_cache!Object



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

def resolve_with_cache!
  with_cache!

  resolve
end

#setup_domain!(options = {}) ⇒ Boolean

Setup sources according to the given options and the state of the definition.

Returns:

  • (Boolean)

    Whether fetching remote information will be necessary or not



186
187
188
189
190
191
192
193
194
195
196
197
# File 'lib/bundler/definition.rb', line 186

def setup_domain!(options = {})
  prefer_local! if options[:"prefer-local"]

  if options[:add_checksums] || (!options[:local] && install_needed?)
    remotely!
    true
  else
    Bundler.settings.set_command_option(:jobs, 1) unless install_needed? # to avoid the overhead of Bundler::Worker
    with_cache!
    false
  end
end

#spec_git_pathsObject



345
346
347
# File 'lib/bundler/definition.rb', line 345

def spec_git_paths
  sources.git_sources.filter_map {|s| File.realpath(s.path) if File.exist?(s.path) }
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:



231
232
233
# File 'lib/bundler/definition.rb', line 231

def specs
  @specs ||= materialize(requested_dependencies)
end

#specs_for(groups) ⇒ Object



298
299
300
301
302
# File 'lib/bundler/definition.rb', line 298

def specs_for(groups)
  return specs if groups.empty?
  deps = dependencies_for(groups)
  materialize(deps)
end

#to_lockObject



400
401
402
403
# File 'lib/bundler/definition.rb', line 400

def to_lock
  require_relative "lockfile_generator"
  LockfileGenerator.generate(self)
end

#unlocking?Boolean

Returns:

  • (Boolean)


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

def unlocking?
  @unlocking
end

#validate_platforms!Object

Raises:



487
488
489
490
491
492
493
# File 'lib/bundler/definition.rb', line 487

def validate_platforms!
  return if current_platform_locked?

  raise ProductionError, "Your bundle only supports platforms #{@platforms.map(&:to_s)} " \
    "but your local platform is #{local_platform}. " \
    "Add the current platform to the lockfile with\n`bundle lock --add-platform #{local_platform}` and try again."
end

#validate_ruby!Object



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'lib/bundler/definition.rb', line 462

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



457
458
459
460
# File 'lib/bundler/definition.rb', line 457

def validate_runtime!
  validate_ruby!
  validate_platforms!
end

#with_cache!Object



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

def with_cache!
  sources.local!
  sources.cached!
end