branch_io_cli 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd6157b41fc586526be77da254770b5d85163ec3288927bc61c0c57a56c33bc8
-  data.tar.gz: 79f2102c3254a3eabd933d9cd5b36a9504a86ec1a348fed55c02fbbbf1463dfe
+  metadata.gz: ed1b9b67e4bbb2e57d7108b533fd9b77e81d3393eaa229eba07e4964215b6036
+  data.tar.gz: f451658fdddda919cfe70efa48f6a97c0d2458b287ec149b08b392ecb42c8e35
 SHA512:
-  metadata.gz: d5b48cdb7b011c4a21a54f80455f0f6780d857d21592d368429079d32921b638b347e38e5eb7bc91eabacae731b033acffb6cc527652789c1dfd6025506ffab5
-  data.tar.gz: a7014ab71338528a7c40f11636ea9c31db09fca6a29ae8f3d8235427cd88512d660d5b30c2d2aa7a920ce6f59a03315bf6d87ae93aebd4b4e2335029560e29a1
+  metadata.gz: a536b08af90fa19f98f20a20a145258784dc677c2098209b5c374d700bba5eacd803a98626e7b0633394ef25d13addad8513af449edf1ef690f0c4f1ef92c7a6
+  data.tar.gz: 2880054b91cdb81cf982d5d445d7a23f3d11aac9abaa5a015a7fdf87695e36523b91ac50a080ac9962b7364aec7c73faa7a24d8446522aad29d483969d568660

data/lib/assets/patches/objc_import_at_end.yml

@@ -0,0 +1,3 @@
+regexp: '\z'
+mode: append
+text: "\n#import <Branch/Branch.h>\n"

data/lib/assets/patches/objc_import_include_guard.yml

@@ -0,0 +1,3 @@
+regexp: '/\n\s*#ifndef\s+(\w+).*\n\s*#define\s+\1.*?\n/m'
+mode: append
+text: "\n#import <Branch/Branch.h>\n"

data/lib/branch_io_cli/command/report_command.rb

@@ -155,9 +155,12 @@ EOF
       def version_from_branch_framework
         framework = config.target.frameworks_build_phase.files.find { |f| f.file_ref.path =~ /Branch.framework$/ }
         return nil unless framework
+
         if framework.file_ref.isa == "PBXFileReference"
+          project_path = config.relative_path(config.xcodeproj_path)
           framework_path = framework.file_ref.real_path
         elsif framework.file_ref.isa == "PBXReferenceProxy" && @xcode_settings
+          project_path = config.relative_path framework.file_ref.remote_ref.proxied_object.project.path
           framework_path = File.expand_path framework.file_ref.path, @xcode_settings[framework.file_ref.source_tree]
         end
         info_plist_path = File.join framework_path.to_s, "Info.plist"
@@ -168,7 +171,8 @@ EOF
         raw_info_plist = CFPropertyList::List.new file: info_plist_path
         info_plist = CFPropertyList.native_types raw_info_plist.value
         version = info_plist["CFBundleVersion"]
-        version ? "#{version} [Branch.framework/Info.plist]" : nil
+        return nil unless version
+        "#{version} [Branch.framework/Info.plist:#{project_path}]"
       end
 
       def version_from_bnc_config_m(project = @config.xcodeproj)
@@ -188,7 +192,7 @@ EOF
         matches = /BNC_SDK_VERSION\s+=\s+@"(\d+\.\d+\.\d+)"/m.match bnc_config_m
         return nil unless matches
         version = matches[1]
-        "#{version} [BNCConfig.m]"
+        "#{version} [BNCConfig.m:#{config.relative_path project.path}]"
       end
 
       def report_configuration
@@ -201,8 +205,8 @@ Scheme: #{config.scheme || '(none)'}
 Target: #{config.target || '(none)'}
 Configuration: #{config.configuration || '(none)'}
 SDK: #{config.sdk}
-Podfile: #{config.podfile_path || '(none)'}
-Cartfile: #{config.cartfile_path || '(none)'}
+Podfile: #{config.relative_path(config.podfile_path) || '(none)'}
+Cartfile: #{config.relative_path(config.cartfile_path) || '(none)'}
 Pod repo update: #{config.pod_repo_update.inspect}
 Clean: #{config.clean.inspect}
 EOF
@@ -251,9 +255,9 @@ EOF
         header += " Deployment target: #{config.target.deployment_target}\n"
         header += " Modules #{config.modules_enabled? ? '' : 'not '}enabled\n"
         header += " Swift #{config.swift_version}\n" if config.swift_version
-        header += " Bridging header: #{config.bridging_header_path}\n" if config.bridging_header_path
-        header += " Info.plist: #{infoplist_path || '(none)'}\n"
-        header += " Entitlements file: #{entitlements_path || '(none)'}\n"
+        header += " Bridging header: #{config.relative_path(config.bridging_header_path)}\n" if config.bridging_header_path
+        header += " Info.plist: #{config.relative_path(infoplist_path) || '(none)'}\n"
+        header += " Entitlements file: #{config.relative_path(entitlements_path) || '(none)'}\n"
 
         if config.podfile_path
           begin
@@ -325,6 +329,7 @@ EOF
       # String containing information relevant to Branch setup
       def branch_report
         infoplist_path = helper.expanded_build_setting config.target, "INFOPLIST_FILE", config.configuration
+        infoplist_path = File.expand_path infoplist_path, File.dirname(config.xcodeproj_path)
 
         report = "Branch configuration:\n"
 
@@ -334,10 +339,12 @@ EOF
           report += " Branch key(s) (Info.plist):\n"
           if branch_key.kind_of? Hash
             branch_key.each_key do |key|
-              report += "  #{key.capitalize}: #{branch_key[key]}\n"
+              resolved_key = helper.expand_build_settings branch_key[key], config.target, config.configuration
+              report += "  #{key.capitalize}: #{resolved_key}\n"
             end
           elsif branch_key
-            report += "  #{branch_key}\n"
+            resolved_key = helper.expand_build_settings branch_key, config.target, config.configuration
+            report += "  #{resolved_key}\n"
           else
             report += "  (none found)\n"
           end

data/lib/branch_io_cli/configuration/configuration.rb

@@ -55,6 +55,23 @@ EOF
         Helper::BranchHelper
       end
 
+      def relative_path(path)
+        return nil if path.nil?
+
+        path = Pathname.new(path) unless path.kind_of? Pathname
+        return path.to_s unless path.absolute?
+
+        unless @root
+          if workspace
+            @root = Pathname.new(workspace_path).dirname
+          else
+            @root = Pathname.new(xcodeproj_path).dirname
+          end
+        end
+
+        path.relative_path_from(@root).to_s
+      end
+
       # 1. Look for options.xcodeproj.
       # 2. If not specified, look for projects under . (excluding anything in Pods or Carthage folder).
       # 3. If none or more than one found, prompt the user.
@@ -81,7 +98,7 @@ EOF
           # TODO: Allow the user to choose if xcodeproj_paths.count > 0
           begin
             @xcodeproj = Xcodeproj::Project.open path
-            @xcodeproj_path = path
+            @xcodeproj_path = File.expand_path path
             return
           rescue StandardError => e
             say e.message
@@ -140,6 +157,7 @@ EOF
       def open_podfile(path = @podfile_path)
         @podfile = Pod::Podfile.from_file path
         @podfile_path = path
+        @sdk_integration_mode = :cocoapods
         true
       rescue RuntimeError => e
         say e.message
@@ -152,13 +170,14 @@ EOF
 
         if valid
           valid = File.exist? buildfile_path
-          say "#{buildfile_path} not found." unless valid
+          say "#{buildfile_path} not found." and return false unless valid
         end
 
         if filename == "Podfile" && open_podfile(buildfile_path)
           true
         elsif filename == "Cartfile"
           @cartfile_path = buildfile_path
+          @sdk_integration_mode = :carthage
           true
         else
           false

data/lib/branch_io_cli/configuration/report_configuration.rb

@@ -42,8 +42,8 @@ module BranchIOCLI
 <%= color('Target:', BOLD) %> #{target || '(none)'}
 <%= color('Configuration:', BOLD) %> #{configuration}
 <%= color('SDK:', BOLD) %> #{sdk}
-<%= color('Podfile:', BOLD) %> #{podfile_path || '(none)'}
-<%= color('Cartfile:', BOLD) %> #{cartfile_path || '(none)'}
+<%= color('Podfile:', BOLD) %> #{relative_path(podfile_path) || '(none)'}
+<%= color('Cartfile:', BOLD) %> #{relative_path(cartfile_path) || '(none)'}
 <%= color('Pod repo update:', BOLD) %> #{pod_repo_update.inspect}
 <%= color('Clean:', BOLD) %> #{clean.inspect}
 <%= color('Report path:', BOLD) %> #{report_path}
@@ -57,12 +57,12 @@ EOF
           if options.workspace
             path = options.workspace
             @workspace = Xcodeproj::Workspace.new_from_xcworkspace options.workspace
-            @workspace_path = options.workspace
+            @workspace_path = File.expand_path options.workspace
           end
           if options.xcodeproj
             path = options.xcodeproj
             @xcodeproj = Xcodeproj::Project.open options.xcodeproj
-            @xcodeproj_path = 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$/
@@ -107,7 +107,7 @@ EOF
           begin
             if path =~ /\.xcworkspace$/
               @workspace = Xcodeproj::Workspace.new_from_xcworkspace path
-              @workspace_path = 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$/
@@ -118,7 +118,7 @@ EOF
               return
             elsif path =~ /\.xcodeproj$/
               @xcodeproj = Xcodeproj::Project.open path
-              @xcodeproj_path = path
+              @xcodeproj_path = File.expand_path path
               return
             else
               say "Path must end with .xcworkspace or .xcodeproj"

data/lib/branch_io_cli/configuration/setup_configuration.rb

@@ -4,6 +4,7 @@ module BranchIOCLI
       APP_LINK_REGEXP = /\.app\.link$|\.test-app\.link$/
       SDK_OPTIONS =
         {
+          "Specify the location of a Podfile or Cartfile" => :specify,
           "Set this project up to use CocoaPods and add the Branch SDK." => :cocoapods,
           "Set this project up to use Carthage and add the Branch SDK." => :carthage,
           "Add Branch.framework directly to the project's dependencies." => :direct,
@@ -62,8 +63,8 @@ module BranchIOCLI
 <%= color('Test key:', BOLD) %> #{keys[:test] || '(none)'}
 <%= color('Domains:', BOLD) %> #{all_domains}
 <%= color('URI scheme:', BOLD) %> #{uri_scheme || '(none)'}
-<%= color('Podfile:', BOLD) %> #{podfile_path || '(none)'}
-<%= color('Cartfile:', BOLD) %> #{cartfile_path || '(none)'}
+<%= color('Podfile:', BOLD) %> #{relative_path(podfile_path) || '(none)'}
+<%= color('Cartfile:', BOLD) %> #{relative_path(cartfile_path) || '(none)'}
 <%= color('Carthage command:', BOLD) %> #{carthage_command || '(none)'}
 <%= color('Pod repo update:', BOLD) %> #{pod_repo_update.inspect}
 <%= color('Validate:', BOLD) %> #{validate.inspect}
@@ -183,6 +184,20 @@ module BranchIOCLI
         scheme.sub %r{://$}, ""
       end
 
+      def prompt_for_podfile_or_cartfile
+        loop do
+          path = ask("Please enter the location of your Podfile or Cartfile: ").trim
+          case path
+          when %r{/?Podfile$}
+            return if validate_buildfile_at_path path, "Podfile"
+          when %r{/?Cartfile$}
+            return if validate_buildfile_at_path path, "Cartfile"
+          else
+            say "Path must end in Podfile or Cartfile."
+          end
+        end
+      end
+
       def validate_sdk_addition(options)
         return if !options.add_sdk || sdk_integration_mode
 
@@ -202,6 +217,8 @@ module BranchIOCLI
         @sdk_integration_mode = SDK_OPTIONS[selected]
 
         case sdk_integration_mode
+        when :specify
+          prompt_for_podfile_or_cartfile
         when :cocoapods
           @podfile_path = File.expand_path "../Podfile", xcodeproj_path
         when :carthage

data/lib/branch_io_cli/core_ext.rb

@@ -1 +1,2 @@
 require "branch_io_cli/core_ext/io.rb"
+require "branch_io_cli/core_ext/regexp.rb"

data/lib/branch_io_cli/core_ext/regexp.rb

@@ -0,0 +1,14 @@
+class Regexp
+  def match_file(file)
+    case file
+    when File
+      contents = file.read
+    when String
+      contents = File.read file
+    else
+      raise ArgumentError, "Invalid argument type: #{file.class.name}"
+    end
+
+    match contents
+  end
+end

data/lib/branch_io_cli/helper/ios_helper.rb

@@ -372,7 +372,14 @@ module BranchIOCLI
       end
 
       def expanded_build_setting(target, setting_name, configuration)
-        setting_value = target.resolved_build_setting(setting_name)[configuration]
+        # second arg true means if there is an xcconfig, also consult that
+        begin
+          setting_value = target.resolved_build_setting(setting_name, true)[configuration]
+        rescue Errno::ENOENT
+          # If not found, look up without it
+          setting_value = target.resolved_build_setting(setting_name, false)[configuration]
+        end
+
         return if setting_value.nil?
 
         expand_build_settings setting_value, target, configuration
@@ -380,14 +387,50 @@ module BranchIOCLI
 
       def expand_build_settings(string, target, configuration)
         search_position = 0
-        while (matches = /\$\(([^(){}]*)\)|\$\{([^(){}]*)\}/.match(string, search_position))
-          macro_name = matches[1] || matches[2]
-          search_position = string.index(macro_name) - 2
+        # It's safest to make a copy of this string, though we probably get a
+        # copy from PBXNativeTarget#resolve_build_setting anyway. Copying here
+        # avoids a copy on every match.
+        string = string.clone
+
+        # HACK: When matching against an xcconfig, as here, sometimes the macro is just returned
+        # without delimiters, e.g. TARGET_NAME or BUILT_PRODUCTS_DIR/Branch.framework. We allow
+        # these two patterns for now.
+        while (matches = %r{\$\(([^(){}]*)\)|\$\{([^(){}]*)\}|^([A-Z_]+)(/.*)?$}.match(string, search_position))
+          original_macro = matches[1] || matches[2] || matches[3]
+          delimiter_length = matches[3] ? 0 : 3 # $() or ${}
+          delimiter_offset = matches[3] ? 0 : 2 # $( or ${
+          search_position = string.index(original_macro) - delimiter_offset
+
+          modifier_regexp = /^(.+):(.+)$/
+          if (matches = modifier_regexp.match original_macro)
+            macro_name = matches[1]
+            modifier = matches[2]
+          else
+            macro_name = original_macro
+          end
 
-          expanded_macro = macro_name == "SRCROOT" ? "." : expanded_build_setting(target, macro_name, configuration)
-          search_position += macro_name.length + 3 and next if expanded_macro.nil?
+          case macro_name
+          when "SRCROOT"
+            expanded_macro = "."
+          when "TARGET_NAME"
+            # Clone in case of modifier processing
+            expanded_macro = target.name.clone
+          else
+            expanded_macro = expanded_build_setting(target, macro_name, configuration)
+          end
+
+          search_position += original_macro.length + delimiter_length and next if expanded_macro.nil?
+
+          if modifier == "rfc1034identifier"
+            # From the Apple dev portal when creating a new app ID:
+            # You cannot use special characters such as @, &, *, ', "
+            # From trial and error with Xcode, it appears that only letters, digits and hyphens are allowed.
+            # Everything else becomes a hyphen, including underscores.
+            special_chars = /[^A-Za-z0-9-]/
+            expanded_macro.gsub!(special_chars, '-')
+          end
 
-          string.gsub!(/\$\(#{macro_name}\)|\$\{#{macro_name}\}/, expanded_macro)
+          string.gsub!(/\$\(#{original_macro}\)|\$\{#{original_macro}\}|^#{original_macro}/, expanded_macro)
           search_position += expanded_macro.length
         end
         string

data/lib/branch_io_cli/helper/patch_helper.rb

@@ -44,7 +44,16 @@ module BranchIOCLI
 
           say "Patching #{config.bridging_header_path}"
 
-          load_patch(:objc_import).apply config.bridging_header_path
+          if /^\s*(#import|#include|@import)/.match_file config.bridging_header_path
+            # Add among other imports
+            load_patch(:objc_import).apply config.bridging_header_path
+          elsif /\n\s*#ifndef\s+(\w+).*\n\s*#define\s+\1.*?\n/m.match_file config.bridging_header_path
+            # Has an include guard. Add inside.
+            load_patch(:objc_import_include_guard).apply config.bridging_header_path
+          else
+            # No imports, no include guard. Add at the end.
+            load_patch(:objc_import_at_end).apply config.bridging_header_path
+          end
           helper.add_change config.bridging_header_path
         end
 

data/lib/branch_io_cli/version.rb

@@ -1,3 +1,3 @@
 module BranchIOCLI
-  VERSION = "0.9.5"
+  VERSION = "0.9.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch_io_cli
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - Branch
@@ -272,6 +272,8 @@ files:
 - lib/assets/patches/did_finish_launching_objc.yml
 - lib/assets/patches/did_finish_launching_swift.yml
 - lib/assets/patches/objc_import.yml
+- lib/assets/patches/objc_import_at_end.yml
+- lib/assets/patches/objc_import_include_guard.yml
 - lib/assets/patches/open_url_new_objc.yml
 - lib/assets/patches/open_url_new_swift.yml
 - lib/assets/patches/open_url_objc.yml
@@ -293,6 +295,7 @@ files:
 - lib/branch_io_cli/configuration/validate_configuration.rb
 - lib/branch_io_cli/core_ext.rb
 - lib/branch_io_cli/core_ext/io.rb
+- lib/branch_io_cli/core_ext/regexp.rb
 - lib/branch_io_cli/helper.rb
 - lib/branch_io_cli/helper/android_helper.rb
 - lib/branch_io_cli/helper/branch_helper.rb
@@ -320,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.1
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: Branch.io command-line interface for mobile app integration