Class: Bundler::Settings
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Inherits: | Object |
Defined in: | lib/bundler/mirror.rb, lib/bundler/settings.rb, lib/bundler/settings/validator.rb |
Constant Summary
-
ARRAY_KEYS =
# File 'lib/bundler/settings.rb', line 72%w[ with without ].freeze
-
BOOL_KEYS =
# File 'lib/bundler/settings.rb', line 11%w[ allow_bundler_dependency_conflicts allow_deployment_source_credential_changes allow_offline_install auto_clean_without_path auto_install auto_config_jobs cache_all cache_all_platforms cache_command_is_package console_command default_install_uses_path deployment deployment_means_frozen disable_checksum_validation disable_exec_load disable_local_branch_check disable_multisource disable_platform_warnings disable_shared_gems disable_version_check error_on_stderr force_ruby_platform forget_cli_options frozen gem.coc gem.mit global_path_appends_ruby_scope global_gem_cache ignore_messages init_gems_rb list_command lockfile_uses_separate_rubygems_sources major_deprecations no_install no_prune only_update_to_newer_versions path_relative_to_cwd path.system plugins prefer_gems_rb print_only_version_number setup_makes_kernel_gem_public silence_root_warning skip_default_git_sources specific_platform suppress_install_using_messages unlock_source_unlocks_spec update_requires_all_flag use_gem_version_promoter_for_major_updates viz_command ].freeze
-
CONFIG_REGEX =
# File 'lib/bundler/settings.rb', line 409%r{ # rubocop:disable Style/RegexpLiteral ^ (BUNDLE_.+):\s # the key (?: !\s)? # optional exclamation mark found with ruby 1.9.3 (['"]?) # optional opening quote (.* # contents of the value (?: # optionally, up until the next key (\n(?!BUNDLE).+)* ) ) \2 # matching closing quote $ }xo
-
DEFAULT_CONFIG =
# File 'lib/bundler/settings.rb', line 77{ :disable_version_check => true, :redirect => 5, :retry => 3, :timeout => 10, }.freeze
-
NORMALIZE_URI_OPTIONS_PATTERN =
# File 'lib/bundler/settings.rb', line 437/ \A (\w+\.)? # optional prefix key (https?.*?) # URI (\.#{Regexp.union(PER_URI_OPTIONS)})? # optional suffix key \z /ix
-
NUMBER_KEYS =
# File 'lib/bundler/settings.rb', line 64%w[ jobs redirect retry ssl_verify_mode timeout ].freeze
-
PER_URI_OPTIONS =
# File 'lib/bundler/settings.rb', line 433%w[ fallback_timeout ].freeze
Class Method Summary
- .new(root = nil) ⇒ Settings constructor
-
.normalize_uri(uri)
private
TODO: duplicates
Rubygems#normalize_uri
TODO: is this the correct place to validate mirror URIs?
Instance Attribute Summary
- #allow_sudo? ⇒ Boolean readonly
- #ignore_config? ⇒ Boolean readonly
Instance Method Summary
- #[](name)
- #all
- #app_cache_path
- #credentials_for(uri)
- #gem_mirrors
- #key_for(key)
- #local_overrides
- #locations(key)
- #mirror_for(uri)
-
#path
for legacy reasons, in
::Bundler
1, the ruby scope isnt appended when the setting comes from ENV or the global config, nor do we respect:disable_shared_gems
. - #pretty_values_for(exposed_key)
- #set_command_option(key, value)
- #set_command_option_if_given(key, value)
- #set_global(key, value)
- #set_local(key, value)
- #temporary(update)
- #validate!
- #array_to_s(array) private
- #converted_value(value, key) private
- #global_config_file private
- #is_array(key) private
- #is_bool(name) private
- #is_num(key) private
- #load_config(config_file) private
- #local_config_file private
- #parent_setting_for(name) private
- #set_key(raw_key, value, hash, file) private
- #specific_gem_for(name) private
- #split_specific_setting_for(name) private
- #to_array(value) private
- #to_bool(value) private
Constructor Details
.new(root = nil) ⇒ Settings
# File 'lib/bundler/settings.rb', line 84
def initialize(root = nil) @root = root @local_config = load_config(local_config_file) @global_config = load_config(global_config_file) @temporary = {} end
Class Method Details
.normalize_uri(uri) (private)
TODO: duplicates Rubygems#normalize_uri
TODO: is this the correct place to validate mirror URIs?
# File 'lib/bundler/settings.rb', line 448
def self.normalize_uri(uri) uri = uri.to_s if uri =~ NORMALIZE_URI_OPTIONS_PATTERN prefix = $1 uri = $2 suffix = $3 end uri = "#{uri}/" unless uri.end_with?("/") uri = URI(uri) unless uri.absolute? raise ArgumentError, format("Gem sources must be absolute. You provided '%s'.", uri) end "#{prefix}#{uri}#{suffix}" end
Instance Attribute Details
#allow_sudo? ⇒ Boolean
(readonly)
[ GitHub ]
#ignore_config? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/settings.rb', line 289
def ignore_config? ENV["BUNDLE_IGNORE_CONFIG"] end
Instance Method Details
#[](name)
[ GitHub ]# File 'lib/bundler/settings.rb', line 91
def [](name) key = key_for(name) value = @temporary.fetch(key) do @local_config.fetch(key) do ENV.fetch(key) do @global_config.fetch(key) do DEFAULT_CONFIG.fetch(name) do nil end end end end end converted_value(value, name) end
#all
[ GitHub ]# File 'lib/bundler/settings.rb', line 153
def all env_keys = ENV.keys.grep(/\ABUNDLE_.+/) keys = @temporary.keys | @global_config.keys | @local_config.keys | env_keys keys.map do |key| key.sub(/^BUNDLE_/, "").gsub(/__/, ".").downcase end end
#app_cache_path
[ GitHub ]# File 'lib/bundler/settings.rb', line 293
def app_cache_path @app_cache_path ||= self[:cache_path] || "vendor/cache" end
#array_to_s(array) (private)
[ GitHub ]# File 'lib/bundler/settings.rb', line 352
def array_to_s(array) array = Array(array) return nil if array.empty? array.join(":").tr(" ", ":") end
#converted_value(value, key) (private)
[ GitHub ]#credentials_for(uri)
[ GitHub ]# File 'lib/bundler/settings.rb', line 176
def credentials_for(uri) self[uri.to_s] || self[uri.host] end
#gem_mirrors
[ GitHub ]#global_config_file (private)
[ GitHub ]# File 'lib/bundler/settings.rb', line 393
def global_config_file if ENV["BUNDLE_CONFIG"] && !ENV["BUNDLE_CONFIG"].empty? Pathname.new(ENV["BUNDLE_CONFIG"]) else begin Bundler.user_bundle_path("config") rescue PermissionError, GenericSystemCallError nil end end end
#is_array(key) (private)
[ GitHub ]# File 'lib/bundler/settings.rb', line 343
def is_array(key) ARRAY_KEYS.include?(key.to_s) end
#is_bool(name) (private)
[ GitHub ]# File 'lib/bundler/settings.rb', line 326
def is_bool(name) BOOL_KEYS.include?(name.to_s) || BOOL_KEYS.include?(parent_setting_for(name.to_s)) end
#is_num(key) (private)
[ GitHub ]# File 'lib/bundler/settings.rb', line 339
def is_num(key) NUMBER_KEYS.include?(key.to_s) end
#key_for(key)
[ GitHub ]# File 'lib/bundler/settings.rb', line 306
def key_for(key) key = Settings.normalize_uri(key).to_s if key.is_a?(String) && /https?:/ =~ key key = key.to_s.gsub(".", "__").upcase "BUNDLE_#{key}" end
#load_config(config_file) (private)
[ GitHub ]# File 'lib/bundler/settings.rb', line 423
def load_config(config_file) return {} if !config_file || ignore_config? SharedHelpers.filesystem_access(config_file, :read) do |file| valid_file = file.exist? && !file.size.zero? return {} unless valid_file require "bundler/yaml_serializer" YAMLSerializer.load file.read end end
#local_config_file (private)
[ GitHub ]# File 'lib/bundler/settings.rb', line 405
def local_config_file Pathname.new(@root).join("config") if @root end
#local_overrides
[ GitHub ]# File 'lib/bundler/settings.rb', line 163
def local_overrides repos = {} all.each do |k| repos[$'] = self[k] if k =~ /^local\./ end repos end
#locations(key)
[ GitHub ]# File 'lib/bundler/settings.rb', line 187
def locations(key) key = key_for(key) locations = {} locations[:temporary] = @temporary[key] if @temporary.key?(key) locations[:local] = @local_config[key] if @local_config.key?(key) locations[:env] = ENV[key] if ENV[key] locations[:global] = @global_config[key] if @global_config.key?(key) locations[:default] = DEFAULT_CONFIG[key] if DEFAULT_CONFIG.key?(key) locations end
#mirror_for(uri)
[ GitHub ]# File 'lib/bundler/settings.rb', line 171
def mirror_for(uri) uri = URI(uri.to_s) unless uri.is_a?(URI) gem_mirrors.for(uri.to_s).uri end
#parent_setting_for(name) (private)
[ GitHub ]# File 'lib/bundler/settings.rb', line 314
def parent_setting_for(name) split_specific_setting_for(name)[0] end
#path
for legacy reasons, in ::Bundler
1, the ruby scope isnt appended when the setting comes from ENV or the global config, nor do we respect :disable_shared_gems
# File 'lib/bundler/settings.rb', line 225
def path key = key_for(:path) path = ENV[key] || @global_config[key] if path && !@temporary.key?(key) && !@local_config.key?(key) return Path.new(path, Bundler.feature_flag.global_path_appends_ruby_scope?, false, false) end system_path = self["path.system"] || (self[:disable_shared_gems] == false) Path.new(self[:path], true, system_path, Bundler.feature_flag.default_install_uses_path?) end
#pretty_values_for(exposed_key)
[ GitHub ]# File 'lib/bundler/settings.rb', line 198
def pretty_values_for(exposed_key) key = key_for(exposed_key) locations = [] if @temporary.key?(key) locations << "Set for the current command: #{converted_value(@temporary[key], exposed_key).inspect}" end if @local_config.key?(key) locations << "Set for your local app (#{local_config_file}): #{converted_value(@local_config[key], exposed_key).inspect}" end if value = ENV[key] locations << "Set via #{key}: #{converted_value(value, exposed_key).inspect}" end if @global_config.key?(key) locations << "Set for the current user (#{global_config_file}): #{converted_value(@global_config[key], exposed_key).inspect}" end return ["You have not configured a value for `#{exposed_key}`"] if locations.empty? locations end
#set_command_option(key, value)
[ GitHub ]# File 'lib/bundler/settings.rb', line 104
def set_command_option(key, value) if Bundler.feature_flag. temporary(key => value) value else command = if value.nil? "bundle config --delete #{key}" else "bundle config #{key} #{Array(value).join(":")}" end Bundler::SharedHelpers.major_deprecation 2,\ "flags passed to commands " \ "will no longer be automatically remembered. Instead please set flags " \ "you want remembered between commands using `bundle config " \ "<setting name> <setting value>`, i.e. `#{command}`" set_local(key, value) end end
#set_command_option_if_given(key, value)
[ GitHub ]# File 'lib/bundler/settings.rb', line 125
def set_command_option_if_given(key, value) return if value.nil? set_command_option(key, value) end
#set_global(key, value)
[ GitHub ]# File 'lib/bundler/settings.rb', line 149
def set_global(key, value) set_key(key, value, @global_config, global_config_file) end
#set_key(raw_key, value, hash, file) (private)
[ GitHub ]# File 'lib/bundler/settings.rb', line 358
def set_key(raw_key, value, hash, file) raw_key = raw_key.to_s value = array_to_s(value) if is_array(raw_key) key = key_for(raw_key) return if hash[key] == value hash[key] = value hash.delete(key) if value.nil? Validator.validate!(raw_key, converted_value(value, raw_key), hash) return unless file SharedHelpers.filesystem_access(file) do |p| FileUtils.mkdir_p(p.dirname) require "bundler/yaml_serializer" p.open("w") {|f| f.write(YAMLSerializer.dump(hash)) } end end
#set_local(key, value)
[ GitHub ]# File 'lib/bundler/settings.rb', line 130
def set_local(key, value) local_config_file || raise(GemfileNotFound, "Could not locate Gemfile") set_key(key, value, @local_config, local_config_file) end
#specific_gem_for(name) (private)
[ GitHub ]# File 'lib/bundler/settings.rb', line 318
def specific_gem_for(name) split_specific_setting_for(name)[1] end
#split_specific_setting_for(name) (private)
[ GitHub ]# File 'lib/bundler/settings.rb', line 322
def split_specific_setting_for(name) name.split(".") end
#temporary(update)
[ GitHub ]#to_array(value) (private)
[ GitHub ]# File 'lib/bundler/settings.rb', line 347
def to_array(value) return [] unless value value.split(":").map(&:to_sym) end
#to_bool(value) (private)
[ GitHub ]# File 'lib/bundler/settings.rb', line 330
def to_bool(value) case value when nil, /\A(false|f|no|n|0|)\z/i, false false else true end end