xcodeproj 1.19.0 → 1.22.0

data/lib/xcodeproj/project/project_helper.rb

@@ -41,17 +41,17 @@ module Xcodeproj
       #
       # @return [PBXNativeTarget] the target.
       #
-      def self.new_target(project, type, name, platform, deployment_target, product_group, language)
+      def self.new_target(project, type, name, platform, deployment_target, product_group, language, product_basename)
         # Target
         target = project.new(PBXNativeTarget)
         project.targets << target
         target.name = name
-        target.product_name = name
+        target.product_name = product_basename
         target.product_type = Constants::PRODUCT_TYPE_UTI[type]
         target.build_configuration_list = configuration_list(project, platform, deployment_target, type, language)
 
         # Product
-        product = product_group.new_product_ref_for_target(name, type)
+        product = product_group.new_product_ref_for_target(target.product_name, type)
         target.product_reference = product
 
         # Build phases
@@ -88,12 +88,12 @@ module Xcodeproj
       #
       # @return [PBXNativeTarget] the target.
       #
-      def self.new_resources_bundle(project, name, platform, product_group)
+      def self.new_resources_bundle(project, name, platform, product_group, product_basename)
         # Target
         target = project.new(PBXNativeTarget)
         project.targets << target
         target.name = name
-        target.product_name = name
+        target.product_name = product_basename
         target.product_type = Constants::PRODUCT_TYPE_UTI[:bundle]
 
         # Configuration List
@@ -111,7 +111,7 @@ module Xcodeproj
         target.build_configuration_list = cl
 
         # Product
-        product = product_group.new_bundle(name)
+        product = product_group.new_bundle(target.product_name)
         target.product_reference = product
 
         # Build phases

data/lib/xcodeproj/project.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'atomos'
 require 'fileutils'
 require 'securerandom'
@@ -220,11 +221,11 @@ module Xcodeproj
       end
 
       if archive_version.to_i > Constants::LAST_KNOWN_ARCHIVE_VERSION
-        raise '[Xcodeproj] Unknown archive version.'
+        raise "[Xcodeproj] Unknown archive version (#{archive_version.to_i})."
       end
 
       if object_version.to_i > Constants::LAST_KNOWN_OBJECT_VERSION
-        raise '[Xcodeproj] Unknown object version.'
+        raise "[Xcodeproj] Unknown object version (#{object_version.to_i})."
       end
 
       # Projects can have product_ref_groups that are not listed in the main_groups["Products"]
@@ -711,9 +712,10 @@ module Xcodeproj
     #
     # @return [PBXNativeTarget] the target.
     #
-    def new_target(type, name, platform, deployment_target = nil, product_group = nil, language = nil)
+    def new_target(type, name, platform, deployment_target = nil, product_group = nil, language = nil, product_basename = nil)
       product_group ||= products_group
-      ProjectHelper.new_target(self, type, name, platform, deployment_target, product_group, language)
+      product_basename ||= name
+      ProjectHelper.new_target(self, type, name, platform, deployment_target, product_group, language, product_basename)
     end
 
     # Creates a new resource bundles target and adds it to the project.
@@ -731,9 +733,10 @@ module Xcodeproj
     #
     # @return [PBXNativeTarget] the target.
     #
-    def new_resources_bundle(name, platform, product_group = nil)
+    def new_resources_bundle(name, platform, product_group = nil, product_basename = nil)
       product_group ||= products_group
-      ProjectHelper.new_resources_bundle(self, name, platform, product_group)
+      product_basename ||= name
+      ProjectHelper.new_resources_bundle(self, name, platform, product_group, product_basename)
     end
 
     # Creates a new target and adds it to the project.

data/lib/xcodeproj/scheme/abstract_scheme_action.rb

@@ -23,6 +23,78 @@ module Xcodeproj
       def build_configuration=(config_name)
         @xml_element.attributes['buildConfiguration'] = config_name
       end
+
+      # @return [Array<ExecutionAction>]
+      #         The list of actions to run before this scheme action.
+      #         Each entry can be either a 'Run Script' or a 'Send Email' action.
+      #
+      def pre_actions
+        pre_actions = @xml_element.elements['PreActions']
+        return nil unless pre_actions
+        pre_actions.get_elements('ExecutionAction').map do |entry_node|
+          ExecutionAction.new(entry_node)
+        end
+      end
+
+      # @param [Array<ExecutionAction>] pre_actions
+      #         Set the list of actions to run before this scheme action.
+      #         Each entry can be either a 'Run Script' or a 'Send Email' action.
+      #
+      def pre_actions=(pre_actions)
+        @xml_element.delete_element('PreActions')
+        unless pre_actions.empty?
+          pre_actions_element = @xml_element.add_element('PreActions')
+          pre_actions.each do |entry_node|
+            pre_actions_element.add_element(entry_node.xml_element)
+          end
+        end
+        pre_actions
+      end
+
+      # @param [ExecutionAction] pre_action
+      #        Add an action to the list of actions to run before this scheme action.
+      #        It can be either a 'Run Script' or a 'Send Email' action.
+      #
+      def add_pre_action(pre_action)
+        pre_actions = @xml_element.elements['PreActions'] || @xml_element.add_element('PreActions')
+        pre_actions.add_element(pre_action.xml_element)
+      end
+
+      # @return [Array<ExecutionAction>]
+      #         The list of actions to run after this scheme action.
+      #         Each entry can be either a 'Run Script' or a 'Send Email' action.
+      #
+      def post_actions
+        post_actions = @xml_element.elements['PostActions']
+        return nil unless post_actions
+        post_actions.get_elements('ExecutionAction').map do |entry_node|
+          ExecutionAction.new(entry_node)
+        end
+      end
+
+      # @param [Array<ExecutionAction>] post_actions
+      #        Set the list of actions to run after this scheme action.
+      #        Each entry can be either a 'Run Script' or a 'Send Email' action.
+      #
+      def post_actions=(post_actions)
+        @xml_element.delete_element('PostActions')
+        unless post_actions.empty?
+          post_actions_element = @xml_element.add_element('PostActions')
+          post_actions.each do |entry_node|
+            post_actions_element.add_element(entry_node.xml_element)
+          end
+        end
+        post_actions
+      end
+
+      # @param [ExecutionAction] post_action
+      #        Add an action to the list of actions to run after this scheme action.
+      #        It can be either a 'Run Script' or a 'Send Email' action.
+      #
+      def add_post_action(post_action)
+        post_actions = @xml_element.elements['PostActions'] || @xml_element.add_element('PostActions')
+        post_actions.add_element(post_action.xml_element)
+      end
     end
   end
 end

data/lib/xcodeproj/scheme/build_action.rb

@@ -19,6 +19,20 @@ module Xcodeproj
         end
       end
 
+      # @return [Bool]
+      #         Whether or not to run post actions on build failure
+      #
+      def run_post_actions_on_failure?
+        string_to_bool(@xml_element.attributes['runPostActionsOnFailure'])
+      end
+
+      # @param [Bool] flag
+      #        Set whether or not to run post actions on build failure
+      #
+      def run_post_actions_on_failure=(flag)
+        @xml_element.attributes['runPostActionsOnFailure'] = bool_to_string(flag)
+      end
+
       # @return [Bool]
       #         Whether or not to build the various targets in parallel
       #
@@ -47,6 +61,78 @@ module Xcodeproj
         @xml_element.attributes['buildImplicitDependencies'] = bool_to_string(flag)
       end
 
+      # @return [Array<ExecutionAction>]
+      #         The list of actions to run before this scheme action.
+      #         Each entry can be either a 'Run Script' or a 'Send Email' action.
+      #
+      def pre_actions
+        pre_actions = @xml_element.elements['PreActions']
+        return nil unless pre_actions
+        pre_actions.get_elements('ExecutionAction').map do |entry_node|
+          ExecutionAction.new(entry_node)
+        end
+      end
+
+      # @param [Array<ExecutionAction>] pre_actions
+      #        Set the list of actions to run before this scheme action.
+      #        Each entry can be either a 'Run Script' or a 'Send Email' action.
+      #
+      def pre_actions=(pre_actions)
+        @xml_element.delete_element('PreActions')
+        unless pre_actions.empty?
+          pre_actions_element = @xml_element.add_element('PreActions')
+          pre_actions.each do |entry_node|
+            pre_actions_element.add_element(entry_node.xml_element)
+          end
+        end
+        pre_actions
+      end
+
+      # @param [ExecutionAction] pre_action
+      #        Add an action to the list of actions to run before this scheme action.
+      #        It can be either a 'Run Script' or a 'Send Email' action.
+      #
+      def add_pre_action(pre_action)
+        pre_actions = @xml_element.elements['PreActions'] || @xml_element.add_element('PreActions')
+        pre_actions.add_element(pre_action.xml_element)
+      end
+
+      # @return [Array<ExecutionAction>]
+      #         The list of actions to run after this scheme action.
+      #         Each entry can be either a 'Run Script' or a 'Send Email' action.
+      #
+      def post_actions
+        post_actions = @xml_element.elements['PostActions']
+        return nil unless post_actions
+        post_actions.get_elements('ExecutionAction').map do |entry_node|
+          ExecutionAction.new(entry_node)
+        end
+      end
+
+      # @param [Array<ExecutionAction>] post_actions
+      #        Set the list of actions to run after this scheme action.
+      #        Each entry can be either a 'Run Script' or a 'Send Email' action.
+      #
+      def post_actions=(post_actions)
+        @xml_element.delete_element('PostActions')
+        unless post_actions.empty?
+          post_actions_element = @xml_element.add_element('PostActions')
+          post_actions.each do |entry_node|
+            post_actions_element.add_element(entry_node.xml_element)
+          end
+        end
+        post_actions
+      end
+
+      # @param [ExecutionAction] post_action
+      #        Add an action to the list of actions to run after this scheme action.
+      #        It can be either a 'Run Script' or a 'Send Email' action.
+      #
+      def add_post_action(post_action)
+        post_actions = @xml_element.elements['PostActions'] || @xml_element.add_element('PostActions')
+        post_actions.add_element(post_action.xml_element)
+      end
+
       # @return [Array<BuildAction::Entry>]
       #         The list of BuildActionEntry nodes associated with this Build Action.
       #         Each entry represent a target to build and tells for which action it's needed to be built.
@@ -103,11 +189,11 @@ module Xcodeproj
               is_app_target = app_types.include?(target_or_node.product_type)
             end
 
-            self.build_for_analyzing = true
             self.build_for_testing   = is_test_target
             self.build_for_running   = is_app_target
             self.build_for_profiling = is_app_target
             self.build_for_archiving = is_app_target
+            self.build_for_analyzing = true
 
             add_buildable_reference BuildableReference.new(target_or_node) if target_or_node
           end

data/lib/xcodeproj/scheme/execution_action.rb

@@ -0,0 +1,86 @@
+module Xcodeproj
+  class XCScheme
+    # This class wraps the ExecutionAction node of a .xcscheme XML file
+    #
+    class ExecutionAction < XMLElementWrapper
+      # @param [REXML::Element] node
+      #        The 'ExecutionAction' XML node that this object will wrap.
+      #        If nil, will create an empty one
+      #
+      # @param [Symbol] action_type
+      #        One of `EXECUTION_ACTION_TYPE.keys`
+      #
+      def initialize(node = nil, action_type = nil)
+        create_xml_element_with_fallback(node, 'ExecutionAction') do
+          type = action_type || node.action_type
+          raise "[Xcodeproj] Invalid ActionType `#{type}`" unless Constants::EXECUTION_ACTION_TYPE.keys.include?(type)
+          @xml_element.attributes['ActionType'] = Constants::EXECUTION_ACTION_TYPE[type]
+        end
+      end
+
+      # @return [String]
+      #         The ActionType of this ExecutionAction. One of two values:
+      #
+      #         Xcode.IDEStandardExecutionActionsCore.ExecutionActionType.ShellScriptAction,
+      #         Xcode.IDEStandardExecutionActionsCore.ExecutionActionType.SendEmailAction
+      #
+      def action_type
+        @xml_element.attributes['ActionType']
+      end
+
+      # @return [ShellScriptActionContent]
+      #         If action_type is 'Xcode.IDEStandardExecutionActionsCore.ExecutionActionType.ShellScriptAction'
+      #         returns the contents of the shell script to run pre/post action.
+      #
+      # @return [SendEmailActionContent]
+      #         If action_type is 'Xcode.IDEStandardExecutionActionsCore.ExecutionActionType.SendEmailAction'
+      #         returns the contents of the email to send pre/post action.
+      #
+      def action_content
+        case action_type
+        when Constants::EXECUTION_ACTION_TYPE[:shell_script]
+          ShellScriptActionContent.new(@xml_element.elements['ActionContent'])
+        when Constants::EXECUTION_ACTION_TYPE[:send_email]
+          SendEmailActionContent.new(@xml_element.elements['ActionContent'])
+        else
+          raise "[Xcodeproj] Invalid ActionType `#{action_type}`"
+        end
+      end
+
+      # @param [ShellScriptActionContent, SendEmailActionContent] value
+      #        Set either the contents of the shell script to run pre/post action
+      #        or the contents of the email to send pre/post action.
+      #
+      def action_content=(value)
+        raise "[Xcodeproj] Invalid ActionContent `#{value.class}` for " \
+          "ActionType `#{action_type}`" unless valid_action_content?(value)
+
+        @xml_element.delete_element('ActionContent')
+        @xml_element.add_element(value.xml_element)
+      end
+
+      #-------------------------------------------------------------------------#
+
+      private
+
+      # @!group Private helpers
+
+      # @return [Bool]
+      #         True if value (ActionContent) is valid for current action_type
+      #
+      # @param [ShellScriptActionContent, SendEmailActionContent] value
+      #        Checks if value matches the expected action_type if present.
+      #
+      def valid_action_content?(value)
+        case action_type
+        when Constants::EXECUTION_ACTION_TYPE[:shell_script]
+          value.is_a?(ShellScriptActionContent)
+        when Constants::EXECUTION_ACTION_TYPE[:send_email]
+          value.is_a?(SendEmailActionContent)
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/xcodeproj/scheme/launch_action.rb

@@ -11,6 +11,8 @@ module Xcodeproj
       #
       def initialize(node = nil)
         create_xml_element_with_fallback(node, 'LaunchAction') do
+          self.build_configuration = 'Debug'
+
           # Add some attributes (that are not handled by this wrapper class yet but expected in the XML)
           @xml_element.attributes['selectedDebuggerIdentifier'] = 'Xcode.DebuggerFoundation.Debugger.LLDB'
           @xml_element.attributes['selectedLauncherIdentifier'] = 'Xcode.DebuggerFoundation.Launcher.LLDB'
@@ -19,10 +21,8 @@ module Xcodeproj
           @xml_element.attributes['ignoresPersistentStateOnLaunch'] = bool_to_string(false)
           @xml_element.attributes['debugDocumentVersioning'] = bool_to_string(true)
           @xml_element.attributes['debugServiceExtension'] = 'internal'
-          @xml_element.add_element('AdditionalOptions')
 
           # Setup default values for other (handled) attributes
-          self.build_configuration = 'Debug'
           self.allow_location_simulation = true
         end
       end
@@ -47,6 +47,21 @@ module Xcodeproj
         @xml_element.attributes['allowLocationSimulation'] = bool_to_string(flag)
       end
 
+      # @return [LocationScenarioReference]
+      #         The LocationScenarioReference to simulate a GPS location when executing the Launch Action
+      #
+      def location_scenario_reference?
+        LocationScenarioReference.new(@xml_element.elements['LocationScenarioReference'])
+      end
+
+      # @return [LocationScenarioReference]
+      #         Set the LocationScenarioReference which simulates a GPS location when executing the Launch Action
+      #
+      def location_scenario_reference=(reference)
+        @xml_element.delete_element('LocationScenarioReference')
+        @xml_element.add_element(reference.xml_element) if reference
+      end
+
       # @return [Bool]
       #         Whether this Build Action should disable detection of UI API misuse
       #         from background threads

data/lib/xcodeproj/scheme/location_scenario_reference.rb

@@ -0,0 +1,49 @@
+module Xcodeproj
+  class XCScheme
+    # This class wraps the LocationScenarioReference node of a .xcscheme XML file
+    #
+    # A LocationScenarioReference is a reference to a simulated GPS location associated
+    # with a scheme's launch action
+    #
+    class LocationScenarioReference < XMLElementWrapper
+      # @param [Xcodeproj::Project::Object::AbstractTarget, REXML::Element] target_or_node
+      #        Either the Xcode target to reference,
+      #        or an existing XML 'LocationScenarioReference' node element to reference
+      #
+      def initialize(target_or_node)
+        create_xml_element_with_fallback(target_or_node, 'LocationScenarioReference') do
+          self.identifier = ''
+          self.reference_type = '0'
+        end
+      end
+
+      # @return [String]
+      #         The identifier of a built-in location scenario reference, or a path to a GPX file
+      #
+      def identifier
+        @xml_element.attributes['identifier']
+      end
+
+      # @param [String] value
+      #        Set the identifier for the location scenario reference
+      #
+      def identifier=(value)
+        @xml_element.attributes['identifier'] = value
+      end
+
+      # @return [String]
+      #         The reference type is 0 when using a custom GPX file, or 1 when using a built-in location reference
+      #
+      def reference_type
+        @xml_element.attributes['referenceType']
+      end
+
+      # @param [String] value
+      #        Set the reference type for the location scenario reference
+      #
+      def reference_type=(value)
+        @xml_element.attributes['referenceType'] = value
+      end
+    end
+  end
+end

data/lib/xcodeproj/scheme/profile_action.rb

@@ -11,14 +11,14 @@ module Xcodeproj
       #
       def initialize(node = nil)
         create_xml_element_with_fallback(node, 'ProfileAction') do
+          # Setup default values for other (handled) attributes
+          self.build_configuration = 'Release'
+          self.should_use_launch_scheme_args_env = true
+
           # Add some attributes (that are not handled by this wrapper class yet but expected in the XML)
           @xml_element.attributes['savedToolIdentifier'] = ''
           @xml_element.attributes['useCustomWorkingDirectory'] = bool_to_string(false)
           @xml_element.attributes['debugDocumentVersioning'] = bool_to_string(true)
-
-          # Setup default values for other (handled) attributes
-          self.build_configuration = 'Release'
-          self.should_use_launch_scheme_args_env = true
         end
       end
 
@@ -42,7 +42,7 @@ module Xcodeproj
       #         The BuildableProductRunnable to launch when launching the Profile action
       #
       def buildable_product_runnable
-        BuildableProductRunnable.new @xml_element.elements['BuildableProductRunnable']
+        BuildableProductRunnable.new @xml_element.elements['BuildableProductRunnable'], 0
       end
 
       # @param [BuildableProductRunnable] runnable

data/lib/xcodeproj/scheme/send_email_action_content.rb

@@ -0,0 +1,84 @@
+module Xcodeproj
+  class XCScheme
+    # This class wraps a 'ActionContent' node of type
+    # 'Xcode.IDEStandardExecutionActionsCore.ExecutionActionType.SendEmailAction' of a .xcscheme XML file
+    #
+    class SendEmailActionContent < XMLElementWrapper
+      # @param [REXML::Element] node
+      #        The 'ActionContent' XML node that this object will wrap.
+      #        If nil, will create a default XML node to use.
+      #
+      def initialize(node = nil)
+        create_xml_element_with_fallback(node, 'ActionContent') do
+          self.title = 'Send Email'
+          # For some reason this is not visible in Xcode's UI and it's always set to 'NO'
+          # couldn't find much documentation on it so it might be safer to keep it read only
+          @xml_element.attributes['attachLogToEmail'] = 'NO'
+        end
+      end
+
+      # @return [Bool]
+      #         Whether or not this action should attach log to email
+      #
+      def attach_log_to_email?
+        string_to_bool(@xml_element.attributes['attachLogToEmail'])
+      end
+
+      # @return [String]
+      #         The title of this ActionContent
+      #
+      def title
+        @xml_element.attributes['title']
+      end
+
+      # @param [String] value
+      #        Set the title of this ActionContent
+      #
+      def title=(value)
+        @xml_element.attributes['title'] = value
+      end
+
+      # @return [String]
+      #         The email recipient of this ActionContent
+      #
+      def email_recipient
+        @xml_element.attributes['emailRecipient']
+      end
+
+      # @param [String] value
+      #        Set the email recipient of this ActionContent
+      #
+      def email_recipient=(value)
+        @xml_element.attributes['emailRecipient'] = value
+      end
+
+      # @return [String]
+      #         The email subject of this ActionContent
+      #
+      def email_subject
+        @xml_element.attributes['emailSubject']
+      end
+
+      # @param [String] value
+      #        Set the email subject of this ActionContent
+      #
+      def email_subject=(value)
+        @xml_element.attributes['emailSubject'] = value
+      end
+
+      # @return [String]
+      #         The email body of this ActionContent
+      #
+      def email_body
+        @xml_element.attributes['emailBody']
+      end
+
+      # @param [String] value
+      #        Set the email body of this ActionContent
+      #
+      def email_body=(value)
+        @xml_element.attributes['emailBody'] = value
+      end
+    end
+  end
+end

data/lib/xcodeproj/scheme/shell_script_action_content.rb

@@ -0,0 +1,77 @@
+module Xcodeproj
+  class XCScheme
+    # This class wraps a 'ActionContent' node of type
+    # 'Xcode.IDEStandardExecutionActionsCore.ExecutionActionType.ShellScriptAction' of a .xcscheme XML file
+    #
+    class ShellScriptActionContent < XMLElementWrapper
+      # @param [REXML::Element] node
+      #        The 'ActionContent' XML node that this object will wrap.
+      #        If nil, will create a default XML node to use.
+      #
+      def initialize(node = nil)
+        create_xml_element_with_fallback(node, 'ActionContent') do
+          self.title = 'Run Script'
+        end
+      end
+
+      # @return [String]
+      #         The title of this ActionContent
+      #
+      def title
+        @xml_element.attributes['title']
+      end
+
+      # @param [String] value
+      #        Set the title of this ActionContent
+      #
+      def title=(value)
+        @xml_element.attributes['title'] = value
+      end
+
+      # @return [String]
+      #         The contents of the shell script represented by this ActionContent
+      #
+      def script_text
+        @xml_element.attributes['scriptText']
+      end
+
+      # @param [String] value
+      #         Set the contents of the shell script represented by this ActionContent
+      #
+      def script_text=(value)
+        @xml_element.attributes['scriptText'] = value
+      end
+
+      # @return [String]
+      #         The preferred shell to invoke with this ActionContent
+      #
+      def shell_to_invoke
+        @xml_element.attributes['shellToInvoke']
+      end
+
+      # @param [String] value
+      #        Set the preferred shell to invoke with this ActionContent
+      #
+      def shell_to_invoke=(value)
+        @xml_element.attributes['shellToInvoke'] = value
+      end
+
+      # @return [BuildableReference]
+      #         The BuildableReference (Xcode target) associated with this ActionContent
+      #
+      def buildable_reference
+        BuildableReference.new(@xml_element.elements['EnvironmentBuildable'].elements['BuildableReference'])
+      end
+
+      # @param [BuildableReference] ref
+      #        Set the BuildableReference (Xcode target) associated with this ActionContent
+      #
+      def buildable_reference=(ref)
+        @xml_element.delete_element('EnvironmentBuildable')
+
+        env_buildable = @xml_element.add_element('EnvironmentBuildable')
+        env_buildable.add_element(ref.xml_element)
+      end
+    end
+  end
+end