branch_io_cli 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d6d029c93a40885ef2c8f619c45d550cd49a680
-  data.tar.gz: 3553f1e6241a02f8329f30d4ac9ab65057a78ac0
+  metadata.gz: 5010d2220f3412bda298fa667173dd26b6142f20
+  data.tar.gz: 91b25b66bd4c3d4b9e6bf9ea9051763c5bd5cc01
 SHA512:
-  metadata.gz: 738daf6516afbdde4902e7be83865a856031b28b565d07d1c244b5c53cc817795d3a20ecf48c2ebf9f52f306903405fbdc4784039d6b25625d4109858c3a1c3f
-  data.tar.gz: e861e2ceb053c93cf2ab57605856386e07767f8c36b683cb4387b3fd118cc882026a24a41d436e3840bbd13e20155df025612128771f56d2e85e97638bd75f2f
+  metadata.gz: 3bffd545175fc581e8ae95b7ea13002386a36c994fbff76169538d2ee4cb047b10ea4b41457526b707bab99755763bf6a3589ab91086da68578f882a79676df4
+  data.tar.gz: 07af2fa0b8aad5aec93df27be95a4707c58b196f5f761b1c1f276ec80c0a51974f21cb2f5d5ad84c1ec16c1c2f73f06d72d9435debb7d0ffc7910332b392a5da

data/README.md

@@ -229,7 +229,8 @@ report with additional diagnostic information suitable for opening a support tic
 |--xcodeproj MyProject.xcodeproj|Path to an Xcode project|
 |--target MyAppTarget|Name of a target to modify in the Xcode project|
 |--scheme MyAppScheme|Name of a scheme to build|
-|--configuration Debug/Release/CustomConfig|Name of a build configuration|
+|--configuration Debug/Release/CustomConfig|Name of a build configuration (default: Release)|
+|--sdk iphonesimulator|Name of an SDK to use with xcodebuild (default: iphonesimulator)|
 |--[no-]clean|Clean before building (default: yes)|
 |--[no-]header-only|Show a diagnostic header and exit without cleaning or building (default: no)|
 |--podfile /path/to/Podfile|Path to the Podfile for the project|

data/lib/branch_io_cli/cli.rb

@@ -163,6 +163,7 @@ EOF
         c.option "--scheme MyProjectScheme", String, "A scheme from the project or workspace to build"
         c.option "--target MyProjectTarget", String, "A target to build"
         c.option "--configuration Debug|Release|CustomConfigName", String, "The build configuration to use (default: Release)"
+        c.option "--sdk iphonesimulator", String, "Passed as -sdk to xcodebuild (default: iphonesimulator)"
         c.option "--podfile /path/to/Podfile", String, "Path to the Podfile for the project"
         c.option "--cartfile /path/to/Cartfile", String, "Path to the Cartfile for the project"
         c.option "--[no-]clean", "Clean before attempting to build (default: yes)"
@@ -170,7 +171,12 @@ EOF
         c.option "--out branch-report.txt", String, "Report output path (default: ./branch-report.txt)"
 
         c.action do |args, options|
-          options.default clean: true, header_only: false
+          options.default(
+            clean: true,
+            header_only: false,
+            configuration: "Release",
+            sdk: "iphonesimulator"
+          )
           Commands::ReportCommand.new(options).run!
         end
       end

data/lib/branch_io_cli/commands/report_command.rb

@@ -18,34 +18,52 @@ module BranchIOCLI
 
         File.open config_helper.report_path, "w" do |report|
           report.write "Branch.io Xcode build report v #{VERSION} #{DateTime.now}\n\n"
-          # TODO: Write out command-line options or configuration from helper
+          report.write "#{report_configuration}\n"
           report.write "#{report_header}\n"
 
+          # run xcodebuild -list
           report.report_command "#{base_xcodebuild_cmd} -list"
-          report.report_command "#{base_xcodebuild_cmd} -showBuildSettings"
+
+          # If using a workspace, -list all the projects as well
+          if config_helper.workspace_path
+            config_helper.workspace.file_references.map(&:path).each do |project_path|
+              path = File.join File.dirname(config_helper.workspace_path), project_path
+              report.report_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_helper.scheme}" if config_helper.workspace_path
+
+          # xcodebuild -showBuildSettings
+          report.report_command "#{base_cmd} -showBuildSettings"
+
+          # Add more options for the rest of the commands
+          base_cmd = "#{base_cmd} -configuration #{config_helper.configuration} -sdk #{config_helper.sdk}"
+          base_cmd = "#{base_cmd} -target #{config_helper.target}" unless config_helper.workspace_path
 
           if config_helper.clean
             say "Cleaning"
-            report.report_command "#{base_xcodebuild_cmd} clean"
+            report.report_command "#{base_cmd} clean"
           end
 
           say "Building"
-          report.report_command "#{base_xcodebuild_cmd} -verbose"
+          report.report_command "#{base_cmd} -verbose"
 
           say "Done ✅"
         end
-        @report = nil
 
         say "Report generated in #{config_helper.report_path}"
       end
 
       def base_xcodebuild_cmd
-        cmd = "xcodebuild -sdk iphonesimulator"
-        cmd = "#{cmd} -scheme #{config_helper.scheme}" if config_helper.scheme
-        cmd = "#{cmd} -workspace #{config_helper.workspace_path}" if config_helper.workspace_path
-        cmd = "#{cmd} -project #{config_helper.xcodeproj_path}" if config_helper.xcodeproj_path && !config_helper.workspace_path
-        cmd = "#{cmd} -target #{config_helper.target}" if config_helper.target
-        cmd = "#{cmd} -configuration #{config_helper.configuration}" if config_helper.configuration
+        cmd = "xcodebuild"
+        if config_helper.workspace_path
+          cmd = "#{cmd} -workspace #{config_helper.workspace_path}"
+        else
+          cmd = "#{cmd} -project #{config_helper.xcodeproj_path}"
+        end
         cmd
       end
 
@@ -66,7 +84,7 @@ module BranchIOCLI
       def requirement_from_cartfile
         return nil unless config_helper.cartfile_path
         cartfile = File.read config_helper.cartfile_path
-        matches = %r{\n?[^\n]+?BranchMetrics/(ios-branch-deep-linking|iOS-Deferred-Deep-Linking-SDK.*?).*?\n}m.match cartfile
+        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
 
@@ -98,9 +116,9 @@ module BranchIOCLI
       end
 
       def version_from_branch_framework
-        framework = config_helper.xcodeproj.frameworks_group.files.find { |f| f.path =~ /Branch.framework$/ }
+        framework = config_helper.target.frameworks_build_phase.files.find { |f| f.file_ref.path =~ /Branch.framework$/ }
         return nil unless framework
-        framework_path = framework.real_path
+        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
 
@@ -123,29 +141,91 @@ module BranchIOCLI
         "#{version} [BNCConfig.m]"
       end
 
+      def report_configuration
+        <<EOF
+Configuration:
+
+Xcode workspace: #{config_helper.workspace_path || '(none)'}
+Xcode project: #{config_helper.xcodeproj_path || '(none)'}
+Scheme: #{config_helper.scheme || '(none)'}
+Target: #{config_helper.target || '(none)'}
+Configuration: #{config_helper.configuration || '(none)'}
+SDK: #{config_helper.sdk}
+Podfile: #{config_helper.podfile_path || '(none)'}
+Cartfile: #{config_helper.cartfile_path || '(none)'}
+Clean: #{config_helper.clean.inspect}
+EOF
+      end
+
+      # rubocop: disable Metrics/PerceivedComplexity
       def report_header
         header = `xcodebuild -version`
 
-        if config_helper.podfile_path && File.exist?("#{config_helper.podfile_path}.lock")
-          podfile_lock = Pod::Lockfile.from_file Pathname.new "#{config_helper.podfile_path}.lock"
-          header = "#{header}\nUsing CocoaPods v. #{podfile_lock.cocoapods_version}\n"
+        header += "\nTarget #{config_helper.target.name} deploy target: #{config_helper.target.deployment_target}\n"
+
+        if config_helper.podfile_path
+          begin
+            cocoapods_version = `pod --version`.chomp
+          rescue Errno::ENOENT
+            header += "\n(pod command not found)\n"
+          end
+
+          if File.exist?("#{config_helper.podfile_path}.lock")
+            podfile_lock = Pod::Lockfile.from_file Pathname.new "#{config_helper.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_helper.podfile_path
+          target_definition = podfile.target_definition_list.find { |t| t.name == config_helper.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_helper.target.name.inspect} not found in Podfile.\n"
+          end
+
         end
 
-        podfile_requirement = requirement_from_podfile
-        header = "#{header}\nFrom Podfile:\n#{podfile_requirement}\n" if podfile_requirement
+        if config_helper.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 = "#{header}\nFrom Cartfile:\n#{cartfile_requirement}\n" if cartfile_requirement
+        header += "\nFrom Cartfile:\n#{cartfile_requirement}\n" if cartfile_requirement
 
         version = branch_version
         if version
-          header = "#{header}\nBranch SDK v. #{version}\n"
+          header += "\nBranch SDK v. #{version}\n"
         else
-          header = "Branch SDK not found.\n"
+          header += "\nBranch SDK not found.\n"
         end
 
         header
       end
+      # rubocop: enable Metrics/PerceivedComplexity
     end
   end
 end

data/lib/branch_io_cli/commands/setup_command.rb

@@ -1,3 +1,5 @@
+require "branch_io_cli/helper/methods"
+
 module BranchIOCLI
   module Commands
     class SetupCommand < Command
@@ -46,7 +48,7 @@ module BranchIOCLI
         helper.ensure_uri_scheme_in_info_plist if is_app_target # does nothing if already present
 
         new_path = helper.add_universal_links_to_project @domains, false if is_app_target
-        `git add #{new_path}` if options.commit && new_path
+        sh "git add #{new_path}" if options.commit && new_path
 
         config_helper.target.add_system_frameworks options.frameworks unless options.frameworks.nil? || options.frameworks.empty?
 
@@ -58,7 +60,7 @@ module BranchIOCLI
 
         changes = helper.changes.to_a.map { |c| Pathname.new(File.expand_path(c)).relative_path_from(Pathname.pwd).to_s }
 
-        `git commit #{changes.join(" ")} -m '[branch_io_cli] Branch SDK integration'`
+        sh "git commit -qm '[branch_io_cli] Branch SDK integration' #{changes.join(' ')}"
       end
       # rubocop: enable Metrics/PerceivedComplexity
     end

data/lib/branch_io_cli/core_ext/io.rb

@@ -33,8 +33,8 @@ end
 #
 # :command: [String] a shell command to execute and report
 def STDOUT.report_command(command)
-  # TODO: Improve this?
-  say "<%= color('$ #{command}', BOLD) %>\n\n"
+  # TODO: Improve this implementation?
+  say "<%= color(%q{$ #{command}}, [MAGENTA, BOLD]) %>\n\n"
   # May also write to stderr
   # Could try system "#{command} 2>&1", but that might depend on the shell.
   system command
@@ -45,4 +45,5 @@ def STDOUT.report_command(command)
   else
     write "#{status}\n\n"
   end
+  status
 end

data/lib/branch_io_cli/helper.rb

@@ -1,3 +1,2 @@
 require "branch_io_cli/helper/branch_helper"
 require "branch_io_cli/helper/configuration_helper"
-require "branch_io_cli/helper/methods"

data/lib/branch_io_cli/helper/configuration_helper.rb

@@ -41,6 +41,7 @@ module BranchIOCLI
         attr_reader :scheme
         attr_reader :configuration
         attr_reader :report_path
+        attr_reader :sdk
 
         def validate_setup_options(options)
           print_identification "setup"
@@ -100,8 +101,10 @@ module BranchIOCLI
           @target = options.target
           @configuration = options.configuration
           @report_path = options.out || "./report.txt"
+          @sdk = options.sdk
 
           validate_xcodeproj_and_workspace options
+          validate_target options
           validate_scheme options
 
           # If neither --podfile nor --cartfile is present, arbitrarily look for a Podfile
@@ -127,7 +130,7 @@ EOF
 
         def print_setup_configuration
           say <<EOF
-<%= color('Configuration:', BOLD) %>
+<%= color('Configuration:', [CYAN, BOLD, UNDERLINE]) %>
 
 <%= color('Xcode project:', BOLD) %> #{@xcodeproj_path}
 <%= color('Target:', BOLD) %> #{@target.name}
@@ -151,7 +154,7 @@ EOF
 
         def print_validation_configuration
           say <<EOF
-<%= color('Configuration:', BOLD) %>
+<%= color('Configuration:', [CYAN, BOLD, UNDERLINE]) %>
 
 <%= color('Xcode project:', BOLD) %> #{@xcodeproj_path}
 <%= color('Target:', BOLD) %> #{@target.name}
@@ -161,13 +164,14 @@ EOF
 
         def print_report_configuration
           say <<EOF
-<%= color('Configuration:', BOLD) %>
+<%= color('Configuration:', [CYAN, BOLD, UNDERLINE]) %>
 
 <%= 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('Configuration:', BOLD) %> #{@configuration || '(none)'}
+<%= color('Configuration:', BOLD) %> #{@configuration}
+<%= color('SDK:', BOLD) %> #{@sdk}
 <%= color('Podfile:', BOLD) %> #{@podfile_path || '(none)'}
 <%= color('Cartfile:', BOLD) %> #{@cartfile_path || '(none)'}
 <%= color('Clean:', BOLD) %> #{@clean.inspect}
@@ -337,11 +341,15 @@ EOF
 
         def validate_scheme(options)
           schemes = all_schemes
+          # TODO: Prompt if --scheme specified but not found.
           if options.scheme && schemes.include?(options.scheme)
             @scheme = options.scheme
           elsif schemes.count == 1
             @scheme = schemes.first
           elsif !schemes.empty?
+            # By default, take a scheme with the same name as the target name.
+            return if (@scheme = schemes.find { |s| s == @target.name })
+
             say "Please specify one of the following for the --scheme argument:"
             schemes.each do |scheme|
               say " #{scheme}"

data/lib/branch_io_cli/helper/ios_helper.rb

@@ -11,8 +11,6 @@ require "branch_io_cli/helper/methods"
 module BranchIOCLI
   module Helper
     module IOSHelper
-      include Methods
-
       APPLINKS = "applinks"
       ASSOCIATED_DOMAINS = "com.apple.developer.associated-domains"
       CODE_SIGN_ENTITLEMENTS = "CODE_SIGN_ENTITLEMENTS"
@@ -341,7 +339,8 @@ module BranchIOCLI
           raise "Target #{target} not found" if target.nil?
         else
           # find the first application target
-          target = project.targets.find { |t| !t.extension_target_type? && !t.test_target_type? }
+          targets = project.targets.select { |t| !t.extension_target_type? && !t.test_target_type? }
+          target = targets.find { |t| t.name == File.basename(project.path).sub(/\.xcodeproj$/, "") } || targets.first
           raise "No application target found" if target.nil?
         end
         target
@@ -793,7 +792,7 @@ EOF
         install_command = "pod install"
         install_command += " --repo-update" if options.pod_repo_update
         Dir.chdir(File.dirname(podfile_path)) do
-          report_command "pod init"
+          sh "pod init"
           apply_patch(
             files: podfile_path,
             regexp: /^(\s*)# Pods for #{ConfigurationHelper.target.name}$/,
@@ -801,7 +800,7 @@ EOF
             text: "\n\\1pod \"Branch\"",
             global: false
           )
-          report_command install_command
+          sh install_command
         end
 
         add_change podfile_path
@@ -813,7 +812,7 @@ EOF
         podfile_pathname = Pathname.new(podfile_path).relative_path_from Pathname.pwd
         add_change pods_folder_path
         add_change workspace_path
-        `git add #{podfile_pathname} #{podfile_pathname}.lock #{pods_folder_path} #{workspace_path}` if options.commit
+        sh "git add #{podfile_pathname} #{podfile_pathname}.lock #{pods_folder_path} #{workspace_path}" if options.commit
       end
 
       def add_carthage(options)
@@ -830,7 +829,7 @@ EOF
 
         # 2. carthage update
         Dir.chdir(File.dirname(cartfile_path)) do
-          report_command "carthage #{ConfigurationHelper.carthage_command}"
+          sh "carthage #{ConfigurationHelper.carthage_command}"
         end
 
         # 3. Add Cartfile and Cartfile.resolved to commit (in case :commit param specified)
@@ -859,7 +858,7 @@ EOF
         carthage_folder_path = Pathname.new(File.expand_path("../Carthage", cartfile_path)).relative_path_from(Pathname.pwd)
         cartfile_pathname = Pathname.new(cartfile_path).relative_path_from Pathname.pwd
         add_change carthage_folder_path
-        `git add #{cartfile_pathname} #{cartfile_pathname}.resolved #{carthage_folder_path}` if options.commit
+        sh "git add #{cartfile_pathname} #{cartfile_pathname}.resolved #{carthage_folder_path}" if options.commit
       end
 
       def add_direct(options)
@@ -923,7 +922,7 @@ EOF
 
         add_change ConfigurationHelper.xcodeproj_path
         add_change framework_path
-        `git add #{framework_path}` if options.commit
+        sh "git add #{framework_path}" if options.commit
 
         say "Done. ✅"
       end
@@ -943,7 +942,7 @@ EOF
         command += ' --repo-update' if options.pod_repo_update
 
         Dir.chdir(File.dirname(podfile_path)) do
-          report_command command
+          sh command
         end
 
         # 3. Add Podfile and Podfile.lock to commit (in case :commit param specified)
@@ -957,7 +956,7 @@ EOF
 
         # 5. If so, add the Pods folder to the commit (in case :commit param specified)
         add_change pods_folder_path
-        `git add #{pods_folder_path}` if options.commit
+        sh "git add #{pods_folder_path}" if options.commit
 
         true
       end
@@ -973,7 +972,7 @@ EOF
 
         # 2. carthage update
         Dir.chdir(File.dirname(cartfile_path)) do
-          report_command "carthage #{ConfigurationHelper.carthage_command}"
+          sh "carthage #{ConfigurationHelper.carthage_command}"
         end
 
         # 3. Add Cartfile and Cartfile.resolved to commit (in case :commit param specified)
@@ -1004,7 +1003,7 @@ EOF
 
         # 7. If so, add the Carthage folder to the commit (in case :commit param specified)
         add_change carthage_folder_path
-        `git add #{carthage_folder_path}` if options.commit
+        sh "git add #{carthage_folder_path}" if options.commit
 
         true
       end
@@ -1031,13 +1030,13 @@ EOF
 
         gem_home = ENV["GEM_HOME"]
         if gem_home && File.writable?(gem_home)
-          report_command "gem install cocoapods"
+          sh "gem install cocoapods"
         else
-          report_command "sudo gem install cocoapods"
+          sh "sudo gem install cocoapods"
         end
 
         # Ensure master podspec repo is set up (will update if it exists).
-        report_command "pod setup"
+        sh "pod setup"
       end
 
       def verify_carthage
@@ -1056,7 +1055,7 @@ EOF
           exit(-1)
         end
 
-        report_command "brew install carthage"
+        sh "brew install carthage"
       end
 
       def verify_git
@@ -1077,7 +1076,7 @@ EOF
           exit(-1)
         end
 
-        report_command "xcode-select --install"
+        sh "xcode-select --install"
       end
     end
   end

data/lib/branch_io_cli/helper/methods.rb

@@ -1,9 +1,25 @@
 module BranchIOCLI
   module Helper
+    class CommandError < RuntimeError; end
+
     module Methods
-      def report_command(command)
-        STDOUT.report_command command
+      # Execute a shell command with reporting.
+      # The command itself is logged, then output from
+      # both stdout and stderr, then a success or failure
+      # message. Raises CommandError on error.
+      #
+      # If output is STDOUT (the default), no redirection occurs. In all
+      # other cases, both stdout and stderr are redirected to output.
+      # In these cases, formatting (colors, highlights) may be lost.
+      #
+      # :command: [String] A shell command to execute
+      # :output: [IO] An optional IO object to receive stdout and stderr from the command
+      def sh(command, output = STDOUT)
+        status = output.report_command command
+        raise CommandError, %{Error executing "#{command}": #{status}.} unless status.success?
       end
     end
   end
 end
+
+include BranchIOCLI::Helper::Methods

data/lib/branch_io_cli/version.rb

@@ -1,3 +1,3 @@
 module BranchIOCLI
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch_io_cli
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Branch
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-02 00:00:00.000000000 Z
+date: 2017-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList