branch_io_cli 0.13.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 127f04c8e5422054f2eb24e0ef8c1e0b3a2f5c0e938f77f02ea3baa1d457b552
-  data.tar.gz: 58d2336145b1f3683b91856711d94e81d9efe94e3d8dbdad782a254ab5b93db8
+  metadata.gz: d070eebc7fcafbeca391b9bd8e319b2dd204ea3e06b50e5c03d2140003251fc5
+  data.tar.gz: 901ecc88737470df07c08aff6a076ed210f109c6797d92e654ae2c730341d206
 SHA512:
-  metadata.gz: 2c40028ed828ec0727d74b5dae8a53569eadd39cf163df4c7d254d9083ac40e945b281c2d5015928280fcaf9ebe3bb59661a39ab7a23afc8c7b20531635f256d
-  data.tar.gz: 42d189d84f4218464ffe61dbc52eb66b8f342e4298d363776e56adad81339ba8de324787b99fe9df2be68b4471e08975e0a0ca1f775bb600b82b57db47df10aa
+  metadata.gz: ac7ca487cadb9cd19525381b88e9e994974a7693d306d2279e7b975c2aff778cdc1605b8d24f44a756e7afc9ea8cf92e3b45c5273d8944436316172c301b2bdc
+  data.tar.gz: 68f31555998ecfcfd1e2c36e59e939572304f5d8beb4b67de15f8a37bf6003731587448ade32f8fa0474dbebfec37cd503b04d89dd1d6aa085fb3f8dd24eb9d9

data/README.md

@@ -38,6 +38,7 @@ branch_io -h
 branch_io setup -h
 branch_io validate -h
 branch_io report -h
+branch_io env -h
 ```
 
 The gem also installs `br` as an alias for `branch_io`:
@@ -47,6 +48,7 @@ br -h
 br setup -h
 br validate -h
 br report -h
+br env -h
 ```
 
 ### Shell completion

data/lib/branch_io_cli/branch_app.rb

@@ -1,5 +1,5 @@
 require "active_support/core_ext/hash"
-require "json"
+require "active_support/json"
 require_relative "helper"
 require "tty/spinner"
 

data/lib/branch_io_cli/command/report_command.rb

@@ -1,4 +1,5 @@
 require "shellwords"
+require "tty/spinner"
 
 module BranchIOCLI
   module Command
@@ -6,14 +7,17 @@ module BranchIOCLI
       def run!
         say "\n"
 
-        say "Loading settings from Xcode"
+        task = Helper::Task.new
+        task.begin "Loading settings from Xcode."
+
         # In case running in a non-CLI context (e.g., Rake or Fastlane) be sure
         # to reset Xcode settings each time, since project, target and
         # configurations will change.
         Configuration::XcodeSettings.reset
         if Configuration::XcodeSettings.all_valid?
-          say "Done ✅"
+          task.success "Done."
         else
+          task.error "Failed."
           say "Failed to load settings from Xcode. Some information may be missing.\n"
         end
 
@@ -50,13 +54,13 @@ module BranchIOCLI
         tool_helper.carthage_bootstrap_if_required report
 
         # run xcodebuild -list
-        report.sh(*report_helper.base_xcodebuild_cmd, "-list")
+        report.sh(*report_helper.base_xcodebuild_cmd, "-list", obfuscate: true)
 
         # 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.sh "xcodebuild", "-list", "-project", path
+            report.sh "xcodebuild", "-list", "-project", path, obfuscate: true
           end
         end
 
@@ -77,19 +81,21 @@ module BranchIOCLI
         ]
 
         if config.clean
-          say "Cleaning"
-          if report.sh(*base_cmd, "clean").success?
-            say "Done ✅"
+          task = Helper::Task.new use_spinner: report != STDOUT
+          task.begin "Cleaning."
+          if report.sh(*base_cmd, "clean", obfuscate: true).success?
+            task.success "Done."
           else
-            say "Clean failed."
+            task.error "Clean failed."
           end
         end
 
-        say "Building"
-        if report.sh(*base_cmd, "-verbose").success?
-          say "Done ✅"
+        task = Helper::Task.new use_spinner: report != STDOUT
+        task.begin "Building."
+        if report.sh(*base_cmd, "-verbose", obfuscate: true).success?
+          task.success "Done."
         else
-          say "Build failed."
+          task.error "Failed."
         end
       end
 

data/lib/branch_io_cli/configuration/configuration.rb

@@ -130,6 +130,10 @@ EOF
         target.name.nil? ? nil : target.name
       end
 
+      def env
+        Environment
+      end
+
       def root
         return @root if @root
         if workspace
@@ -327,8 +331,7 @@ EOF
       end
 
       def pod_install_required?
-        # If this is set, its existence has been verified.
-        return false unless podfile_path
+        return false unless podfile_path && File.exist?(podfile_path)
 
         lockfile_path = "#{podfile_path}.lock"
         manifest_path = File.expand_path "../Pods/Manifest.lock", podfile_path

data/lib/branch_io_cli/configuration/environment.rb

@@ -88,15 +88,17 @@ module BranchIOCLI
           if terminal
             "<%= color('#{label}:', BOLD) %> #{value}\n"
           else
-            "label: #{value}\n"
+            "#{label}: #{value}\n"
           end
         end
 
         def obfuscate_user(path)
+          return nil if path.nil?
           path.gsub(ENV['HOME'], '~').gsub(ENV['USER'], '$USER')
         end
 
         def display_path(path)
+          return nil if path.nil?
           path = path.gsub(Gem.dir, '$GEM_HOME')
           path = obfuscate_user(path)
           path

data/lib/branch_io_cli/configuration/report_configuration.rb

@@ -50,8 +50,8 @@ module BranchIOCLI
         <<EOF
 Configuration:
 
-Xcode workspace: #{workspace_path || '(none)'}
-Xcode project: #{xcodeproj_path || '(none)'}
+Xcode workspace: #{env.display_path(workspace_path) || '(none)'}
+Xcode project: #{env.display_path(xcodeproj_path) || '(none)'}
 Scheme: #{scheme || '(none)'}
 Target: #{target || '(none)'}
 Configuration: #{configuration || '(none)'}
@@ -66,8 +66,8 @@ EOF
       def log
         super
         say <<EOF
-<%= color('Xcode workspace:', BOLD) %> #{workspace_path || '(none)'}
-<%= color('Xcode project:', BOLD) %> #{xcodeproj_path || '(none)'}
+<%= color('Xcode workspace:', BOLD) %> #{env.display_path(workspace_path) || '(none)'}
+<%= color('Xcode project:', BOLD) %> #{env.display_path(xcodeproj_path) || '(none)'}
 <%= color('Scheme:', BOLD) %> #{scheme || '(none)'}
 <%= color('Target:', BOLD) %> #{target || '(none)'}
 <%= color('Target type:', BOLD) %> #{target.product_type}

data/lib/branch_io_cli/configuration/setup_configuration.rb

@@ -73,7 +73,7 @@ module BranchIOCLI
       def log
         super
         message = <<-EOF
-<%= color('Xcode project:', BOLD) %> #{xcodeproj_path}
+<%= color('Xcode project:', BOLD) %> #{env.display_path(xcodeproj_path)}
 <%= color('Target:', BOLD) %> #{target.name}
 <%= color('Target type:', BOLD) %> #{target.product_type}
 <%= color('Live key:', BOLD) %> #{keys[:live] || '(none)'}

data/lib/branch_io_cli/configuration/validate_configuration.rb

@@ -34,7 +34,7 @@ module BranchIOCLI
       def log
         super
         say <<EOF
-<%= color('Xcode project:', BOLD) %> #{xcodeproj_path}
+<%= color('Xcode project:', BOLD) %> #{env.display_path(xcodeproj_path)}
 <%= color('Target:', BOLD) %> #{target.name}
 <%= color('Target type:', BOLD) %> #{target.product_type}
 <%= color('Live key:', BOLD) %> #{keys[:live] || '(none)'}

data/lib/branch_io_cli/configuration/xcode_settings.rb

@@ -1,5 +1,6 @@
 require "open3"
 require "shellwords"
+require_relative "environment"
 
 module BranchIOCLI
   module Configuration
@@ -41,6 +42,10 @@ module BranchIOCLI
         Configuration.current
       end
 
+      def env
+        Environment
+      end
+
       def [](key)
         @xcode_settings[key]
       end
@@ -65,7 +70,7 @@ module BranchIOCLI
         @xcode_settings = {}
         Open3.popen2e(xcodebuild_cmd) do |stdin, output, thread|
           while (line = output.gets)
-            @xcodebuild_showbuildsettings_output += line
+            @xcodebuild_showbuildsettings_output += env.obfuscate_user(line)
             line.strip!
             next unless (matches = /^(.+)\s+=\s+(.+)$/.match line)
             @xcode_settings[matches[1]] = matches[2]
@@ -78,7 +83,7 @@ module BranchIOCLI
         if report == STDOUT
           say "<%= color('$ #{xcodebuild_cmd}', [MAGENTA, BOLD]) %>\n\n"
         else
-          report.write "$ #{xcodebuild_cmd}\n\n"
+          report.write "$ #{env.obfuscate_user(xcodebuild_cmd)}\n\n"
         end
 
         report.write @xcodebuild_showbuildsettings_output

data/lib/branch_io_cli/core_ext/io.rb

@@ -1,5 +1,6 @@
 require "open3"
 require "shellwords"
+require_relative "../configuration/environment"
 
 class IO
   # Report the command. Execute the command, capture stdout
@@ -11,10 +12,16 @@ class IO
   def sh(*args)
     write "$ #{IO.command_from_args(*args)}\n\n"
 
+    obfuscate = args.last.delete(:obfuscate) if args.last.kind_of?(Hash)
+
     Open3.popen2e(*args) do |stdin, output, thread|
       # output is stdout and stderr merged
-      while (line = output.gets)
-        puts line
+      output.each do |line|
+        if obfuscate
+          puts BranchIOCLI::Configuration::Environment.obfuscate_user(line)
+        else
+          puts line
+        end
       end
 
       status = thread.value
@@ -34,9 +41,12 @@ end
 #
 # @param command a shell command to execute and report
 def STDOUT.sh(*args)
+  args.last.delete(:obfuscate) if args.last.kind_of?(Hash)
+
   # TODO: Improve this implementation?
   say "<%= color(%q{$ #{IO.command_from_args(*args)}}, [MAGENTA, BOLD]) %>\n\n"
   # May also write to stderr
+  # Cannot obfuscate here.
   system(*args)
 
   status = $?
@@ -52,7 +62,10 @@ 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)
+  if args.last.kind_of?(Hash)
+    options = args.pop
+    obfuscate = options[:obfuscate]
+  end
 
   command = ""
 
@@ -71,5 +84,9 @@ def IO.command_from_args(*args)
     command += args.shelljoin
   end
 
-  command
+  if obfuscate
+    BranchIOCLI::Configuration::Environment.obfuscate_user(command)
+  else
+    command
+  end
 end

data/lib/branch_io_cli/helper.rb

@@ -2,5 +2,6 @@ require_relative "helper/branch_helper"
 require_relative "helper/methods"
 require_relative "helper/patch_helper"
 require_relative "helper/report_helper"
+require_relative "helper/task"
 require_relative "helper/tool_helper"
 require_relative "helper/util"

data/lib/branch_io_cli/helper/ios_helper.rb

@@ -1,5 +1,5 @@
 require "active_support/core_ext/object"
-require "json"
+require "active_support/json"
 require "openssl"
 require "plist"
 require "tty/spinner"

data/lib/branch_io_cli/helper/task.rb

@@ -0,0 +1,34 @@
+require "tty/spinner"
+
+module BranchIOCLI
+  module Helper
+    class Task
+      def initialize(use_spinner: true)
+        @use_spinner = use_spinner
+      end
+
+      def use_spinner?
+        @use_spinner
+      end
+
+      def begin(message)
+        if use_spinner?
+          @spinner = TTY::Spinner.new "[:spinner] #{message}", format: :flip
+          @spinner.auto_spin
+        end
+      end
+
+      def success(message)
+        if use_spinner?
+          @spinner.success message
+        end
+      end
+
+      def error(message)
+        if use_spinner?
+          @spinner.error message
+        end
+      end
+    end
+  end
+end

data/lib/branch_io_cli/helper/tool_helper.rb

@@ -31,7 +31,7 @@ module BranchIOCLI
           install_command = %w(pod install)
           install_command << "--repo-update" if options.pod_repo_update
           Dir.chdir(File.dirname(podfile_path)) do
-            sh %w(pod init)
+            sh "pod", "init"
             PatternPatch::Patch.new(
               regexp: /^(\s*)# Pods for #{options.target.name}$/,
               mode: :append,
@@ -77,7 +77,7 @@ github "BranchMetrics/ios-branch-deep-linking"
           end
 
           # 2. carthage update
-          sh "carthage", options.carthage_command, chdir: File.dirname(config.cartfile_path)
+          sh "carthage", *options.carthage_command.shellsplit, chdir: File.dirname(config.cartfile_path)
 
           # 3. Add Cartfile and Cartfile.resolved to commit (in case :commit param specified)
           helper.add_change cartfile_path
@@ -193,7 +193,6 @@ github "BranchMetrics/ios-branch-deep-linking"
           return false unless PatchHelper.patch_podfile podfile_path
 
           # 2. pod install
-          # command = "PATH='#{ENV['PATH']}' pod install"
           command = %w(pod install)
           command << '--repo-update' if options.pod_repo_update
 
@@ -306,7 +305,7 @@ github "BranchMetrics/ios-branch-deep-linking"
 
           # Ensure master podspec repo is set up (will update if it exists).
           say "Synching master podspec repo. This may take some time."
-          sh %w(pod setup)
+          sh "pod", "setup"
           say "Done ✅"
         end
 
@@ -326,7 +325,7 @@ github "BranchMetrics/ios-branch-deep-linking"
             exit(-1)
           end
 
-          sh %w(brew install carthage)
+          sh "brew", "install", "carthage"
         end
 
         def verify_git
@@ -347,7 +346,7 @@ github "BranchMetrics/ios-branch-deep-linking"
             exit(-1)
           end
 
-          sh %w(xcode-select --install)
+          sh "xcode-select", "--install"
         end
 
         def pod_install_if_required(report = STDOUT)
@@ -378,11 +377,13 @@ some cases. If that happens, please rerun without --no-pod-repo-update or run
                 EOF
           end
 
+          task = Task.new use_spinner: report != STDOUT
           # included by sh, but this is to the screen when generating a report.
-          say "Running #{IO.command_from_args(*install_command)}"
+          task.begin "Running #{IO.command_from_args(*install_command)}."
           if report.sh(*install_command).success?
-            say "Done ✅"
+            task.success "Done."
           else
+            task.error "Failed."
             say "#{IO.command_from_args(*install_command)} failed. See report for details."
             return false
           end
@@ -408,22 +409,26 @@ some cases. If that happens, please rerun without --no-pod-repo-update or run
 
           checkout_command = %w(carthage checkout)
 
+          task = Task.new use_spinner: report != STDOUT
           # included by sh, but this is to the screen when generating a report.
-          say "Running #{IO.command_from_args(*checkout_command)}"
+          task.begin "Running #{IO.command_from_args(*checkout_command)}."
           if report.sh(*checkout_command).success?
-            say "Done ✅"
+            task.success "Done."
           else
+            task.error "Failed."
             say "#{IO.command_from_args(*checkout_command)} failed. See report for details."
             return false
           end
 
-          build_command = %w(carthage build --platform ios)
+          build_command = "carthage", "build", "--platform", "ios"
 
+          task = Task.new use_spinner: report != STDOUT
           # included by sh, but this is to the screen when generating a report.
-          say "Running #{IO.command_from_args(*build_command)}"
+          task.begin "Running #{IO.command_from_args(*build_command)}."
           if report.sh(*build_command).success?
-            say "Done ✅"
+            task.success "Done."
           else
+            task.error "Failed."
             say "#{IO.command_from_args(*build_command)} failed. See report for details."
             return false
           end

data/lib/branch_io_cli/version.rb

@@ -1,3 +1,3 @@
 module BranchIOCLI
-  VERSION = "0.13.0"
+  VERSION = "0.13.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch_io_cli
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Branch
@@ -414,6 +414,7 @@ files:
 - lib/branch_io_cli/helper/methods.rb
 - lib/branch_io_cli/helper/patch_helper.rb
 - lib/branch_io_cli/helper/report_helper.rb
+- lib/branch_io_cli/helper/task.rb
 - lib/branch_io_cli/helper/tool_helper.rb
 - lib/branch_io_cli/helper/util.rb
 - lib/branch_io_cli/rake_task.rb