xcocoapods 1.5.3

data/lib/cocoapods/sandbox/file_accessor.rb

@@ -0,0 +1,444 @@
+autoload :MachO, 'macho'
+
+module Pod
+  class Sandbox
+    # Resolves the file patterns of a specification against its root directory,
+    # taking into account any exclude pattern and the default extensions to use
+    # for directories.
+    #
+    # @note The FileAccessor always returns absolute paths.
+    #
+    class FileAccessor
+      HEADER_EXTENSIONS = Xcodeproj::Constants::HEADER_FILES_EXTENSIONS
+      SOURCE_FILE_EXTENSIONS = (%w(.m .mm .i .c .cc .cxx .cpp .c++ .swift) + HEADER_EXTENSIONS).uniq.freeze
+
+      GLOB_PATTERNS = {
+        :readme              => 'readme{*,.*}'.freeze,
+        :license             => 'licen{c,s}e{*,.*}'.freeze,
+        :source_files        => "*{#{SOURCE_FILE_EXTENSIONS.join(',')}}".freeze,
+        :public_header_files => "*{#{HEADER_EXTENSIONS.join(',')}}".freeze,
+        :podspecs            => '*.{podspec,podspec.json}'.freeze,
+        :docs                => 'doc{s}{*,.*}/**/*'.freeze,
+      }.freeze
+
+      # @return [Sandbox::PathList] the directory where the source of the Pod
+      #         is located.
+      #
+      attr_reader :path_list
+
+      # @return [Specification::Consumer] the consumer of the specification for
+      #         which the file patterns should be resolved.
+      #
+      attr_reader :spec_consumer
+
+      # Initialize a new instance
+      #
+      # @param [Sandbox::PathList, Pathname] path_list @see #path_list
+      # @param [Specification::Consumer] spec_consumer @see #spec_consumer
+      #
+      def initialize(path_list, spec_consumer)
+        if path_list.is_a?(PathList)
+          @path_list = path_list
+        else
+          @path_list = PathList.new(path_list)
+        end
+        @spec_consumer = spec_consumer
+
+        unless @spec_consumer
+          raise Informative, 'Attempt to initialize File Accessor without a specification consumer.'
+        end
+      end
+
+      # @return [Pathname] the directory which contains the files of the Pod.
+      #
+      def root
+        path_list.root if path_list
+      end
+
+      # @return [Specification] the specification.
+      #
+      def spec
+        spec_consumer.spec
+      end
+
+      # @return [Specification] the platform used to consume the specification.
+      #
+      def platform_name
+        spec_consumer.platform_name
+      end
+
+      # @return [String] A string suitable for debugging.
+      #
+      def inspect
+        "<#{self.class} spec=#{spec.name} platform=#{platform_name} root=#{root}>"
+      end
+
+      #-----------------------------------------------------------------------#
+
+      public
+
+      # @!group Paths
+
+      # @return [Array<Pathname>] the source files of the specification.
+      #
+      def source_files
+        paths_for_attribute(:source_files)
+      end
+
+      # @return [Array<Pathname>] the source files of the specification that
+      #                           use ARC.
+      #
+      def arc_source_files
+        case spec_consumer.requires_arc
+        when TrueClass
+          source_files
+        when FalseClass
+          []
+        else
+          paths_for_attribute(:requires_arc) & source_files
+        end
+      end
+
+      # @return [Array<Pathname>] the source files of the specification that
+      #                           do not use ARC.
+      #
+      def non_arc_source_files
+        source_files - arc_source_files
+      end
+
+      # @return [Array<Pathname] the source files that do not match any of the
+      #                          recognized file extensions
+      def other_source_files
+        extensions = SOURCE_FILE_EXTENSIONS
+        source_files.reject { |f| extensions.include?(f.extname) }
+      end
+
+      # @return [Array<Pathname>] the headers of the specification.
+      #
+      def headers
+        extensions = HEADER_EXTENSIONS
+        source_files.select { |f| extensions.include?(f.extname) }
+      end
+
+      # @param [Boolean] include_frameworks
+      #        Whether or not to include the headers of the vendored frameworks.
+      #        Defaults to not include them.
+      #
+      # @return [Array<Pathname>] the public headers of the specification.
+      #
+      def public_headers(include_frameworks = false)
+        public_headers = public_header_files
+        private_headers = private_header_files
+        if public_headers.nil? || public_headers.empty?
+          header_files = headers
+        else
+          header_files = public_headers
+        end
+        header_files += vendored_frameworks_headers if include_frameworks
+        header_files - private_headers
+      end
+
+      # @return [Array<Pathname>] The private headers of the specification.
+      #
+      def private_headers
+        private_header_files
+      end
+
+      # @return [Array<Pathname>] the resources of the specification.
+      #
+      def resources
+        paths_for_attribute(:resources, true)
+      end
+
+      # @return [Array<Pathname>] the files of the specification to preserve.
+      #
+      def preserve_paths
+        paths_for_attribute(:preserve_paths, true)
+      end
+
+      # @return [Array<Pathname>] The paths of the framework bundles that come
+      #         shipped with the Pod.
+      #
+      def vendored_frameworks
+        paths_for_attribute(:vendored_frameworks, true)
+      end
+
+      # @return [Array<Pathname>] The paths of the dynamic framework bundles
+      #         that come shipped with the Pod.
+      #
+      def vendored_dynamic_frameworks
+        vendored_frameworks.select do |framework|
+          dynamic_binary?(framework + framework.basename('.*'))
+        end
+      end
+
+      # @return [Array<Pathname>] The paths of the static (fake) framework
+      #         bundles that come shipped with the Pod.
+      #
+      def vendored_static_frameworks
+        vendored_frameworks - vendored_dynamic_frameworks
+      end
+
+      # @param  [Pathname] framework
+      #         The vendored framework to search into.
+      # @return [Pathname] The path of the header directory of the
+      #         vendored framework.
+      #
+      def self.vendored_frameworks_headers_dir(framework)
+        dir = framework + 'Headers'
+        dir.directory? ? dir.realpath : dir
+      end
+
+      # @param  [Pathname] framework
+      #         The vendored framework to search into.
+      # @return [Array<Pathname>] The paths of the headers included in the
+      #         vendored framework.
+      #
+      def self.vendored_frameworks_headers(framework)
+        headers_dir = vendored_frameworks_headers_dir(framework)
+        Pathname.glob(headers_dir + '**/' + GLOB_PATTERNS[:public_header_files])
+      end
+
+      # @return [Array<Pathname>] The paths of the framework headers that come
+      #         shipped with the Pod.
+      #
+      def vendored_frameworks_headers
+        vendored_frameworks.flat_map do |framework|
+          self.class.vendored_frameworks_headers(framework)
+        end.uniq
+      end
+
+      # @return [Array<Pathname>] The paths of the library bundles that come
+      #         shipped with the Pod.
+      #
+      def vendored_libraries
+        paths_for_attribute(:vendored_libraries)
+      end
+
+      # @return [Array<Pathname>] The paths of the dynamic libraries
+      #         that come shipped with the Pod.
+      #
+      def vendored_dynamic_libraries
+        vendored_libraries.select do |library|
+          dynamic_binary?(library)
+        end
+      end
+
+      # @return [Array<Pathname>] The paths of the static libraries
+      #         that come shipped with the Pod.
+      #
+      def vendored_static_libraries
+        vendored_libraries - vendored_dynamic_libraries
+      end
+
+      # @return [Array<Pathname>] The paths of the dynamic binary artifacts
+      #         that come shipped with the Pod.
+      #
+      def vendored_dynamic_artifacts
+        vendored_dynamic_libraries + vendored_dynamic_frameworks
+      end
+
+      # @return [Array<Pathname>] The paths of the static binary artifacts
+      #         that come shipped with the Pod.
+      #
+      def vendored_static_artifacts
+        vendored_static_libraries + vendored_static_frameworks
+      end
+
+      # @return [Hash{String => Array<Pathname>}] A hash that describes the
+      #         resource bundles of the Pod. The keys represent the name of
+      #         the bundle while the values the path of the resources.
+      #
+      def resource_bundles
+        result = {}
+        spec_consumer.resource_bundles.each do |name, file_patterns|
+          paths = expanded_paths(file_patterns,
+                                 :exclude_patterns => spec_consumer.exclude_files,
+                                 :include_dirs => true)
+          result[name] = paths
+        end
+        result
+      end
+
+      # @return [Array<Pathname>] The paths of the files which should be
+      #         included in resources bundles by the Pod.
+      #
+      def resource_bundle_files
+        resource_bundles.values.flatten
+      end
+
+      # @return [Pathname] The of the prefix header file of the specification.
+      #
+      def prefix_header
+        if file = spec_consumer.prefix_header_file
+          path_list.root + file
+        end
+      end
+
+      # @return [Pathname] The path of the auto-detected README file.
+      #
+      def readme
+        path_list.glob([GLOB_PATTERNS[:readme]]).first
+      end
+
+      # @return [Pathname] The path of the license file as indicated in the
+      #         specification or auto-detected.
+      #
+      def license
+        spec_license || path_list.glob([GLOB_PATTERNS[:license]]).first
+      end
+
+      # @return [Pathname, Nil] The path of the custom module map file of the
+      #         specification, if specified.
+      def module_map
+        if module_map = spec_consumer.module_map
+          path_list.root + module_map
+        end
+      end
+
+      # @return [Array<Pathname>] The paths of auto-detected podspecs
+      #
+      def specs
+        path_list.glob([GLOB_PATTERNS[:podspecs]])
+      end
+
+      # @return [Array<Pathname>] The paths of auto-detected docs
+      #
+      def docs
+        path_list.glob([GLOB_PATTERNS[:docs]])
+      end
+
+      # @return [Pathname] The path of the license file specified in the
+      #         specification, if it exists
+      #
+      def spec_license
+        if file = spec_consumer.license[:file]
+          absolute_path = root + file
+          absolute_path if File.exist?(absolute_path)
+        end
+      end
+
+      # @return [Array<Pathname>] Paths to include for local pods to assist in development
+      #
+      def developer_files
+        podspecs = specs
+        result = [module_map, prefix_header]
+
+        if license_path = spec_consumer.license[:file]
+          license_path = root + license_path
+          unless File.exist?(license_path)
+            UI.warn "A license was specified in podspec `#{spec.name}` but the file does not exist - #{license_path}"
+          end
+        end
+
+        if podspecs.size <= 1
+          result += [license, readme, podspecs, docs]
+        else
+          # Manually add non-globbing files since there are multiple podspecs in the same folder
+          result << podspec_file
+          if license_file = spec_license
+            absolute_path = root + license_file
+            result << absolute_path if File.exist?(absolute_path)
+          end
+        end
+        result.compact.flatten.sort
+      end
+
+      #-----------------------------------------------------------------------#
+
+      private
+
+      # @!group Private paths
+
+      # @return [Array<Pathname>] The paths of the user-specified public header
+      #         files.
+      #
+      def public_header_files
+        paths_for_attribute(:public_header_files)
+      end
+
+      # @return [Array<Pathname>] The paths of the user-specified public header
+      #         files.
+      #
+      def private_header_files
+        paths_for_attribute(:private_header_files)
+      end
+
+      # @return [Pathname] The path of the podspec matching @spec
+      #
+      def podspec_file
+        specs.lazy.select { |p| File.basename(p.to_s, '.*') == spec.name }.first
+      end
+
+      #-----------------------------------------------------------------------#
+
+      private
+
+      # @!group Private helpers
+
+      # Returns the list of the paths founds in the file system for the
+      # attribute with given name. It takes into account any dir pattern and
+      # any file excluded in the specification.
+      #
+      # @param  [Symbol] attribute
+      #         the name of the attribute.
+      #
+      # @return [Array<Pathname>] the paths.
+      #
+      def paths_for_attribute(attribute, include_dirs = false)
+        file_patterns = spec_consumer.send(attribute)
+        options = {
+          :exclude_patterns => spec_consumer.exclude_files,
+          :dir_pattern => GLOB_PATTERNS[attribute],
+          :include_dirs => include_dirs,
+        }
+        expanded_paths(file_patterns, options)
+      end
+
+      # Matches the given patterns to the file present in the root of the path
+      # list.
+      #
+      # @param  [Array<String>] patterns
+      #         The patterns to expand.
+      #
+      # @param  [Hash] options
+      #         The options to use to expand the patterns to file paths.
+      #
+      # @option options [String] :dir_pattern
+      #         The pattern to add to directories.
+      #
+      # @option options [Array<String>] :exclude_patterns
+      #         The exclude patterns to pass to the PathList.
+      #
+      # @option options [Bool] :include_dirs
+      #         Whether directories should be also included or just plain
+      #         files.
+      #
+      # @raise  [Informative] If the pod does not exists.
+      #
+      # @return [Array<Pathname>] A list of the paths.
+      #
+      def expanded_paths(patterns, options = {})
+        return [] if patterns.empty?
+        path_list.glob(patterns, options).flatten.compact.uniq
+      end
+
+      # @param  [Pathname] binary
+      #         The file to be checked for being a dynamic Mach-O binary.
+      #
+      # @return [Boolean] Whether `binary` can be dynamically linked.
+      #
+      def dynamic_binary?(binary)
+        @cached_dynamic_binary_results ||= {}
+        return @cached_dynamic_binary_results[binary] unless @cached_dynamic_binary_results[binary].nil?
+        return false unless binary.file?
+
+        @cached_dynamic_binary_results[binary] = MachO.open(binary).dylib?
+      rescue MachO::MachOError
+        @cached_dynamic_binary_results[binary] = false
+      end
+
+      #-----------------------------------------------------------------------#
+    end
+  end
+end

data/lib/cocoapods/sandbox/headers_store.rb

@@ -0,0 +1,146 @@
+module Pod
+  class Sandbox
+    # Provides support for managing a header directory. It also keeps track of
+    # the header search paths.
+    #
+    class HeadersStore
+      SEARCH_PATHS_KEY = Struct.new(:platform_name, :target_name, :use_modular_headers)
+
+      # @return [Pathname] the absolute path of this header directory.
+      #
+      def root
+        sandbox.headers_root + @relative_path
+      end
+
+      # @return [Sandbox] the sandbox where this header directory is stored.
+      #
+      attr_reader :sandbox
+
+      # @param  [Sandbox] @see #sandbox
+      #
+      # @param  [String] relative_path
+      #         the relative path to the sandbox root and hence to the Pods
+      #         project.
+      #
+      # @param  [Symbol] visibility_scope
+      #         the header visibility scope to use in this store. Can be `:private` or `:public`.
+      #
+      def initialize(sandbox, relative_path, visibility_scope)
+        @sandbox       = sandbox
+        @relative_path = relative_path
+        @search_paths  = []
+        @search_paths_cache = {}
+        @visibility_scope = visibility_scope
+      end
+
+      # @param  [Platform] platform
+      #         the platform for which the header search paths should be
+      #         returned.
+      #
+      # @param  [String] target_name
+      #         the target for which the header search paths should be
+      #         returned. Can be `nil` in which case all headers that match the platform
+      #         will be returned.
+      #
+      # @param  [Boolean] use_modular_headers
+      #         whether the search paths generated should use modular (stricter) style.
+      #
+      # @return [Array<String>] All the search paths of the header directory in
+      #         xcconfig format. The paths are specified relative to the pods
+      #         root with the `${PODS_ROOT}` variable.
+      #
+      def search_paths(platform, target_name = nil, use_modular_headers = false)
+        key = SEARCH_PATHS_KEY.new(platform.name, target_name, use_modular_headers)
+        return @search_paths_cache[key] if @search_paths_cache.key?(key)
+        search_paths = @search_paths.select do |entry|
+          matches_platform = entry[:platform] == platform.name
+          matches_target = target_name.nil? || (File.basename(entry[:path]) == target_name)
+          matches_platform && matches_target
+        end
+        headers_dir = root.relative_path_from(sandbox.root).dirname
+        @search_paths_cache[key] = search_paths.flat_map do |entry|
+          paths = []
+          paths << "${PODS_ROOT}/#{headers_dir}/#{@relative_path}" if !use_modular_headers || @visibility_scope == :public
+          paths << "${PODS_ROOT}/#{headers_dir}/#{entry[:path]}" if !use_modular_headers || @visibility_scope == :private
+          paths
+        end.tap(&:uniq!).freeze
+      end
+
+      # Removes the directory as it is regenerated from scratch during each
+      # installation.
+      #
+      # @return [void]
+      #
+      def implode!
+        root.rmtree if root.exist?
+      end
+
+      #-----------------------------------------------------------------------#
+
+      public
+
+      # @!group Adding headers
+
+      # Adds headers to the directory.
+      #
+      # @param  [Pathname] namespace
+      #         the path where the header file should be stored relative to the
+      #         headers directory.
+      #
+      # @param  [Array<Pathname>] relative_header_paths
+      #         the path of the header file relative to the Pods project
+      #         (`PODS_ROOT` variable of the xcconfigs).
+      #
+      # @note   This method does _not_ add the files to the search paths.
+      #
+      # @return [Array<Pathname>]
+      #
+      def add_files(namespace, relative_header_paths)
+        root.join(namespace).mkpath unless relative_header_paths.empty?
+        relative_header_paths.map do |relative_header_path|
+          add_file(namespace, relative_header_path, :mkdir => false)
+        end
+      end
+
+      # Adds a header to the directory.
+      #
+      # @param  [Pathname] namespace
+      #         the path where the header file should be stored relative to the
+      #         headers directory.
+      #
+      # @param  [Pathname] relative_header_path
+      #         the path of the header file relative to the Pods project
+      #         (`PODS_ROOT` variable of the xcconfigs).
+      #
+      # @note   This method does _not_ add the file to the search paths.
+      #
+      # @return [Pathname]
+      #
+      def add_file(namespace, relative_header_path, mkdir: true)
+        namespaced_path = root + namespace
+        namespaced_path.mkpath if mkdir
+
+        absolute_source = (sandbox.root + relative_header_path)
+        source = absolute_source.relative_path_from(namespaced_path)
+        FileUtils.ln_sf(source, namespaced_path)
+        namespaced_path + relative_header_path.basename
+      end
+
+      # Adds an header search path to the sandbox.
+      #
+      # @param  [Pathname] path
+      #         the path to add.
+      #
+      # @param  [String] platform
+      #         the platform the search path applies to
+      #
+      # @return [void]
+      #
+      def add_search_path(path, platform)
+        @search_paths << { :platform => platform.name, :path => File.join(@relative_path, path) }
+      end
+
+      #-----------------------------------------------------------------------#
+    end
+  end
+end