Module: Kettle::Dev::BundlerEnvGuard

Defined in:
lib/kettle/dev/bundler_env_guard.rb

Constant Summary collapse

RESET_ENV_KEYS = 
%w[
  BUNDLE_BIN_PATH
  BUNDLE_FROZEN
  BUNDLE_GEMFILE
  BUNDLE_LOCKFILE
  BUNDLER_SETUP
  BUNDLER_VERSION
].freeze
INERT_ENV_KEYS = 
%w[
  BUNDLE_DEBUG
  BUNDLE_QUIET
  BUNDLE_SILENCE_DEPRECATIONS
  BUNDLE_SILENCE_ROOT_WARNING
  BUNDLE_SUPPRESS_INSTALL_USING_MESSAGES
  BUNDLE_VERBOSE
].freeze
INERT_ENV_PREFIXES = 
%w[
  BUNDLER_ORIG_
].freeze

Class Method Summary collapse

Class Method Details

.expected_env_key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
58
59
 
# File 'lib/kettle/dev/bundler_env_guard.rb', line 55

def expected_env_key?(key)
  RESET_ENV_KEYS.include?(key) ||
    INERT_ENV_KEYS.include?(key) ||
    INERT_ENV_PREFIXES.any? { |prefix| key.start_with?(prefix) }
end

.reset_warning_cache! ⇒ Object 



47
48
49
 
# File 'lib/kettle/dev/bundler_env_guard.rb', line 47

def reset_warning_cache!
  @warned_unexpected_env_keys = {}
end

.unbundled_env ⇒ Object 



30
31
32
33
34
 
# File 'lib/kettle/dev/bundler_env_guard.rb', line 30

def unbundled_env
  RESET_ENV_KEYS.each_with_object({}) do |key, env|
    env[key] = nil
  end
end

.unexpected_env_keys ⇒ Object 



51
52
53
 
# File 'lib/kettle/dev/bundler_env_guard.rb', line 51

def unexpected_env_keys
  ENV.to_hash.keys.grep(/\ABUNDLE(?:R)?_/).reject { |key| expected_env_key?(key) }.sort
end

.warn_unexpected_env!(stream: $stderr) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/kettle/dev/bundler_env_guard.rb', line 36

def warn_unexpected_env!(stream: $stderr)
  unexpected = unexpected_env_keys
  return if unexpected.empty?
  return if warned_unexpected_env?(unexpected)

  stream.puts(
    "[kettle-dev] Unexpected Bundler environment variable(s) present while preparing an unbundled subprocess: #{unexpected.join(", ")}. " \
      "If this variable is safe, add it to BundlerEnvGuard::INERT_ENV_KEYS; otherwise add it to RESET_ENV_KEYS."
  )
end

.warned_unexpected_env?(keys) ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
64
65
66
67
68
 
# File 'lib/kettle/dev/bundler_env_guard.rb', line 61

def warned_unexpected_env?(keys)
  @warned_unexpected_env_keys ||= {}
  signature = keys.join("\0")
  return true if @warned_unexpected_env_keys[signature]

  @warned_unexpected_env_keys[signature] = true
  false
end