Class: Fastlane::Actions::RomeAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/rome/actions/rome_action.rb

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



145
146
147
 
# File 'lib/fastlane/plugin/rome/actions/rome_action.rb', line 145

def self.authors
  ["François Benaiteau", "Tommaso Piazza"]
end

.available_commands ⇒ Object 



129
130
131
 
# File 'lib/fastlane/plugin/rome/actions/rome_action.rb', line 129

def self.available_commands
  %w(list download upload version help)
end

.available_options ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/fastlane/plugin/rome/actions/rome_action.rb', line 153

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :binary_path,
                                 env_name: "FL_ROME_BINARY_PATH",
                                 description: "Rome binary path, set to `Pods/Rome/rome` if you install Rome via CocoaPods",
                                 optional: true,
                                 default_value: `which rome`),

    FastlaneCore::ConfigItem.new(key: :command,
                                 env_name: "FL_ROME_COMMAND",
                                 description: "Rome command (one of: #{available_commands.join(', ')})",
                                 default_value: "help",
                                 verify_block: proc do |value|
                                   UI.user_error!("Please pass a valid command. Use one of the following: #{available_commands.join(', ')}") unless available_commands.include? value
                                 end),

    FastlaneCore::ConfigItem.new(key: :verbose,
                                 env_name: "FL_ROME_VERBOSE",
                                 description: "Print xcodebuild output inline",
                                 is_string: false,
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error!("Please pass a valid value for verbose. Use one of the following: true, false") unless value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
                                 end),

    FastlaneCore::ConfigItem.new(key: :noignore,
                                 env_name: "FL_ROME_NOIGNORE",
                                 description: "Ignore the `ignoreMap` section of a Romefile",
                                 is_string: false,
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error!("Please pass a valid value for noignore. Use one of the following: true, false") unless value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
                                 end),

    FastlaneCore::ConfigItem.new(key: :platform,
                                 env_name: "FL_ROME_PLATFORM",
                                 description: "Define which platform to build for",
                                 optional: true,
                                 verify_block: proc do |value|
                                   value.split(',').each do |platform|
                                     UI.user_error!("Please pass a valid platform. Use one of the following: #{available_platforms.join(', ')}") unless available_platforms.map(&:downcase).include?(platform.downcase)
                                   end
                                 end),

    FastlaneCore::ConfigItem.new(key: :missing,
                                 env_name: "FL_ROME_MISSING",
                                 description: "Option to list only missing frameworks",
                                 optional: true,
                                 is_string: false,
                                 verify_block: proc do |value|
                                   UI.user_error!("Please pass a valid value for missing. Use one of the following: true, false") unless value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
                                 end),

    FastlaneCore::ConfigItem.new(key: :present,
                                 env_name: "FL_ROME_PRESENT",
                                 description: "Option to list only present frameworks",
                                 optional: true,
                                 is_string: false,
                                 verify_block: proc do |value|
                                   UI.user_error!("Please pass a valid value for present. Use one of the following: true, false") unless value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
                                 end),

    FastlaneCore::ConfigItem.new(key: :frameworks,
                                 description: "Framework name or names to upload/download, could be applied only along with the 'upload' or 'download' commands",
                                 default_value: [],
                                 is_string: false,
                                 type: Array),

    FastlaneCore::ConfigItem.new(key: :cacheprefix,
                                 env_name: "FL_ROME_CACHE_PREFIX",
                                 description: "Allow a prefix for top level directories to be specified for all commands. Useful to store frameworks built with different Swift versions",
                                 optional: true,
                                 is_string: true),

    FastlaneCore::ConfigItem.new(key: :printformat,
                                 env_name: "FL_ROME_PRINT_FORMAT",
                                 description: "Specify what format to use in the output of the list command. One of 'JSON' or 'Text'. Defaults to 'Text' if omitted",
                                 optional: true,
                                 is_string: true),

    FastlaneCore::ConfigItem.new(key: :romefile,
                                 env_name: "FL_ROME_ROMEFILE",
                                 description: "The path to the Romefile to use. Defaults to the \"Romefile\" in the current directory",
                                 optional: true,
                                 is_string: true),

    FastlaneCore::ConfigItem.new(key: :noskipcurrent,
                                 env_name: "FL_ROME_NOSKIPCURRENT",
                                 description: "Use the `currentMap` section when performing the operation",
                                 is_string: false,
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error!("Please pass a valid value for noskipcurrent. Use one of the following: true, false") unless value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
                                 end),

    FastlaneCore::ConfigItem.new(key: :concurrently,
                                 env_name: "FL_ROME_CONCURRENTLY",
                                 description: "Maximize concurrency while performing the operation. Not needed for listing",
                                 is_string: false,
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error!("Please pass a valid value for concurrently. Use one of the following: true, false") unless value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
                                 end),

    FastlaneCore::ConfigItem.new(key: :usexcframeworks,
                                 env_name: "FL_ROME_USEXCFRAMEWORKS",
                                 description: "Search for .xcframeworks when performing the operation. Not needed for listing",
                                 is_string: false,
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error!("Please pass a valid value for concurrently. Use one of the following: true, false") unless value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
                                 end)
  ]
end

.available_platforms ⇒ Object 



133
134
135
 
# File 'lib/fastlane/plugin/rome/actions/rome_action.rb', line 133

def self.available_platforms
  %w(all iOS Mac tvOS watchOS)
end

.available_print_formats ⇒ Object 



137
138
139
 
# File 'lib/fastlane/plugin/rome/actions/rome_action.rb', line 137

def self.available_print_formats
  %w(JSON Text)
end

.description ⇒ Object 



141
142
143
 
# File 'lib/fastlane/plugin/rome/actions/rome_action.rb', line 141

def self.description
  "An S3 cache tool for Carthage"
end

.details ⇒ Object 



149
150
151
 
# File 'lib/fastlane/plugin/rome/actions/rome_action.rb', line 149

def self.details
  "Rome is a tool that allows developers on Apple platforms to use Amazon's S3  and/or others as a shared cache for frameworks built with Carthage."
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


268
269
270
271
272
273
 
# File 'lib/fastlane/plugin/rome/actions/rome_action.rb', line 268

def self.is_supported?(platform)
  # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
  # See: https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Platforms.md
  #
  %i(ios mac).include?(platform)
end

.meet_minimum_version(binary_path, minimum_version) ⇒ Object 



38
39
40
41
42
43
 
# File 'lib/fastlane/plugin/rome/actions/rome_action.rb', line 38

def self.meet_minimum_version(binary_path, minimum_version)
  version = Actions.sh("#{binary_path} --version") # i.e. 0.12.0.31 - Romam uno die non fuisse conditam.
  version_number = version.split(' - ')[0]

  return version_is_greater_or_equal(version_number, minimum_version)
end

.run(params) ⇒ Object 



4
5
6
7
8
9
10
11
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
 
# File 'lib/fastlane/plugin/rome/actions/rome_action.rb', line 4

def self.run(params)
  validate(params)

  cmd = [params[:binary_path].chomp]
  command_name = params[:command]

  if command_name == "version"
    cmd << "--version"
  elsif command_name == "help"
    cmd << "--help"
  else
    cmd << command_name
  end

  if (command_name == "upload" || command_name == "download") && params[:frameworks].count > 0
    cmd.concat params[:frameworks]
  elsif command_name == "list"
    cmd << "--missing" if params[:missing] == true
    cmd << "--present" if params[:present] == true
  end

  cmd << "--platform #{params[:platform]}" if params[:platform]
  cmd << "--cache-prefix #{params[:cacheprefix]}" if params[:cacheprefix]
  cmd << "--print-format #{params[:printformat]}" if params[:printformat]
  cmd << "--romefile #{params[:romefile]}" if params[:romefile]
  cmd << "--no-ignore" if params[:noignore] == true
  cmd << "--no-skip-current" if params[:noskipcurrent] == true
  cmd << "--concurrently" if params[:concurrently] == true
  cmd << "--use-xcframeworks" if params[:usexcframeworks] == true
  cmd << "-v " if params[:verbose]

  return Actions.sh(cmd.join(' '))
end

.validate(params) ⇒ Object 



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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/fastlane/plugin/rome/actions/rome_action.rb', line 64

def self.validate(params)
  binary_path = params[:binary_path].chomp
  unless binary_path.include?('rome')
    UI.important("Install Rome for the plugin to work")
    UI.important("")
    UI.error("Or install it using CocoaPods:")
    UI.error("Add `pod 'Rome'` to your Podfile, and set `binary_path` option to `Pods/Rome/rome`")
    UI.error("")
    UI.error("Install it using Homebrew:")
    UI.command("brew install blender/homebrew-tap/rome")
    UI.error("")
    UI.error("If you don't have homebrew, visit http://brew.sh")

    UI.user_error!("Install Rome and start your lane again!")
  end

  command_name = params[:command]
  if !(command_name == "upload" || command_name == "download") && (params[:frameworks] || []).count > 0
    UI.user_error!("Frameworks option is available only for 'upload'' or 'download' commands.")
  end

  if command_name != "list" && (params[:missing] || params [:present])
    UI.user_error!("Missing/Present option is available only for 'list' command.")
  end

  if command_name == "list" && !(params[:printformat] == nil || params[:printformat] == "JSON" || params[:printformat] == "Text")
    UI.user_error!("Unsupported print format. Supported print formats are 'JSON' and 'Text'.")
    UI.user_error!("'printformat' option requires Rome version '0.13.0.33' or later") if !meet_minimum_version(binary_path, "0.13.0.33")
  end

  noignore = params[:noignore]
  if noignore != nil
    UI.user_error!("'noignore' option requires Rome version '0.13.1.35' or later") if !meet_minimum_version(binary_path, "0.13.1.35")
  end

  cacheprefix = params[:cacheprefix]
  if cacheprefix != nil
    UI.user_error!("'cacheprefix' option requires Rome version '0.12.0.31' or later") if !meet_minimum_version(binary_path, "0.12.0.31")
  end

  noskipcurrent = params[:noskipcurrent]
  if noskipcurrent != nil
    UI.user_error!("'noskipcurrent' option requires Rome version '0.18.0.51' or later") if !meet_minimum_version(binary_path, "0.18.0.51")
  end

  concurrently = params[:concurrently]
  if concurrently != nil
    UI.user_error!("'concurrently' option requires Rome version '0.20.0.56' or later") if !meet_minimum_version(binary_path, "0.20.0.56")
  end

  usexcframeworks = params[:usexcframeworks]
  if usexcframeworks != nil
    UI.user_error!("'usexcframeworks' option requires Rome version '0.24.0.65' or later") if !meet_minimum_version(binary_path, "0.24.0.65")
  end

  platform = params[:platform]
  if usexcframeworks != nil && platform != nil
    UI.user_error!("'usexcframeworks' option cannot be combined with 'platform' option. Only one of them can be provided.")
  end

  if command_name == "list" && concurrently != nil
    UI.user_error!("Concurrently option is only avalable with download or upload. Listing is performed concurrently by default.")
  end
end

.version_is_greater_or_equal(lhs_version, rhs_version) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/fastlane/plugin/rome/actions/rome_action.rb', line 45

def self.version_is_greater_or_equal(lhs_version, rhs_version)

  lhs_parts = lhs_version.split('.')
  rhs_parts = rhs_version.split('.')

  for i in 0..lhs_parts.length do
    part = lhs_parts[i] || "0"
    min_part = rhs_parts[i] || "0"
    
    if part.to_i > min_part.to_i
      return true
    elsif part.to_i == min_part.to_i
    else part.to_i < min_part.to_i
      return false
    end
  end
  return true
end