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, local_platform, platform_specificity_match, same_deps, same_specificity, select_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



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
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
 
# File 'lib/bundler/definition.rb', line 58

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
  @remote          = false
  @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_platform = nil
  @removed_platform = 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
    @originally_locked_specs = SpecSet.new(@locked_gems.specs)

    if unlock != true
      @locked_deps    = @locked_gems.dependencies
      @locked_specs   = @originally_locked_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([])
    @originally_locked_specs = @locked_specs
    @locked_sources = []
    @locked_platforms = []
  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

  @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.frozen_bundle?

  converge_path_sources_to_gemspec_sources
  @path_changes = converge_paths
  @source_changes = converge_sources

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

  @dependency_changes = converge_dependencies
  @local_changes = converge_locals

  @missing_lockfile_dep = check_missing_lockfile_dep
end

Class Attribute Details

.no_lock ⇒ Object

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

#dependencies ⇒ Object (readonly)

Returns the value of attribute dependencies.



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

def dependencies
  @dependencies
end

#gemfiles ⇒ Object (readonly)

Returns the value of attribute gemfiles.



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

def gemfiles
  @gemfiles
end

#locked_deps ⇒ Object (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_gems ⇒ Object (readonly)

Returns the value of attribute locked_gems.



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

def locked_gems
  @locked_gems
end

#lockfile ⇒ Object (readonly)

Returns the value of attribute lockfile.



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

def lockfile
  @lockfile
end

#platforms ⇒ Object (readonly)

Returns the value of attribute platforms.



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

def platforms
  @platforms
end

#ruby_version ⇒ Object (readonly)

Returns the value of attribute ruby_version.



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

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:



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

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_platform(platform) ⇒ Object 



459
460
461
462
 
# File 'lib/bundler/definition.rb', line 459

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

#bundler_version_to_lock ⇒ Object 



364
365
366
 
# File 'lib/bundler/definition.rb', line 364

def bundler_version_to_lock
  @resolved_bundler_version || Bundler.gem_version
end

#current_dependencies ⇒ Object 



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

def current_dependencies
  filter_relevant(dependencies)
end

#current_locked_dependencies ⇒ Object 



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

def current_locked_dependencies
  filter_relevant(locked_dependencies)
end

#deleted_deps ⇒ Object 



261
262
263
 
# File 'lib/bundler/definition.rb', line 261

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

#dependencies_for(groups) ⇒ Object 



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

def dependencies_for(groups)
  groups.map!(&:to_sym)
  current_dependencies.reject do |d|
    (d.groups & groups).empty?
  end
end

#ensure_equivalent_gemfile_and_lockfile(explicit_flag = false) ⇒ Object

Raises:



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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/bundler/definition.rb', line 373

def ensure_equivalent_gemfile_and_lockfile(explicit_flag = false)
  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 = 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 #{Bundler.default_lockfile.relative_path_from(SharedHelpers.pwd)} 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 #{Bundler.default_gemfile.relative_path_from(SharedHelpers.pwd)} " \
           "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 



247
248
249
250
251
 
# File 'lib/bundler/definition.rb', line 247

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

#gem_version_promoter ⇒ Object 



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

def gem_version_promoter
  @gem_version_promoter ||= GemVersionPromoter.new
end

#groups ⇒ Object 



309
310
311
 
# File 'lib/bundler/definition.rb', line 309

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

#lock(file, preserve_unknown_sections = false) ⇒ Object 



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

def lock(file, preserve_unknown_sections = false)
  return if Definition.no_lock

  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 = bundler_version_to_lock.segments.first

    updating_major = locked_major < current_major
  end

  preserve_unknown_sections ||= !updating_major && (Bundler.frozen_bundle? || !(unlocking? || @unlocking_bundler))

  return if file && File.exist?(file) && lockfiles_equal?(@lockfile_contents, contents, preserve_unknown_sections)

  if Bundler.frozen_bundle?
    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_dependencies ⇒ Object 



253
254
255
 
# File 'lib/bundler/definition.rb', line 253

def locked_dependencies
  @locked_deps.values
end

#locked_ruby_version ⇒ Object 



343
344
345
346
347
348
349
350
 
# File 'lib/bundler/definition.rb', line 343

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_object ⇒ Object 



352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/bundler/definition.rb', line 352

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_specs ⇒ Object 



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

def missing_specs
  resolve.materialize(requested_dependencies).missing_specs
end

#missing_specs? ⇒ Boolean

Returns:

  • (Boolean) 


215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/bundler/definition.rb', line 215

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
  @specs = nil
  @gem_version_promoter = nil

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

#most_specific_locked_platform ⇒ Object 



471
472
473
474
475
 
# File 'lib/bundler/definition.rb', line 471

def most_specific_locked_platform
  @platforms.min_by do |bundle_platform|
    platform_specificity_match(bundle_platform, local_platform)
  end
end

#new_deps ⇒ Object 



257
258
259
 
# File 'lib/bundler/definition.rb', line 257

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

#new_specs ⇒ Object 



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

def new_specs
  specs - @locked_specs
end

#no_resolve_needed? ⇒ Boolean

Returns:

  • (Boolean) 


484
485
486
 
# File 'lib/bundler/definition.rb', line 484

def no_resolve_needed?
  !unlocking? && nothing_changed?
end

#nothing_changed? ⇒ Boolean

Returns:

  • (Boolean) 


480
481
482
 
# File 'lib/bundler/definition.rb', line 480

def nothing_changed?
  !@source_changes && !@dependency_changes && !@new_platform && !@path_changes && !@local_changes && !@missing_lockfile_dep && !@unlocking_bundler
end

#remove_platform(platform) ⇒ Object

Raises:



464
465
466
467
468
469
 
# File 'lib/bundler/definition.rb', line 464

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_specs ⇒ Object 



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

def removed_specs
  @locked_specs - specs
end

#requested_dependencies ⇒ Object 



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

def requested_dependencies
  dependencies_for(requested_groups)
end

#requested_specs ⇒ Object 



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

def requested_specs
  specs_for(requested_groups)
end

#resolution_mode=(options) ⇒ Object 



176
177
178
179
180
181
182
183
 
# File 'lib/bundler/definition.rb', line 176

def resolution_mode=(options)
  if options["local"]
    @remote = false
  else
    @remote = true
    @prefer_local = options["prefer-local"]
  end
end

#resolve ⇒ SpecSet

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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/bundler/definition.rb', line 283

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
    Bundler.ui.debug "Found changes from the lockfile, re-resolving dependencies because #{change_reason}"
    start_resolution
  end
end

#resolve_only_locally! ⇒ Object 



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

def resolve_only_locally!
  @remote = false
  sources.local_only!
  resolve
end

#resolve_remotely! ⇒ Object 



170
171
172
173
174
 
# File 'lib/bundler/definition.rb', line 170

def resolve_remotely!
  @remote = true
  sources.remote!
  resolve
end

#resolve_with_cache! ⇒ Object 



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

def resolve_with_cache!
  sources.cached!
  resolve
end

#setup_sources_for_resolve ⇒ Object 



185
186
187
188
189
190
191
 
# File 'lib/bundler/definition.rb', line 185

def setup_sources_for_resolve
  if @remote == false
    sources.cached!
  else
    sources.remote!
  end
end

#spec_git_paths ⇒ Object 



305
306
307
 
# File 'lib/bundler/definition.rb', line 305

def spec_git_paths
  sources.git_sources.map {|s| File.realpath(s.path) if File.exist?(s.path) }.compact
end

#specs ⇒ Bundler::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:



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

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

#specs_for(groups) ⇒ Object 



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

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

#to_lock ⇒ Object 



368
369
370
371
 
# File 'lib/bundler/definition.rb', line 368

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

#unlocking? ⇒ Boolean

Returns:

  • (Boolean) 


488
489
490
 
# File 'lib/bundler/definition.rb', line 488

def unlocking?
  @unlocking
end

#validate_platforms! ⇒ Object

Raises:



451
452
453
454
455
456
457
 
# File 'lib/bundler/definition.rb', line 451

def validate_platforms!
  return if current_platform_locked?

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

#validate_ruby! ⇒ Object 



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/bundler/definition.rb', line 426

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 



421
422
423
424
 
# File 'lib/bundler/definition.rb', line 421

def validate_runtime!
  validate_ruby!
  validate_platforms!
end