xcodeproj 1.17.1 → 1.21.0

data/lib/xcodeproj/project/object/group.rb

@@ -226,24 +226,24 @@ module Xcodeproj
         # Creates a file reference to a static library and adds it to the
         # group.
         #
-        # @param  [#to_s] product_name
+        # @param  [#to_s] product_basename
         #         The name of the static library.
         #
         # @return [PBXFileReference] The new file reference.
         #
-        def new_product_ref_for_target(target_name, product_type)
-          FileReferencesFactory.new_product_ref_for_target(self, target_name, product_type)
+        def new_product_ref_for_target(product_basename, product_type)
+          FileReferencesFactory.new_product_ref_for_target(self, product_basename, product_type)
         end
 
         # Creates a file reference to a new bundle.
         #
-        # @param  [#to_s] product_name
+        # @param  [#to_s] product_basename
         #         The name of the bundle.
         #
         # @return [PBXFileReference] The new file reference.
         #
-        def new_bundle(product_name)
-          FileReferencesFactory.new_bundle(self, product_name)
+        def new_bundle(product_basename)
+          FileReferencesFactory.new_bundle(self, product_basename)
         end
 
         # Creates a file reference to a new bundle and adds it to the group.
@@ -440,10 +440,12 @@ module Xcodeproj
 
             result = File.basename(x.display_name.downcase, '.*') <=> File.basename(y.display_name.downcase, '.*')
             if result.zero?
-              File.extname(x.display_name.downcase) <=> File.extname(y.display_name.downcase)
-            else
-              result
+              result = File.extname(x.display_name.downcase) <=> File.extname(y.display_name.downcase)
+              if result.zero?
+                result = x.path.downcase <=> y.path.downcase
+              end
             end
+            result
           end
         end
       end

data/lib/xcodeproj/project/object/helpers/file_references_factory.rb

@@ -42,17 +42,17 @@ module Xcodeproj
           # @param  [PBXGroup] group
           #         The group to which to add the reference.
           #
-          # @param  [#to_s] product_name
+          # @param  [#to_s] product_basename
           #         The name of the static library.
           #
           # @return [PBXFileReference] The new file reference.
           #
-          def new_product_ref_for_target(group, target_name, product_type)
+          def new_product_ref_for_target(group, product_basename, product_type)
             if product_type == :static_library
               prefix = 'lib'
             end
             extension = Constants::PRODUCT_UTI_EXTENSIONS[product_type]
-            path = "#{prefix}#{target_name}"
+            path = "#{prefix}#{product_basename}"
             path += ".#{extension}" if extension
             ref = new_reference(group, path, :built_products)
             ref.include_in_index = '0'
@@ -66,13 +66,13 @@ module Xcodeproj
           # @param  [PBXGroup] group
           #         The group to which to add the reference.
           #
-          # @param  [#to_s] product_name
+          # @param  [#to_s] product_basename
           #         The name of the bundle.
           #
           # @return [PBXFileReference] The new file reference.
           #
-          def new_bundle(group, product_name)
-            ref = new_reference(group, "#{product_name}.bundle", :built_products)
+          def new_bundle(group, product_basename)
+            ref = new_reference(group, "#{product_basename}.bundle", :built_products)
             ref.include_in_index = '0'
             ref.set_explicit_file_type('wrapper.cfbundle')
             ref

data/lib/xcodeproj/project/object/helpers/groupable_helper.rb

@@ -205,7 +205,7 @@ module Xcodeproj
           # @return [void]
           #
           def set_path_with_source_tree(object, path, source_tree)
-            path = Pathname.new(path)
+            path = Pathname(path)
             source_tree = normalize_source_tree(source_tree)
             object.source_tree = source_tree
 

data/lib/xcodeproj/project/object/native_target.rb

@@ -552,6 +552,49 @@ module Xcodeproj
           end
         end
 
+        # Adds on demand resources to the resources build phase of the target.
+        #
+        # @param  {String => [Array<PBXFileReference>]} on_demand_resource_tag_files
+        #         the files references of the on demand resources to add to the target keyed by the tag.
+        #
+        # @return [void]
+        #
+        def add_on_demand_resources(on_demand_resource_tag_files)
+          on_demand_resource_tag_files.each do |tag, file_refs|
+            file_refs.each do |file_ref|
+              if resources_build_phase.include?(file_ref)
+                existing_build_file = resources_build_phase.build_file(file_ref)
+                existing_build_file.settings ||= {}
+                existing_build_file.settings['ASSET_TAGS'] ||= []
+                existing_build_file.settings['ASSET_TAGS'] << tag
+                existing_build_file.settings['ASSET_TAGS'].uniq!
+                next
+              end
+              build_file = resources_build_phase.add_file_reference(file_ref, true)
+              build_file.settings = (build_file.settings ||= {}).merge('ASSET_TAGS' => [tag])
+            end
+          end
+        end
+
+        # Remove on demand resources from the resources build phase of the target.
+        #
+        # @param  {String => [Array<PBXFileReference>]} on_demand_resource_tag_files
+        #         the files references of the on demand resources to add to the target keyed by the tag.
+        #
+        # @return [void]
+        #
+        def remove_on_demand_resources(on_demand_resource_tag_files)
+          on_demand_resource_tag_files.each do |tag, file_refs|
+            file_refs.each do |file_ref|
+              build_file = resources_build_phase.build_file(file_ref)
+              next if build_file.nil?
+              asset_tags = build_file.settings['ASSET_TAGS']
+              asset_tags.delete(tag)
+              resources_build_phase.remove_file_reference(file_ref) if asset_tags.empty?
+            end
+          end
+        end
+
         # Finds or creates the headers build phase of the target.
         #
         # @note   A target should have only one headers build phase.

data/lib/xcodeproj/project/object/swift_package_product_dependency.rb

@@ -13,6 +13,16 @@ module Xcodeproj
         # @return [String] the product name of this Swift package.
         #
         attribute :product_name, String
+
+        # @!group AbstractObject Hooks
+        #--------------------------------------#
+
+        # @return [String] the name of the Swift package.
+        #
+        def display_name
+          return product_name if product_name
+          super
+        end
       end
     end
   end

data/lib/xcodeproj/project/object/swift_package_remote_reference.rb

@@ -13,6 +13,20 @@ module Xcodeproj
         # @return [Hash] the version requirements for this Swift package.
         #
         attribute :requirement, Hash
+
+        # @!group AbstractObject Hooks
+        #--------------------------------------#
+
+        def ascii_plist_annotation
+          " #{isa} \"#{File.basename(display_name)}\" "
+        end
+
+        # @return [String] the name of the Swift package repository.
+        #
+        def display_name
+          return repositoryURL if repositoryURL
+          super
+        end
       end
     end
   end

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/scheme.rb

@@ -9,8 +9,12 @@ require 'xcodeproj/scheme/archive_action'
 
 require 'xcodeproj/scheme/buildable_product_runnable'
 require 'xcodeproj/scheme/buildable_reference'
+require 'xcodeproj/scheme/location_scenario_reference'
+require 'xcodeproj/scheme/execution_action'
 require 'xcodeproj/scheme/macro_expansion'
 require 'xcodeproj/scheme/remote_runnable'
+require 'xcodeproj/scheme/send_email_action_content'
+require 'xcodeproj/scheme/shell_script_action_content'
 
 module Xcodeproj
   # This class represents a Scheme document represented by a ".xcscheme" file
@@ -221,7 +225,7 @@ module Xcodeproj
       launch_runnable = BuildableProductRunnable.new(build_target, 0)
       launch_action.buildable_product_runnable = launch_runnable
 
-      profile_runnable = BuildableProductRunnable.new(build_target)
+      profile_runnable = BuildableProductRunnable.new(build_target, 0)
       profile_action.buildable_product_runnable = profile_runnable
 
       macro_exp = MacroExpansion.new(build_target)

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