Class: BranchIOCLI::Command::ReportCommand
- Defined in:
- lib/branch_io_cli/command/report_command.rb
Instance Attribute Summary
Attributes inherited from Command
Instance Method Summary collapse
- #base_xcodebuild_cmd ⇒ Object
- #branch_version ⇒ Object
-
#initialize(options) ⇒ ReportCommand
constructor
A new instance of ReportCommand.
- #pod_install_required? ⇒ Boolean
- #report_configuration ⇒ Object
-
#report_header ⇒ Object
rubocop: disable Metrics/PerceivedComplexity.
- #requirement_from_cartfile ⇒ Object
- #requirement_from_podfile ⇒ Object
- #run! ⇒ Object
- #version_from_bnc_config_m ⇒ Object
- #version_from_branch_framework ⇒ Object
- #version_from_cartfile_resolved ⇒ Object
- #version_from_podfile_lock ⇒ Object
Methods inherited from Command
Constructor Details
#initialize(options) ⇒ ReportCommand
Returns a new instance of ReportCommand.
7 8 9 10 |
# File 'lib/branch_io_cli/command/report_command.rb', line 7 def initialize() super @config = Configuration::ReportConfiguration.new end |
Instance Method Details
#base_xcodebuild_cmd ⇒ Object
87 88 89 90 91 92 93 94 95 |
# File 'lib/branch_io_cli/command/report_command.rb', line 87 def base_xcodebuild_cmd cmd = "xcodebuild" if config.workspace_path cmd = "#{cmd} -workspace #{config.workspace_path}" else cmd = "#{cmd} -project #{config.xcodeproj_path}" end cmd end |
#branch_version ⇒ Object
97 98 99 100 101 102 |
# File 'lib/branch_io_cli/command/report_command.rb', line 97 def branch_version version_from_podfile_lock || version_from_cartfile_resolved || version_from_branch_framework || version_from_bnc_config_m end |
#pod_install_required? ⇒ Boolean
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/branch_io_cli/command/report_command.rb', line 188 def pod_install_required? # If this is set, its existence has been verified. return false unless config.podfile_path lockfile_path = "#{config.podfile_path}.lock" manifest_path = File. "../Pods/Manifest.lock", config.podfile_path return true unless File.exist?(lockfile_path) && File.exist?(manifest_path) lockfile = Pod::Lockfile.from_file Pathname.new lockfile_path manifest = Pod::Lockfile.from_file Pathname.new manifest_path # diff the contents of Podfile.lock and Pods/Manifest.lock # This is just what is done in the "[CP] Check Pods Manifest.lock" script build phase # in a project using CocoaPods. return true unless lockfile == manifest # compare checksum of Podfile with checksum in Podfile.lock # This is a good sanity check, but perhaps unnecessary. It means pod install # has not been run since the Podfile was modified, which is probably an oversight. return true unless lockfile.to_hash["PODFILE CHECKSUM"] == config.podfile.checksum false end |
#report_configuration ⇒ Object
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/branch_io_cli/command/report_command.rb', line 171 def report_configuration <<EOF Configuration: Xcode workspace: #{config.workspace_path || '(none)'} Xcode project: #{config.xcodeproj_path || '(none)'} Scheme: #{config.scheme || '(none)'} Target: #{config.target || '(none)'} Configuration: #{config.configuration || '(none)'} SDK: #{config.sdk} Podfile: #{config.podfile_path || '(none)'} Cartfile: #{config.cartfile_path || '(none)'} Pod repo update: #{config.pod_repo_update.inspect} Clean: #{config.clean.inspect} EOF end |
#report_header ⇒ Object
rubocop: disable Metrics/PerceivedComplexity
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 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/branch_io_cli/command/report_command.rb', line 214 def report_header header = "cocoapods-core: #{Pod::CORE_VERSION}\n" header += `xcodebuild -version` header += "\nTarget #{config.target.name}:\n" header += " Deployment target: #{config.target.deployment_target}\n" header += " Modules #{config.modules_enabled? ? '' : 'not '}enabled\n" header += " Swift #{config.swift_version}\n" if config.swift_version header += " Bridging header: #{config.bridging_header_path}\n" if config.bridging_header_path if config.podfile_path begin cocoapods_version = `pod --version`.chomp rescue Errno::ENOENT header += "\n(pod command not found)\n" end if File.exist?("#{config.podfile_path}.lock") podfile_lock = Pod::Lockfile.from_file Pathname.new "#{config.podfile_path}.lock" end if cocoapods_version || podfile_lock header += "\nUsing CocoaPods v. " if cocoapods_version header += "#{cocoapods_version} (CLI) " end if podfile_lock header += "#{podfile_lock.cocoapods_version} (Podfile.lock)" end header += "\n" end # Already verified existence. podfile = Pod::Podfile.from_file Pathname.new config.podfile_path target_definition = podfile.target_definition_list.find { |t| t.name == config.target.name } if target_definition branch_dep = target_definition.dependencies.find { |p| p.name == "Branch" } header += "Podfile target #{target_definition.name}:" header += "\n use_frameworks!" if target_definition.uses_frameworks? header += "\n platform: #{target_definition.platform}" header += "\n build configurations: #{target_definition.build_configurations}" header += "\n inheritance: #{target_definition.inheritance}" header += "\n pod 'Branch', '#{branch_dep.requirement}'" if branch_dep header += ", #{branch_dep.external_source}" if branch_dep && branch_dep.external_source header += "\n" else header += "Target #{config.target.name.inspect} not found in Podfile.\n" end header += "\npod install #{pod_install_required? ? '' : 'not '}required.\n" end if config.cartfile_path begin carthage_version = `carthage version`.chomp header += "\nUsing Carthage v. #{carthage_version}\n" rescue Errno::ENOENT header += "\n(carthage command not found)\n" end end cartfile_requirement = requirement_from_cartfile header += "\nFrom Cartfile:\n#{cartfile_requirement}\n" if cartfile_requirement version = branch_version if version header += "\nBranch SDK v. #{version}\n" else header += "\nBranch SDK not found.\n" end header end |
#requirement_from_cartfile ⇒ Object
111 112 113 114 115 116 |
# File 'lib/branch_io_cli/command/report_command.rb', line 111 def requirement_from_cartfile return nil unless config.cartfile_path cartfile = File.read config.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
104 105 106 107 108 109 |
# File 'lib/branch_io_cli/command/report_command.rb', line 104 def requirement_from_podfile return nil unless config.podfile_path podfile = File.read config.podfile_path matches = /\n?\s*pod\s+("Branch"|'Branch').*?\n/m.match podfile matches ? matches[0].strip : nil end |
#run! ⇒ 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 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 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/branch_io_cli/command/report_command.rb', line 12 def run! say "\n" if config.header_only say report_header exit 0 end # Only if a Podfile is detected/supplied at the command line. if pod_install_required? say "pod install required in order to build." install = ask %{Run "pod install" now (Y/n)? } if install.downcase =~ /^n/ say %{Please run "pod install" or "pod update" first in order to continue.} exit(-1) end helper.verify_cocoapods install_command = "pod install" if config.pod_repo_update install_command += " --repo-update" else say <<EOF You have disabled "pod repo update". This can cause "pod install" to fail in some cases. If that happens, please rerun without --no-pod-repo-update or run "pod install --repo-update" manually. EOF end sh install_command end File.open config.report_path, "w" do |report| report.write "Branch.io Xcode build report v #{VERSION} #{DateTime.now}\n\n" report.write "#{report_configuration}\n" report.write "#{report_header}\n" # run xcodebuild -list report.log_command "#{base_xcodebuild_cmd} -list" # If using a workspace, -list all the projects as well if config.workspace_path config.workspace.file_references.map(&:path).each do |project_path| path = File.join File.dirname(config.workspace_path), project_path report.log_command "xcodebuild -list -project #{path}" end end base_cmd = base_xcodebuild_cmd # Add -scheme option for the rest of the commands if using a workspace base_cmd = "#{base_cmd} -scheme #{config.scheme}" if config.workspace_path # xcodebuild -showBuildSettings report.log_command "#{base_cmd} -showBuildSettings" # Add more options for the rest of the commands base_cmd = "#{base_cmd} -configuration #{config.configuration} -sdk #{config.sdk}" base_cmd = "#{base_cmd} -target #{config.target}" unless config.workspace_path if config.clean say "Cleaning" report.log_command "#{base_cmd} clean" end say "Building" report.log_command "#{base_cmd} -verbose" say "Done ✅" end say "Report generated in #{config.report_path}" end |
#version_from_bnc_config_m ⇒ Object
160 161 162 163 164 165 166 167 168 169 |
# File 'lib/branch_io_cli/command/report_command.rb', line 160 def version_from_bnc_config_m # Look for BNCConfig.m in embedded source bnc_config_m_ref = config.xcodeproj.files.find { |f| f.path =~ /BNCConfig\.m$/ } 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]" end |
#version_from_branch_framework ⇒ Object
145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/branch_io_cli/command/report_command.rb', line 145 def version_from_branch_framework framework = config.target.frameworks_build_phase.files.find { |f| f.file_ref.path =~ /Branch.framework$/ } return nil unless framework framework_path = framework.file_ref.real_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"] version ? "#{version} [Branch.framework/Info.plist]" : nil end |
#version_from_cartfile_resolved ⇒ Object
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/branch_io_cli/command/report_command.rb', line 126 def version_from_cartfile_resolved return nil unless config.cartfile_path && File.exist?("#{config.cartfile_path}.resolved") cartfile_resolved = File.read "#{config.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
118 119 120 121 122 123 124 |
# File 'lib/branch_io_cli/command/report_command.rb', line 118 def version_from_podfile_lock return nil unless config.podfile_path && File.exist?("#{config.podfile_path}.lock") podfile_lock = Pod::Lockfile.from_file Pathname.new "#{config.podfile_path}.lock" version = podfile_lock.version "Branch" version ? "#{version} [Podfile.lock]" : nil end |