branch_io_cli 0.12.2 → 0.12.3

data/lib/branch_io_cli/configuration/setup_configuration.rb

@@ -1,6 +1,5 @@
 module BranchIOCLI
   module Configuration
-    # rubocop: disable Metrics/ClassLength
     class SetupConfiguration < Configuration
       class << self
         def summary
@@ -16,151 +15,6 @@ module BranchIOCLI
             "Install using carthage bootstrap" => "branch_io --carthage-command \"bootstrap --no-use-binaries\""
           }
         end
-
-        def available_options
-          [
-            Option.new(
-              name: :live_key,
-              description: "Branch live key",
-              example: "key_live_xxxx",
-              type: String,
-              aliases: "-L"
-            ),
-            Option.new(
-              name: :test_key,
-              description: "Branch test key",
-              example: "key_test_yyyy",
-              type: String,
-              aliases: "-T"
-            ),
-            Option.new(
-              name: :domains,
-              description: "Comma-separated list of custom domain(s) or non-Branch domain(s)",
-              example: "example.com,www.example.com",
-              type: Array,
-              aliases: "-D",
-              confirm_symbol: :all_domains
-            ),
-            Option.new(
-              name: :app_link_subdomain,
-              description: "Branch app.link subdomain, e.g. myapp for myapp.app.link",
-              example: "myapp",
-              type: String,
-              label: "app.link subdomain",
-              skip_confirmation: true
-            ),
-            Option.new(
-              name: :uri_scheme,
-              description: "Custom URI scheme used in the Branch Dashboard for this app",
-              example: "myurischeme[://]",
-              type: String,
-              aliases: "-U",
-              label: "URI scheme"
-            ),
-            Option.new(
-              name: :setting,
-              description: "Use a custom build setting for the Branch key (default: Use Info.plist)",
-              example: "BRANCH_KEY_SETTING",
-              type: String,
-              argument_optional: true,
-              aliases: "-s",
-              label: "User-defined setting for Branch key"
-            ),
-            Option.new(
-              name: :test_configurations,
-              description: "List of configurations that use the test key with a user-defined setting (default: Debug configurations)",
-              example: "config1,config2",
-              type: Array,
-              negatable: true,
-              valid_values_proc: ->() { Configuration.current.xcodeproj.build_configurations.map(&:name) }
-            ),
-            Option.new(
-              name: :xcodeproj,
-              description: "Path to an Xcode project to update",
-              example: "MyProject.xcodeproj",
-              type: String,
-              confirm_symbol: :xcodeproj_path,
-              validate_proc: ->(path) { Configuration.open_xcodeproj path }
-            ),
-            Option.new(
-              name: :target,
-              description: "Name of a target to modify in the Xcode project",
-              example: "MyAppTarget",
-              type: String,
-              confirm_symbol: :target_name,
-              valid_values_proc: ->() { Configuration.current.xcodeproj.targets.map(&:name) }
-            ),
-            Option.new(
-              name: :podfile,
-              description: "Path to the Podfile for the project",
-              example: "/path/to/Podfile",
-              type: String,
-              confirm_symbol: :podfile_path,
-              validate_proc: ->(path) { Configuration.open_podfile path }
-            ),
-            Option.new(
-              name: :cartfile,
-              description: "Path to the Cartfile for the project",
-              example: "/path/to/Cartfile",
-              type: String,
-              confirm_symbol: :cartfile_path,
-              validate_proc: ->(path) { !path.nil? && File.exist?(path.to_s) },
-              convert_proc: ->(path) { Configuration.absolute_path(path.to_s) unless path.nil? }
-            ),
-            Option.new(
-              name: :carthage_command,
-              description: "Command to run when installing from Carthage",
-              example: "<command>",
-              type: String,
-              default_value: "update --platform ios"
-            ),
-            Option.new(
-              name: :frameworks,
-              description: "Comma-separated list of system frameworks to add to the project",
-              example: "AdSupport,CoreSpotlight,SafariServices",
-              type: Array
-            ),
-            Option.new(
-              name: :pod_repo_update,
-              description: "Update the local podspec repo before installing",
-              default_value: true
-            ),
-            Option.new(
-              name: :validate,
-              description: "Validate Universal Link configuration",
-              default_value: true
-            ),
-            Option.new(
-              name: :force,
-              description: "Update project even if Universal Link validation fails",
-              default_value: false
-            ),
-            Option.new(
-              name: :add_sdk,
-              description: "Add the Branch framework to the project",
-              default_value: true
-            ),
-            Option.new(
-              name: :patch_source,
-              description: "Add Branch SDK calls to the AppDelegate",
-              default_value: true
-            ),
-            Option.new(
-              name: :commit,
-              description: "Commit the results to Git if non-blank",
-              type: String,
-              example: "message",
-              argument_optional: true,
-              label: "Commit message"
-            ),
-            Option.new(
-              name: :confirm,
-              description: "Confirm configuration before proceeding",
-              default_value: true,
-              skip_confirmation: true
-            )
-          ]
-        end
       end
 
       APP_LINK_REGEXP = /\.app\.link$|\.test-app\.link$/
@@ -401,6 +255,7 @@ module BranchIOCLI
         # Prompt the user:
         selected = choose do |menu|
           menu.header = "No Podfile or Cartfile specified or found. Here are your options"
+          menu.readline = true
 
           SDK_OPTIONS.each_key { |k| menu.choice k }
 

data/lib/branch_io_cli/configuration/setup_options.rb

@@ -0,0 +1,152 @@
+module BranchIOCLI
+  module Configuration
+    class SetupOptions
+      class << self
+        def available_options
+          [
+            Option.new(
+              name: :live_key,
+              description: "Branch live key",
+              example: "key_live_xxxx",
+              type: String,
+              aliases: "-L"
+            ),
+            Option.new(
+              name: :test_key,
+              description: "Branch test key",
+              example: "key_test_yyyy",
+              type: String,
+              aliases: "-T"
+            ),
+            Option.new(
+              name: :domains,
+              description: "Comma-separated list of custom domain(s) or non-Branch domain(s)",
+              example: "example.com,www.example.com",
+              type: Array,
+              aliases: "-D",
+              confirm_symbol: :all_domains
+            ),
+            Option.new(
+              name: :app_link_subdomain,
+              description: "Branch app.link subdomain, e.g. myapp for myapp.app.link",
+              example: "myapp",
+              type: String,
+              label: "app.link subdomain",
+              skip_confirmation: true
+            ),
+            Option.new(
+              name: :uri_scheme,
+              description: "Custom URI scheme used in the Branch Dashboard for this app",
+              example: "myurischeme[://]",
+              type: String,
+              aliases: "-U",
+              label: "URI scheme"
+            ),
+            Option.new(
+              name: :setting,
+              description: "Use a custom build setting for the Branch key (default: Use Info.plist)",
+              example: "BRANCH_KEY_SETTING",
+              type: String,
+              argument_optional: true,
+              aliases: "-s",
+              label: "User-defined setting for Branch key"
+            ),
+            Option.new(
+              name: :test_configurations,
+              description: "List of configurations that use the test key with a user-defined setting (default: Debug configurations)",
+              example: "config1,config2",
+              type: Array,
+              negatable: true,
+              valid_values_proc: ->() { Configuration.current.xcodeproj.build_configurations.map(&:name) }
+            ),
+            Option.new(
+              name: :xcodeproj,
+              description: "Path to an Xcode project to update",
+              example: "MyProject.xcodeproj",
+              type: String,
+              confirm_symbol: :xcodeproj_path,
+              validate_proc: ->(path) { Configuration.open_xcodeproj path }
+            ),
+            Option.new(
+              name: :target,
+              description: "Name of a target to modify in the Xcode project",
+              example: "MyAppTarget",
+              type: String,
+              confirm_symbol: :target_name,
+              valid_values_proc: ->() { Configuration.current.xcodeproj.targets.map(&:name) }
+            ),
+            Option.new(
+              name: :podfile,
+              description: "Path to the Podfile for the project",
+              example: "/path/to/Podfile",
+              type: String,
+              confirm_symbol: :podfile_path,
+              validate_proc: ->(path) { Configuration.open_podfile path }
+            ),
+            Option.new(
+              name: :cartfile,
+              description: "Path to the Cartfile for the project",
+              example: "/path/to/Cartfile",
+              type: String,
+              confirm_symbol: :cartfile_path,
+              validate_proc: ->(path) { !path.nil? && File.exist?(path.to_s) },
+              convert_proc: ->(path) { Configuration.absolute_path(path.to_s) unless path.nil? }
+            ),
+            Option.new(
+              name: :carthage_command,
+              description: "Command to run when installing from Carthage",
+              example: "<command>",
+              type: String,
+              default_value: "update --platform ios"
+            ),
+            Option.new(
+              name: :frameworks,
+              description: "Comma-separated list of system frameworks to add to the project",
+              example: "AdSupport,CoreSpotlight,SafariServices",
+              type: Array
+            ),
+            Option.new(
+              name: :pod_repo_update,
+              description: "Update the local podspec repo before installing",
+              default_value: true
+            ),
+            Option.new(
+              name: :validate,
+              description: "Validate Universal Link configuration",
+              default_value: true
+            ),
+            Option.new(
+              name: :force,
+              description: "Update project even if Universal Link validation fails",
+              default_value: false
+            ),
+            Option.new(
+              name: :add_sdk,
+              description: "Add the Branch framework to the project",
+              default_value: true
+            ),
+            Option.new(
+              name: :patch_source,
+              description: "Add Branch SDK calls to the AppDelegate",
+              default_value: true
+            ),
+            Option.new(
+              name: :commit,
+              description: "Commit the results to Git if non-blank",
+              type: String,
+              example: "message",
+              argument_optional: true,
+              label: "Commit message"
+            ),
+            Option.new(
+              name: :confirm,
+              description: "Confirm configuration before proceeding",
+              default_value: true,
+              skip_confirmation: true
+            )
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/branch_io_cli/configuration/validate_configuration.rb

@@ -9,37 +9,6 @@ module BranchIOCLI
         def return_value
           "If validation passes, this command returns 0. If validation fails, it returns 1."
         end
-
-        def available_options
-          [
-            Option.new(
-              name: :domains,
-              description: "Comma-separated list of domains to validate (Branch domains or non-Branch domains)",
-              type: Array,
-              example: "example.com,www.example.com",
-              aliases: "-D",
-              default_value: []
-            ),
-            Option.new(
-              name: :xcodeproj,
-              description: "Path to an Xcode project to update",
-              type: String,
-              example: "MyProject.xcodeproj"
-            ),
-            Option.new(
-              name: :target,
-              description: "Name of a target to validate in the Xcode project",
-              type: String,
-              example: "MyAppTarget"
-            ),
-            Option.new(
-              name: :configurations,
-              description: "Comma-separated list of configurations to validate (default: all)",
-              type: Array,
-              example: "Debug,Release"
-            )
-          ]
-        end
       end
 
       def initialize(options)

data/lib/branch_io_cli/configuration/validate_options.rb

@@ -0,0 +1,38 @@
+module BranchIOCLI
+  module Configuration
+    class ValidateOptions
+      class << self
+        def available_options
+          [
+            Option.new(
+              name: :domains,
+              description: "Comma-separated list of domains to validate (Branch domains or non-Branch domains)",
+              type: Array,
+              example: "example.com,www.example.com",
+              aliases: "-D",
+              default_value: []
+            ),
+            Option.new(
+              name: :xcodeproj,
+              description: "Path to an Xcode project to update",
+              type: String,
+              example: "MyProject.xcodeproj"
+            ),
+            Option.new(
+              name: :target,
+              description: "Name of a target to validate in the Xcode project",
+              type: String,
+              example: "MyAppTarget"
+            ),
+            Option.new(
+              name: :configurations,
+              description: "Comma-separated list of configurations to validate (default: all)",
+              type: Array,
+              example: "Debug,Release"
+            )
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/branch_io_cli/configuration/xcode_settings.rb

@@ -46,13 +46,18 @@ module BranchIOCLI
       end
 
       def xcodebuild_cmd
-        cmd = "xcodebuild"
-        cmd += " -showBuildSettings"
-        cmd += " -project #{Shellwords.escape config.xcodeproj_path}"
-        cmd += " -target #{Shellwords.escape config.target.name}"
-        cmd += " -sdk #{Shellwords.escape config.sdk}"
-        cmd += " -configuration #{Shellwords.escape configuration}"
-        cmd
+        [
+          "xcodebuild",
+          "-showBuildSettings",
+          "-project",
+          config.xcodeproj_path,
+          "-target",
+          config.target.name,
+          "-sdk",
+          config.sdk,
+          "-configuration",
+          configuration
+        ].shelljoin
       end
 
       def load_settings_from_xcode

data/lib/branch_io_cli/core_ext.rb

@@ -1,2 +1,3 @@
 require "branch_io_cli/core_ext/io.rb"
 require "branch_io_cli/core_ext/regexp.rb"
+require "branch_io_cli/core_ext/xcodeproj.rb"

data/lib/branch_io_cli/core_ext/io.rb

@@ -7,12 +7,11 @@ class IO
   # status at the end in case of error. Returns a Process::Status
   # object.
   #
-  # @param command [String, Array] a shell command to execute and report
-  def log_command(command)
-    command = command.map(&:to_s).map(&:shellescape).join(" ") if command.kind_of? Array
-    write "$ #{command}\n\n"
+  # @param command a shell command to execute and report
+  def sh(*args)
+    write "$ #{IO.command_from_args(*args)}\n\n"
 
-    Open3.popen2e(command) do |stdin, output, thread|
+    Open3.popen2e(*args) do |stdin, output, thread|
       # output is stdout and stderr merged
       while (line = output.gets)
         puts line
@@ -33,14 +32,12 @@ end
 # not redirected. Report the exit status at the end if nonzero.
 # Returns a Process::Status object.
 #
-# @param command [String, Array] a shell command to execute and report
-def STDOUT.log_command(command)
-  command = command.map(&:to_s).map(&:shellescape).join(" ") if command.kind_of? Array
+# @param command a shell command to execute and report
+def STDOUT.sh(*args)
   # TODO: Improve this implementation?
-  say "<%= color(%q{$ #{command}}, [MAGENTA, BOLD]) %>\n\n"
+  say "<%= color(%q{$ #{IO.command_from_args(*args)}}, [MAGENTA, BOLD]) %>\n\n"
   # May also write to stderr
-  # Could try system "#{command} 2>&1", but that might depend on the shell.
-  system command
+  system(*args)
 
   status = $?
   if status == 0
@@ -50,3 +47,29 @@ def STDOUT.log_command(command)
   end
   status
 end
+
+def IO.command_from_args(*args)
+  raise ArgumentError, "sh requires at least one argument" unless args.count > 0
+
+  # Ignore any trailing options in the output
+  args.pop if args.last.kind_of?(Hash)
+
+  command = ""
+
+  # Optional initial environment Hash
+  if args.first.kind_of?(Hash)
+    command = args.shift.map { |k, v| "#{k}=#{v.shellescape}" }.join(" ") + " "
+  end
+
+  # Support [ "/usr/local/bin/foo", "foo" ], "-x", ...
+  if args.first.kind_of?(Array)
+    command += args.shift.first.shellescape + " " + args.shelljoin
+    command.chomp! " "
+  elsif args.count == 1 && args.first.kind_of?(String)
+    command += args.first
+  else
+    command += args.shelljoin
+  end
+
+  command
+end