Class: BranchIOCLI::Configuration::ReportConfiguration

Inherits:
Configuration
  • Object
show all
Defined in:
lib/branch_io_cli/configuration/report_configuration.rb

Instance Attribute Summary collapse

Attributes inherited from Configuration

#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

Methods inherited from Configuration

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, #initialize, #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

This class inherits a constructor from BranchIOCLI::Configuration::Configuration

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class BranchIOCLI::Configuration::Configuration

Instance Attribute Details

#report_path ⇒ Object (readonly)

Returns the value of attribute report_path.



21
22
23
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 21

def report_path
  @report_path
end

Class Method Details

.examples ⇒ Object 



12
13
14
15
16
17
18
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 12

def examples
  {
    "Show general project information without building" => "br report -H",
    "Perform a full build and report all errors to report.txt" => "br report",
    "Don't clean before building" => "br report --no-clean"
  }
end

.summary ⇒ Object 



8
9
10
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 8

def summary
  "Generate and optionally submit a build diagnostic report."
end

Instance Method Details

#all_schemes ⇒ Object 



192
193
194
195
196
197
198
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 192

def all_schemes
  if workspace_path
    workspace.schemes.keys.reject { |scheme| scheme == "Pods" }
  else
    Xcodeproj::Project.schemes xcodeproj_path
  end
end

#all_workspace_paths ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 131

def all_workspace_paths
  return @all_workspace_paths if @all_workspace_paths

  @all_workspace_paths =
    Dir[File.expand_path(File.join(".", "**/*.xcworkspace"))]
    .reject { |w| w =~ %r{/project.xcworkspace$} }
    .select do |p|
      valid = true
      Pathname.new(p).each_filename do |f|
        valid = false && break if f == "Carthage" || f == "Pods"
      end
      valid
    end

  @all_workspace_paths
end

#branch_key_setting_from_info_plist(config = configuration || "Release") ⇒ Object 



349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 349

def branch_key_setting_from_info_plist(config = configuration || "Release")
  return @branch_key_setting_from_info_plist if @branch_key_setting_from_info_plist

  infoplist_path = target.expanded_build_setting "INFOPLIST_FILE", config
  infoplist_path = File.expand_path infoplist_path, File.dirname(xcodeproj_path)
  info_plist = File.open(infoplist_path) { |f| Plist.parse_xml f }
  branch_key = info_plist["branch_key"]
  regexp = /^\$\((\w+)\)$|^\$\{(\w+)\}$/
  return nil unless branch_key.kind_of?(String) && (matches = regexp.match branch_key)
  @branch_key_setting_from_info_plist = matches[1] || matches[2]
  @branch_key_setting_from_info_plist
end

#branch_version ⇒ Object 



257
258
259
260
261
262
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 257

def branch_version
  version_from_podfile_lock ||
    version_from_cartfile_resolved ||
    version_from_branch_framework ||
    version_from_bnc_config_m
end

#configurations ⇒ Object 



248
249
250
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 248

def configurations
  configuration ? [configuration] : configurations_from_scheme
end

#configurations_from_scheme ⇒ Object 



252
253
254
255
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 252

def configurations_from_scheme
  return ["Debug", "Release"] unless xcscheme
  %i[test launch profile archive analyze].map { |pfx| xcscheme.send("#{pfx}_action").build_configuration }.uniq
end

#log ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 66

def log
  super
  say <<EOF
<%= color('Xcode workspace:', BOLD) %> #{workspace_path || '(none)'}
<%= color('Xcode project:', BOLD) %> #{xcodeproj_path || '(none)'}
<%= color('Scheme:', BOLD) %> #{scheme || '(none)'}
<%= color('Target:', BOLD) %> #{target || '(none)'}
<%= color('Target type:', BOLD) %> #{target.product_type}
<%= color('Configuration:', BOLD) %> #{configuration || '(none)'}
<%= color('SDK:', BOLD) %> #{sdk}
<%= color('Podfile:', BOLD) %> #{relative_path(podfile_path) || '(none)'}
<%= color('Cartfile:', BOLD) %> #{relative_path(cartfile_path) || '(none)'}
<%= color('Pod repo update:', BOLD) %> #{pod_repo_update.inspect}
<%= color('Clean:', BOLD) %> #{clean.inspect}
<%= color('Report path:', BOLD) %> #{report_path}
EOF
end

#open_first_project_in_workspace ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 148

def open_first_project_in_workspace
  # Pass --workspace and --xcodeproj or use the configuration editor to
  # override this inference.
  project_path = workspace.file_references.map(&:path).find do |path|
    path =~ /\.xcodeproj$/ && File.exist?(File.expand_path("../#{path}", workspace_path))
  end

  if project_path.nil?
    raise "No project found in workspace #{workspace_path}"
  end

  open_xcodeproj project_path
  # TODO: Handle the case where this cannot be opened (though it exists).
end

#open_workspace(path = workspace_path) ⇒ Object 



84
85
86
87
88
89
90
91
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 84

def open_workspace(path = workspace_path)
  @workspace = Xcodeproj::Workspace.new_from_xcworkspace path
  @workspace_path = File.expand_path path
  true
rescue Xcodeproj::PlainInformative => e
  say e.message
  false
end

#report_configuration ⇒ Object

TODO: Collapse the following methods with support for formatting.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 49

def report_configuration
  <<EOF
Configuration:

Xcode workspace: #{workspace_path || '(none)'}
Xcode project: #{xcodeproj_path || '(none)'}
Scheme: #{scheme || '(none)'}
Target: #{target || '(none)'}
Configuration: #{configuration || '(none)'}
SDK: #{sdk}
Podfile: #{relative_path(podfile_path) || '(none)'}
Cartfile: #{relative_path(cartfile_path) || '(none)'}
Pod repo update: #{pod_repo_update.inspect}
Clean: #{clean.inspect}
EOF
end

#requirement_from_cartfile ⇒ Object 



271
272
273
274
275
276
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 271

def requirement_from_cartfile
  return nil unless cartfile_path
  cartfile = File.read cartfile_path
  matches = %r{^git(hub\s+"|\s+"https://github.com/)BranchMetrics/(ios-branch-deep-linking|iOS-Deferred-Deep-Linking-SDK.*?).*?\n}m.match cartfile
  matches ? matches[0].strip : nil
end

#requirement_from_podfile ⇒ Object 



264
265
266
267
268
269
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 264

def requirement_from_podfile
  return nil unless podfile_path
  podfile = File.read podfile_path
  matches = /\n?\s*pod\s+("Branch"|'Branch').*?\n/m.match podfile
  matches ? matches[0].strip : nil
end

#scheme_with_name(scheme_name) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 208

def scheme_with_name(scheme_name)
  if workspace_path
    project_path = workspace.schemes[@scheme]
  else
    project_path = xcodeproj_path
  end

  # Look for a shared scheme.
  xcshareddata_path = File.join project_path, "xcshareddata", "xcschemes", "#{@scheme}.xcscheme"
  scheme_path = xcshareddata_path if File.exist?(xcshareddata_path)

  unless scheme_path
    # Look for a local scheme
    user = ENV["USER"]
    xcuserdata_path = File.join project_path, "xcuserdata", "#{user}.xcuserdatad", "xcschemes", "#{@scheme}.xcscheme"
    scheme_path = xcuserdata_path if File.exist?(xcuserdata_path)
  end

  return nil unless scheme_path

  Xcodeproj::XCScheme.new(scheme_path)
end

#validate_configuration(options) ⇒ Object 



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 231

def validate_configuration(options)
  return unless options.configuration

  all_configs = xcodeproj.build_configurations.map(&:name)

  if all_configs.include?(options.configuration)
    @configuration = options.configuration
  else
    say "Configuration #{options.configuration} not found."
    @configuration = choose do |menu|
      menu.header = "Configurations from project"
      all_configs.each { |c| menu.choice c }
      menu.prompt = "Please choose one of the above. "
    end
  end
end

#validate_options ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 23

def validate_options
  @clean = options.clean
  @header_only = options.header_only
  @scheme = options.scheme
  @target = options.target
  @report_path = options.out
  @sdk = options.sdk
  @pod_repo_update = options.pod_repo_update

  validate_xcodeproj_and_workspace options
  validate_scheme options
  validate_target options
  validate_configuration options

  # If neither --podfile nor --cartfile is present, arbitrarily look for a Podfile
  # first.

  # If --cartfile is present, don't look for a Podfile. Just validate that
  # Cartfile.
  validate_buildfile_path(options.podfile, "Podfile") if options.cartfile.nil?

  # If --podfile is present or a Podfile was found, don't look for a Cartfile.
  validate_buildfile_path(options.cartfile, "Cartfile") if sdk_integration_mode.nil?
end

#validate_scheme(options) ⇒ Object 



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
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 163

def validate_scheme(options)
  schemes = all_schemes

  if options.scheme && schemes.include?(options.scheme)
    @scheme = options.scheme
  elsif schemes.count == 1
    @scheme = schemes.first
    say "Scheme #{options.scheme} not found. Using #{@scheme}." if options.scheme
  elsif !schemes.empty?
    # By default, take a scheme with the same name as the project name.
    return if !options.scheme && (@scheme = schemes.find { |s| s == File.basename(xcodeproj_path, '.xcodeproj') })

    @scheme = choose do |menu|
      menu.header = "Schemes from project"
      schemes.each { |s| menu.choice s }
      menu.prompt = "Please choose one of the schemes above. "
    end
  else
    say "No scheme defined in project."
    exit(-1)
  end

  return if options.target || xcscheme.nil?

  # Find the target used when running the scheme if the user didn't specify one.
  entry = xcscheme.build_action.entries.select(&:build_for_running?).first
  @target = xcodeproj.targets.find { |t| t.name == entry.buildable_references.first.target_name }
end

#validate_xcodeproj_and_workspace(options) ⇒ Object 



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
128
129
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 93

def validate_xcodeproj_and_workspace(options)
  # What was passed in?
  if options.workspace
    open_workspace options.workspace
  end

  if options.xcodeproj
    open_xcodeproj options.xcodeproj
  elsif workspace
    open_first_project_in_workspace
  end

  return if workspace || xcodeproj

  # Try to find first a workspace, then a project
  path =
    case all_workspace_paths.count
    when 1
      all_workspace_paths.first
    when 0
      find_project
    end
  # If more than one workspace. Don't try to find a project. Just prompt.

  loop do
    path = ask "Please enter a path to your Xcode project or workspace: " if path.nil?
    if path =~ /\.xcworkspace$/
      next unless open_workspace path
      open_first_project_in_workspace
      return
    elsif path =~ /\.xcodeproj$/
      return if open_xcodeproj path
    else
      say "Path must end with .xcworkspace or .xcodeproj"
    end
  end
end

#version_from_bnc_config_m(project = xcodeproj) ⇒ Object 



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 329

def version_from_bnc_config_m(project = xcodeproj)
  # Look for BNCConfig.m in embedded source
  bnc_config_m_ref = project.files.find { |f| f.path =~ /BNCConfig\.m$/ }
  unless bnc_config_m_ref
    subprojects = project.files.select { |f| f.path =~ /\.xcodeproj$/ }
    subprojects.each do |subproject|
      p = Xcodeproj::Project.open subproject.real_path
      version = version_from_bnc_config_m p
      return version if version
    end
  end

  return nil unless bnc_config_m_ref
  bnc_config_m = File.read bnc_config_m_ref.real_path
  matches = /BNC_SDK_VERSION\s+=\s+@"(\d+\.\d+\.\d+)"/m.match bnc_config_m
  return nil unless matches
  version = matches[1]
  "#{version} [BNCConfig.m:#{relative_path project.path}]"
end

#version_from_branch_framework(configuration = configurations.first) ⇒ Object 



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 305

def version_from_branch_framework(configuration = configurations.first)
  framework = target.frameworks_build_phase.files.find { |f| f.file_ref.path =~ /Branch.framework$/ }
  return nil unless framework

  if framework.file_ref.isa == "PBXFileReference"
    project_path = relative_path(xcodeproj_path)
    framework_path = framework.file_ref.real_path
  elsif framework.file_ref.isa == "PBXReferenceProxy" && XcodeSettings[configuration].valid?
    project_path = relative_path framework.file_ref.remote_ref.proxied_object.project.path
    framework_path = File.expand_path framework.file_ref.path, XcodeSettings[configuration][framework.file_ref.source_tree]
  end
  return nil unless framework_path
  info_plist_path = File.join framework_path.to_s, "Info.plist"
  return nil unless File.exist? info_plist_path

  require "cfpropertylist"

  raw_info_plist = CFPropertyList::List.new file: info_plist_path
  info_plist = CFPropertyList.native_types raw_info_plist.value
  version = info_plist["CFBundleVersion"]
  return nil unless version
  "#{version} [Branch.framework/Info.plist:#{project_path}]"
end

#version_from_cartfile_resolved ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 286

def version_from_cartfile_resolved
  return nil unless cartfile_path && File.exist?("#{cartfile_path}.resolved")
  cartfile_resolved = File.read "#{cartfile_path}.resolved"

  # Matches:
  # git "https://github.com/BranchMetrics/ios-branch-deep-linking"
  # git "https://github.com/BranchMetrics/ios-branch-deep-linking/"
  # git "https://github.com/BranchMetrics/iOS-Deferred-Deep-Linking-SDK"
  # git "https://github.com/BranchMetrics/iOS-Deferred-Deep-Linking-SDK/"
  # github "BranchMetrics/ios-branch-deep-linking"
  # github "BranchMetrics/ios-branch-deep-linking/"
  # github "BranchMetrics/iOS-Deferred-Deep-Linking-SDK"
  # github "BranchMetrics/iOS-Deferred-Deep-Linking-SDK/"
  matches = %r{(ios-branch-deep-linking|iOS-Deferred-Deep-Linking-SDK)/?" "(\d+\.\d+\.\d+)"}m.match cartfile_resolved
  return nil unless matches
  version = matches[2]
  "#{version} [Cartfile.resolved]"
end

#version_from_podfile_lock ⇒ Object 



278
279
280
281
282
283
284
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 278

def version_from_podfile_lock
  return nil unless podfile_path && File.exist?("#{podfile_path}.lock")
  podfile_lock = Pod::Lockfile.from_file Pathname.new "#{podfile_path}.lock"
  version = podfile_lock.version("Branch") || podfile_lock.version("Branch-SDK")

  version ? "#{version} [Podfile.lock]" : nil
end

#xcscheme ⇒ Object 



200
201
202
203
204
205
206
 
# File 'lib/branch_io_cli/configuration/report_configuration.rb', line 200

def xcscheme
  return @xcscheme if @xcscheme_checked
  # This may not exist. If it comes back nil once, don't keep checking.
  @xcscheme_checked = true
  @xcscheme = scheme_with_name @scheme
  @xcscheme
end