Merge pull request #25 from BranchMetrics/system-frameworks

Added a :frameworks option to add system frameworks to iOS projects

Author: jdee

Branchfile

@@ -8,3 +8,4 @@ app_link_subdomain "bnctestbed"
 uri_scheme "branchtest"
 android_project_path "examples/android/BranchPluginExample"
 xcodeproj "examples/ios/BranchPluginExample/BranchPluginExample.xcodeproj"
+frameworks %w{AdSupport CoreSpotlight SafariServices}

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fastlane-plugin-branch (0.2.2)
+    fastlane-plugin-branch (0.3.0)
       plist
       xcodeproj
 
@@ -14,15 +14,15 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.5.1)
-      public_suffix (~> 2.0, >= 2.0.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
     ast (2.3.0)
     babosa (1.0.2)
     claide (1.0.2)
-    cocoapods (1.3.0)
+    cocoapods (1.3.1)
       activesupport (>= 4.0.2, < 5)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.3.0)
+      cocoapods-core (= 1.3.1)
       cocoapods-deintegrate (>= 1.0.1, < 2.0)
       cocoapods-downloader (>= 1.1.3, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -38,7 +38,7 @@ GEM
       nap (~> 1.0)
       ruby-macho (~> 1.1)
       xcodeproj (>= 1.5.1, < 2.0)
-    cocoapods-core (1.3.0)
+    cocoapods-core (1.3.1)
       activesupport (>= 4.0.2, < 6)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
@@ -66,15 +66,15 @@ GEM
     dotenv (2.2.1)
     escape (0.0.4)
     excon (0.58.0)
-    faraday (0.12.2)
+    faraday (0.13.1)
       multipart-post (>= 1.2, < 3)
     faraday-cookie_jar (0.0.6)
       faraday (>= 0.7.4)
       http-cookie (~> 1.0.0)
     faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
     fastimage (2.1.0)
-    fastlane (2.50.1)
+    fastlane (2.55.0)
       CFPropertyList (>= 2.3, < 3.0.0)
       addressable (>= 2.3, < 3.0.0)
       babosa (>= 1.0.2, < 2.0.0)
@@ -88,28 +88,29 @@ GEM
       faraday_middleware (~> 0.9)
       fastimage (>= 2.1.0, < 3.0.0)
       gh_inspector (>= 1.0.1, < 2.0.0)
-      google-api-client (>= 0.12.0, < 0.13.0)
+      google-api-client (>= 0.13.1, < 0.14.0)
       highline (>= 1.7.2, < 2.0.0)
       json (< 3.0.0)
       mini_magick (~> 4.5.1)
       multi_json
       multi_xml (~> 0.5)
       multipart-post (~> 2.0.0)
       plist (>= 3.1.0, < 4.0.0)
+      public_suffix (~> 2.0.0)
       rubyzip (>= 1.1.0, < 2.0.0)
       security (= 0.1.3)
       slack-notifier (>= 1.3, < 2.0.0)
       terminal-notifier (>= 1.6.2, < 2.0.0)
       terminal-table (>= 1.4.5, < 2.0.0)
       tty-screen (~> 0.5.0)
       word_wrap (~> 1.0.0)
-      xcodeproj (>= 1.4.4, < 2.0.0)
+      xcodeproj (>= 1.5.0, < 2.0.0)
       xcpretty (>= 0.2.4, < 1.0.0)
       xcpretty-travis-formatter (>= 0.0.3)
     fourflusher (2.0.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.0.3)
-    google-api-client (0.12.0)
+    google-api-client (0.13.4)
       addressable (~> 2.5, >= 2.5.1)
       googleauth (~> 0.5)
       httpclient (>= 2.8.1, < 3.0)
@@ -199,11 +200,11 @@ GEM
       faraday (~> 0.9)
       jwt (~> 1.5)
       multi_json (~> 1.10)
-    simplecov (0.14.1)
+    simplecov (0.15.0)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.1)
+    simplecov-html (0.10.2)
     slack-notifier (1.5.1)
     slop (3.6.0)
     terminal-notifier (1.8.0)

README.md

@@ -86,7 +86,8 @@ Available options:
 |:remove_existing_domains|If true, any domains currently configured in the Xcode project or Android manifest will be removed before adding the domains specified by the arguments. Mainly useful for sample apps.|BRANCH_REMOVE_EXISTING_DOMAINS|boolean|false|
 |:validate|Determines whether to validate the resulting Universal Link configuration before modifying the project|BRANCH_VALIDATE|boolean|true|
 |: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|boolean or string|BRANCH_COMMIT_CHANGES|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|[]|
 
 Individually, all parameters are optional, but the following conditions apply:
 
@@ -143,10 +144,10 @@ This action does not use the Branchfile.
 Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. To try it:
 
 ```bash
-bundle exec fastlane validate          # The example project needs to be set up. This will fail.
-bundle exec fastlane update            # Also validates the UL configuration.
-bundle exec fastlane update_and_commit # Also commit changes to Git. (git reset --hard HEAD^ to erase the last commit)
-bundle exec fastlane validate          # Now validation will pass.
+bundle exec fastlane validate         # The example project needs to be set up. This will fail.
+bundle exec fastlane setup            # Also validates the UL configuration.
+bundle exec fastlane setup_and_commit # Also commit changes to Git. (git reset --hard HEAD^ to erase the last commit)
+bundle exec fastlane validate         # Now validation will pass.
 ```
 
 ## Run tests for this plugin

fastlane/Fastfile

@@ -1,10 +1,10 @@
 desc "Add Branch keys and Universal Link domains to BranchPluginExample"
-lane :update do
+lane :setup do
   setup_branch
 end
 
 desc "Add Branch keys and Universal Link domains to BranchPluginExample and commit to Git"
-lane :update_and_commit do
+lane :setup_and_commit do
   setup_branch commit: true # Use a string here for a custom commit message
 end
 

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

@@ -47,6 +47,9 @@ def self.run(params)
           helper.add_branch_universal_link_domains_to_info_plist xcodeproj, target, domains
           new_path = helper.add_universal_links_to_project xcodeproj, target, domains, params[:remove_existing_domains]
           other_action.git_add path: new_path if params[:commit] && new_path
+
+          helper.add_system_frameworks xcodeproj, target, params[:frameworks] unless params[:frameworks].empty?
+
           xcodeproj.save
         end
 
@@ -192,7 +195,13 @@ def self.available_options
                                description: "Set to true to commit changes to Git; set to a string to commit with a custom message",
                                   optional: true,
                              default_value: false,
-                                 is_string: false)
+                                 is_string: false),
+          FastlaneCore::ConfigItem.new(key: :frameworks,
+                                  env_name: "BRANCH_FRAMEWORKS",
+                               description: "A list of system frameworks to add to the target that uses the Branch SDK (iOS only)",
+                                  optional: true,
+                             default_value: [],
+                                      type: Array)
         ]
       end
 

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

@@ -329,6 +329,12 @@ def expanded_build_setting(target, setting_name, configuration)
         end
         setting_value
       end
+
+      def add_system_frameworks(project, target_name, frameworks)
+        target = target_from_project project, target_name
+
+        target.add_system_framework frameworks
+      end
     end
   end
 end

lib/fastlane/plugin/branch/version.rb

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