cocoapods-square-stable 0.19.3

data/lib/cocoapods/generator/xcconfig.rb

@@ -0,0 +1,185 @@
+module Pod
+  module Generator
+
+    # Generates an xcconfig file for each target of the Pods project. The
+    # configuration file should be used by the user target as well.
+    #
+    class XCConfig
+
+      # @return [Sandbox] the sandbox where the Pods project is installed.
+      #
+      attr_reader :sandbox
+
+      # @return [Array<Specification::Consumer>] the consumers for the
+      #         specifications of the library which needs the xcconfig.
+      #
+      attr_reader :spec_consumers
+
+      # @return [String] the relative path of the Pods root respect the user
+      #         project that should be integrated by this library.
+      #
+      attr_reader :relative_pods_root
+
+      # @param  [Sandbox] sandbox @see sandbox
+      # @param  [Array<LocalPod>] pods @see pods
+      # @param  [String] relative_pods_root @see relative_pods_root
+      #
+      def initialize(sandbox, spec_consumers, relative_pods_root)
+        @sandbox = sandbox
+        @spec_consumers = spec_consumers
+        @relative_pods_root = relative_pods_root
+      end
+
+      # @return [Bool] whether the Podfile specifies to add the `-fobjc-arc`
+      #         flag for compatibility.
+      #
+      attr_accessor :set_arc_compatibility_flag
+
+      #-----------------------------------------------------------------------#
+
+      # Generates the xcconfig for the library.
+      #
+      # @return [Xcodeproj::Config]
+      #
+      # @note   The value `PODS_HEADERS_SEARCH_PATHS` is used to store the headers
+      #         so xcconfig can reference the variable.
+      #
+      def generate
+        ld_flags = '-ObjC'
+        if  set_arc_compatibility_flag && spec_consumers.any? { |consumer| consumer.requires_arc }
+          ld_flags << ' -fobjc-arc'
+        end
+
+        @xcconfig = Xcodeproj::Config.new({
+          'ALWAYS_SEARCH_USER_PATHS'         => 'YES',
+          'OTHER_LDFLAGS'                    => ld_flags,
+          'HEADER_SEARCH_PATHS'              => '${PODS_HEADERS_SEARCH_PATHS}',
+          'PODS_ROOT'                        => relative_pods_root,
+          'PODS_HEADERS_SEARCH_PATHS'        => '${PODS_PUBLIC_HEADERS_SEARCH_PATHS}',
+          'PODS_BUILD_HEADERS_SEARCH_PATHS'  => quote(sandbox.build_headers.search_paths),
+          'PODS_PUBLIC_HEADERS_SEARCH_PATHS' => quote(sandbox.public_headers.search_paths),
+          'GCC_PREPROCESSOR_DEFINITIONS'     => '$(inherited) COCOAPODS=1'
+        })
+
+        spec_consumers.each do |consumer|
+          add_spec_build_settings_to_xcconfig(consumer, @xcconfig)
+        end
+
+        @xcconfig
+      end
+
+      # @return [Xcodeproj::Config] The generated xcconfig.
+      #
+      attr_reader :xcconfig
+
+      # @return [Hash] The settings of the xcconfig that the Pods project
+      #         needs to override.
+      #
+      def self.pods_project_settings
+        { 'PODS_ROOT' => '${SRCROOT}',
+          'PODS_HEADERS_SEARCH_PATHS' => '${PODS_BUILD_HEADERS_SEARCH_PATHS}' }
+      end
+
+      # Generates and saves the xcconfig to the given path.
+      #
+      # @param  [Pathname] path
+      #         the path where the prefix header should be stored.
+      #
+      # @return [void]
+      #
+      def save_as(path)
+        path.open('w') { |file| file.write(generate) }
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # @!group Private helpers.
+
+      private
+
+      # @return [String] the default linker flags. `-ObjC` is always included
+      #         while `-fobjc-arc` is included only if requested in the
+      #         Podfile.
+      #
+      def default_ld_flags
+        flags = %w[ -ObjC ]
+        requires_arc = pods.any? { |pod| pod.requires_arc? }
+        if  requires_arc && set_arc_compatibility_flag
+          flags << '-fobjc-arc'
+        end
+        flags.join(" ")
+      end
+
+      # Converts an array of strings to a single string where the each string
+      # is surrounded by double quotes and separated by a space. Used to
+      # represent strings in a xcconfig file.
+      #
+      # @param  [Array<String>] strings
+      #         a list of strings.
+      #
+      # @return [String] the resulting string.
+      #
+      def quote(strings)
+        strings.sort.map { |s| %W|"#{s}"| }.join(" ")
+      end
+
+      # Configures the given Xcconfig according to the build settings of the
+      # given Specification.
+      #
+      # @param  [Specification::Consumer] consumer
+      #         The consumer of the specification.
+      #
+      # @param  [Xcodeproj::Config] xcconfig
+      #         The xcconfig to edit.
+      #
+      # @return [void]
+      #
+      def add_spec_build_settings_to_xcconfig(consumer, xcconfig)
+        xcconfig.merge!(consumer.xcconfig)
+        xcconfig.libraries.merge(consumer.libraries)
+        xcconfig.frameworks.merge(consumer.frameworks)
+        xcconfig.weak_frameworks.merge(consumer.weak_frameworks)
+        add_developers_frameworks_if_needed(consumer, xcconfig)
+      end
+
+      # @return [Array<String>] The search paths for the developer frameworks.
+      #
+      # @todo   Inheritance should be properly handled in Xcconfigs.
+      #
+      DEVELOPER_FRAMEWORKS_SEARCH_PATHS = [
+        '$(inherited)',
+        '"$(SDKROOT)/Developer/Library/Frameworks"',
+        '"$(DEVELOPER_LIBRARY_DIR)/Frameworks"'
+      ]
+
+      # Adds the search paths of the developer frameworks to the specification
+      # if needed. This is done because the `SenTestingKit` requires them and 
+      # adding them to each specification which requires it is repetitive and
+      # error prone.
+      #
+      # @param  [Specification::Consumer] consumer
+      #         The consumer of the specification.
+      #
+      # @param  [Xcodeproj::Config] xcconfig
+      #         The xcconfig to edit.
+      #
+      # @return [void]
+      #
+      def add_developers_frameworks_if_needed(consumer, xcconfig)
+        if xcconfig.frameworks.include?('SenTestingKit')
+          search_paths = xcconfig.attributes['FRAMEWORK_SEARCH_PATHS'] ||= ''
+          DEVELOPER_FRAMEWORKS_SEARCH_PATHS.each do |search_path|
+            unless search_paths.include?(search_path)
+              search_paths << ' ' unless search_paths.empty?
+              search_paths << search_path
+            end
+          end
+        end
+      end
+
+      #-----------------------------------------------------------------------#
+
+    end
+  end
+end
+

data/lib/cocoapods/hooks/installer_representation.rb

@@ -0,0 +1,134 @@
+module Pod
+
+  class Podfile
+    def config
+      UI.warn "Podfile#config is deprecated. The config is accessible from " \
+        "the parameter passed to the hooks"
+      Config.instance
+    end
+  end
+
+  class Podfile::TargetDefinition
+    def copy_resources_script_name
+      UI.warn "TargetDefinition#copy_resources_script_name is deprecated. " \
+        "The value is accessible directly from the representation of the " \
+        "library using the #copy_resources_script_path method."
+      Config.instance.sandbox.root + "#{label}-resources.sh"
+    end
+  end
+
+  module Hooks
+
+    # The installer representation to pass to the hooks.
+    #
+    class InstallerRepresentation
+
+      public
+
+      # @!group Public Hooks API
+
+      # @return [Pathname] The root of the sandbox.
+      #
+      def sandbox_root
+        installer.sandbox.root
+      end
+
+      # @return [Pod::Project] the `Pods/Pods.xcodeproj` project.
+      #
+      # @note   This value is not yet set in the pre install callbacks.
+      #
+      def project
+        installer.pods_project
+      end
+
+      # @return [Array<PodRepresentation>] The representation of the Pods.
+      #
+      def pods
+        installer.pod_reps
+      end
+
+      # @return [Array<LibraryRepresentation>] The representation of the
+      #         libraries.
+      #
+      def libraries
+        installer.library_reps
+      end
+
+      # @return [Hash{LibraryRepresentation => Array<Specification>}] The
+      #         specifications grouped by target definition.
+      #
+      def specs_by_lib
+        result = {}
+        installer.libraries.each do |lib|
+          result[installer.library_rep(lib)] = lib.specs
+        end
+        result
+      end
+
+      # @return [Hash{LibraryRepresentation => Array<PodRepresentation>}] The
+      #         local pod instances grouped by target.
+      #
+      def pods_by_lib
+        result = {}
+        installer.libraries.each do |lib|
+          pod_names = lib.specs.map { |spec| spec.root.name }.uniq
+          pod_reps = pods.select { |rep| pod_names.include?(rep.name) }
+          result[lib.target_definition] = pod_reps
+        end
+        result
+      end
+
+      #-----------------------------------------------------------------------#
+      public
+
+      # @!group Compatibility
+      #
+      # The following aliases provides compatibility with CP < 0.17
+
+      alias :target_installers :libraries
+      alias :specs_by_target :specs_by_lib
+      alias :local_pods_by_target :pods_by_lib
+
+      #-----------------------------------------------------------------------#
+
+      public
+
+      # @!group Unsafe Hooks API
+      #
+      # The interface of the following objects might change at any time.
+      # If there some information which is needed, please open an issue.
+
+      # @return [Sandbox] sandbox the sandbox where the support files should
+      #         be generated.
+      #
+      def sandbox
+        installer.sandbox
+      end
+
+      # @return [Config] The config singleton used for the installation.
+      #
+      def config
+        Config.instance
+      end
+
+      # @return [Installer] The installer described by this instance.
+      #
+      attr_reader :installer
+
+      #-----------------------------------------------------------------------#
+
+      # @!group Private implementation
+
+      # @param [Installer] installer @see installer
+      #
+      def initialize(installer)
+        @installer = installer
+      end
+
+      #-----------------------------------------------------------------------#
+
+    end
+  end
+end
+
+

data/lib/cocoapods/hooks/library_representation.rb

@@ -0,0 +1,94 @@
+module Pod
+  module Hooks
+    class LibraryRepresentation
+
+      # Stores the information of the target installer
+
+      #-----------------------------------------------------------------------#
+
+      # @return [String] The name of the Pods library.
+      #
+      def name
+        library.name
+      end
+
+      # @return [Array<Dependency>] The dependencies of this library.
+      #
+      def dependencies
+        target_definition.dependencies
+      end
+
+      # @return [Pathname] The path of the Pods dir.
+      #
+      def sandbox_dir
+        sandbox.root
+      end
+
+      # @return [Pathname] The path of the prefix_header
+      #
+      def prefix_header_path
+        UI.warn "LibraryRepresentation#prefix_header_path is deprecated. " \
+          "Use the specification `prefix_header_contents` attribute."
+        library.prefix_header_path
+      end
+      alias :prefix_header_filename :prefix_header_path
+
+      # @return [Pathname] The path of the script used to copy the resources.
+      #
+      def copy_resources_script_path
+        library.copy_resources_script_path
+      end
+
+      # @return [Project] The Pods project of the sandbox.
+      #
+      def project
+        sandbox.project
+      end
+
+      # @return [TargetDefinition] The target definition of the library.
+      #
+      def target_definition
+        library.target_definition
+      end
+
+      #-----------------------------------------------------------------------#
+
+      public
+
+      # @!group Unsafe Hooks API
+
+      # @return [Sandbox] sandbox the sandbox where the support files should
+      #         be generated.
+      #
+      attr_reader :sandbox
+
+      # @return [Library] The library whose target needs to be generated.
+      #
+      attr_reader :library
+
+      # @return [PBXNativeTarget] The target generated by the installation
+      #         process.
+      #
+      def target
+        library.target
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # @!group Private implementation
+
+      # @param [Sandbox] sandbox @see sandbox
+      # @param [Library] library @see library
+      #
+      def initialize(sandbox, library)
+        @sandbox = sandbox
+        @library = library
+      end
+
+      #-----------------------------------------------------------------------#
+
+    end
+  end
+end
+
+

data/lib/cocoapods/hooks/pod_representation.rb

@@ -0,0 +1,74 @@
+module Pod
+
+  class Specification
+    def config
+      UI.warn "[#{name}] Specification#config is deprecated. The config is accessible from " \
+        "the parameter passed to the hooks"
+      Config.instance
+    end
+  end
+
+  module Hooks
+
+    # Stores the information of the Installer for the hooks
+    #
+    class PodRepresentation
+
+      # @return [String]
+      #
+      attr_accessor :name
+
+      # @return [Version]
+      #
+      def version
+        root_spec.version
+      end
+
+      # @return [Specification]
+      #
+      def root_spec
+        file_accessors.first.spec.root
+      end
+
+      # @return [Array<Specification>]
+      #
+      def specs
+        file_accessors.map(&:spec).uniq
+      end
+
+      # @return [Pathname]
+      #
+      def root
+        file_accessors.first.path_list.root
+      end
+
+      # @return [Array<Pathname>]
+      #
+      def source_files
+        file_accessors.map(&:source_files).flatten.uniq
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # @!group Private implementation
+
+      # @param [Installer] installer @see installer
+      #
+      def initialize(name, file_accessors)
+        @name = name
+        @file_accessors = file_accessors
+      end
+
+      def to_s
+        root_spec.to_s
+      end
+
+      private
+
+      attr_reader :file_accessors
+
+      #-----------------------------------------------------------------------#
+
+    end
+  end
+end