xcodeproj 0.18.0 → 0.19.0

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

@@ -1,7 +1,6 @@
 module Xcodeproj
   class Project
     module Object
-
       # Apparently a proxy for another object which might belong another
       # project contained in the same workspace of the project document.
       #
@@ -19,7 +18,6 @@ module Xcodeproj
       #        xcodeproj to raise because ti can't find the UUID.
       #
       class PBXContainerItemProxy < AbstractObject
-
         # @!group Attributes
 
         # @return [String] apparently the UUID of the root object
@@ -38,7 +36,8 @@ module Xcodeproj
         #         If this assumption is incorrect, there could be loss of
         #         information opening and saving an existing project.
         #
-        # TODO this is the external reference that 'contains' other proxy items
+        # @todo   This is the external reference that 'contains' other proxy
+        #         items.
         attribute :container_portal, String
 
         # @return [String] the type of the proxy.
@@ -66,7 +65,6 @@ module Xcodeproj
         #         the proxy.
         #
         attribute :remote_info, String
-
       end
     end
   end

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

@@ -3,11 +3,9 @@ require 'xcodeproj/project/object/helpers/groupable_helper'
 module Xcodeproj
   class Project
     module Object
-
       # This class represents a reference to a file in the file system.
       #
       class PBXFileReference < AbstractObject
-
         # @!group Attributes
 
         # @return [String] the name of the reference, often not present.
@@ -245,7 +243,7 @@ module Xcodeproj
         #
         def project_reference_metadata
           project.root_object.project_references.find do |project_reference|
-            project_reference['ProjectRef'] == self
+            project_reference[:project_ref] == self
           end
         end
 
@@ -259,7 +257,7 @@ module Xcodeproj
         def proxy_containers
           project.objects.select do |object|
             object.isa == 'PBXContainerItemProxy' &&
-              object.container_portal == self.uuid
+              object.container_portal == uuid
           end
         end
 
@@ -313,14 +311,13 @@ module Xcodeproj
           if project_reference = project_reference_metadata
             file_reference_proxies.each(&:remove_from_project)
             target_dependency_proxies.each(&:remove_from_project)
-            project_reference['ProductGroup'].remove_from_project
+            project_reference[:product_group].remove_from_project
             project.root_object.project_references.delete(project_reference)
           end
           super
         end
 
         #---------------------------------------------------------------------#
-
       end
     end
   end

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

@@ -4,12 +4,10 @@ require 'xcodeproj/project/object/helpers/file_references_factory'
 module Xcodeproj
   class Project
     module Object
-
       # This class represents a group. A group can contain other groups
       # (PBXGroup) and file references (PBXFileReference).
       #
       class PBXGroup < AbstractObject
-
         # @!group Attributes
 
         # @return [ObjectList<PBXGroup, PBXFileReference>]
@@ -78,7 +76,6 @@ module Xcodeproj
         #
         attribute :comments, String
 
-
         public
 
         # @!group Helpers
@@ -223,7 +220,7 @@ module Xcodeproj
         def new_reference(path, source_tree = :group)
           FileReferencesFactory.new_reference(self, path, source_tree)
         end
-        alias :new_file :new_reference
+        alias_method :new_file, :new_reference
 
         # Creates a file reference to a static library and adds it to the
         # group.
@@ -280,7 +277,7 @@ module Xcodeproj
         def clear
           children.objects.each(&:remove_from_project)
         end
-        alias :remove_children_recursively :clear
+        alias_method :remove_children_recursively, :clear
 
         # Traverses the children groups and finds the children with the given
         # path, optionally, creating any needed group. If the given path is
@@ -306,7 +303,7 @@ module Xcodeproj
           return self unless path
           path = path.split('/') unless path.is_a?(Array)
           child_name = path.shift
-          child = children.find{ |c| c.display_name == child_name }
+          child = children.find { |c| c.display_name == child_name }
           if child.nil?
             if should_create
               child = new_group(child_name)
@@ -351,7 +348,7 @@ module Xcodeproj
               if extname_x != extname_y
                 extname_x <=> extname_y
               else
-                File.basename(x.display_name, ".*" ) <=> File.basename(y.display_name, ".*" )
+                File.basename(x.display_name, '.*') <=> File.basename(y.display_name, '.*')
               end
             else
               0
@@ -364,7 +361,7 @@ module Xcodeproj
         # @return [void]
         #
         def sort_recursively_by_type
-          groups.each { |group| group.sort_recursively_by_type }
+          groups.each(&:sort_recursively_by_type)
           sort_by_type
         end
 
@@ -408,7 +405,7 @@ module Xcodeproj
               end
             end
 
-            result = File.basename(x.display_name, ".*" ) <=> File.basename(y.display_name, ".*" )
+            result = File.basename(x.display_name, '.*') <=> File.basename(y.display_name, '.*')
             if result.zero?
               File.extname(x.display_name) <=> File.extname(y.display_name)
             else
@@ -423,13 +420,11 @@ module Xcodeproj
       # This class is used to gather localized files into one entry.
       #
       class PBXVariantGroup < PBXGroup
-
         # @!group Attributes
 
         # @return [String] the file type guessed by Xcode.
         #
         attribute :last_known_file_type, String
-
       end
 
       #-----------------------------------------------------------------------#
@@ -440,7 +435,6 @@ module Xcodeproj
       # Used to contain the different versions of a `xcdatamodel`.
       #
       class XCVersionGroup < PBXGroup
-
         # @!group Attributes
 
         # @return [PBXFileReference] the reference to the current version.
@@ -450,11 +444,9 @@ module Xcodeproj
         # @return [String] the type of the versioned resource.
         #
         attribute :version_group_type, String, 'wrapper.xcdatamodel'
-
       end
 
       #-----------------------------------------------------------------------#
-
     end
   end
 end

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

@@ -5,7 +5,6 @@ module Xcodeproj
     module Object
       class FileReferencesFactory
         class << self
-
           # Creates a new reference with the given path and adds it to the
           # given group. The reference is configured according to the extension
           # of the path.
@@ -23,11 +22,14 @@ module Xcodeproj
           # @return [PBXFileReference, XCVersionGroup] The new reference.
           #
           def new_reference(group, path, source_tree)
-            if File.extname(path).downcase == '.xcdatamodeld'
-              ref = new_xcdatamodeld(group, path, source_tree)
-            else
-              ref = new_file_reference(group, path, source_tree)
-            end
+            ref = case File.extname(path).downcase
+                  when '.xcdatamodeld'
+                    new_xcdatamodeld(group, path, source_tree)
+                  when '.xcodeproj'
+                    new_subproject(group, path, source_tree)
+                  else
+                    new_file_reference(group, path, source_tree)
+                  end
 
             configure_defaults_for_file_reference(ref)
             ref
@@ -69,11 +71,10 @@ module Xcodeproj
           def new_bundle(group, product_name)
             ref = new_reference(group, "#{product_name}.bundle", :built_products)
             ref.include_in_index = '0'
-            ref.set_explicit_file_type("wrapper.cfbundle")
+            ref.set_explicit_file_type('wrapper.cfbundle')
             ref
           end
 
-
           private
 
           # @group Private Helpers
@@ -135,8 +136,7 @@ module Xcodeproj
             if path.exist?
               path.children.each do |child_path|
                 if File.extname(child_path) == '.xcdatamodel'
-                  child_ref = new_file_reference(ref, child_path, :group)
-                  last_child_ref = child_ref
+                  new_file_reference(ref, child_path, :group)
                 elsif File.basename(child_path) == '.xccurrentversion'
                   full_path = path + File.basename(child_path)
                   xccurrentversion = Xcodeproj::PlistHelper.read(full_path)
@@ -146,7 +146,7 @@ module Xcodeproj
 
               if current_version_name
                 ref.current_version = ref.children.find do |obj|
-                    obj.path.split('/').last == current_version_name
+                  obj.path.split('/').last == current_version_name
                 end
               end
             end
@@ -154,6 +154,59 @@ module Xcodeproj
             ref
           end
 
+          # Creates a file reference to another Xcode subproject and setups the
+          # proxies to the targets.
+          #
+          # @param  [PBXGroup] group
+          #         The group to which to add the reference.
+          #
+          # @param  [#to_s] path
+          #         The, preferably absolute, path of the reference.
+          #
+          # @param  [Symbol] source_tree
+          #         The source tree key to use to configure the path (@see
+          #         GroupableHelper::SOURCE_TREES_BY_KEY).
+          #
+          # @note   To analyze the targets the given project is read and thus
+          #         it should already exist in the disk.
+          #
+          # @return [PBXFileReference] The new file reference.
+          #
+          def new_subproject(group, path, source_tree)
+            ref = new_file_reference(group, path, source_tree)
+            ref.include_in_index = nil
+
+            product_group_ref = group.project.new(PBXGroup)
+            product_group_ref.name = 'Products'
+            product_group_ref.source_tree = '<group>'
+
+            subproj = Project.open(path)
+            subproj.products_group.files.each do |product_reference|
+              container_proxy = group.project.new(PBXContainerItemProxy)
+              container_proxy.container_portal = ref.uuid
+              container_proxy.proxy_type = '2'
+              container_proxy.remote_global_id_string = product_reference.uuid
+              container_proxy.remote_info = 'Subproject'
+
+              reference_proxy = group.project.new(PBXReferenceProxy)
+              extension = File.extname(product_reference.path)[1..-1]
+              reference_proxy.file_type = Constants::FILE_TYPES_BY_EXTENSION[extension]
+              reference_proxy.path = product_reference.path
+              reference_proxy.remote_ref = container_proxy
+              reference_proxy.source_tree = 'BUILT_PRODUCTS_DIR'
+
+              product_group_ref << reference_proxy
+            end
+
+            attribute = PBXProject.references_by_keys_attributes.find { |attrb| attrb.name == :project_references }
+            project_reference = ObjectDictionary.new(attribute, group.project.root_object)
+            project_reference[:project_ref] = ref
+            project_reference[:product_group] = product_group_ref
+            group.project.root_object.project_references << project_reference
+
+            ref
+          end
+
           # Configures a file reference according to the extension to math
           # Xcode behaviour.
           #
@@ -177,10 +230,8 @@ module Xcodeproj
           end
 
           #-------------------------------------------------------------------#
-
         end
       end
     end
   end
 end
-

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

@@ -3,7 +3,6 @@ module Xcodeproj
     module Object
       class GroupableHelper
         class << self
-
           # @param  [PBXGroup, PBXFileReference] object
           #         The object to analyze.
           #
@@ -12,15 +11,15 @@ module Xcodeproj
           def parent(object)
             referrers = object.referrers.uniq
             if referrers.count > 1
-              referrers = referrers.select{ |obj| obj.isa == 'PBXGroup' }
+              referrers = referrers.select { |obj| obj.isa == 'PBXGroup' }
             end
 
             if referrers.count == 0
-              raise "[Xcodeproj] Consistency issue: no parent " \
+              raise '[Xcodeproj] Consistency issue: no parent ' \
                 "for object `#{object.display_name}`: "\
                 "`#{object.referrers.join('`, `')}`"
             elsif referrers.count > 1
-              raise "[Xcodeproj] Consistency issue: unexpected multiple parents " \
+              raise '[Xcodeproj] Consistency issue: unexpected multiple parents ' \
                 "for object `#{object.display_name}`: "\
                 "#{object.referrers}"
             end
@@ -178,7 +177,7 @@ module Xcodeproj
 
             if source_tree == SOURCE_TREES_BY_KEY[:absolute]
               unless path.absolute?
-                raise "[Xcodeproj] Attempt to set a relative path with an " \
+                raise '[Xcodeproj] Attempt to set a relative path with an ' \
                   "absolute source tree: `#{path}`"
               end
               object.path = path.to_s
@@ -220,7 +219,6 @@ module Xcodeproj
           end
 
           #-------------------------------------------------------------------#
-
         end
       end
     end

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

@@ -1,9 +1,7 @@
 module Xcodeproj
   class Project
     module Object
-
       class AbstractTarget < AbstractObject
-
         # @!group Attributes
 
         # @return [String] The name of the Target.
@@ -31,7 +29,6 @@ module Xcodeproj
         #
         has_many :dependencies, PBXTargetDependency
 
-
         public
 
         # @!group Helpers
@@ -54,7 +51,7 @@ module Xcodeproj
         def resolved_build_setting(key)
           target_settings = build_configuration_list.get_setting(key)
           project_settings = project.build_configuration_list.get_setting(key)
-          target_settings.merge(project_settings) do |key, target_val, proj_val|
+          target_settings.merge(project_settings) do |_key, target_val, proj_val|
             target_val || proj_val
           end
         end
@@ -203,7 +200,7 @@ module Xcodeproj
               container_proxy.container_portal = project.root_object.uuid
             else
               subproject_reference = project.reference_for_path(target.project.path)
-              raise ArgumentError, "add_dependency got target that belongs to a project is not this project and is not a subproject of this project" unless subproject_reference
+              raise ArgumentError, 'add_dependency got target that belongs to a project is not this project and is not a subproject of this project' unless subproject_reference
               container_proxy.container_portal = subproject_reference.uuid
             end
             container_proxy.proxy_type = '1'
@@ -245,7 +242,6 @@ module Xcodeproj
           phase
         end
 
-
         public
 
         # @!group System frameworks
@@ -280,7 +276,7 @@ module Xcodeproj
               path_sdk_name = 'MacOSX'
               path_sdk_version = sdk_version || Constants::LAST_KNOWN_OSX_SDK
             else
-              raise "Unknown platform for target"
+              raise 'Unknown platform for target'
             end
 
             path = "Platforms/#{path_sdk_name}.platform/Developer/SDKs/#{path_sdk_name}#{path_sdk_version}.sdk/System/Library/Frameworks/#{name}.framework"
@@ -291,7 +287,7 @@ module Xcodeproj
             ref
           end
         end
-        alias :add_system_frameworks :add_system_framework
+        alias_method :add_system_frameworks, :add_system_framework
 
         # Adds a file reference for one or more system libraries to the project
         # if needed and adds them to the Frameworks build phases.
@@ -304,14 +300,15 @@ module Xcodeproj
         def add_system_library(names)
           Array(names).each do |name|
             path = "usr/lib/lib#{name}.dylib"
-            unless ref = project.frameworks_group.files.find { |ref| ref.path == path }
-              ref = project.frameworks_group.new_file(path, :sdk_root)
+            files = project.frameworks_group.files
+            unless reference = files.find { |ref| ref.path == path }
+              reference = project.frameworks_group.new_file(path, :sdk_root)
             end
-            frameworks_build_phase.add_file_reference(ref, true)
-            ref
+            frameworks_build_phase.add_file_reference(reference, true)
+            reference
           end
         end
-        alias :add_system_libraries :add_system_library
+        alias_method :add_system_libraries, :add_system_library
 
         public
 
@@ -325,11 +322,10 @@ module Xcodeproj
           {
             display_name => {
               'Build Phases' => build_phases.map(&:pretty_print),
-              'Build Configurations' => build_configurations.map(&:pretty_print)
-            }
+              'Build Configurations' => build_configurations.map(&:pretty_print),
+            },
           }
         end
-
       end
 
       #-----------------------------------------------------------------------#
@@ -337,7 +333,6 @@ module Xcodeproj
       # Represents a target handled by Xcode.
       #
       class PBXNativeTarget < AbstractTarget
-
         # @!group Attributes
 
         # @return [PBXBuildRule] the build rules of this target.
@@ -365,7 +360,6 @@ module Xcodeproj
         #
         has_many :build_phases, AbstractBuildPhase
 
-
         public
 
         # @!group Helpers
@@ -374,7 +368,8 @@ module Xcodeproj
         # @return [Symbol] The type of the target expressed as a symbol.
         #
         def symbol_type
-          pair = Constants::PRODUCT_TYPE_UTI.find { |key, value| value == product_type }
+          pair = Constants::PRODUCT_TYPE_UTI.find { |_key, value| value == product_type }
+          return nil if pair.nil?
           pair.first
         end
 
@@ -396,7 +391,7 @@ module Xcodeproj
 
             extension = File.extname(file.path)
             header_extensions = Constants::HEADER_FILES_EXTENSIONS
-            if (header_extensions.include?(extension))
+            if header_extensions.include?(extension)
               headers_build_phase.files << build_file
             else
               if compiler_flags && !compiler_flags.empty?
@@ -471,7 +466,7 @@ module Xcodeproj
         def frameworks_build_phase
           phase = build_phases.find { |bp| bp.class == PBXFrameworksBuildPhase }
           unless phase
-            phase= project.new(PBXFrameworksBuildPhase)
+            phase = project.new(PBXFrameworksBuildPhase)
             build_phases << phase
           end
           phase
@@ -492,7 +487,6 @@ module Xcodeproj
           phase
         end
 
-
         public
 
         # @!group AbstractObject Hooks
@@ -503,7 +497,7 @@ module Xcodeproj
         #
         # Build phases are not sorted as they order is relevant.
         #
-        def sort(options = nil)
+        def sort(_options = nil)
           attributes_to_sort = to_many_attributes.reject { |attr| attr.name == :build_phases }
           attributes_to_sort.each do |attrb|
             list = attrb.get_value(self)
@@ -521,7 +515,6 @@ module Xcodeproj
       # @todo Apparently it can't have build rules.
       #
       class PBXAggregateTarget < AbstractTarget
-
         # @!group Attributes
 
         # @return [PBXBuildRule] the build phases of the target.
@@ -530,8 +523,7 @@ module Xcodeproj
         #         PBXShellScriptBuildPhase can appear multiple times in a
         #         target.
         #
-        has_many :build_phases, [ PBXCopyFilesBuildPhase, PBXShellScriptBuildPhase ]
-
+        has_many :build_phases, [PBXCopyFilesBuildPhase, PBXShellScriptBuildPhase]
       end
 
       #-----------------------------------------------------------------------#
@@ -542,7 +534,6 @@ module Xcodeproj
       # present.
       #
       class PBXLegacyTarget < AbstractTarget
-
         # @!group Attributes
 
         # @return [String] e.g "Dir"
@@ -568,11 +559,9 @@ module Xcodeproj
         #         target.
         #
         has_many :build_phases, AbstractBuildPhase
-
       end
 
       #-----------------------------------------------------------------------#
-
     end
   end
 end