Class: FastlaneCore::Configuration
- Inherits:
-
Object
- Object
- FastlaneCore::Configuration
- Defined in:
- lib/fastlane_core/configuration/configuration.rb
Actually using the class collapse
-
#all_keys ⇒ Array
readonly
An array of symbols which are all available keys.
-
#values(ask: true) ⇒ Object
see fetch.
Instance Attribute Summary collapse
-
#available_options ⇒ Object
Returns the value of attribute available_options.
-
#config_file_name ⇒ String
The name of the configuration file (not the path).
Setting up the configuration collapse
-
#initialize(available_options, values) ⇒ Configuration
constructor
A new instance of Configuration.
-
#load_configuration_file(config_file_name = nil, block_for_missing = nil) ⇒ Object
This method takes care of parsing and using the configuration file as values Call this once you know where the config file might be located Take a look at how ‘gym` uses this method.
- #verify_conflicts ⇒ Object
-
#verify_default_value_matches_verify_block ⇒ Object
Verifies the default value is also valid.
- #verify_input_types ⇒ Object
- #verify_no_duplicates ⇒ Object
- #verify_value_exists ⇒ Object
Actually using the class collapse
-
#_values ⇒ Object
Direct access to the values, without iterating through all items.
-
#fetch(key, ask: true) ⇒ Object
(also: #[])
Returns the value for a certain key.
-
#option_for_key(key) ⇒ Object
Returns the config_item object for a given key.
-
#set(key, value) ⇒ Object
(also: #[]=)
Overwrites or sets a new value for a given key.
Class Method Summary collapse
Constructor Details
#initialize(available_options, values) ⇒ Configuration
Returns a new instance of Configuration.
38 39 40 41 42 43 44 45 46 47 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 38 def initialize(, values) self. = || [] self.values = values || {} verify_input_types verify_value_exists verify_no_duplicates verify_conflicts verify_default_value_matches_verify_block end |
Instance Attribute Details
#all_keys ⇒ Array (readonly)
Returns An array of symbols which are all available keys.
12 13 14 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 12 def all_keys @all_keys end |
#available_options ⇒ Object
Returns the value of attribute available_options.
7 8 9 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 7 def @available_options end |
#config_file_name ⇒ String
Returns The name of the configuration file (not the path). Optional!.
15 16 17 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 15 def config_file_name @config_file_name end |
#values(ask: true) ⇒ Object
see fetch
240 241 242 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 240 def values @values end |
Class Method Details
.create(available_options, values) ⇒ Object
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 17 def self.create(, values) UI.user_error!("values parameter must be a hash") unless values.kind_of?(Hash) v = values.dup v.each do |key, val| v[key] = val.dup if val.kind_of?(String) # this is necessary when fetching a value from an environment variable end if v.kind_of?(Hash) && .kind_of?(Array) # we only want to deal with the new configuration system # Now see if --verbose would be a valid input # If not, it might be because it's an action and not a tool unless .find { |a| a.kind_of?(ConfigItem) && a.key == :verbose } v.delete(:verbose) # as this is being processed by commander end end Configuration.new(, v) end |
Instance Method Details
#_values ⇒ Object
Direct access to the values, without iterating through all items
249 250 251 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 249 def _values @values end |
#fetch(key, ask: true) ⇒ Object Also known as: []
Returns the value for a certain key. fastlane_core tries to fetch the value from different sources if ‘ask’ is true and the value is not present, the user will be prompted to provide a value
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 168 def fetch(key, ask: true) UI.user_error!("Key '#{key}' must be a symbol. Example :app_id.") unless key.kind_of?(Symbol) option = option_for_key(key) UI.user_error!("Could not find option for key :#{key}. Available keys: #{@available_options.collect(&:key).join(', ')}") unless option value = @values[key] value = option.auto_convert_value(value) # `if value == nil` instead of ||= because false is also a valid value if value.nil? and option.env_name and ENV[option.env_name] # We want to inform the user that we took the value # from an environment variable # however we don't print the actual value, as it may contain sensitive information # The user can easily find the actual value by print out the environment UI.verbose("Taking value for '#{key}' from environment variable '#{option.env_name}'") value = option.auto_convert_value(ENV[option.env_name].dup) option.verify!(value) if value end value = option.default_value if value.nil? value = nil if value.nil? and !option.string? # by default boolean flags are false return value unless value.nil? # we already have a value return value if option.optional # as this value is not required, just return what we have return value unless ask # fallback to asking if Helper.is_test? or !UI.interactive? # Since we don't want to be asked on tests, we'll just call the verify block with no value # to raise the exception that is shown when the user passes an invalid value set(key, '') # If this didn't raise an exception, just raise a default one UI.user_error!("No value found for '#{key}'") end while value.nil? UI.important("To not be asked about this value, you can specify it using '#{option.key}'") value = option.sensitive ? UI.password("#{option.description}: ") : UI.input("#{option.description}: ") # Also store this value to use it from now on begin set(key, value) rescue => ex puts ex value = nil end end value end |
#load_configuration_file(config_file_name = nil, block_for_missing = nil) ⇒ Object
This method takes care of parsing and using the configuration file as values Call this once you know where the config file might be located Take a look at how ‘gym` uses this method
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 144 def load_configuration_file(config_file_name = nil, block_for_missing = nil) return unless config_file_name self.config_file_name = config_file_name paths = [] paths += Dir["./fastlane/#{self.config_file_name}"] paths += Dir["./.fastlane/#{self.config_file_name}"] paths += Dir["./#{self.config_file_name}"] paths += Dir["./spec/fixtures/#{self.config_file_name}"] if Helper.is_test? return if paths.count == 0 path = paths.first configuration_file = ConfigurationFile.new(self, path, block_for_missing) verify_conflicts # important, since user can set conflicting options in configuration file configuration_file end |
#option_for_key(key) ⇒ Object
Returns the config_item object for a given key
258 259 260 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 258 def option_for_key(key) @available_options.find { |o| o.key == key } end |
#set(key, value) ⇒ Object Also known as: []=
Overwrites or sets a new value for a given key
225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 225 def set(key, value) UI.user_error!("Key '#{key}' must be a symbol. Example :#{key}.") unless key.kind_of? Symbol option = option_for_key(key) unless option UI.user_error!("Could not find option '#{key}' in the list of available options: #{@available_options.collect(&:key).join(', ')}") end option.verify!(value) @values[key] = value true end |
#verify_conflicts ⇒ Object
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 85 def verify_conflicts option_keys = @values.keys option_keys.each do |current| index = @available_options.find_index { |item| item.key == current } current = @available_options[index] # ignore conflicts because option value is nil next if @values[current.key].nil? next if current..nil? conflicts = current. & option_keys next if conflicts.nil? conflicts.each do |conflicting_option_key| index = @available_options.find_index { |item| item.key == conflicting_option_key } conflicting_option = @available_options[index] # ignore conflicts because because value of conflict option is nil next if @values[conflicting_option.key].nil? if current.conflict_block begin current.conflict_block.call(conflicting_option) rescue => ex UI.error("Error resolving conflict between options: '#{current.key}' and '#{conflicting_option.key}'") raise ex end else UI.user_error!("Unresolved conflict between options: '#{current.key}' and '#{conflicting_option.key}'") end end end end |
#verify_default_value_matches_verify_block ⇒ Object
Verifies the default value is also valid
122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 122 def verify_default_value_matches_verify_block @available_options.each do |item| next unless item.verify_block && item.default_value begin unless @values[item.key] # this is important to not verify if there already is a value there item.verify_block.call(item.default_value) end rescue => ex UI.error(ex) UI.user_error!("Invalid default value for #{item.key}, doesn't match verify_block") end end end |
#verify_input_types ⇒ Object
49 50 51 52 53 54 55 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 49 def verify_input_types UI.user_error!("available_options parameter must be an array of ConfigItems but is #{@available_options.class}") unless @available_options.kind_of? Array @available_options.each do |item| UI.user_error!("available_options parameter must be an array of ConfigItems. Found #{item.class}.") unless item.kind_of? ConfigItem end UI.user_error!("values parameter must be a hash") unless @values.kind_of?(Hash) end |
#verify_no_duplicates ⇒ Object
72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 72 def verify_no_duplicates # Make sure a key was not used multiple times @available_options.each do |current| count = @available_options.count { |option| option.key == current.key } UI.user_error!("Multiple entries for configuration key '#{current.key}' found!") if count > 1 unless current.short_option.to_s.empty? count = @available_options.count { |option| option.short_option == current.short_option } UI.user_error!("Multiple entries for short_option '#{current.short_option}' found!") if count > 1 end end end |
#verify_value_exists ⇒ Object
57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/fastlane_core/configuration/configuration.rb', line 57 def verify_value_exists # Make sure the given value keys exist @values.each do |key, value| next if key == :trace # special treatment option = option_for_key(key) if option @values[key] = option.auto_convert_value(value) UI.deprecated("Using deprecated option: '--#{key}' (#{option.deprecated})") if option.deprecated option.verify!(@values[key]) # Call the verify block for it too else UI.user_error!("Could not find option '#{key}' in the list of available options: #{@available_options.collect(&:key).join(', ')}") end end end |