branch_io_cli 0.9.0 → 0.9.1

data/lib/branch_io_cli/{commands → command}/setup_command.rb

@@ -1,13 +1,16 @@
 require "branch_io_cli/helper/methods"
+require "shellwords"
 
 module BranchIOCLI
-  module Commands
+  module Command
     class SetupCommand < Command
+      attr_reader :config
+
       def initialize(options)
         super
-        config_helper.validate_setup_options options
-        @keys = config_helper.keys
-        @domains = config_helper.all_domains
+        @config = Configuration::SetupConfiguration.new options
+        @keys = config.keys
+        @domains = config.all_domains
       end
 
       # rubocop: disable Metrics/PerceivedComplexity
@@ -15,26 +18,9 @@ module BranchIOCLI
         # Make sure the user stashes or commits before continuing.
         check_repo_status
 
-        xcodeproj = config_helper.xcodeproj
-
-        case config_helper.sdk_integration_mode
-        when :cocoapods
-          if File.exist? config_helper.podfile_path
-            helper.update_podfile options
-          else
-            helper.add_cocoapods options
-          end
-        when :carthage
-          if File.exist? config_helper.cartfile_path
-            helper.update_cartfile options, xcodeproj
-          else
-            helper.add_carthage options
-          end
-        when :direct
-          helper.add_direct options
-        end
+        xcodeproj = config.xcodeproj
 
-        is_app_target = !config_helper.target.extension_target_type?
+        is_app_target = !config.target.extension_target_type?
 
         if is_app_target && options.validate &&
            !helper.validate_team_and_bundle_ids_from_aasa_files(@domains)
@@ -51,13 +37,30 @@ module BranchIOCLI
         helper.ensure_uri_scheme_in_info_plist if is_app_target # does nothing if already present
 
         new_path = helper.add_universal_links_to_project @domains, false if is_app_target
-        sh "git add #{new_path}" if options.commit && new_path
+        sh "git add #{Shellwords.escape(new_path)}" if options.commit && new_path
 
         config_helper.target.add_system_frameworks options.frameworks unless options.frameworks.nil? || options.frameworks.empty?
 
         xcodeproj.save
 
-        helper.patch_source xcodeproj if options.patch_source
+        case config.sdk_integration_mode
+        when :cocoapods
+          if File.exist? config.podfile_path
+            helper.update_podfile options
+          else
+            helper.add_cocoapods options
+          end
+        when :carthage
+          if File.exist? config.cartfile_path
+            helper.update_cartfile options, xcodeproj
+          else
+            helper.add_carthage options
+          end
+        when :direct
+          helper.add_direct options
+        end
+
+        patch_helper.patch_source xcodeproj if options.patch_source
 
         return unless options.commit
 
@@ -98,7 +101,7 @@ module BranchIOCLI
           sh "git stash -q"
         when /^Commit/
           message = ask "Please enter a commit message: "
-          sh "git commit -aqm'#{message}'"
+          sh "git commit -aqm #{Shellwords.escape(message)}"
         else
           say "Please stash or commit your changes before continuing."
           exit(-1)

data/lib/branch_io_cli/{commands → command}/validate_command.rb

@@ -1,9 +1,11 @@
 module BranchIOCLI
-  module Commands
+  module Command
     class ValidateCommand < Command
+      attr_reader :config
+
       def initialize(options)
         super
-        config_helper.validate_validation_options options
+        @config = Configuration::ValidateConfiguration.new options
       end
 
       def run!

data/lib/branch_io_cli/configuration.rb

@@ -0,0 +1,4 @@
+require "branch_io_cli/configuration/configuration"
+require "branch_io_cli/configuration/report_configuration"
+require "branch_io_cli/configuration/setup_configuration"
+require "branch_io_cli/configuration/validate_configuration"

data/lib/branch_io_cli/configuration/configuration.rb

@@ -0,0 +1,211 @@
+require "cocoapods-core"
+require "pathname"
+require "xcodeproj"
+
+module BranchIOCLI
+  module Configuration
+    class Configuration
+      class << self
+        attr_accessor :current
+      end
+
+      attr_reader :options
+      attr_reader :xcodeproj
+      attr_reader :xcodeproj_path
+      attr_reader :target
+      attr_reader :podfile
+      attr_reader :podfile_path
+      attr_reader :cartfile_path
+      attr_reader :sdk_integration_mode
+      attr_reader :workspace
+      attr_reader :workspace_path
+      attr_reader :pod_repo_update
+
+      def initialize(options)
+        @options = options
+        @pod_repo_update = options.pod_repo_update
+        Configuration.current = self
+
+        print_identification self.class.name.sub(/^.*::(.*?)Configuration$/, '\1').downcase
+        validate_options
+        log
+      end
+
+      def validate_options
+        # implemented in subclasses
+      end
+
+      def log
+        say <<EOF
+<%= color('Configuration:', [CYAN, BOLD, UNDERLINE]) %>
+
+EOF
+        # subclass implementation follows
+      end
+
+      def print_identification(command)
+        say <<EOF
+
+<%= color("branch_io #{command} v. #{VERSION}", BOLD) %>
+
+EOF
+      end
+
+      def helper
+        Helper::BranchHelper
+      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.
+      def validate_xcodeproj_path
+        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
+        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 = path
+            return
+          rescue StandardError => e
+            say e.message
+            path = nil
+          end
+        end
+      end
+
+      def validate_target(allow_extensions = true)
+        non_test_targets = xcodeproj.targets.reject(&:test_target_type?)
+        raise "No non-test target found in project" if non_test_targets.empty?
+
+        valid_targets = non_test_targets.reject { |t| !allow_extensions && t.extension_target_type? }
+
+        begin
+          target = helper.target_from_project xcodeproj, options.target
+
+          # If a test target was explicitly specified.
+          raise "Cannot use test targets" if target.test_target_type?
+
+          # If an extension target was explicitly specified for validation.
+          raise "Extension targets not allowed for this command" if !allow_extensions && target.extension_target_type?
+
+          @target = target
+        rescue StandardError => e
+          say e.message
+
+          choice = choose do |menu|
+            valid_targets.each { |t| menu.choice t.name }
+            menu.prompt = "Which target do you wish to use? "
+          end
+
+          @target = xcodeproj.targets.find { |t| t.name = choice }
+        end
+      end
+
+      def validate_buildfile_path(buildfile_path, filename)
+        # Disable Podfile/Cartfile update if --no-add-sdk is present
+        return unless sdk_integration_mode.nil?
+
+        # No --podfile or --cartfile option
+        if buildfile_path.nil?
+          # Check for Podfile/Cartfile next to workspace or project
+          buildfile_path = File.expand_path "../#{filename}", (workspace_path || xcodeproj_path)
+          return unless File.exist? buildfile_path
+        end
+
+        # Validate. Prompt if not valid.
+        while !buildfile_path || !validate_buildfile_at_path(buildfile_path, filename)
+          buildfile_path = ask "Please enter the path to your #{filename}: "
+        end
+
+        @sdk_integration_mode = filename == "Podfile" ? :cocoapods : :carthage
+      end
+
+      def open_podfile(path)
+        @podfile = Pod::Podfile.from_file path
+        @podfile_path = path
+        true
+      rescue RuntimeError => e
+        say e.message
+        false
+      end
+
+      def validate_buildfile_at_path(buildfile_path, filename)
+        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 filename == "Podfile" && open_podfile(buildfile_path)
+          true
+        elsif filename == "Cartfile"
+          @cartfile_path = buildfile_path
+          true
+        else
+          false
+        end
+      end
+
+      def uses_frameworks?
+        return nil unless podfile
+        target_definition = podfile.target_definition_list.find { |t| t.name == target.name }
+        return nil unless target_definition
+        target_definition.uses_frameworks?
+      end
+
+      def bridging_header_required?
+        return false unless swift_version
+        # If there is a Podfile and use_frameworks! is not present for this
+        # target, we need a bridging header.
+        podfile && !uses_frameworks?
+      end
+
+      # TODO: How many of these can vary by configuration?
+
+      def modules_enabled?
+        return nil unless target
+        setting = target.resolved_build_setting("CLANG_ENABLE_MODULES")["Release"]
+        return nil unless setting
+        setting == "YES"
+      end
+
+      def bridging_header_path
+        return @bridging_header_path if @bridging_header_path
+
+        return nil unless target
+        path = helper.expanded_build_setting target, "SWIFT_OBJC_BRIDGING_HEADER", "Release"
+        return nil unless path
+
+        @bridging_header_path = File.expand_path path, File.dirname(xcodeproj_path)
+        @bridging_header_path
+      end
+
+      def swift_version
+        return @swift_version if @swift_version
+
+        return nil unless target
+        @swift_version = target.resolved_build_setting("SWIFT_VERSION")["Release"]
+        @swift_version
+      end
+    end
+  end
+end

data/lib/branch_io_cli/configuration/report_configuration.rb

@@ -0,0 +1,164 @@
+module BranchIOCLI
+  module Configuration
+    class ReportConfiguration < Configuration
+      attr_reader :clean
+      attr_reader :header_only
+      attr_reader :scheme
+      attr_reader :configuration
+      attr_reader :report_path
+      attr_reader :sdk
+
+      def validate_options
+        @clean = options.clean
+        @header_only = options.header_only
+        @scheme = options.scheme
+        @target = options.target
+        @configuration = options.configuration
+        @report_path = options.out
+        @sdk = options.sdk
+        @pod_repo_update = options.pod_repo_update
+
+        validate_xcodeproj_and_workspace options
+        validate_target options
+        validate_scheme options
+
+        # If neither --podfile nor --cartfile is present, arbitrarily look for a Podfile
+        # first.
+
+        # If --cartfile is present, don't look for a Podfile. Just validate that
+        # Cartfile.
+        validate_buildfile_path(options.podfile, "Podfile") if options.cartfile.nil?
+
+        # If --podfile is present or a Podfile was found, don't look for a Cartfile.
+        validate_buildfile_path(options.cartfile, "Cartfile") if sdk_integration_mode.nil?
+      end
+
+      def log
+        super
+        say <<EOF
+<%= color('Xcode workspace:', BOLD) %> #{workspace_path || '(none)'}
+<%= color('Xcode project:', BOLD) %> #{xcodeproj_path || '(none)'}
+<%= color('Scheme:', BOLD) %> #{scheme || '(none)'}
+<%= 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('Pod repo update:', BOLD) %> #{pod_repo_update.inspect}
+<%= color('Clean:', BOLD) %> #{clean.inspect}
+<%= color('Report path:', BOLD) %> #{report_path}
+EOF
+      end
+
+      # rubocop: disable Metrics/PerceivedComplexity
+      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 = options.workspace
+          end
+          if options.xcodeproj
+            path = options.xcodeproj
+            @xcodeproj = Xcodeproj::Project.open options.xcodeproj
+            @xcodeproj_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
+        end
+
+        # 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"
+          end
+          valid
+        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|
+            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
+        # 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 = 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 = path
+              return
+            else
+              say "Path must end with .xcworkspace or .xcodeproj"
+            end
+          rescue StandardError => e
+            say e.message
+          end
+        end
+      end
+      # rubocop: enable Metrics/PerceivedComplexity
+
+      def validate_scheme(options)
+        schemes = all_schemes
+        # TODO: Prompt if --scheme specified but not found.
+        if options.scheme && schemes.include?(options.scheme)
+          @scheme = options.scheme
+        elsif schemes.count == 1
+          @scheme = schemes.first
+        elsif !schemes.empty?
+          # By default, take a scheme with the same name as the target name.
+          return if (@scheme = schemes.find { |s| s == target.name })
+
+          say "Please specify one of the following for the --scheme argument:"
+          schemes.each do |scheme|
+            say " #{scheme}"
+          end
+          exit 1
+        else
+          say "No scheme defined in project."
+          exit(-1)
+        end
+      end
+
+      def all_schemes
+        if workspace_path
+          workspace.schemes.keys.reject { |scheme| scheme == "Pods" }
+        else
+          Xcodeproj::Project.schemes xcodeproj_path
+        end
+      end
+    end
+  end
+end