Module: Bundler::SharedHelpers

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

Instance Method Summary collapse

Instance Method Details

#chdir(dir, &blk) ⇒ Object 



63
64
65
66
67
 
# File 'lib/bundler/shared_helpers.rb', line 63

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

#const_get_safely(constant_name, namespace) ⇒ Object 



135
136
137
138
139
140
 
# File 'lib/bundler/shared_helpers.rb', line 135

def const_get_safely(constant_name, namespace)
  const_in_namespace = namespace.constants.include?(constant_name.to_s) ||
    namespace.constants.include?(constant_name.to_sym)
  return nil unless const_in_namespace
  namespace.const_get(constant_name)
end

#default_bundle_dir ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/bundler/shared_helpers.rb', line 47

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:



32
33
34
35
36
 
# File 'lib/bundler/shared_helpers.rb', line 32

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

#default_lockfile ⇒ Object 



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

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.untaint
end

#digest(name) ⇒ Object 



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

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

#ensure_same_dependencies(spec, old_deps, new_deps) ⇒ Object

Raises:



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

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(", ")})." \
    "\nEither installing with `--full-index` or running `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", :write) 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}


115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/bundler/shared_helpers.rb', line 115

def filesystem_access(path, action = :write, &block)
  # Use block.call instead of yield because of a bug in Ruby 2.2.2
  # See https://github.com/bundler/bundler/issues/5341 for details
  block.call(path.dup.untaint)
rescue Errno::EACCES
  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 *[const_get_safely(:ENOTSUP, Errno)].compact
  raise OperationNotSupportedError.new(path, action)
rescue Errno::EEXIST, Errno::ENOENT
  raise
rescue SystemCallError => e
  raise GenericSystemCallError.new(e, "There was an error accessing `#{path}`.")
end

#in_bundle? ⇒ Boolean

Returns:

  • (Boolean) 


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

def in_bundle?
  find_gemfile
end

#major_deprecation(major_version, message) ⇒ Object 



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

def major_deprecation(major_version, message)
  if Bundler.bundler_major_version >= major_version
    require "bundler/errors"
    raise DeprecatedError, "[REMOVED FROM #{major_version}.0] #{message}"
  end

  return unless prints_major_deprecations?
  @major_deprecation_ui ||= Bundler::UI::Shell.new("no-color" => true)
  ui = Bundler.ui.is_a?(@major_deprecation_ui.class) ? Bundler.ui : @major_deprecation_ui
  ui.warn("[DEPRECATED FOR #{major_version}.0] #{message}")
end

#md5_available? ⇒ Boolean

Returns:

  • (Boolean) 


208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/bundler/shared_helpers.rb', line 208

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

#pretty_dependency(dep, print_source = false) ⇒ Object 



197
198
199
200
201
202
203
204
205
206
 
# File 'lib/bundler/shared_helpers.rb', line 197

def pretty_dependency(dep, print_source = false)
  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 << " from the `#{dep.source}` source" if print_source && dep.source
  msg
end

#print_major_deprecations! ⇒ Object 



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 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 false if gemfiles.size == 1
  end
  if multiple_gemfiles && Bundler.bundler_major_version == 1
    Bundler::SharedHelpers.major_deprecation 2, \
      "gems.rb and gems.locked will be preferred to Gemfile and Gemfile.lock."
  end

  if RUBY_VERSION < "2"
    major_deprecation(2, "Bundler will only support ruby >= 2.0, you are running #{RUBY_VERSION}")
  end
  return if Bundler.rubygems.provides?(">= 2")
  major_deprecation(2, "Bundler will only support rubygems >= 2.0, you are running #{Bundler.rubygems.version}")
end

#pwd ⇒ Object 



69
70
71
72
73
 
# File 'lib/bundler/shared_helpers.rb', line 69

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

#root ⇒ Object

Raises:



26
27
28
29
30
 
# File 'lib/bundler/shared_helpers.rb', line 26

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

#set_bundle_environment ⇒ Object 



88
89
90
91
92
93
 
# File 'lib/bundler/shared_helpers.rb', line 88

def set_bundle_environment
  set_bundle_variables
  set_path
  set_rubyopt
  set_rubylib
end

#set_env(key, value) ⇒ Object

Raises:

  • (ArgumentError) 


283
284
285
286
287
288
289
290
291
 
# File 'lib/bundler/shared_helpers.rb', line 283

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

#trap(signal, override = false, &block) ⇒ Object 



172
173
174
175
176
177
 
# File 'lib/bundler/shared_helpers.rb', line 172

def trap(signal, override = false, &block)
  prior = Signal.trap(signal) do
    block.call
    prior.call unless override
  end
end

#with_clean_git_env(&block) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/bundler/shared_helpers.rb', line 75

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