Class: BranchIOCLI::Configuration::SetupConfiguration
Constant Summary
collapse
- APP_LINK_REGEXP =
/\.app\.link$|\.test-app\.link$/
- SDK_OPTIONS =
{
"Specify the location of a Podfile or Cartfile" => :specify,
"Set this project up to use CocoaPods and add the Branch SDK." => :cocoapods,
"Set this project up to use Carthage and add the Branch SDK." => :carthage,
"Add Branch.framework directly to the project's dependencies." => :direct,
"Skip adding the framework to the project." => :skip
}
Instance Attribute Summary collapse
#apps, #cartfile_path, #keys, #options, #pod_repo_update, #podfile, #podfile_path, #quiet, #sdk, #sdk_integration_mode, #target, #workspace, #workspace_path, #xcodeproj, #xcodeproj_path
Class Method Summary
collapse
Instance Method Summary
collapse
#absolute_path, absolute_path, #all_xcodeproj_paths, #app_delegate_objc_path, #app_delegate_swift_path, available_options, #branch_imports, #branch_imports_from_file, #bridging_header_path, #bridging_header_required?, #confirm_with_user, defaults, #find_project, #helper, #ios_urischemes_from_api, #key_valid?, #messages_view_controller_path, #method_missing, #modules_enabled?, open_podfile, #open_podfile, open_xcodeproj, #open_xcodeproj, #pod_install_required?, #print_identification, #prompt_for_option, relative_path, #relative_path, #root, root, #swift_version, #target_name, uri_scheme_without_suffix, #uses_frameworks?, #validate_buildfile_at_path, #validate_buildfile_path, #validate_key, #validate_keys, #validate_target, #validate_xcodeproj_path, wrapper
Constructor Details
Returns a new instance of SetupConfiguration.
32
33
34
35
36
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 32
def initialize(options)
super
confirm_with_user if options.confirm
end
|
Instance Attribute Details
#all_domains ⇒ Object
Returns the value of attribute all_domains.
30
31
32
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 30
def all_domains
@all_domains
end
|
Class Method Details
.examples ⇒ Object
9
10
11
12
13
14
15
16
17
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 9
def examples
{
"Test without validation (can use dummy keys and domains)" => "br setup -L key_live_xxxx -D myapp.app.link --no-validate",
"Use both live and test keys" => "br setup -L key_live_xxxx -T key_test_yyyy -D myapp.app.link",
"Use custom or non-Branch domains" => "br setup -D myapp.app.link,example.com,www.example.com",
"Avoid pod repo update" => "br setup --no-pod-repo-update",
"Install using carthage bootstrap" => "br setup --carthage-command \"bootstrap --no-use-binaries\""
}
end
|
.summary ⇒ Object
5
6
7
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 5
def summary
"Integrates the Branch SDK into a native app project"
end
|
Instance Method Details
#all_domains_from_domains(domains) ⇒ Object
204
205
206
207
208
209
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 204
def all_domains_from_domains(domains)
app_link_roots = app_link_roots_from_domains domains
app_link_subdomains = app_link_subdomains_from_roots app_link_roots
custom_domains = custom_domains_from_domains domains
custom_domains + app_link_subdomains
end
|
#app_link_roots_from_domains(domains) ⇒ Object
164
165
166
167
168
169
170
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 164
def app_link_roots_from_domains(domains)
return [] if domains.nil?
domains.select { |d| d =~ APP_LINK_REGEXP }
.map { |d| d.sub(APP_LINK_REGEXP, '').sub(/-alternate$/, '') }
.uniq
end
|
#app_link_subdomains(root) ⇒ Object
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 177
def app_link_subdomains(root)
app_link_subdomain = root
return [] if app_link_subdomain.nil?
live_key = keys[:live]
test_key = keys[:test]
domains = []
unless live_key.nil?
domains += [
"#{app_link_subdomain}.app.link",
"#{app_link_subdomain}-alternate.app.link"
]
end
unless test_key.nil?
domains += [
"#{app_link_subdomain}.test-app.link",
"#{app_link_subdomain}-alternate.test-app.link"
]
end
domains
end
|
#app_link_subdomains_from_roots(roots) ⇒ Object
200
201
202
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 200
def app_link_subdomains_from_roots(roots)
roots.inject([]) { |domains, root| domains + app_link_subdomains(root) }
end
|
#custom_domains_from_domains(domains) ⇒ Object
172
173
174
175
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 172
def custom_domains_from_domains(domains)
return [] if domains.nil?
domains.reject { |d| d =~ APP_LINK_REGEXP }.uniq
end
|
#domains_from_api ⇒ Object
143
144
145
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 143
def domains_from_api
helper.domains @apps
end
|
#log ⇒ Object
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
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 73
def log
super
message = <<-EOF
<%= color('Xcode project:', BOLD) %> #{xcodeproj_path}
<%= color('Target:', BOLD) %> #{target.name}
<%= color('Target type:', BOLD) %> #{target.product_type}
<%= color('Live key:', BOLD) %> #{keys[:live] || '(none)'}
<%= color('Test key:', BOLD) %> #{keys[:test] || '(none)'}
<%= color('Domains:', BOLD) %> #{all_domains}
<%= color('URI scheme:', BOLD) %> #{uri_scheme || '(none)'}
EOF
if setting
message += <<-EOF
<%= color('Branch key setting:', BOLD) %> #{setting}
EOF
if test_configurations
message += <<-EOF
<%= color('Test configurations:', BOLD) %> #{test_configurations}
EOF
end
end
message += <<-EOF
<%= color('Podfile:', BOLD) %> #{relative_path(podfile_path) || '(none)'}
<%= color('Cartfile:', BOLD) %> #{relative_path(cartfile_path) || '(none)'}
<%= color('Carthage command:', BOLD) %> #{carthage_command || '(none)'}
<%= color('Pod repo update:', BOLD) %> #{pod_repo_update.inspect}
<%= color('Validate:', BOLD) %> #{validate.inspect}
<%= color('Force:', BOLD) %> #{force.inspect}
<%= color('Add SDK:', BOLD) %> #{add_sdk.inspect}
<%= color('Patch source:', BOLD) %> #{patch_source.inspect}
<%= color('Commit:', BOLD) %> #{commit.inspect}
<%= color('SDK integration mode:', BOLD) %> #{sdk_integration_mode || '(none)'}
EOF
if swift_version
message += <<-EOF
<%= color('Swift version:', BOLD) %> #{swift_version}
EOF
end
message += "\n"
say message
end
|
#prompt_for_podfile_or_cartfile ⇒ Object
211
212
213
214
215
216
217
218
219
220
221
222
223
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 211
def prompt_for_podfile_or_cartfile
loop do
path = ask("Please enter the location of your Podfile or Cartfile: ").trim
case path
when %r{/?Podfile$}
return if validate_buildfile_at_path path, "Podfile"
when %r{/?Cartfile$}
return if validate_buildfile_at_path path, "Cartfile"
else
say "Path must end in Podfile or Cartfile."
end
end
end
|
#validate_all_domains(options, required = true) ⇒ Object
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 120
def validate_all_domains(options, required = true)
app_link_roots = app_link_roots_from_domains options.domains
unless options.app_link_subdomain.nil? || app_link_roots.include?(options.app_link_subdomain)
app_link_roots << options.app_link_subdomain
end
app_link_subdomains = app_link_subdomains_from_roots app_link_roots
custom_domains = custom_domains_from_domains options.domains
@all_domains = (app_link_subdomains + custom_domains).uniq
while required && @all_domains.empty?
domains = ask "Please enter domains as a comma-separated list: ", ->(str) { str.split "," }
@all_domains = all_domains_from_domains domains
end
end
|
#validate_options ⇒ Object
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 38
def validate_options
@validate = options.validate
@patch_source = options.patch_source
@add_sdk = options.add_sdk
@force = options.force
@commit = options.commit
say "--force is ignored when --no-validate is used." if !options.validate && options.force
if options.cartfile && options.podfile
say "--cartfile and --podfile are mutually exclusive. Please specify the file to patch."
exit 1
end
validate_xcodeproj_path
validate_target
validate_keys
validate_all_domains options, !target.extension_target_type?
validate_uri_scheme options
validate_setting options
validate_test_configurations options
validate_buildfile_path options.podfile, "Podfile" if options.cartfile.nil? && options.add_sdk
validate_buildfile_path options.cartfile, "Cartfile" if sdk_integration_mode.nil? && options.add_sdk
@carthage_command = options.carthage_command if sdk_integration_mode == :carthage
validate_sdk_addition options
end
|
#validate_sdk_addition(options) ⇒ Object
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
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 225
def validate_sdk_addition(options)
return if !options.add_sdk || sdk_integration_mode
return if target.frameworks_build_phase.files.map(&:file_ref).map(&:path).any? { |p| p =~ /Branch.framework$/ }
selected = choose do ||
. = "No Podfile or Cartfile specified or found. Here are your options"
.readline = true
SDK_OPTIONS.each_key { |k| .choice k }
.prompt = "What would you like to do?"
end
@sdk_integration_mode = SDK_OPTIONS[selected]
case sdk_integration_mode
when :specify
prompt_for_podfile_or_cartfile
when :cocoapods
@podfile_path = File.expand_path "../Podfile", xcodeproj_path
when :carthage
@cartfile_path = File.expand_path "../Cartfile", xcodeproj_path
@carthage_command = options.carthage_command
end
end
|
#validate_setting(options) ⇒ Object
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 255
def validate_setting(options)
setting = options.setting
return if setting.nil?
@setting = "BRANCH_KEY" and return if setting == true
loop do
if setting =~ /^[A-Z0-9_]+$/
@setting = setting
return
end
setting = ask "Invalid build setting. Please enter an all-caps identifier (may include digits and underscores): "
end
end
|
#validate_test_configurations(options) ⇒ Object
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 270
def validate_test_configurations(options)
return if options.test_configurations.nil?
unless options.setting
say "--test-configurations ignored without --setting"
return
end
all_configurations = target.build_configurations.map(&:name)
test_configs = options.test_configurations == false ? [] : options.test_configurations
loop do
invalid_configurations = test_configs.reject { |c| all_configurations.include? c }
@test_configurations = test_configs and return if invalid_configurations.empty?
say "The following test configurations are invalid: #{invalid_configurations}."
say "Available configurations: #{all_configurations}"
test_configs = ask "Please enter a comma-separated list of configurations to use the Branch test key: ", Array
end
end
|
#validate_uri_scheme(options) ⇒ Object
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
# File 'lib/branch_io_cli/configuration/setup_configuration.rb', line 147
def validate_uri_scheme(options)
uri_scheme = options.uri_scheme
if options.uri_scheme == false
@uri_scheme = nil
return
end
if confirm
uri_scheme ||= ask "Please enter any URI scheme you entered in the Branch Dashboard [enter for none]: "
end
@uri_scheme = self.class.uri_scheme_without_suffix uri_scheme
end
|