branch_io_cli 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e44ff16984837cc68abcc18111323a33b52cd1f
-  data.tar.gz: 81f3b075bb26b8037754313ee745269c26d2c224
+  metadata.gz: 6ed6a08fd41a779e66e95b3d4bbfd60b73f9f1a7
+  data.tar.gz: 86d0ab68a447fa963a9bb40810aec4c9e7a54d13
 SHA512:
-  metadata.gz: 1482aad528f89e1d23d031719fab36d10611104c39edb0e113e099bdbfaee5d533855a5555d8a50dc12d056c6b14b388f6842c8f98f96802826b694bbd06cb3e
-  data.tar.gz: a664d4adfebdacd3e9e5874a47ce01a469d3d9224c32c7ccff9e3464c4d169ecf106fbcbb292800d77d3d3a7cae6f9bdbf7734d485c144bcfe61a68882730832
+  metadata.gz: 6853fe36957e1364ee1d3cfabfc43126d49570c8799838648619ddba431f62a0ddab9de3bdb641a9907d5f48d2fd3968226cb91b7e2001b65496dafdc5629ba2
+  data.tar.gz: f37d61ba24b28fb17663d2ae71d7c38c800458fb58c12fb68ef2381e4e243c4688936b5ee4a9d16cfe1d57bfa87378d9ed24ab37ee04840bc3167974d1068d69

data/README.md

@@ -11,6 +11,11 @@ This is a command-line tool to integrate the Branch SDK into mobile app projects
 
 This is a preliminary release of this gem. Please report any problems by opening issues in this repo.
 
+### Using Fastlane?
+
+See also the [Branch Fastlane plugin](https://github.com/BranchMetrics/fastlane-plugin-branch), which offers
+the same support via Fastlane.
+
 ## Getting started
 
 ```bash
@@ -125,3 +130,8 @@ and no Universal Link domain is present that does not pass validation.
 #### Return value
 
 If validation passes, this command returns 0. If validation fails, it returns 1.
+
+## Examples
+
+See the [examples](./examples) folder for several example projects that can be
+used to exercise the CLI.

data/lib/branch_io_cli/command.rb

@@ -1,15 +1,16 @@
+require "pathname"
 require "xcodeproj"
 
 module BranchIOCLI
   class Command
     class << self
       def setup(options)
-        options = Helper::ConfigurationHelper.validate_setup_options options
+        config_helper.validate_setup_options options
 
-        @keys = Helper::ConfigurationHelper.keys
-        @domains = Helper::ConfigurationHelper.all_domains
-        @xcodeproj_path = options.xcodeproj
-        xcodeproj = Helper::ConfigurationHelper.xcodeproj
+        @keys = config_helper.keys
+        @domains = config_helper.all_domains
+        @xcodeproj_path = config_helper.xcodeproj_path
+        xcodeproj = config_helper.xcodeproj
 
         update_podfile(options) || update_cartfile(options, xcodeproj)
 
@@ -38,14 +39,17 @@ module BranchIOCLI
 
         return unless options.commit
 
-        `git commit #{helper.changes.to_a.join(" ")} -m '[branch_io_cli] Branch SDK integration'`
+        current_pathname = Pathname.new File.expand_path "."
+        changes = helper.changes.to_a.map { |c| Pathname.new(File.expand_path(c)).relative_path_from(current_pathname).to_s }
+
+        `git commit #{changes.join(" ")} -m '[branch_io_cli] Branch SDK integration'`
       end
 
       def validate(options)
-        options = Helper::ConfigurationHelper.validate_validation_options options
+        config_helper.validate_validation_options options
 
         # raises
-        xcodeproj = Helper::ConfigurationHelper.xcodeproj
+        xcodeproj = config_helper.xcodeproj
 
         valid = true
 
@@ -80,45 +84,15 @@ module BranchIOCLI
       end
 
       def helper
-        BranchIOCLI::Helper::BranchHelper
+        Helper::BranchHelper
       end
 
-      def podfile_path(options)
-        # Disable Podfile update if add_sdk: false is present
-        return nil if options.no_add_sdk
-
-        # Use the :podfile parameter if present
-        if options.podfile
-          raise "--podfile argument must specify a path ending in '/Podfile'" unless options.podfile =~ %r{/Podfile$}
-          podfile_path = File.expand_path options.podfile, "."
-          return podfile_path if File.exist? podfile_path
-          raise "#{podfile_path} not found"
-        end
-
-        # 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
-      end
-
-      def cartfile_path(options)
-        # Disable Cartfile update if add_sdk: false is present
-        return nil if options.no_add_sdk
-
-        # Use the :cartfile parameter if present
-        if options.cartfile
-          raise "--cartfile argument must specify a path ending in '/Cartfile'" unless options.cartfile =~ %r{/Cartfile$}
-          cartfile_path = File.expand_path options.cartfile, "."
-          return cartfile_path if File.exist? cartfile_path
-          raise "#{cartfile_path} not found"
-        end
-
-        # 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
+      def config_helper
+        Helper::ConfigurationHelper
       end
 
       def update_podfile(options)
-        podfile_path = podfile_path options
+        podfile_path = config_helper.podfile_path
         return false if podfile_path.nil?
 
         # 1. Patch Podfile. Return if no change (Branch pod already present).
@@ -138,7 +112,8 @@ module BranchIOCLI
         helper.add_change "#{podfile_path}.lock"
 
         # 4. Check if Pods folder is under SCM
-        pods_folder_path = File.expand_path "../Pods", podfile_path
+        current_pathname = Pathname.new File.expand_path "."
+        pods_folder_path = Pathname.new(File.expand_path("../Pods", podfile_path)).relative_path_from current_pathname
         `git ls-files #{pods_folder_path} --error-unmatch > /dev/null 2>&1`
         return true unless $?.exitstatus == 0
 
@@ -150,7 +125,7 @@ module BranchIOCLI
       end
 
       def update_cartfile(options, project)
-        cartfile_path = cartfile_path options
+        cartfile_path = config_helper.cartfile_path
         return false if cartfile_path.nil?
 
         # 1. Patch Cartfile. Return if no change (Branch already present).
@@ -158,7 +133,7 @@ module BranchIOCLI
 
         # 2. carthage update
         Dir.chdir(File.dirname(cartfile_path)) do
-          system "carthage update"
+          system "carthage update --platform ios"
         end
 
         # 3. Add Cartfile and Cartfile.resolved to commit (in case :commit param specified)
@@ -166,7 +141,7 @@ module BranchIOCLI
         helper.add_change "#{cartfile_path}.resolved"
 
         # 4. Add to target depependencies
-        frameworks_group = project['Frameworks']
+        frameworks_group = project.frameworks_group
         branch_framework = frameworks_group.new_file "Carthage/Build/iOS/Branch.framework"
         target = helper.target_from_project project, options.target
         target.frameworks_build_phase.add_file_reference branch_framework
@@ -182,11 +157,12 @@ module BranchIOCLI
         end
 
         # 6. Check if Carthage folder is under SCM
-        carthage_folder_path = File.expand_path "../Carthage", cartfile_path
+        current_pathname = Pathname.new File.expand_path "."
+        carthage_folder_path = Pathname.new(File.expand_path("../Carthage", cartfile_path)).relative_path_from current_pathname
         `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)
+        # 7. If so, add the Carthage folder to the commit (in case :commit param specified)
         helper.add_change carthage_folder_path
         `git add #{carthage_folder_path}` if options.commit
 

data/lib/branch_io_cli/helper/configuration_helper.rb

@@ -1,23 +1,33 @@
+require "json"
+require "net/http"
+require "pathname"
 require "xcodeproj"
+require "zip"
 
 module BranchIOCLI
   module Helper
     class ConfigurationHelper
       class << self
+        attr_accessor :xcodeproj_path
         attr_accessor :xcodeproj
         attr_accessor :keys
         attr_accessor :all_domains
+        attr_accessor :podfile_path
+        attr_accessor :cartfile_path
 
         def validate_setup_options(options)
-          options.xcodeproj = xcodeproj_path options
+          say "--force is ignored when --no_validate is used." if options.no_validate && options.force
+
+          validate_xcodeproj_path options
           validate_keys_from_setup_options options
           validate_all_domains options
-          options
+          validate_buildfile_path options, "Podfile"
+          validate_buildfile_path options, "Cartfile"
+          validate_sdk_addition options
         end
 
         def validate_validation_options(options)
-          options.xcodeproj = xcodeproj_path options
-          options
+          validate_xcodeproj_path options
         end
 
         def validate_keys_from_setup_options(options)
@@ -50,14 +60,20 @@ module BranchIOCLI
         # 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.
-        def xcodeproj_path(options)
+        def validate_xcodeproj_path(options)
           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.reject { |p| p =~ /Pods|Carthage/ }
+            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
           end
@@ -67,9 +83,11 @@ module BranchIOCLI
             # TODO: Allow the user to choose if xcodeproj_paths.count > 0
             begin
               @xcodeproj = Xcodeproj::Project.open path
-              return path
+              @xcodeproj_path = path
+              return
             rescue StandardError => e
               say e.message
+              path = nil
             end
           end
         end
@@ -96,6 +114,244 @@ module BranchIOCLI
           end
           domains
         end
+
+        def validate_buildfile_path(options, filename)
+          # Disable Podfile/Cartfile update if --no_add_sdk is present
+          return if options.no_add_sdk
+
+          buildfile_path = filename == "Podfile" ? options.podfile : options.cartfile
+
+          # Was --podfile/--cartfile used?
+          if buildfile_path
+            # Yes: Validate. Prompt if not valid.
+            loop do
+              valid = buildfile_path =~ %r{/?#{filename}$}
+              say "#{filename} path must end in /#{filename}." unless valid
+
+              if valid
+                valid = File.exist? buildfile_path
+                say "#{buildfile_path} not found." unless valid
+              end
+
+              if valid
+                if filename == "Podfile"
+                  @podfile_path = buildfile_path
+                else
+                  @cartfile_path = buildfile_path
+                end
+                return
+              end
+
+              buildfile_path = ask "Please enter the path to your #{filename}: "
+            end
+          end
+
+          # No: Check for Podfile/Cartfile next to @xcodeproj_path
+          buildfile_path = File.expand_path "../#{filename}", @xcodeproj_path
+          return unless File.exist? buildfile_path
+
+          # Exists: Use it (valid if found)
+          if filename == "Podfile"
+            @podfile_path = buildfile_path
+          else
+            @cartfile_path = buildfile_path
+          end
+        end
+
+        def validate_sdk_addition(options)
+          return if options.no_add_sdk || @podfile_path || @cartfile_path
+
+          # If no CocoaPods or Carthage, check to see if the framework is linked.
+          target = BranchHelper.target_from_project @xcodeproj, options.target
+          return if target.frameworks_build_phase.files.map(&:file_ref).map(&:path).any? { |p| p =~ %r{/Branch.framework$} }
+
+          # --podfile, --cartfile not specified. No Podfile found. No Cartfile found. No Branch.framework in project.
+          # Prompt the user:
+          selected = choose do |menu|
+            menu.header = "No Podfile or Cartfile specified or found. Here are your options"
+
+            SDK_OPTIONS.each_key { |k| menu.choice k }
+
+            menu.prompt = "What would you like to do?"
+          end
+
+          option = SDK_OPTIONS[selected]
+
+          case option
+          when :skip
+            return
+          else
+            send "add_#{option}", options
+          end
+        end
+
+        def add_cocoapods(options)
+          @podfile_path = File.expand_path "../Podfile", @xcodeproj_path
+          target = BranchHelper.target_from_project @xcodeproj, options.target
+
+          File.open(@podfile_path, "w") do |file|
+            file.write <<EOF
+platform :ios, "#{target.deployment_target}"
+
+pod "Branch"
+
+#{@xcodeproj.targets.map { |t| "target \"#{t.name}\"" }.join("\n")}
+EOF
+          end
+
+          command = "pod install"
+          command += " --repo-update" unless options.no_pod_repo_update
+          Dir.chdir(File.dirname(@podfile_path)) do
+            system command
+          end
+
+          BranchHelper.add_change @podfile_path
+          BranchHelper.add_change "#{@podfile_path}.lock"
+
+          # For now, add Pods folder to SCM.
+          current_pathname = Pathname.new File.expand_path "."
+          pods_folder_path = Pathname.new(File.expand_path("../Pods", podfile_path)).relative_path_from current_pathname
+          workspace_path = Pathname.new(File.expand_path(@xcodeproj_path.sub(/.xcodeproj$/, ".xcworkspace"))).relative_path_from current_pathname
+          podfile_pathname = Pathname.new(@podfile_path).relative_path_from current_pathname
+          BranchHelper.add_change pods_folder_path
+          BranchHelper.add_change workspace_path
+          `git add #{podfile_pathname} #{podfile_pathname}.lock #{pods_folder_path} #{workspace_path}` if options.commit
+        end
+
+        def add_carthage(options)
+          # TODO: Collapse this and Command::update_cartfile
+
+          # 1. Generate Cartfile
+          @cartfile_path = File.expand_path "../Cartfile", @xcodeproj_path
+          File.open(@cartfile_path, "w") do |file|
+            file.write <<EOF
+github "BranchMetrics/ios-branch-deep-linking"
+EOF
+          end
+
+          # 2. carthage update
+          Dir.chdir(File.dirname(@cartfile_path)) do
+            system "carthage update --platform ios"
+          end
+
+          # 3. Add Cartfile and Cartfile.resolved to commit (in case :commit param specified)
+          BranchHelper.add_change cartfile_path
+          BranchHelper.add_change "#{cartfile_path}.resolved"
+
+          # 4. Add to target depependencies
+          frameworks_group = @xcodeproj.frameworks_group
+          branch_framework = frameworks_group.new_file "Carthage/Build/iOS/Branch.framework"
+          target = BranchHelper.target_from_project @xcodeproj, options.target
+          target.frameworks_build_phase.add_file_reference branch_framework
+
+          # 5. Create a copy-frameworks build phase
+          carthage_build_phase = target.new_shell_script_build_phase "carthage copy-frameworks"
+          carthage_build_phase.shell_script = "/usr/local/bin/carthage copy-frameworks"
+
+          carthage_build_phase.input_paths << "$(SRCROOT)/Carthage/Build/iOS/Branch.framework"
+          carthage_build_phase.output_paths << "$(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/Branch.framework"
+
+          @xcodeproj.save
+
+          # For now, add Carthage folder to SCM
+
+          # 6. Add the Carthage folder to the commit (in case :commit param specified)
+          current_pathname = Pathname.new File.expand_path "."
+          carthage_folder_path = Pathname.new(File.expand_path("../Carthage", cartfile_path)).relative_path_from(current_pathname)
+          cartfile_pathname = Pathname.new(@cartfile_path).relative_path_from current_pathname
+          BranchHelper.add_change carthage_folder_path
+          `git add #{cartfile_pathname} #{cartfile_pathname}.resolved #{carthage_folder_path}` if options.commit
+        end
+
+        def add_direct(options)
+          # TODO: Put these intermediates in a temp directory until Branch.framework is unzipped
+          # (and validated?). For now dumped in the current directory.
+          File.unlink "Branch.framework.zip" if File.exist? "Branch.framework.zip"
+          remove_directory "Branch.framework"
+
+          say "Finding current framework release..."
+
+          # Find the latest release from GitHub.
+          releases = JSON.parse fetch "https://api.github.com/repos/BranchMetrics/ios-branch-deep-linking/releases"
+          current_release = releases.first
+          # Get the download URL for the framework.
+          framework_asset = current_release["assets"][0]
+          framework_url = framework_asset["browser_download_url"]
+
+          say "Downloading Branch.framework v. #{current_release['tag_name']} (#{framework_asset['size']} bytes zipped)..."
+
+          # Download the framework zip
+          File.open("Branch.framework.zip", "w") do |file|
+            file.write fetch framework_url
+          end
+
+          say "Unzipping Branch.framework..."
+
+          # Unzip
+          Zip::File.open "Branch.framework.zip" do |zip_file|
+            # Start with just the framework and add dSYM, etc., later
+            zip_file.glob "Carthage/Build/iOS/Branch.framework/**/*" do |entry|
+              filename = entry.name.sub %r{^Carthage/Build/iOS/}, ""
+              ensure_directory File.dirname filename
+              entry.extract filename
+            end
+          end
+
+          # Remove intermediate zip file
+          File.unlink "Branch.framework.zip"
+
+          # Now the current framework is in ./Branch.framework
+
+          say "Adding to #{@xcodeproj_path}..."
+
+          # Add as a dependency in the Frameworks group
+          frameworks_group = @xcodeproj.frameworks_group
+          framework = frameworks_group.new_file "Branch.framework"
+          target = BranchHelper.target_from_project @xcodeproj, options.target
+          target.frameworks_build_phase.add_file_reference framework, true
+          @xcodeproj.save
+
+          BranchHelper.add_change File.expand_path "Branch.framework"
+          `git add Branch.framework` if options.commit
+
+          say "Done. ✅"
+        end
+
+        def fetch(url)
+          response = Net::HTTP.get_response URI(url)
+
+          case response
+          when Net::HTTPRedirection
+            fetch response['location']
+          else
+            response.body
+          end
+        end
+
+        def ensure_directory(path)
+          return if path == "/" || path == "."
+          parent = File.dirname path
+          ensure_directory parent
+          return if Dir.exist? path
+          Dir.mkdir path
+        end
+
+        def remove_directory(path)
+          return unless File.exist? path
+
+          Dir["#{path}/*"].each do |file|
+            remove_directory(file) and next if File.directory?(file)
+            File.unlink file
+          end
+        end
+
+        SDK_OPTIONS =
+          {
+            "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,
+            "Skip adding the framework to the project." => :skip
+          }
       end
     end
   end

data/lib/branch_io_cli/version.rb

@@ -1,3 +1,3 @@
 module BranchIOCLI
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch_io_cli
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Branch
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-16 00:00:00.000000000 Z
+date: 2017-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -53,6 +53,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  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: xcodeproj
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cocoapods
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -155,16 +183,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement