cocoapods 0.16.4 → 0.17.0.rc1

data/lib/cocoapods/generator/acknowledgements/markdown.rb

@@ -3,10 +3,11 @@ module Pod
 
     class Markdown < Acknowledgements
 
+      def self.path_from_basepath(path)
+        Pathname.new(path.dirname + "#{path.basename.to_s}.markdown")
+      end
+
       def save_as(path)
-        if (path.extname != ".markdown")
-          path = Pathname.new(path.dirname + "#{path.basename.to_s}.markdown")
-        end
         file = File.new(path, "w")
         file.write(licenses)
         file.close
@@ -18,17 +19,17 @@ module Pod
         end
       end
 
-      def string_for_pod(pod)
-        if (license_text = pod.license_text)
-          "\n" << title_from_string(pod.name, 2) << "\n\n" << license_text << "\n"
+      def string_for_spec(spec)
+        if (license_text = license_text(spec))
+          "\n" << title_from_string(spec.name, 2) << "\n\n" << license_text << "\n"
         end
       end
 
       def licenses
         licenses_string = "#{title_from_string(header_title, 1)}\n#{header_text}\n"
-        @pods.each do |pod|
-          if (license = string_for_pod(pod))
-            license = license.force_encoding("UTF-8") if license.respond_to?(:force_encoding) 
+        specs.each do |spec|
+          if (license = string_for_spec(spec))
+            license = license.force_encoding("UTF-8") if license.respond_to?(:force_encoding)
             licenses_string += license
           end
         end

data/lib/cocoapods/generator/acknowledgements/plist.rb

@@ -4,10 +4,11 @@ module Pod
     class Plist < Acknowledgements
       require "xcodeproj/xcodeproj_ext"
 
+      def self.path_from_basepath(path)
+        Pathname.new(path.dirname + "#{path.basename.to_s}.plist")
+      end
+
       def save_as(path)
-        if (path.extname != ".plist")
-          path = Pathname.new(path.dirname + "#{path.basename.to_s}.plist")
-        end
         Xcodeproj.write_plist(plist, path)
       end
 
@@ -25,19 +26,19 @@ module Pod
 
       def licenses
         licences_array = [header_hash]
-        @pods.each do |pod|
-          if (hash = hash_for_pod(pod))
+        specs.each do |spec|
+          if (hash = hash_for_spec(spec))
             licences_array << hash
           end
         end
         licences_array << footnote_hash
       end
 
-      def hash_for_pod(pod)
-        if (license = pod.license_text)
+      def hash_for_spec(spec)
+        if (license = license_text(spec))
           {
             :Type => "PSGroupSpecifier",
-            :Title => pod.name,
+            :Title => spec.name,
             :FooterText => license
           }
         end

data/lib/cocoapods/generator/copy_resources_script.rb

@@ -34,7 +34,7 @@ EOS
       attr_reader :resources
 
       # A list of files relative to the project pods root.
-      def initialize(resources)
+      def initialize(resources = [])
         @resources = resources
       end
 
@@ -45,7 +45,7 @@ EOS
             script.puts "install_resource '#{resource}'"
           end
         end
-        # TODO use File api
+        # @todo use File api
         system("chmod +x '#{pathname}'")
       end
     end

data/lib/cocoapods/generator/documentation.rb

@@ -4,56 +4,156 @@ require 'active_support/core_ext/array/conversions'
 module Pod
   module Generator
 
+    # Generates the documentation for a Pod with the appledoc tool.
+    #
     class Documentation
-      include Config::Mixin
-      extend Executable
 
+      extend Executable
       executable :appledoc
-      attr_reader :pod, :specification, :target_path, :options
 
-      def initialize(pod)
-        @pod = pod
-        @specification = pod.top_specification
-        @target_path = pod.sandbox.root + 'Documentation' + pod.name
-        @options = @specification.documentation || {}
+      attr_reader :sandbox
+      attr_reader :specification
+      attr_reader :path_list
+
+      def initialize(sandbox, specification, path_list)
+        @sandbox = sandbox
+        @specification = specification.root
+        @path_list = path_list
+      end
+
+      DOC_SETS_PATH = "~/Library/Developer/Shared/Documentation/DocSets"
+
+      # @return [Bool] Whether the documentation for the current Pod is already
+      #         installed in the system.
+      #
+      def already_installed?
+        index = spec_appledoc_options.index('--company-id')
+        company_id = index ? spec_appledoc_options[index + 1] : docs_id
+        docset_path = DOC_SETS_PATH + "/#{company_id}.#{name.gsub(/ /,'-')}.docset"
+        Pathname.new(File.expand_path(docset_path)).exist?
+      end
+
+      # Generates and optionally installs the documentation for the current
+      # Pod.
+      #
+      # @param  [Bool] install_docset
+      #         Whether the documentation should also be installed in Xcode.
+      #
+      # @note   As the documentation is once per Pod to speed up the
+      #         installation process it is generate for all the specs
+      #         (including those not currently used). For this reason it is
+      #         important that the documentation is generated before cleaning a
+      #         Pod installation.
+      #
+      # @todo   Passing the files explicitly clutters output and chokes on very
+      #         long list (AWSiOSSDK).  It is possible to just pass the dir of
+      #         the pod, however this would include other files like demo
+      #         projects.
+      #
+      # @return [void]
+      #
+      def generate(install_docset)
+        if `which appledoc`.strip.empty?
+          UI.warn "[!] Skipping documentation generation because appledoc can't be found.",
+            actions = [], verbose_only = true
+          return
+        end
+
+        target_path.mkpath
+        Dir.chdir(pod_root) do
+          appledoc apple_doc_command_line_arguments(install_docset)
+        end
+
+        if $?.exitstatus != 0
+          UI.warn "[!] Appledoc encountered an error (exitstatus: #{$?.exitstatus}), an update might be available to solve the issue."
+        end
+
       end
 
+      #-----------------------------------------------------------------------#
+
+      public
+
+      # !@group Docset information.
+
+      # @return [String] The name of the docset
+      #
       def name
-        @specification.name + ' ' + @specification.version.to_s
+        specification.name + ' ' + specification.version.to_s
       end
 
+      # @return [String] The company of the docset.
+      #
+      # @todo   Set to CocoaPods?
+      #
       def company
-        if @specification.authors
-          @specification.authors.keys.sort.to_sentence
+        if specification.authors
+          specification.authors.keys.sort.to_sentence
         else
           'no-company'
         end
       end
 
+      # @return [String] The copyright of the docset.
+      #
       def copyright
         company
       end
 
+      # @return [String] The description of the docset.
+      #
       def description
-        @specification.description || 'Generated by CocoaPods.'
+        specification.summary || specification.description || 'Generated by CocoaPods.'
       end
 
+      # @return [String] The id of the docset.
+      #
       def docs_id
         'org.cocoapods'
       end
 
-      def files
-        @pod.documentation_headers.map{ |f| f.relative_path_from(@pod.root).to_s }
+      #-----------------------------------------------------------------------#
+
+      public
+
+      # !@group Paths.
+
+      # @return [Array<String>] the list of the headers to process
+      #         with the appledoc tool.
+      #
+      def public_headers
+        absolute_paths = file_accessors.map(&:public_headers).flatten.uniq
+        absolute_paths.map { |f| f.relative_path_from(pod_root).to_s }
       end
 
+      # @return [String] the path of the file to use ad index of the
+      #         documentation relative to the root of the Pod.
+      #
       def index_file
-        @pod.readme_file.relative_path_from(@pod.root).to_s if @pod.readme_file
+        readme_file = file_accessors.first.readme
+        readme_file.relative_path_from(pod_root).to_s if readme_file
       end
 
+      #-----------------------------------------------------------------------#
+
+      public
+
+      # !@group Appledoc options.
+
+      # @return [Array<String>] The list of the appledoc options followed by
+      #         their value as defined in the specification.
+      #
       def spec_appledoc_options
-        @options[:appledoc] || []
+        return [] unless specification.documentation
+        specification.documentation[:appledoc]
       end
 
+      # @return [Array<String>] The list of the appledoc options followed by
+      #         their value.
+      #
+      # @note The appledoc tool terminates with an exits status of 1 if a
+      #       warning was logged (see `--exit-threshold` option).
+      #
       def appledoc_options
         options = [
           '--project-name', name,
@@ -65,38 +165,54 @@ module Pod
           '--keep-undocumented-objects',
           '--keep-undocumented-members',
           '--keep-intermediate-files',
-          '--exit-threshold', '2' # appledoc terminates with an exits status of 1 if a warning was logged
+          '--exit-threshold', '2'
         ]
         options += ['--index-desc', index_file] if index_file
         options += spec_appledoc_options
       end
 
-      def already_installed?
-        index = spec_appledoc_options.index('--company-id')
-        company_id = index ? spec_appledoc_options[index + 1] : docs_id
-        Pathname.new(File.expand_path("~/Library/Developer/Shared/Documentation/DocSets/#{company_id}.#{name.gsub(/ /,'-')}.docset")).exist?
+      # @return [String] the arguments to pass to the appledoc command line
+      #         tool, properly escaped.
+      #
+      # @param  [Bool] install_docset
+      #         Whether the documentation should also be installed in Xcode.
+      #
+      def apple_doc_command_line_arguments(install_docset)
+        arguments = appledoc_options
+        arguments += ['--output', target_path.to_s]
+        arguments += install_docset ? ['--create-docset'] : ['--no-create-docset']
+        arguments += public_headers
+        Escape.shell_command(arguments)
       end
 
-      def generate(install = false)
-        options = appledoc_options
-        options += ['--output', @target_path.to_s]
-        options += install ? ['--create-docset'] : ['--no-create-docset']
-        # TODO: passing the files explicitly clutters output and chokes on very long list (AWSiOSSDK Spec).
-        # It is possible to just pass the dir of the pod, however this would include other files like demo projects.
-        options += files
+      #-----------------------------------------------------------------------#
 
-        @target_path.mkpath
-        @pod.chdir do
-          appledoc Escape.shell_command(options)
-        end
+      private
 
-        if $?.exitstatus != 0
-          puts "[!] Appledoc encountered an error (exitstatus: #{$?.exitstatus}), an update might be available to solve the issue." unless config.silent?
-        end
+      # !@group Private Helpers
+
+      def target_path
+        sandbox.root + 'Documentation' + specification.name
+      end
 
-      rescue Informative
-        puts "[!] Skipping documentation generation because appledoc can't be found." if config.verbose?
+      def pod_root
+        path_list.root
       end
+
+      def file_accessors
+        return @file_accessors if @file_accessors
+
+        @file_accessors = []
+        all_specs = [specification, *specification.subspecs]
+        all_specs.each do |spec|
+          spec.available_platforms.each do |platform|
+            accessor = Sandbox::FileAccessor.new(path_list, spec.consumer(platform))
+            @file_accessors << accessor
+          end
+        end
+        @file_accessors
+      end
+
     end
   end
 end

data/lib/cocoapods/generator/prefix_header.rb

@@ -0,0 +1,82 @@
+module Pod
+  module Generator
+
+    # Generates a prefix header file for a Pods library. The prefix header is
+    # generated according to the platform of the target and the pods.
+    #
+    # According to the platform the prefix header imports `UIKit/UIKit.h` or
+    # `Cocoa/Cocoa.h`.
+    #
+    class PrefixHeader
+
+      # @return [Platform] the platform for which the prefix header will be
+      #         generated.
+      #
+      attr_reader :file_accessors
+      attr_reader :platform
+
+      # @return [Array<LocalPod>] the LocalPod for the target for which the
+      #         prefix header needs to be generated.
+      #
+      # attr_reader :consumers
+
+      # @return [Array<String>] any header to import (with quotes).
+      #
+      attr_reader :imports
+
+      # @param  [Platform] platform     @see platform
+      # @param  [Array<LocalPod>] consumers  @see consumers
+      #
+      def initialize(file_accessors, platform)
+        @file_accessors = file_accessors
+        @platform = platform
+        @imports = []
+      end
+
+      # Generates the contents of the prefix header according to the platform
+      # and the pods.
+      #
+      # @note   If the platform is iOS an import call to `UIKit/UIKit.h` is
+      #         added to the top of the prefix header. For OS X `Cocoa/Cocoa.h`
+      #         is imported.
+      #
+      # @return [String]
+      #
+      # @todo   Subspecs can specify prefix header information too.
+      #
+      def generate
+        result =  "#ifdef __OBJC__\n"
+        result << "#import #{platform == :ios ? '<UIKit/UIKit.h>' : '<Cocoa/Cocoa.h>'}\n"
+        result << "#endif\n"
+
+        imports.each do |import|
+          result << %|\n#import "#{import}"|
+        end
+
+        file_accessors.each do |file_accessor|
+          result << "\n"
+          if prefix_header_contents = file_accessor.spec_consumer.prefix_header_contents
+            result << prefix_header_contents
+            result << "\n"
+          end
+          if prefix_header = file_accessor.prefix_header
+            result << Pathname(prefix_header).read
+          end
+        end
+        result
+      end
+
+      # Generates and saves the prefix header 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') { |header| header.write(generate) }
+      end
+
+    end
+  end
+end

data/lib/cocoapods/generator/target_header.rb

@@ -0,0 +1,58 @@
+module Pod
+  module Generator
+
+    # Generates a header which allows to inspect at compile time the installed
+    # pods and the installed specifications of a pod.
+    #
+    # Example output:
+    #
+    #     #define __COCOA_PODS
+    #
+    #     #define __POD_AFIncrementaStore
+    #     #define __POD_AFNetworking
+    #     #define __POD_libextobjc_EXTConcreteProtocol
+    #     #define __POD_libextobjc_EXTKeyPathCoding
+    #     #define __POD_libextobjc_EXTScope
+    #
+    # Example usage:
+    #
+    #     #ifdef __COCOA_PODS
+    #       #ifdef __POD__AFNetworking
+    #         #import "MYLib+AFNetworking.h"
+    #       #endif
+    #     #else
+    #       // Non CocoaPods code
+    #     #endif
+    #
+    class TargetHeader
+
+      # @return [Array<LocalPod>] the specifications installed for the target.
+      #
+      attr_reader :specs
+
+      # @param  [Array<LocalPod>] pods @see pods
+      #
+      def initialize(specs)
+        @specs = specs
+      end
+
+      # Generates and saves the file.
+      #
+      # @param  [Pathname] pathname
+      #         The path where to save the generated file.
+      #
+      # @return [void]
+      #
+      def save_as(pathname)
+        pathname.open('w') do |source|
+          source.puts "// WARNING: This feature of CocoaPods is present for discussion purposes and might be discontinued or changed in future"
+          source.puts "#define __COCOA_PODS"
+          source.puts
+          specs.each do |specs|
+            source.puts "#define __POD_#{specs.name.gsub(/[^\w]/,'_')}"
+          end
+        end
+      end
+    end
+  end
+end