branch_io_cli 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9adda8f92100e01cd272fa97fe2bf8b71db6b664
-  data.tar.gz: c91ec03d311711ea448aec62ffa1db6f1f401e77
+  metadata.gz: 334a3a4f55aeb27b4a683036fb8c26c576c93e0e
+  data.tar.gz: 74ea173bc48c7eedd4868098612064ec6369a21c
 SHA512:
-  metadata.gz: 3ce717958b072775a9fbd789c249c23a80972ba8fe45cd2a546074d03b2b019d9fa6fdc2a580539193abe289579470617db34d7a46e8d7a396b30c4d6cbe7325
-  data.tar.gz: 84a1f6ef67c575e34c31c9306eeb62aea5858bf3005d7990769d5eba1bc8e4adbcdaa3561aca91cf4324b008a3d0114cefc049b9693e0ba704b649320cc054ab
+  metadata.gz: 49ff44e9f2aa8c44a9df062ce6a650682823c278028aa1ad6be2488d0c6ca603fe8baf60ce8bc23b7c5c316a9339b58d51682a9909e88eb2448c57f02f43f962
+  data.tar.gz: 6efb3a1bf7349f0b8772ef5e6f03e34b5fcd834004eef6799bcbf5de2eb4b4a719fcf3f549fa77304409d528e09ecc300d04475ec839b3bb681452608b04d855

data/README.md

@@ -41,25 +41,30 @@ branch_io setup
 Integrates the Branch SDK into a native app project. This currently supports iOS only.
 It will infer the project location if there is exactly one .xcodeproj anywhere under
 the current directory, excluding any in a Pods or Carthage folder. Otherwise, specify
-the project location using the `--xcodeproj` option.
+the project location using the `--xcodeproj` option, or the CLI will prompt you for the
+location.
 
 If a Podfile or Cartfile is detected, the Branch SDK will be added to the relevant
 configuration file and the dependencies updated to include the Branch framework.
 This behavior may be suppressed using `--no_add_sdk`. If no Podfile or Cartfile
 is found, and Branch.framework is not already among the project's dependencies,
-you will be prompted for a number of choices.
+you will be prompted for a number of choices, including setting up CocoaPods or
+Carthage for the project or directly installing the Branch.framework.
 
 By default, all supplied Universal Link domains are validated. If validation passes,
 the setup continues. If validation fails, no further action is taken. Suppress
 validation using `--no_validate` or force changes when validation fails using
 `--force`.
 
-All relevant project settings are modified. The Branch keys are added to the Info.plist,
+By default, this command will look for the first app target in the project. Test
+targets are not supported. To set up an extension target, supply the `--target` option.
+
+All relevant target settings are modified. The Branch keys are added to the Info.plist,
 along with the `branch_universal_link_domains` key for custom domains (when `--domains`
-is used). All domains are added to the project's Associated Domains entitlements.
-An entitlements file is added if none is found. Optionally, if `--frameworks` is
-specified, this command can add a list of system frameworks to the project (e.g.,
-AdSupport, CoreSpotlight, SafariServices).
+is used). For app targets, all domains are added to the project's Associated Domains
+entitlement. An entitlements file is also added for app targets if none is found.
+Optionally, if `--frameworks` is specified, this command can add a list of system
+frameworks to the target's dependencies (e.g., AdSupport, CoreSpotlight, SafariServices).
 
 A language-specific patch is applied to the AppDelegate (Swift or Objective-C).
 This can be suppressed using `--no_patch_source`.
@@ -114,6 +119,10 @@ signing team identifiers in the project as well as the app's Associated Domains.
 It requests the apple-app-site-association file for each domain and validates
 the file against the project's settings.
 
+Only app targets are supported for this command. By default, it will validate the first.
+If your project has multiple app targets, specify the <%= color('--target', BOLD) %> option to validate other
+targets.
+
 #### Options
 
 |Option|Description|

data/lib/branch_io_cli/cli.rb

@@ -20,25 +20,30 @@ EOF
 Integrates the Branch SDK into a native app project. This currently supports iOS only.
 It will infer the project location if there is exactly one .xcodeproj anywhere under
 the current directory, excluding any in a Pods or Carthage folder. Otherwise, specify
-the project location using the <%= color('--xcodeproj', BOLD) %> option.
+the project location using the <%= color('--xcodeproj', BOLD) %> option, or the CLI will prompt you for the
+location.
 
 If a Podfile or Cartfile is detected, the Branch SDK will be added to the relevant
 configuration file and the dependencies updated to include the Branch framework.
 This behavior may be suppressed using <%= color('--no_add_sdk', BOLD) %>. If no Podfile or Cartfile
 is found, and Branch.framework is not already among the project's dependencies,
-you will be prompted for a number of choices.
+you will be prompted for a number of choices, including setting up CocoaPods or
+Carthage for the project or directly installing the Branch.framework.
 
 By default, all supplied Universal Link domains are validated. If validation passes,
 the setup continues. If validation fails, no further action is taken. Suppress
 validation using <%= color('--no_validate', BOLD) %> or force changes when validation fails using
 <%= color('--force', BOLD) %>.
 
-All relevant project settings are modified. The Branch keys are added to the Info.plist,
+By default, this command will look for the first app target in the project. Test
+targets are not supported. To set up an extension target, supply the <%= color('--target', BOLD) %> option.
+
+All relevant target settings are modified. The Branch keys are added to the Info.plist,
 along with the <%= color('branch_universal_link_domains', BOLD) %> key for custom domains (when <%= color('--domains', BOLD) %>
-is used). All domains are added to the project's Associated Domains entitlements.
-An entitlements file is added if none is found. Optionally, if <%= color('--frameworks', BOLD) %> is
-specified, this command can add a list of system frameworks to the project (e.g.,
-AdSupport, CoreSpotlight, SafariServices).
+is used). For app targets, all domains are added to the project's Associated Domains
+entitlement. An entitlements file is also added for app targets if none is found.
+Optionally, if <%= color('--frameworks', BOLD) %> is specified, this command can add a list of system
+frameworks to the target's dependencies (e.g., AdSupport, CoreSpotlight, SafariServices).
 
 A language-specific patch is applied to the AppDelegate (Swift or Objective-C).
 This can be suppressed using <%= color('--no_patch_source', BOLD) %>.
@@ -94,17 +99,22 @@ EOF
         c.syntax = "branch_io validate [OPTIONS]"
         c.summary = "Validates all Universal Link domains configured in a project"
         c.description = <<EOF
-This command validates all Universal Link domains configured in a project without making any modification.
-It validates both Branch and non-Branch domains. Unlike web-based Universal Link validators,
-this command operates directly on the project. It finds the bundle and
-signing team identifiers in the project as well as the app's Associated Domains.
-It requests the apple-app-site-association file for each domain and validates
-the file against the project's settings.
-
-All parameters are optional. If <%= color('--domains', BOLD) %> is specified, the list of Universal Link domains in the
-Associated Domains entitlement must exactly match this list, without regard to order. If no <%= color('--domains', BOLD) %>
-are provided, validation passes if at least one Universal Link domain is configured and passes validation,
-and no Universal Link domain is present that does not pass validation.
+This command validates all Universal Link domains configured in a project without making any
+modification. It validates both Branch and non-Branch domains. Unlike web-based Universal
+Link validators, this command operates directly on the project. It finds the bundle and
+signing team identifiers in the project as well as the app's Associated Domains. It requests
+the apple-app-site-association file for each domain and validates the file against the
+project's settings.
+
+Only app targets are supported for this command. By default, it will validate the first.
+If your project has multiple app targets, specify the <%= color('--target', BOLD) %> option to validate other
+targets.
+
+All parameters are optional. If <%= color('--domains', BOLD) %> is specified, the list of Universal Link domains in
+the Associated Domains entitlement must exactly match this list, without regard to order. If
+no <%= color('--domains', BOLD) %> are provided, validation passes if at least one Universal Link domain is
+configured and passes validation, and no Universal Link domain is present that does not pass
+validation.
 
 See https://github.com/BranchMetrics/branch_io_cli#validate-command for more information.
 EOF

data/lib/branch_io_cli/command.rb

@@ -14,24 +14,25 @@ module BranchIOCLI
 
         update_podfile(options) || update_cartfile(options, xcodeproj)
 
-        target = options.target # may be nil
+        target_name = options.target # may be nil
+        is_app_target = !Helper::ConfigurationHelper.target.extension_target_type?
 
-        if !options.no_validate &&
-           !helper.validate_team_and_bundle_ids_from_aasa_files(xcodeproj, target, @domains)
+        if is_app_target && !options.no_validate &&
+           !helper.validate_team_and_bundle_ids_from_aasa_files(xcodeproj, target_name, @domains)
           say "Universal Link configuration failed validation."
           helper.errors.each { |error| say " #{error}" }
           return unless options.force
-        elsif !options.no_validate
+        elsif is_app_target && !options.no_validate
           say "Universal Link configuration passed validation. ✅"
         end
 
         # the following calls can all raise IOError
-        helper.add_keys_to_info_plist xcodeproj, target, @keys
-        helper.add_branch_universal_link_domains_to_info_plist xcodeproj, target, @domains
-        new_path = helper.add_universal_links_to_project xcodeproj, target, @domains, false
+        helper.add_keys_to_info_plist xcodeproj, target_name, @keys
+        helper.add_branch_universal_link_domains_to_info_plist xcodeproj, target_name, @domains if is_app_target
+        new_path = helper.add_universal_links_to_project xcodeproj, target_name, @domains, false if is_app_target
         `git add #{new_path}` if options.commit && new_path
 
-        helper.add_system_frameworks xcodeproj, target, options.frameworks unless options.frameworks.nil? || options.frameworks.empty?
+        helper.add_system_frameworks xcodeproj, target_name, options.frameworks unless options.frameworks.nil? || options.frameworks.empty?
 
         xcodeproj.save
 
@@ -143,7 +144,7 @@ module BranchIOCLI
         # 4. Add to target depependencies
         frameworks_group = project.frameworks_group
         branch_framework = frameworks_group.new_file "Carthage/Build/iOS/Branch.framework"
-        target = helper.target_from_project project, options.target
+        target = ConfigurationHelper.target
         target.frameworks_build_phase.add_file_reference branch_framework
 
         # 5. Add to copy-frameworks build phase

data/lib/branch_io_cli/helper/configuration_helper.rb

@@ -6,28 +6,77 @@ require "zip"
 
 module BranchIOCLI
   module Helper
+    # rubocop: disable Metrics/ClassLength
     class ConfigurationHelper
       class << self
+        APP_LINK_REGEXP = /\.app\.link$|\.test-app\.link$/
+
         attr_accessor :xcodeproj_path
         attr_accessor :xcodeproj
         attr_accessor :keys
         attr_accessor :all_domains
         attr_accessor :podfile_path
         attr_accessor :cartfile_path
+        attr_accessor :target
 
         def validate_setup_options(options)
+          print_identification "setup"
+
           say "--force is ignored when --no_validate is used." if options.no_validate && options.force
 
           validate_xcodeproj_path options
+          validate_target options
           validate_keys_from_setup_options options
-          validate_all_domains options
+          validate_all_domains options, !@target.extension_target_type?
           validate_buildfile_path options, "Podfile"
           validate_buildfile_path options, "Cartfile"
+
+          print_setup_configuration
+
           validate_sdk_addition options
         end
 
         def validate_validation_options(options)
+          print_identification "validate"
+
           validate_xcodeproj_path options
+          validate_target options, false
+
+          print_validation_configuration
+        end
+
+        def print_identification(command)
+          say <<EOF
+
+<%= color("branch_io #{command} v. #{VERSION}", BOLD) %>
+
+EOF
+        end
+
+        def print_setup_configuration
+          say <<EOF
+
+<%= color('Configuration:', BOLD) %>
+
+<%= color('Xcode project:', BOLD) %> #{@xcodeproj_path}
+<%= color('Target:', BOLD) %> #{@target.name}
+<%= color('Live key:', BOLD) %> #{@keys[:live] || '(none)'}
+<%= color('Test key:', BOLD) %> #{@keys[:test] || '(none)'}
+<%= color('Domains:', BOLD) %> #{@all_domains}
+<%= color('Podfile:', BOLD) %> #{@podfile_path || '(none)'}
+<%= color('Cartfile:', BOLD) %> #{@cartfile_path || '(none)'}
+
+EOF
+        end
+
+        def print_validation_configuration
+          say <<EOF
+<%= color('Configuration:', BOLD) %>
+
+<%= color('Xcode project:', BOLD) %> #{@xcodeproj_path}
+<%= color('Target:', BOLD) %> #{@target.name}
+<%= color('Domains:', BOLD) %> #{@all_domains}
+EOF
         end
 
         def validate_keys_from_setup_options(options)
@@ -47,13 +96,26 @@ module BranchIOCLI
           end
         end
 
-        def validate_all_domains(options)
-          app_link_subdomains = app_link_subdomains options
-          custom_domains = options.domains || []
+        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_roots now contains options.app_link_subdomain, if supplied, and the roots of any
+          # .app.link or .test-app.link domains provided via options.domains.
+
+          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 @all_domains.empty?
-            @all_domains = ask "Please enter domains as a comma-separated list: ", ->(str) { str.split "," }
+          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
 
@@ -92,13 +154,54 @@ module BranchIOCLI
           end
         end
 
-        def app_link_subdomains(options)
-          app_link_subdomain = options.app_link_subdomain
-          live_key = options.live_key
-          test_key = options.test_key
-          return [] if live_key.nil? and test_key.nil?
+        def validate_target(options, allow_extensions = true)
+          non_test_targets = @xcodeproj.targets.reject(&:test_target_type?)
+          raise "No non-test target found in project" if non_test_targets.empty?
+
+          valid_targets = non_test_targets.reject { |t| !allow_extensions && t.extension_target_type? }
+
+          begin
+            target = BranchHelper.target_from_project @xcodeproj, options.target
+
+            # If a test target was explicitly specified.
+            raise "Cannot use test targets" if target.test_target_type?
+
+            # If an extension target was explicitly specified for validation.
+            raise "Extension targets not allowed for this command" if !allow_extensions && target.extension_target_type?
+
+            @target = target
+          rescue StandardError => e
+            say e.message
+
+            choice = choose do |menu|
+              valid_targets.each { |t| menu.choice t.name }
+              menu.prompt = "Which target do you wish to use? "
+            end
+
+            @target = @xcodeproj.targets.find { |t| t.name = choice }
+          end
+        end
+
+        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
+
+        def custom_domains_from_domains(domains)
+          return [] if domains.nil?
+          domains.reject { |d| d =~ APP_LINK_REGEXP }.uniq
+        end
+
+        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 += [
@@ -115,6 +218,17 @@ module BranchIOCLI
           domains
         end
 
+        def app_link_subdomains_from_roots(roots)
+          roots.inject([]) { |domains, root| domains + app_link_subdomains(root) }
+        end
+
+        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
+
         def validate_buildfile_path(options, filename)
           # Disable Podfile/Cartfile update if --no_add_sdk is present
           return if options.no_add_sdk
@@ -364,4 +478,5 @@ EOF
       end
     end
   end
+  # rubocop enable: Metrics/ClassLength
 end

data/lib/branch_io_cli/version.rb

@@ -1,3 +1,3 @@
 module BranchIOCLI
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch_io_cli
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Branch
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2017-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander