cocoapods 1.0.0 → 1.1.0

data/lib/cocoapods/installer/xcode/pods_project_generator/pod_target_installer.rb

@@ -0,0 +1,401 @@
+module Pod
+  class Installer
+    class Xcode
+      class PodsProjectGenerator
+        # Creates the target for the Pods libraries in the Pods project and the
+        # relative support files.
+        #
+        class PodTargetInstaller < TargetInstaller
+          # Creates the target in the Pods project and the relative support files.
+          #
+          # @return [void]
+          #
+          def install!
+            unless target.should_build?
+              add_resources_bundle_targets
+              return
+            end
+
+            UI.message "- Installing target `#{target.name}` #{target.platform}" do
+              add_target
+              create_support_files_dir
+              add_resources_bundle_targets
+              add_files_to_build_phases
+              create_xcconfig_file
+              if target.requires_frameworks?
+                create_info_plist_file
+                create_module_map
+                create_umbrella_header do |generator|
+                  generator.imports += if header_mappings_dir
+                                         target.file_accessors.flat_map(&:public_headers).map do |pathname|
+                                           pathname.relative_path_from(header_mappings_dir)
+                                         end
+                                       else
+                                         target.file_accessors.flat_map(&:public_headers).map(&:basename)
+                                       end
+                end
+                create_build_phase_to_symlink_header_folders
+              end
+              create_prefix_header
+              create_dummy_source
+            end
+          end
+
+          private
+
+          # Remove the default headers folder path settings for static library pod
+          # targets.
+          #
+          # @return [Hash{String => String}]
+          #
+          def custom_build_settings
+            settings = super
+            unless target.requires_frameworks?
+              settings['PRIVATE_HEADERS_FOLDER_PATH'] = ''
+              settings['PUBLIC_HEADERS_FOLDER_PATH'] = ''
+            end
+
+            settings['CODE_SIGN_IDENTITY[sdk=appletvos*]'] = ''
+            settings['CODE_SIGN_IDENTITY[sdk=iphoneos*]'] = ''
+            settings['CODE_SIGN_IDENTITY[sdk=watchos*]'] = ''
+
+            if target.swift_version
+              settings['SWIFT_VERSION'] = target.swift_version
+            end
+            settings
+          end
+
+          #-----------------------------------------------------------------------#
+
+          SOURCE_FILE_EXTENSIONS = Sandbox::FileAccessor::SOURCE_FILE_EXTENSIONS
+
+          # Adds the build files of the pods to the target and adds a reference to
+          # the frameworks of the Pods.
+          #
+          # @note   The Frameworks are used only for presentation purposes as the
+          #         xcconfig is the authoritative source about their information.
+          #
+          # @note   Core Data model directories (.xcdatamodeld) defined in the `resources`
+          #         property are currently added to the `Copy Resources` build phase like
+          #         all other resources. The Xcode UI adds these to the `Compile Sources`
+          #         build phase, but they will compile correctly either way.
+          #
+          # @return [void]
+          #
+          def add_files_to_build_phases
+            target.file_accessors.each do |file_accessor|
+              consumer = file_accessor.spec_consumer
+
+              headers = file_accessor.headers
+              public_headers = file_accessor.public_headers
+              private_headers = file_accessor.private_headers
+              other_source_files = file_accessor.source_files.reject { |sf| SOURCE_FILE_EXTENSIONS.include?(sf.extname) }
+
+              {
+                true => file_accessor.arc_source_files,
+                false => file_accessor.non_arc_source_files,
+              }.each do |arc, files|
+                files = files - headers - other_source_files
+                flags = compiler_flags_for_consumer(consumer, arc)
+                regular_file_refs = files.map { |sf| project.reference_for_path(sf) }
+                native_target.add_file_references(regular_file_refs, flags)
+              end
+
+              header_file_refs = headers.map { |sf| project.reference_for_path(sf) }
+              native_target.add_file_references(header_file_refs) do |build_file|
+                add_header(build_file, public_headers, private_headers)
+              end
+
+              other_file_refs = other_source_files.map { |sf| project.reference_for_path(sf) }
+              native_target.add_file_references(other_file_refs, nil)
+
+              next unless target.requires_frameworks?
+
+              resource_refs = file_accessor.resources.flatten.map do |res|
+                project.reference_for_path(res)
+              end
+
+              # Some nested files are not directly present in the Xcode project, such as the contents
+              # of an .xcdatamodeld directory. These files will return nil file references.
+              resource_refs.compact!
+
+              native_target.add_resources(resource_refs)
+            end
+          end
+
+          # Adds the resources of the Pods to the Pods project.
+          #
+          # @note   The source files are grouped by Pod and in turn by subspec
+          #         (recursively) in the resources group.
+          #
+          # @note   Core Data model directories (.xcdatamodeld) are currently added to the
+          #         `Copy Resources` build phase like all other resources. The Xcode UI adds
+          #         these to the `Compile Sources` build phase, but they will compile
+          #         correctly either way.
+          #
+          # @return [void]
+          #
+          def add_resources_bundle_targets
+            target.file_accessors.each do |file_accessor|
+              file_accessor.resource_bundles.each do |bundle_name, paths|
+                file_references = paths.map do |path|
+                  ref = project.reference_for_path(path)
+
+                  # Some nested files are not directly present in the Xcode project, such as the contents
+                  # of an .xcdatamodeld directory. These files are implicitly included by including their
+                  # parent directory.
+                  next if ref.nil?
+
+                  # For variant groups, the variant group itself is added, not its members.
+                  next ref.parent if ref.parent.is_a?(Xcodeproj::Project::Object::PBXVariantGroup)
+
+                  ref
+                end
+                file_references = file_references.uniq.compact
+
+                label = target.resources_bundle_target_label(bundle_name)
+                bundle_target = project.new_resources_bundle(label, file_accessor.spec_consumer.platform_name)
+                bundle_target.product_reference.tap do |bundle_product|
+                  bundle_file_name = "#{bundle_name}.bundle"
+                  bundle_product.name = bundle_file_name
+                  bundle_product.path = bundle_file_name
+                end
+                bundle_target.add_resources(file_references)
+
+                target.user_build_configurations.each do |bc_name, type|
+                  bundle_target.add_build_configuration(bc_name, type)
+                end
+                bundle_target.deployment_target = deployment_target
+
+                target.resource_bundle_targets << bundle_target
+
+                if target.should_build?
+                  native_target.add_dependency(bundle_target)
+                  if target.requires_frameworks?
+                    native_target.add_resources([bundle_target.product_reference])
+                  end
+                end
+
+                # Create Info.plist file for bundle
+                path = target.info_plist_path
+                path.dirname.mkdir unless path.dirname.exist?
+                info_plist_path = path.dirname + "ResourceBundle-#{bundle_name}-#{path.basename}"
+                generator = Generator::InfoPlistFile.new(target, :bundle_package_type => :bndl)
+                generator.save_as(info_plist_path)
+                add_file_to_support_group(info_plist_path)
+
+                bundle_target.build_configurations.each do |c|
+                  c.build_settings['PRODUCT_NAME'] = bundle_name
+                  relative_info_plist_path = info_plist_path.relative_path_from(sandbox.root)
+                  c.build_settings['INFOPLIST_FILE'] = relative_info_plist_path.to_s
+                  c.build_settings['CONFIGURATION_BUILD_DIR'] = target.configuration_build_dir('$(BUILD_DIR)/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)')
+
+                  # Set the correct device family for this bundle, based on the platform
+                  device_family_by_platform = {
+                    :ios => '1,2',
+                    :tvos => '3',
+                    :watchos => '1,2' # The device family for watchOS is 4, but Xcode creates watchkit-compatible bundles as 1,2
+                  }
+
+                  if family = device_family_by_platform[target.platform.name]
+                    c.build_settings['TARGETED_DEVICE_FAMILY'] = family
+                  end
+                end
+              end
+            end
+          end
+
+          # Generates the contents of the xcconfig file and saves it to disk.
+          #
+          # @return [void]
+          #
+          def create_xcconfig_file
+            path = target.xcconfig_path
+            xcconfig_gen = Generator::XCConfig::PodXCConfig.new(target)
+            xcconfig_gen.save_as(path)
+            xcconfig_file_ref = add_file_to_support_group(path)
+
+            native_target.build_configurations.each do |c|
+              c.base_configuration_reference = xcconfig_file_ref
+            end
+
+            # also apply the private config to resource targets
+            target.resource_bundle_targets.each do |rsrc_target|
+              rsrc_target.build_configurations.each do |rsrc_bc|
+                rsrc_bc.base_configuration_reference = xcconfig_file_ref
+              end
+            end
+          end
+
+          # Creates a build phase which links the versioned header folders
+          # of the OS X into the framework bundle's root root directory.
+          # This is only necessary because the way how headers are copied
+          # via custom copy file build phases in combination with
+          # header_mappings_dir interferes with xcodebuild's expectations
+          # about the existence of private or public headers.
+          #
+          # @return [void]
+          #
+          def create_build_phase_to_symlink_header_folders
+            return unless target.platform.name == :osx && header_mappings_dir
+
+            build_phase = native_target.new_shell_script_build_phase('Create Symlinks to Header Folders')
+            build_phase.shell_script = <<-eos.strip_heredoc
+          base="$CONFIGURATION_BUILD_DIR/$WRAPPER_NAME"
+          ln -fs $base/${PUBLIC_HEADERS_FOLDER_PATH\#$WRAPPER_NAME/} $base/${PUBLIC_HEADERS_FOLDER_PATH\#\$CONTENTS_FOLDER_PATH/}
+          ln -fs $base/${PRIVATE_HEADERS_FOLDER_PATH\#\$WRAPPER_NAME/} $base/${PRIVATE_HEADERS_FOLDER_PATH\#\$CONTENTS_FOLDER_PATH/}
+            eos
+          end
+
+          # Creates a prefix header file which imports `UIKit` or `Cocoa` according
+          # to the platform of the target. This file also include any prefix header
+          # content reported by the specification of the pods.
+          #
+          # @return [void]
+          #
+          def create_prefix_header
+            path = target.prefix_header_path
+            generator = Generator::PrefixHeader.new(target.file_accessors, target.platform)
+            generator.save_as(path)
+            add_file_to_support_group(path)
+
+            native_target.build_configurations.each do |c|
+              relative_path = path.relative_path_from(project.path.dirname)
+              c.build_settings['GCC_PREFIX_HEADER'] = relative_path.to_s
+            end
+          end
+
+          ENABLE_OBJECT_USE_OBJC_FROM = {
+            :ios => Version.new('6'),
+            :osx => Version.new('10.8'),
+            :watchos => Version.new('2.0'),
+            :tvos => Version.new('9.0'),
+          }
+
+          # Returns the compiler flags for the source files of the given specification.
+          #
+          # The following behavior is regarding the `OS_OBJECT_USE_OBJC` flag. When
+          # set to `0`, it will allow code to use `dispatch_release()` on >= iOS 6.0
+          # and OS X 10.8.
+          #
+          # * New libraries that do *not* require ARC don’t need to care about this
+          #   issue at all.
+          #
+          # * New libraries that *do* require ARC _and_ have a deployment target of
+          #   >= iOS 6.0 or OS X 10.8:
+          #
+          #   These no longer use `dispatch_release()` and should *not* have the
+          #   `OS_OBJECT_USE_OBJC` flag set to `0`.
+          #
+          #   **Note:** this means that these libraries *have* to specify the
+          #             deployment target in order to function well.
+          #
+          # * New libraries that *do* require ARC, but have a deployment target of
+          #   < iOS 6.0 or OS X 10.8:
+          #
+          #   These contain `dispatch_release()` calls and as such need the
+          #   `OS_OBJECT_USE_OBJC` flag set to `1`.
+          #
+          #   **Note:** libraries that do *not* specify a platform version are
+          #             assumed to have a deployment target of < iOS 6.0 or OS X 10.8.
+          #
+          #  For more information, see: http://opensource.apple.com/source/libdispatch/libdispatch-228.18/os/object.h
+          #
+          # @param  [Specification::Consumer] consumer
+          #         The consumer for the specification for which the compiler flags
+          #         are needed.
+          #
+          # @return [String] The compiler flags.
+          #
+          def compiler_flags_for_consumer(consumer, arc)
+            flags = consumer.compiler_flags.dup
+            if !arc
+              flags << '-fno-objc-arc'
+            else
+              platform_name = consumer.platform_name
+              spec_deployment_target = consumer.spec.deployment_target(platform_name)
+              if spec_deployment_target.nil? || Version.new(spec_deployment_target) < ENABLE_OBJECT_USE_OBJC_FROM[platform_name]
+                flags << '-DOS_OBJECT_USE_OBJC=0'
+              end
+            end
+            if target.inhibit_warnings?
+              flags << '-w -Xanalyzer -analyzer-disable-all-checks'
+            end
+            flags * ' '
+          end
+
+          # Adds a reference to the given file in the support group of this target.
+          #
+          # @param  [Pathname] path
+          #         The path of the file to which the reference should be added.
+          #
+          # @return [PBXFileReference] the file reference of the added file.
+          #
+          def add_file_to_support_group(path)
+            pod_name = target.pod_name
+            dir = target.support_files_dir
+            group = project.pod_support_files_group(pod_name, dir)
+            group.new_file(path)
+          end
+
+          def create_module_map
+            return super unless custom_module_map
+            path = target.module_map_path
+            UI.message "- Copying module map file to #{UI.path(path)}" do
+              FileUtils.cp(custom_module_map, path)
+              add_file_to_support_group(path)
+
+              native_target.build_configurations.each do |c|
+                relative_path = path.relative_path_from(sandbox.root)
+                c.build_settings['MODULEMAP_FILE'] = relative_path.to_s
+              end
+            end
+          end
+
+          def create_umbrella_header
+            return super unless custom_module_map
+          end
+
+          def custom_module_map
+            @custom_module_map ||= target.file_accessors.first.module_map
+          end
+
+          def header_mappings_dir
+            return @header_mappings_dir if defined?(@header_mappings_dir)
+            file_accessor = target.file_accessors.first
+            @header_mappings_dir = if dir = file_accessor.spec_consumer.header_mappings_dir
+                                     file_accessor.path_list.root + dir
+                                   end
+          end
+
+          def add_header(build_file, public_headers, private_headers)
+            file_ref = build_file.file_ref
+            acl = if public_headers.include?(file_ref.real_path)
+                    'Public'
+                  elsif private_headers.include?(file_ref.real_path)
+                    'Private'
+                  else
+                    'Project'
+                  end
+
+            if target.requires_frameworks? && header_mappings_dir && acl != 'Project'
+              relative_path = file_ref.real_path.relative_path_from(header_mappings_dir)
+              sub_dir = relative_path.dirname
+              copy_phase_name = "Copy #{sub_dir} #{acl} Headers"
+              copy_phase = native_target.copy_files_build_phases.find { |bp| bp.name == copy_phase_name } ||
+                native_target.new_copy_files_build_phase(copy_phase_name)
+              copy_phase.symbol_dst_subfolder_spec = :products_directory
+              copy_phase.dst_path = "$(#{acl.upcase}_HEADERS_FOLDER_PATH)/#{sub_dir}"
+              copy_phase.add_file_reference(file_ref, true)
+            else
+              build_file.settings ||= {}
+              build_file.settings['ATTRIBUTES'] = [acl]
+            end
+          end
+
+          #-----------------------------------------------------------------------#
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods/installer/xcode/pods_project_generator/target_installer.rb

@@ -0,0 +1,214 @@
+module Pod
+  class Installer
+    class Xcode
+      class PodsProjectGenerator
+        # Controller class responsible of creating and configuring the static
+        # library target in Pods project. It also creates the support file needed
+        # by the target.
+        #
+        class TargetInstaller
+          # @return [Sandbox] sandbox the sandbox where the support files should
+          #         be generated.
+          #
+          attr_reader :sandbox
+
+          # @return [Target] The library whose target needs to be generated.
+          #
+          attr_reader :target
+
+          # @param  [Project] project @see project
+          # @param  [Target]  target  @see target
+          #
+          def initialize(sandbox, target)
+            @sandbox = sandbox
+            @target = target
+          end
+
+          private
+
+          #-----------------------------------------------------------------------#
+
+          # @!group Installation steps
+
+          # Adds the target for the library to the Pods project with the
+          # appropriate build configurations.
+          #
+          # @note   The `PODS_HEADERS_SEARCH_PATHS` overrides the xcconfig.
+          #
+          # @return [void]
+          #
+          def add_target
+            product_type = target.product_type
+            name = target.label
+            platform = target.platform.name
+            language = target.uses_swift? ? :swift : :objc
+            @native_target = project.new_target(product_type, name, platform, deployment_target, nil, language)
+
+            product_name = target.product_name
+            product = @native_target.product_reference
+            product.name = product_name
+
+            target.user_build_configurations.each do |bc_name, type|
+              @native_target.add_build_configuration(bc_name, type)
+            end
+
+            @native_target.build_configurations.each do |configuration|
+              configuration.build_settings.merge!(custom_build_settings)
+            end
+
+            target.native_target = @native_target
+          end
+
+          # @return [String] The deployment target.
+          #
+          def deployment_target
+            target.platform.deployment_target.to_s
+          end
+
+          # Returns the customized build settings which are overridden in the build
+          # settings of the user target.
+          #
+          # @return [Hash{String => String}]
+          #
+          def custom_build_settings
+            settings = {}
+
+            unless target.archs.empty?
+              settings['ARCHS'] = target.archs
+            end
+
+            if target.requires_frameworks?
+              settings['PRODUCT_NAME'] = target.product_module_name
+            else
+              settings.merge!('OTHER_LDFLAGS' => '', 'OTHER_LIBTOOLFLAGS' => '')
+            end
+
+            settings
+          end
+
+          # Creates the directory where to store the support files of the target.
+          #
+          def create_support_files_dir
+            target.support_files_dir.mkdir
+          end
+
+          # Creates the Info.plist file which sets public framework attributes
+          #
+          # @return [void]
+          #
+          def create_info_plist_file
+            path = target.info_plist_path
+            UI.message "- Generating Info.plist file at #{UI.path(path)}" do
+              generator = Generator::InfoPlistFile.new(target)
+              generator.save_as(path)
+              add_file_to_support_group(path)
+
+              native_target.build_configurations.each do |c|
+                relative_path = path.relative_path_from(sandbox.root)
+                c.build_settings['INFOPLIST_FILE'] = relative_path.to_s
+              end
+            end
+          end
+
+          # Creates the module map file which ensures that the umbrella header is
+          # recognized with a customized path
+          #
+          # @yield_param [Generator::ModuleMap]
+          #              yielded once to configure the private headers
+          #
+          # @return [void]
+          #
+          def create_module_map
+            path = target.module_map_path
+            UI.message "- Generating module map file at #{UI.path(path)}" do
+              generator = Generator::ModuleMap.new(target)
+              yield generator if block_given?
+              generator.save_as(path)
+              add_file_to_support_group(path)
+
+              native_target.build_configurations.each do |c|
+                relative_path = path.relative_path_from(sandbox.root)
+                c.build_settings['MODULEMAP_FILE'] = relative_path.to_s
+              end
+            end
+          end
+
+          # Generates a header which ensures that all header files are exported
+          # in the module map
+          #
+          # @yield_param [Generator::UmbrellaHeader]
+          #              yielded once to configure the imports
+          #
+          def create_umbrella_header
+            path = target.umbrella_header_path
+            UI.message "- Generating umbrella header at #{UI.path(path)}" do
+              generator = Generator::UmbrellaHeader.new(target)
+              yield generator if block_given?
+              generator.save_as(path)
+
+              # Add the file to the support group and the native target,
+              # so it will been added to the header build phase
+              file_ref = add_file_to_support_group(path)
+              native_target.add_file_references([file_ref])
+
+              # Make the umbrella header public
+              build_file = native_target.headers_build_phase.build_file(file_ref)
+              build_file.settings ||= {}
+              build_file.settings['ATTRIBUTES'] = ['Public']
+            end
+          end
+
+          # Generates a dummy source file for each target so libraries that contain
+          # only categories build.
+          #
+          # @return [void]
+          #
+          def create_dummy_source
+            path = target.dummy_source_path
+            generator = Generator::DummySource.new(target.label)
+            generator.save_as(path)
+            file_reference = add_file_to_support_group(path)
+            native_target.source_build_phase.add_file_reference(file_reference)
+          end
+
+          # @return [PBXNativeTarget] the target generated by the installation
+          #         process.
+          #
+          # @note   Generated by the {#add_target} step.
+          #
+          attr_reader :native_target
+
+          private
+
+          #-----------------------------------------------------------------------#
+
+          # @!group Private helpers.
+
+          # @return [Project] the Pods project of the sandbox.
+          #
+          def project
+            sandbox.project
+          end
+
+          # @return [PBXGroup] the group where the file references to the support
+          #         files should be stored.
+          #
+          attr_reader :support_files_group
+
+          # Adds a reference to the given file in the support group of this target.
+          #
+          # @param  [Pathname] path
+          #         The path of the file to which the reference should be added.
+          #
+          # @return [PBXFileReference] the file reference of the added file.
+          #
+          def add_file_to_support_group(path)
+            support_files_group.new_file(path)
+          end
+
+          #-----------------------------------------------------------------------#
+        end
+      end
+    end
+  end
+end