branch_io_cli 0.12.2 → 0.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fdec6cc2dfb747d21b5289bb907cdc3a0726d9b09cc489e7fa1d345da843745
-  data.tar.gz: af5b660dceb286f2f0d2b923944cfd447812d2be25243dfeef4beabbabf68a4c
+  metadata.gz: 2e5aed004a45c8ab9ba1551d603e972affbc07660351c1495d378e9d08492452
+  data.tar.gz: 54786f9bcb72a71855dab1575482a964b26779c6a3b6fd4a8053cbe553c33507
 SHA512:
-  metadata.gz: c134396f2768b91d8a157967f524136cd10a4d3b4b8358ce15830a6c99250af358fdb606c7192092dda158bed11d69ca94d9a9dcd30b78985e325ee9155514ba
-  data.tar.gz: 734523ffb51d4615e456056b81f8ecdff2c73278970f1114487a7b9765ba32a94348d1921d6c2148374d94796f411f98800a599ebd1f7b95efa346000fd4d9da
+  metadata.gz: 434932c0f1da70515c63b5d069a2171ea5bac2109cd47ad405b3a057a98bad4a145c52316616a12ff31bd8cff84761373ea47e5b51b918160070f9c3c418ae36
+  data.tar.gz: 4cfdc82ca1e78119bb0e3fa9a1d1a5c0b82eba4e38292f443aee726900e6f709cde5f22959aebf60637bee42ede08d00a81d0bc57a1ac9a025ca1dab0ed90185

data/lib/branch_io_cli/cli.rb

@@ -61,7 +61,7 @@ module BranchIOCLI
 
     def class_for_command(name, type)
       type_name = type.to_s.capitalize
-      type_module = Object.const_get("BranchIOCLI").const_get(type_name)
+      type_module = BranchIOCLI.const_get(type_name)
       candidate = type_module.const_get("#{name.to_s.capitalize}#{type_name}")
       return nil unless candidate
 

data/lib/branch_io_cli/command/command.rb

@@ -10,9 +10,7 @@ module BranchIOCLI
         def configuration_class
           root = command_name.capitalize
 
-          Object.const_get("BranchIOCLI")
-                .const_get("Configuration")
-                .const_get("#{root}Configuration")
+          BranchIOCLI::Configuration.const_get("#{root}Configuration")
         end
 
         def available_options
@@ -47,6 +45,10 @@ module BranchIOCLI
       def patch_helper
         Helper::PatchHelper
       end
+
+      def tool_helper
+        Helper::ToolHelper
+      end
     end
   end
 end

data/lib/branch_io_cli/command/report_command.rb

@@ -40,13 +40,13 @@ module BranchIOCLI
         report_helper.pod_install_if_required report
 
         # run xcodebuild -list
-        report.log_command "#{report_helper.base_xcodebuild_cmd} -list"
+        report.sh(*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", path]
+            report.sh "xcodebuild", "-list", "-project", path
           end
         end
 
@@ -57,13 +57,18 @@ module BranchIOCLI
 
         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}"
+        base_cmd += [
+          "-scheme",
+          config.scheme,
+          "-configuration",
+          config.configuration || config.configurations_from_scheme.first,
+          "-sdk",
+          config.sdk
+        ]
 
         if config.clean
           say "Cleaning"
-          if report.log_command("#{base_cmd} clean").success?
+          if report.sh(*base_cmd, "clean").success?
             say "Done ✅"
           else
             say "Clean failed."
@@ -71,7 +76,7 @@ module BranchIOCLI
         end
 
         say "Building"
-        if report.log_command("#{base_cmd} -verbose").success?
+        if report.sh(*base_cmd, "-verbose").success?
           say "Done ✅"
         else
           say "Build failed."

data/lib/branch_io_cli/command/setup_command.rb

@@ -11,103 +11,119 @@ module BranchIOCLI
         @domains = config.all_domains
       end
 
-      # rubocop: disable Metrics/PerceivedComplexity
       def run!
         # Make sure the user stashes or commits before continuing.
-        check_repo_status
+        return 1 unless check_repo_status
 
-        xcodeproj = config.xcodeproj
-
-        is_app_target = !config.target.extension_target_type?
-
-        if is_app_target && config.validate &&
-           !helper.validate_team_and_bundle_ids_from_aasa_files(@domains)
-          say "Universal Link configuration failed validation."
-          helper.errors.each { |error| say " #{error}" }
-          return 1 unless config.force
-        elsif is_app_target && config.validate
-          say "Universal Link configuration passed validation. ✅"
+        # Validate Universal Link configuration in an application target.
+        if config.validate && config.target.symbol_type == :application
+          valid = validate_universal_links
+          return 1 unless valid || config.force
         end
 
+        # Make sure we can resolve all build settings in a project using
+        # CocoaPods.
         if config.podfile_path && File.exist?(config.podfile_path) && config.pod_install_required?
-          helper.verify_cocoapods
+          tool_helper.verify_cocoapods
           say "Installing pods to resolve current build settings"
-          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
+          # We haven't modified anything yet. Don't use --repo-update at this stage.
+          # This is unlikely to fail.
+          sh "pod install", chdir: File.dirname(config.podfile_path)
         end
 
-        helper.add_custom_build_setting if config.setting
+        # Add SDK via CocoaPods, Carthage or direct download (no-op if disabled).
+        add_sdk
 
-        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
+        # Set up Universal Links and Branch key(s)
+        update_project_settings
 
-        if is_app_target
-          config.xcodeproj.build_configurations.each do |c|
-            new_path = helper.add_universal_links_to_project @domains, false, c.name
-            sh ["git", "add", new_path] if config.commit && new_path
-          end
+        # Patch source code if so instructed.
+        patch_helper.patch_source config.xcodeproj if config.patch_source
+
+        # Commit changes if so instructed.
+        commit_changes if config.commit
+
+        # Return success.
+        0
+      end
+
+      def validate_universal_links
+        valid = helper.validate_team_and_bundle_ids_from_aasa_files @domains
+        if valid
+          say "Universal Link configuration passed validation. ✅"
+        else
+          say "Universal Link configuration failed validation."
+          helper.errors.each { |error| say " #{error}" }
         end
+        valid
+      end
 
-        config_helper.target.add_system_frameworks config.frameworks unless config.frameworks.nil? || config.frameworks.empty?
+      def update_project_settings
+        helper.add_custom_build_setting if config.setting
+        helper.add_keys_to_info_plist @keys
+        config.target.add_system_frameworks config.frameworks unless config.frameworks.blank?
+
+        return unless config.target.symbol_type == :application
 
-        xcodeproj.save
+        helper.add_branch_universal_link_domains_to_info_plist @domains
+        helper.ensure_uri_scheme_in_info_plist
+        config.xcodeproj.build_configurations.each do |c|
+          new_path = helper.add_universal_links_to_project @domains, false, c.name
+          sh "git", "add", new_path if config.commit && new_path
+        end
+      ensure
+        config.xcodeproj.save
+      end
 
+      def add_sdk
         case config.sdk_integration_mode
         when :cocoapods
           if File.exist? config.podfile_path
-            helper.update_podfile config
+            tool_helper.update_podfile config
           else
-            helper.add_cocoapods config
+            tool_helper.add_cocoapods config
           end
         when :carthage
           if File.exist? config.cartfile_path
-            helper.update_cartfile config, xcodeproj
+            tool_helper.update_cartfile config, config.xcodeproj
           else
-            helper.add_carthage config
+            tool_helper.add_carthage config
           end
         when :direct
-          helper.add_direct config
+          tool_helper.add_direct config
         end
+      end
 
-        patch_helper.patch_source xcodeproj if config.patch_source
-
-        return 0 unless config.commit
-
+      def commit_changes
         changes = helper.changes.to_a.map { |c| Pathname.new(File.expand_path(c)).relative_path_from(Pathname.pwd).to_s }
 
         commit_message = config.commit if config.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", commit_message, *changes]
-
-        0
+        sh "git", "commit", "-qm", commit_message, *changes
       end
-      # rubocop: enable Metrics/PerceivedComplexity
 
       def check_repo_status
         # If the git command is not installed, there's not much we can do.
         # Don't want to use verify_git here, which will insist on installing
         # the command. The logic of that method could change.
-        return if `which git`.empty? || !config.confirm
+        return true if `which git`.empty? || !config.confirm
 
         unless Dir.exist? ".git"
           `git rev-parse --git-dir > /dev/null 2>&1`
           # Not a git repo
-          return unless $?.success?
+          return true unless $?.success?
         end
 
         `git diff-index --quiet HEAD --`
-        return if $?.success?
+        return true if $?.success?
 
         # Show the user
         sh "git status"
 
         choice = choose do |menu|
           menu.header = "There are uncommitted changes in this repo. It's best to stash or commit them before continuing."
+          menu.readline = true
           menu.choice "Stash"
           menu.choice "Commit (You will be prompted for a commit message.)"
           menu.choice "Quit"
@@ -120,11 +136,13 @@ module BranchIOCLI
           sh "git stash -q"
         when /^Commit/
           message = ask "Please enter a commit message: "
-          sh ["git", "commit", "-aqm", message]
+          sh "git", "commit", "-aqm", message
         when /^Quit/
           say "Please stash or commit your changes before continuing."
-          exit(-1)
+          return false
         end
+
+        true
       end
     end
   end

data/lib/branch_io_cli/configuration.rb

@@ -2,6 +2,9 @@ require "branch_io_cli/configuration/configuration"
 require "branch_io_cli/configuration/option"
 require "branch_io_cli/configuration/option_wrapper"
 require "branch_io_cli/configuration/report_configuration"
+require "branch_io_cli/configuration/report_options"
 require "branch_io_cli/configuration/setup_configuration"
+require "branch_io_cli/configuration/setup_options"
 require "branch_io_cli/configuration/validate_configuration"
+require "branch_io_cli/configuration/validate_options"
 require "branch_io_cli/configuration/xcode_settings"

data/lib/branch_io_cli/configuration/configuration.rb

@@ -1,3 +1,4 @@
+require "artii"
 require "cocoapods-core"
 require "pathname"
 require "xcodeproj"
@@ -24,6 +25,11 @@ module BranchIOCLI
           end
         end
 
+        def available_options
+          root = name.gsub(/^.*::(\w+)Configuration$/, '\1')
+          BranchIOCLI::Configuration.const_get("#{root.capitalize}Options").available_options
+        end
+
         def absolute_path(path)
           return path unless current
           current.absolute_path path
@@ -92,6 +98,7 @@ EOF
         say <<EOF
 <%= color("branch_io #{self.class.name.sub(/^.*::(.*?)Configuration$/, '\1').downcase} v. #{VERSION}", BOLD) %>
 
+#{Artii::Base.new.asciify 'Branch'}
 EOF
       end
 
@@ -322,8 +329,8 @@ EOF
         objc_paths = all_paths.grep(/\.m$/)
         objc_paths += objc_paths.map { |p| p.sub(/\.m$/, '.h') }.select { |f| File.exist? f }
 
-        path = swift_paths.find { |f| /class.*:\s+MSMessagesAppViewController\s*{\n/m.match_file f } ||
-               objc_paths.find { |f| /@interface.*:\s+MSMessagesAppViewController/.match_file f }
+        path = swift_paths.find { |f| /class.*:\s+MSMessagesAppViewController\s*{\n/m.match_file? f } ||
+               objc_paths.find { |f| /@interface.*:\s+MSMessagesAppViewController/.match_file? f }
 
         # If we found a .h, patch the corresponding .m.
         path && path.sub(/\.h$/, '.m')

data/lib/branch_io_cli/configuration/report_configuration.rb

@@ -3,91 +3,11 @@ require "xcodeproj"
 
 module BranchIOCLI
   module Configuration
-    # rubocop: disable Metrics/ClassLength
     class ReportConfiguration < Configuration
       class << self
         def summary
           "Generate and optionally submit a build diagnostic report."
         end
-
-        def available_options
-          [
-            Option.new(
-              name: :workspace,
-              description: "Path to an Xcode workspace",
-              type: String,
-              example: "MyProject.xcworkspace"
-            ),
-            Option.new(
-              name: :xcodeproj,
-              description: "Path to an Xcode project",
-              type: String,
-              example: "MyProject.xcodeproj"
-            ),
-            Option.new(
-              name: :scheme,
-              description: "A scheme from the project or workspace to build",
-              type: String,
-              example: "MyProjectScheme"
-            ),
-            Option.new(
-              name: :target,
-              description: "A target to build",
-              type: String,
-              example: "MyProjectTarget"
-            ),
-            Option.new(
-              name: :configuration,
-              description: "The build configuration to use (default: Scheme-dependent)",
-              type: String,
-              example: "Debug/Release/CustomConfigName"
-            ),
-            Option.new(
-              name: :sdk,
-              description: "Passed as -sdk to xcodebuild",
-              type: String,
-              example: "iphoneos",
-              default_value: "iphonesimulator"
-            ),
-            Option.new(
-              name: :podfile,
-              description: "Path to the Podfile for the project",
-              type: String,
-              example: "/path/to/Podfile"
-            ),
-            Option.new(
-              name: :cartfile,
-              description: "Path to the Cartfile for the project",
-              type: String,
-              example: "/path/to/Cartfile"
-            ),
-            Option.new(
-              name: :clean,
-              description: "Clean before attempting to build",
-              default_value: true
-            ),
-            Option.new(
-              name: :header_only,
-              description: "Write a report header to standard output and exit",
-              default_value: false,
-              aliases: "-H"
-            ),
-            Option.new(
-              name: :pod_repo_update,
-              description: "Update the local podspec repo before installing",
-              default_value: true
-            ),
-            Option.new(
-              name: :out,
-              description: "Report output path",
-              default_value: "./report.txt",
-              aliases: "-o",
-              example: "./report.txt",
-              type: String,
-              env_name: "BRANCH_REPORT_PATH"
-            )
-          ]
-        end
       end
 
       attr_reader :report_path

data/lib/branch_io_cli/configuration/report_options.rb

@@ -0,0 +1,86 @@
+module BranchIOCLI
+  module Configuration
+    class ReportOptions
+      class << self
+        def available_options
+          [
+            Option.new(
+              name: :workspace,
+              description: "Path to an Xcode workspace",
+              type: String,
+              example: "MyProject.xcworkspace"
+            ),
+            Option.new(
+              name: :xcodeproj,
+              description: "Path to an Xcode project",
+              type: String,
+              example: "MyProject.xcodeproj"
+            ),
+            Option.new(
+              name: :scheme,
+              description: "A scheme from the project or workspace to build",
+              type: String,
+              example: "MyProjectScheme"
+            ),
+            Option.new(
+              name: :target,
+              description: "A target to build",
+              type: String,
+              example: "MyProjectTarget"
+            ),
+            Option.new(
+              name: :configuration,
+              description: "The build configuration to use (default: Scheme-dependent)",
+              type: String,
+              example: "Debug/Release/CustomConfigName"
+            ),
+            Option.new(
+              name: :sdk,
+              description: "Passed as -sdk to xcodebuild",
+              type: String,
+              example: "iphoneos",
+              default_value: "iphonesimulator"
+            ),
+            Option.new(
+              name: :podfile,
+              description: "Path to the Podfile for the project",
+              type: String,
+              example: "/path/to/Podfile"
+            ),
+            Option.new(
+              name: :cartfile,
+              description: "Path to the Cartfile for the project",
+              type: String,
+              example: "/path/to/Cartfile"
+            ),
+            Option.new(
+              name: :clean,
+              description: "Clean before attempting to build",
+              default_value: true
+            ),
+            Option.new(
+              name: :header_only,
+              description: "Write a report header to standard output and exit",
+              default_value: false,
+              aliases: "-H"
+            ),
+            Option.new(
+              name: :pod_repo_update,
+              description: "Update the local podspec repo before installing",
+              default_value: true
+            ),
+            Option.new(
+              name: :out,
+              description: "Report output path",
+              default_value: "./report.txt",
+              aliases: "-o",
+              example: "./report.txt",
+              type: String,
+              env_name: "BRANCH_REPORT_PATH"
+            )
+          ]
+        end
+      end
+    end
+  end
+end