branch_io_cli 0.10.0 → 0.11.0

data/lib/branch_io_cli/command/command.rb

@@ -1,17 +1,39 @@
 module BranchIOCLI
   module Command
     class Command
+      class << self
+        def command_name
+          matches = /BranchIOCLI::Command::(\w+)Command/.match name
+          matches[1].downcase
+        end
+
+        def configuration_class
+          root = command_name.capitalize
+
+          Object.const_get("BranchIOCLI")
+                .const_get("Configuration")
+                .const_get("#{root}Configuration")
+        end
+
+        def available_options
+          configuration_class.available_options
+        end
+
+        def examples
+          configuration_class.examples if configuration_class.respond_to?(:examples)
+        end
+
+        def return_value
+          configuration_class.return_value if configuration_class.respond_to?(:return_value)
+        end
+      end
+
       attr_reader :options # command-specific options from CLI
       attr_reader :config # command-specific configuration object
 
       def initialize(options)
         @options = options
-        matches = /BranchIOCLI::Command::(\w+)Command/.match self.class.name
-        root = matches[1]
-
-        @config = Object.const_get("BranchIOCLI")
-                        .const_get("Configuration")
-                        .const_get("#{root}Configuration").new options
+        @config = self.class.configuration_class.new options
       end
 
       def run!

data/lib/branch_io_cli/command/report_command.rb

@@ -44,7 +44,7 @@ module BranchIOCLI
         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}"
+            report.log_command ["xcodebuild", "-list", "-project", path]
           end
         end
 

data/lib/branch_io_cli/command/setup_command.rb

@@ -1,11 +1,8 @@
 require "branch_io_cli/helper/methods"
-require "shellwords"
 
 module BranchIOCLI
   module Command
     class SetupCommand < Command
-      attr_reader :config
-
       def initialize(options)
         super
         @keys = config.keys
@@ -47,7 +44,7 @@ module BranchIOCLI
         helper.ensure_uri_scheme_in_info_plist if is_app_target # does nothing if already present
 
         new_path = helper.add_universal_links_to_project @domains, false if is_app_target
-        sh "git add #{Shellwords.escape(new_path)}" if options.commit && new_path
+        sh ["git", "add", new_path] if options.commit && new_path
 
         config_helper.target.add_system_frameworks options.frameworks unless options.frameworks.nil? || options.frameworks.empty?
 
@@ -79,7 +76,7 @@ module BranchIOCLI
         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(' ')}"
+        sh ["git", "commit", "-qm", commit_message, *changes]
       end
       # rubocop: enable Metrics/PerceivedComplexity
 
@@ -87,7 +84,7 @@ module BranchIOCLI
         # 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?
+        return if `which git`.empty? || !config.check_repo_changes
 
         unless Dir.exist? ".git"
           `git rev-parse --git-dir > /dev/null 2>&1`
@@ -115,7 +112,7 @@ module BranchIOCLI
           sh "git stash -q"
         when /^Commit/
           message = ask "Please enter a commit message: "
-          sh "git commit -aqm #{Shellwords.escape(message)}"
+          sh ["git", "commit", "-aqm", message]
         when /^Quit/
           say "Please stash or commit your changes before continuing."
           exit(-1)

data/lib/branch_io_cli/command/validate_command.rb

@@ -1,8 +1,6 @@
 module BranchIOCLI
   module Command
     class ValidateCommand < Command
-      attr_reader :config
-
       def run!
         valid = true
 

data/lib/branch_io_cli/configuration.rb

@@ -1,4 +1,6 @@
 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/setup_configuration"
 require "branch_io_cli/configuration/validate_configuration"

data/lib/branch_io_cli/configuration/configuration.rb

@@ -7,6 +7,17 @@ module BranchIOCLI
     class Configuration
       class << self
         attr_accessor :current
+
+        def wrapper(hash, add_defaults = true)
+          OptionWrapper.new hash, available_options, add_defaults
+        end
+
+        def defaults
+          available_options.inject({}) do |defs, o|
+            next defs if o.default_value.nil?
+            defs.merge(o.name => o.default_value)
+          end
+        end
       end
 
       attr_reader :options
@@ -23,7 +34,7 @@ module BranchIOCLI
 
       def initialize(options)
         @options = options
-        @pod_repo_update = options.pod_repo_update
+        @pod_repo_update = options.pod_repo_update if options.respond_to?(:pod_repo_update)
         Configuration.current = self
 
         print_identification self.class.name.sub(/^.*::(.*?)Configuration$/, '\1').downcase
@@ -108,6 +119,8 @@ EOF
       end
 
       def validate_target(allow_extensions = true)
+        return if @target
+
         non_test_targets = xcodeproj.targets.reject(&:test_target_type?)
         raise "No non-test target found in project" if non_test_targets.empty?
 
@@ -310,6 +323,19 @@ EOF
         end
         imports
       end
+
+      def method_missing(method_sym, *arguments, &block)
+        all_options = self.class.available_options.map(&:name)
+        return super unless all_options.include?(method_sym)
+
+        self.class.send :define_method, method_sym do
+          ivar = "@#{method_sym}"
+          value = instance_variable_get ivar
+          value
+        end
+
+        send method_sym
+      end
     end
   end
 end

data/lib/branch_io_cli/configuration/option.rb

@@ -0,0 +1,28 @@
+module BranchIOCLI
+  module Configuration
+    class Option
+      attr_accessor :name
+      attr_accessor :type
+      attr_accessor :description
+      attr_accessor :default_value
+      attr_accessor :example
+      attr_accessor :argument_optional
+      attr_accessor :aliases
+      attr_accessor :negatable
+
+      def initialize(options)
+        @name = options[:name]
+        @type = options[:type]
+        @description = options[:description]
+        @default_value = options[:default_value]
+        @example = options[:example]
+        @argument_optional = options[:argument_optional] || false
+        @aliases = options[:aliases] || []
+        @aliases = [@aliases] unless @aliases.kind_of?(Array)
+        @negatable = options[:type].nil? if options[:negatable].nil?
+
+        @argument_optional ||= @negatable
+      end
+    end
+  end
+end

data/lib/branch_io_cli/configuration/option_wrapper.rb

@@ -0,0 +1,33 @@
+module BranchIOCLI
+  module Configuration
+    # Proxy class for use with Command.new.
+    class OptionWrapper
+      attr_reader :hash
+      attr_reader :options
+      attr_reader :add_defaults
+
+      def initialize(hash, options, add_defaults = true)
+        raise ArgumentError if hash.nil?
+
+        @hash = hash
+        @options = options
+        @add_defaults = add_defaults
+
+        build_option_hash
+      end
+
+      def method_missing(method_sym, *arguments, &block)
+        option = @option_hash[method_sym]
+        return super unless option
+
+        value = hash[method_sym]
+        return value unless add_defaults && value.nil?
+        option.default_value
+      end
+
+      def build_option_hash
+        @option_hash = options.inject({}) { |hash, o| hash.merge o.name => o }
+      end
+    end
+  end
+end

data/lib/branch_io_cli/configuration/report_configuration.rb

@@ -43,13 +43,89 @@ end
 
 module BranchIOCLI
   module Configuration
+    # rubocop: disable Metrics/ClassLength
     class ReportConfiguration < Configuration
-      attr_reader :clean
-      attr_reader :header_only
-      attr_reader :scheme
-      attr_reader :configuration
+      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
+            )
+          ]
+        end
+      end
+
       attr_reader :report_path
-      attr_reader :sdk
 
       def validate_options
         @clean = options.clean
@@ -216,9 +292,8 @@ EOF
         return if options.target || xcscheme.nil?
 
         # Find the target used when running the scheme if the user didn't specify one.
-        # This will be picked up in #validate_target
         entry = xcscheme.build_action.entries.select(&:build_for_running?).first
-        options.target = entry.buildable_references.first.target_name
+        @target = xcodeproj.targets.find { |t| t.name == entry.buildable_references.first.target_name }
       end
 
       def all_schemes
@@ -391,5 +466,6 @@ EOF
         @branch_key_setting_from_info_plist
       end
     end
+    # rubocop: enable Metrics/ClassLength
   end
 end

data/lib/branch_io_cli/configuration/setup_configuration.rb

@@ -1,6 +1,147 @@
 module BranchIOCLI
   module Configuration
+    # rubocop: disable Metrics/ClassLength
     class SetupConfiguration < Configuration
+      class << self
+        def examples
+          {
+            "Test without validation (can use dummy keys and domains)" => "branch_io setup -L key_live_xxxx -D myapp.app.link --no-validate",
+            "Use both live and test keys" => "branch_io setup -L key_live_xxxx -T key_test_yyyy -D myapp.app.link",
+            "Use custom or non-Branch domains" => "branch_io setup -D myapp.app.link,example.com,www.example.com",
+            "Avoid pod repo update" => "branch_io setup --no-pod-repo-update",
+            "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"
+            ),
+            Option.new(
+              name: :app_link_subdomain,
+              description: "Branch app.link subdomain, e.g. myapp for myapp.app.link",
+              example: "myapp",
+              type: String
+            ),
+            Option.new(
+              name: :uri_scheme,
+              description: "Custom URI scheme used in the Branch Dashboard for this app",
+              example: "myurischeme[://]",
+              type: String,
+              aliases: "-U"
+            ),
+            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"
+            ),
+            Option.new(
+              name: :test_configurations,
+              description: "List of configurations that use the test key with a custom build setting (default: Debug configurations)",
+              example: "config1,config2",
+              type: Array,
+              negatable: true
+            ),
+            Option.new(
+              name: :xcodeproj,
+              description: "Path to an Xcode project to update",
+              example: "MyProject.xcodeproj",
+              type: String
+            ),
+            Option.new(
+              name: :target,
+              description: "Name of a target to modify in the Xcode project",
+              example: "MyAppTarget",
+              type: String
+            ),
+            Option.new(
+              name: :podfile,
+              description: "Path to the Podfile for the project",
+              example: "/path/to/Podfile",
+              type: String
+            ),
+            Option.new(
+              name: :cartfile,
+              description: "Path to the Cartfile for the project",
+              example: "/path/to/Cartfile",
+              type: String
+            ),
+            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",
+              type: String,
+              example: "message",
+              argument_optional: true
+            ),
+            Option.new(
+              name: :check_repo_changes,
+              description: "Check for uncommitted changes to a git repo",
+              default_value: true
+            )
+          ]
+        end
+      end
+
       APP_LINK_REGEXP = /\.app\.link$|\.test-app\.link$/
       SDK_OPTIONS =
         {
@@ -13,15 +154,6 @@ module BranchIOCLI
 
       attr_reader :keys
       attr_reader :all_domains
-      attr_reader :carthage_command
-      attr_reader :uri_scheme
-      attr_reader :validate
-      attr_reader :add_sdk
-      attr_reader :force
-      attr_reader :patch_source
-      attr_reader :commit
-      attr_reader :setting
-      attr_reader :test_configurations
 
       def validate_options
         @validate = options.validate
@@ -294,5 +426,6 @@ module BranchIOCLI
         end
       end
     end
+    # rubocop: enable Metrics/ClassLength
   end
 end