branch_io_cli 0.12.3 → 0.12.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e5aed004a45c8ab9ba1551d603e972affbc07660351c1495d378e9d08492452
-  data.tar.gz: 54786f9bcb72a71855dab1575482a964b26779c6a3b6fd4a8053cbe553c33507
+  metadata.gz: 73ff4ce1216540062fb5538541b2872eec3acdebb1471fa7a8b24d2154a3fcfe
+  data.tar.gz: d4b975f00a121acb6ea440e0fdd25de305a00e82625a2469742a07b790cb64ed
 SHA512:
-  metadata.gz: 434932c0f1da70515c63b5d069a2171ea5bac2109cd47ad405b3a057a98bad4a145c52316616a12ff31bd8cff84761373ea47e5b51b918160070f9c3c418ae36
-  data.tar.gz: 4cfdc82ca1e78119bb0e3fa9a1d1a5c0b82eba4e38292f443aee726900e6f709cde5f22959aebf60637bee42ede08d00a81d0bc57a1ac9a025ca1dab0ed90185
+  metadata.gz: eeaf64c3d4944edcf6edd1d97ebc284c5bd60a5ef6770fbba2fabef05874982cd1add06aee1cd735de01d4dc21c2a46c4b5d883f3d915f95e556bfd90b46d35c
+  data.tar.gz: db25f0205240eb879fd92d76ec5f959f62c1f26d7bd2b96d96425c1c4476aa1d6ca8f3af49ade8bdd3df7024371745081beade2f1c4f6537e17d44e2dba2be14

data/README.md

@@ -31,6 +31,15 @@ branch_io validate -h
 branch_io report -h
 ```
 
+The gem also installs `br` as an alias for `branch_io`:
+
+```bash
+br -h
+br setup -h
+br validate -h
+br report -h
+```
+
 ### Shell completion
 
 _Work in progress_
@@ -66,6 +75,7 @@ Currently command-line completion for bash is much more extensive than for zsh.
 
 ```bash
 branch_io setup [OPTIONS]
+br setup [OPTIONS]
 ```
 
 Integrates the Branch SDK into a native app project. This currently supports iOS only.
@@ -157,35 +167,35 @@ See https://github.com/BranchMetrics/branch_io_cli#setup-command for more inform
 ##### Test without validation (can use dummy keys and domains)
 
 ```bash
-branch_io setup -L key_live_xxxx -D myapp.app.link --no-validate
+br setup -L key_live_xxxx -D myapp.app.link --no-validate
 ```
 
 
 ##### Use both live and test keys
 
 ```bash
-branch_io setup -L key_live_xxxx -T key_test_yyyy -D myapp.app.link
+br setup -L key_live_xxxx -T key_test_yyyy -D myapp.app.link
 ```
 
 
 ##### Use custom or non-Branch domains
 
 ```bash
-branch_io setup -D myapp.app.link,example.com,www.example.com
+br setup -D myapp.app.link,example.com,www.example.com
 ```
 
 
 ##### Avoid pod repo update
 
 ```bash
-branch_io setup --no-pod-repo-update
+br setup --no-pod-repo-update
 ```
 
 
 ##### Install using carthage bootstrap
 
 ```bash
-branch_io --carthage-command "bootstrap --no-use-binaries"
+br setup --carthage-command "bootstrap --no-use-binaries"
 ```
 
 
@@ -195,6 +205,7 @@ branch_io --carthage-command "bootstrap --no-use-binaries"
 
 ```bash
 branch_io validate [OPTIONS]
+br validate [OPTIONS]
 ```
 
 This command validates all Universal Link domains configured in a project without making any
@@ -243,6 +254,7 @@ See https://github.com/BranchMetrics/branch_io_cli#validate-command for more inf
 
 ```bash
 branch_io report [OPTIONS]
+br report [OPTIONS]
 ```
 
 This command optionally cleans and then builds a workspace or project, generating a verbose

data/bin/br

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+
+require "branch_io_cli"
+
+BranchIOCLI::CLI.new.run

data/lib/assets/artwork/branch_ascii_art.txt

@@ -0,0 +1,6 @@
+ ____                       _
+|  _ \                     | |
+| |_) |_ __ __ _ _ __   ___| |__
+|  _ <| '__/ _` | '_ \ / __| '_ \
+| |_) | | | (_| | | | | (__| | | |
+|____/|_|  \__,_|_| |_|\___|_| |_|

data/lib/assets/completions/completion.bash

@@ -36,7 +36,7 @@ _branch_io_complete()
           ;;
       esac
       COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
-    elif [[ ${prev} == branch_io ]] ; then
+    elif [[ ${prev} == branch_io || ${prev} == br ]] ; then
       COMPREPLY=( $(compgen -W "${commands}" -- ${cur}) )
     else
       COMPREPLY=( $(compgen -o default ${cur}) )
@@ -44,3 +44,4 @@ _branch_io_complete()
     return 0
 }
 complete -F _branch_io_complete branch_io
+complete -F _branch_io_complete br

data/lib/assets/completions/completion.zsh

@@ -11,3 +11,4 @@ _branch_io_complete() {
 }
 
 compctl -K _branch_io_complete branch_io
+compctl -K _branch_io_complete br

data/lib/assets/templates/command.erb

@@ -2,6 +2,7 @@
 
 ```bash
 branch_io <%= @command.command_name %> [OPTIONS]
+br <%= @command.command_name %> [OPTIONS]
 ```
 
 <%= render "#{@command.command_name}_description" %>

data/lib/assets/templates/completion.bash.erb

@@ -32,7 +32,7 @@ _branch_io_complete()
           ;;
       esac
       COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
-    elif [[ ${prev} == branch_io ]] ; then
+    elif [[ ${prev} == branch_io || ${prev} == br ]] ; then
       COMPREPLY=( $(compgen -W "${commands}" -- ${cur}) )
     else
       COMPREPLY=( $(compgen -o default ${cur}) )
@@ -40,3 +40,4 @@ _branch_io_complete()
     return 0
 }
 complete -F _branch_io_complete branch_io
+complete -F _branch_io_complete br

data/lib/assets/templates/completion.zsh.erb

@@ -11,3 +11,4 @@ _branch_io_complete() {
 }
 
 compctl -K _branch_io_complete branch_io
+compctl -K _branch_io_complete br

data/lib/branch_io_cli.rb

@@ -1,3 +1,4 @@
+require "branch_io_cli/ascii_art"
 require "branch_io_cli/cli"
 require "branch_io_cli/command"
 require "branch_io_cli/configuration"

data/lib/branch_io_cli/ascii_art.rb

@@ -0,0 +1,5 @@
+module BranchIOCLI
+  # Courtesy of artii https://github.com/miketierney/artii
+  # artii Branch
+  ASCII_ART = File.read(File.expand_path(File.join("..", "..", "assets", "artwork", "branch_ascii_art.txt"), __FILE__))
+end

data/lib/branch_io_cli/cli.rb

@@ -23,7 +23,7 @@ module BranchIOCLI
         next unless configuration_class && command_class
 
         command command_name do |c|
-          c.syntax = "branch_io #{c.name} [OPTIONS]"
+          c.syntax = "branch_io #{c.name} [OPTIONS]\n    br #{c.name} [OPTIONS]"
           c.summary = configuration_class.summary if configuration_class.respond_to?(:summary)
 
           begin

data/lib/branch_io_cli/command/setup_command.rb

@@ -43,22 +43,26 @@ module BranchIOCLI
         # Commit changes if so instructed.
         commit_changes if config.commit
 
+        say "\nDone ✅"
+
         # Return success.
         0
       end
 
       def validate_universal_links
+        say "Validating new Universal Link configuration before making any changes.\n\n"
         valid = helper.validate_team_and_bundle_ids_from_aasa_files @domains
         if valid
-          say "Universal Link configuration passed validation. ✅"
+          say "Universal Link configuration passed validation. ✅\n\n"
         else
-          say "Universal Link configuration failed validation."
+          say "Universal Link configuration failed validation.\n\n"
           helper.errors.each { |error| say " #{error}" }
         end
         valid
       end
 
       def update_project_settings
+        say "Updating project settings.\n\n"
         helper.add_custom_build_setting if config.setting
         helper.add_keys_to_info_plist @keys
         config.target.add_system_frameworks config.frameworks unless config.frameworks.blank?
@@ -76,6 +80,7 @@ module BranchIOCLI
       end
 
       def add_sdk
+        say "Making sure Branch dependency is available."
         case config.sdk_integration_mode
         when :cocoapods
           if File.exist? config.podfile_path
@@ -92,6 +97,7 @@ module BranchIOCLI
         when :direct
           tool_helper.add_direct config
         end
+        say "\n"
       end
 
       def commit_changes

data/lib/branch_io_cli/configuration/configuration.rb

@@ -1,4 +1,3 @@
-require "artii"
 require "cocoapods-core"
 require "pathname"
 require "xcodeproj"
@@ -78,6 +77,8 @@ module BranchIOCLI
 
         say "\n"
         print_identification
+        say ASCII_ART
+        say "\n"
         validate_options
         log
       end
@@ -97,8 +98,6 @@ EOF
       def print_identification
         say <<EOF
 <%= color("branch_io #{self.class.name.sub(/^.*::(.*?)Configuration$/, '\1').downcase} v. #{VERSION}", BOLD) %>
-
-#{Artii::Base.new.asciify 'Branch'}
 EOF
       end
 
@@ -145,32 +144,31 @@ EOF
         if options.xcodeproj
           path = options.xcodeproj
         else
-          all_xcodeproj_paths = Dir[File.expand_path(File.join(".", "**/*.xcodeproj"))]
-          # find an xcodeproj (ignoring the Pods and Carthage folders)
-          # TODO: Improve this filter
-          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
+          path = find_project
         end
 
         loop do
           path = ask "Please enter the path to your Xcode project or use --xcodeproj: " if path.nil?
           # TODO: Allow the user to choose if xcodeproj_paths.count > 0
-          begin
-            @xcodeproj = Xcodeproj::Project.open path
-            @xcodeproj_path = File.expand_path path
-            return
-          rescue StandardError => e
-            say e.message
-            path = nil
+          return if open_xcodeproj path
+        end
+      end
+
+      def all_xcodeproj_paths
+        return @all_xcodeproj_paths if @all_xcodeproj_paths
+        xcodeproj_paths = Dir[File.expand_path(File.join(".", "**/*.xcodeproj"))]
+        @all_xcodeproj_paths = 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
+        @all_xcodeproj_paths
+      end
+
+      def find_project
+        all_xcodeproj_paths.count == 1 ? all_xcodeproj_paths.first : nil
       end
 
       def validate_target(allow_extensions = true)
@@ -224,7 +222,7 @@ EOF
 
       def open_podfile(path = podfile_path)
         @podfile = Pod::Podfile.from_file path
-        @podfile_path = path
+        @podfile_path = File.expand_path path
         @sdk_integration_mode = :cocoapods
         true
       rescue Pod::PlainInformative => e
@@ -234,7 +232,7 @@ EOF
 
       def open_xcodeproj(path = xcodeproj_path)
         @xcodeproj = Xcodeproj::Project.open path
-        @xcodeproj_path = path
+        @xcodeproj_path = File.expand_path path
         true
       rescue Xcodeproj::PlainInformative => e
         say e.message

data/lib/branch_io_cli/configuration/report_configuration.rb

@@ -72,47 +72,60 @@ EOF
 EOF
       end
 
-      # rubocop: disable Metrics/PerceivedComplexity
+      def open_workspace(path = workspace_path)
+        @workspace = Xcodeproj::Workspace.new_from_xcworkspace path
+        @workspace_path = File.expand_path path
+        true
+      rescue Xcodeproj::PlainInformative => e
+        say e.message
+        false
+      end
+
       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 = File.expand_path options.workspace
-          end
-          if options.xcodeproj
-            path = options.xcodeproj
-            @xcodeproj = Xcodeproj::Project.open options.xcodeproj
-            @xcodeproj_path = File.expand_path options.xcodeproj
-          else
-            # Pass --workspace and --xcodeproj to override this inference.
-            if workspace && workspace.file_references.count > 0 && workspace.file_references.first.path =~ /\.xcodeproj$/
-              @xcodeproj_path = File.expand_path "../#{@workspace.file_references.first.path}", workspace_path
-              @xcodeproj = Xcodeproj::Project.open xcodeproj_path
-            end
-          end
-          return if @workspace || @xcodeproj
-        rescue StandardError => e
-          say e.message
+        # What was passed in?
+        if options.workspace
+          open_workspace options.workspace
         end
 
+        if options.xcodeproj
+          open_xcodeproj options.xcodeproj
+        elsif workspace
+          open_first_project_in_workspace
+        end
+
+        return if workspace || xcodeproj
+
         # Try to find first a workspace, then a project
-        all_workspace_paths = Dir[File.expand_path(File.join(".", "**/*.xcworkspace"))]
-                              .reject { |w| w =~ %r{/project.xcworkspace$} }
-                              .select do |p|
-          valid = true
-          Pathname.new(p).each_filename do |f|
-            valid = false && break if f == "Carthage" || f == "Pods"
+        path =
+          case all_workspace_paths.count
+          when 1
+            all_workspace_paths.first
+          when 0
+            find_project
+          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?
+          if path =~ /\.xcworkspace$/
+            next unless open_workspace path
+            open_first_project_in_workspace
+            return
+          elsif path =~ /\.xcodeproj$/
+            return if open_xcodeproj path
+          else
+            say "Path must end with .xcworkspace or .xcodeproj"
           end
-          valid
         end
+      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|
+      def all_workspace_paths
+        return @all_workspace_paths if @all_workspace_paths
+
+        @all_workspace_paths =
+          Dir[File.expand_path(File.join(".", "**/*.xcworkspace"))]
+          .reject { |w| w =~ %r{/project.xcworkspace$} }
+          .select do |p|
             valid = true
             Pathname.new(p).each_filename do |f|
               valid = false && break if f == "Carthage" || f == "Pods"
@@ -120,37 +133,23 @@ EOF
             valid
           end
 
-          path = xcodeproj_paths.first if xcodeproj_paths.count == 1
+        @all_workspace_paths
+      end
+
+      def open_first_project_in_workspace
+        # Pass --workspace and --xcodeproj or use the configuration editor to
+        # override this inference.
+        project_path = workspace.file_references.map(&:path).find do |path|
+          path =~ /\.xcodeproj$/ && File.exist?(File.expand_path("../#{path}", workspace_path))
         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 = File.expand_path path
-
-              # Pass --workspace and --xcodeproj to override this inference.
-              if workspace.file_references.count > 0 && workspace.file_references.first.path =~ /\.xcodeproj$/
-                @xcodeproj_path = File.expand_path "../#{workspace.file_references.first.path}", workspace_path
-                @xcodeproj = Xcodeproj::Project.open xcodeproj_path
-              end
-
-              return
-            elsif path =~ /\.xcodeproj$/
-              @xcodeproj = Xcodeproj::Project.open path
-              @xcodeproj_path = File.expand_path path
-              return
-            else
-              say "Path must end with .xcworkspace or .xcodeproj"
-            end
-          rescue StandardError => e
-            say e.message
-          end
+        if project_path.nil?
+          raise "No project found in workspace #{workspace_path}"
         end
+
+        open_xcodeproj project_path
+        # TODO: Handle the case where this cannot be opened (though it exists).
       end
-      # rubocop: enable Metrics/PerceivedComplexity
 
       def validate_scheme(options)
         schemes = all_schemes

data/lib/branch_io_cli/configuration/setup_configuration.rb

@@ -8,11 +8,11 @@ module BranchIOCLI
 
         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\""
+            "Test without validation (can use dummy keys and domains)" => "br setup -L key_live_xxxx -D myapp.app.link --no-validate",
+            "Use both live and test keys" => "br setup -L key_live_xxxx -T key_test_yyyy -D myapp.app.link",
+            "Use custom or non-Branch domains" => "br setup -D myapp.app.link,example.com,www.example.com",
+            "Avoid pod repo update" => "br setup --no-pod-repo-update",
+            "Install using carthage bootstrap" => "br setup --carthage-command \"bootstrap --no-use-binaries\""
           }
         end
       end

data/lib/branch_io_cli/helper/tool_helper.rb

@@ -160,8 +160,6 @@ github "BranchMetrics/ios-branch-deep-linking"
           helper.add_change options.xcodeproj_path
           helper.add_change framework_path
           sh "git", "add", framework_path if options.commit
-
-          say "Done. ✅"
         end
 
         def update_framework_search_paths(path)

data/lib/branch_io_cli/version.rb

@@ -1,3 +1,3 @@
 module BranchIOCLI
-  VERSION = "0.12.3"
+  VERSION = "0.12.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch_io_cli
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.12.4
 platform: ruby
 authors:
 - Branch
@@ -9,22 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-08 00:00:00.000000000 Z
+date: 2017-12-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: artii
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
   requirement: !ruby/object:Gem::Requirement
@@ -256,12 +242,15 @@ email:
 - jgvdthree@gmail.com
 executables:
 - branch_io
+- br
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/br
 - bin/branch_io
+- lib/assets/artwork/branch_ascii_art.txt
 - lib/assets/completions/completion.bash
 - lib/assets/completions/completion.zsh
 - lib/assets/patches/ContinueUserActivity.m
@@ -309,6 +298,7 @@ files:
 - lib/assets/templates/setup_description.erb
 - lib/assets/templates/validate_description.erb
 - lib/branch_io_cli.rb
+- lib/branch_io_cli/ascii_art.rb
 - lib/branch_io_cli/cli.rb
 - lib/branch_io_cli/command.rb
 - lib/branch_io_cli/command/command.rb