cocoapods 0.5.1 → 0.6.0.rc1

data/lib/cocoapods/downloader/http.rb

@@ -0,0 +1,73 @@
+require 'open-uri'
+require 'tempfile'
+require 'zlib'
+require 'yaml'
+
+module Pod
+  class Downloader
+    class Http < Downloader
+      class UnsupportedFileTypeError < StandardError; end
+
+      executable :curl
+      executable :unzip
+      executable :tar
+
+      attr_accessor :filename, :download_path
+      def download
+        @filename        = filename_with_type type
+        @download_path   = target_path + @filename
+
+        download_file @download_path
+        extract_with_type @download_path, type
+      end
+
+      def type
+        options[:type] || type_with_url(url)
+      end
+
+      private
+      def type_with_url(url)
+        if url =~ /.zip$/
+          :zip
+        elsif url =~ /.tgz$/
+          :tgz
+        elsif url =~ /.tar$/
+          :tar
+        else
+          nil
+        end
+      end
+
+      def filename_with_type(type=:zip)
+        case type
+        when :zip
+          "file.zip"
+        when :tgz
+          "file.tgz"
+        when :tar
+          "file.tar"
+        else
+          raise UnsupportedFileTypeError.new "Unsupported file type: #{type}"
+        end
+      end
+
+      def download_file(full_filename)
+        curl "-L -o '#{full_filename}' '#{url}'"
+      end
+
+      def extract_with_type(full_filename, type=:zip)
+        case type
+        when :zip
+          unzip "'#{full_filename}' -d #{target_path}"
+        when :tgz
+          tar "xfz '#{full_filename}' -C #{target_path}"
+        when :tar
+          tar "xf '#{full_filename}' -C #{target_path}"
+        else
+          raise UnsupportedFileTypeError.new "Unsupported file type: #{type}"
+        end
+      end
+
+    end
+  end
+end

data/lib/cocoapods/downloader/mercurial.rb

@@ -4,8 +4,7 @@ module Pod
       executable :hg
 
       def download
-        @pod_root.dirname.mkpath
-        if @options[:revision]
+        if options[:revision]
           download_revision
         else
           download_head
@@ -13,16 +12,11 @@ module Pod
       end
 
       def download_head
-        hg "clone '#{@url}' '#{@pod_root}'"
+        hg "clone '#{url}' '#{target_path}'"
       end
 
       def download_revision
-        hg "clone '#{@url}' --rev '#{@options[:revision]}' '#{@pod_root}'"
-      end
-
-      def clean(clean_paths = [])
-        super
-        (@pod_root + '.hg').rmtree
+        hg "clone '#{url}' --rev '#{options[:revision]}' '#{target_path}'"
       end
     end
   end

data/lib/cocoapods/downloader/subversion.rb

@@ -4,8 +4,7 @@ module Pod
       executable :svn
 
       def download
-        @pod_root.dirname.mkpath
-        if @options[:revision]
+        if options[:revision]
           download_revision
         else
           download_head
@@ -13,16 +12,11 @@ module Pod
       end
 
       def download_head
-        svn "checkout '#{@url}' '#{@pod_root}'"
+        svn "checkout '#{url}' '#{target_path}'"
       end
 
       def download_revision
-        svn "checkout '#{@url}' -r '#{@options[:revision]}' '#{@pod_root}'"
-      end
-
-      def clean(clean_paths = [])
-        super
-        @pod_root.glob('**/.svn').each(&:rmtree)
+        svn "checkout '#{url}' -r '#{options[:revision]}' '#{target_path}'"
       end
     end
   end

data/lib/cocoapods/executable.rb

@@ -1,17 +1,40 @@
+require 'open4'
+
 module Pod
   module Executable
+    class Indenter < ::Array
+      attr_accessor :indent
+      attr_accessor :io
+
+      def initialize(io = nil, indent = '   ')
+        @io = io
+        @indent = indent
+      end
+
+      def <<(value)
+        super
+      ensure
+        @io << "#{ indent }#{ value }" if @io
+      end
+    end
+
     def executable(name)
       bin = `which #{name}`.strip
       define_method(name) do |command|
         if bin.empty?
           raise Informative, "Unable to locate the executable `#{name}'"
         end
+        full_command = "#{bin} #{command}"
         if Config.instance.verbose?
-          puts "#{bin} #{command}"
-          `#{bin} #{command} 1>&2`
+          puts "   $ #{full_command}"
+          stdout, stderr = Indenter.new(STDOUT), Indenter.new(STDERR)
         else
-          `#{bin} #{command} 2> /dev/null`
+          stdout, stderr = Indenter.new, Indenter.new
         end
+        status = Open4.spawn(full_command, :stdout => stdout, :stderr => stderr, :status => true)
+        # TODO not sure that we should be silent in case of a failure.
+        puts (Config.instance.verbose? ? '   ' : '') << "[!] Failed: #{full_command}".red unless status.success? || Config.instance.silent?
+        stdout.join("\n") + stderr.join("\n") # TODO will this suffice?
       end
       private name
     end

data/lib/cocoapods/generator/acknowledgements.rb

@@ -0,0 +1,37 @@
+module Pod
+  module Generator
+
+    class Acknowledgements
+
+      def self.generators
+        [Plist, Markdown]
+      end
+
+      def initialize(target_definition, pods)
+        @target_definition, @pods = target_definition, pods
+      end
+
+      def save_as(path)
+        Acknowledgements.generators.each do |generator|
+          generator.new(@target_definition, @pods).save_as(path)
+        end
+      end
+
+      def header_title
+        "Acknowledgements"
+      end
+
+      def header_text
+        "This application makes use of the following third party libraries:"
+      end
+
+      def footnote_title
+        ""
+      end
+
+      def footnote_text
+        "Generated by CocoaPods - http://cocoapods.org"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Pod
+  module Generator
+
+    class Markdown < Acknowledgements
+
+      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
+      end
+
+      def title_from_string(string, level)
+        if !string.empty?
+          "#" * level << " #{string}"
+        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"
+        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))
+            licenses_string += license
+          end
+        end
+        licenses_string += "#{title_from_string(footnote_title, 2)}#{footnote_text}\n"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+module Pod
+  module Generator
+
+    class Plist < Acknowledgements
+      require "xcodeproj/xcodeproj_ext"
+
+      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
+
+      def plist
+        {
+          :Title => plist_title,
+          :StringsTable => plist_title,
+          :PreferenceSpecifiers => licenses
+        }
+      end
+
+      def plist_title
+        "Acknowledgements"
+      end
+
+      def licenses
+        licences_array = [header_hash]
+        @pods.each do |pod|
+          if (hash = hash_for_pod(pod))
+            licences_array << hash
+          end
+        end
+        licences_array << footnote_hash
+      end
+
+      def hash_for_pod(pod)
+        if (license = pod.license_text)
+          {
+            :Type => "PSGroupSpecifier",
+            :Title => pod.name,
+            :FooterText => license
+          }
+        end
+      end
+
+      def header_hash
+        {
+          :Type => "PSGroupSpecifier",
+          :Title => header_title,
+          :FooterText => header_text
+        }
+      end
+
+      def footnote_hash
+        {
+          :Type => "PSGroupSpecifier",
+          :Title => footnote_title,
+          :FooterText => footnote_text
+        }
+      end
+    end
+  end
+end

data/lib/cocoapods/generator/copy_resources_script.rb

@@ -7,13 +7,17 @@ module Pod
 install_resource()
 {
   case $1 in
+    *\.storyboard)
+      echo "ibtool --errors --warnings --notices --output-format human-readable-text --compile ${CONFIGURATION_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/`basename $1 .storyboard`.storyboardc ${PODS_ROOT}/$1 --sdk ${SDKROOT}"
+      ibtool --errors --warnings --notices --output-format human-readable-text --compile "${CONFIGURATION_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/`basename $1 .storyboard`.storyboardc" "${PODS_ROOT}/$1" --sdk "${SDKROOT}"
+      ;;
     *\.xib)
-      echo "ibtool --errors --warnings --notices --output-format human-readable-text --compile ${CONFIGURATION_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/`basename $1 .xib`.nib ${SRCROOT}/Pods/$1 --sdk ${SDKROOT}"
-      ibtool --errors --warnings --notices --output-format human-readable-text --compile ${CONFIGURATION_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/`basename $1 .xib`.nib ${SRCROOT}/Pods/$1 --sdk ${SDKROOT}
+      echo "ibtool --errors --warnings --notices --output-format human-readable-text --compile ${CONFIGURATION_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/`basename $1 .xib`.nib ${PODS_ROOT}/$1 --sdk ${SDKROOT}"
+      ibtool --errors --warnings --notices --output-format human-readable-text --compile "${CONFIGURATION_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/`basename $1 .xib`.nib" "${PODS_ROOT}/$1" --sdk "${SDKROOT}"
       ;;
     *)
-      echo "cp -R ${SRCROOT}/Pods/$1 ${CONFIGURATION_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}"
-      cp -R "${SRCROOT}/Pods/$1" "${CONFIGURATION_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}"
+      echo "cp -R ${PODS_ROOT}/$1 ${CONFIGURATION_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}"
+      cp -R "${PODS_ROOT}/$1" "${CONFIGURATION_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}"
       ;;
   esac
 }

data/lib/cocoapods/generator/documentation.rb

@@ -0,0 +1,99 @@
+require 'escape'
+
+module Pod
+  module Generator
+
+    class Documentation
+      include Config::Mixin
+      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 || {}
+      end
+
+      def name
+        @specification.name + ' ' + @specification.version.to_s
+      end
+
+      def company
+        if @specification.authors
+          @specification.authors.keys.sort.join(', ')
+        else
+          'no-company'
+        end
+      end
+
+      def copyright
+        company
+      end
+
+      def description
+        @specification.description || 'Generated by CocoaPods.'
+      end
+
+      def docs_id
+        'org.cocoapods'
+      end
+
+      def files
+        @pod.all_specs_public_header_files.map{ |f| f.relative_path_from(@pod.root).to_s }
+      end
+
+      def index_file
+        @pod.readme_file.relative_path_from(@pod.root).to_s if @pod.readme_file
+      end
+
+      def spec_appledoc_options
+        @options[:appledoc] || []
+      end
+
+      def appledoc_options
+        options = [
+          '--project-name', name,
+          '--docset-desc', description,
+          '--project-company', company,
+          '--docset-copyright', copyright,
+          '--company-id', docs_id,
+          '--ignore', '.m',
+          '--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
+        ]
+        options += ['--index-desc', index_file] if index_file
+        options += spec_appledoc_options
+      end
+
+      def already_installed?
+        Pathname.new(File.expand_path("~/Library/Developer/Shared/Documentation/DocSets/org.cocoapods.#{name.gsub(/ /,'-')}.docset")).exist?
+      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
+
+        if $?.exitstatus != 0
+          puts "[!] Appledoc encountered an error (exitstatus: #{$?.exitstatus}), an update might be available to solve the issue." unless config.silent?
+        end
+
+      rescue Informative
+        puts "[!] Skipping documentation generation because appledoc can't be found." if config.verbose?
+      end
+    end
+  end
+end

data/lib/cocoapods/generator/dummy_source.rb

@@ -0,0 +1,14 @@
+module Pod
+  module Generator
+    class DummySource
+      def save_as(pathname)
+        pathname.open('w') do |source|
+          source.puts "@interface PodsDummy : NSObject"
+          source.puts "@end"
+          source.puts "@implementation PodsDummy"
+          source.puts "@end"
+        end
+      end
+    end
+  end
+end