branch_io_cli 0.9.9 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9193658d454dcab2a74341807a6594a25baaa647ec46eac3e44043ee632a696
-  data.tar.gz: afb073e2385911619802a78066f281f9b36fef02d5613cba141ccaf8498dcd11
+  metadata.gz: d57e3295339b988ee4f835a92154eb15e45ae1df5655930902ebc5c43f1a33e0
+  data.tar.gz: 6b9b929afa148c9aa389116ac73e8d0eb8143ea5fed06285e389819371496c24
 SHA512:
-  metadata.gz: cfb723a5edc92d5eaae87c3b2673cc1c41cc38aaf694dd19cec96e26a53fd3cb275559de3e442fbcd58c18cf1a5768b790a47643875b21f868b4e4bd21eac74a
-  data.tar.gz: d134244741fe80706d32662edfb08d9212c80428b70aada33d90b2954b77ebe5ad6e88e080809b9d2e3685ce47758a37d03f15cb088dfded0e83aac849fda5ec
+  metadata.gz: 0f8a5e5132646571ed123b8546b8ceee45e998d0cc06356854d133c93cf544313302100f6058f22ecafa5a859f1459fd0c89b983745d3fadd865c2f95d7b0ee4
+  data.tar.gz: b37bd6a57304fb87f0ff721e30d1d7281bf52f1b0cfd6872b23b6cbd46494a4b5345b1f3925dfe6fc322f4365606b053aacb28aaad9b1875e5eae93d889dfe01

data/README.md

@@ -121,6 +121,8 @@ that the relevant commands are available in your `PATH`.
 |--app-link-subdomain myapp|Branch app.link subdomain, e.g. myapp for myapp.app.link|
 |-D, --domains example.com,www.example.com|Comma-separated list of custom domain(s) or non-Branch domain(s)|
 |-U, --uri-scheme myurischeme[://]|Custom URI scheme used in the Branch Dashboard for this app|
+|-s, --setting [BRANCH_KEY_SETTING]|Use a custom build setting for the Branch key (default: Use Info.plist)|
+|--test-configurations|List of configurations that use the test key with a custom build setting (default: Debug configurations)|
 |--xcodeproj MyProject.xcodeproj|Path to an Xcode project to update|
 |--target MyAppTarget|Name of a target to modify in the Xcode project|
 |--podfile /path/to/Podfile|Path to the Podfile for the project|
@@ -132,7 +134,7 @@ that the relevant commands are available in your `PATH`.
 |--[no-]force|Update project even if Universal Link validation fails (default: no)|
 |--[no-]add-sdk|Add the Branch framework to the project (default: yes)|
 |--[no-]patch-source|Add Branch SDK calls to the AppDelegate (default: yes)|
-|--[no-]commit|Commit the results to Git (default: no)|
+|--[no-]commit [message]|Commit the results to Git (default: no)|
 
 All parameters are optional. A live key or test key, or both is required, as well as at least one domain.
 Specify --live-key, --test-key or both and --app-link-subdomain, --domains or both. If these are not
@@ -236,7 +238,7 @@ report with additional diagnostic information suitable for opening a support tic
 |--[no-]pod-repo-update|Update the local podspec repo before installing (default: yes)|
 |--podfile /path/to/Podfile|Path to the Podfile for the project|
 |--cartfile /path/to/Cartfile|Path to the Cartfile for the project|
-|--out ./report.txt|Path to use for the generated report (default: ./report.txt)|
+|-o, --out ./report.txt|Path to use for the generated report (default: ./report.txt)|
 
 ## Examples
 

data/lib/assets/completions/completion.bash

@@ -12,7 +12,8 @@ _branch_io_complete()
     global_opts="-h --help -t --trace -v --version"
 
     setup_opts="$global_opts -L --live-key -T --test-key -D --domains --app-link-subdomain -U --uri-scheme"
-    setup_opts="$setup_opts --xcodeproj --target --frameworks --podfile --cartfile --carthage-command"
+    setup_opts="$setup_opts --xcodeproj --target --frameworks --podfile --cartfile --carthage-command --setting -s"
+    setup_opts="$setup_opts --test-configurations --no-test-configurations"
     # Don't autocomplete the default values here, e.g. --no-force, --pod-repo-update.
     setup_opts="$setup_opts --no-add-sdk --no-validate --force --no-pod-repo-update --commit --no-patch-source"
 

data/lib/assets/completions/completion.zsh

@@ -5,7 +5,8 @@ _branch_io_complete() {
   word="$1"
   opts="-h --help -t --trace -v --version"
   opts="$opts -L --live-key -T --test-key -D --domains --app-link-subdomain -U --uri-scheme"
-  opts="$opts --xcodeproj --target --frameworks --podfile --cartfile --carthage-command"
+  opts="$opts --xcodeproj --target --frameworks --podfile --cartfile --carthage-command --setting -s"
+  opts="$opts --test-configurations --no-test-configurations"
   # Don't autocomplete the default values here, e.g. --no-force, --pod-repo-update.
   opts="$opts --no-add-sdk --no-validate --force --no-pod-repo-update --commit --no-patch-source"
 

data/lib/branch_io_cli/cli.rb

@@ -77,6 +77,8 @@ EOF
         c.option "--app-link-subdomain myapp", String, "Branch app.link subdomain, e.g. myapp for myapp.app.link"
         c.option "-D", "--domains example.com,www.example.com", Array, "Comma-separated list of custom domain(s) or non-Branch domain(s)"
         c.option "-U", "--uri-scheme myurischeme[://]", String, "Custom URI scheme used in the Branch Dashboard for this app"
+        c.option "-s", "--setting [BRANCH_KEY_SETTING]", String, "Use a custom build setting for the Branch key (default: Use Info.plist)"
+        c.option "--[no-]test-configurations [config1,config2]", Array, "List of configurations that use the test key with a custom build setting (default: Debug configurations)"
 
         c.option "--xcodeproj MyProject.xcodeproj", String, "Path to an Xcode project to update"
         c.option "--target MyAppTarget", String, "Name of a target to modify in the Xcode project"
@@ -90,7 +92,7 @@ EOF
         c.option "--[no-]force", "Update project even if Universal Link validation fails (default: no)"
         c.option "--[no-]add-sdk", "Add the Branch framework to the project (default: yes)"
         c.option "--[no-]patch-source", "Add Branch SDK calls to the AppDelegate (default: yes)"
-        c.option "--[no-]commit", "Commit the results to Git (default: no)"
+        c.option "--[no-]commit [message]", String, "Commit the results to Git (default: no)"
 
         c.example "Test without validation (can use dummy keys and domains)", "branch_io setup -L key_live_xxxx -D myapp.app.link --no-validate"
         c.example "Use both live and test keys", "branch_io setup -L key_live_xxxx -T key_test_yyyy -D myapp.app.link"
@@ -169,7 +171,7 @@ EOF
         c.option "--[no-]clean", "Clean before attempting to build (default: yes)"
         c.option "-H", "--[no-]header-only", "Write a report header to standard output and exit"
         c.option "--[no-]pod-repo-update", "Update the local podspec repo before installing (default: yes)"
-        c.option "--out ./report.txt", String, "Report output path (default: ./report.txt)"
+        c.option "-o", "--out ./report.txt", String, "Report output path (default: ./report.txt)"
 
         c.action do |args, options|
           options.default(

data/lib/branch_io_cli/command/report_command.rb

@@ -7,7 +7,11 @@ module BranchIOCLI
         say "\n"
 
         say "Loading settings from Xcode"
-        if xcode_settings.valid?
+        # In case running in a non-CLI context (e.g., Rake or Fastlane) be sure
+        # to reset Xcode settings each time, since project, target and
+        # configurations will change.
+        Configuration::XcodeSettings.reset
+        if Configuration::XcodeSettings.all_valid?
           say "Done ✅"
         else
           say "Failed to load settings from Xcode. Some information may be missing.\n"
@@ -15,63 +19,66 @@ module BranchIOCLI
 
         if config.header_only
           say report_helper.report_header
-          exit 0
+          return
         end
 
-        File.open config.report_path, "w" do |report|
-          report.write "Branch.io Xcode build report v #{VERSION} #{DateTime.now}\n\n"
-          report.write "#{config.report_configuration}\n"
-          report.write "#{report_helper.report_header}\n"
+        if config.report_path == "stdout"
+          write_report STDOUT
+        else
+          File.open(config.report_path, "w") { |f| write_report f }
+          say "Report generated in #{config.report_path}"
+        end
+      end
+
+      def write_report(report)
+        report.write "Branch.io Xcode build report v #{VERSION} #{DateTime.now}\n\n"
+        report.write "#{config.report_configuration}\n"
+        report.write "#{report_helper.report_header}\n"
 
-          report_helper.pod_install_if_required report
+        report_helper.pod_install_if_required report
 
-          # run xcodebuild -list
-          report.log_command "#{report_helper.base_xcodebuild_cmd} -list"
+        # run xcodebuild -list
+        report.log_command "#{report_helper.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 #{Shellwords.escape path}"
-            end
+        # 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 #{Shellwords.escape path}"
           end
+        end
 
-          base_cmd = report_helper.base_xcodebuild_cmd
-          # Add more options for the rest of the commands
-          base_cmd += " -scheme #{Shellwords.escape config.scheme}"
-          base_cmd += " -configuration #{Shellwords.escape config.configuration}"
-          base_cmd += " -sdk #{Shellwords.escape config.sdk}"
+        # xcodebuild -showBuildSettings
+        config.configurations.each do |configuration|
+          Configuration::XcodeSettings[configuration].log_xcodebuild_showbuildsettings report
+        end
 
-          # xcodebuild -showBuildSettings
-          xcode_settings.log_xcodebuild_showbuildsettings report
+        base_cmd = report_helper.base_xcodebuild_cmd
+        # Add more options for the rest of the commands
+        base_cmd += " -scheme #{Shellwords.escape config.scheme}"
+        base_cmd += " -configuration #{Shellwords.escape(config.configuration || config.configurations_from_scheme.first)}"
+        base_cmd += " -sdk #{Shellwords.escape config.sdk}"
 
-          if config.clean
-            say "Cleaning"
-            if report.log_command("#{base_cmd} clean").success?
-              say "Done ✅"
-            else
-              say "Clean failed."
-            end
-          end
-
-          say "Building"
-          if report.log_command("#{base_cmd} -verbose").success?
+        if config.clean
+          say "Cleaning"
+          if report.log_command("#{base_cmd} clean").success?
             say "Done ✅"
           else
-            say "Build failed."
+            say "Clean failed."
           end
         end
 
-        say "Report generated in #{config.report_path}"
+        say "Building"
+        if report.log_command("#{base_cmd} -verbose").success?
+          say "Done ✅"
+        else
+          say "Build failed."
+        end
       end
 
       def report_helper
         Helper::ReportHelper
       end
-
-      def xcode_settings
-        Configuration::XcodeSettings.settings
-      end
     end
   end
 end

data/lib/branch_io_cli/command/setup_command.rb

@@ -30,18 +30,18 @@ module BranchIOCLI
           say "Universal Link configuration passed validation. ✅"
         end
 
-        if @keys.count > 1 && helper.has_multiple_info_plists? &&
-           !File.exist?(File.join(File.dirname(config.podfile_path), 'Pods'))
-          # Work around a potential crash for now. The PBXBuildConfiguration#debug?
-          # method may raise in this case.
+        if config.podfile_path && File.exist?(config.podfile_path) && config.pod_install_required?
           helper.verify_cocoapods
           say "Installing pods to resolve current build settings"
-          # We haven't modified anything yet. Don't use --repo-update at this stage.
-          # This is unlikely to fail.
-          sh "pod install"
+          Dir.chdir(File.dirname(config.podfile_path)) do
+            # We haven't modified anything yet. Don't use --repo-update at this stage.
+            # This is unlikely to fail.
+            sh "pod install"
+          end
         end
 
-        # the following calls can all raise IOError
+        helper.add_custom_build_setting if config.setting
+
         helper.add_keys_to_info_plist @keys
         helper.add_branch_universal_link_domains_to_info_plist @domains if is_app_target
         helper.ensure_uri_scheme_in_info_plist if is_app_target # does nothing if already present
@@ -76,7 +76,10 @@ module BranchIOCLI
 
         changes = helper.changes.to_a.map { |c| Pathname.new(File.expand_path(c)).relative_path_from(Pathname.pwd).to_s }
 
-        sh "git commit -qm '[branch_io_cli] Branch SDK integration' #{changes.join(' ')}"
+        commit_message = options.commit if options.commit.kind_of?(String)
+        commit_message ||= "[branch_io_cli] Branch SDK integration #{config.relative_path(config.xcodeproj_path)} (#{config.target.name})"
+
+        sh "git commit -qm #{Shellwords.escape commit_message} #{changes.join(' ')}"
       end
       # rubocop: enable Metrics/PerceivedComplexity
 

data/lib/branch_io_cli/configuration/configuration.rb

@@ -268,11 +268,11 @@ EOF
         setting == "YES"
       end
 
-      def bridging_header_path
+      def bridging_header_path(configuration = "Release")
         return @bridging_header_path if @bridging_header_path
 
         return nil unless target
-        path = helper.expanded_build_setting target, "SWIFT_OBJC_BRIDGING_HEADER", "Release"
+        path = helper.expanded_build_setting target, "SWIFT_OBJC_BRIDGING_HEADER", configuration
         return nil unless path
 
         @bridging_header_path = File.expand_path path, File.dirname(xcodeproj_path)
@@ -292,7 +292,11 @@ EOF
 
         source_files = target.source_build_phase.files.map { |f| f.file_ref.real_path.to_s }
         source_files << bridging_header_path if bridging_header_path
-        @branch_imports = source_files.compact.map { |f| { f => branch_imports_from_file(f) } }.inject({}, :merge)
+        @branch_imports = source_files.compact.map do |f|
+          imports = branch_imports_from_file f
+          next {} if imports.empty?
+          { f => imports }
+        end.inject({}, :merge)
         @branch_imports
       end
 

data/lib/branch_io_cli/configuration/report_configuration.rb

@@ -51,10 +51,6 @@ module BranchIOCLI
       attr_reader :report_path
       attr_reader :sdk
 
-      def xcode_settings
-        XcodeSettings.settings
-      end
-
       def validate_options
         @clean = options.clean
         @header_only = options.header_only
@@ -105,7 +101,7 @@ EOF
 <%= color('Xcode project:', BOLD) %> #{xcodeproj_path || '(none)'}
 <%= color('Scheme:', BOLD) %> #{scheme || '(none)'}
 <%= color('Target:', BOLD) %> #{target || '(none)'}
-<%= color('Configuration:', BOLD) %> #{configuration}
+<%= 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)'}
@@ -265,11 +261,13 @@ EOF
       end
 
       def validate_configuration(options)
+        return unless options.configuration
+
         all_configs = xcodeproj.build_configurations.map(&:name)
 
-        if options.configuration && all_configs.include?(options.configuration)
+        if all_configs.include?(options.configuration)
           @configuration = options.configuration
-        elsif options.configuration
+        else
           say "Configuration #{options.configuration} not found."
           @configuration = choose do |menu|
             menu.header = "Configurations from project"
@@ -277,14 +275,15 @@ EOF
             menu.prompt = "Please choose one of the above. "
           end
         end
+      end
 
-        return if @configuration
-
-        @configuration = "Debug" # Usual default for the launch action
-
-        return unless xcscheme
+      def configurations
+        configuration ? [configuration] : configurations_from_scheme
+      end
 
-        @configuration = xcscheme.launch_action.build_configuration
+      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
 
       def branch_version
@@ -335,17 +334,18 @@ EOF
         "#{version} [Cartfile.resolved]"
       end
 
-      def version_from_branch_framework
+      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(config.xcodeproj_path)
+          project_path = relative_path(xcodeproj_path)
           framework_path = framework.file_ref.real_path
-        elsif framework.file_ref.isa == "PBXReferenceProxy" && xcode_settings
+        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, xcode_settings[framework.file_ref.source_tree]
+          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
 
@@ -377,6 +377,19 @@ EOF
         version = matches[1]
         "#{version} [BNCConfig.m:#{relative_path project.path}]"
       end
+
+      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 = helper.expanded_build_setting target, "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
     end
   end
 end

data/lib/branch_io_cli/configuration/setup_configuration.rb

@@ -20,6 +20,8 @@ module BranchIOCLI
       attr_reader :force
       attr_reader :patch_source
       attr_reader :commit
+      attr_reader :setting
+      attr_reader :test_configurations
 
       def validate_options
         @validate = options.validate
@@ -39,6 +41,8 @@ module BranchIOCLI
         validate_keys_from_setup_options options
         validate_all_domains options, !target.extension_target_type?
         validate_uri_scheme options
+        validate_setting options
+        validate_test_configurations options
 
         # If neither --podfile nor --cartfile is present, arbitrarily look for a Podfile
         # first.
@@ -63,6 +67,20 @@ module BranchIOCLI
 <%= 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)'}
@@ -241,6 +259,40 @@ module BranchIOCLI
           @carthage_command = options.carthage_command
         end
       end
+
+      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
+
+      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
     end
   end
 end

data/lib/branch_io_cli/configuration/xcode_settings.rb

@@ -5,14 +5,30 @@ module BranchIOCLI
   module Configuration
     class XcodeSettings
       class << self
-        def settings
-          return @settings if @settings
-          @settings = self.new
-          @settings
+        def all_valid?
+          Configuration.current.configurations.map { |c| settings(c) }.all?(&:valid?)
+        end
+
+        def [](configuration)
+          settings configuration
+        end
+
+        def settings(configuration = Configuration.current.configurations.first)
+          return @settings[configuration] if @settings && @settings[configuration]
+          @settings ||= {}
+
+          @settings[configuration] = self.new configuration
+        end
+
+        def reset
+          @settings = {}
         end
       end
 
-      def initialize
+      attr_reader :configuration
+
+      def initialize(configuration)
+        @configuration = configuration
         load_settings_from_xcode
       end
 
@@ -30,11 +46,11 @@ module BranchIOCLI
 
       def xcodebuild_cmd
         cmd = "xcodebuild"
-        cmd = "#{cmd} -project #{Shellwords.escape config.xcodeproj_path}"
+        cmd += " -showBuildSettings"
+        cmd += " -project #{Shellwords.escape config.xcodeproj_path}"
         cmd += " -target #{Shellwords.escape config.target.name}"
-        cmd += " -configuration #{Shellwords.escape config.configuration}"
         cmd += " -sdk #{Shellwords.escape config.sdk}"
-        cmd += " -showBuildSettings"
+        cmd += " -configuration #{Shellwords.escape configuration}"
         cmd
       end
 
@@ -53,7 +69,12 @@ module BranchIOCLI
       end
 
       def log_xcodebuild_showbuildsettings(report = STDOUT)
-        report.write "$ #{xcodebuild_cmd}\n\n"
+        if report == STDOUT
+          say "<%= color('$ #{xcodebuild_cmd}', [MAGENTA, BOLD]) %>\n\n"
+        else
+          report.write "$ #{xcodebuild_cmd}\n\n"
+        end
+
         report.write @xcodebuild_showbuildsettings_output
         if valid?
           report.write "Success.\n\n"

data/lib/branch_io_cli/helper/ios_helper.rb

@@ -32,13 +32,31 @@ module BranchIOCLI
         end.uniq.count > 1
       end
 
+      def uses_test_key?(build_configuration)
+        return build_configuration.debug? unless config.setting && config.test_configurations
+        config.test_configurations.include? build_configuration.name
+      end
+
+      def add_custom_build_setting
+        return unless config.setting
+
+        config.target.build_configurations.each do |c|
+          key = uses_test_key?(c) ? config.keys[:test] : config.keys[:live]
+          # Reuse the same key if both not present
+          key ||= uses_test_key?(c) ? config.keys[:live] : config.keys[:test]
+          c.build_settings[config.setting] = key
+        end
+      end
+
       def add_keys_to_info_plist(keys)
         if has_multiple_info_plists?
           config.xcodeproj.build_configurations.each do |c|
             update_info_plist_setting c.name do |info_plist|
-              if keys.count > 1
+              if keys.count > 1 && !config.setting
                 # Use test key in debug configs and live key in release configs
                 info_plist["branch_key"] = c.debug? ? keys[:test] : keys[:live]
+              elsif config.setting
+                info_plist["branch_key"] = "$(#{config.setting})"
               else
                 info_plist["branch_key"] = keys[:live] ? keys[:live] : keys[:test]
               end
@@ -47,8 +65,10 @@ module BranchIOCLI
         else
           update_info_plist_setting RELEASE_CONFIGURATION do |info_plist|
             # add/overwrite Branch key(s)
-            if keys.count > 1
+            if keys.count > 1 && !config.setting
               info_plist["branch_key"] = keys
+            elsif config.setting
+              info_plist["branch_key"] = "$(#{config.setting})"
             elsif keys[:live]
               info_plist["branch_key"] = keys[:live]
             else

data/lib/branch_io_cli/helper/patch_helper.rb

@@ -23,7 +23,7 @@ module BranchIOCLI
         end
 
         def use_conditional_test_key?
-          config.keys.count > 1 && !helper.has_multiple_info_plists?
+          config.keys.count > 1 && config.setting.nil? && !helper.has_multiple_info_plists?
         end
 
         def swift_file_includes_branch?(path)

data/lib/branch_io_cli/helper/report_helper.rb

@@ -38,6 +38,13 @@ module BranchIOCLI
           cmd
         end
 
+        def report_scheme
+          report = "\nScheme #{config.scheme}:\n"
+          report += " Configurations:\n"
+          report += "  #{config.configurations_from_scheme.join("\n  ")}\n"
+          report
+        end
+
         # rubocop: disable Metrics/PerceivedComplexity
         def report_header
           header = "cocoapods-core: #{Pod::CORE_VERSION}\n"
@@ -45,10 +52,14 @@ module BranchIOCLI
           header += `xcodebuild -version`
           header += "SDK: #{xcode_settings['SDK_NAME']}\n" if xcode_settings
 
-          bundle_identifier = helper.expanded_build_setting config.target, "PRODUCT_BUNDLE_IDENTIFIER", config.configuration
-          dev_team = helper.expanded_build_setting config.target, "DEVELOPMENT_TEAM", config.configuration
-          infoplist_path = helper.expanded_build_setting config.target, "INFOPLIST_FILE", config.configuration
-          entitlements_path = helper.expanded_build_setting config.target, "CODE_SIGN_ENTITLEMENTS", config.configuration
+          header += report_scheme
+
+          configuration = config.configuration || config.configurations_from_scheme.first
+          configurations = config.configuration ? [config.configuration] : config.configurations_from_scheme
+
+          bundle_identifier = helper.expanded_build_setting config.target, "PRODUCT_BUNDLE_IDENTIFIER", configuration
+          dev_team = helper.expanded_build_setting config.target, "DEVELOPMENT_TEAM", configuration
+          entitlements_path = helper.expanded_build_setting config.target, "CODE_SIGN_ENTITLEMENTS", configuration
 
           header += "\nTarget #{config.target.name}:\n"
           header += " Bundle identifier: #{bundle_identifier || '(none)'}\n"
@@ -57,7 +68,12 @@ module BranchIOCLI
           header += " Modules #{config.modules_enabled? ? '' : 'not '}enabled\n"
           header += " Swift #{config.swift_version}\n" if config.swift_version
           header += " Bridging header: #{config.relative_path(config.bridging_header_path)}\n" if config.bridging_header_path
-          header += " Info.plist: #{config.relative_path(infoplist_path) || '(none)'}\n"
+
+          header += " Info.plist\n"
+          configurations.each do |c|
+            header += "  #{c}: #{helper.expanded_build_setting config.target, 'INFOPLIST_FILE', c}\n"
+          end
+
           header += " Entitlements file: #{config.relative_path(entitlements_path) || '(none)'}\n"
 
           if config.podfile_path
@@ -121,53 +137,66 @@ module BranchIOCLI
             header += "\nBranch SDK not found.\n"
           end
 
-          header += "\n#{branch_report}"
+          header += "\n#{report_branch}"
 
           header
         end
         # rubocop: enable Metrics/PerceivedComplexity
 
         # String containing information relevant to Branch setup
-        def branch_report
-          infoplist_path = helper.expanded_build_setting config.target, "INFOPLIST_FILE", config.configuration
-          infoplist_path = File.expand_path infoplist_path, File.dirname(config.xcodeproj_path)
-
+        def report_branch
           report = "Branch configuration:\n"
 
-          begin
-            info_plist = File.open(infoplist_path) { |f| Plist.parse_xml f }
-            branch_key = info_plist["branch_key"]
-            report += " Branch key(s) (Info.plist):\n"
-            if branch_key.kind_of? Hash
-              branch_key.each_key do |key|
-                resolved_key = helper.expand_build_settings branch_key[key], config.target, config.configuration
-                report += "  #{key.capitalize}: #{resolved_key}\n"
+          configurations = config.configuration ? [config.configuration] : config.configurations_from_scheme
+
+          configurations.each do |configuration|
+            report += " #{configuration}:\n"
+            infoplist_path = helper.expanded_build_setting config.target, "INFOPLIST_FILE", configuration
+            infoplist_path = File.expand_path infoplist_path, File.dirname(config.xcodeproj_path)
+
+            begin
+              info_plist = File.open(infoplist_path) { |f| Plist.parse_xml f }
+              branch_key = info_plist["branch_key"]
+              if config.branch_key_setting_from_info_plist(configuration)
+                annotation = "[#{File.basename infoplist_path}:$(#{config.branch_key_setting_from_info_plist})]"
+              else
+                annotation = "(#{File.basename infoplist_path})"
               end
-            elsif branch_key
-              resolved_key = helper.expand_build_settings branch_key, config.target, config.configuration
-              report += "  #{resolved_key}\n"
-            else
-              report += "  (none found)\n"
-            end
 
-            branch_universal_link_domains = info_plist["branch_universal_link_domains"]
-            if branch_universal_link_domains
-              if branch_universal_link_domains.kind_of? Array
-                report += " branch_universal_link_domains (Info.plist):\n"
-                branch_universal_link_domains.each do |domain|
-                  report += "  #{domain}\n"
+              report += "  Branch key(s) #{annotation}:\n"
+              if branch_key.kind_of? Hash
+                branch_key.each_key do |key|
+                  resolved_key = helper.expand_build_settings branch_key[key], config.target, configuration
+                  report += "   #{key.capitalize}: #{resolved_key}\n"
                 end
+              elsif branch_key
+                resolved_key = helper.expand_build_settings branch_key, config.target, configuration
+                report += "   #{resolved_key}\n"
               else
-                report += " branch_universal_link_domains (Info.plist): #{branch_universal_link_domains}\n"
+                report += "   (none found)\n"
               end
+
+              branch_universal_link_domains = info_plist["branch_universal_link_domains"]
+              if branch_universal_link_domains
+                if branch_universal_link_domains.kind_of? Array
+                  report += "  branch_universal_link_domains (Info.plist):\n"
+                  branch_universal_link_domains.each do |domain|
+                    report += "   #{domain}\n"
+                  end
+                else
+                  report += "  branch_universal_link_domains (Info.plist): #{branch_universal_link_domains}\n"
+                end
+              end
+            rescue StandardError => e
+              report += "  (Failed to open Info.plist: #{e.message})\n"
             end
-          rescue StandardError => e
-            report += " (Failed to open Info.plist: #{e.message})\n"
           end
 
           unless config.target.extension_target_type?
             begin
-              domains = helper.domains_from_project config.configuration
+              # This isn't likely to vary by configuration, so just report for one, either
+              # whatever was passed or Release.
+              domains = helper.domains_from_project config.configuration || config.configurations_from_scheme.first
               report += " Universal Link domains (entitlements):\n"
               domains.each do |domain|
                 report += "  #{domain}\n"

data/lib/branch_io_cli/rake_task.rb

@@ -0,0 +1,88 @@
+require "rake"
+require "rake/tasklib"
+require "branch_io_cli"
+require "highline/import"
+
+module BranchIOCLI
+  class RakeTask < Rake::TaskLib
+    ReportOptions = Struct.new(
+      :cartfile,
+      :clean,
+      :configuration,
+      :header_only,
+      :out,
+      :pod_repo_update,
+      :podfile,
+      :scheme,
+      :sdk,
+      :target,
+      :xcodeproj,
+      :workspace
+    )
+
+    attr_reader :defaults
+
+    def initialize(defaults = {}, &b)
+      @defaults = defaults
+      @defaults[:report] ||= {}
+
+      namespace :branch do
+        report_task
+      end
+    end
+
+    def report_task
+      desc "Generate a brief Branch report"
+      task :report, %i{paths options} do |task, args|
+        paths = args[:paths]
+        paths = [paths] unless paths.respond_to?(:each)
+
+        paths.each do |path|
+          Dir.chdir(path) do |p|
+            Command::ReportCommand.new(report_options(args[:options])).run!
+          end
+        end
+      end
+    end
+
+    # rubocop: disable Metrics/PerceivedComplexity
+    def report_options(options)
+      options ||= {}
+      defs = defaults[:report]
+
+      if options[:clean].nil? && defs[:clean].nil?
+        clean = true
+      else
+        clean = options[:clean] || defs[:clean]
+      end
+
+      if options[:pod_repo_update].nil? && defs[:pod_repo_update].nil?
+        repo_update = true
+      else
+        repo_update = options[:pod_repo_update] || defs[:pod_repo_update]
+      end
+
+      if options[:header_only].nil? && defs[:header_only].nil?
+        header_only = false
+      else
+        header_only = options[:header_only] || defs[:header_only]
+      end
+
+      ReportOptions.new(
+        options[:cartfile] || defs[:cartfile],
+        clean,
+        options[:configuration] || defs[:configuration],
+        header_only,
+        options[:out] || defs[:out] || "./report.txt",
+        repo_update,
+        options[:podfile] || defs[:podfile],
+        options[:scheme] || defs[:scheme],
+        options[:sdk] || defs[:sdk] || "iphonesimulator",
+        options[:target] || defs[:target],
+        options[:xcodeproj] || defs[:xcodeproj],
+        options[:workspace] || defs[:workspace]
+      )
+    end
+    # rubocop: enable Metrics/PerceivedComplexity
+  end
+end

data/lib/branch_io_cli/version.rb

@@ -1,3 +1,3 @@
 module BranchIOCLI
-  VERSION = "0.9.9"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch_io_cli
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 0.10.0
 platform: ruby
 authors:
 - Branch
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2017-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
@@ -310,6 +310,7 @@ files:
 - lib/branch_io_cli/helper/methods.rb
 - lib/branch_io_cli/helper/patch_helper.rb
 - lib/branch_io_cli/helper/report_helper.rb
+- lib/branch_io_cli/rake_task.rb
 - lib/branch_io_cli/version.rb
 homepage: http://github.com/BranchMetrics/branch_io_cli
 licenses: