Class: FastlaneCore::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/fastlane_core/configuration.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(available_options, values) ⇒ Configuration

Returns a new instance of Configuration.



16
17
18
19
20
21
22
23
 
# File 'lib/fastlane_core/configuration.rb', line 16

def initialize(available_options, values)
  @available_options = available_options || []
  @values = values || {}

  verify_input_types      
  verify_value_exists
  verify_no_duplicates
end

Class Method Details

.create(available_options, values) ⇒ Object 



6
7
8
 
# File 'lib/fastlane_core/configuration.rb', line 6

def self.create(available_options, values)
  Configuration.new(available_options, values)
end

Instance Method Details

#fetch(key) ⇒ Object Also known as: []

Returns the value for a certain key. fastlane_core tries to fetch the value from different sources



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/fastlane_core/configuration.rb', line 61

def fetch(key)
  raise "Key '#{key}' must be a symbol. Example :app_id.".red unless key.kind_of?Symbol

  option = option_for_key(key)
  raise "Could not find option for key :#{key}. Available keys: #{@available_options.collect { |a| a.key }.join(', ')}".red unless option

  # `if value == nil` instead of ||= because false is also a valid value

  value = @values[key]
  # TODO: configuration files

  if value == nil
    value = ENV[option.env_name]
    option.verify!(value) if value
  end

  value = option.default_value if value == nil
  value = nil if (value == nil and not option.is_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
  

  if Helper.is_test?
    # 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
    raise "No value found for '#{key}'"
  end

  while value == nil
    Helper.log.info "To not be asked about this value, you can specify it using '#{option.key}'".yellow
    value = ask("#{option.description}: ")
    # Also store this value to use it from now on
    begin
      set(key, value)
    rescue Exception => ex
      puts ex
      value = nil
    end
  end

  value
end

#option_for_key(key) ⇒ Object

Returns the config_item object for a given key



123
124
125
 
# File 'lib/fastlane_core/configuration.rb', line 123

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



108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/fastlane_core/configuration.rb', line 108

def set(key, value)
  raise "Key '#{key}' must be a symbol. Example :#{key}.".red unless key.kind_of?Symbol
  option = option_for_key(key)
  
  unless option
    raise "Could not find available option '#{key}' in the list of available options #{@available_options.collect { |a| a.key }.join(', ')}".red
  end

  option.verify!(value)

  @values[key] = value
  true
end

#values ⇒ Object

Setting up



12
13
14
 
# File 'lib/fastlane_core/configuration.rb', line 12

def values
  @values
end

#verify_input_types ⇒ Object 



25
26
27
28
29
30
31
 
# File 'lib/fastlane_core/configuration.rb', line 25

def verify_input_types
  raise "available_options parameter must be an array of ConfigItems but is #{@available_options.class}".red unless @available_options.kind_of?Array
  @available_options.each do |item|
    raise "available_options parameter must be an array of ConfigItems. Found #{item.class}.".red unless item.kind_of?ConfigItem
  end
  raise "values parameter must be a hash".red unless @values.kind_of?Hash
end

#verify_no_duplicates ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/fastlane_core/configuration.rb', line 45

def verify_no_duplicates
  # Make sure a key was not used multiple times
  @available_options.each do |current|
    count = @available_options.select { |option| option.key == current.key }.count
    raise "Multiple entries for configuration key '#{current.key}' found!".red if count > 1

    unless current.short_option.to_s.empty?
      count = @available_options.select { |option| option.short_option == current.short_option }.count
      raise "Multiple entries for short_option '#{current.short_option}' found!".red if count > 1
    end
  end
end

#verify_value_exists ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/fastlane_core/configuration.rb', line 33

def verify_value_exists
  # Make sure the given value keys exist
  @values.each do |key, value|
    option = option_for_key(key)
    if option
      option.verify!(value) # Call the verify block for it too
    else
      raise "Could not find available option '#{key}' in the list of available options: #{@available_options.collect { |a| a.key }.join(', ')}".red
    end
  end
end