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

Constructor Details

#initialize(lockfile, dependencies, sources, unlock, ruby_version = nil) ⇒ 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 (Array(Bundler::Source::Rubygems))
  • 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



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

def initialize(lockfile, dependencies, sources, unlock, ruby_version = nil)
  @unlocking = unlock == true || !unlock.empty?

  @dependencies, @sources, @unlock = dependencies, sources, unlock
  @remote            = false
  @specs             = nil
  @lockfile_contents = ""
  @ruby_version      = ruby_version

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

    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

Instance Attribute Details

#dependencies ⇒ Object (readonly)

Returns the value of attribute dependencies.



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

def dependencies
  @dependencies
end

#locked_deps ⇒ Object (readonly)

Returns the value of attribute locked_deps.



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

def locked_deps
  @locked_deps
end

#platforms ⇒ Object (readonly)

Returns the value of attribute platforms.



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

def platforms
  @platforms
end

#ruby_version ⇒ Object (readonly)

Returns the value of attribute ruby_version.



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

def ruby_version
  @ruby_version
end

#sources ⇒ Object (readonly)

Returns the value of attribute sources.



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

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:



18
19
20
21
22
23
24
25
26
27
 
# 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

Instance Method Details

#current_dependencies ⇒ Object 



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

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

#ensure_equivalent_gemfile_and_lockfile(explicit_flag = false) ⇒ Object

Raises:



306
307
308
309
310
311
312
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
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
 
# File 'lib/bundler/definition.rb', line 306

def ensure_equivalent_gemfile_and_lockfile(explicit_flag = false)
  changes = 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 = []

  if @locked_sources != @sources
    new_sources = @sources - @locked_sources
    deleted_sources = @locked_sources - @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

    changes = true
  end

  both_sources = Hash.new { |h,k| h[k] = ["no specified source", "no specified source"] }
  @dependencies.each { |d| both_sources[d.name][0] = d.source if d.source }
  @locked_deps.each  { |d| both_sources[d.name][1] = d.source if d.source }
  both_sources.delete_if { |k,v| v[0] == v[1] }

  if @dependencies != @locked_deps
    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.each do |name, sources|
      changed << "* #{name} from `#{sources[0]}` to `#{sources[1]}`"
    end

    changes = true
  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 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/bundler/definition.rb', line 97

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



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

def groups
  dependencies.map { |d| d.groups }.flatten.uniq
end

#index ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/bundler/definition.rb', line 208

def index
  @index ||= Index.build do |idx|
    dependency_names = @dependencies.dup || []
    dependency_names.map! {|d| d.name }

    @sources.each do |s|
      if s.is_a?(Bundler::Source::Rubygems)
        s.dependency_names = dependency_names.uniq
        idx.add_source s.specs
      else
        source_index = s.specs
        dependency_names += source_index.unmet_dependency_names
        idx.add_source source_index
      end
    end
  end
end

#lock(file) ⇒ Object 



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

def lock(file)
  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")

  return if @lockfile_contents == contents

  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

#missing_specs ⇒ Object 



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

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

#new_platform? ⇒ Boolean

Returns:

  • (Boolean) 


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

def new_platform?
  @new_platform
end

#new_specs ⇒ Object 



145
146
147
 
# File 'lib/bundler/definition.rb', line 145

def new_specs
  specs - @locked_specs
end

#removed_specs ⇒ Object 



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

def removed_specs
  @locked_specs - specs
end

#requested_specs ⇒ Object 



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

def requested_specs
  @requested_specs ||= begin
    groups = self.groups - Bundler.settings.without
    groups.map! { |g| g.to_sym }
    specs_for(groups)
  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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/bundler/definition.rb', line 186

def resolve
  @resolve ||= begin
    if Bundler.settings[:frozen] || (!@unlocking && nothing_changed?)
      @locked_specs
    else
      last_resolve = converge_locked_specs

      # 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

      # 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! ⇒ Object 



118
119
120
121
122
123
 
# File 'lib/bundler/definition.rb', line 118

def resolve_remotely!
  raise "Specs already loaded" if @specs
  @remote = true
  @sources.each { |s| s.remote! }
  specs
end

#resolve_with_cache! ⇒ Object 



112
113
114
115
116
 
# File 'lib/bundler/definition.rb', line 112

def resolve_with_cache!
  raise "Specs already loaded" if @specs
  @sources.each { |s| s.cached! }
  specs
end

#rubygems_index ⇒ Object

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



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

def rubygems_index
  @rubygems_index ||= Index.build do |idx|
    rubygems = @sources.find{|s| s.is_a?(Source::Rubygems) }
    idx.add_source rubygems.specs
  end
end

#rubygems_remotes ⇒ Object 



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

def rubygems_remotes
  @sources.select{|s| s.is_a?(Source::Rubygems) }.map{|s| s.remotes }.flatten
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:



131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/bundler/definition.rb', line 131

def specs
  @specs ||= begin
    specs = resolve.materialize(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 



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

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/bundler/definition.rb', line 265

def to_lock
  out = ""

  sorted_sources.each do |source|
    # Add the source header
    out << source.to_lock
    # Find all specs for this source
    resolve.
      select  { |s| s.source == source }.
      # 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

  out
end

#validate_ruby! ⇒ Object 



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/bundler/definition.rb', line 369

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