cocoapods 0.37.1 → 0.37.2

data/lib/cocoapods/installer/pod_source_preparer.rb

@@ -12,6 +12,8 @@ module Pod
       #
       attr_reader :path
 
+      # Initialize a new instance
+      #
       # @param [Specification] spec the root specification of the Pod.
       # @param [Pathname] path the folder where the source of the Pod is located.
       #

data/lib/cocoapods/installer/user_project_integrator.rb

@@ -33,14 +33,16 @@ module Pod
       #
       attr_reader :installation_root
 
-      # @return [Array<Target>] the targets represented in the Podfile.
+      # @return [Array<AggregateTarget>] the targets represented in the Podfile.
       #
       attr_reader :targets
 
+      # Init a new UserProjectIntegrator
+      #
       # @param  [Podfile]  podfile @see #podfile
       # @param  [Sandbox]  sandbox @see #sandbox
       # @param  [Pathname] installation_root @see #installation_root
-      # @param  [Library]  libraries @see #libraries
+      # @param  [Array<AggregateTarget>]  targets @see #targets
       #
       # @todo   Too many initialization arguments
       #

data/lib/cocoapods/installer/user_project_integrator/target_integrator.rb

@@ -14,11 +14,13 @@ module Pod
         #
         EMBED_FRAMEWORK_TARGET_TYPES = [:application, :unit_test_bundle].freeze
 
-        # @return [Target] the target that should be integrated.
+        # @return [AggregateTarget] the target that should be integrated.
         #
         attr_reader :target
 
-        # @param  [Target] target @see #target_definition
+        # Init a new TargetIntegrator
+        #
+        # @param  [AggregateTarget] target @see #target
         #
         def initialize(target)
           @target = target
@@ -257,6 +259,8 @@ module Pod
         # Read the project from the disk to ensure that it is up to date as
         # other TargetIntegrators might have modified it.
         #
+        # @return [Project]
+        #
         def user_project
           @user_project ||= Xcodeproj::Project.open(target.user_project_path)
         end

data/lib/cocoapods/open_uri.rb

@@ -16,6 +16,14 @@ module OpenURI
   # (RFC 2109 4.3.1, RFC 2965 3.3, RFC 2616 15.1.3)
   # However this is ad hoc.  It should be extensible/configurable.
   #
+  # @param [URI::Generic] uri1
+  #        the origin uri from where the redirect origins
+  #
+  # @param [URI::Generic] uri2
+  #        the target uri where to where the redirect points to
+  #
+  # @return [Bool]
+  #
   def self.redirectable?(uri1, uri2)
     uri1.scheme.downcase == uri2.scheme.downcase ||
       (/\A(?:http|ftp)\z/i =~ uri1.scheme && /\A(?:https?|ftp)\z/i =~ uri2.scheme)

data/lib/cocoapods/project.rb

@@ -7,6 +7,8 @@ module Pod
   # through the installation process.
   #
   class Project < Xcodeproj::Project
+    # Initialize a new instance
+    #
     # @param  [Pathname, String] path @see path
     # @param  [Bool] skip_initialization
     #         Whether the project should be initialized from scratch.
@@ -169,7 +171,7 @@ module Pod
     #         The group for the new file reference.
     #
     # @param  [Bool] reflect_file_system_structure
-    #         Wether group structure should reflect the file system structure.
+    #         Whether group structure should reflect the file system structure.
     #         If yes, where needed, intermediate groups are created, similar to
     #         how mkdir -p operates.
     #

data/lib/cocoapods/resolver.rb

@@ -25,6 +25,8 @@ module Pod
     #
     attr_accessor :sources
 
+    # Init a new Resolver
+    #
     # @param  [Sandbox] sandbox @see sandbox
     # @param  [Podfile] podfile @see podfile
     # @param  [Array<Dependency>] locked_dependencies @see locked_dependencies
@@ -53,7 +55,11 @@ module Pod
       dependencies = podfile.target_definition_list.map(&:dependencies).flatten
       @cached_sets = {}
       @activated = Molinillo::Resolver.new(self, self).resolve(dependencies, locked_dependencies)
-      specs_by_target
+      specs_by_target.tap do |specs_by_target|
+        specs_by_target.values.flatten.each do |spec|
+          sandbox.store_head_pod(spec.name) if spec.version.head?
+        end
+      end
     rescue Molinillo::ResolverError => e
       handle_resolver_error(e)
     end
@@ -64,24 +70,18 @@ module Pod
     # @note   The returned specifications can be subspecs.
     #
     def specs_by_target
-      @specs_by_target ||= begin
-        specs_by_target = {}
+      @specs_by_target ||= {}.tap do |specs_by_target|
         podfile.target_definition_list.each do |target|
-          specs = target.dependencies.map(&:name).map do |name|
+          specs = target.dependencies.map(&:name).flat_map do |name|
             node = @activated.vertex_named(name)
             valid_dependencies_for_target_from_node(target, node) << node
           end
 
           specs_by_target[target] = specs.
-            flatten.
             map(&:payload).
             uniq.
-            sort_by(&:name).
-            each do |spec|
-              sandbox.store_head_pod(spec.name) if spec.version.head?
-            end
+            sort_by(&:name)
         end
-        specs_by_target
       end
     end
 

data/lib/cocoapods/sandbox.rb

@@ -50,6 +50,8 @@ module Pod
     #
     attr_reader :public_headers
 
+    # Initialize a new instance
+    #
     # @param [String, Pathname] root @see root
     #
     def initialize(root)
@@ -246,6 +248,8 @@ module Pod
     #         The contents of the specification (String) or the path to a
     #         podspec file (Pathname).
     #
+    # @return [void]
+    #
     # @todo   Store all the specifications (including those not originating
     #         from external sources) so users can check them.
     #

data/lib/cocoapods/sandbox/file_accessor.rb

@@ -27,6 +27,8 @@ module Pod
       #
       attr_reader :spec_consumer
 
+      # Initialize a new instance
+      #
       # @param [Sandbox::PathList, Pathname] path_list @see path_list
       # @param [Specification::Consumer] spec_consumer @see spec_consumer
       #
@@ -168,7 +170,7 @@ module Pod
       end
 
       # @return [Hash{String => Array<Pathname>}] A hash that describes the
-      #         resource bundles of the Pod. The keys reppresent the name of
+      #         resource bundles of the Pod. The keys represent the name of
       #         the bundle while the values the path of the resources.
       #
       def resource_bundles

data/lib/cocoapods/sandbox/headers_store.rb

@@ -56,19 +56,19 @@ module Pod
 
       # @!group Adding headers
 
-      # Adds a header to the directory.
+      # Adds headers to the directory.
       #
-      # @param  [Pathname] namespace_path
+      # @param  [Pathname] namespace
       #         the path where the header file should be stored relative to the
       #         headers directory.
       #
-      # @param  [Pathname] relative_header_path
+      # @param  [Array<Pathname>] relative_header_paths
       #         the path of the header file relative to the Pods project
       #         (`PODS_ROOT` variable of the xcconfigs).
       #
       # @note   This method adds the files to the search paths.
       #
-      # @return [Pathname]
+      # @return [Array<Pathname>]
       #
       def add_files(namespace, relative_header_paths, platform)
         add_search_path(namespace, platform)

data/lib/cocoapods/sandbox/path_list.rb

@@ -15,6 +15,8 @@ module Pod
       #
       attr_accessor :root
 
+      # Initialize a new instance
+      #
       # @param  [Pathname] root The root of the PathList.
       #
       def initialize(root)
@@ -61,24 +63,41 @@ module Pod
 
       # @!group Globbing
 
-      # @return [Array<Pathname>] Similar to {glob} but returns the absolute
-      #         paths.
+      # Similar to {glob} but returns the absolute paths.
+      #
+      # @param  [String,Array<String>] patterns
+      #         @see #relative_glob
+      #
+      # @param  [Hash] options
+      #         @see #relative_glob
+      #
+      # @return [Array<Pathname>]
       #
       def glob(patterns, options = {})
         relative_glob(patterns, options).map { |p| root + p }
       end
 
-      # @return [Array<Pathname>] The list of relative paths that are case
-      #         insensitively matched by a given pattern. This method emulates
-      #         {Dir#glob} with the {File::FNM_CASEFOLD} option.
+      # The list of relative paths that are case insensitively matched by a
+      # given pattern. This method emulates {Dir#glob} with the
+      # {File::FNM_CASEFOLD} option.
       #
       # @param  [String,Array<String>] patterns
       #         A single {Dir#glob} like pattern, or a list of patterns.
       #
-      # @param  [String] dir_pattern
+      # @param  [Hash] options
+      #
+      # @option options [String] :dir_pattern
       #         An optional pattern to append to a pattern, if it is the path
       #         to a directory.
       #
+      # @option options [Array<String>] :exclude_patterns
+      #         Exclude specific paths given by those patterns.
+      #
+      # @option options [Array<String>] :include_dirs
+      #         Additional paths to take into account for matching.
+      #
+      # @return [Array<Pathname>]
+      #
       def relative_glob(patterns, options = {})
         return [] if patterns.empty?
 

data/lib/cocoapods/sources_manager.rb

@@ -195,7 +195,9 @@ module Pod
       # Updates the local clone of the spec-repo with the given name or of all
       # the git repos if the name is omitted.
       #
-      # @param  [String] name
+      # @param  [String] source_name
+      #
+      # @param  [Bool] show_output
       #
       # @return [void]
       #

data/lib/cocoapods/target.rb

@@ -6,7 +6,7 @@ module Pod
   # This class is used to represent both the targets and their libraries.
   #
   class Target
-    # @return [PBXNativeTarget] the target definition of the Podfile that
+    # @return [TargetDefinition] the target definition of the Podfile that
     #         generated this target.
     #
     attr_reader :target_definition

data/lib/cocoapods/target/aggregate_target.rb

@@ -3,6 +3,8 @@ module Pod
   # of the single Pods. The client targets will then depend on this one.
   #
   class AggregateTarget < Target
+    # Initialize a new instance
+    #
     # @param [TargetDefinition] target_definition @see target_definition
     # @param [Sandbox] sandbox @see sandbox
     #
@@ -51,8 +53,12 @@ module Pod
     #
     attr_accessor :user_target_uuids
 
-    # @return [Array<PBXNativeTarget>] The list of all the user targets that
-    #         will be integrated by this target.
+    # List all user targets that will be integrated by this #target.
+    #
+    # @param  [Xcodeproj::Project] project
+    #         The project to search for the user targets
+    #
+    # @return [Array<PBXNativeTarget>]
     #
     def user_targets(project = nil)
       return [] unless user_project_path

data/lib/cocoapods/user_interface.rb

@@ -37,6 +37,16 @@ module Pod
       # @todo Refactor to title (for always visible titles like search)
       #       and sections (titles that represent collapsible sections).
       #
+      # @param [String] title
+      #        The title to print
+      #
+      # @param [String] verbose_prefix
+      #        See #message
+      #
+      # @param [FixNum] relative_indentation
+      #        The indentation level relative to the current,
+      #        when the message is printed.
+      #
       def section(title, verbose_prefix = '', relative_indentation = 0)
         if config.verbose?
           title(title, verbose_prefix, relative_indentation)
@@ -74,6 +84,16 @@ module Pod
 
       # A title opposed to a section is always visible
       #
+      # @param [String] title
+      #        The title to print
+      #
+      # @param [String] verbose_prefix
+      #        See #message
+      #
+      # @param [FixNum] relative_indentation
+      #        The indentation level relative to the current,
+      #        when the message is printed.
+      #
       def title(title, verbose_prefix = '', relative_indentation = 2)
         if @treat_titles_as_messages
           message(title, verbose_prefix)
@@ -102,6 +122,16 @@ module Pod
       #
       # @todo Clean interface.
       #
+      # @param [String] message
+      #        The message to print.
+      #
+      # @param [String] verbose_prefix
+      #        See #message
+      #
+      # @param [FixNum] relative_indentation
+      #        The indentation level relative to the current,
+      #        when the message is printed.
+      #
       def message(message, verbose_prefix = '', relative_indentation = 2)
         message = verbose_prefix + message if config.verbose?
         puts_indented message if config.verbose?
@@ -117,6 +147,9 @@ module Pod
       #
       # Any title printed in the optional block is treated as a message.
       #
+      # @param [String] message
+      #        The message to print.
+      #
       def info(message)
         indentation = config.verbose? ? self.indentation_level : 0
         indented = wrap_string(message, indentation)
@@ -143,6 +176,9 @@ module Pod
       # The returned path is quoted. If the argument is nil it returns the
       # empty string.
       #
+      # @param [#to_str] pathname
+      #        The path to print.
+      #
       def path(pathname)
         if pathname
           from_path = config.podfile_path.dirname if config.podfile_path
@@ -156,6 +192,12 @@ module Pod
 
       # Prints the textual representation of a given set.
       #
+      # @param  [Set] set
+      #         the set that should be presented.
+      #
+      # @param  [Symbol] mode
+      #         the presentation mode, either `:normal` or `:name_and_version`.
+      #
       def pod(set, mode = :normal)
         if mode == :name_and_version
           puts_indented "#{set.name} #{set.versions.first.version}"
@@ -190,6 +232,15 @@ module Pod
 
       # Prints a message with a label.
       #
+      # @param [String] label
+      #        The label to print.
+      #
+      # @param [#to_s] value
+      #        The value to print.
+      #
+      # @param [FixNum] justification
+      #        The justification of the label.
+      #
       def labeled(label, value, justification = 12)
         if value
           title = "- #{label}:"
@@ -208,6 +259,9 @@ module Pod
       # Prints a message respecting the current indentation level and
       # wrapping it to the terminal width if necessary.
       #
+      # @param [String] message
+      #        The message to print.
+      #
       def puts_indented(message = '')
         indented = wrap_string(message, self.indentation_level)
         puts(indented)
@@ -238,12 +292,18 @@ module Pod
 
       # prints a message followed by a new line unless config is silent.
       #
+      # @param [String] message
+      #        The message to print.
+      #
       def puts(message = '')
         STDOUT.puts(message) unless config.silent?
       end
 
       # prints a message followed by a new line unless config is silent.
       #
+      # @param [String] message
+      #        The message to print.
+      #
       def print(message)
         STDOUT.print(message) unless config.silent?
       end
@@ -259,6 +319,8 @@ module Pod
       #
       # @param [String]  message The message to print.
       # @param [Array]   actions The actions that the user should take.
+      # @param [Bool]    verbose_only
+      #        Restrict the appearance of the warning to verbose mode only
       #
       # return [void]
       #

data/lib/cocoapods/validator.rb

@@ -16,6 +16,8 @@ module Pod
     #
     attr_reader :linter
 
+    # Initialize a new instance
+    #
     # @param  [Specification, Pathname, String] spec_or_path
     #         the Specification or the path of the `podspec` file to lint.
     #
@@ -167,7 +169,8 @@ module Pod
       result_type != :error && (result_type != :warning || allow_warnings)
     end
 
-    # @return [Symbol]
+    # @return [Symbol] The type, which should been used to display the result.
+    #         One of: `:error`, `:warning`, `:note`.
     #
     def result_type
       types = results.map(&:type).uniq
@@ -177,7 +180,8 @@ module Pod
       end
     end
 
-    # @return [Symbol]
+    # @return [Symbol] The color, which should been used to display the result.
+    #         One of: `:green`, `:yellow`, `:red`.
     #
     def result_color
       case result_type