cocoapods-square-stable 0.19.3

data/lib/cocoapods/sources_manager.rb

@@ -0,0 +1,276 @@
+module Pod
+
+  # Manages all the sources known to the running CocoaPods Instance.
+  #
+  class SourcesManager
+
+    class << self
+
+      include Config::Mixin
+
+      # @return [Source::Aggregate] the aggregate of all the sources known to
+      #         this installation of CocoaPods.
+      #
+      def aggregate
+        Source::Aggregate.new(config.repos_dir)
+      end
+
+      # @return [Array<Source>] the list of all the sources known to this
+      #         installation of CocoaPods.
+      #
+      def all
+        aggregate.all
+      end
+
+      # @return [Array<Specification::Set>] the list of all the specification
+      #         sets know to this installation of CocoaPods.
+      #
+      def all_sets
+        aggregate.all_sets
+      end
+
+      # Search all the sources to match the set for the given dependency.
+      #
+      # @return [Set, nil] a set for a given dependency including all the
+      #         {Source} that contain the Pod. If no sources containing the
+      #         Pod where found it returns nil.
+      #
+      # @raise  If no source including the set can be found.
+      #
+      def search(dependency)
+        aggregate.search(dependency)
+      end
+
+      # Search all the sources with the given search term.
+      #
+      # @param  [String] query
+      #         The search term.
+      #
+      # @param  [Bool] full_text_search
+      #         Whether the search should be limited to the name of the Pod or
+      #         should include also the author, the summary, and the
+      #         description.
+      #
+      # @raise  If no source including the set can be found.
+      #
+      # @note   Full text search requires to load the specification for each
+      #         pod, hence is considerably slower.
+      #
+      # @return [Array<Set>]  The sets that contain the search term.
+      #
+      def search_by_name(query, full_text_search = false)
+        if full_text_search
+          set_names = []
+          updated_search_index.each do |name, set_data|
+            text = name.dup
+            if full_text_search
+              text << set_data['authors'].to_s if set_data['authors']
+              text << set_data['summary']      if set_data['summary']
+              text << set_data['description']  if set_data['description']
+            end
+            set_names << name if text.downcase.include?(query.downcase)
+          end
+          sets = set_names.sort.map { |name| aggregate.represenative_set(name) }
+        else
+          sets = aggregate.search_by_name(query, false)
+        end
+        if sets.empty?
+          extra = ", author, summary, or description" if full_text_search
+          raise Informative, "Unable to find a pod with name#{extra} matching `#{query}`"
+        end
+        sets
+      end
+
+      # Creates or updates the search data and returns it. The search data
+      # groups by name the following information for each set:
+      #
+      #   - version
+      #   - summary
+      #   - description
+      #   - authors
+      #
+      # @note   This operation is fairly expensive, because of the YAML
+      #         conversion.
+      #
+      # @return [Hash{String => String}] The up to date search data.
+      #
+      def updated_search_index
+        unless @updated_search_index
+          if search_index_path.exist?
+            stored_index = YAML.load(search_index_path.read)
+            if stored_index && stored_index.is_a?(Hash)
+              search_index = aggregate.update_search_index(stored_index)
+            else
+              search_index = aggregate.generate_search_index
+            end
+          else
+            search_index = aggregate.generate_search_index
+          end
+
+          File.open(search_index_path, 'w') {|f| f.write(search_index.to_yaml) }
+          @updated_search_index = search_index
+        end
+        @updated_search_index
+      end
+
+      # Allows to clear the search index.
+      #
+      attr_writer :updated_search_index
+
+      # @return [Pathname] The path where the search index should be stored.
+      #
+      def search_index_path
+        CACHE_ROOT + 'search_index.yaml'
+      end
+
+      public
+
+      # @!group Updating Sources
+      #-----------------------------------------------------------------------#
+
+      extend Executable
+      executable :git
+
+      # 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
+      #
+      # @return [void]
+      #
+      def update(source_name = nil, show_output = false)
+        if source_name
+          specified_source = aggregate.all.find { |s| s.name == source_name }
+          raise Informative, "Unable to find the `#{source_name}` repo."    unless specified_source
+          raise Informative, "The `#{source_name}` repo is not a git repo." unless git_repo?(specified_source.repo)
+          sources = [specified_source]
+        else
+          sources = aggregate.all.select { |source| git_repo?(source.repo) }
+        end
+
+        sources.each do |source|
+          UI.section "Updating spec repo `#{source.name}`" do
+            Dir.chdir(source.repo) do
+              output = git!("pull")
+              UI.puts output if show_output && !config.verbose?
+            end
+            check_version_information(source.repo)
+          end
+        end
+      end
+
+      # Returns whether a source is a GIT repo.
+      #
+      # @param  [Pathname] dir
+      #         The directory where the source is stored.
+      #
+      # @return [Bool] Wether the given source is a GIT repo.
+      #
+      def git_repo?(dir)
+        Dir.chdir(dir) { `git rev-parse  >/dev/null 2>&1` }
+        $?.exitstatus.zero?
+      end
+
+      # Checks the version information of the source with the given directory.
+      # It raises if the source is not compatible and if there is CocoaPods
+      # update it informs the user.
+      #
+      # @param  [Pathname] dir
+      #         The directory where the source is stored.
+      #
+      # @raise  If the source is not compatible.
+      #
+      # @return [void]
+      #
+      def check_version_information(dir)
+        versions = version_information(dir)
+        unless repo_compatible?(dir)
+          min, max = versions['min'], versions['max']
+          version_msg = ( min == max ) ? min : "#{min} - #{max}"
+          raise Informative, "The `#{dir.basename}` repo requires " \
+          "CocoaPods #{version_msg}\n".red +
+          "Update CocoaPods, or checkout the appropriate tag in the repo."
+        end
+
+        if config.new_version_message? && cocoapods_update?(versions)
+          UI.puts "\nCocoaPods #{versions['last']} is available.\n".green
+        end
+      end
+
+      # Returns whether a source is compatible with the current version of
+      # CocoaPods.
+      #
+      # @param  [Pathname] dir
+      #         The directory where the source is stored.
+      #
+      # @return [Bool] whether the source is compatible.
+      #
+      def repo_compatible?(dir)
+        versions = version_information(dir)
+
+        min, max = versions['min'], versions['max']
+        bin_version  = Gem::Version.new(Pod::VERSION)
+        supports_min = !min || bin_version >= Gem::Version.new(min)
+        supports_max = !max || bin_version <= Gem::Version.new(max)
+        supports_min && supports_max
+      end
+
+      # Checks whether there is a CocoaPods given the version information of a
+      # repo.
+      #
+      # @param  [Hash] version_information
+      #         The version information of a repository.
+      #
+      # @return [Bool] whether there is an update.
+      #
+      def cocoapods_update?(version_information)
+        version = version_information['last']
+        version && Gem::Version.new(version) > Gem::Version.new(Pod::VERSION)
+      end
+
+      # Returns the contents of the `CocoaPods-version.yml` file, which stores
+      # information about CocoaPods versions.
+      #
+      # This file is a hash with the following keys:
+      #
+      # - last: the last version of CocoaPods known to the source.
+      # - min: the minimum version of CocoaPods supported by the source.
+      # - max: the maximum version of CocoaPods supported by the source.
+      #
+      # @param  [Pathname] dir
+      #         The directory where the source is stored.
+      #
+      # @return [Hash] the versions information from the repo.
+      #
+      def version_information(dir)
+        require 'yaml'
+        yaml_file  = dir + 'CocoaPods-version.yml'
+        yaml_file.exist? ? YAML.load_file(yaml_file) : {}
+      end
+
+      public
+
+      # @!group Master repo
+      #-----------------------------------------------------------------------#
+
+      # @return [Pathname] The path of the master repo.
+      #
+      def master_repo_dir
+        config.repos_dir + 'master'
+      end
+
+      # @return [Bool] Checks if the master repo is usable.
+      #
+      # @note   Note this is used to automatically setup the master repo if
+      #         needed.
+      #
+      def master_repo_functional?
+        master_repo_dir.exist? && repo_compatible?(master_repo_dir)
+      end
+
+      #-----------------------------------------------------------------------#
+
+    end
+  end
+end
+

data/lib/cocoapods/user_interface.rb

@@ -0,0 +1,304 @@
+require 'cocoapods/user_interface/error_report'
+
+module Pod
+
+  # Provides support for UI output. It provides support for nested sections of
+  # information and for a verbose mode.
+  #
+  module UserInterface
+
+    require 'colored'
+
+    @title_colors      =  %w|yellow green|
+    @title_level       =  0
+    @indentation_level =  2
+    @treat_titles_as_messages = false
+    @warnings = []
+
+    class << self
+
+      include Config::Mixin
+
+      attr_accessor :indentation_level
+      attr_accessor :title_level
+      attr_accessor :warnings
+
+      # @return [Bool] Whether the wrapping of the strings to the width of the
+      #         terminal should be disabled.
+      #
+      attr_accessor :disable_wrap
+      alias_method  :disable_wrap?, :disable_wrap
+
+      # Prints a title taking an optional verbose prefix and
+      # a relative indentation valid for the UI action in the passed
+      # block.
+      #
+      # In verbose mode titles are printed with a color according
+      # to their level. In normal mode titles are printed only if
+      # they have nesting level smaller than 2.
+      #
+      # @todo Refactor to title (for always visible titles like search)
+      #       and sections (titles that represent collapsible sections).
+      #
+      def section(title, verbose_prefix = '', relative_indentation = 0)
+        if config.verbose?
+          title(title, verbose_prefix, relative_indentation)
+        elsif title_level < 1
+          puts title
+        end
+
+        self.indentation_level += relative_indentation
+        self.title_level += 1
+        yield if block_given?
+        self.indentation_level -= relative_indentation
+        self.title_level -= 1
+      end
+
+      # In verbose mode it shows the sections and the contents.
+      # In normal mode it just prints the title.
+      #
+      # @return [void]
+      #
+      def titled_section(title, options = {})
+        relative_indentation = options[:relative_indentation] || 0
+        verbose_prefix = options[:verbose_prefix] || ''
+        if config.verbose?
+          title(title, verbose_prefix, relative_indentation)
+        else
+          puts title
+        end
+
+        self.indentation_level += relative_indentation
+        self.title_level += 1
+        yield if block_given?
+        self.indentation_level -= relative_indentation
+        self.title_level -= 1
+      end
+
+      # A title opposed to a section is always visible
+      #
+      def title(title, verbose_prefix = '', relative_indentation = 2)
+        if(@treat_titles_as_messages)
+          message(title, verbose_prefix)
+        else
+          title = verbose_prefix + title if config.verbose?
+          title = "\n#{title}" if @title_level < 2
+          if (color = @title_colors[@title_level])
+            title = title.send(color)
+          end
+          puts "#{title}"
+        end
+
+        self.indentation_level += relative_indentation
+        self.title_level += 1
+        yield if block_given?
+        self.indentation_level -= relative_indentation
+        self.title_level -= 1
+      end
+
+      # def title(title, verbose_prefix = '', relative_indentation = 2)
+      # end
+
+      # Prints a verbose message taking an optional verbose prefix and
+      # a relative indentation valid for the UI action in the passed
+      # block.
+      #
+      # @todo Clean interface.
+      #
+      def message(message, verbose_prefix = '', relative_indentation = 2)
+        message = verbose_prefix + message if config.verbose?
+        puts_indented message if config.verbose?
+
+        self.indentation_level += relative_indentation
+        yield if block_given?
+        self.indentation_level -= relative_indentation
+      end
+
+      # Prints an info to the user. The info is always displayed.
+      # It respects the current indentation level only in verbose
+      # mode.
+      #
+      # Any title printed in the optional block is treated as a message.
+      #
+      def info(message)
+        indentation = config.verbose? ? self.indentation_level : 0
+        indented = wrap_string(message, " " * indentation)
+        puts(indented)
+
+        self.indentation_level += 2
+        @treat_titles_as_messages = true
+        yield if block_given?
+        @treat_titles_as_messages = false
+        self.indentation_level -= 2
+      end
+
+      # Prints an important message to the user.
+      #
+      # @param [String] message The message to print.
+      #
+      # return [void]
+      #
+      def notice(message)
+        puts("\n[!] #{message}".green)
+      end
+
+      # Returns a string containing relative location of a path from the Podfile.
+      # The returned path is quoted. If the argument is nit it returns the
+      # empty string.
+      #
+      def path(pathname)
+        if pathname
+          path = pathname.relative_path_from(config.podfile_path.dirname || Pathname.pwd)
+          "`#{path}`"
+        else
+          ''
+        end
+      end
+
+      # Prints the textual representation of a given set.
+      #
+      def pod(set, mode = :normal, statistics_provider = nil)
+        if mode == :name
+          puts_indented set.name
+        else
+          pod = Specification::Set::Presenter.new(set, statistics_provider)
+          title("\n-> #{pod.name} (#{pod.version})".green, '', 1) do
+            puts_indented pod.summary
+            labeled('Homepage', pod.homepage)
+            labeled('Source',   pod.source_url)
+            labeled('Versions', pod.verions_by_source)
+            if mode == :stats
+              labeled('Pushed',   pod.github_last_activity)
+              labeled('Authors',  pod.authors) if pod.authors =~ /,/
+              labeled('Author',   pod.authors) if pod.authors !~ /,/
+              labeled('License',  pod.license)
+              labeled('Platform', pod.platform)
+              labeled('Watchers', pod.github_watchers)
+              labeled('Forks',    pod.github_forks)
+            end
+            labeled('Sub specs', pod.subspecs)
+          end
+        end
+      end
+
+      # Prints a message with a label.
+      #
+      def labeled(label, value)
+        if value
+          ''.tap do |t|
+            t << "    - #{label}:".ljust(16)
+            if value.is_a?(Array)
+              separator = "\n  - "
+              puts_indented t << separator << value.join(separator)
+            else
+              puts_indented t << value.to_s << "\n"
+            end
+          end
+        end
+      end
+
+      # Prints a message respecting the current indentation level and
+      # wrapping it to the terminal width if necessary.
+      #
+      def puts_indented(message = '')
+        indented = wrap_string(message, " " * self.indentation_level)
+        puts(indented)
+      end
+
+      # Prints the stored warnings. This method is intended to be called at the
+      # end of the execution of the binary.
+      #
+      # @return [void]
+      #
+      def print_warnings
+        STDOUT.flush
+        warnings.each do |warning|
+          next if warning[:verbose_only] && !config.verbose?
+          STDERR.puts("\n[!] #{warning[:message]}".yellow)
+          warning[:actions].each do |action|
+            indented = wrap_string(action, "    - ")
+            puts(indented)
+          end
+        end
+      end
+
+      public
+
+      # @!group Basic methods
+      #-----------------------------------------------------------------------#
+
+      # prints a message followed by a new line unless config is silent.
+      #
+      def puts(message = '')
+        STDOUT.puts(message) unless config.silent?
+      end
+
+      # prints a message followed by a new line unless config is silent.
+      #
+      def print(message)
+        STDOUT.print(message) unless config.silent?
+      end
+
+      # Stores important warning to the user optionally followed by actions
+      # that the user should take. To print them use {#print_warnings}.
+      #
+      # @param [String]  message The message to print.
+      # @param [Array]   actions The actions that the user should take.
+      #
+      # return [void]
+      #
+      def warn(message, actions = [], verbose_only = false)
+        warnings << { :message => message, :actions => actions, :verbose_only => verbose_only }
+      end
+
+      private
+
+      # @!group Helpers
+      #-----------------------------------------------------------------------#
+
+      # @return [String] Wraps a string taking into account the width of the
+      # terminal and an option indent. Adapted from
+      # http://blog.macromates.com/2006/wrapping-text-with-regular-expressions/
+      #
+      # @param [String] txt     The string to wrap
+      #
+      # @param [String] indent  The string to use to indent the result.
+      #
+      # @return [String]        The formatted string.
+      #
+      # @note If CocoaPods is not being run in a terminal or the width of the
+      # terminal is too small a width of 80 is assumed.
+      #
+      def wrap_string(txt, indent = '')
+        if disable_wrap || !STDIN.tty?
+          txt
+        else
+          width = `stty size`.split(' ')[1].to_i - indent.length
+          width = 80 unless width >= 10
+          txt.strip.gsub(/(.{1,#{width}})( +|$)\n?|(.{#{width}})/, indent + "\\1\\3\n")
+        end
+      end
+    end
+  end
+  UI = UserInterface
+
+  # Redirects cocoapods-core UI.
+  #
+  module CoreUI
+
+    class << self
+
+      # @todo enable in CocoaPods 0.17.0 release
+      #
+      def puts(message)
+        # UI.puts message
+      end
+
+      # @todo enable in CocoaPods 0.17.0 release
+      #
+      def warn(message)
+        # UI.warn message
+      end
+    end
+  end
+end