Class: Fastlane::ActionsList

Inherits:
Object
  • Object
show all
Defined in:
lib/fastlane/documentation/actions_list.rb

Class Method Summary collapse

Class Method Details

.action_subclass_error(name) ⇒ Object 



68
69
70
 
# File 'lib/fastlane/documentation/actions_list.rb', line 68

def self.action_subclass_error(name)
  "Please update your action '#{name}' to be a subclass of `Action` by adding ` < Action` after your class name."
end

.all_actions(platform = nil) ⇒ Object

Iterates through all available actions and yields from there



136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/fastlane/documentation/actions_list.rb', line 136

def self.all_actions(platform = nil)
  action_symbols = Fastlane::Actions.constants.select {|c| Fastlane::Actions.const_get(c).kind_of? Class }
  action_symbols.sort.each do |symbol|
    action = Fastlane::Actions.const_get(symbol)

    # We allow classes that don't respond to is_supported? to come through because we want to list
    # them as broken actions in the table, regardless of platform specification
    next if platform && action.respond_to?(:is_supported?) && !action.is_supported?(platform.to_sym)

    name = symbol.to_s.gsub('Action', '').fastlane_underscore
    yield action, name
  end
end

.find_action_named(name) ⇒ Object 



150
151
152
153
154
155
156
 
# File 'lib/fastlane/documentation/actions_list.rb', line 150

def self.find_action_named(name)
  all_actions do |action, action_name|
    return action if action_name == name
  end

  nil
end

.parse_options(options, fill_all = true) ⇒ Object

Helper:



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/fastlane/documentation/actions_list.rb', line 159

def self.parse_options(options, fill_all = true)
  rows = []
  rows << [options] if options.kind_of? String

  if options.kind_of? Array
    options.each do |current|
      if current.kind_of? FastlaneCore::ConfigItem
        key_name = (current.optional ? "  " : "* ") + current.key.to_s
        rows << [key_name.yellow, current.description, current.env_name, current.default_value]
      elsif current.kind_of? Array
        # Legacy actions that don't use the new config manager
        UI.user_error!("Invalid number of elements in this row: #{current}. Must be 2 or 3") unless [2, 3].include? current.count
        rows << current
        rows.last[0] = rows.last.first.yellow # color it yellow :)
        rows.last << nil while fill_all and rows.last.count < 3 # to have a nice border in the table
      end
    end
  end

  rows
end

.print_all(platform: nil) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/fastlane/documentation/actions_list.rb', line 12

def self.print_all(platform: nil)
  rows = []
  all_actions(platform) do |action, name|
    current = []
    current << name.yellow

    if action < Action
      current << action.description if action.description

      authors = Array(action.author || action.authors)
      current << authors.first.green if authors.count == 1
      current << "Multiple".green if authors.count > 1
    else
      UI.error action_subclass_error(name)
      current << "Please update action file".red
      current << ' '
    end
    rows << current
  end

  puts Terminal::Table.new(
    title: "Available fastlane actions".green,
    headings: ['Action', 'Description', 'Author'],
    rows: rows
  )
  puts "  Platform filter: #{platform}".magenta if platform
  puts "  Total of #{rows.count} actions"

  puts "\nGet more information for one specific action using `fastlane action [name]`\n".green
end

.print_options(action, name) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/fastlane/documentation/actions_list.rb', line 92

def self.print_options(action, name)
  options = parse_options(action.available_options) if action.available_options

  if options
    puts Terminal::Table.new(
      title: "#{name} Options".green,
      headings: ['Key', 'Description', 'Env Var', 'Default'],
      rows: options
    )
    required_count = action.available_options.count do |o|
      o.kind_of?(FastlaneCore::ConfigItem) && o.optional == false
    end

    if required_count > 0
      puts "#{required_count} of the available parameters are required".magenta
      puts "They are marked with an asterisk *".magenta
    end
  else
    puts "No available options".yellow
  end
  puts ""
end

.print_output_variables(action, name) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/fastlane/documentation/actions_list.rb', line 115

def self.print_output_variables(action, name)
  output = action.output
  return if output.nil? || output.empty?

  puts Terminal::Table.new(
    title: "#{name} Output Variables".green,
    headings: ['Key', 'Description'],
    rows: output.map { |key, desc| [key.yellow, desc] }
  )
  puts "Access the output values using `lane_context[SharedValues::VARIABLE_NAME]`"
  puts ""
end

.print_return_value(action, name) ⇒ Object 



128
129
130
131
132
133
 
# File 'lib/fastlane/documentation/actions_list.rb', line 128

def self.print_return_value(action, name)
  return unless action.return_value

  puts Terminal::Table.new(title: "#{name} Return Value".green, rows: [[action.return_value]])
  puts ""
end

.print_summary(action, name) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/fastlane/documentation/actions_list.rb', line 72

def self.print_summary(action, name)
  rows = []

  if action.description
    rows << [action.description]
    rows << [' ']
  end

  if action.details
    rows << [action.details]
    rows << [' ']
  end

  authors = Array(action.author || action.authors)
  rows << ["Created by #{authors.join(', ').green}"] unless authors.empty?

  puts Terminal::Table.new(title: name.green, rows: rows)
  puts ""
end

.run(filter: nil, platform: nil) ⇒ Object 



3
4
5
6
7
8
9
10
 
# File 'lib/fastlane/documentation/actions_list.rb', line 3

def self.run(filter: nil, platform: nil)
  require 'terminal-table'
  if filter
    show_details(filter: filter)
  else
    print_all(platform: platform)
  end
end

.show_details(filter: nil) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/fastlane/documentation/actions_list.rb', line 43

def self.show_details(filter: nil)
  puts "Loading documentation for #{filter}:".green
  puts ""

  action = find_action_named(filter)

  if action
    unless action < Action
      UI.user_error! action_subclass_error(filter)
    end

    print_summary(action, filter)
    print_options(action, filter)
    print_output_variables(action, filter)
    print_return_value(action, filter)

    puts "More information can be found on https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Actions.md"
    puts ""
  else
    puts "Couldn't find action for the given filter.".red
    puts "==========================================\n".red
    print_all # show all available actions instead
  end
end