cocoapods-square-stable 0.19.3

data/lib/cocoapods/installer/user_project_integrator/target_integrator.rb

@@ -0,0 +1,224 @@
+require 'active_support'
+
+module Pod
+  class Installer
+    class UserProjectIntegrator
+
+      # This class is responsible for integrating the library generated by a
+      # {TargetDefinition} with its destination project.
+      #
+      class TargetIntegrator
+
+        # @return [Library] the library that should be integrated.
+        #
+        attr_reader :library
+
+        # @param  [Library] library @see #target_definition
+        #
+        def initialize(library)
+          @library = library
+        end
+
+        # Integrates the user project targets. Only the targets that do **not**
+        # already have the Pods library in their frameworks build phase are
+        # processed.
+        #
+        # @return [void]
+        #
+        def integrate!
+          return if targets.empty?
+          UI.section(integration_message) do
+            add_xcconfig_base_configuration
+            add_pods_library
+            add_copy_resources_script_phase
+            add_check_manifest_lock_script_phase
+            save_user_project
+          end
+        end
+
+        # @return [Array<PBXNativeTarget>] the list of targets that the Pods
+        #         lib that need to be integrated.
+        #
+        # @note   A target is considered integrated if it already references
+        #
+        def targets
+          unless @targets
+            target_uuids = library.user_target_uuids
+            targets = target_uuids.map do |uuid|
+              target = user_project.objects_by_uuid[uuid]
+              unless target
+                raise Informative, "[Bug] Unable to find the target with " \
+                  "the `#{uuid}` UUID for the `#{library}` library"
+              end
+              target
+            end
+            non_integrated = targets.reject do |target|
+              target.frameworks_build_phase.files.any? do |build_file|
+                file_ref = build_file.file_ref
+                file_ref &&
+                  file_ref.isa == 'PBXFileReference' &&
+                  file_ref.display_name == library.product_name
+              end
+            end
+            @targets = non_integrated
+          end
+          @targets
+        end
+
+        # Read the project from the disk to ensure that it is up to date as
+        # other TargetIntegrators might have modified it.
+        #
+        def user_project
+          @user_project ||= Xcodeproj::Project.new(library.user_project_path)
+        end
+
+        # @return [String] a string representation suitable for debugging.
+        #
+        def inspect
+          "#<#{self.class} for target `#{target_definition.label}'>"
+        end
+
+        #---------------------------------------------------------------------#
+
+        # @!group Integration steps
+
+        private
+
+        # Adds the `xcconfig` configurations files generated for the current
+        # {TargetDefinition} to the build configurations of the targets that
+        # should be integrated.
+        #
+        # @note   It also checks if any build setting of the build
+        #         configurations overrides the `xcconfig` file and warns the
+        #         user.
+        #
+        # @todo   If the xcconfig is already set don't override it and inform
+        #         the user.
+        #
+        # @return [void]
+        #
+        def add_xcconfig_base_configuration
+          xcconfig = user_project.new_file(library.xcconfig_relative_path)
+          targets.each do |target|
+            check_overridden_build_settings(library.xcconfig, target)
+            target.build_configurations.each do |config|
+              config.base_configuration_reference = xcconfig
+            end
+          end
+        end
+
+        # Adds a file reference to the library of the {TargetDefinition} and
+        # adds it to the frameworks build phase of the targets.
+        #
+        # @return [void]
+        #
+        def add_pods_library
+          frameworks = user_project.frameworks_group
+          pods_library = frameworks.new_static_library(library.label)
+          targets.each do |target|
+            target.frameworks_build_phase.add_file_reference(pods_library)
+          end
+        end
+
+        # Adds a shell script build phase responsible to copy the resources
+        # generated by the TargetDefinition to the bundle of the product of the
+        # targets.
+        #
+        # @return [void]
+        #
+        def add_copy_resources_script_phase
+          targets.each do |target|
+            phase = target.new_shell_script_build_phase('Copy Pods Resources')
+            path  = library.copy_resources_script_relative_path
+            phase.shell_script = %{"#{path}"\n}
+          end
+        end
+
+        # Adds a shell script build phase responsible for checking if the Pods
+        # locked in the Pods/Manifest.lock file are in sync with the Pods defined
+        # in the Podfile.lock.
+        #
+        # @note   The build phase is appended to the front because to fail
+        #         fast.
+        #
+        # @return [void]
+        #
+        def add_check_manifest_lock_script_phase
+          targets.each do |target|
+            phase = target.project.new(Xcodeproj::Project::Object::PBXShellScriptBuildPhase)
+            target.build_phases.unshift(phase)
+            phase.name = 'Check Pods Manifest.lock'
+            phase.shell_script = <<-EOS.strip_heredoc
+              diff "${PODS_ROOT}/../Podfile.lock" "${PODS_ROOT}/Manifest.lock" > /dev/null
+              if [[ $? != 0 ]] ; then
+                  cat << EOM
+              error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.
+              EOM
+                  exit 1
+              fi
+            EOS
+          end
+        end
+
+        # Saves the changes to the user project to the disk.
+        #
+        # @return [void]
+        #
+        def save_user_project
+          user_project.save_as(library.user_project_path)
+        end
+
+        #---------------------------------------------------------------------#
+
+        # @!group Private helpers.
+
+        private
+
+        # Informs the user about any build setting of the target which might
+        # override the given xcconfig file.
+        #
+        # @return [void]
+        #
+        def check_overridden_build_settings(xcconfig, target)
+          return unless xcconfig
+
+          configs_by_overridden_key = {}
+          target.build_configurations.each do |config|
+            xcconfig.attributes.keys.each do |key|
+              target_value = config.build_settings[key]
+
+              if target_value && !target_value.include?('$(inherited)')
+                configs_by_overridden_key[key] ||= []
+                configs_by_overridden_key[key] << config.name
+              end
+            end
+
+            configs_by_overridden_key.each do |key, config_names|
+              name    = "#{target.name} [#{config_names.join(' - ')}]"
+              actions = [
+                "Use the `$(inherited)` flag, or",
+                "Remove the build settings from the target."
+              ]
+              UI.warn("The target `#{name}` overrides the `#{key}` build " \
+                      "setting defined in `#{library.xcconfig_relative_path}'.",
+                      actions)
+            end
+          end
+        end
+
+        # @return [String] the message that should be displayed for the target
+        #         integration.
+        #
+        def integration_message
+          "Integrating `#{library.product_name}` into " \
+            "#{'target'.pluralize(targets.size)} "  \
+            "`#{targets.map(&:name).to_sentence}` " \
+            "of project #{UI.path library.user_project_path}."
+        end
+
+        #---------------------------------------------------------------------#
+
+      end
+    end
+  end
+end

data/lib/cocoapods/library.rb

@@ -0,0 +1,202 @@
+module Pod
+
+  # Model class which describes a Pods library.
+  #
+  # The Library class stores and provides the information necessary for
+  # working with a library in the Pods project and in the user projects
+  # through the installation process.
+  #
+  class Library
+
+    # @return [PBXNativeTarget] the target definition of the Podfile that
+    #         generated this library.
+    #
+    attr_reader :target_definition
+
+    # @param  [TargetDefinition] target_definition @see target_definition
+    # @param  [PBXNativeTarget]  target @see target
+    #
+    def initialize(target_definition)
+      @target_definition = target_definition
+    end
+
+    # @return [String] the label for the library.
+    #
+    def label
+      target_definition.label.to_s
+    end
+
+    # @return [String] the name of the library.
+    #
+    def name
+      target_definition.label.to_s
+    end
+
+    # @return [String] the name of the library.
+    #
+    def product_name
+      "lib#{target_definition.label}.a"
+    end
+
+    # @return [String] A string suitable for debugging.
+    #
+    def inspect
+      "<#{self.class} name=#{name} platform=#{platform}>"
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Information storage
+
+    # @return [Pathname] the folder where to store the support files of this
+    #         library.
+    #
+    attr_accessor :support_files_root
+
+    # @return [Pathname] the folder where the client is stored used for
+    #         computing the relative paths. If integrating it should be the
+    #         folder where the user project is stored, otherwise it should
+    #         be the installation root.
+    #
+    attr_accessor :client_root
+
+    # @return [Pathname] the path of the user project that this library will
+    #         integrate as identified by the analyzer.
+    #
+    # @note   The project instance is not stored to prevent editing different
+    #         instances.
+    #
+    attr_accessor :user_project_path
+
+    # @return [String] the list of the UUIDs of the user targets that will be
+    #         integrated by this library as identified by the analizer.
+    #
+    # @note   The target instances are not stored to prevent editing different
+    #         instances.
+    #
+    attr_accessor :user_target_uuids
+
+    # @return [Hash{String=>Symbol}] A hash representing the user build
+    #         configurations where each key corresponds to the name of a
+    #         configuration and its value to its type (`:debug` or `:release`).
+    #
+    attr_accessor :user_build_configurations
+
+    # @return [Platform] the platform for this library.
+    #
+    attr_accessor :platform
+
+    # @return [PBXNativeTarget] the target generated in the Pods project for
+    #         this library.
+    #
+    attr_accessor :target
+
+    # @return [Xcodeproj::Config] the configuration file of the library
+    #
+    # @note   The configuration is generated by the {TargetInstaller} and
+    #         used by {UserProjectIntegrator} to check for any overridden
+    #         values.
+    #
+    attr_accessor :xcconfig
+
+    # @return [Array<Specification>] the specifications of this library.
+    #
+    attr_accessor :specs
+
+    # @return [Array<Sandbox::FileAccessor>] the file accessors for the
+    #         specifications of this library.
+    #
+    attr_accessor :file_accessors
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Support files
+
+    # @return [Pathname] the absolute path of the xcconfig file.
+    #
+    def xcconfig_path
+      support_files_root + "#{label}.xcconfig"
+    end
+
+    # @return [Pathname] the absolute path of the copy resources script.
+    #
+    def copy_resources_script_path
+      support_files_root + "#{label}-resources.sh"
+    end
+
+    # @return [Pathname] the absolute path of the header file which contains
+    #         the information about the installed pods.
+    #
+    def target_environment_header_path
+      support_files_root + "#{label}-environment.h"
+    end
+
+    # @return [Pathname] the absolute path of the prefix header file.
+    #
+    def prefix_header_path
+      support_files_root + "#{label}-prefix.pch"
+    end
+
+    # @return [Pathname] the absolute path of the bridge support file.
+    #
+    def bridge_support_path
+      support_files_root + "#{label}.bridgesupport"
+    end
+
+    # @return [Pathname] the absolute path of acknowledgements file.
+    #
+    # @note   The acknowledgements generators add the extension according to
+    #         the file type.
+    #
+    def acknowledgements_basepath
+      support_files_root + "#{label}-acknowledgements"
+    end
+
+    # @return [Pathname] the path of the dummy source generated by CocoaPods
+    #
+    def dummy_source_path
+      support_files_root + "#{label}-dummy.m"
+    end
+
+    #--------------------------------------#
+
+    # @return [String] The xcconfig path of the root from the `$(SRCROOT)`
+    #         variable of the user's project.
+    #
+    def relative_pods_root
+      "${SRCROOT}/#{support_files_root.relative_path_from(client_root)}"
+    end
+
+    # @return [String] the path of the xcconfig file relative to the root of
+    #         the user project.
+    #
+    def xcconfig_relative_path
+      relative_to_srcroot(xcconfig_path).to_s
+    end
+
+    # @return [String] the path of the copy resources script relative to the
+    #         root of the user project.
+    #
+    def copy_resources_script_relative_path
+      "${SRCROOT}/#{relative_to_srcroot(copy_resources_script_path)}"
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Private Helpers
+
+    private
+
+    # Computes the relative path of a sandboxed file from the `$(SRCROOT)`
+    # variable of the user's project.
+    #
+    # @param  [Pathname] path
+    #         A relative path from the root of the sandbox.
+    #
+    # @return [String] the computed path.
+    #
+    def relative_to_srcroot(path)
+      path.relative_path_from(client_root).to_s
+    end
+  end
+end

data/lib/cocoapods/open_uri.rb

@@ -0,0 +1,24 @@
+require 'open-uri'
+
+# Allow OpenURI to follow http to https redirects.
+#
+module OpenURI
+
+  # Whether {#open} should follow a redirect.
+  #
+  # Inspiration from: https://gist.github.com/1271420
+  # Relevant issue:   http://redmine.ruby-lang.org/issues/3719
+  # Source here:      https://github.com/ruby/ruby/blob/trunk/lib/open-uri.rb
+  #
+  # This test is intended to forbid a redirection from http://... to
+  # file:///etc/passwd, file:///dev/zero, etc.  CVE-2011-1521
+  # https to http redirect is also forbidden intentionally.
+  # It avoids sending secure cookie or referrer by non-secure HTTP protocol.
+  # (RFC 2109 4.3.1, RFC 2965 3.3, RFC 2616 15.1.3)
+  # However this is ad hoc.  It should be extensible/configurable.
+  #
+  def OpenURI.redirectable?(uri1, uri2)
+    uri1.scheme.downcase == uri2.scheme.downcase ||
+    (/\A(?:http|ftp)\z/i =~ uri1.scheme && /\A(?:https?|ftp)\z/i =~ uri2.scheme)
+  end
+end