Module: Bundler::SharedHelpers

Extended by:
SharedHelpers
Included in:
Runtime, SharedHelpers
Defined in:
lib/bundler/shared_helpers.rb

Instance Method Summary collapse

Instance Method Details

#bundle_bin_path ⇒ Object 



309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/bundler/shared_helpers.rb', line 309

def bundle_bin_path
  # bundler exe & lib folders have same root folder, typical gem installation
  exe_file = File.join(source_root, "exe/bundle")

  # for Ruby core repository testing
  exe_file = File.join(source_root, "libexec/bundle") unless File.exist?(exe_file)

  # bundler is a default gem, exe path is separate
  exe_file = Gem.bin_path("bundler", "bundle", VERSION) unless File.exist?(exe_file)

  exe_file
end

#chdir(dir, &blk) ⇒ Object 



52
53
54
55
56
 
# File 'lib/bundler/shared_helpers.rb', line 52

def chdir(dir, &blk)
  Bundler.rubygems.ext_lock.synchronize do
    Dir.chdir dir, &blk
  end
end

#checksum_for_file(path, digest) ⇒ Object 



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

def checksum_for_file(path, digest)
  return unless path.file?
  # This must use File.read instead of Digest.file().hexdigest
  # because we need to preserve \n line endings on windows when calculating
  # the checksum
  SharedHelpers.filesystem_access(path, :read) do
    File.open(path, "rb") do |f|
      digest = SharedHelpers.digest(digest).new
      buf = String.new(capacity: 16_384, encoding: Encoding::BINARY)
      digest << buf while f.read(16_384, buf)
      digest.hexdigest
    end
  end
end

#default_bundle_dir ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/bundler/shared_helpers.rb', line 36

def default_bundle_dir
  bundle_dir = find_directory(".bundle")
  return nil unless bundle_dir

  bundle_dir = Pathname.new(bundle_dir)

  global_bundle_dir = Bundler.user_home.join(".bundle")
  return nil if bundle_dir == global_bundle_dir

  bundle_dir
end

#default_gemfile ⇒ Object

Raises:



21
22
23
24
25
 
# File 'lib/bundler/shared_helpers.rb', line 21

def default_gemfile
  gemfile = find_gemfile
  raise GemfileNotFound, "Could not locate Gemfile" unless gemfile
  Pathname.new(gemfile).expand_path
end

#default_lockfile ⇒ Object 



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

def default_lockfile
  gemfile = default_gemfile

  case gemfile.basename.to_s
  when "gems.rb" then Pathname.new(gemfile.sub(/.rb$/, ".locked"))
  else Pathname.new("#{gemfile}.lock")
  end
end

#digest(name) ⇒ Object 



197
198
199
200
 
# File 'lib/bundler/shared_helpers.rb', line 197

def digest(name)
  require "digest"
  Digest(name)
end

#ensure_same_dependencies(spec, old_deps, new_deps) ⇒ Object

Raises:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/bundler/shared_helpers.rb', line 154

def ensure_same_dependencies(spec, old_deps, new_deps)
  new_deps = new_deps.reject {|d| d.type == :development }
  old_deps = old_deps.reject {|d| d.type == :development }

  without_type = proc {|d| Gem::Dependency.new(d.name, d.requirements_list.sort) }
  new_deps.map!(&without_type)
  old_deps.map!(&without_type)

  extra_deps = new_deps - old_deps
  return if extra_deps.empty?

  Bundler.ui.debug "#{spec.full_name} from #{spec.remote} has either corrupted API or lockfile dependencies" \
    " (was expecting #{old_deps.map(&:to_s)}, but the real spec has #{new_deps.map(&:to_s)})"
  raise APIResponseMismatchError,
    "Downloading #{spec.full_name} revealed dependencies not in the API or the lockfile (#{extra_deps.join(", ")})." \
    "\nRunning `bundle update #{spec.name}` should fix the problem."
end

#filesystem_access(path, action = :write) { ... } ⇒ Object

Rescues permissions errors raised by file system operations (ie. Errno:EACCESS, Errno::EAGAIN) and raises more friendly errors instead.

Examples:

filesystem_access("vendor/cache", :create) do
  FileUtils.mkdir_p("vendor/cache")
end

Parameters:

  • path (String) —

    the path that the action will be attempted to

  • action (Symbol, #to_s) (defaults to: :write) —

    the type of operation that will be performed. For example: :write, :read, :exec

Yields:

  • path

Raises:

See Also:

  • Bundler::SharedHelpers.{Bundler{Bundler::PermissionError}


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/bundler/shared_helpers.rb', line 104

def filesystem_access(path, action = :write, &block)
  yield(path.dup)
rescue Errno::EACCES => e
  raise unless e.message.include?(path.to_s) || action == :create

  raise PermissionError.new(path, action)
rescue Errno::EAGAIN
  raise TemporaryResourceError.new(path, action)
rescue Errno::EPROTO
  raise VirtualProtocolError.new
rescue Errno::ENOSPC
  raise NoSpaceOnDeviceError.new(path, action)
rescue Errno::ENOTSUP
  raise OperationNotSupportedError.new(path, action)
rescue Errno::EEXIST, Errno::ENOENT
  raise
rescue SystemCallError => e
  raise GenericSystemCallError.new(e, "There was an error #{[:create, :write].include?(action) ? "creating" : "accessing"} `#{path}`.")
end

#gemspec_path ⇒ Object 



323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/bundler/shared_helpers.rb', line 323

def gemspec_path
  # inside a gem repository, typical gem installation
  gemspec_file = File.join(source_root, "../../specifications/bundler-#{VERSION}.gemspec")

  # for Ruby core repository testing
  gemspec_file = File.expand_path("bundler.gemspec", __dir__) unless File.exist?(gemspec_file)

  # bundler is a default gem
  gemspec_file = File.join(Gem.default_specifications_dir, "bundler-#{VERSION}.gemspec") unless File.exist?(gemspec_file)

  gemspec_file
end

#in_bundle? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/bundler/shared_helpers.rb', line 48

def in_bundle?
  find_gemfile
end

#major_deprecation(major_version, message, removed_message: nil, print_caller_location: false) ⇒ Object 



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

def major_deprecation(major_version, message, removed_message: nil, print_caller_location: false)
  if print_caller_location
    caller_location = caller_locations(2, 2).first
    suffix = " (called at #{caller_location.path}:#{caller_location.lineno})"
    message += suffix
    removed_message += suffix if removed_message
  end

  bundler_major_version = Bundler.bundler_major_version
  if bundler_major_version > major_version
    require_relative "errors"
    raise DeprecatedError, "[REMOVED] #{removed_message || message}"
  end

  return unless bundler_major_version >= major_version && prints_major_deprecations?
  Bundler.ui.warn("[DEPRECATED] #{message}")
end

#md5_available? ⇒ Boolean

Returns:

  • (Boolean) 


184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/bundler/shared_helpers.rb', line 184

def md5_available?
  return @md5_available if defined?(@md5_available)
  @md5_available = begin
    require "openssl"
    ::OpenSSL::Digest.digest("MD5", "")
    true
  rescue LoadError
    true
  rescue ::OpenSSL::Digest::DigestError
    false
  end
end

#pretty_dependency(dep) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/bundler/shared_helpers.rb', line 172

def pretty_dependency(dep)
  msg = String.new(dep.name)
  msg << " (#{dep.requirement})" unless dep.requirement == Gem::Requirement.default

  if dep.is_a?(Bundler::Dependency)
    platform_string = dep.platforms.join(", ")
    msg << " " << platform_string if !platform_string.empty? && platform_string != Gem::Platform::RUBY
  end

  msg
end

#print_major_deprecations! ⇒ Object 



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

def print_major_deprecations!
  multiple_gemfiles = search_up(".") do |dir|
    gemfiles = gemfile_names.select {|gf| File.file? File.expand_path(gf, dir) }
    next if gemfiles.empty?
    break gemfiles.size != 1
  end
  return unless multiple_gemfiles
  message = "Multiple gemfiles (gems.rb and Gemfile) detected. " \
            "Make sure you remove Gemfile and Gemfile.lock since bundler is ignoring them in favor of gems.rb and gems.locked."
  Bundler.ui.warn message
end

#pwd ⇒ Object 



58
59
60
61
62
 
# File 'lib/bundler/shared_helpers.rb', line 58

def pwd
  Bundler.rubygems.ext_lock.synchronize do
    Pathname.pwd
  end
end

#relative_gemfile_path ⇒ Object 



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

def relative_gemfile_path
  relative_path_to(Bundler.default_gemfile)
end

#relative_lockfile_path ⇒ Object 



225
226
227
 
# File 'lib/bundler/shared_helpers.rb', line 225

def relative_lockfile_path
  relative_path_to(Bundler.default_lockfile)
end

#relative_path_to(destination, from: pwd) ⇒ Object 



229
230
231
232
233
234
 
# File 'lib/bundler/shared_helpers.rb', line 229

def relative_path_to(destination, from: pwd)
  Pathname.new(destination).relative_path_from(from).to_s
rescue ArgumentError
  # on Windows, if source and destination are on different drivers, there's no relative path from one to the other
  destination
end

#root ⇒ Object

Raises:



15
16
17
18
19
 
# File 'lib/bundler/shared_helpers.rb', line 15

def root
  gemfile = find_gemfile
  raise GemfileNotFound, "Could not locate Gemfile" unless gemfile
  Pathname.new(gemfile).expand_path.parent
end

#set_bundle_environment ⇒ Object 



77
78
79
80
81
82
 
# File 'lib/bundler/shared_helpers.rb', line 77

def set_bundle_environment
  set_bundle_variables
  set_path
  set_rubyopt
  set_rubylib
end

#set_env(key, value) ⇒ Object

Raises:

  • (ArgumentError) 


291
292
293
294
295
296
297
298
299
 
# File 'lib/bundler/shared_helpers.rb', line 291

def set_env(key, value)
  raise ArgumentError, "new key #{key}" unless EnvironmentPreserver::BUNDLER_KEYS.include?(key)
  orig_key = "#{EnvironmentPreserver::BUNDLER_PREFIX}#{key}"
  orig = ENV[key]
  orig ||= EnvironmentPreserver::INTENTIONALLY_NIL
  ENV[orig_key] ||= orig

  ENV[key] = value
end

#with_clean_git_env(&block) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/bundler/shared_helpers.rb', line 64

def with_clean_git_env(&block)
  keys    = %w[GIT_DIR GIT_WORK_TREE]
  old_env = keys.inject({}) do |h, k|
    h.update(k => ENV[k])
  end

  keys.each {|key| ENV.delete(key) }

  block.call
ensure
  keys.each {|key| ENV[key] = old_env[key] }
end

#write_to_gemfile(gemfile_path, contents) ⇒ Object 



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

def write_to_gemfile(gemfile_path, contents)
  filesystem_access(gemfile_path) {|g| File.open(g, "w") {|file| file.puts contents } }
end