Merge pull request #962 from xslim/master

New command podfile-info - Shows information on installed Pods #855

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ###### Enhancements
 
+* Added `pod podfile-info` command. Shows list of used Pods and their info
+  in a project or supplied Podfile.
+  Options: `--all` - with dependancies. `--md` - in Markdown.
+  [#855](https://github.com/CocoaPods/CocoaPods/issues/855)
 * CocoaPods now defines the `COCOAPODS=1` macro in the Pod and the Client
   targets. This is useful for libraries which conditionally expose interfaces.
   [#903](https://github.com/CocoaPods/CocoaPods/issues/903)

lib/cocoapods/command.rb

@@ -18,6 +18,7 @@ module Pod
     require 'cocoapods/command/spec'
     require 'cocoapods/command/help'
     require 'cocoapods/command/inter_process_communication'
+    require 'cocoapods/command/podfile_info'
 
     self.abstract_command = true
     self.command = 'pod'

lib/cocoapods/command/podfile_info.rb

+module Pod
+  class Command
+
+    class PodfileInfo < Command
+
+      self.summary = 'Shows information on installed Pods.'
+      self.description = <<-DESC
+        Shows information on installed Pods in current Project. 
+        If optional `PODFILE_PATH` provided, the info will be shown for
+        that specific Podfile
+      DESC
+      self.arguments = '[PODFILE_PATH]'
+
+      def self.options
+        [
+          ["--all", "Show information about all Pods with dependencies that are used in a project"],
+          ["--md", "Output information in Markdown format"]
+        ].concat(super)
+      end
+
+      def initialize(argv)
+        @info_all = argv.flag?('all')
+        @info_in_md = argv.flag?('md')
+        @podfile_path = argv.shift_argument
+        super
+      end
+
+      def run
+        use_podfile = (@podfile_path || !config.lockfile)
+          
+        if !use_podfile
+          UI.puts "Using lockfile" if config.verbose?
+          verify_lockfile_exists!
+          lockfile = config.lockfile
+          pods = lockfile.pod_names
+          if @info_all
+            deps = lockfile.dependencies.map{|d| d.name}
+            pods = (deps + pods).uniq
+          end
+        elsif @podfile_path
+          podfile = Pod::Podfile.from_file(@podfile_path)
+          pods = pods_from_podfile(podfile)
+        else
+          verify_podfile_exists!
+          podfile = config.podfile
+          pods = pods_from_podfile(podfile)
+        end
+
+        UI.puts "\nPods used:\n".yellow unless @info_in_md
+        pods_info(pods, @info_in_md)
+      end
+
+      def pods_from_podfile(podfile)
+        pods = []
+        podfile.root_target_definitions.each {|e| h = e.to_hash; pods << h['dependencies'] if h['dependencies']}
+        pods.flatten!
+        pods.collect! {|pod| (pod.is_a?(Hash)) ? pod.keys.first : pod}
+      end
+
+      def pods_info_hash(pods, keys=[:name, :homepage, :summary])
+        pods_info = []
+        pods.each do |pod|
+          spec = (Pod::SourcesManager.search_by_name(pod).first rescue nil)
+          if spec
+            info = {}
+            keys.each { |k| info[k] = spec.specification.send(k) }
+            pods_info << info
+          else
+            
+          end
+          
+        end
+        pods_info
+      end
+
+      def pods_info(pods, in_md=false)
+        pods = pods_info_hash(pods, [:name, :homepage, :summary])
+
+        pods.each do |pod| 
+          if in_md
+            UI.puts "* [#{pod[:name]}](#{pod[:homepage]}) - #{pod[:summary]}" 
+          else
+            UI.puts "- #{pod[:name]} - #{pod[:summary]}" 
+          end
+        end
+      end
+
+    end
+    
+  end
+end
\ No newline at end of file

spec/functional/command/podfile_info_spec.rb

+require File.expand_path('../../../spec_helper', __FILE__)
+
+module Pod
+  describe Command::PodfileInfo do
+    extend SpecHelper::TemporaryRepos
+
+    before do
+      @test_source = Source.new(fixture('spec-repos/test_repo'))
+      Source::Aggregate.any_instance.stubs(:all).returns([@test_source])
+      SourcesManager.updated_search_index = nil
+    end
+
+    it "tells the user pods info from Podfile" do
+
+      file = temporary_directory + 'Podfile'
+
+      text = <<-PODFILE
+      platform :ios
+      pod 'BananaLib'
+      pod 'JSONKit'
+      PODFILE
+      File.open(file, 'w') {|f| f.write(text) }
+
+      Dir.chdir(temporary_directory) do
+        output = run_command('podfile-info')
+        output.should.include? '- BananaLib - Chunky bananas!'
+        output.should.include? '- JSONKit - A Very High Performance Objective-C JSON Library.'
+      end
+    end
+  end
+end
+