[#149] removed atom support force appledoc

lib/cocoapods/command/install.rb

@@ -20,8 +20,8 @@ module Pod
       def self.options
         "    --no-clean  Leave SCM dirs like `.git' and `.svn' in tact after downloading\n" +
         "    --no-update Skip running `pod repo update` before install\n" +
-        "    --doc-force Generate documentation for all pods with appledoc\n" +
         "    --no-doc    Skip documentation generation\n" +
+        "    --no-doc-force Generate documentation only for the pods that support it\n" +
         "    --no-doc-install Skip documentation installation to Xcode\n" +
         super
       end
@@ -30,7 +30,7 @@ module Pod
         config.clean = !argv.option('--no-clean')
         config.doc = !argv.option('--no-doc')
         config.doc_install = !argv.option('--no-doc-install')
-        config.doc_force = argv.option('--doc-force')
+        config.doc_force = !argv.option('--no-doc-force')
         @update_repo = !argv.option('--no-update')
         @projpath = argv.shift_argument
         super unless argv.empty?

lib/cocoapods/command/spec.rb

@@ -54,13 +54,11 @@ module Pod
 
             # If available specify the documentation sources.
             # :html       The online link for the documentation.
-            # :atom       The atom link of the Xcode 4 compatible documentation set.
             # :appledoc   If the pod uses appledoc specify the options. The command
             #             will be run on the files specified in s.source_file.
             #
             s.documentation = {
             #  :html => 'http://EXAMPLE/#{@name}/documentation',
-            #  :atom => 'http://EXAMPLE/#{@name}/com.company.#{@name}.atom',
             #  :appledoc => ['--project-name', '#{@name}',
             #     '--project-company', 'Company Name',
             #     '--company-id', 'com.company',

lib/cocoapods/config.rb

@@ -25,7 +25,7 @@ module Pod
       @silent = false
       @doc = true
       @doc_install = true
-      @doc_force = false
+      @doc_force = true
     end
 
     def project_root

lib/cocoapods/installer.rb

@@ -53,10 +53,9 @@ module Pod
             downloader.download
 
             if config.doc?
-              doc_source = pod.generate_documentation(config.doc_install?, config.doc_force? ,config.verbose?)
-              if doc_source
+              if pod.generate_documentation(config.doc_install?, config.doc_force? ,config.verbose?)
                 action = config.doc_install ? 'installed' : 'generated'
-                puts "           #{action} #{doc_source} documentation" unless config.silent?
+                puts "           #{action} documentation" unless config.silent?
               end
             end
 

lib/cocoapods/local_pod.rb

@@ -83,56 +83,43 @@ module Pod
     #
     def generate_documentation(install, force = true, verbose = false)
       documentation = specification.documentation ? specification.documentation : {}
-
+      success = false
       if force || documentation.has_key?(:appledoc)
-          `which appledoc`
-          return nil unless $?.success?
-          dir = "#{@sandbox.root}/Documentation/#{name}/"
-          FileUtils.mkdir_p(dir)
-          # default options
-          options = ['--project-name', specification.to_s,
-                      '--project-company', specification.authors.keys.to_s,
-                      '--docset-copyright', "Generated by cocoapods (see #{specification.homepage} for copyright information).",
-                      '--docset-desc', specification.description,
-                      '--company-id', 'org.cocoapods',
-                      '--ignore', '.m']
-          # spec options
-          options += documentation[:appledoc] if documentation[:appledoc]
-          # options that can't be overridden
-          options << '--no-create-docset' unless install
-          options << '--keep-intermediate-files'
-          options += ['--print-settings'] if verbose
-          options += ['--output', dir]
-          options += expanded_paths(specification.source_files, :glob => '*.{h,m,mm,c,cpp}', :relative_to_sandbox => false)
-          success = false
-          Open3.popen3('appledoc', *options ) do |stdin, stdout, stderr|
-            puts stdout.read.chomp if verbose
-            puts stderr.read.chomp if verbose
-            success = stderr.read.chomp == ""
-          end
-          # TODO: should return nil if appledoc fails
-          return success ? 'appledoc' : nil
-
-        elsif documentation[:atom] && install
-          # TODO: donwload and uncompress the docset
-          # path =
-          #Open3.popen3('osascript') { |stdin, stdout, stderr|
-          #stdin.puts('tell application "Xcode"')
-          #stdin.puts("load documentation set with path \"#{path}\"")
-          #stdin.puts('end tell')
-          #stdin.close
-          #puts stdout.read.chomp if verbose
-          #puts stderr.read.chomp if verbose
-          #}
-          #return 'atom'
+        `which appledoc`
+        return nil unless $?.success?
+        dir = "#{@sandbox.root}/Documentation/#{name}/"
+        FileUtils.mkdir_p(dir)
+        # default options
+        #inline spec may not have some fields like authors
+        project_company = specification.authors ? specification.authors.keys.to_s : 'no-company-specified'
+        options = ['--project-name', specification.to_s,
+                   '--project-company', project_company,
+                   '--company-id', 'org.cocoapods',
+                   '--ignore', '.m']
+        options += ['--docset-copyright', "Generated by cocoapods (see #{specification.homepage} for copyright information)."] if specification.homepage
+        options += ['--docset-desc', specification.description] if specification.description
+        # spec options
+        options += documentation[:appledoc] if documentation[:appledoc]
+        # options that can't be overridden
+        options << '--no-create-docset' unless install
+        options << '--keep-intermediate-files'
+        options += ['--print-settings'] if verbose
+        options += ['--output', dir]
+        options += expanded_paths(specification.source_files, :glob => '*.{h,m,mm,c,cpp}', :relative_to_sandbox => false)
+        Open3.popen3('appledoc', *options ) do |stdin, stdout, stderr|
+          puts stdout.read.chomp if verbose
+          puts stderr.read.chomp if verbose
+          # TODO: success test should be more robust
+          success = stderr.read.chomp == ""
         end
-      return nil
+      end
+      success
     end
 
     def requires_arc?
       specification.requires_arc
     end
-    
+
     private
     
     def implementation_files

spec/unit/specification_spec.rb

@@ -283,22 +283,18 @@ describe "A Pod::Specification, in general," do
   it "returns the documentation of the Pod" do
     @spec.documentation = {
       :html => 'http://EXAMPLE/#{@name}/documentation',
-      :atom => 'http://EXAMPLE/#{@name}/com.company.#{@name}.atom',
-      :appledoc => ['--project-name', '#{@name}',
-                    '--project-company', '"Company Name"',
-                    '--company-id', 'com.company',
-                    '--ignore', 'Common',
-                    '--ignore', '.m'] 
-    }
-    @spec.documentation.should == {
-      :html => 'http://EXAMPLE/#{@name}/documentation',
-      :atom => 'http://EXAMPLE/#{@name}/com.company.#{@name}.atom',
       :appledoc => ['--project-name', '#{@name}',
                     '--project-company', '"Company Name"',
                     '--company-id', 'com.company',
                     '--ignore', 'Common',
                     '--ignore', '.m'] 
     }
+    @spec.documentation[:html].should == 'http://EXAMPLE/#{@name}/documentation'
+    @spec.documentation[:appledoc].should == ['--project-name', '#{@name}',
+                                          '--project-company', '"Company Name"',
+                                          '--company-id', 'com.company',
+                                          '--ignore', 'Common',
+                                          '--ignore', '.m']
   end
 
   it "takes a list of paths to clean" do