claide-plugins 0.9.0

data/Rakefile

@@ -0,0 +1,55 @@
+# Bootstrap
+#-----------------------------------------------------------------------------#
+
+task :bootstrap do
+  if system('which bundle')
+    sh 'bundle install'
+  else
+    $stderr.puts "\033[0;31m" \
+      "[!] Please install the bundler gem manually:\n" \
+      '    $ [sudo] gem install bundler' \
+      "\e[0m"
+    exit 1
+  end
+end
+
+begin
+
+  require 'bundler/gem_tasks'
+
+  task :default => 'spec'
+
+  # Spec
+  #-----------------------------------------------------------------------------#
+
+  desc 'Runs all the specs'
+  task :spec do
+    start_time = Time.now
+    sh "bundle exec bacon #{specs('**')}"
+    duration = Time.now - start_time
+    puts "Tests completed in #{duration}s"
+    Rake::Task['rubocop'].invoke
+  end
+
+  def specs(dir)
+    FileList["spec/#{dir}/*_spec.rb"].shuffle.join(' ')
+  end
+
+  # Rubocop
+  #-----------------------------------------------------------------------------#
+
+  desc 'Checks code style'
+  task :rubocop do
+    require 'rubocop'
+    cli = RuboCop::CLI.new
+    result = cli.run(FileList['{spec,lib}/**/*.rb'])
+    abort('RuboCop failed!') unless result == 0
+  end
+
+
+rescue LoadError
+  $stderr.puts "\033[0;31m" \
+    '[!] Some Rake tasks haven been disabled because the environment' \
+    ' couldn’t be loaded. Be sure to run `rake bootstrap` first.' \
+    "\e[0m"
+end

data/claide-plugins.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'claide_plugins.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'claide-plugins'
+  spec.version       = CLAidePlugins::VERSION
+  spec.authors       = ['David Grandinetti', 'Olivier Halligon']
+  spec.summary       = %q{CLAide plugin which shows info about available CLAide plugins.}
+  spec.description   = <<-DESC
+                         This CLAide plugin shows information about all available CLAide plugins
+                         (yes, this is very meta!).
+                         This plugin adds the "plugins" subcommand to a binary so that you can list
+                         all plugins (registered in the reference JSON hosted at CocoaPods/cocoapods-plugins)
+                       DESC
+  spec.homepage      = 'https://github.com/cocoapods/claide-plugins'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'nap', '~> 1.0'
+  spec.add_runtime_dependency 'cork', '~> 0'
+  spec.add_runtime_dependency 'open4', '~> 1.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.required_ruby_version = '>= 2.0.0'
+end

data/lib/claide/command/gem_helper.rb

@@ -0,0 +1,120 @@
+require 'claide/command/gem_index_cache'
+
+module CLAide
+  class Command
+    # This module is used by Command::PluginsHelper to download the Gem
+    # Specification data, check if a Gem is installed, and provide info
+    # on all versions of a Gem.
+    #
+    module GemHelper
+      # A GemIndexCache to manage downloading/caching the spec index.
+      #
+      @cache = nil
+
+      # Getter for GemIndexCache
+      #
+      # @return [GemIndexCache] a new or memoized GemIndexCache
+      #
+      def self.cache
+        @cache ||= GemIndexCache.new
+      end
+
+      # Instantiate a cache and download the spec index if it has
+      # not already been done.
+      #
+      def self.download_and_cache_specs
+        cache.download_and_cache_specs
+      end
+
+      # Tells if a gem is installed
+      #
+      # @param [String] gem_name
+      #        The name of the plugin gem to test
+      #
+      # @param [String] version_string
+      #        An optional version string, used to check if a specific
+      #        version of a gem is installed
+      #
+      # @return [Bool] true if the gem is installed, false otherwise.
+      #
+      def self.gem_installed?(gem_name, version_string = nil)
+        version = Gem::Version.new(version_string) if version_string
+
+        if Gem::Specification.respond_to?(:find_all_by_name)
+          gems = Gem::Specification.find_all_by_name(gem_name)
+          return !gems.empty? unless version
+          gems.each { |gem| return true if gem.version == version }
+          false
+        else
+          dep = Gem::Dependency.new(gem_name, version_string)
+          !Gem.source_index.search(dep).empty?
+        end
+      end
+
+      # Get the version of a gem that is installed locally. If more than
+      # one version is installed, this returns the first version found,
+      # which MAY not be the highest/newest version.
+      #
+      # @return [String] The version of the gem that is installed,
+      #                  or nil if it is not installed.
+      #
+      def self.installed_version(gem_name)
+        if Gem::Specification.respond_to?(:find_all_by_name)
+          gem = Gem::Specification.find_all_by_name(gem_name).first
+        else
+          dep = Gem::Dependency.new(gem_name)
+          gem = Gem.source_index.search(dep).first
+        end
+        gem ? gem.version.to_s : nil
+      end
+
+      # Create a string containing all versions of a plugin,
+      # colored to indicate if a specific version is installed
+      # locally.
+      #
+      # @param [String] plugin_name
+      #        The name of the plugin gem
+      #
+      # @param [GemIndexCache] index_cache
+      #        Optional index cache can be passed in, otherwise
+      #        the module instance is used.
+      #
+      # @return [String] a string containing a comma separated
+      #                  concatenation of all versions of a plugin
+      #                  that were found on rubygems.org
+      #
+      def self.versions_string(plugin_name, index_cache = @cache)
+        name_tuples = index_cache.specs_with_name(plugin_name)
+        sorted_versions = name_tuples.sort_by(&:version)
+        version_strings = colorize_versions(sorted_versions)
+        version_strings.join ', '
+      end
+
+      #----------------#
+
+      private
+
+      # Colorize an Array of version strings so versions that are installed
+      # are green and uninstalled versions are yellow.
+      #
+      # @param [Array] versions
+      #        sorted array of Gem::NameTuples representing all versions of
+      #        a plugin gem.
+      #
+      # @return [Array] An array of strings, each one being the version
+      #                 string of the same plugin
+      #
+      def self.colorize_versions(versions)
+        colored_strings = []
+        versions.reverse_each do |name_tuple|
+          if gem_installed?(name_tuple.name, name_tuple.version.to_s)
+            colored_strings << name_tuple.version.to_s.green
+          else
+            colored_strings << name_tuple.version.to_s.yellow
+          end
+        end
+        colored_strings
+      end
+    end
+  end
+end

data/lib/claide/command/gem_index_cache.rb

@@ -0,0 +1,87 @@
+require 'claide/command/gem_helper'
+
+module CLAide
+  class Command
+    # This class is used by Command::GemsHelper to download the Gem
+    # Specification index from rubygems.org and provide info about
+    # the index.
+    #
+    class GemIndexCache
+      # A memoized hash of all the rubygem specs. If it is nil, the specs will
+      # be downloaded, which will take a few seconds to download.
+      #
+      # @return [Hash] The hash of all rubygems
+      #
+      def specs
+        @specs ||= download_specs
+      end
+
+      # Alias to make the initial caching process more readable.
+      #
+      alias_method :download_and_cache_specs, :specs
+
+      # Get an Array of Gem::NameTuple objects that match a given
+      # spec name.
+      #
+      # @param [String] name
+      #        The name of the gem to match on (e.g. 'cocoapods-try')
+      #
+      # @return [Array] Array of Gem::NameTuple that match the name
+      #
+      def specs_with_name(name)
+        matching_specs = @specs.select do |spec|
+          spec[0].name == name
+        end
+
+        name_tuples = []
+        matching_specs.each do |(name_tuple, _)|
+          name_tuples << name_tuple
+        end
+
+        name_tuples
+      end
+
+      #----------------#
+
+      private
+
+      # Force the rubygem spec index file
+      #
+      # @return [Hash] The hash of all rubygems
+      #
+      def download_specs
+        UI.puts 'Downloading Rubygem specification index...'
+        fetcher = Gem::SpecFetcher.fetcher
+        results, errors = fetcher.available_specs(:released)
+
+        unless errors.empty?
+          UI.puts 'Error downloading Rubygem specification index: ' +
+            errors.first.error.to_s
+          return []
+        end
+
+        flatten_fetcher_results(results)
+      end
+
+      # Flatten the dictionary returned from Gem::SpecFetcher
+      # to a simple array.
+      #
+      # @param [Hash] results
+      #        the hash returned from the call to
+      #        Gem::SpecFetcher.available_specs()
+      #
+      # @return [Array] Array of all spec results
+      #
+      def flatten_fetcher_results(results)
+        specs = []
+        results.each do |source, source_specs|
+          source_specs.each do |tuple|
+            specs << [tuple, source]
+          end
+        end
+
+        specs
+      end
+    end
+  end
+end

data/lib/claide/command/plugins.rb

@@ -0,0 +1,47 @@
+require 'rest'
+require 'json'
+require 'cork'
+require 'claide'
+require 'claide/command/plugins_config'
+
+UI = Cork::Board.new
+
+module CLAide
+  module Plugins
+    class << self
+      attr_accessor :config
+    end
+    # set a default configuration that will work with claide-plugins
+    self.config = Configuration.new
+  end
+
+  # Indicates a runtime error **not** caused by a bug.
+  #
+  class PlainInformative < StandardError; end
+
+  # Indicates a user error.
+  #
+  class Informative < PlainInformative; end
+
+  class Command
+    # The claide plugins command.
+    #
+    class Plugins < Command
+      require 'claide/command/plugins/list'
+      require 'claide/command/plugins/search'
+      require 'claide/command/plugins/create'
+
+      self.abstract_command = true
+      self.default_subcommand = 'list'
+
+      self.summary = 'Show available plugins'
+      self.description = <<-DESC
+        Lists or searches the available plugins
+        and show if you have them installed or not.
+
+        Also allows you to quickly create a new
+        plugin using a provided template.
+      DESC
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+require 'claide/command/plugins_helper'
+require 'claide/executable'
+
+module CLAide
+  class Command
+    class Plugins
+      # The create subcommand. Used to create a new plugin using either the
+      # default template (CocoaPods/cocoapods-plugin-template) or a custom
+      # template
+      #
+      class Create < Plugins
+        NAME_PREFIX = 'claide-'
+
+        self.summary = 'Creates a new plugin'
+        self.description = <<-DESC
+                Creates a scaffold for the development of a new plugin
+                named `NAME` according to the CocoaPods best practices.
+
+                If a `TEMPLATE_URL`, pointing to a git repo containing a
+                compatible template, is specified, it will be used
+                in place of the default one.
+        DESC
+
+        self.arguments = [
+          CLAide::Argument.new('NAME', true),
+          CLAide::Argument.new('TEMPLATE_URL', false),
+        ]
+
+        def initialize(argv)
+          @name = argv.shift_argument
+          unless @name.nil? || @name.empty? || @name.start_with?(NAME_PREFIX)
+            @name = NAME_PREFIX + @name.dup
+          end
+          @template_url = argv.shift_argument
+          super
+        end
+
+        def validate!
+          super
+          if @name.nil? || @name.empty?
+            help! 'A name for the plugin is required.'
+          end
+
+          help! 'The plugin name cannot contain spaces.' if @name.match(/\s/)
+        end
+
+        def run
+          clone_template
+          configure_template
+          show_reminder
+        end
+
+        #----------------------------------------#
+
+        private
+
+        # !@group Private helpers
+
+        extend CLAide::Executable
+        executable :git
+
+        TEMPLATE_BASE_URL = 'https://github.com/CocoaPods/'
+        TEMPLATE_REPO = TEMPLATE_BASE_URL + 'cocoapods-plugin-template.git'
+        TEMPLATE_INFO_URL = TEMPLATE_BASE_URL + 'cocoapods-plugin-template'
+
+        # Clones the template from the remote in the working directory using
+        # the name of the plugin.
+        #
+        # @return [void]
+        #
+        def clone_template
+          UI.section("-> Creating `#{@name}` plugin") do
+            UI.notice "using template '#{template_repo_url}'"
+            command = ['clone', template_repo_url, @name]
+            if method(:git!).arity == -1
+              git! command
+            else
+              # TODO: delete this conditional and use the other branch when
+              # 0.5.0 is released
+              require 'shellwords'
+              git! command.map(&:to_s).map(&:shellescape).join(' ')
+            end
+          end
+        end
+
+        # Runs the template configuration utilities.
+        #
+        # @return [void]
+        #
+        def configure_template
+          UI.section('-> Configuring template') do
+            Dir.chdir(@name) do
+              if File.file? 'configure'
+                system "./configure #{@name}"
+              else
+                UI.warn 'Template does not have a configure file.'
+              end
+            end
+          end
+        end
+
+        # Checks if a template URL is given else returns the TEMPLATE_REPO URL
+        #
+        # @return String
+        #
+        def template_repo_url
+          @template_url || TEMPLATE_REPO
+        end
+
+        # Shows a reminder to the plugin author to make a Pull Request
+        # in order to update plugins.json once the plugin is released
+        #
+        def show_reminder
+          repo = PluginsHelper.plugins_raw_url
+          UI.notice "Don't forget to create a Pull Request on #{repo}\n" \
+            ' to add your plugin to the plugins.json file once it is released!'
+        end
+      end
+    end
+  end
+end