cocoapods 0.16.4 → 0.17.0.rc1

data/lib/cocoapods/library.rb

@@ -0,0 +1,195 @@
+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 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_header_path
+      support_files_root + "#{label}-header.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(user_project_path.dirname)}"
+    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(user_project_path.dirname).to_s
+    end
+  end
+end

data/lib/cocoapods/open_uri.rb

@@ -1,21 +1,23 @@
 require 'open-uri'
 
-# Inspiration from: https://gist.github.com/1271420
+# Allow OpenURI to follow http to https redirects.
 #
-# Allow open-uri to follow http to https redirects.
-# Relevant issue:
-# http://redmine.ruby-lang.org/issues/3719
-# Source here:
-# https://github.com/ruby/ruby/blob/trunk/lib/open-uri.rb
-
 module OpenURI
-  def OpenURI.redirectable?(uri1, uri2) # :nodoc:
-    # 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 referer 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.
+
+  # 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

data/lib/cocoapods/project.rb

@@ -1,86 +1,209 @@
 require 'xcodeproj'
 
-# Xcodeproj::Project::Object::PBXCopyFilesBuildPhase.instance_eval do
-#   def self.new_pod_dir(project, pod_name, path)
-#     new(project, nil, {
-#       "dstPath" => "Pods/#{path}",
-#       "name"    => "Copy #{pod_name} Public Headers",
-#     })
-#   end
-# end
-
 module Pod
+
+  # The Pods project.
+  #
+  # Model class which provides helpers for working with the Pods project
+  # through the installation process.
+  #
   class Project < Xcodeproj::Project
 
-    attr_reader :support_files_group
+    # @return [Pathname] the path of the xcodeproj file which stores the
+    #         project.
+    #
+    attr_reader :path
 
-    def initialize(*)
-      super
-      new_group('Pods')
+    # @param  [Sandbox] sandbox @see #sandbox
+    #
+    def initialize(path = nil)
+      super(nil) # Recreate the project from scratch for now.
+      @path = path
       @support_files_group = new_group('Targets Support Files')
-      @user_build_configurations = []
+
+      @refs_by_absolute_path = {}
     end
 
-    def user_build_configurations=(user_build_configurations)
-      @user_build_configurations = user_build_configurations
-      # The configurations at the top level only need to exist, they don't hold
-      # any build settings themselves, that's left to `add_pod_target`.
-      user_build_configurations.each do |name, _|
-        unless build_configurations.map(&:name).include?(name)
-          bc = new(XCBuildConfiguration)
-          bc.name = name
-          build_configurations << bc
-        end
+    # @return [Pathname] the path of the xcodeproj file which stores the
+    #         project.
+    #
+    attr_reader :path
+
+    # @return [Pathname] the directory where the project is stored.
+    #
+    def root
+      @root ||= path.dirname
+    end
+
+    # @return [Pathname] Returns the relative path from the project root.
+    #
+    # @param  [Pathname] path
+    #         The path that needs to be converted to the relative format.
+    #
+    # @note   If the two absolute paths don't share the same root directory an
+    #         extra `../` is added to the result of
+    #         {Pathname#relative_path_from}.
+    #
+    # @example
+    #
+    #   path = Pathname.new('/Users/dir')
+    #   @sandbox.root #=> Pathname('/tmp/CocoaPods/Lint/Pods')
+    #
+    #   @sandbox.relativize(path) #=> '../../../../Users/dir'
+    #   @sandbox.relativize(path) #=> '../../../../../Users/dir'
+    #
+    def relativize(path)
+      unless path.absolute?
+        raise StandardError, "[Bug] Attempt to add relative path `#{path}` to the Pods project"
       end
+
+      result = path.relative_path_from(root)
+      unless root.to_s.split('/')[1] == path.to_s.split('/')[1]
+        result = Pathname.new('../') + result
+      end
+      result
+    end
+
+    # @return [String] a string representation suited for debugging.
+    #
+    def inspect
+      "#<#{self.class}> path:#{path}"
     end
 
-    # Shortcut access to the `Pods' PBXGroup.
+    #-------------------------------------------------------------------------#
+
+    public
+
+    # @!group Groups
+
+    # @return [PBXGroup] the group where the support files for the Pod
+    #         libraries should be added.
+    #
+    attr_reader :support_files_group
+
+    # Returns the `Pods` group, creating it if needed.
+    #
+    # @return [PBXGroup] the group.
+    #
     def pods
-      @pods ||= self['Pods'] || new_group('Pods')
+      @pods ||= new_group('Pods')
     end
 
-    # Shortcut access to the `Local Pods' PBXGroup.
+    # Returns the `Local Pods` group, creating it if needed. This group is used
+    # to contain locally sourced pods.
+    #
+    # @return [PBXGroup] the group.
+    #
     def local_pods
-      @local_pods ||= self['Local Pods'] || new_group('Local Pods')
+      @local_pods ||= new_group('Local Pods')
+    end
+
+    # Returns the `Local Pods` group, creating it if needed. This group is used
+    # to contain locally sourced pods.
+    #
+    # @return [PBXGroup] the group.
+    #
+    def resources
+      @resources ||= new_group('Resources')
     end
 
-    # Adds a group as child to the `Pods' group namespacing subspecs.
-    def add_spec_group(name, parent_group)
-      current_group = parent_group
+    # Adds a group as child to the `Pods` group namespacing subspecs.
+    #
+    # @param  [String] spec_name
+    #         The full name of the specification.
+    #
+    # @param  [PBXGroup] root_group
+    #         The group where to add the specification. Either `Pods` or `Local
+    #         Pods`.
+    #
+    # @return [PBXGroup] the group for the spec with the given name.
+    #
+    def add_spec_group(spec_name, root_group)
+      current_group = root_group
       group = nil
-      name.split('/').each do |name|
+      spec_name.split('/').each do |name|
         group = current_group[name] || current_group.new_group(name)
         current_group = group
       end
       group
     end
 
-    def add_pod_target(name, platform)
-      target = new_target(:static_library, name, platform.name)
-
-      settings = {}
-      if platform.requires_legacy_ios_archs?
-        settings['ARCHS'] = "armv6 armv7"
-      end
+    #-------------------------------------------------------------------------#
 
-      if platform.deployment_target
-        settings[platform.deployment_target_setting_name] = platform.deployment_target.to_s
-      end
+    public
 
-      target.build_settings('Debug').merge!(settings)
-      target.build_settings('Release').merge!(settings)
+    # @!group File references
 
-      @user_build_configurations.each do |name, type|
-        unless target.build_configurations.map(&:name).include?(name)
-          bc = new(XCBuildConfiguration)
-          bc.name = name
-          target.build_configurations << bc
-          # Copy the settings from either the Debug or the Release configuration.
-          bc.build_settings = target.build_settings(type.to_s.capitalize).merge(settings)
+    # Adds a file reference for each one of the given files in the specified
+    # group, namespaced by specification unless a file reference for the given
+    # path already exits.
+    #
+    # @note   With this set-up different subspecs might not reference the same
+    #         file (i.e. the first will win). Not sure thought if this is a
+    #         limitation or a feature.
+    #
+    # @param  [Array<Pathname,String>] paths
+    #         The files for which the file reference is needed.
+    #
+    # @param  [String] spec_name
+    #         The full name of the specification.
+    #
+    # @param  [PBXGroup] parent_group
+    #         The group where the file references should be added.
+    #
+    # @return [void]
+    #
+    def add_file_references(absolute_path, spec_name, parent_group)
+      group = add_spec_group(spec_name, parent_group)
+      absolute_path.each do |file|
+        existing = file_reference(file)
+        unless existing
+          file = Pathname.new(file)
+          ref = group.new_file(relativize(file))
+          @refs_by_absolute_path[file] = ref
         end
       end
+    end
 
-      target
+    # Returns the file reference for the given absolute file path.
+    #
+    # @param  [Pathname,String] absolute_path
+    #         The absolute path of the file whose reference is needed.
+    #
+    # @return [PBXFileReference] The file reference.
+    # @return [Nil] If no file reference could be found.
+    #
+    def file_reference(absolute_path)
+      absolute_path = Pathname.new(absolute_path)
+      refs_by_absolute_path[absolute_path]
     end
+
+    # Adds a file reference to the podfile.
+    #
+    # @param  [Pathname,String] podfile_path
+    #         the path of the podfile
+    #
+    # @return [PBXFileReference] the file reference.
+    #
+    def add_podfile(podfile_path)
+      podfile_path = Pathname.new(podfile_path)
+      podfile_ref  = new_file(relativize(podfile_path))
+      podfile_ref.xc_language_specification_identifier = 'xcode.lang.ruby'
+      podfile_ref
+    end
+
+    #-------------------------------------------------------------------------#
+
+    private
+
+    # @!group Private helpers
+
+    # @return [Hash{Pathname => PBXFileReference}] The file references grouped
+    #         by absolute path.
+    #
+    attr_reader :refs_by_absolute_path
+
+    #-------------------------------------------------------------------------#
+
   end
 end