xcodeproj 0.26.3 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3ffe9ba21a5d156f491061b65e4a600ada8c653
-  data.tar.gz: b4327d4cdbbd7036dcd891c478f850ac19fdd8ea
+  metadata.gz: 06e0ee7bf2c3ae317b24d55195a21d22c9018a67
+  data.tar.gz: e07317fcef70ba2aa4969bbea76bda7c3a0f52ff
 SHA512:
-  metadata.gz: 86aa2035f0857282fa84bc0bc13827d4523ce0724f25b4f31883c693e8724478555d85404d437de96ae54efae2720c20724b3c5e8685a7eaf60fafd8f422c1c7
-  data.tar.gz: 0f5707dee287885c37cb5fbafe17ae3832f4556a645e8b354486ab1f9b48976047511a323c77eff50aac3154cec536ed167510167397e0725a27972470351820
+  metadata.gz: f3ed731a9be7088415abe1e113b7d7ec85113a735217063b41b38c7da5e8111701a86470843ae17df1f2529304706e7853b49b2fb73d3d5008aeb3586b67baf0
+  data.tar.gz: 88be395b0399c6bc5e879d9cb94cd9785b5efa8ee5545b13d83b3a435cd932f2367b35e7db6beb10fa4e80816895c781b1287b6d857301d99c4edf323ccc08a8

data/lib/xcodeproj/config.rb

@@ -81,7 +81,7 @@ module Xcodeproj
     #
     def to_s(prefix = nil)
       include_lines = includes.map { |path| "#include \"#{normalized_xcconfig_path(path)}\"" }
-      settings = to_hash(prefix).sort_by(&:first).map { |k, v| "#{k} = #{v}" }
+      settings = to_hash(prefix).sort_by(&:first).map { |k, v| "#{k} = #{v}".strip }
       [include_lines + settings].join("\n")
     end
 
@@ -131,6 +131,7 @@ module Xcodeproj
 
       result = attributes.dup
       result['OTHER_LDFLAGS'] = list.join(' ') unless list.empty?
+      result.reject! { |_, v| %w($(inherited) ${inherited}).freeze.any? { |i| i == v.strip } }
 
       if prefix
         Hash[result.map { |k, v| [prefix + k, v] }]

data/lib/xcodeproj/constants.rb

@@ -32,6 +32,10 @@ module Xcodeproj
     #
     LAST_SWIFT_UPGRADE_CHECK = '0700'
 
+    # @return [String] The version of `.xcscheme` files supported by Xcodeproj
+    #
+    XCSCHEME_FORMAT_VERSION = '1.3'
+
     # @return [Hash] The all the known ISAs grouped by superclass.
     #
     KNOWN_ISAS = {
@@ -104,6 +108,7 @@ module Xcodeproj
       :dynamic_library   => 'com.apple.product-type.library.dynamic',
       :static_library    => 'com.apple.product-type.library.static',
       :bundle            => 'com.apple.product-type.bundle',
+      :octest_bundle     => 'com.apple.product-type.bundle',
       :unit_test_bundle  => 'com.apple.product-type.bundle.unit-test',
       :app_extension     => 'com.apple.product-type.app-extension',
       :command_line_tool => 'com.apple.product-type.tool',
@@ -116,11 +121,13 @@ module Xcodeproj
     # @return [Hash] The extensions or the various product UTIs.
     #
     PRODUCT_UTI_EXTENSIONS = {
-      :application     => 'app',
-      :framework       => 'framework',
-      :dynamic_library => 'dylib',
-      :static_library  => 'a',
-      :bundle          => 'bundle',
+      :application      => 'app',
+      :framework        => 'framework',
+      :dynamic_library  => 'dylib',
+      :static_library   => 'a',
+      :bundle           => 'bundle',
+      :octest_bundle    => 'octest',
+      :unit_test_bundle => 'xctest',
     }.freeze
 
     # @return [Hash] The common build settings grouped by platform, and build

data/lib/xcodeproj/gem_version.rb

@@ -1,5 +1,5 @@
 module Xcodeproj
   # The version of the xcodeproj gem.
   #
-  VERSION = '0.26.3' unless defined? Xcodeproj::VERSION
+  VERSION = '0.27.0' unless defined? Xcodeproj::VERSION
 end

data/lib/xcodeproj/project/object.rb

@@ -145,7 +145,7 @@ module Xcodeproj
           to_many_attributes.each do |attrb|
             list = attrb.get_value(self)
             list.sort! do |x, y|
-              x.display_name <=> y.display_name
+              x.display_name.downcase <=> y.display_name.downcase
             end
           end
         end

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

@@ -406,9 +406,9 @@ module Xcodeproj
               end
             end
 
-            result = File.basename(x.display_name, '.*') <=> File.basename(y.display_name, '.*')
+            result = File.basename(x.display_name.downcase, '.*') <=> File.basename(y.display_name.downcase, '.*')
             if result.zero?
-              File.extname(x.display_name) <=> File.extname(y.display_name)
+              File.extname(x.display_name.downcase) <=> File.extname(y.display_name.downcase)
             else
               result
             end

data/lib/xcodeproj/scheme.rb

@@ -1,5 +1,16 @@
 require 'rexml/document'
 
+require 'xcodeproj/scheme/build_action'
+require 'xcodeproj/scheme/test_action'
+require 'xcodeproj/scheme/launch_action'
+require 'xcodeproj/scheme/profile_action'
+require 'xcodeproj/scheme/analyze_action'
+require 'xcodeproj/scheme/archive_action'
+
+require 'xcodeproj/scheme/buildable_product_runnable'
+require 'xcodeproj/scheme/buildable_reference'
+require 'xcodeproj/scheme/macro_expansion'
+
 module Xcodeproj
   # This class represents a Scheme document represented by a ".xcscheme" file
   # usually stored in a xcuserdata or xcshareddata (for a shared scheme)
@@ -11,61 +22,155 @@ module Xcodeproj
     #
     attr_reader :doc
 
-    # Create a new XCScheme instance
-    #
-    def initialize
-      @doc = REXML::Document.new
-      @doc << REXML::XMLDecl.new(REXML::XMLDecl::DEFAULT_VERSION, 'UTF-8')
-      @doc.context[:attribute_quote] = :quote
-
-      @scheme = @doc.add_element 'Scheme'
-      @scheme.attributes['LastUpgradeVersion'] = Constants::LAST_UPGRADE_CHECK
-      @scheme.attributes['version'] = '1.3'
-
-      @build_action = @scheme.add_element 'BuildAction'
-      @build_action.attributes['parallelizeBuildables'] = 'YES'
-      @build_action.attributes['buildImplicitDependencies'] = 'YES'
-      @build_action_entries = nil
-
-      @test_action = @scheme.add_element 'TestAction'
-      @test_action.attributes['selectedDebuggerIdentifier'] = 'Xcode.DebuggerFoundation.Debugger.LLDB'
-      @test_action.attributes['selectedLauncherIdentifier'] = 'Xcode.DebuggerFoundation.Launcher.LLDB'
-      @test_action.attributes['shouldUseLaunchSchemeArgsEnv'] = 'YES'
-      @test_action.attributes['buildConfiguration'] = 'Debug'
-
-      @test_action_additional_options = @test_action.add_element 'AdditionalOptions'
-
-      @testables = @test_action.add_element 'Testables'
-
-      @launch_action = @scheme.add_element 'LaunchAction'
-      @launch_action.attributes['selectedDebuggerIdentifier'] = 'Xcode.DebuggerFoundation.Debugger.LLDB'
-      @launch_action.attributes['selectedLauncherIdentifier'] = 'Xcode.DebuggerFoundation.Launcher.LLDB'
-      @launch_action.attributes['launchStyle'] = '0'
-      @launch_action.attributes['useCustomWorkingDirectory'] = 'NO'
-      @launch_action.attributes['buildConfiguration'] = 'Debug'
-      @launch_action.attributes['ignoresPersistentStateOnLaunch'] = 'NO'
-      @launch_action.attributes['debugDocumentVersioning'] = 'YES'
-      @launch_action.attributes['debugServiceExtension'] = 'internal'
-      @launch_action.attributes['allowLocationSimulation'] = 'YES'
-      @launch_action.add_element('AdditionalOptions')
-
-      @profile_action = @scheme.add_element 'ProfileAction'
-      @profile_action.attributes['shouldUseLaunchSchemeArgsEnv'] = 'YES'
-      @profile_action.attributes['savedToolIdentifier'] = ''
-      @profile_action.attributes['useCustomWorkingDirectory'] = 'NO'
-      @profile_action.attributes['buildConfiguration'] = 'Release'
-      @profile_action.attributes['debugDocumentVersioning'] = 'YES'
-
-      analyze_action = @scheme.add_element 'AnalyzeAction'
-      analyze_action.attributes['buildConfiguration'] = 'Debug'
-
-      archive_action = @scheme.add_element 'ArchiveAction'
-      archive_action.attributes['buildConfiguration'] = 'Release'
-      archive_action.attributes['revealArchiveInOrganizer'] = 'YES'
+    # Create a XCScheme either from scratch or using an existing file
+    #
+    # @param [String] file_path
+    #        The path of the existing .xcscheme file. If nil will create an empty scheme
+    #
+    def initialize(file_path = nil)
+      if file_path
+        @doc = REXML::Document.new(File.new(file_path))
+        @doc.context[:attribute_quote] = :quote
+
+        @scheme = @doc.elements['Scheme']
+      else
+        @doc = REXML::Document.new
+        @doc.context[:attribute_quote] = :quote
+        @doc << REXML::XMLDecl.new(REXML::XMLDecl::DEFAULT_VERSION, 'UTF-8')
+
+        @scheme = @doc.add_element 'Scheme'
+        @scheme.attributes['LastUpgradeVersion'] = Constants::LAST_UPGRADE_CHECK
+        @scheme.attributes['version'] = Xcodeproj::Constants::XCSCHEME_FORMAT_VERSION
+
+        self.build_action   = BuildAction.new
+        self.test_action    = TestAction.new
+        self.launch_action  = LaunchAction.new
+        self.profile_action = ProfileAction.new
+        self.analyze_action = AnalyzeAction.new
+        self.archive_action = ArchiveAction.new
+      end
+    end
+
+    # Convenience method to quickly add app and test targets to a new scheme.
+    #
+    # It will add the runnable_target to the Build, Launch and Profile actions
+    # and the test_target to the Build and Test actions
+    #
+    # @param [Xcodeproj::Project::Object::PBXAbstractTarget] runnable_target
+    #        The target to use for the 'Run', 'Profile' and 'Analyze' actions
+    #
+    # @param [Xcodeproj::Project::Object::PBXAbstractTarget] test_target
+    #        The target to use for the 'Test' action
+    #
+    def configure_with_targets(runnable_target, test_target)
+      build_action.add_entry BuildAction::Entry.new(runnable_target) if runnable_target
+      build_action.add_entry BuildAction::Entry.new(test_target) if test_target
+
+      test_action.add_testable TestAction::TestableReference.new(test_target) if test_target
+      launch_action.buildable_product_runnable = BuildableProductRunnable.new(runnable_target, 0) if runnable_target
+      profile_action.buildable_product_runnable = BuildableProductRunnable.new(runnable_target) if runnable_target
     end
 
     public
 
+    # @!group Access Action nodes
+
+    # @return [XCScheme::BuildAction]
+    #         The Build Action associated with this scheme
+    #
+    def build_action
+      @build_action ||= BuildAction.new(@scheme.elements['BuildAction'])
+    end
+
+    # @param [XCScheme::BuildAction] action
+    #        The Build Action to associate to this scheme
+    #
+    def build_action=(action)
+      @scheme.delete_element('BuildAction')
+      @scheme.add_element(action.xml_element)
+      @build_action = action
+    end
+
+    # @return [XCScheme::TestAction]
+    #         The Test Action associated with this scheme
+    #
+    def test_action
+      @test_action ||= TestAction.new(@scheme.elements['TestAction'])
+    end
+
+    # @param [XCScheme::TestAction] action
+    #        The Test Action to associate to this scheme
+    #
+    def test_action=(action)
+      @scheme.delete_element('TestAction')
+      @scheme.add_element(action.xml_element)
+      @test_action = action
+    end
+
+    # @return [XCScheme::LaunchAction]
+    #         The Launch Action associated with this scheme
+    #
+    def launch_action
+      @launch_action ||= LaunchAction.new(@scheme.elements['LaunchAction'])
+    end
+
+    # @param [XCScheme::LaunchAction] action
+    #        The Launch Action to associate to this scheme
+    #
+    def launch_action=(action)
+      @scheme.delete_element('LaunchAction')
+      @scheme.add_element(action.xml_element)
+      @launch_action = action
+    end
+
+    # @return [XCScheme::ProfileAction]
+    #         The Profile Action associated with this scheme
+    #
+    def profile_action
+      @profile_action ||= ProfileAction.new(@scheme.elements['ProfileAction'])
+    end
+
+    # @param [XCScheme::ProfileAction] action
+    #        The Profile Action to associate to this scheme
+    #
+    def profile_action=(action)
+      @scheme.delete_element('ProfileAction')
+      @scheme.add_element(action.xml_element)
+      @profile_action = action
+    end
+
+    # @return [XCScheme::AnalyzeAction]
+    #         The Analyze Action associated with this scheme
+    #
+    def analyze_action
+      @analyze_action ||= AnalyzeAction.new(@scheme.elements['AnalyzeAction'])
+    end
+
+    # @param [XCScheme::AnalyzeAction] action
+    #        The Analyze Action to associate to this scheme
+    #
+    def analyze_action=(action)
+      @scheme.delete_element('AnalyzeAction')
+      @scheme.add_element(action.xml_element)
+      @analyze_action = action
+    end
+
+    # @return [XCScheme::ArchiveAction]
+    #         The Archive Action associated with this scheme
+    #
+    def archive_action
+      @archive_action ||= ArchiveAction.new(@scheme.elements['ArchiveAction'])
+    end
+
+    # @param [XCScheme::ArchiveAction] action
+    #        The Archive Action to associate to this scheme
+    #
+    def archive_action=(action)
+      @scheme.delete_element('ArchiveAction')
+      @scheme.add_element(action.xml_element)
+      @archive_action = action
+    end
+
     # @!group Target methods
 
     # Add a target to the list of targets to build in the build action.
@@ -77,23 +182,15 @@ module Xcodeproj
     #        Whether to build this target in the launch action. Often false for test targets.
     #
     def add_build_target(build_target, build_for_running = true)
-      unless @build_action_entries
-        @build_action_entries = @build_action.add_element 'BuildActionEntries'
-      end
+      entry = BuildAction::Entry.new(build_target)
 
-      build_action_entry = @build_action_entries.add_element 'BuildActionEntry'
-      build_action_entry.attributes['buildForTesting'] = 'YES'
-      build_action_entry.attributes['buildForRunning'] = build_for_running ? 'YES' : 'NO'
-      build_action_entry.attributes['buildForProfiling'] = 'YES'
-      build_action_entry.attributes['buildForArchiving'] = 'YES'
-      build_action_entry.attributes['buildForAnalyzing'] = 'YES'
-
-      buildable_reference = build_action_entry.add_element 'BuildableReference'
-      buildable_reference.attributes['BuildableIdentifier'] = 'primary'
-      buildable_reference.attributes['BlueprintIdentifier'] = build_target.uuid
-      buildable_reference.attributes['BuildableName'] = construct_buildable_name(build_target)
-      buildable_reference.attributes['BlueprintName'] = build_target.name
-      buildable_reference.attributes['ReferencedContainer'] = construct_referenced_container_uri(build_target)
+      entry.build_for_testing   = true
+      entry.build_for_running   = build_for_running
+      entry.build_for_profiling = true
+      entry.build_for_archiving = true
+      entry.build_for_analyzing = true
+
+      build_action.add_entry(entry)
     end
 
     # Add a target to the list of targets to build in the build action.
@@ -102,15 +199,8 @@ module Xcodeproj
     #        A target used by scheme in the test step.
     #
     def add_test_target(test_target)
-      testable_reference = @testables.add_element 'TestableReference'
-      testable_reference.attributes['skipped'] = 'NO'
-
-      buildable_reference = testable_reference.add_element 'BuildableReference'
-      buildable_reference.attributes['BuildableIdentifier'] = 'primary'
-      buildable_reference.attributes['BlueprintIdentifier'] = test_target.uuid
-      buildable_reference.attributes['BuildableName'] = "#{test_target.name}.octest"
-      buildable_reference.attributes['BlueprintName'] = test_target.name
-      buildable_reference.attributes['ReferencedContainer'] = construct_referenced_container_uri(test_target)
+      testable = TestAction::TestableReference.new(test_target)
+      test_action.add_testable(testable)
     end
 
     # Sets a runnable target to be the target of the launch action of the scheme.
@@ -119,33 +209,14 @@ module Xcodeproj
     #        A target used by scheme in the launch step.
     #
     def set_launch_target(build_target)
-      launch_product_runnable = @launch_action.add_element 'BuildableProductRunnable'
-      launch_product_runnable.attributes['runnableDebuggingMode'] = '0'
-
-      launch_buildable_reference = launch_product_runnable.add_element 'BuildableReference'
-      launch_buildable_reference.attributes['BuildableIdentifier'] = 'primary'
-      launch_buildable_reference.attributes['BlueprintIdentifier'] = build_target.uuid
-      launch_buildable_reference.attributes['BuildableName'] = "#{build_target.name}.app"
-      launch_buildable_reference.attributes['BlueprintName'] = build_target.name
-      launch_buildable_reference.attributes['ReferencedContainer'] = construct_referenced_container_uri(build_target)
-
-      profile_product_runnable = @profile_action.add_element 'BuildableProductRunnable'
-
-      profile_buildable_reference = profile_product_runnable.add_element 'BuildableReference'
-      profile_buildable_reference.attributes['BuildableIdentifier'] = 'primary'
-      profile_buildable_reference.attributes['BlueprintIdentifier'] = build_target.uuid
-      profile_buildable_reference.attributes['BuildableName'] = "#{build_target.name}.app"
-      profile_buildable_reference.attributes['BlueprintName'] = build_target.name
-      profile_buildable_reference.attributes['ReferencedContainer'] = construct_referenced_container_uri(build_target)
-
-      macro_expansion = @test_action.add_element 'MacroExpansion'
-
-      buildable_reference = macro_expansion.add_element 'BuildableReference'
-      buildable_reference.attributes['BuildableIdentifier'] = 'primary'
-      buildable_reference.attributes['BlueprintIdentifier'] = build_target.uuid
-      buildable_reference.attributes['BuildableName'] = File.basename(build_target.product_reference.path)
-      buildable_reference.attributes['BlueprintName'] = build_target.name
-      buildable_reference.attributes['ReferencedContainer'] = construct_referenced_container_uri(build_target)
+      launch_runnable = BuildableProductRunnable.new(build_target, 0)
+      launch_action.buildable_product_runnable = launch_runnable
+
+      profile_runnable = BuildableProductRunnable.new(build_target)
+      profile_action.buildable_product_runnable = profile_runnable
+
+      macro_exp = MacroExpansion.new(build_target)
+      test_action.add_macro_expansion(macro_exp)
     end
 
     # @!group Class methods
@@ -272,39 +343,5 @@ module Xcodeproj
     end
 
     #-------------------------------------------------------------------------#
-
-    private
-
-    # @!group Private helpers
-
-    # @param [Xcodeproj::Project::Object::AbstractTarget] target
-    #
-    # @return [String] The buildable name of the scheme.
-    #
-    def construct_buildable_name(build_target)
-      case build_target.isa
-      when 'PBXNativeTarget'
-        File.basename(build_target.product_reference.path)
-      when 'PBXAggregateTarget'
-        build_target.name
-      else
-        raise ArgumentError, "Unsupported build target type #{build_target.isa}"
-      end
-    end
-
-    # @param [Xcodeproj::Project::Object::AbstractTarget] target
-    #
-    # @return [String] A string in the format "container:[path to the project
-    #                  file relative to the project_dir_path, always ending with
-    #                  the actual project directory name]"
-    #
-    def construct_referenced_container_uri(target)
-      project = target.project
-      relative_path = project.path.relative_path_from(project.path + project.root_object.project_dir_path).to_s
-      relative_path = project.path.basename if relative_path == '.'
-      "container:#{relative_path}"
-    end
-
-    #-------------------------------------------------------------------------#
   end
 end