cocoapods-core 0.30.0 → 1.15.2

data/lib/cocoapods-core/lockfile.rb

@@ -1,5 +1,4 @@
 module Pod
-
   # The Lockfile stores information about the pods that were installed by
   # CocoaPods.
   #
@@ -11,7 +10,6 @@ module Pod
   # need to be installed or removed.
   #
   class Lockfile
-
     # @todo   The symbols should be converted to a String and back to symbol
     #         when reading (EXTERNAL SOURCES Download options)
 
@@ -39,8 +37,7 @@ module Pod
     #
     def self.from_file(path)
       return nil unless path.exist?
-      require 'yaml'
-      hash = File.open(path) { |f| YAML.load(f) }
+      hash = YAMLHelper.load_file(path)
       unless hash && hash.is_a?(Hash)
         raise Informative, "Invalid Lockfile in `#{path}`"
       end
@@ -53,7 +50,7 @@ module Pod
     #
     attr_accessor :defined_in_file
 
-    # @return [Bool] Whether the Podfiles are equal.
+    # @return [Boolean] Whether the Podfiles are equal.
     #
     def ==(other)
       other && to_hash == other.to_hash
@@ -80,7 +77,7 @@ module Pod
 
     # Returns the version of the given Pod.
     #
-    # @param [name] The name of the Pod (root name of the specification).
+    # @param [String] pod_name The name of the Pod (root name of the specification).
     #
     # @return [Version] The version of the pod.
     #
@@ -95,9 +92,21 @@ module Pod
       pod_versions[root_name]
     end
 
+    # Returns the source of the given Pod.
+    #
+    # @param [String] pod_name The name of the Pod (root name of the specification).
+    #
+    # @return [String] The source of the pod.
+    #
+    # @return [Nil] If there is no source stored for the given name.
+    #
+    def spec_repo(pod_name)
+      spec_repos_by_pod[pod_name]
+    end
+
     # Returns the checksum for the given Pod.
     #
-    # @param [name] The name of the Pod (root name of the specification).
+    # @param [String] name The name of the Pod (root name of the specification).
     #
     # @return [String] The checksum of the specification for the given Pod.
     #
@@ -124,6 +133,17 @@ module Pod
       @dependencies
     end
 
+    # Returns pod names grouped by the spec repo they were sourced from.
+    #
+    # @return [Hash<String, Array<String>>] A hash, where the keys are spec
+    #         repo source URLs (or names), and the values are arrays of pod names.
+    #
+    # @note   It does not include pods that come from "external sources".
+    #
+    def pods_by_spec_repo
+      @pods_by_spec_repo ||= internal_data['SPEC REPOS'] || {}
+    end
+
     # Generates a dependency that requires the exact version of the Pod with the
     # given name.
     #
@@ -135,20 +155,38 @@ module Pod
     #
     # @raise  If there is no version stored for the given name.
     #
-    # @return [Dependency] the generated dependency.
+    # @return [Array<Dependency>] the generated dependency.
     #
-    def dependency_to_lock_pod_named(name)
-      dep = dependencies.find { |d| d.name == name || d.root_name == name }
-      version = version(name)
+    def dependencies_to_lock_pod_named(name)
+      deps = dependencies.select { |d| d.root_name == name }
+      if deps.empty?
+        raise StandardError, "Attempt to lock the `#{name}` Pod without a " \
+          'known dependency.'
+      end
 
-      unless dep && version
-        raise StandardError, "Attempt to lock the `#{name}` Pod without an " \
-          "known dependency."
+      deps.map do |dep|
+        version = version(dep.name)
+        locked_dependency = dep.dup
+        locked_dependency.specific_version = version
+        locked_dependency
       end
+    end
 
-      locked_dependency = dep.dup
-      locked_dependency.specific_version = version
-      locked_dependency
+    # Returns the specific checkout options for the external source of the pod
+    # with the given name.
+    #
+    # @example  Output
+    #           {:commit => "919903db28535c3f387c4bbaa6a3feae4428e993"
+    #            :git => "https://github.com/luisdelarosa/AFRaptureXMLRequestOperation.git"}
+    #
+    # @return   [Hash] a hash of the checkout options for the external source of
+    #           the pod with the given name.
+    #
+    # @param    [String] name
+    #           the name of the Pod.
+    #
+    def checkout_options_for_pod_named(name)
+      checkout_options_data[name]
     end
 
     # @return [Version] The version of CocoaPods which generated this lockfile.
@@ -184,7 +222,14 @@ module Pod
     #         that required the pod.
     #
     def external_sources_data
-      @external_sources_data ||= internal_data["EXTERNAL SOURCES"] || {}
+      @external_sources_data ||= internal_data['EXTERNAL SOURCES'] || {}
+    end
+
+    # @return [Hash{String => Hash}] a hash where the name of the pods are the
+    #         keys and the values are a hash of specific checkout options.
+    #
+    def checkout_options_data
+      @checkout_options_data ||= internal_data['CHECKOUT OPTIONS'] || {}
     end
 
     # @return [Hash{String => Version}] a Hash containing the name of the root
@@ -203,6 +248,17 @@ module Pod
       internal_data['SPEC CHECKSUMS'] || {}
     end
 
+    # @return [Hash{String => String}] A hash containing the spec repo used for the specification
+    #         by the name of the root spec.
+    #
+    def spec_repos_by_pod
+      @spec_repos_by_pod ||= pods_by_spec_repo.each_with_object({}) do |(spec_repo, pods), spec_repos_by_pod|
+        pods.each do |pod|
+          spec_repos_by_pod[pod] = spec_repo
+        end
+      end
+    end
+
     #-------------------------------------------------------------------------#
 
     # !@group Comparison with a Podfile
@@ -217,7 +273,7 @@ module Pod
     # - added: Pods that weren't present in the Podfile.
     # - changed: Pods that were present in the Podfile but changed:
     #   - Pods whose version is not compatible anymore with Podfile,
-    #   - Pods that changed their head or external options.
+    #   - Pods that changed their external options.
     # - removed: Pods that were removed form the Podfile.
     # - unchanged: Pods that are still compatible with Podfile.
     #
@@ -234,13 +290,23 @@ module Pod
       result = {}
       [:added, :changed, :removed, :unchanged].each { |k| result[k] = [] }
 
-      installed_deps = dependencies.map do |dep|
-        dependency_to_lock_pod_named(dep.name)
+      installed_deps = {}
+      dependencies.each do |dep|
+        name = dep.root_name
+        installed_deps[name] ||= dependencies_to_lock_pod_named(name)
       end
-      all_dep_names  = (dependencies + podfile.dependencies).map(&:name).uniq
+
+      installed_deps = installed_deps.values.flatten(1).group_by(&:name)
+
+      podfile_dependencies = podfile.dependencies
+      podfile_dependencies_by_name = podfile_dependencies.group_by(&:name)
+
+      all_dep_names = (dependencies + podfile_dependencies).map(&:name).uniq
       all_dep_names.each do |name|
-        installed_dep = installed_deps.find { |d| d.name == name }
-        podfile_dep   = podfile.dependencies.find { |d| d.name == name }
+        installed_dep   = installed_deps[name]
+        installed_dep &&= installed_dep.first
+        podfile_dep     = podfile_dependencies_by_name[name]
+        podfile_dep   &&= podfile_dep.first
 
         if installed_dep.nil?  then key = :added
         elsif podfile_dep.nil? then key = :removed
@@ -267,8 +333,17 @@ module Pod
     #
     def write_to_disk(path)
       path.dirname.mkpath unless path.dirname.exist?
-      File.open(path, 'w') { |f| f.write(to_yaml) }
       self.defined_in_file = path
+      # rubocop:disable Lint/RescueException
+      # rubocop:disable Lint/HandleExceptions
+      begin
+        existing = Lockfile.from_file(path)
+        return if existing == self
+      rescue Exception
+      end
+      path.open('w') { |f| f.write(to_yaml) }
+      # rubocop:enable Lint/HandleExceptions
+      # rubocop:enable Lint/RescueException
     end
 
     # @return [Hash{String=>Array,Hash,String}] a hash representation of the
@@ -285,6 +360,7 @@ module Pod
     #     'EXTERNAL SOURCES' => { "JSONKit" => { :podspec => path/JSONKit.podspec } },
     #     'SPEC CHECKSUMS'   => { "BananaLib" => "439d9f683377ecf4a27de43e8cf3bce6be4df97b",
     #                             "JSONKit", "92ae5f71b77c8dec0cd8d0744adab79d38560949" },
+    #     'PODFILE CHECKSUM' => "439d9f683377ecf4a27de43e8cf3bce6be4df97b",
     #     'COCOAPODS'        => "0.17.0"
     #   }
     #
@@ -292,11 +368,25 @@ module Pod
     def to_hash
       hash = {}
       internal_data.each do |key, value|
-        hash[key] = value unless value.empty?
+        hash[key] = value unless value.nil? || value.empty?
       end
       hash
     end
 
+    # @return [Array<String>] The order in which the hash keys should appear in
+    #         a serialized Lockfile.
+    #
+    HASH_KEY_ORDER = [
+      'PODS',
+      'DEPENDENCIES',
+      'SPEC REPOS',
+      'EXTERNAL SOURCES',
+      'CHECKOUT OPTIONS',
+      'SPEC CHECKSUMS',
+      'PODFILE CHECKSUM',
+      'COCOAPODS',
+    ].map(&:freeze).freeze
+
     # @return [String] the YAML representation of the Lockfile, used for
     #         serialization.
     #
@@ -305,20 +395,12 @@ module Pod
     # @note   The YAML string is prettified.
     #
     def to_yaml
-      keys_hint = [
-        "PODS",
-        "DEPENDENCIES",
-        "EXTERNAL SOURCES",
-        "SPEC CHECKSUMS",
-        "COCOAPODS",
-      ]
-      YAMLConverter.convert_hash(to_hash, keys_hint, "\n\n")
+      YAMLHelper.convert_hash(to_hash, HASH_KEY_ORDER, "\n\n")
     end
 
     #-------------------------------------------------------------------------#
 
     class << self
-
       # !@group Generation
 
       public
@@ -336,12 +418,15 @@ module Pod
       #
       # @return [Lockfile] a new lockfile.
       #
-      def generate(podfile, specs)
+      def generate(podfile, specs, checkout_options, spec_repos = {})
         hash = {
           'PODS'             => generate_pods_data(specs),
           'DEPENDENCIES'     => generate_dependencies_data(podfile),
+          'SPEC REPOS'       => generate_spec_repos(spec_repos),
           'EXTERNAL SOURCES' => generate_external_sources_data(podfile),
+          'CHECKOUT OPTIONS' => checkout_options,
           'SPEC CHECKSUMS'   => generate_checksums(specs),
+          'PODFILE CHECKSUM' => podfile.checksum,
           'COCOAPODS'        => CORE_VERSION,
         }
         Lockfile.new(hash)
@@ -369,22 +454,17 @@ module Pod
       #
       #
       def generate_pods_data(specs)
-        pod_and_deps = specs.map do |spec|
-          [spec.to_s, spec.all_dependencies.map(&:to_s).sort]
-        end.uniq
-
-        tmp = {}
-        pod_and_deps.each do |name, deps|
-          if tmp[name]
-            tmp[name].concat(deps).uniq!
-          else
-            tmp[name] = deps
-          end
+        pods_and_deps_merged = specs.reduce({}) do |result, spec|
+          name = spec.to_s
+          result[name] ||= []
+          result[name].concat(spec.all_dependencies.map(&:to_s))
+          result
         end
-        pod_and_deps = tmp.sort_by(&:first).map do |name, deps|
-          deps.empty? ? name : { name => deps }
+
+        pod_and_deps = pods_and_deps_merged.map do |name, deps|
+          deps.empty? ? name : { name => YAMLHelper.sorted_array(deps.uniq) }
         end
-        pod_and_deps
+        YAMLHelper.sorted_array(pod_and_deps)
       end
 
       # Generates the list of the dependencies of the Podfile.
@@ -396,7 +476,36 @@ module Pod
       # @return   [Array] the generated data.
       #
       def generate_dependencies_data(podfile)
-        podfile.dependencies.map { |d| d.to_s }.sort
+        YAMLHelper.sorted_array(podfile.dependencies.map(&:to_s))
+      end
+
+      # Generates the hash of spec repo sources used in the Podfile.
+      #
+      # @example  Output
+      #           { "https://github.com/cocoapods/cocoapods.git" => ["Alamofire", "Moya"] }
+      #
+      def generate_spec_repos(spec_repos)
+        output = Hash.new {|h, k| h[k] = Array.new(0)}
+        spec_repos.each do |source, specs|
+          next unless source
+          next if specs.empty?
+          key = source.url || source.name
+
+          # save `trunk` as 'trunk' so that the URL itself can be changed without lockfile churn
+          key = Pod::TrunkSource::TRUNK_REPO_NAME if source.name == Pod::TrunkSource::TRUNK_REPO_NAME
+
+          value = specs.map { |s| s.root.name }
+
+          if output.has_key?(key)
+            value = value + output[key]
+          end
+
+          if value.length > 0
+            output[key] = YAMLHelper.sorted_array(value.uniq)
+          end
+        end
+
+        output.compact
       end
 
       # Generates the information of the external sources.
@@ -408,10 +517,6 @@ module Pod
       #           the values store the external source hashes of each
       #           dependency.
       #
-      # @todo     The downloader should generate an external source hash that
-      #           should be store for dependencies in head mode and for those
-      #           with external source.
-      #
       def generate_external_sources_data(podfile)
         deps = podfile.dependencies.select(&:external?)
         deps = deps.sort { |d, other| d.name <=> other.name }
@@ -434,7 +539,7 @@ module Pod
       #
       def generate_checksums(specs)
         checksums = {}
-        specs.select { |spec| !spec.defined_in_file.nil? }.each do |spec|
+        specs.select(&:defined_in_file).each do |spec|
           checksums[spec.root.name] = spec.checksum
         end
         checksums

data/lib/cocoapods-core/metrics.rb

@@ -0,0 +1,47 @@
+module Pod
+  # Allows to access metrics about pods.
+  #
+  # This class is stored in Core because it might be used by web services.
+  #
+  module Metrics
+    # Returns the metrics of a pod.
+    #
+    # @param  [String] name
+    #         The name of the pod.
+    #
+    # @return [Hash] The metrics for the pod.
+    #
+    def self.pod(name)
+      peform_request("http://metrics.cocoapods.org/api/v1/pods/#{name}")
+    end
+
+    private
+
+    # @!group Private helpers
+    #-------------------------------------------------------------------------#
+
+    # Performs a get request with the given URL.
+    #
+    # @param [String] url
+    #        The URL of the resource.
+    #
+    # @return [Array, Hash] The information of the resource as Ruby objects.
+    #
+    def self.peform_request(url)
+      require 'rest'
+      require 'json'
+      headers = { 'User-Agent' => "CocoaPods #{Pod::CORE_VERSION}" }
+      response = REST.get(url, headers)
+      body = JSON.parse(response.body)
+      if response.ok?
+        body
+      else
+        CoreUI.warn "Request to #{url} failed - #{response.status_code}"
+        CoreUI.warn body['message']
+        nil
+      end
+    end
+
+    #-------------------------------------------------------------------------#
+  end
+end

data/lib/cocoapods-core/platform.rb

@@ -1,14 +1,11 @@
 module Pod
-
   # A Platform describes an SDK name and deployment target.
   #
   class Platform
-
     # @return [Symbol, String] the name of the SDK represented by the platform.
     #
-    def name
-      @symbolic_name
-    end
+    attr_reader :symbolic_name
+    alias_method :name, :symbolic_name
 
     # @return [Version] the deployment target of the platform.
     #
@@ -48,7 +45,19 @@ module Pod
         @symbolic_name = input.name
         @deployment_target = input.deployment_target
       else
-        @symbolic_name = input.to_sym
+        input = input.to_s.downcase
+
+        name = case input
+               when 'macos'
+                 # Allow `Platform.new('macos')` to be equivalent to `Platform.macos`
+                 'osx'
+               when 'xros'
+                 # Compatibility with older references to 'xrOS'
+                 'visionos'
+               else
+                 input
+               end
+        @symbolic_name = name.to_sym
         target = target[:deployment_target] if target.is_a?(Hash)
         @deployment_target = Version.create(target)
       end
@@ -70,6 +79,46 @@ module Pod
       new :osx
     end
 
+    # Convenience method to initialize a macOS platform.
+    #
+    # @return [Platform] a macOS platform.
+    #
+    def self.macos
+      osx
+    end
+
+    # Convenience method to initialize a tvOS platform.
+    #
+    # @return [Platform] a tvOS platform.
+    #
+    def self.tvos
+      new :tvos
+    end
+
+    # Convenience method to initialize a visionOS platform.
+    #
+    # @return [Platform] a visionOS platform.
+    #
+    def self.visionos
+      new :visionos
+    end
+
+    # Convenience method to initialize a watchOS platform.
+    #
+    # @return [Platform] a watchOS platform.
+    #
+    def self.watchos
+      new :watchos
+    end
+
+    # Convenience method to get all available platforms.
+    #
+    # @return [Array<Platform>] list of platforms.
+    #
+    def self.all
+      [ios, osx, watchos, visionos, tvos]
+    end
+
     # Checks if a platform is equivalent to another one or to a symbol
     # representation.
     #
@@ -89,13 +138,25 @@ module Pod
       end
     end
 
+    # (see #==)
+    alias_method :eql?, :==
+
+    # Hashes the instance by the platform name and deployment target.
+    #
+    # This adds support to make instances usable as Hash keys.
+    #
+    # @!visibility private
+    def hash
+      name.hash ^ deployment_target.hash
+    end
+
     # Checks whether a platform supports another one.
     #
     # In the context of operating system SDKs, a platform supports another
     # one if they have the same name and the other platform has a minor or
     # equal deployment target.
     #
-    # @return [Bool] whether the platform supports another platform.
+    # @return [Boolean] whether the platform supports another platform.
     #
     def supports?(other)
       other = Platform.new(other)
@@ -146,17 +207,40 @@ module Pod
       end
     end
 
-    # @return [Bool] whether the platform requires legacy architectures for
+    # @return [Boolean] whether the platform requires legacy architectures for
     #         iOS.
     #
     def requires_legacy_ios_archs?
       if name == :ios
-        deployment_target && (deployment_target < Version.new("4.3"))
+        deployment_target && (deployment_target < Version.new('4.3'))
       else
         false
       end
     end
 
+    # @return [Boolean] whether the platform supports dynamic frameworks.
+    #
+    def supports_dynamic_frameworks?
+      if name == :ios
+        deployment_target && (deployment_target >= Version.new(8.0))
+      else
+        true
+      end
+    end
+
+    # @return [String] The string that describes the #symbolic_name.
+    #
+    def string_name
+      self.class.string_name(symbolic_name)
+    end
+
+    # @return [String] The string that describes the #symbolic_name,
+    #         which doesn't contain spaces and is so safe to use in
+    #         paths which might not be quoted or escaped consequently.
+    def safe_string_name
+      string_name.tr(' ', '')
+    end
+
     # Converts the symbolic name of a platform to a string name suitable to be
     # presented to the user.
     #
@@ -168,8 +252,12 @@ module Pod
     def self.string_name(symbolic_name)
       case symbolic_name
       when :ios then 'iOS'
-      when :osx then 'OS X'
-      else symbolic_name.to_s end
+      when :osx then 'macOS'
+      when :watchos then 'watchOS'
+      when :tvos then 'tvOS'
+      when :visionos then 'visionOS'
+      else symbolic_name.to_s
+      end
     end
   end
 end