cocoapods 0.37.1 → 0.37.2

data/lib/cocoapods/hooks/installer_representation.rb

@@ -119,6 +119,8 @@ module Pod
 
       # @!group Private implementation
 
+      # Initialize a new instance
+      #
       # @param [Installer] installer @see installer
       #
       def initialize(installer)

data/lib/cocoapods/hooks/library_representation.rb

@@ -61,7 +61,7 @@ module Pod
       #
       attr_reader :sandbox
 
-      # @return [Library] The library whose target needs to be generated.
+      # @return [Target] The library whose target needs to be generated.
       #
       attr_reader :library
 
@@ -76,8 +76,10 @@ module Pod
 
       # @!group Private implementation
 
+      # Initialize a new instance
+      #
       # @param [Sandbox] sandbox @see sandbox
-      # @param [Library] library @see library
+      # @param [Target]  library @see library
       #
       def initialize(sandbox, library)
         @sandbox = sandbox

data/lib/cocoapods/hooks/pod_representation.rb

@@ -11,35 +11,35 @@ module Pod
     # Stores the information of the Installer for the hooks
     #
     class PodRepresentation
-      # @return [String]
+      # @return [String] the name of the pod
       #
       attr_accessor :name
 
-      # @return [Version]
+      # @return [Version] the version
       #
       def version
         root_spec.version
       end
 
-      # @return [Specification]
+      # @return [Specification] the root spec
       #
       def root_spec
         file_accessors.first.spec.root
       end
 
-      # @return [Array<Specification>]
+      # @return [Array<Specification>] the specs
       #
       def specs
         file_accessors.map(&:spec).uniq
       end
 
-      # @return [Pathname]
+      # @return [Pathname] the root path
       #
       def root
         file_accessors.first.path_list.root
       end
 
-      # @return [Array<Pathname>]
+      # @return [Array<Pathname>] the source files
       #
       def source_files
         file_accessors.map(&:source_files).flatten.uniq

data/lib/cocoapods/hooks_manager.rb

@@ -34,6 +34,8 @@ module Pod
       #
       attr_reader :block
 
+      # Initialize a new instance
+      #
       # @param  [String] name        @see {#name}.
       #
       # @param  [String] plugin_name @see {#plugin_name}.

data/lib/cocoapods/installer.rb

@@ -55,6 +55,8 @@ module Pod
     #
     attr_reader :lockfile
 
+    # Initialize a new instance
+    #
     # @param  [Sandbox]  sandbox     @see sandbox
     # @param  [Podfile]  podfile     @see podfile
     # @param  [Lockfile] lockfile    @see lockfile
@@ -122,6 +124,7 @@ module Pod
         install_pod_sources
         run_pre_install_hooks
         clean_pod_sources
+        lock_pod_sources
       end
     end
 
@@ -133,6 +136,7 @@ module Pod
         set_target_dependencies
         run_podfile_post_install_hooks
         write_pod_project
+        share_development_pod_schemes
         write_lockfiles
       end
     end
@@ -171,6 +175,8 @@ module Pod
 
     # @!group Installation steps
 
+    # Performs the analysis.
+    #
     # @return [void]
     #
     # @note   The warning about the version of the Lockfile doesn't use the
@@ -316,6 +322,16 @@ module Pod
       @pod_installers.each(&:clean!)
     end
 
+    # Locks the sources of the Pods if the config instructs to do so.
+    #
+    # @todo Why the @pod_installers might be empty?
+    #
+    def lock_pod_sources
+      return unless config.lock_pod_source?
+      return unless @pod_installers
+      @pod_installers.each(&:lock_files!)
+    end
+
     # Determines if the dependencies need to be built as dynamic frameworks or
     # if they can be built as static libraries by checking for the Swift source
     # presence. Therefore it is important that the file accessors of the
@@ -589,6 +605,20 @@ module Pod
       end
     end
 
+    # Shares schemes of development Pods.
+    #
+    # @return [void]
+    #
+    def share_development_pod_schemes
+      development_pod_targets = sandbox.development_pods.keys.map do |pod|
+        pods_project.targets.select { |target| target.name =~ /^Pods-.*-#{pod}$/ }
+      end.flatten
+
+      development_pod_targets.each do |pod_target|
+        Xcodeproj::XCScheme.share_scheme(pods_project.path, pod_target.name)
+      end
+    end
+
     # Writes the Podfile and the lock files.
     #
     # @todo   Pass the checkout options to the Lockfile.
@@ -696,18 +726,20 @@ module Pod
 
     # @!group Hooks Data
 
+    # Creates a hook representation for this installer.
+    #
     # @return [InstallerRepresentation]
     #
     def installer_rep
       Hooks::InstallerRepresentation.new(self)
     end
 
-    # @return [PodRepresentation] The hook representation of a Pod.
+    # Creates a hook representation for a Pod.
     #
     # @param  [String] pod
     #         The name of the pod.
     #
-    # @return [PodRepresentation] The pod representation.
+    # @return [PodRepresentation]
     #
     def pod_rep(pod)
       all_file_accessors = pod_targets.map(&:file_accessors).flatten.compact
@@ -715,18 +747,27 @@ module Pod
       Hooks::PodRepresentation.new(pod, file_accessors)
     end
 
+    # Creates a hook representation for a given aggregate target.
+    #
+    # @param  [AggregateTarget] aggregate_target
+    #         the aggregate target
+    #
     # @return [LibraryRepresentation]
     #
     def library_rep(aggregate_target)
       Hooks::LibraryRepresentation.new(sandbox, aggregate_target)
     end
 
+    # Creates hook representations for all aggregate targets.
+    #
     # @return [Array<LibraryRepresentation>]
     #
     def library_reps
       @library_reps ||= aggregate_targets.map { |lib| library_rep(lib) }
     end
 
+    # Creates hook representations for all #root_specs.
+    #
     # @return [Array<PodRepresentation>]
     #
     def pod_reps

data/lib/cocoapods/installer/analyzer.rb

@@ -24,6 +24,8 @@ module Pod
       #
       attr_reader :lockfile
 
+      # Initialize a new instance
+      #
       # @param  [Sandbox]  sandbox     @see sandbox
       # @param  [Podfile]  podfile     @see podfile
       # @param  [Lockfile] lockfile    @see lockfile
@@ -44,6 +46,9 @@ module Pod
       # compute which specification should be installed. The manifest of the
       # sandbox returns which specifications are installed.
       #
+      # @param  [Bool] allow_fetches
+      #         whether external sources may be fetched
+      #
       # @return [AnalysisResult]
       #
       def analyze(allow_fetches = true)
@@ -72,6 +77,9 @@ module Pod
         podfile_needs_install?(analysis_result) || sandbox_needs_install?(analysis_result)
       end
 
+      # @param  [AnalysisResult] analysis_result
+      #         the analysis result to check for changes
+      #
       # @return [Bool] Whether the podfile has changes respect to the lockfile.
       #
       def podfile_needs_install?(analysis_result)
@@ -80,6 +88,9 @@ module Pod
         !needing_install.empty?
       end
 
+      # @param  [AnalysisResult] analysis_result
+      #         the analysis result to check for changes
+      #
       # @return [Bool] Whether the sandbox is in synch with the lockfile.
       #
       def sandbox_needs_install?(analysis_result)
@@ -181,7 +192,7 @@ module Pod
 
       # Creates the models that represent the libraries generated by CocoaPods.
       #
-      # @return [Array<Libraries>] the generated libraries.
+      # @return [Array<Target>] the generated libraries.
       #
       def generate_targets
         targets = []
@@ -757,6 +768,8 @@ module Pod
       #       subspecs are added instead of the name of the Pods.
       #
       class SpecsState
+        # Initialize a new instance
+        #
         # @param  [Hash{Symbol=>String}] pods_by_state
         #         The name of the pods grouped by their state
         #         (`:added`, `:removed`, `:changed` or `:unchanged`).
@@ -804,10 +817,10 @@ module Pod
 
         # Adds the name of a Pod to the give state.
         #
-        # @param  [String]
+        # @param  [String] name
         #         the name of the Pod.
         #
-        # @param  [Symbol]
+        # @param  [Symbol] state
         #         the state of the Pod.
         #
         # @return [void]

data/lib/cocoapods/installer/analyzer/sandbox_analyzer.rb

@@ -51,6 +51,8 @@ module Pod
         #
         attr_reader :lockfile
 
+        # Init a new SandboxAnalyzer
+        #
         # @param [Sandbox] sandbox @see sandbox
         # @param [Array<Specifications>] specs @see specs
         # @param [Bool] update_mode @see update_mode
@@ -66,7 +68,7 @@ module Pod
         # Performs the analysis to the detect the state of the sandbox respect
         # to the resolved specifications.
         #
-        # @return [SpecsState] the state of the sandbox.
+        # @return [void]
         #
         def analyze
           state = SpecsState.new

data/lib/cocoapods/installer/file_references_installer.rb

@@ -16,6 +16,8 @@ module Pod
       #
       attr_reader :pods_project
 
+      # Initialize a new instance
+      #
       # @param [Sandbox] sandbox @see sandbox
       # @param [Array<PodTarget>] libraries @see libraries
       # @param [Project] libraries @see libraries
@@ -153,7 +155,7 @@ module Pod
       #         The key of the group of the Pods project.
       #
       # @param  [Bool] reflect_file_system_structure_for_development
-      #         Wether organizing the a local pod's files in subgroups inside
+      #         Whether organizing a local pod's files in subgroups inside
       #         the pod's group is allowed.
       #
       # @return [void]

data/lib/cocoapods/installer/hooks_context.rb

@@ -13,6 +13,15 @@ module Pod
       #
       attr_accessor :umbrella_targets
 
+      # Generate a {HooksContext}.
+      #
+      # @param  [Sandbox] sandbox
+      #         The sandbox
+      #
+      # @param  [Array<AggregateTarget>] aggregate_targets
+      #         The aggregate targets, which will been presented by an adequate
+      #         {UmbrellaTargetDescription} in the generated context.
+      #
       # @return [HooksContext] Convenience class method to generate the
       #         static context.
       #

data/lib/cocoapods/installer/migrator.rb

@@ -8,7 +8,8 @@ module Pod
       class << self
         # Performs the migration.
         #
-        # @param  [Sandbox] The sandbox which should be migrated.
+        # @param  [Sandbox] sandbox
+        #         The sandbox which should be migrated.
         #
         def migrate(sandbox)
           if sandbox.manifest
@@ -21,6 +22,8 @@ module Pod
 
         # Migrates from CocoaPods versions previous to 0.34.
         #
+        # @param [Sandbox] sandbox
+        #
         def migrate_to_0_34(sandbox)
           UI.message('Migrating to CocoaPods 0.34') do
             delete(sandbox.root + 'Headers')
@@ -49,6 +52,8 @@ module Pod
 
         # Migrates from CocoaPods versions prior to 0.36.
         #
+        # @param [Sandbox] sandbox
+        #
         def migrate_to_0_36(sandbox)
           UI.message('Migrating to CocoaPods 0.36') do
             move(sandbox.root + 'Headers/Build', sandbox.root + 'Headers/Private')
@@ -69,6 +74,16 @@ module Pod
 
         # @!group Private helpers
 
+        # Check whether a migration is required
+        #
+        # @param [#to_s] target_version
+        #        See Version#new.
+        #
+        # @param [Sandbox] sandbox
+        #        The sandbox
+        #
+        # @return [void]
+        #
         def installation_minor?(target_version, sandbox)
           sandbox.manifest.cocoapods_version < Version.new(target_version)
         end
@@ -79,6 +94,8 @@ module Pod
         # @path [#to_s] path
         #       The path.
         #
+        # @return [void]
+        #
         def make_path(path)
           return if path.exist?
           UI.message "- Making path #{UI.path(path)}" do
@@ -94,6 +111,8 @@ module Pod
         # @path [#to_s] destination
         #       The destination path.
         #
+        # @return [void]
+        #
         def move(source, destination)
           return unless source.exist?
           make_path(destination.dirname)
@@ -108,6 +127,8 @@ module Pod
         # @path [#to_s] path
         #       The path.
         #
+        # @return [void]
+        #
         def delete(path)
           return unless path.exist?
           UI.message "- Deleting #{UI.path(path)}" do

data/lib/cocoapods/installer/pod_source_installer.rb

@@ -8,7 +8,7 @@ module Pod
     # @note This class needs to consider all the activated specs of a Pod.
     #
     class PodSourceInstaller
-      # @return [Sandbox]
+      # @return [Sandbox] The installation target.
       #
       attr_reader :sandbox
 
@@ -17,6 +17,8 @@ module Pod
       #
       attr_reader :specs_by_platform
 
+      # Initialize a new instance
+      #
       # @param [Sandbox] sandbox @see sandbox
       # @param [Hash{Symbol=>Array}] specs_by_platform @see specs_by_platform
       #
@@ -44,7 +46,6 @@ module Pod
       def install!
         download_source unless predownloaded? || local?
         PodSourcePreparer.new(root_spec, root).prepare! if local?
-        lock_files!
       end
 
       # Cleans the installations if appropriate.
@@ -58,7 +59,18 @@ module Pod
         clean_installation unless local?
       end
 
-      # @return [Hash]
+      # Locks the source files if appropriate.
+      #
+      # @todo   As the pre install hooks need to run before cleaning this
+      #         method should be refactored.
+      #
+      # @return [void]
+      #
+      def lock_files!
+        lock_installation unless local?
+      end
+
+      # @return [Hash] @see Downloader#checkout_options
       #
       attr_reader :specific_source
 
@@ -95,11 +107,7 @@ module Pod
       #
       # @return [void]
       #
-      def lock_files!
-        if local?
-          return
-        end
-
+      def lock_installation
         # We don't want to lock diretories, as that forces you to override
         # those permissions if you decide to delete the Pods folder.
         Dir.glob(root + '**/*').each do |file|