cocoapods 0.16.4 → 0.17.0.rc1

data/lib/cocoapods/external_sources.rb

@@ -0,0 +1,325 @@
+module Pod
+
+  # Provides support for initializing the correct concrete class of an external
+  # source.
+  #
+  module ExternalSources
+
+    # @return [AbstractExternalSource] an initialized instance of the concrete
+    #         external source class associated with the option specified in the
+    #         hash.
+    #
+    def self.from_dependency(dependency, podfile_path)
+      name   = dependency.root_name
+      params = dependency.external_source
+
+      klass  = if params.key?(:git) then GitSource
+      elsif params.key?(:svn)       then SvnSource
+      elsif params.key?(:hg)        then MercurialSource
+      elsif params.key?(:podspec)   then PodspecSource
+      elsif params.key?(:local)     then LocalSource
+      end
+
+      if klass
+        klass.new(name, params, podfile_path)
+      else
+        msg = "Unknown external source parameters for `#{name}`: `#{params}`"
+        raise Informative, msg
+      end
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # Abstract class that defines the common behaviour of external sources.
+    #
+    class AbstractExternalSource
+
+      # @return [String] the name of the Pod described by this external source.
+      #
+      attr_reader :name
+
+      # @return [Hash{Symbol => String}] the hash representation of the
+      #         external source.
+      #
+      attr_reader :params
+
+      # @return [String] the path where the podfile is defined to resolve
+      #         relative paths.
+      #
+      attr_reader :podfile_path
+
+      # @param [String] name @see name
+      # @param [Hash] params @see params
+      # @param [String] podfile_path @see podfile_path
+      #
+      def initialize(name, params, podfile_path)
+        @name = name
+        @params = params
+        @podfile_path = podfile_path
+      end
+
+      # @return [Bool] whether an external source source is equal to another
+      #         according to the {#name} and to the {#params}.
+      #
+      def ==(other)
+        return false if other.nil?
+        name == other.name && params == other.params
+      end
+
+      #--------------------------------------#
+
+      public
+
+      # @!group Fetching
+
+      # Fetches the external source from the remote according to the params.
+      #
+      # @param  [Sandbox] sandbox
+      #         the sandbox where the specification should be stored.
+      #
+      # @return [void]
+      #
+      def fetch(sandbox)
+        raise "Abstract method"
+      end
+
+      #--------------------------------------#
+
+      public
+
+      # @!group Subclasses hooks
+
+      # Fetches the external source from the remote according to the params.
+      #
+      # @param  [Sandbox] sandbox
+      #         the sandbox where the specification should be stored.
+      #
+      # @return [void]
+      #
+      def fetch(sandbox)
+        raise "Abstract method"
+      end
+
+      # @return [String] a string representation of the source suitable for UI.
+      #
+      def description
+        raise "Abstract method"
+      end
+
+      #--------------------------------------#
+
+      private
+
+      # @! Subclasses helpers
+
+      # Pre-downloads a Pod passing the options to the downloader and informing
+      # the sandbox.
+      #
+      # @param  [Sandbox] sandbox
+      #         The sandbox where the Pod should be downloaded.
+      #
+      # @note   To prevent a double download of the repository the pod is
+      #         marked as pre-downloaded indicating to the installer that only
+      #         clean operations are needed.
+      #
+      # @return [void]
+      #
+      def pre_download(sandbox)
+        UI.titled_section("Pre-downloading: `#{name}` #{description}", { :verbose_prefix => "-> " }) do
+          target = sandbox.root + name
+          target.rmtree if target.exist?
+          downloader = Downloader.for_target(target, params)
+          downloader.download
+          store_podspec(sandbox, target + "#{name}.podspec")
+          sandbox.store_pre_downloaded_pod(name)
+          if downloader.options_specific?
+            source = params
+          else
+            source = downloader.checkout_options
+          end
+          sandbox.store_checkout_source(name, source)
+        end
+      end
+
+      # Stores the podspec in the sandbox and marks it as from an external
+      # source.
+      #
+      # @param  [Sandbox] sandbox
+      #         The sandbox where the specification should be stored.
+      #
+      # @param  [Pathname, String] spec
+      #         The path of the specification or its contents.
+      #
+      # @note   All the concrete implementations of #{fetch} should invoke this
+      #         method.
+      #
+      # @note   The sandbox ensures that the podspec exists and that the names
+      #         match.
+      #
+      # @return [void]
+      #
+      def store_podspec(sandbox, spec)
+        sandbox.store_podspec(name, spec, true)
+      end
+
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # Provides support for fetching a specification file from a Git remote.
+    #
+    # Supports all the options of the downloader (is similar to the git key of
+    # `source` attribute of a specification).
+    #
+    # @note The podspec must be in the root of the repository and should have a
+    #       name matching the one of the dependency.
+    #
+    class GitSource < AbstractExternalSource
+
+      # @see AbstractExternalSource#fetch
+      #
+      def fetch(sandbox)
+        pre_download(sandbox)
+      end
+
+      # @see AbstractExternalSource#description
+      #
+      def description
+        "from `#{params[:git]}`".tap do |description|
+          description << ", commit `#{params[:commit]}`" if params[:commit]
+          description << ", branch `#{params[:branch]}`" if params[:branch]
+          description << ", tag `#{params[:tag]}`" if params[:tag]
+        end
+      end
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # Provides support for fetching a specification file from a SVN source
+    # remote.
+    #
+    # Supports all the options of the downloader (is similar to the git key of
+    # `source` attribute of a specification).
+    #
+    # @note The podspec must be in the root of the repository and should have a
+    #       name matching the one of the dependency.
+    #
+    class SvnSource < AbstractExternalSource
+
+      # @see AbstractExternalSource#fetch
+      #
+      def fetch(sandbox)
+        pre_download(sandbox)
+      end
+
+      # @see AbstractExternalSource#description
+      #
+      def description
+        "from `#{params[:svn]}`".tap do |description|
+          description << ", folder `#{params[:folder]}`" if params[:folder]
+          description << ", tag `#{params[:tag]}`" if params[:tag]
+          description << ", revision `#{params[:revision]}`" if params[:revision]
+        end
+      end
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # Provides support for fetching a specification file from a Mercurial
+    # source remote.
+    #
+    # Supports all the options of the downloader (is similar to the git key of
+    # `source` attribute of a specification).
+    #
+    # @note The podspec must be in the root of the repository and should have a
+    #       name matching the one of the dependency.
+    #
+    class MercurialSource < AbstractExternalSource
+
+      # @see AbstractExternalSource#fetch
+      #
+      def fetch(sandbox)
+        pre_download(sandbox)
+      end
+
+      # @see AbstractExternalSource#description
+      #
+      def description
+        "from `#{params[:hg]}`".tap do |description|
+          description << ", revision `#{params[:revision]}`" if params[:revision]
+        end
+      end
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # Provides support for fetching a specification file from an URL. Can be
+    # http, file, etc.
+    #
+    class PodspecSource < AbstractExternalSource
+
+      # @see AbstractExternalSource#fetch
+      #
+      def fetch(sandbox)
+        UI.titled_section("Fetching podspec for `#{name}` #{description}", { :verbose_prefix => "-> " }) do
+          path = params[:podspec]
+          path = Pathname.new(path).expand_path if path.to_s.start_with?("~")
+          require 'open-uri'
+          open(path) { |io| store_podspec(sandbox, io.read) }
+        end
+      end
+
+      # @see AbstractExternalSource#description
+      #
+      def description
+        "from `#{params[:podspec]}`"
+      end
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # Provides support for fetching a specification file from a path local to
+    # the machine running the installation.
+    #
+    # Works with the {LocalPod::LocalSourcedPod} class.
+    #
+    class LocalSource < AbstractExternalSource
+
+      # @see  AbstractExternalSource#fetch
+      #
+      def fetch(sandbox)
+        UI.titled_section("Fetching podspec for `#{name}` #{description}", { :verbose_prefix => "-> " }) do
+          podspec = pod_spec_path
+          store_podspec(sandbox, podspec)
+          sandbox.store_local_path(name, podspec.dirname)
+        end
+      end
+
+      # @see  AbstractExternalSource#description
+      #
+      def description
+        "from `#{params[:local]}`"
+      end
+
+      #--------------------------------------#
+
+      private
+
+      # @!group Helpers
+
+      # @return [Pathname] the path of the podspec.
+      #
+      def pod_spec_path
+        declared_path = params[:local].to_s
+        path_with_ext = File.extname(declared_path) == '.podspec' ? declared_path : "#{declared_path}/#{name}.podspec"
+        path_without_tilde = path_with_ext.gsub('~', ENV['HOME'])
+        absolute_path = Pathname(podfile_path).dirname + path_without_tilde
+
+        unless absolute_path.exist?
+          raise Informative, "No podspec found for `#{name}` in `#{params[:local]}`"
+        end
+        absolute_path
+      end
+    end
+  end
+end

data/lib/cocoapods/file_list.rb

@@ -6,7 +6,9 @@ end
 
 # This makes Rake::FileList usable with the Specification attributes
 # source_files, public_header_files, preserve_paths, and resources.
-
+#
+# @todo This needs to be deprecated as we no have the PathList List
+#
 module Rake
   class FileList
     def prepend_patterns(pathname)
@@ -20,6 +22,11 @@ module Rake
     def glob
       to_a.map { |path| Pathname.new(path) }
     end
+
+    def inspect
+      "<##{self.class} pending_add=#{@pending_add}>"
+    end
+    alias :to_s :inspect
   end
 end
 

data/lib/cocoapods/gem_version.rb

@@ -0,0 +1,7 @@
+module Pod
+
+  # The version of the cocoapods command line tool.
+  #
+  VERSION = '0.17.0.rc1' unless defined? Pod::VERSION
+end
+

data/lib/cocoapods/generator/acknowledgements.rb

@@ -3,35 +3,99 @@ module Pod
 
     class Acknowledgements
 
+      # @return [Array<Class>] The classes of the acknowledgements generator
+      #         subclasses.
+      #
       def self.generators
         [Plist, Markdown]
       end
 
-      def initialize(target_definition, pods)
-        @target_definition, @pods = target_definition, pods
-      end
+      # @return [Array<Sandbox::FileAccessor>] the list of the file accessors
+      #         for the specs of the target that needs to generate the
+      #         acknowledgements.
+      #
+      attr_reader :file_accessors
 
-      def save_as(path)
-        Acknowledgements.generators.each do |generator|
-          generator.new(@target_definition, @pods).save_as(path)
-        end
+      # @param [Array<Sandbox::FileAccessor>] @see file_accessors.
+      #
+      def initialize(file_accessors)
+        @file_accessors = file_accessors
       end
 
+      #-----------------------------------------------------------------------#
+
+      # !@group Configuration
+
+      # @return [String] The title of the acknowledgements file.
+      #
       def header_title
         "Acknowledgements"
       end
 
+      # @return [String] A text to present before listing the acknowledgements.
+      #
       def header_text
         "This application makes use of the following third party libraries:"
       end
 
+      # @return [String] The title of the foot notes.
+      #
       def footnote_title
         ""
       end
 
+      # @return [String] the foot notes.
+      #
       def footnote_text
         "Generated by CocoaPods - http://cocoapods.org"
       end
+
+      #-----------------------------------------------------------------------#
+
+      private
+
+      # !@group Private methods
+
+      # @return [Array<Specification>] The root specifications for which the
+      #         acknowledgements should be generated.
+      #
+      def specs
+        file_accessors.map{ |accessor| accessor.spec.root }.uniq
+      end
+
+      # Returns the text of the license for the given spec.
+      #
+      # @param  [Specification] spec
+      #         the specification for which license is needed.
+      #
+      # @return [String] The text of the license.
+      # @return [Nil] If not license text could be found.
+      #
+      def license_text(spec)
+        if spec.license
+          if text = spec.license[:text]
+            text
+          elsif license_file = file_accessor(spec).license
+            text = IO.read(license_file)
+          end
+        end
+      end
+
+      protected
+
+      # Returns the file accessor for the given spec.
+      #
+      # @param  [Specification] spec
+      #         the specification for which the file accessor is needed.
+      #
+      # @return [Sandbox::FileAccessor] The file accessor.
+      #
+      def file_accessor(spec)
+        file_accessors.find { |accessor| accessor.spec.root == spec }
+      end
+
+      #-----------------------------------------------------------------------#
+
     end
   end
 end