plasmo_xcodeproj 1.21.1

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

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+require 'xcodeproj/project/object/helpers/groupable_helper'
+
+module Xcodeproj
+  class Project
+    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.
+          #
+          # @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).
+          #
+          # @return [PBXFileReference, XCVersionGroup] The new reference.
+          #
+          def new_reference(group, path, source_tree)
+            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
+          end
+
+          # Creates a file reference to a static library and adds it to the
+          # given group.
+          #
+          # @param  [PBXGroup] group
+          #         The group to which to add the reference.
+          #
+          # @param  [#to_s] product_basename
+          #         The name of the static library.
+          #
+          # @return [PBXFileReference] The new file reference.
+          #
+          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}#{product_basename}"
+            path += ".#{extension}" if extension
+            ref = new_reference(group, path, :built_products)
+            ref.include_in_index = '0'
+            ref.set_explicit_file_type
+            ref
+          end
+
+          # Creates a file reference to a new bundle and adds it to the given
+          # group.
+          #
+          # @param  [PBXGroup] group
+          #         The group to which to add the reference.
+          #
+          # @param  [#to_s] product_basename
+          #         The name of the bundle.
+          #
+          # @return [PBXFileReference] The new file reference.
+          #
+          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
+          end
+
+          private
+
+          # @group Private Helpers
+          #-------------------------------------------------------------------#
+
+          # Creates a new file reference with the given path and adds it to the
+          # given group.
+          #
+          # @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).
+          #
+          # @return [PBXFileReference] The new file reference.
+          #
+          def new_file_reference(group, path, source_tree)
+            path = Pathname.new(path)
+            ref = group.project.new(PBXFileReference)
+            group.children << ref
+            GroupableHelper.set_path_with_source_tree(ref, path, source_tree)
+            ref.set_last_known_file_type
+            ref
+          end
+
+          # Creates a new version group reference to an xcdatamodeled adding
+          # the xcdatamodel files included in the wrapper as children file
+          # references.
+          #
+          # @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 match Xcode behaviour the current version is read from
+          #         the .xccurrentversion file, if it doesn't exist the last
+          #         xcdatamodel according to its path is set as the current
+          #         version.
+          #
+          # @return [XCVersionGroup] The new reference.
+          #
+          def new_xcdatamodeld(group, path, source_tree)
+            path = Pathname.new(path)
+            ref = group.project.new(XCVersionGroup)
+            group.children << ref
+            GroupableHelper.set_path_with_source_tree(ref, path, source_tree)
+            ref.version_group_type = 'wrapper.xcdatamodel'
+
+            real_path = group.real_path.join(path)
+            current_version_name = nil
+            if real_path.exist?
+              real_path.children.each do |child_path|
+                if File.extname(child_path) == '.xcdatamodel'
+                  new_file_reference(ref, child_path, :group)
+                elsif File.basename(child_path) == '.xccurrentversion'
+                  full_path = real_path + File.basename(child_path)
+                  xccurrentversion = Plist.read_from_path(full_path)
+                  current_version_name = xccurrentversion['_XCCurrentVersionName']
+                end
+              end
+
+              if current_version_name
+                ref.current_version = ref.children.find do |obj|
+                  obj.path.split('/').last == current_version_name
+                end
+              end
+            end
+
+            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 = find_products_group_ref(group, true)
+
+            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 = Constants::PROXY_TYPES[:reference]
+              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.
+          #
+          # @param  [PBXFileReference] ref
+          #         The file reference to configure.
+          #
+          # @note   To closely match the Xcode behaviour the name attribute of
+          #         the file reference is set only if the path of the file is
+          #         not equal to the path of the group.
+          #
+          # @return [void]
+          #
+          def configure_defaults_for_file_reference(ref)
+            if ref.path.include?('/')
+              ref.name = ref.path.split('/').last
+            end
+
+            if File.extname(ref.path).downcase == '.framework'
+              ref.include_in_index = nil
+            end
+          end
+
+          def find_products_group_ref(group, should_create = false)
+            product_group_ref =
+              (group.project.root_object.product_ref_group ||= group.project.main_group.find_subpath('Products', should_create))
+            product_group_ref
+          end
+
+          #-------------------------------------------------------------------#
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+module Xcodeproj
+  class Project
+    module Object
+      class GroupableHelper
+        class << self
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to analyze.
+          #
+          # @return [PBXGroup, PBXProject] The parent of the object.
+          #
+          def parent(object)
+            referrers = object.referrers.uniq
+            if referrers.count > 1
+              referrers = referrers.grep(PBXGroup)
+            end
+
+            if referrers.count == 0
+              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 ' \
+                "for object `#{object.display_name}`: "\
+                "#{object.referrers}"
+            end
+            referrers.first
+          end
+
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to analyze.
+          #
+          # @return [Array<PBXGroup, PBXProject>] The parents of the object.
+          #
+          def parents(object)
+            if main_group?(object)
+              []
+            else
+              parent = parent(object)
+              parents(parent).push(parent)
+            end
+          end
+
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to analyze.
+          #
+          # @return [String] A representation of the group hierarchy.
+          #
+          def hierarchy_path(object)
+            unless main_group?(object)
+              parent = parent(object)
+              parent = parent.hierarchy_path if parent.respond_to?(:hierarchy_path)
+              "#{parent}/#{object.display_name}"
+            end
+          end
+
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to analyze.
+          #
+          # @return [Bool] Wether the object is the main group of the project.
+          #
+          def main_group?(object)
+            object.equal?(object.project.main_group)
+          end
+
+          # Moves the object to a new parent.
+          #
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to move.
+          #
+          # @param  [PBXGroup] new_parent
+          #         The new parent.
+          #
+          # @return [void]
+          #
+          def move(object, new_parent)
+            unless object
+              raise "[Xcodeproj] Attempt to move nil object to `#{new_parent}`."
+            end
+            unless new_parent
+              raise "[Xcodeproj] Attempt to move object `#{object}` to nil parent."
+            end
+            if new_parent.equal?(object)
+              raise "[Xcodeproj] Attempt to move object `#{object}` to itself."
+            end
+            if parents(new_parent).include?(object)
+              raise "[Xcodeproj] Attempt to move object `#{object}` to a child object `#{new_parent}`."
+            end
+
+            object.parent.children.delete(object)
+            new_parent << object
+          end
+
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to analyze.
+          #
+          # @return [Pathname] The absolute path of the object resolving the
+          #         source tree.
+          #
+          def real_path(object)
+            source_tree = source_tree_real_path(object)
+            path = object.path || ''.freeze
+            if source_tree
+              source_tree + path
+            else
+              Pathname(path)
+            end
+          end
+
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to analyze.
+          #
+          # @return [Pathname] The path of the object without resolving the
+          #         source tree.
+          #
+          def full_path(object)
+            folder =  case object.source_tree
+                      when '<group>'
+                        object_parent = parent(object)
+                        if object_parent.isa == 'PBXProject'.freeze
+                          nil
+                        else
+                          full_path(object_parent)
+                        end
+                      when 'SOURCE_ROOT'
+                        nil
+                      when '<absolute>'
+                        Pathname.new('/'.freeze)
+                      else
+                        Pathname.new("${#{object.source_tree}}")
+                      end
+            folder ||= Pathname.new('')
+            if object.path
+              folder + object.path
+            else
+              folder
+            end
+          end
+
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to analyze.
+          #
+          # @return [Pathname] The absolute path of the source tree of the
+          #         object.
+          #
+          def source_tree_real_path(object)
+            case object.source_tree
+            when '<group>'
+              object_parent = parent(object)
+              if object_parent.isa == 'PBXProject'.freeze
+                object.project.project_dir + object.project.root_object.project_dir_path
+              else
+                real_path(object_parent)
+              end
+            when 'SOURCE_ROOT'
+              object.project.project_dir
+            when '<absolute>'
+              nil
+            else
+              Pathname.new("${#{object.source_tree}}")
+            end
+          end
+
+          # @return [Hash{Symbol => String}] The source tree values by they
+          #         symbol representation.
+          #
+          SOURCE_TREES_BY_KEY = {
+            :absolute        => '<absolute>',
+            :group           => '<group>',
+            :project         => 'SOURCE_ROOT',
+            :built_products  => 'BUILT_PRODUCTS_DIR',
+            :developer_dir   => 'DEVELOPER_DIR',
+            :sdk_root        => 'SDKROOT',
+          }.freeze
+
+          # Sets the source tree of the given object.
+          #
+          # @param  [Symbol, String] source_tree
+          #         The source tree, either a string or a key for
+          #         {SOURCE_TREES_BY_KEY}.
+          #
+          # @return [void]
+          #
+          def set_source_tree(object, source_tree)
+            source_tree = normalize_source_tree(source_tree)
+            object.source_tree = source_tree
+          end
+
+          # Sets the path of the given object according to the provided source
+          # tree key. The path is converted to relative according to the real
+          # path of the source tree for group and project source trees, if both
+          # paths are relative or absolute. Otherwise the path is set as
+          # provided.
+          #
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object whose path needs to be set.
+          #
+          # @param  [#to_s] path
+          #         The path.
+          #
+          # @param  [Symbol, String] source_tree
+          #         The source tree, either a string or a key for
+          #         {SOURCE_TREES_BY_KEY}.
+          #
+          # @return [void]
+          #
+          def set_path_with_source_tree(object, path, source_tree)
+            path = Pathname(path)
+            source_tree = normalize_source_tree(source_tree)
+            object.source_tree = source_tree
+
+            if source_tree == SOURCE_TREES_BY_KEY[:absolute]
+              unless path.absolute?
+                raise '[Xcodeproj] Attempt to set a relative path with an ' \
+                  "absolute source tree: `#{path}`"
+              end
+              object.path = path.to_s
+            elsif source_tree == SOURCE_TREES_BY_KEY[:group] || source_tree == SOURCE_TREES_BY_KEY[:project]
+              source_tree_real_path = GroupableHelper.source_tree_real_path(object)
+              if source_tree_real_path && source_tree_real_path.absolute? == path.absolute?
+                relative_path = path.relative_path_from(source_tree_real_path)
+                object.path = relative_path.to_s
+              else
+                object.path = path.to_s
+              end
+            else
+              object.path = path.to_s
+            end
+          end
+
+          private
+
+          # @group Helpers
+          #-------------------------------------------------------------------#
+
+          # Converts the given source tree to its string value.
+          #
+          # @param  [Symbol, String] source_tree
+          #         The source tree, either a string or a key for
+          #         {SOURCE_TREES_BY_KEY}.
+          #
+          # @return [String] the string value of the source tree.
+          #
+          def normalize_source_tree(source_tree)
+            if source_tree.is_a?(Symbol)
+              source_tree = SOURCE_TREES_BY_KEY[source_tree]
+            end
+
+            unless SOURCE_TREES_BY_KEY.values.include?(source_tree)
+              raise "[Xcodeproj] Unrecognized source tree option `#{source_tree}`"
+            end
+            source_tree
+          end
+
+          #-------------------------------------------------------------------#
+        end
+      end
+    end
+  end
+end