LocalPod clean up.

lib/cocoapods/local_pod.rb

@@ -13,17 +13,20 @@ module Pod
       new(Specification.from_file(podspec), sandbox, platform)
     end
 
-    def root
-      @sandbox.root + top_specification.name
-    end
-
-    # Adding specifications is idempotent
+    # Method to add the specifications sharing the same top level
+    # parent. With this information the local pod can determine the
+    # paths to clean and avoid duplication in file processing.
+    # Adding specifications is idempotent.
     def add_specification(spec)
       raise Informative, "[Local Pod] Attempt to add a specification from another pod" unless spec.top_level_parent == top_specification
       spec.activate_platform(platform)
       @specifications << spec unless @specifications.include?(spec)
     end
 
+    def root
+      @sandbox.root + top_specification.name
+    end
+
     def subspecs
       specifications.reject{|s| s.parent.nil? }
     end
@@ -42,6 +45,8 @@ module Pod
       top_specification.active_platform
     end
 
+    # Installation methods
+
     def create
       root.mkpath unless exists?
     end
@@ -59,10 +64,10 @@ module Pod
       root.rmtree if exists?
     end
 
+    # It deletes all the files identified by clean_paths, then it removes
+    # all the empty folders or symlinks.
     def clean
       clean_paths.each { |path| FileUtils.rm_rf(path) }
-
-      # remove empty diretories
       Dir.glob("#{root}/**/{*,.*}").
         sort_by(&:length).reverse.            # Clean the deepest paths first to determine if the containing folders are empty
         reject { |d| d =~ /\/\.\.?$/ }.       # Remove the `.` and `..` paths
@@ -72,6 +77,8 @@ module Pod
         end
     end
 
+    # File attributes
+
     def prefix_header_file
       if prefix_header = top_specification.prefix_header_file
         @sandbox.root + top_specification.name + prefix_header
@@ -110,16 +117,18 @@ module Pod
       source_files.select { |f| f.extname == '.h' }
     end
 
+    def xcconfig
+      specifications.map { |s| s.xcconfig }.reduce(:merge)
+    end
+
+    # Integration methods
+
     def link_headers
       copy_header_mappings.each do |namespaced_path, files|
         @sandbox.add_header_files(namespaced_path, files)
       end
     end
 
-    def xcconfig
-      specifications.map { |s| s.xcconfig }.reduce(:merge)
-    end
-
     def add_to_target(target)
       sources_files_by_specification.each do | spec, files |
         files.each do |file|
@@ -128,30 +137,13 @@ module Pod
       end
     end
 
-    # returns an hash where the source_files are groupped by specification.
-    # If the same file is required by two specifications the one at the
-    # higher level in the inheritance chain wins.
-    def sources_files_by_specification
-      files_by_spec   = {}
-      processed_files = []
-      specifications.sort_by { |s| s.name.length }.each do |spec|
-        files = []
-        expanded_paths(spec.source_files, :glob => '*.{h,m,mm,c,cpp}', :relative_to_sandbox => true).each do | file |
-          files << file unless processed_files.include?(file)
-        end
-        files_by_spec[spec] = files
-        processed_files    += files
-      end
-      files_by_spec
-    end
-
     def requires_arc?
       top_specification.requires_arc
     end
 
-    def dependencies
-      top_specification.dependencies
-    end
+    # def dependencies
+    #   top_specification.dependencies
+    # end
 
     private
 
@@ -165,6 +157,9 @@ module Pod
 
     # TODO this is being overriden in the RestKit 0.9.4 spec, need to do
     # something with that, and this method also still exists in Specification.
+    #
+    # This is not overriden anymore in specification refactor and the code
+    # Pod::Specification#copy_header_mapping can be moved here.
     def copy_header_mappings
       search_path_headers = header_files - exclude_headers
       search_path_headers.inject({}) do |mappings, from|
@@ -175,6 +170,23 @@ module Pod
       end
     end
 
+    # returns an hash where the source_files are groupped by specification.
+    # If the same file is required by two specifications the one at the
+    # higher level in the inheritance chain wins.
+    def sources_files_by_specification
+      files_by_spec   = {}
+      processed_files = []
+      specifications.sort_by { |s| s.name.length }.each do |spec|
+        files = []
+        expanded_paths(spec.source_files, :glob => '*.{h,m,mm,c,cpp}', :relative_to_sandbox => true).each do | file |
+          files << file unless processed_files.include?(file)
+        end
+        files_by_spec[spec] = files
+        processed_files    += files
+      end
+      files_by_spec
+    end
+
     def exclude_headers
       chained_expanded_paths(:exclude_headers, :relative_to_sandbox => true)
     end