fastlane-plugin-branch 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71452d61b439b4f695f7d2098ea5eafba48fd3fe
-  data.tar.gz: 8ff31c8f5005e6941352e6edffb6dbb8103bf3e4
+  metadata.gz: '08822a6026ae8a7f5a990080ddc64e537713d705'
+  data.tar.gz: bd5ae339f360d756004bb6e746c46543c0ebf09a
 SHA512:
-  metadata.gz: 73026e1c972b2de5c44a504f6c84caf8eebf96546f5de2e8e619c7a346ed0fc695b48aa2d9ac802ffa519bc4b4148d6caa9a2913a568095fa5d1f2a78a3fcba0
-  data.tar.gz: 1dfad69799475b92c931a24fcc3a9092830f7a0343ee23a2e6184428a88b9f16631eca3758685c000faa112d2316013c05abb256a5b13b512347e51d2cbc88d1
+  metadata.gz: 4768a177e965e307358b31fba008a73f1f3b136a81585039372982331521a23c75f9d89d799c68ce44f89bad375d3d822d2d34b8c944f34660d7f581ef231b4d
+  data.tar.gz: 2bb0ba13f14c4121aec797867a7b1193cfc30a552bec22fd268ea1e0aba9dad5db35bef92b9c1a15d1bf0f20a15110f363dc96db63d3999c641ce1307ce03e14

data/README.md

@@ -34,6 +34,8 @@ for help getting started.
 
 ## setup_branch action
 
+![Branch plugin](./assets/branch_plugin.gif)
+
 ### Prerequisites
 
 Before using this action, make sure to set up your app in the [Branch Dashboard](https://dashboard.branch.io). See https://docs.branch.io/pages/dashboard/integrate/ for details. To use the `setup_branch` action, you need:
@@ -48,6 +50,26 @@ Before using this action, make sure to set up your app in the [Branch Dashboard]
 This action automatically configures Xcode and Android projects that use the Branch SDK
 for Universal Links, App Links and custom URI handling. It modifies Xcode project settings and entitlements as well as Info.plist and AndroidManifest.xml files.
 
+For iOS projects, if a Podfile is detected, and the Podfile does not already contain
+the Branch pod, the pod will be added and `pod install` run to add the Branch SDK
+dependency to the project. If no Podfile is present, and a Cartfile is detected without
+the Branch framework, the framework will be added and `carthage update` run to add
+the Branch SDK dependency to the project. If no Podfile or Cartfile is detected, or
+if one exists with the Branch SDK already included, no changes to the project's
+dependencies will be made.
+
+The AppDelegate will receive the following changes if a
+Branch import is not found:
+
+- Import the Branch SDK (`import Branch` or `#import <Branch/Branch.h>`).
+- Add the Branch `initSession` call to the `application:didFinishLaunchingWithOptions:` method.
+- Add the `application:continueUserActivity:restorationHandler:` method if it does not
+  exist.
+
+Both Swift and Objective-C are supported. Automatically updating the Podfile and
+the AppDelegate may be suppressed, respectively, using the `:add_sdk` and
+`:patch_source` options (see below for all options).
+
 ```ruby
 setup_branch(
   live_key: "key_live_xxxx",
@@ -88,6 +110,11 @@ Available options:
 |:force|Update project(s) even if Universal Link validation fails|BRANCH_FORCE_UPDATE|boolean|false|
 |:commit|Set to true to commit changes to Git; set to a string to commit with a custom message|BRANCH_COMMIT_CHANGES|boolean or string|false|
 |:frameworks|A list of system frameworks to add to the target that uses the Branch SDK (iOS only)|BRANCH_FRAMEWORKS|array|[]|
+|:add_sdk|Set to false to disable automatic integration of the Branch SDK|BRANCH_ADD_SDK|boolean|true|
+|:podfile|Path to a Podfile to update (iOS only)|BRANCH_PODFILE|string||
+|:patch_source|Set to false to disable automatic source-code patching|BRANCH_PATCH_SOURCE|boolean|true|
+|:pod_repo_update|Set to false to disable update of local podspec repo before pod install|BRANCH_POD_REPO_UPDATE|boolean|true|
+|:cartfile|Path to a Cartfile to update (iOS only)|BRANCH_CARTFILE|string||
 
 Individually, all parameters are optional, but the following conditions apply:
 
@@ -96,7 +123,7 @@ Individually, all parameters are optional, but the following conditions apply:
 - :app_link_subdomain or :domains must be specified.
 
 This action also supports an optional Branchfile to specify configuration options.
-See the sample Branchfile at the root of this repo.
+See the sample [Branchfile](./fastlane/Branchfile) in the fastlane subdirectory of this repo.
 
 ## validate_universal_links action (iOS only)
 

data/lib/fastlane/plugin/branch/actions/setup_branch_action.rb

@@ -9,8 +9,6 @@ module Fastlane
         # First augment with any defaults from Branchfile, if present
         params.load_configuration_file("Branchfile")
 
-        helper = Helper::BranchHelper
-
         keys = helper.keys_from_params params
         raise "Must specify :live_key or :test_key." if keys.empty?
 
@@ -29,6 +27,8 @@ module Fastlane
           # raises
           xcodeproj = Xcodeproj::Project.open params[:xcodeproj]
 
+          update_podfile(params) || update_cartfile(params, xcodeproj)
+
           target = params[:target] # may be nil
 
           if params[:update_bundle_and_team_ids]
@@ -51,6 +51,8 @@ module Fastlane
           helper.add_system_frameworks xcodeproj, target, params[:frameworks] unless params[:frameworks].empty?
 
           xcodeproj.save
+
+          patch_source xcodeproj if params[:patch_source]
         end
 
         if params[:android_project_path] || params[:android_manifest_path]
@@ -201,7 +203,35 @@ module Fastlane
                                description: "A list of system frameworks to add to the target that uses the Branch SDK (iOS only)",
                                   optional: true,
                              default_value: [],
-                                      type: Array)
+                                      type: Array),
+          FastlaneCore::ConfigItem.new(key: :add_sdk,
+                                  env_name: "BRANCH_ADD_SDK",
+                               description: "Set to false to disable automatic integration of the Branch SDK",
+                                  optional: true,
+                             default_value: true,
+                                 is_string: false),
+          FastlaneCore::ConfigItem.new(key: :podfile,
+                                  env_name: "BRANCH_PODFILE",
+                               description: "Path to a Podfile to update (iOS only)",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :patch_source,
+                                  env_name: "BRANCH_PATCH_SOURCE",
+                               description: "Set to false to disable automatic source-code patching",
+                                  optional: true,
+                             default_value: true,
+                                 is_string: false),
+          FastlaneCore::ConfigItem.new(key: :pod_repo_update,
+                                  env_name: "BRANCH_POD_REPO_UPDATE",
+                               description: "Set to false to disable update of local podspec repo before pod install",
+                                  optional: true,
+                             default_value: true,
+                                 is_string: false),
+          FastlaneCore::ConfigItem.new(key: :cartfile,
+                                  env_name: "BRANCH_CARTFILE",
+                               description: "Path to a Cartfile to update (iOS only)",
+                                  optional: true,
+                                      type: String)
         ]
       end
 
@@ -212,6 +242,74 @@ module Fastlane
       def self.category
         :project
       end
+
+      class << self
+        def update_podfile(params)
+          podfile_path = helper.podfile_path_from_params params
+          return false if podfile_path.nil?
+
+          # 1. Patch Podfile. Return if no change (Branch pod already present).
+          return false unless helper.patch_podfile podfile_path
+
+          # 2. pod install
+          other_action.cocoapods podfile: podfile_path, repo_update: params[:pod_repo_update]
+
+          # 3. Add Podfile and Podfile.lock to commit (in case :commit param specified)
+          helper.add_change podfile_path
+          helper.add_change "#{podfile_path}.lock"
+
+          # 4. Check if Pods folder is under SCM
+          pods_folder_path = File.expand_path "../Pods", podfile_path
+          `git ls-files #{pods_folder_path} --error-unmatch > /dev/null 2>&1`
+          return true unless $?.exitstatus == 0
+
+          # 5. If so, add the Pods folder to the commit (in case :commit param specified)
+          helper.add_change pods_folder_path
+          other_action.git_add path: pods_folder_path if params[:commit]
+          true
+        end
+
+        def update_cartfile(params, project)
+          cartfile_path = helper.cartfile_path_from_params params
+          return false if cartfile_path.nil?
+
+          # 1. Patch Cartfile. Return if no change (Branch already present).
+          return false unless helper.patch_cartfile cartfile_path
+
+          # 2. carthage update
+          other_action.carthage command: "update", project_directory: File.dirname(cartfile_path)
+
+          # 3. Add Cartfile and Cartfile.resolved to commit (in case :commit param specified)
+          helper.add_change cartfile_path
+          helper.add_change "#{cartfile_path}.resolved"
+
+          # 4. Add to target depependencies
+          frameworks_group = project['Frameworks']
+          branch_framework = frameworks_group.new_file "Carthage/Build/iOS/Branch.framework"
+          target = helper.target_from_project project, params[:target]
+          target.frameworks_build_phase.add_file_reference branch_framework
+
+          # 5. TODO: Add to copy-frameworks build phase
+
+          # 6. Check if Carthage folder is under SCM
+          carthage_folder_path = File.expand_path "../Carthage", cartfile_path
+          `git ls-files #{carthage_folder_path} --error-unmatch > /dev/null 2>&1`
+          return true unless $?.exitstatus == 0
+
+          # 7. If so, add the Pods folder to the commit (in case :commit param specified)
+          helper.add_change carthage_folder_path
+          other_action.git_add path: carthage_folder_path if params[:commit]
+          true
+        end
+
+        def patch_source(xcodeproj)
+          helper.patch_app_delegate_swift(xcodeproj) || helper.patch_app_delegate_objc(xcodeproj)
+        end
+
+        def helper
+          Helper::BranchHelper
+        end
+      end
     end
   end
 end

data/lib/fastlane/plugin/branch/helper/configuration_helper.rb

@@ -81,6 +81,68 @@ module Fastlane
 
         domains
       end
+
+      def podfile_path_from_params(params)
+        # Disable Podfile update if add_sdk: false is present
+        return nil unless add_sdk? params
+
+        # Use the :podfile parameter if present
+        if params[:podfile]
+          UI.user_error! ":podfile argument must specify a path ending in '/Podfile'" unless params[:podfile] =~ %r{/Podfile$}
+          podfile_path = File.expand_path params[:podfile], Bundler.root
+          return podfile_path if File.exist? podfile_path
+          UI.user_error! "#{podfile_path} not found"
+        end
+
+        xcodeproj_path = xcodeproj_path_from_params(params)
+        # Look in the same directory as the project (typical setup)
+        podfile_path = File.expand_path "../Podfile", xcodeproj_path
+        return podfile_path if File.exist? podfile_path
+
+        # Scan the repo. If one Podfile found, return it.
+        repo_path = Bundler.root
+
+        all_podfile_paths = Dir[File.expand_path(File.join(repo_path, '**/Podfile'))]
+        return nil unless all_podfile_paths.count == 1
+        all_podfile_paths.first
+      end
+
+      def cartfile_path_from_params(params)
+        # Disable Cartfile update if add_sdk: false is present
+        return nil unless add_sdk? params
+
+        # Use the :cartfile parameter if present
+        if params[:cartfile]
+          UI.user_error! ":cartfile argument must specify a path ending in '/Cartfile'" unless params[:cartfile] =~ %r{/Cartfile$}
+          cartfile_path = File.expand_path params[:cartfile], Bundler.root
+          return cartfile_path if File.exist? cartfile_path
+          UI.user_error! "#{cartfile_path} not found"
+        end
+
+        xcodeproj_path = xcodeproj_path_from_params(params)
+        # Look in the same directory as the project (typical setup)
+        cartfile_path = File.expand_path "../Cartfile", xcodeproj_path
+        return cartfile_path if File.exist? cartfile_path
+
+        # Scan the repo. If one Cartfile found, return it.
+        repo_path = Bundler.root
+
+        all_cartfile_paths = Dir[File.expand_path(File.join(repo_path, '**/Cartfile'))]
+        return nil unless all_cartfile_paths.count == 1
+        all_cartfile_paths.first
+      end
+
+      def add_sdk?(params)
+        add_sdk_param = params[:add_sdk]
+        return false if add_sdk_param.nil?
+
+        case add_sdk_param
+        when String
+          add_sdk_param.casecmp? "true"
+        else
+          add_sdk_param
+        end
+      end
     end
   end
 end

data/lib/fastlane/plugin/branch/helper/ios_helper.rb

@@ -1,3 +1,4 @@
+require "fastlane/plugin/patch"
 require "plist"
 
 module Fastlane
@@ -335,6 +336,162 @@ module Fastlane
 
         target.add_system_framework frameworks
       end
+
+      def patch_app_delegate_swift(project)
+        app_delegate_swift = project.files.find { |f| f.path =~ /AppDelegate.swift$/ }
+        return false if app_delegate_swift.nil?
+
+        app_delegate_swift_path = app_delegate_swift.real_path.to_s
+
+        app_delegate = File.open(app_delegate_swift_path, &:read)
+        return false if app_delegate =~ /import\s+Branch/
+
+        UI.message "Patching #{app_delegate_swift_path}"
+
+        Actions::PatchAction.run(
+          files: app_delegate_swift_path,
+          regexp: /^\s*import .*$/,
+          text: "\nimport Branch",
+          mode: :prepend,
+          offset: 0
+        )
+
+        # TODO: This is Swift 3. Support other versions, esp. 4.
+        init_session_text = <<-EOF
+        Branch.getInstance().initSession(launchOptions: launchOptions) {
+            universalObject, linkProperties, error in
+
+            // TODO: Route Branch links
+        }
+        EOF
+
+        Actions::PatchAction.run(
+          files: app_delegate_swift_path,
+          regexp: /didFinishLaunchingWithOptions.*\{[^\n]*\n/m,
+          text: init_session_text,
+          mode: :append,
+          offset: 0
+        )
+
+        unless app_delegate =~ /application:.*continueUserActivity:.*restorationHandler:/
+          # Add the application:continueUserActivity:restorationHandler method if it does not exist
+          continue_user_activity_text = <<-EOF
+
+
+    func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool {
+      return Branch.getInstance().continue(userActivity)
+    }
+          EOF
+
+          Actions::PatchAction.run(
+            files: app_delegate_swift_path,
+            regexp: /\n\s*\}[^{}]*\Z/m,
+            text: continue_user_activity_text,
+            mode: :prepend,
+            offset: 0
+          )
+        end
+
+        add_change app_delegate_swift_path
+        true
+      end
+
+      def patch_app_delegate_objc(project)
+        app_delegate_objc = project.files.find { |f| f.path =~ /AppDelegate.m$/ }
+        return false if app_delegate_objc.nil?
+
+        app_delegate_objc_path = app_delegate_objc.real_path.to_s
+
+        app_delegate = File.open(app_delegate_objc_path, &:read)
+        return false if app_delegate =~ %r{^\s+#import\s+<Branch/Branch.h>|^\s+@import\s+Branch;}
+
+        UI.message "Patching #{app_delegate_objc_path}"
+
+        Actions::PatchAction.run(
+          files: app_delegate_objc_path,
+          regexp: /^\s+@import|^\s+#import.*$/,
+          text: "\n#import <Branch/Branch.h>",
+          mode: :prepend,
+          offset: 0
+        )
+
+        init_session_text = <<-EOF
+    [[Branch getInstance] initSessionWithLaunchOptions:launchOptions
+        andRegisterDeepLinkHandlerUsingBranchUniversalObject:^(BranchUniversalObject *universalObject, BranchLinkProperties *linkProperties, NSError *error){
+        // TODO: Route Branch links
+    }];
+        EOF
+
+        Actions::PatchAction.run(
+          files: app_delegate_objc_path,
+          regexp: /didFinishLaunchingWithOptions.*\{[^\n]*\n/m,
+          text: init_session_text,
+          mode: :append,
+          offset: 0
+        )
+
+        unless app_delegate =~ /application:.*continueUserActivity:.*restorationHandler:/
+          # Add the application:continueUserActivity:restorationHandler method if it does not exist
+          continue_user_activity_text = <<-EOF
+
+
+- (BOOL)application:(UIApplication *)app continueUserActivity:(nonnull NSUserActivity *)userActivity restorationHandler:(nonnull void (^)(NSArray * _Nullable))restorationHandler
+{
+    return [[Branch getInstance] continueUserActivity:userActivity];
+}
+          EOF
+
+          Actions::PatchAction.run(
+            files: app_delegate_objc_path,
+            regexp: /\n\s*@end[^@]*\Z/m,
+            text: continue_user_activity_text,
+            mode: :prepend,
+            offset: 0
+          )
+        end
+
+        add_change app_delegate_objc_path
+        true
+      end
+
+      def patch_podfile(podfile_path)
+        podfile = File.open(podfile_path, &:read)
+
+        # Podfile already contains the Branch pod
+        return false if podfile =~ /pod\s+('Branch'|"Branch")/
+
+        UI.message "Adding pod \"Branch\" to #{podfile_path}"
+
+        # TODO: Improve this patch. Should work in the majority of cases for now.
+        Actions::PatchAction.run(
+          files: podfile_path,
+          regexp: /^\s*pod\s*/,
+          text: "\npod \"Branch\"",
+          mode: :prepend,
+          offset: 0
+        )
+
+        true
+      end
+
+      def patch_cartfile(cartfile_path)
+        cartfile = File.open(cartfile_path, &:read)
+
+        # Cartfile already contains the Branch framework
+        return false if cartfile =~ /git.+Branch/
+
+        UI.message "Adding \"Branch\" to #{cartfile_path}"
+
+        Actions::PatchAction.run(
+          files: cartfile_path,
+          regexp: /\z/,
+          text: "git \"https://github.com/BranchMetrics/ios-branch-deep-linking\"\n",
+          mode: :append,
+          offset: 0
+        )
+
+        true
+      end
     end
   end
 end

data/lib/fastlane/plugin/branch/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Branch
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-branch
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Branch
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-01 00:00:00.000000000 Z
+date: 2017-09-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: fastlane-plugin-patch
+  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: plist
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +109,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +137,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fastlane
   requirement: !ruby/object:Gem::Requirement