branch_io_cli 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a59f8d672ea8d70c83d6bd2e23f1b56c1ace20f
-  data.tar.gz: 7a1367bb08e6e2bc1b9a496df9b79e9fd23cb0ef
+  metadata.gz: 6369e446a2ef359946dccb3b93132c75c6ed72c0
+  data.tar.gz: 53affe0e6938179ea185381d139cb18b0c8105d4
 SHA512:
-  metadata.gz: f3e1dad4aa4a7e8481275f6c3032ffd71c1f7ab67ff3d8aea9601b09f78b13cc6727c74fbe85aa9301995a622cc8f9f1ba5de0773e7a89fe12214a288380d0b2
-  data.tar.gz: 597fc8f8ed4f486e97ac60858d145b16bc6c14de69698502cdfcb11d2c538da2c540c6b39f16c3610f7541251318a2b0fbf003ef64c49724437ef2a7d76283e3
+  metadata.gz: 99149f86b892a1aaed05a04e221455409c40cf6fd7f97d2fddac0dbfef368cf6ea4d159bd10511bb03e49bf0ba50e00a5df6ef35170ed9f9de86f0fb135b66b2
+  data.tar.gz: 0c3cd173bc20634d51c9469b3b286dab4e49582e1c16588648850c354683cc3c380717cbd1684c760ebc9d58f5b68a595773b25e5069d5f9813a32b54ce4ece6

data/README.md

@@ -61,7 +61,7 @@ Currently command-line completion for bash is much more extensive than for zsh.
 ### Setup command
 
 ```bash
-branch_io setup
+branch_io setup [OPTIONS]
 ```
 
 Integrates the Branch SDK into a native app project. This currently supports iOS only.
@@ -165,7 +165,7 @@ branch_io setup --no-pod-repo-update
 ### Validate command
 
 ```bash
-branch_io validate
+branch_io validate [OPTIONS]
 ```
 
 This command validates all Universal Link domains configured in a project without making any modification.
@@ -199,6 +199,35 @@ and no Universal Link domain is present that does not pass validation.
 
 If validation passes, this command returns 0. If validation fails, it returns 1.
 
+### Report command
+
+```bash
+branch_io report [OPTIONS]
+```
+
+_Work in progress_
+
+This command optionally cleans and then builds a workspace or project, generating a verbose
+report with additional diagnostic information suitable for opening a support ticket.
+
+#### Options
+
+|Option|Description|
+|------|-----------|
+|-h, --help|Prints a list of commands or help for each command|
+|-v, --version|Prints the current version of the CLI|
+|-t, --trace|Prints a stack trace when exceptions are raised|
+|--workspace MyProject.xcworkspace|Path to an Xcode workspace|
+|--xcodeproj MyProject.xcodeproj|Path to an Xcode project|
+|--target MyAppTarget|Name of a target to modify in the Xcode project|
+|--scheme MyAppScheme|Name of a scheme to build|
+|--configuration Debug/Release/CustomConfig|Name of a build configuration|
+|--[no-]clean|Clean before building (default: yes)|
+|--[no-]header-only|Show a diagnostic header and exit without cleaning or building (default: no)|
+|--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)|
+
 ## Examples
 
 See the [examples](./examples) folder for several example projects that can be

data/lib/assets/completions/completion.bash

@@ -8,7 +8,7 @@ _branch_io_complete()
     prev="${COMP_WORDS[COMP_CWORD-1]}"
     cmd="${COMP_WORDS[1]}"
 
-    commands="setup validate"
+    commands="report setup validate"
     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"
@@ -18,8 +18,13 @@ _branch_io_complete()
 
     validate_opts="$global_opts -D --domains --xcodeproj --target"
 
+    report_opts="$global_opts --xcodeproj --workspace --header-only --no-clean --scheme --target --configuration --out"
+
     if [[ ${cur} == -* ]] ; then
       case "${cmd}" in
+        report)
+          opts=$report_opts
+          ;;
         setup)
           opts=$setup_opts
           ;;

data/lib/branch_io_cli/cli.rb

@@ -145,6 +145,33 @@ EOF
         end
       end
 
+      command :report do |c|
+        c.syntax = "branch_io report [OPTIONS]"
+        c.summary = "Generate and optionally submit a build diagnostic report."
+        c.description = <<EOF
+<%= color('Work in progress', BOLD) %>
+
+This command optionally cleans and then builds a workspace or project, generating a verbose
+report with additional diagnostic information suitable for opening a support ticket.
+EOF
+
+        c.option "--xcodeproj MyProject.xcodeproj", String, "Path to an Xcode project"
+        c.option "--workspace MyProject.xcworkspace", String, "Path to an Xcode workspace"
+        c.option "--scheme MyProjectScheme", String, "A scheme from the project or workspace to build"
+        c.option "--target MyProjectTarget", String, "A target to build"
+        c.option "--configuration Debug|Release|CustomConfigName", String, "The build configuration to use (default: Release)"
+        c.option "--podfile /path/to/Podfile", String, "Path to the Podfile for the project"
+        c.option "--cartfile /path/to/Cartfile", String, "Path to the Cartfile for the project"
+        c.option "--[no-]clean", "Clean before attempting to build (default: yes)"
+        c.option "--[no-]header-only", "Write a report header to standard output and exit"
+        c.option "--out branch-report.txt", String, "Report output path (default: ./branch-report.txt)"
+
+        c.action do |args, options|
+          options.default clean: true, header_only: false
+          Commands::ReportCommand.new(options).run!
+        end
+      end
+
       run!
     end
   end

data/lib/branch_io_cli/commands.rb

@@ -1,3 +1,4 @@
 require "branch_io_cli/commands/command"
+require "branch_io_cli/commands/report_command"
 require "branch_io_cli/commands/setup_command"
 require "branch_io_cli/commands/validate_command"

data/lib/branch_io_cli/commands/report_command.rb

@@ -0,0 +1,70 @@
+module BranchIOCLI
+  module Commands
+    class ReportCommand < Command
+      def initialize(options)
+        super
+        config_helper.validate_report_options options
+      end
+
+      def run!
+        say "\n"
+
+        if config_helper.header_only
+          say report_header
+          exit 0
+        end
+
+        File.open config_helper.report_path, "w" do |report|
+          report.write "Branch.io Xcode build report v #{VERSION}\n\n"
+          # TODO: Write out command-line options or configuration from helper
+          report.write "#{report_header}\n"
+
+          if config_helper.clean
+            say "Cleaning"
+            clean_cmd = "#{base_xcodebuild_cmd} clean"
+            report.write "$ #{clean_cmd}\n\n"
+            report.write `#{clean_cmd}`
+          end
+
+          say "Building"
+          build_cmd = "#{base_xcodebuild_cmd} -verbose"
+          report.write "$ #{build_cmd}\n\n"
+          report.write `#{build_cmd}`
+
+          say "Done ✅"
+        end
+        say "Report generated in #{config_helper.report_path}"
+      end
+
+      def base_xcodebuild_cmd
+        cmd = "xcodebuild"
+        cmd = "#{cmd} -scheme #{config_helper.scheme}" if config_helper.scheme
+        cmd = "#{cmd} -workspace #{config_helper.workspace_path}" if config_helper.workspace_path
+        cmd = "#{cmd} -project #{config_helper.xcodeproj_path}" if config_helper.xcodeproj_path
+        cmd = "#{cmd} -target #{config_helper.target}" if config_helper.target
+        cmd = "#{cmd} -configuration #{config_helper.configuration}" if config_helper.configuration
+        cmd
+      end
+
+      def branch_version
+        if config_helper.podfile_path && File.exist?("#{config_helper.podfile_path}.lock")
+          podfile_lock = File.read "#{config_helper.podfile_path}.lock"
+          matches = %r{Branch/Core \(= (\d+\.\d+\.\d+)\)}m.match podfile_lock
+          return matches[1] if matches
+        elsif config_helper.cartfile_path && File.exist?("#{config_helper.cartfile_path}.resolved")
+          cartfile_resolved = File.read "#{config_helper.cartfile_path}.resolved"
+          matches = /ios-branch-deep-linking" "(\d+\.\d+\.\d+)"/m.match cartfile_resolved
+          return matches[1] if matches
+        end
+        nil
+      end
+
+      def report_header
+        header = `xcodebuild -version`
+        version = branch_version
+        header = "#{header}\nBranch SDK v. #{version}" if version
+        "#{header}\n"
+      end
+    end
+  end
+end

data/lib/branch_io_cli/helper/configuration_helper.rb

@@ -6,6 +6,7 @@ module BranchIOCLI
     # Processes CLI options.
     # Validates options.
     # Prompts for input in a number of cases.
+    # rubocop: disable Metrics/ClassLength
     class ConfigurationHelper
       APP_LINK_REGEXP = /\.app\.link$|\.test-app\.link$/
       SDK_OPTIONS =
@@ -19,6 +20,8 @@ module BranchIOCLI
       class << self
         attr_reader :xcodeproj_path
         attr_reader :xcodeproj
+        attr_reader :workspace_path
+        attr_reader :workspace
         attr_reader :keys
         attr_reader :all_domains
         attr_reader :podfile_path
@@ -32,6 +35,11 @@ module BranchIOCLI
         attr_reader :patch_source
         attr_reader :commit
         attr_reader :sdk_integration_mode
+        attr_reader :clean
+        attr_reader :header_only
+        attr_reader :scheme
+        attr_reader :configuration
+        attr_reader :report_path
 
         def validate_setup_options(options)
           print_identification "setup"
@@ -60,10 +68,10 @@ module BranchIOCLI
 
           # If --cartfile is present, don't look for a Podfile. Just validate that
           # Cartfile.
-          validate_buildfile_path options, "Podfile" if options.cartfile.nil?
+          validate_buildfile_path options.podfile, "Podfile" if options.cartfile.nil? && options.add_sdk
 
           # If --podfile is present or a Podfile was found, don't look for a Cartfile.
-          validate_buildfile_path options, "Cartfile" if @podfile.nil?
+          validate_buildfile_path options.cartfile, "Cartfile" if @sdk_integration_mode.nil? && options.add_sdk
 
           validate_sdk_addition options
 
@@ -79,6 +87,32 @@ module BranchIOCLI
           print_validation_configuration
         end
 
+        def validate_report_options(options)
+          print_identification "report"
+
+          @clean = options.clean
+          @header_only = options.header_only
+          @scheme = options.scheme
+          @target = options.target
+          @configuration = options.configuration
+          @report_path = options.out || "./report.txt"
+
+          validate_xcodeproj_and_workspace options
+          validate_scheme options
+
+          # If neither --podfile nor --cartfile is present, arbitrarily look for a Podfile
+          # first.
+
+          # If --cartfile is present, don't look for a Podfile. Just validate that
+          # Cartfile.
+          validate_buildfile_path(options.podfile, "Podfile") if options.cartfile.nil?
+
+          # If --podfile is present or a Podfile was found, don't look for a Cartfile.
+          validate_buildfile_path(options.cartfile, "Cartfile") if @sdk_integration_mode.nil?
+
+          print_report_configuration
+        end
+
         def print_identification(command)
           say <<EOF
 
@@ -120,6 +154,22 @@ EOF
 EOF
         end
 
+        def print_report_configuration
+          say <<EOF
+<%= color('Configuration:', BOLD) %>
+
+<%= color('Xcode workspace:', BOLD) %> #{@workspace_path || '(none)'}
+<%= color('Xcode project:', BOLD) %> #{@xcodeproj_path || '(none)'}
+<%= color('Scheme:', BOLD) %> #{@scheme || '(none)'}
+<%= color('Target:', BOLD) %> #{@target || '(none)'}
+<%= color('Configuration:', BOLD) %> #{@configuration || '(none)'}
+<%= color('Podfile:', BOLD) %> #{@podfile_path || '(none)'}
+<%= color('Cartfile:', BOLD) %> #{@cartfile_path || '(none)'}
+<%= color('Clean:', BOLD) %> #{@clean.inspect}
+<%= color('Report path:', BOLD) %> #{@report_path}
+EOF
+        end
+
         def validate_keys_from_setup_options(options)
           live_key = options.live_key
           test_key = options.test_key
@@ -200,6 +250,99 @@ EOF
           end
         end
 
+        # rubocop: disable Metrics/PerceivedComplexity
+        def validate_xcodeproj_and_workspace(options)
+          # 1. What was passed in?
+          begin
+            if options.workspace
+              path = options.workspace
+              @workspace = Xcodeproj::Workspace.new_from_xcworkspace options.workspace
+              @workspace_path = options.workspace
+            end
+            if options.xcodeproj
+              path = options.xcodeproj
+              @xcodeproj = Xcodeproj::Project.open options.xcodeproj
+              @xcodeproj_path = options.xcodeproj
+            end
+            return if @workspace || @xcodeproj
+          rescue StandardError => e
+            say e.message
+          end
+
+          # Try to find first a workspace, then a project
+          all_workspace_paths = Dir[File.expand_path(File.join(".", "**/*.xcworkspace"))]
+                                .reject { |w| w =~ %r{/project.pbxproj$} }
+                                .select do |p|
+            valid = true
+            Pathname.new(p).each_filename do |f|
+              valid = false && break if f == "Carthage" || f == "Pods"
+            end
+            valid
+          end
+
+          if all_workspace_paths.count == 1
+            path = all_workspace_paths.first
+          elsif all_workspace_paths.count == 0
+            all_xcodeproj_paths = Dir[File.expand_path(File.join(".", "**/*.xcodeproj"))]
+            xcodeproj_paths = all_xcodeproj_paths.select do |p|
+              valid = true
+              Pathname.new(p).each_filename do |f|
+                valid = false && break if f == "Carthage" || f == "Pods"
+              end
+              valid
+            end
+
+            path = xcodeproj_paths.first if xcodeproj_paths.count == 1
+          end
+          # If more than one workspace. Don't try to find a project. Just prompt.
+
+          loop do
+            path = ask "Please enter a path to your Xcode project or workspace: " if path.nil?
+            begin
+              if path =~ /\.xcworkspace$/
+                @workspace = Xcodeproj::Workspace.new_from_xcworkspace path
+                @workspace_path = path
+                return
+              elsif path =~ /\.xcodeproj$/
+                @xcodeproj = Xcodeproj::Project.open path
+                @xcodeproj_path = path
+                return
+              else
+                say "Path must end with .xcworkspace or .xcodeproj"
+              end
+            rescue StandardError => e
+              say e.message
+            end
+          end
+        end
+        # rubocop: enable Metrics/PerceivedComplexity
+
+        def validate_scheme(options)
+          schemes = all_schemes
+          if options.scheme && schemes.include?(options.scheme)
+            @scheme = options.scheme
+          elsif schemes.count == 1
+            @scheme = schemes.first
+          elsif !schemes.empty?
+            say "Please specify one of the following for the --scheme argument:"
+            schemes.each do |scheme|
+              say " #{scheme}"
+            end
+            exit 1
+          else
+            say "No scheme defined in project."
+            exit(-1)
+          end
+        end
+
+        def all_schemes
+          if @workspace_path
+            @workspace.schemes.keys.reject { |scheme| scheme == "Pods" }
+          else
+            Xcodeproj::Project.schemes @xcodeproj_path
+          end
+        end
+
         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?
@@ -281,11 +424,9 @@ EOF
           scheme.sub %r{://$}, ""
         end
 
-        def validate_buildfile_path(options, filename)
+        def validate_buildfile_path(buildfile_path, filename)
           # Disable Podfile/Cartfile update if --no-add-sdk is present
-          return unless options.add_sdk && @sdk_integration_mode.nil?
-
-          buildfile_path = options.send filename.downcase
+          return unless @sdk_integration_mode.nil?
 
           # Was --podfile/--cartfile used?
           if buildfile_path
@@ -312,8 +453,8 @@ EOF
             end
           end
 
-          # No: Check for Podfile/Cartfile next to @xcodeproj_path
-          buildfile_path = File.expand_path "../#{filename}", @xcodeproj_path
+          # No: Check for Podfile/Cartfile next to workspace or project
+          buildfile_path = File.expand_path "../#{filename}", (@workspace_path || @xcodeproj_path)
           return unless File.exist? buildfile_path
 
           # Exists: Use it (valid if found)
@@ -354,5 +495,6 @@ EOF
         end
       end
     end
+    # rubocop: enable Metrics/ClassLength
   end
 end

data/lib/branch_io_cli/version.rb

@@ -1,3 +1,3 @@
 module BranchIOCLI
-  VERSION = "0.5.3"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch_io_cli
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Branch
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-27 00:00:00.000000000 Z
+date: 2017-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -226,6 +226,7 @@ files:
 - lib/branch_io_cli/cli.rb
 - lib/branch_io_cli/commands.rb
 - lib/branch_io_cli/commands/command.rb
+- lib/branch_io_cli/commands/report_command.rb
 - lib/branch_io_cli/commands/setup_command.rb
 - lib/branch_io_cli/commands/validate_command.rb
 - lib/branch_io_cli/helper.rb