branch_io_cli 0.13.0.pre.1 → 0.13.0.pre.2

data/lib/branch_io_cli/configuration/env_configuration.rb

@@ -0,0 +1,47 @@
+module BranchIOCLI
+  module Configuration
+    class EnvConfiguration < Configuration
+      class << self
+        def summary
+          "Output information about CLI environment."
+        end
+
+        def examples
+          {
+            "Show CLI environment" => "br env",
+            "Get completion script for zsh" => "br env -cs zsh"
+          }
+        end
+      end
+
+      def initialize(options)
+        @quiet = !options.verbose
+        @ruby_version = options.ruby_version
+        @rubygems_version = options.rubygems_version
+        @lib_path = options.lib_path
+        @assets_path = options.assets_path
+        @completion_script = options.completion_script
+        @shell = options.shell
+        super
+      end
+
+      def log
+        super
+        return if quiet
+
+        say <<EOF
+<%= color('Show completion script:', BOLD) %> #{completion_script}
+<%= color('Shell for completion script:', BOLD) %> #{shell}
+EOF
+      end
+
+      def show_all?
+        !show_completion_script?
+      end
+
+      def show_completion_script?
+        completion_script
+      end
+    end
+  end
+end

data/lib/branch_io_cli/configuration/env_options.rb

@@ -0,0 +1,30 @@
+module BranchIOCLI
+  module Configuration
+    class EnvOptions
+      def self.available_options
+        [
+          Option.new(
+            name: :completion_script,
+            description: "Get the path to the completion script for this shell",
+            default_value: false,
+            aliases: "-c"
+          ),
+          Option.new(
+            name: :shell,
+            env_name: "SHELL",
+            description: "Specify shell for completion script",
+            type: String,
+            example: "zsh",
+            aliases: "-s"
+          ),
+          Option.new(
+            name: :verbose,
+            description: "Generate verbose output",
+            default_value: false,
+            aliases: "-V"
+          )
+        ]
+      end
+    end
+  end
+end

data/lib/branch_io_cli/configuration/environment.rb

@@ -0,0 +1,107 @@
+require "active_support/core_ext/string"
+require "rbconfig"
+require_relative "../core_ext/tty_platform"
+
+module BranchIOCLI
+  module Configuration
+    class Environment
+      PLATFORM = TTY::Platform.new
+
+      class << self
+        def config
+          Configuration.current
+        end
+
+        def os_version
+          PLATFORM.version
+        end
+
+        def os_name
+          PLATFORM.os.to_s.capitalize
+        end
+
+        def os_arch
+          PLATFORM.architecture
+        end
+
+        def operating_system
+          if PLATFORM.br_high_sierra?
+            os = "macOS High Sierra"
+          elsif PLATFORM.br_sierra?
+            os = "macOS Sierra"
+          else
+            os = os_name if os_name
+            os += " #{os_version}" if os_version
+          end
+
+          os += " (#{os_arch})"
+
+          os
+        end
+
+        def ruby_path
+          File.join(RbConfig::CONFIG["bindir"],
+                    RbConfig::CONFIG["RUBY_INSTALL_NAME"] +
+                    RbConfig::CONFIG["EXEEXT"])
+        end
+
+        def from_homebrew?
+          ENV["BRANCH_IO_CLI_INSTALLED_FROM_HOMEBREW"] == "true"
+        end
+
+        def lib_path
+          File.expand_path File.join("..", "..", ".."), __FILE__
+        end
+
+        def assets_path
+          File.join lib_path, "assets"
+        end
+
+        # Returns the last path component. Uses the SHELL env. var. unless overriden
+        # at the command line (br env -cs zsh).
+        def shell
+          return ENV["SHELL"].split("/").last unless config.class.available_options.map(&:name).include?(:shell)
+          config.shell.split("/").last
+        end
+
+        def completion_script
+          path = File.join assets_path, "completions", "completion.#{shell}"
+          path if File.readable?(path)
+        end
+
+        def ruby_header(terminal: true, include_load_path: false)
+          header = header_item("Operating system", operating_system, terminal: terminal)
+          header += header_item("Ruby version", RUBY_VERSION, terminal: terminal)
+          header += header_item("Ruby path", display_path(ruby_path), terminal: terminal)
+          header += header_item("RubyGems version", Gem::VERSION, terminal: terminal)
+          header += header_item("Bundler", defined?(Bundler) ? Bundler::VERSION : "no", terminal: terminal)
+          header += header_item("Installed from Homebrew", from_homebrew? ? "yes" : "no", terminal: terminal)
+          header += header_item("GEM_HOME", obfuscate_user(Gem.dir), terminal: terminal)
+          header += header_item("Lib path", display_path(lib_path), terminal: terminal)
+          header += header_item("LOAD_PATH", $LOAD_PATH.map { |p| display_path(p) }, terminal: terminal) if include_load_path
+          header += header_item("Shell", ENV["SHELL"], terminal: terminal)
+          header += "\n"
+          header
+        end
+
+        def header_item(label, value, terminal: true)
+          if terminal
+            "<%= color('#{label}:', BOLD) %> #{value}\n"
+          else
+            "label: #{value}\n"
+          end
+        end
+
+        def obfuscate_user(path)
+          path.gsub(ENV['HOME'], '~').gsub(ENV['USER'], '$USER')
+        end
+
+        def display_path(path)
+          path = path.gsub(Gem.dir, '$GEM_HOME')
+          path = obfuscate_user(path)
+          path
+        end
+      end
+    end
+  end
+end

data/lib/branch_io_cli/configuration/report_configuration.rb

@@ -8,6 +8,14 @@ module BranchIOCLI
         def summary
           "Generate and optionally submit a build diagnostic report."
         end
+
+        def examples
+          {
+            "Show general project information without building" => "br report -H",
+            "Perform a full build and report all errors to report.txt" => "br report",
+            "Don't clean before building" => "br report --no-clean"
+          }
+        end
       end
 
       attr_reader :report_path

data/lib/branch_io_cli/configuration/validate_configuration.rb

@@ -9,6 +9,15 @@ module BranchIOCLI
         def return_value
           "If validation passes, this command returns 0. If validation fails, it returns 1."
         end
+
+        def examples
+          {
+            "Ensure project has at least one correctly configured Branch key and domain" => "br validate",
+            "Ensure project is correctly configured for certain Branch keys" => "br validate -L key_live_xxxx -T key_test_yyyy",
+            "Ensure project is correctly configured to use specific domains" => "br validate -D myapp.app.link,myapp-alternate.app.link",
+            "Validate only Universal Link configuration" => "br validate --universal-links-only"
+          }
+        end
       end
 
       def initialize(options)

data/lib/branch_io_cli/core_ext.rb

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

data/lib/branch_io_cli/core_ext/tty_platform.rb

@@ -0,0 +1,13 @@
+require "tty/platform"
+
+module TTY
+  class Platform
+    def br_sierra?
+      mac? && version.to_s == "16"
+    end
+
+    def br_high_sierra?
+      mac? && version.to_s == "17"
+    end
+  end
+end

data/lib/branch_io_cli/core_ext/xcodeproj.rb

@@ -73,7 +73,7 @@ module Xcodeproj
           end
 
           # TODO: What is the correct resolution order here? Which overrides which in
-          # Xcode?
+          # Xcode? Or does it matter here?
           if setting_value.nil? && defined?(BranchIOCLI::Configuration::XcodeSettings)
             setting_value = BranchIOCLI::Configuration::XcodeSettings[configuration][setting_name]
           end
@@ -120,13 +120,13 @@ module Xcodeproj
             # Everything else becomes a hyphen, including underscores.
             expanded_macro.gsub!(/[^A-Za-z0-9-]/, '-') if modifier == "rfc1034identifier"
 
-            string.gsub!(/\$\(#{original_macro}\)|\$\{#{original_macro}\}|^#{original_macro}/, expanded_macro)
+            string.gsub!(/\$\(#{original_macro}\)|\$\{#{original_macro}\}/, expanded_macro)
             search_position += expanded_macro.length
           end
 
           # HACK: When matching against an xcconfig, as here, sometimes the macro is just returned
-          # without delimiters, e.g. TARGET_NAME or PROJECT_DIR/PROJECT_NAME/BridgingHeader.h. We allow
-          # these two patterns for now.
+          # without delimiters as the entire string or as a path component, e.g. TARGET_NAME or
+          # PROJECT_DIR/PROJECT_NAME/BridgingHeader.h.
           string = string.split("/").map do |component|
             next component unless component =~ /^[A-Z0-9_]+$/
             expanded_build_setting(component, configuration) || component

data/lib/branch_io_cli/format.rb

@@ -1,6 +1,6 @@
-require "branch_io_cli/format/highline_format"
-require "branch_io_cli/format/markdown_format"
-require "branch_io_cli/format/shell_format"
+require_relative "format/highline_format"
+require_relative "format/markdown_format"
+require_relative "format/shell_format"
 
 module BranchIOCLI
   module Format

data/lib/branch_io_cli/helper.rb

@@ -1,6 +1,6 @@
-require "branch_io_cli/helper/branch_helper"
-require "branch_io_cli/helper/methods"
-require "branch_io_cli/helper/patch_helper"
-require "branch_io_cli/helper/report_helper"
-require "branch_io_cli/helper/tool_helper"
-require "branch_io_cli/helper/util"
+require_relative "helper/branch_helper"
+require_relative "helper/methods"
+require_relative "helper/patch_helper"
+require_relative "helper/report_helper"
+require_relative "helper/tool_helper"
+require_relative "helper/util"

data/lib/branch_io_cli/helper/branch_helper.rb

@@ -1,8 +1,9 @@
 require "active_support/core_ext/hash"
-require "branch_io_cli/helper/android_helper"
-require "branch_io_cli/helper/ios_helper"
+require_relative "android_helper"
+require_relative "ios_helper"
 require "net/http"
 require "set"
+require "tty/spinner"
 
 module BranchIOCLI
   module Helper
@@ -19,22 +20,33 @@ module BranchIOCLI
           @changes << change.to_s
         end
 
-        def fetch(url)
+        def fetch(url, spin: true)
+          if spin
+            @spinner = TTY::Spinner.new "[:spinner] GET #{url}.", format: :flip
+            @spinner.auto_spin
+          end
+
           response = Net::HTTP.get_response URI(url)
 
           case response
           when Net::HTTPSuccess
+            @spinner.success "#{response.code} #{response.message}" if @spinner
+            @spinner = nil
             response.body
           when Net::HTTPRedirection
-            fetch response['location']
+            fetch response['location'], spin: false
           else
+            @spinner.error "#{response.code} #{response.message}" if @spinner
+            @spinner = nil
             raise "Error fetching #{url}: #{response.code} #{response.message}"
           end
         end
 
-        def download(url, dest)
+        def download(url, dest, spin: true)
           uri = URI(url)
 
+          @spinner = TTY::Spinner.new "[:spinner] GET #{uri}.", format: :flip if spin
+
           Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |http|
             request = Net::HTTP::Get.new uri
 
@@ -43,7 +55,7 @@ module BranchIOCLI
               when Net::HTTPSuccess
                 bytes_downloaded = 0
                 dots_reported = 0
-                # report a dot every 100 kB
+                # spin every 100 kB
                 per_dot = 102_400
 
                 File.open dest, 'w' do |io|
@@ -53,16 +65,18 @@ module BranchIOCLI
                     # print progress
                     bytes_downloaded += chunk.length
                     while (bytes_downloaded - per_dot * dots_reported) >= per_dot
-                      print "."
+                      @spinner.spin
                       dots_reported += 1
                     end
-                    STDOUT.flush
                   end
                 end
-                say "\n"
+                @spinner.success "#{response.code} #{response.message}" if @spinner
+                @spinner = nil
               when Net::HTTPRedirection
-                download response['location'], dest
+                download response['location'], dest, spin: false
               else
+                @spinner.error "#{response.code} #{response.message}" if @spinner
+                @spinner = nil
                 raise "Error downloading #{url}: #{response.code} #{response.message}"
               end
             end

data/lib/branch_io_cli/helper/ios_helper.rb

@@ -2,9 +2,10 @@ require "active_support/core_ext/object"
 require "json"
 require "openssl"
 require "plist"
+require "tty/spinner"
 
-require "branch_io_cli/configuration"
-require "branch_io_cli/helper/methods"
+require_relative "../configuration"
+require_relative "methods"
 
 module BranchIOCLI
   module Helper
@@ -279,19 +280,25 @@ module BranchIOCLI
 
           Net::HTTP.start uri.host, uri.port, use_ssl: uri.scheme == "https" do |http|
             request = Net::HTTP::Get.new uri
+            spinner = TTY::Spinner.new "[:spinner] GET #{uri}.", format: :flip
+            spinner.auto_spin
             response = http.request request
 
             # Better to use Net::HTTPRedirection and Net::HTTPSuccess here, but
             # having difficulty with the unit tests.
             if (300..399).cover?(response.code.to_i)
+              spinner.error "#{response.code} #{response.message}"
               say "#{uri} cannot result in a redirect. Ignoring."
               next
             elsif response.code.to_i != 200
               # Try the next URI.
-              say "Could not retrieve #{uri}: #{response.code} #{response.message}. Ignoring."
+              spinner.error "#{response.code} #{response.message}"
+              say "Could not retrieve #{uri}. Ignoring."
               next
             end
 
+            spinner.success "#{response.code} #{response.message}"
+
             content_type = response["Content-type"]
             @errors << "[#{domain}] AASA Response does not contain a Content-type header" and next if content_type.nil?
 
@@ -307,8 +314,6 @@ module BranchIOCLI
               @errors << "[#{domain}] Unsigned AASA files must be served via HTTPS" and next if uri.scheme == "http"
               data = response.body
             end
-
-            say "GET #{uri}: #{response.code} #{response.message} (Content-type:#{content_type}) ✅"
           end
         end
 
@@ -447,19 +452,12 @@ module BranchIOCLI
 
         branch_keys = branch_keys.map { |key| config.target.expand_build_settings key, configuration }
 
-        valid = true
-
         # Retrieve app data from Branch API for all keys in the Info.plist
-        apps = branch_keys.map do |key|
-          begin
-            BranchApp[key]
-          rescue StandardError => e
-            # Failed to retrieve a key in the Info.plist from the API.
-            say "[#{key}] #{e.message} ❌"
-            valid = false
-            nil
-          end
-        end.compact.uniq
+        apps = branch_keys.map { |k| BranchApp[k] }.compact.uniq
+        invalid_keys = apps.reject(&:valid?).map(&:key)
+
+        valid = invalid_keys.empty?
+        say "Invalid Branch key(s) in Info.plist for #{configuration} configuration: #{invalid_keys}. ❌" unless valid
 
         # Get domains and URI schemes loaded from API
         domains_from_api = domains apps

data/lib/branch_io_cli/helper/report_helper.rb

@@ -1,6 +1,6 @@
 require "plist"
 require "shellwords"
-require "branch_io_cli/configuration/configuration"
+require_relative "../configuration/configuration"
 
 module BranchIOCLI
   module Helper
@@ -22,6 +22,10 @@ module BranchIOCLI
           Configuration::Configuration.current
         end
 
+        def env
+          Configuration::Environment
+        end
+
         def helper
           BranchHelper
         end