cocoapods-core 0.30.0 → 1.15.2

data/lib/cocoapods-core/specification/root_attribute_accessors.rb

@@ -1,17 +1,15 @@
 module Pod
   class Specification
     module DSL
-
       # Provides the accessors methods for the root attributes. Root attributes
       # do not support multi-platform values and inheritance.
       #
       module RootAttributesAccessors
-
         # @return [String] The name of the specification *not* including the
         #         names of the parents, in case of ‘sub-specifications’.
         #
         def base_name
-          attributes_hash["name"]
+          attributes_hash['name']
         end
 
         # @return [String] The name of the specification including the names of
@@ -21,21 +19,49 @@ module Pod
           parent ? "#{parent.name}/#{base_name}" : base_name
         end
 
-        # @return [Version] The version of the Pod.
+        # @return [Bool, String, Array<String>] The requires_arc value.
         #
-        # @todo   The version is memoized because the Resolvers sets the head
-        #         state on it. This information should be stored in the
-        #         specification instance and the lockfile should have a more
-        #         robust handling of head versions (like a dedicated section).
+        def requires_arc
+          attributes_hash['requires_arc']
+        end
+
+        # @return [Version] The version of the Pod.
         #
         def version
           if root?
-            @version ||= Version.new(attributes_hash["version"])
+            @version ||= Version.new(attributes_hash['version'])
           else
             @version ||= root.version
           end
         end
 
+        # @deprecated in favor of #swift_versions
+        #
+        # @return [Version] The Swift version specified by the specification.
+        #
+        def swift_version
+          swift_versions.last
+        end
+
+        # @return [Array<Version>] The Swift versions supported by the specification.
+        #
+        def swift_versions
+          @swift_versions ||= begin
+            swift_versions = Array(attributes_hash['swift_versions']).dup
+            # Pre 1.7.0, the DSL was singularized as it supported only a single version of Swift. In 1.7.0 the DSL
+            # is now pluralized always and a specification can support multiple versions of Swift. This ensures
+            # we parse the old JSON serialized format and include it as part of the Swift versions supported.
+            swift_versions << attributes_hash['swift_version'] unless attributes_hash['swift_version'].nil?
+            swift_versions.map { |swift_version| Version.new(swift_version) }.uniq.sort
+          end
+        end
+
+        # @return [Requirement] The CocoaPods version required to use the specification.
+        #
+        def cocoapods_version
+          @cocoapods_version ||= Requirement.create(attributes_hash['cocoapods_version'])
+        end
+
         # @return [Hash] a hash containing the authors as the keys and their
         #         email address as the values.
         #
@@ -49,7 +75,7 @@ module Pod
         #   'Author'
         #
         def authors
-          authors = attributes_hash["authors"]
+          authors = attributes_hash['authors']
           if authors.is_a?(Hash)
             authors
           elsif authors.is_a?(Array)
@@ -70,13 +96,19 @@ module Pod
         # @return [String] The social media URL.
         #
         def social_media_url
-          attributes_hash["social_media_url"]
+          attributes_hash['social_media_url']
         end
 
-        # @return [String] The docset URL.
+        # @return [String] The readme.
         #
-        def docset_url
-          attributes_hash["docset_url"]
+        def readme
+          attributes_hash['readme']
+        end
+
+        # @return [String] The changelog.
+        #
+        def changelog
+          attributes_hash['changelog']
         end
 
         # @return [Hash] A hash containing the license information of the Pod.
@@ -84,11 +116,11 @@ module Pod
         # @note   The indentation is stripped from the license text.
         #
         def license
-          license = attributes_hash["license"]
+          license = attributes_hash['license']
           if license.is_a?(String)
             { :type => license }
           elsif license.is_a?(Hash)
-            license = convert_keys_to_symbol(license)
+            license = Specification.convert_keys_to_symbol(license)
             license[:text] = license[:text].strip_heredoc if license[:text]
             license
           else
@@ -99,20 +131,26 @@ module Pod
         # @return [String] The URL of the homepage of the Pod.
         #
         def homepage
-          attributes_hash["homepage"]
+          attributes_hash['homepage']
         end
 
         # @return [Hash{Symbol=>String}] The location from where the library
         #         should be retrieved.
         #
         def source
-          convert_keys_to_symbol(attributes_hash["source"])
+          value = attributes_hash['source']
+          if value && value.is_a?(Hash)
+            Specification.convert_keys_to_symbol(value)
+          else
+            value
+          end
         end
 
         # @return [String] A short description of the Pod.
         #
         def summary
-          attributes_hash["summary"]
+          summary = attributes_hash['summary']
+          summary.strip_heredoc.chomp if summary
         end
 
         # @return [String] A longer description of the Pod.
@@ -120,8 +158,8 @@ module Pod
         # @note   The indentation is stripped from the description.
         #
         def description
-          description = attributes_hash["description"]
-          description.strip_heredoc if description
+          description = attributes_hash['description']
+          description.strip_heredoc.chomp if description
         end
 
         # @return [Array<String>] The list of the URL for the screenshots of
@@ -130,45 +168,58 @@ module Pod
         # @note   The value is coerced to an array.
         #
         def screenshots
-          value = attributes_hash["screenshots"]
+          value = attributes_hash['screenshots']
           [*value]
         end
 
         # @return [String, Nil] The documentation URL of the Pod if specified.
         #
         def documentation_url
-          attributes_hash["documentation_url"]
+          attributes_hash['documentation_url']
         end
 
         # @return [String, Nil] The prepare command of the Pod if specified.
         #
         def prepare_command
-          attributes_hash["prepare_command"]
+          command = attributes_hash['prepare_command']
+          command.strip_heredoc.chomp if command
         end
 
-        #---------------------------------------------------------------------#
+        # @return [Boolean] Indicates, that if use_frameworks! is specified, the
+        #         framework should include a static library.
+        #
+        def static_framework
+          attributes_hash['static_framework']
+        end
 
-        private
+        # @return [Boolean] Whether the Pod has been deprecated.
+        #
+        def deprecated
+          attributes_hash['deprecated']
+        end
 
-        # Converts the keys of the given hash to a string.
+        # @return [String] The name of the Pod that this one has been
+        #         deprecated in favor of.
         #
-        # @param  [Object] value
-        #         the value that needs to be stripped from the Symbols.
+        def deprecated_in_favor_of
+          attributes_hash['deprecated_in_favor_of']
+        end
+
+        # @return [Boolean] Wether the pod is deprecated either in favor of some other
+        #         pod or simply deprecated.
         #
-        # @return [Hash] the hash with the strings instead of the keys.
+        def deprecated?
+          deprecated || !deprecated_in_favor_of.nil?
+        end
+
+        # @return [String, Nil] The custom module map file of the Pod,
+        #         if specified.
         #
-        def convert_keys_to_symbol(value)
-          return unless value
-          result = {}
-          value.each do |key, subvalue|
-            subvalue = convert_keys_to_symbol(subvalue) if subvalue.is_a?(Hash)
-            result[key.to_sym] = subvalue
-          end
-          result
+        def module_map
+          attributes_hash['module_map']
         end
 
         #---------------------------------------------------------------------#
-
       end
     end
   end

data/lib/cocoapods-core/specification/set/presenter.rb

@@ -3,25 +3,18 @@ require 'active_support/core_ext/array/conversions'
 module Pod
   class Specification
     class Set
-
       # Provides support for presenting a Pod described by a {Set} in a
       # consistent way across clients of CocoaPods-Core.
       #
       class Presenter
-
         # @return [Set] the set that should be presented.
         #
         attr_reader :set
 
-        # @return [Statistics] The statistics provider.
-        #
-        attr_reader :statistics_provider
-
         # @param  [Set] set @see #set.
         #
-        def initialize(set, statistics_provider = nil)
+        def initialize(set)
           @set = set
-          @statistics_provider = statistics_provider || Statistics.instance
         end
 
         #---------------------------------------------------------------------#
@@ -44,7 +37,7 @@ module Pod
         #           order.
         #
         def versions
-          @set.versions.sort.reverse
+          @set.versions
         end
 
         # @return   [String] all the versions available sorted from the highest
@@ -56,7 +49,7 @@ module Pod
         #
         # @note     This method orders the sources by name.
         #
-        def verions_by_source
+        def versions_by_source
           result = []
           versions_by_source = @set.versions_by_source
           @set.sources.sort.each do |source|
@@ -92,17 +85,9 @@ module Pod
         #
         #           "Author 1, Author 2 and Author 3"
         #
-        # @note     In ruby 1.8.7 the authors are sorted by name because the
-        #           hash doesn't preserve the order in which they are defined
-        #           in the podspec.
-        #
         def authors
           return '' unless spec.authors
-          if RUBY_VERSION == '1.8.7'
-            spec.authors.keys.sort.to_sentence
-          else
-            spec.authors.keys.to_sentence
-          end
+          spec.authors.keys.to_sentence
         end
 
         # @return [String] the homepage of the pod.
@@ -125,6 +110,28 @@ module Pod
           spec.description || spec.summary
         end
 
+        # @return [String] A string that describes the deprecation of the pod.
+        #         If the pod is deprecated in favor of another pod it will contain
+        #         information about that. If the pod is not deprecated returns nil.
+        #
+        # @example Output example
+        #
+        #          "[DEPRECATED]"
+        #          "[DEPRECATED in favor of NewAwesomePod]"
+        #
+        def deprecation_description
+          if spec.deprecated?
+            description = '[DEPRECATED'
+            description += if spec.deprecated_in_favor_of.nil?
+                             ']'
+                           else
+                             " in favor of #{spec.deprecated_in_favor_of}]"
+                           end
+
+            description
+          end
+        end
+
         # @return [String] the URL of the source of the Pod.
         #
         def source_url
@@ -167,72 +174,29 @@ module Pod
 
         # @!group Statistics
 
-        # @return [Time] the creation date of the first known `podspec` of the
-        #         Pod.
-        #
-        def creation_date
-          statistics_provider.creation_date(@set)
-        end
-
         # @return [Integer] the GitHub likes of the repo of the Pod.
         #
-        def github_watchers
-          statistics_provider.github_watchers(@set)
+        def github_stargazers
+          github_metrics['stargazers']
         end
 
         # @return [Integer] the GitHub forks of the repo of the Pod.
         #
         def github_forks
-          statistics_provider.github_forks(@set)
-        end
-
-        # @return [String] the relative time of the last push of the repo the Pod.
-        #
-        def github_last_activity
-          distance_from_now_in_words(statistics_provider.github_pushed_at(@set))
+          github_metrics['forks']
         end
 
         #---------------------------------------------------------------------#
 
-        private
-
-        # Computes a human readable string that represents a past date in
-        # relative terms.
-        #
-        # @param    [Time, String] from_time
-        #           the date that should be represented.
-        #
-        # @example  Possible outputs
-        #
-        #           "less than a week ago"
-        #           "15 days ago"
-        #           "3 month ago"
-        #           "more than a year ago"
-        #
-        # @return   [String] a string that represents a past date.
-        #
-        def distance_from_now_in_words(from_time)
-          return nil unless from_time
-          from_time = Time.parse(from_time) unless from_time.is_a?(Time)
-          to_time = Time.now
-          distance_in_days = (((to_time - from_time).abs) / 60 / 60 / 24).round
+        # @!group Private Helpers
 
-          case distance_in_days
-          when 0..7
-            "less than a week ago"
-          when 8..29
-            "#{distance_in_days} days ago"
-          when 30..45
-            "1 month ago"
-          when 46..365
-            "#{(distance_in_days.to_f / 30).round} months ago"
-          else
-            "more than a year ago"
-          end
+        def metrics
+          @metrics ||= Metrics.pod(name) || {}
         end
 
-        #---------------------------------------------------------------------#
-
+        def github_metrics
+          metrics['github'] || {}
+        end
       end
     end
   end

data/lib/cocoapods-core/specification/set.rb

@@ -1,22 +1,19 @@
 require 'active_support/core_ext/array/conversions'
 require 'cocoapods-core/specification/set/presenter'
-require 'cocoapods-core/specification/set/statistics'
 
 module Pod
   class Specification
-
     # A Specification::Set is responsible of handling all the specifications of
     # a Pod. This class stores the information of the dependencies that required
     # a Pod in the resolution process.
     #
-    # @note   The alphabetical order of the sets is used to select a
+    # @note   The order in which the sets are provided is used to select a
     #         specification if multiple are available for a given version.
     #
     # @note   The set class is not and should be not aware of the backing store
     #         of a Source.
     #
     class Set
-
       # @return [String] the name of the Pod.
       #
       attr_reader :name
@@ -33,104 +30,49 @@ module Pod
       #         the sources that contain a Pod.
       #
       def initialize(name, sources = [])
-        @name    = name
-        sources  = sources.is_a?(Array) ? sources : [sources]
-        @sources = sources.sort_by(&:name)
-        @dependencies_by_requirer_name = {}
-        @dependencies = []
-      end
-
-      # Stores a dependency on the Pod.
-      #
-      # @param  [Dependency] dependency
-      #         a dependency that requires the Pod.
-      #
-      # @param  [String] dependent_name
-      #         the name of the owner of the dependency.  It is used only to
-      #         display the Pod::Informative.
-      #
-      # @raise  If the versions requirement of the dependency are not
-      #         compatible with the previously stored dependencies.
-      #
-      # @todo   This should simply return a boolean. Is CocoaPods that should
-      #         raise.
-      #
-      # @return [void]
-      #
-      def required_by(dependency, dependent_name)
-        dependencies_by_requirer_name[dependent_name] ||= []
-        dependencies_by_requirer_name[dependent_name] << dependency
-        dependencies << dependency
-
-        if acceptable_versions.empty?
-          message = "Unable to satisfy the following requirements:\n"
-          dependencies_by_requirer_name.each do |name, dependencies|
-            dependencies.each do |dep|
-              message << "- `#{dep}` required by `#{name}`"
-            end
-          end
-          raise Informative, message
-        end
-      end
-
-      # @return [Dependency] A dependency that includes all the versions
-      #         requirements of the stored dependencies.
-      #
-      def dependency
-        dependencies.reduce(Dependency.new(name)) do |previous, dependency|
-          previous.merge(dependency.to_root_dependency)
-        end
+        @name = name
+        @sources = Array(sources)
       end
 
       # @return [Specification] the top level specification of the Pod for the
       #         {#required_version}.
       #
       # @note   If multiple sources have a specification for the
-      #         {#required_version} The alphabetical order of their names is
-      #         used to disambiguate.
+      #         {#required_version}, the order in which they are provided
+      #         is used to disambiguate.
       #
       def specification
-        path = specification_path_for_version(required_version)
-        Specification.from_file(path)
-      end
-
-      # TODO
-      #
-      def specification_path_for_version(version)
-        sources = []
-        versions_by_source.each do |source, source_versions|
-          sources << source if source_versions.include?(required_version)
+        unless highest_version_spec_path
+          raise Informative, "Could not find the highest version for `#{name}`. "\
+                             "This could be due to an empty #{name} directory in a local repository."
         end
-        source = sources.sort_by(&:name).first
-        source.specification_path(name, required_version)
+
+        Specification.from_file(highest_version_spec_path)
       end
 
-      # @return [Version] the highest version that satisfies the stored
-      #         dependencies.
-      #
-      # @todo   This should simply return nil. CocoaPods should raise instead.
+      # @return [Specification] the top level specification for this set for any version.
       #
-      def required_version
-        version = versions.find { |v| dependency.match?(name, v) }
-        unless version
-          raise Informative, "Required version (#{dependency}) not found " \
-            "for `#{name}`.\nAvailable versions: #{versions.join(', ')}"
+      def specification_name
+        versions_by_source.each do |source, versions|
+          next unless version = versions.first
+          return source.specification(name, version).name
         end
-        version
+        nil
       end
 
-      # @return [Array<Version>] All the versions which are acceptable given
-      #         the requirements.
+      # @return [Array<String>] the paths to specifications for the given
+      #         version
       #
-      def acceptable_versions
-        versions.select { |v| dependency.match?(name, v) }
+      def specification_paths_for_version(version)
+        sources = @sources.select { |source| versions_by_source[source].include?(version) }
+        sources.map { |source| source.specification_path(name, version) }
       end
 
       # @return [Array<Version>] all the available versions for the Pod, sorted
       #         from highest to lowest.
       #
       def versions
-        versions_by_source.values.flatten.uniq.sort.reverse
+        @versions ||= versions_by_source.values.flatten.uniq.sort.reverse
       end
 
       # @return [Version] The highest version known of the specification.
@@ -141,19 +83,21 @@ module Pod
 
       # @return [Pathname] The path of the highest version.
       #
+      # @note   If multiple sources have a specification for the
+      #         {#required_version}, the order in which they are provided
+      #         is used to disambiguate.
+      #
       def highest_version_spec_path
-        specification_path_for_version(highest_version)
+        @highest_version_spec_path ||= specification_paths_for_version(highest_version).first
       end
 
       # @return [Hash{Source => Version}] all the available versions for the
       #         Pod grouped by source.
       #
       def versions_by_source
-        result = {}
-        sources.each do |source|
+        @versions_by_source ||= sources.each_with_object({}) do |source, result|
           result[source] = source.versions(name)
         end
-        result
       end
 
       def ==(other)
@@ -163,8 +107,7 @@ module Pod
       end
 
       def to_s
-        "#<#{self.class.name} for `#{name}' with required version " \
-          "`#{required_version}' available at `#{sources.map(&:name) * ', '}'>"
+        "#<#{self.class.name} for `#{name}' available at `#{sources.map(&:name).join(', ')}'>"
       end
       alias_method :inspect, :to_s
 
@@ -194,11 +137,6 @@ module Pod
 
       #-----------------------------------------------------------------------#
 
-      attr_accessor :dependencies_by_requirer_name
-      attr_accessor :dependencies
-
-      #-----------------------------------------------------------------------#
-
       # The Set::External class handles Pods from external sources. Pods from
       # external sources don't use the {Source} and are initialized by a given
       # specification.
@@ -206,7 +144,6 @@ module Pod
       # @note External sources *don't* support subspecs.
       #
       class External < Set
-
         attr_reader :specification
 
         def initialize(spec)
@@ -218,14 +155,23 @@ module Pod
           self.class == other.class && specification == other.specification
         end
 
-        def specification_path
-          raise StandardError, "specification_path"
-        end
-
         def versions
           [specification.version]
         end
       end
+
+      #-----------------------------------------------------------------------#
+
+      # The Set::Head class handles Pods in head mode. Pods in head
+      # mode don't use the {Source} and are initialized by a given
+      # specification.
+      #
+      class Head < External
+        def initialize(spec)
+          super
+          specification.version.head = true
+        end
+      end
     end
   end
 end