Class: Bundler::Definition

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

Constant Summary

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

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.


45
46
47
48
49
50
51
52
53
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
# File 'lib/bundler/definition.rb', line 45

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(&:name)

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

  fixup_dependency_types!
end

Instance Attribute Details

#dependenciesObject (readonly)

Returns the value of attribute dependencies



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

def dependencies
  @dependencies
end

#locked_depsObject (readonly)

Returns the value of attribute locked_deps



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

def locked_deps
  @locked_deps
end

#platformsObject (readonly)

Returns the value of attribute platforms



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

def platforms
  @platforms
end

#ruby_versionObject (readonly)

Returns the value of attribute ruby_version



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

def ruby_version
  @ruby_version
end

Class Method Details

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

Given a gemfile and lockfile creates a Bundler definition

Raises:



18
19
20
21
22
23
24
25
# File 'lib/bundler/definition.rb', line 18

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

#current_dependenciesObject



175
176
177
# File 'lib/bundler/definition.rb', line 175

def current_dependencies
  dependencies.reject {|d| !d.should_include? }
end

#ensure_equivalent_gemfile_and_lockfile(explicit_flag = false) ⇒ Object

Raises:



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'lib/bundler/definition.rb', line 325

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 #{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 = []

  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

  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\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!Object



101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/bundler/definition.rb', line 101

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



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

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

#has_local_dependencies?Boolean



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

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

#has_rubygems_remotes?Boolean



226
227
228
# File 'lib/bundler/definition.rb', line 226

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

#indexObject



203
204
205
206
207
208
209
210
211
212
213
214
# File 'lib/bundler/definition.rb', line 203

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.push(*source.unmet_deps).uniq!
    end
  end
end

#lock(file, preserve_bundled_with = false) ⇒ Object



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
# File 'lib/bundler/definition.rb', line 242

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

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

#lock_versionObject

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



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

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_specsObject



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

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

#new_platform?Boolean



157
158
159
# File 'lib/bundler/definition.rb', line 157

def new_platform?
  @new_platform
end

#new_specsObject



149
150
151
# File 'lib/bundler/definition.rb', line 149

def new_specs
  specs - @locked_specs
end

#removed_specsObject



153
154
155
# File 'lib/bundler/definition.rb', line 153

def removed_specs
  @locked_specs - specs
end

#requested_specsObject



167
168
169
170
171
172
173
# File 'lib/bundler/definition.rb', line 167

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



190
191
192
193
194
195
196
197
198
199
200
201
# File 'lib/bundler/definition.rb', line 190

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
      requested_ruby_version = ruby_version.version if ruby_version
      last_resolve.merge Resolver.resolve(expanded_dependencies, index, source_requirements, last_resolve, requested_ruby_version)
    end
  end
end

#resolve_remotely!Object



122
123
124
125
126
127
# File 'lib/bundler/definition.rb', line 122

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

#resolve_with_cache!Object



116
117
118
119
120
# File 'lib/bundler/definition.rb', line 116

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.



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

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



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

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


135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/bundler/definition.rb', line 135

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



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

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
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
# File 'lib/bundler/definition.rb', line 282

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(&: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

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

  out
end

#validate_ruby!Object



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
# File 'lib/bundler/definition.rb', line 381

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