claide-plugins 0.9.0

data/lib/claide/command/plugins/list.rb

@@ -0,0 +1,34 @@
+require 'claide/command/plugins_helper'
+require 'claide/command/gem_helper'
+
+module CLAide
+  class Command
+    class Plugins
+      # The list subcommand. Used to list all known plugins
+      #
+      class List < Plugins
+        self.summary = 'List all known plugins'
+        self.description = <<-DESC
+                List all known plugins (according to the list
+                hosted on github.com/CocoaPods/cocoapods-plugins)
+        DESC
+
+        def self.options
+          super.reject { |option, _| option == '--silent' }
+        end
+
+        def run
+          plugins = PluginsHelper.known_plugins
+          GemHelper.download_and_cache_specs if self.verbose?
+
+          name = CLAide::Plugins.config.name
+          UI.title "Available #{name} Plugins:" do
+            plugins.each do |plugin|
+              PluginsHelper.print_plugin plugin, self.verbose?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/claide/command/plugins/search.rb

@@ -0,0 +1,60 @@
+require 'claide/command/plugins_helper'
+require 'claide/command/gem_helper'
+require 'claide/command'
+
+module CLAide
+  class Command
+    class Plugins
+      # The search subcommand.
+      # Used to search a plugin in the list of known plugins,
+      # searching into the name, author description fields
+      #
+      class Search < Plugins
+        self.summary = 'Search for known plugins'
+        self.description = <<-DESC
+                Searches plugins whose 'name' contains the given `QUERY`.
+                `QUERY` is a regular expression, ignoring case.
+
+                With `--full`, it also searches by 'author' and 'description'.
+        DESC
+
+        self.arguments = [
+          CLAide::Argument.new('QUERY', true),
+        ]
+
+        def self.options
+          [
+            ['--full',  'Search by name, author, and description'],
+          ].concat(super.reject { |option, _| option == '--silent' })
+        end
+
+        def initialize(argv)
+          @full_text_search = argv.flag?('full')
+          @query = argv.shift_argument unless argv.arguments.empty?
+          super
+        end
+
+        def validate!
+          super
+          help! 'A search query is required.' if @query.nil? || @query.empty?
+          begin
+            /#{@query}/
+          rescue RegexpError
+            help! 'A valid regular expression is required.'
+          end
+        end
+
+        def run
+          plugins = PluginsHelper.matching_plugins(@query, @full_text_search)
+          GemHelper.download_and_cache_specs if self.verbose?
+
+          name = CLAide::Plugins.config.name
+          UI.title "Available #{name} Plugins matching '#{@query}':"
+          plugins.each do |plugin|
+            PluginsHelper.print_plugin plugin, self.verbose?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/claide/command/plugins_config.rb

@@ -0,0 +1,35 @@
+require 'claide'
+
+module CLAide
+  module Plugins
+    class Configuration
+      # name of the plugin
+      attr_accessor :name
+
+      # prefix to use when searching for gems to load at runtime
+      attr_accessor :plugin_prefix
+
+      # url for JSON file that holds list of plugins to show when searching
+      attr_accessor :plugin_list_url
+
+      # url for repo that holds template to use when creating a new plugin
+      attr_accessor :plugin_template_url
+
+      def initialize(name = 'default name',
+                     plugin_prefix = 'claide',
+                     plugin_list_url = 'https://github.com/cocoapods/claide-plugins/something.json',
+                     plugin_template_url = 'https://github.com/cocoapods/claide-plugins-template')
+        @name = name
+        @plugin_prefix = plugin_prefix
+        @plugin_list_url = plugin_list_url
+        @plugin_template_url = plugin_template_url
+      end
+    end
+
+    class << self
+      attr_accessor :config
+    end
+    # set a default configuration that will work with claide-plugins
+    self.config = Configuration.new
+  end
+end

data/lib/claide/command/plugins_helper.rb

@@ -0,0 +1,134 @@
+require 'claide/command/gem_helper'
+
+module CLAide
+  class Command
+    # This module is used by Command::Plugins::List
+    # and Command::Plugins::Search to download and parse
+    # the JSON describing the plugins list and manipulate it
+    #
+    module PluginsHelper
+      def self.plugins_raw_url
+        CLAide::Plugins.config.plugin_list_url
+      end
+
+      # Force-download the JSON
+      #
+      # @return [Hash] The hash representing the JSON with all known plugins
+      #
+      def self.download_json
+        UI.puts 'Downloading Plugins list...'
+        response = REST.get(plugins_raw_url)
+        if response.ok?
+          parse_json(response.body)
+        else
+          raise Informative, 'Could not download plugins list ' \
+            "from cocoapods-plugins: #{response.inspect}"
+        end
+      end
+
+      # The list of all known plugins, according to
+      # the JSON hosted on github's cocoapods-plugins
+      #
+      # @return [Array] all known plugins, as listed in the downloaded JSON
+      #
+      def self.known_plugins
+        json = download_json
+        json['plugins']
+      end
+
+      # Filter plugins to return only matching ones
+      #
+      # @param [String] query
+      #        A query string that corresponds to a valid RegExp pattern.
+      #
+      # @param [Bool] full_text_search
+      #        false only searches in the plugin's name.
+      #        true searches in the plugin's name, author and description.
+      #
+      # @return [Array] all plugins matching the query
+      #
+      def self.matching_plugins(query, full_text_search)
+        query_regexp = /#{query}/i
+        known_plugins.reject do |plugin|
+          texts = [plugin['name']]
+          if full_text_search
+            texts << plugin['author'] if plugin['author']
+            texts << plugin['description'] if plugin['description']
+          end
+          texts.grep(query_regexp).empty?
+        end
+      end
+
+      # Display information about a plugin
+      #
+      # @param [Hash] plugin
+      #        The hash describing the plugin
+      #
+      # @param [Bool] verbose
+      #        If true, will also print the author of the plugins.
+      #        Defaults to false.
+      #
+      def self.print_plugin(plugin, verbose = false)
+        plugin_colored_name = plugin_title(plugin)
+
+        UI.title(plugin_colored_name, '', 1) do
+          UI.puts_indented plugin['description']
+          ljust = verbose ? 16 : 11
+          UI.labeled('Gem', plugin['gem'], ljust)
+          UI.labeled('URL', plugin['url'], ljust)
+          print_verbose_plugin(plugin, ljust) if verbose
+        end
+      end
+
+      #----------------#
+
+      private
+
+      # Smaller helper to print out the verbose details
+      # for a plugin.
+      #
+      # @param [Hash] plugin
+      #        The hash describing the plugin
+      #
+      # @param [Integer] ljust
+      #        The left justification that is passed into UI.labeled
+      #
+      def self.print_verbose_plugin(plugin, ljust)
+        UI.labeled('Author', plugin['author'], ljust)
+        unless GemHelper.cache.specs.empty?
+          versions = GemHelper.versions_string(plugin['gem'])
+          UI.labeled('Versions', versions, ljust)
+        end
+      end
+
+      # Parse the given JSON data, handling parsing errors if any
+      #
+      # @param [String] json_str
+      #        The string representation of the JSON to parse
+      #
+      def self.parse_json(json_str)
+        JSON.parse(json_str)
+      rescue JSON::ParserError => e
+        raise Informative, "Invalid plugins list from cocoapods-plugins: #{e}"
+      end
+
+      # Format the title line to print the plugin info with print_plugin
+      # coloring it according to whether the plugin is installed or not
+      #
+      # @param [Hash] plugin
+      #               The hash describing the plugin
+      #
+      # @return [String] The formatted and colored title
+      #
+      def self.plugin_title(plugin)
+        plugin_name = "-> #{plugin['name']}"
+        if GemHelper.gem_installed?(plugin['gem'])
+          plugin_name += " (#{GemHelper.installed_version(plugin['gem'])})"
+          plugin_name.green
+        else
+          plugin_name.yellow
+        end
+      end
+    end
+  end
+end

data/lib/claide/executable.rb

@@ -0,0 +1,116 @@
+module CLAide
+  # Module which provides support for running executables.
+  #
+  # In a class it can be used as:
+  #
+  #     extend Executable
+  #     executable :git
+  #
+  # This will create two methods `git` and `git!` both accept a command but
+  # the latter will raise on non successful executions. The methods return the
+  # output of the command.
+  #
+  module Executable
+    # Creates the methods for the executable with the given name.
+    #
+    # @param  [Symbol] name
+    #         the name of the executable.
+    #
+    # @return [void]
+    #
+    def executable(name)
+      define_method(name) do |*command|
+        Executable.execute_command(name, Array(command).flatten, false)
+      end
+
+      define_method(name.to_s + '!') do |*command|
+        Executable.execute_command(name, Array(command).flatten, true)
+      end
+    end
+
+    # Executes the given command. Displays output if in verbose mode.
+    #
+    # @param  [String] bin
+    #         The binary to use.
+    #
+    # @param  [Array<#to_s>] command
+    #         The command to send to the binary.
+    #
+    # @param  [Bool] raise_on_failure
+    #         Whether it should raise if the command fails.
+    #
+    # @raise  If the executable could not be located.
+    #
+    # @raise  If the command fails and the `raise_on_failure` is set to true.
+    #
+    # @return [String] the output of the command (STDOUT and STDERR).
+    #
+    # @todo   Find a way to display the live output of the commands.
+    #
+    def self.execute_command(exe, command, raise_on_failure)
+      bin = `which #{exe}`.strip
+      raise Informative, "Unable to locate `#{exe}`" if bin.empty?
+
+      require 'open4'
+      require 'shellwords'
+
+      command = command.map(&:to_s)
+      full_command = \
+        "#{bin.shellescape} #{command.map(&:shellescape).join(' ')}"
+
+      # if Config.instance.verbose?
+      # UI.message("$ #{full_command}")
+      # stdout, stderr = Indenter.new(STDOUT), Indenter.new(STDERR)
+      # else
+      stdout, stderr = Indenter.new, Indenter.new
+      # end
+
+      options = { :stdout => stdout, :stderr => stderr, :status => true }
+      status  = Open4.spawn(bin, command, options)
+      output  = stdout.join("\n") + stderr.join("\n")
+      unless status.success?
+        if raise_on_failure
+          raise Informative, "#{full_command}\n\n#{output}"
+        else
+          UI.message("[!] Failed: #{full_command}".red)
+        end
+      end
+      output
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # Helper class that allows to write to an {IO} instance taking into account
+    # the UI indentation level.
+    #
+    class Indenter < ::Array
+      # @return [Fixnum] The indentation level of the UI.
+      #
+      attr_accessor :indent
+
+      # @return [IO] the {IO} to which the output should be printed.
+      #
+      attr_accessor :io
+
+      # @param [IO] io @see io
+      #
+      def initialize(io = nil)
+        @io = io
+        @indent = ' ' * UI.indentation_level
+      end
+
+      # Stores a portion of the output and prints it to the {IO} instance.
+      #
+      # @param  [String] value
+      #         the output to print.
+      #
+      # @return [void]
+      #
+      def <<(value)
+        super
+      ensure
+        @io << "#{ indent }#{ value }" if @io
+      end
+    end
+  end
+end

data/lib/claide_plugin.rb

@@ -0,0 +1 @@
+require 'claide/command/plugins'

data/lib/claide_plugins.rb

@@ -0,0 +1,3 @@
+module CLAidePlugins
+  VERSION = '0.9.0'.freeze
+end

data/spec/command/gem_helper_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+require 'claide/command/gem_helper'
+
+# The CLAide namespace
+#
+module CLAide
+  describe Command::GemHelper do
+    before do
+      UI_OUT.reopen
+    end
+
+    after do
+      mocha_teardown
+    end
+
+    it 'detects if a gem is installed' do
+      Command::GemHelper.gem_installed?('bacon').should.be.true
+      Command::GemHelper.gem_installed?('fake-fake-fake-gem').should.be.false
+    end
+
+    it 'detects if a specific version of a gem is installed' do
+      Command::GemHelper.gem_installed?('bacon', Bacon::VERSION).should.be.true
+      impossibacon = Gem::Version.new(Bacon::VERSION).bump
+      Command::GemHelper.gem_installed?('bacon', impossibacon).should.be.false
+    end
+
+    it 'creates a version list that includes all versions of a single gem' do
+      spec2 = Gem::NameTuple.new('cocoapods-plugins', Gem::Version.new('0.2.0'))
+      spec1 = Gem::NameTuple.new('cocoapods-plugins', Gem::Version.new('0.1.0'))
+      response = [{ 1 => [spec2, spec1] }, []]
+      Gem::SpecFetcher.any_instance.stubs(:available_specs).returns(response)
+
+      @cache = Command::GemIndexCache.new
+      @cache.download_and_cache_specs
+      versions_string =
+        Command::GemHelper.versions_string('cocoapods-plugins', @cache)
+      versions_string.should.include('0.2.0')
+      versions_string.should.include('0.1.0')
+    end
+  end
+end

data/spec/command/gem_index_cache_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+# The CocoaPods namespace
+#
+module CLAide
+  describe Command::GemIndexCache do
+    before do
+      @cache = Command::GemIndexCache.new
+      UI_OUT.reopen
+    end
+
+    after do
+      mocha_teardown
+    end
+
+    it 'notifies the user that it is downloading the spec index' do
+      response = [{}, []]
+      Gem::SpecFetcher.any_instance.stubs(:available_specs).returns(response)
+
+      @cache.download_and_cache_specs
+      out = UI_OUT.string
+      out.should.include('Downloading Rubygem specification index...')
+      out.should.not.include('Error downloading Rubygem specification')
+    end
+
+    it 'notifies the user when getting the spec index fails' do
+      error = Gem::RemoteFetcher::FetchError.new('no host', 'bad url')
+      wrapper_error = stub(:error => error)
+      response = [[], [wrapper_error]]
+      Gem::SpecFetcher.any_instance.stubs(:available_specs).returns(response)
+
+      @cache.download_and_cache_specs
+      @cache.specs.should.be.empty?
+      UI_OUT.string.should.include('Downloading Rubygem specification index...')
+      UI_OUT.string.should.include('Error downloading Rubygem specification')
+    end
+  end
+end