claide-completion 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9e12551365a7dd992c916bb8804d463d6750def
+  data.tar.gz: 39b2c08434bf6ba4b6014af4c967c0a0e09ac3a8
+SHA512:
+  metadata.gz: 33b09cf9b3a7e6f64822a63738b6b5e323f2ada25477a001d2a2378f2d129088747039f956e97a7b96c1420774c89189f4e0846eb98750af8ff0236b21839d8a
+  data.tar.gz: 05d3fd62a7395d6c92b0dc1d2946366d457a266dc6b1cbc40e948dfc6249ff6a390e125607466fc68a51ec3a6f6bb1c29063d330d20634c4889d48230e7c0a12

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 - 2012 Eloy Durán <eloy.de.enige@gmail.com>
+Copyright (c)        2012 Fabio Pelosin <fabiopelosin@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.markdown

@@ -0,0 +1 @@
+# Hi, I’m CLAide Completion, making your command line experience feel complete.

data/lib/claide_completion.rb

@@ -0,0 +1,23 @@
+require 'claide_completion/generator'
+
+module CLAideCompletion
+  def self.included(mod)
+    if defined?(mod::DEFAULT_ROOT_OPTIONS)
+      mod::DEFAULT_ROOT_OPTIONS << [
+        '--completion-script', 'Print the auto-completion script'
+      ]
+    end
+    mod.prepend(Prepend)
+  end
+
+  module Prepend
+    def handle_root_options(argv)
+      return false unless self.class.root_command?
+      if argv.flag?('completion-script')
+        puts Generator.generate(self.class)
+        return true
+      end
+      super
+    end
+  end
+end

data/lib/claide_completion/gem_version.rb

@@ -0,0 +1,3 @@
+module CLAideCompletion
+  VERSION = '1.0.0'
+end

data/lib/claide_completion/generator.rb

@@ -0,0 +1,36 @@
+module CLAideCompletion
+  module Generator
+    class ShellCompletionNotFound < StandardError
+      include CLAide::InformativeError
+    end
+
+    autoload :Zsh, 'claide_completion/generator/zsh'
+
+    def self.generate(command, shell = nil)
+      shell ||= ENV['SHELL'].split(File::SEPARATOR).last
+      begin
+        generator = const_get(shell.capitalize.to_sym)
+      rescue NameError
+        raise ShellCompletionNotFound,  'Auto-completion generator for ' \
+          "the `#{shell}` shell is not implemented."
+      end
+      generator.new(command).generate
+    end
+
+    # Indents the lines of the given string except the first one to the given
+    # level. Uses two spaces per each level.
+    #
+    # @param  [String] string
+    #         The string to indent.
+    #
+    # @param  [Fixnum] indentation
+    #         The indentation amount.
+    #
+    # @return [String] An indented string.
+    #
+    def indent(string, indentation)
+      string.gsub("\n", "\n#{' ' * indentation * 2}")
+    end
+    module_function :indent
+  end
+end

data/lib/claide_completion/generator/zsh.rb

@@ -0,0 +1,195 @@
+module CLAideCompletion
+  module Generator
+    # Generates a completion script for the Z shell.
+    #
+    class Zsh
+      attr_reader :command
+
+      # @param  [Class] command
+      #         The command to generate the script for.
+      #
+      def initialize(command)
+        @command = command
+      end
+
+      # @return [String] The completion script.
+      #
+      def generate
+        result = <<-DOC
+#compdef #{command.command}
+# setopt XTRACE VERBOSE
+# vim: ft=zsh sw=2 ts=2 et
+
+local -a _subcommands
+local -a _options
+
+#{case_statement_fragment(command)}
+DOC
+
+        post_process(result)
+      end
+
+      private
+
+      # Returns a case statement for a given command with the given nesting
+      # level.
+      #
+      # @param  [Class] command
+      #         The command to generate the fragment for.
+      #
+      # @param  [Fixnum] nest_level
+      #         The nesting level to detect the index of the words array.
+      #
+      # @return [String] the case statement fragment.
+      #
+      # @example
+      #   case "$words[2]" in
+      #     spec-file)
+      #       [..snip..]
+      #     ;;
+      #     *) # bin
+      #       _subcommands=(
+      #         "spec-file:"
+      #       )
+      #       _describe -t commands "bin subcommands" _subcommands
+      #       _options=(
+      #         "--completion-script:Print the auto-completion script"
+      #         "--help:Show help banner of specified command"
+      #         "--verbose:Show more debugging information"
+      #         "--version:Show the version of the tool"
+      #       )
+      #       _describe -t options "bin options" _options
+      #     ;;
+      #   esac
+      #
+      # rubocop:disable MethodLength
+      def case_statement_fragment(command, nest_level = 0)
+        entries = case_statement_entries_fragment(command, nest_level + 1)
+        subcommands = subcommands_fragment(command)
+        options = options_fragment(command)
+
+        result = <<-DOC
+case "$words[#{nest_level + 2}]" in
+  #{Generator.indent(entries, 1)}
+  *) # #{command.full_command}
+    #{Generator.indent(subcommands, 2)}
+    #{Generator.indent(options, 2)}
+  ;;
+esac
+DOC
+        result.gsub(/\n *\n/, "\n").chomp
+      end
+      # rubocop:enable MethodLength
+
+      # Returns a case statement for a given command with the given nesting
+      # level.
+      #
+      # @param  [Class] command
+      #         The command to generate the fragment for.
+      #
+      # @param  [Fixnum] nest_level
+      #         The nesting level to detect the index of the words array.
+      #
+      # @return [String] the case statement fragment.
+      #
+      # @example
+      #   repo)
+      #     case "$words[5]" in
+      #       *) # bin spec-file lint
+      #         _options=(
+      #           "--help:Show help banner of specified command"
+      #           "--only-errors:Skip warnings"
+      #           "--verbose:Show more debugging information"
+      #         )
+      #         _describe -t options "bin spec-file lint options" _options
+      #       ;;
+      #     esac
+      #   ;;
+      #
+      def case_statement_entries_fragment(command, nest_level)
+        subcommands = command.subcommands_for_command_lookup
+        subcommands.sort_by(&:name).map do |subcommand|
+          subcase = case_statement_fragment(subcommand, nest_level)
+          <<-DOC
+#{subcommand.command})
+  #{Generator.indent(subcase, 1)}
+;;
+DOC
+        end.join("\n")
+      end
+
+      # Returns the fragment of the subcommands array.
+      #
+      # @param  [Class] command
+      #         The command to generate the fragment for.
+      #
+      # @return [String] The fragment.
+      #
+      def subcommands_fragment(command)
+        subcommands = command.subcommands_for_command_lookup
+        list = subcommands.sort_by(&:name).map do |subcommand|
+          "\"#{subcommand.command}:#{subcommand.summary}\""
+        end
+        describe_fragment(command, 'subcommands', 'commands', list)
+      end
+
+      # Returns the fragment of the options array.
+      #
+      # @param  [Class] command
+      #         The command to generate the fragment for.
+      #
+      # @return [String] The fragment.
+      #
+      def options_fragment(command)
+        list = command.options.sort_by(&:first).map do |option|
+          "\"#{option[0]}:#{option[1]}\""
+        end
+        describe_fragment(command, 'options', 'options', list)
+      end
+
+      # Returns the fragment for a list of completions and the ZSH
+      # `_describe` function.
+      #
+      # @param  [Class] command
+      #         The command to generate the fragment for.
+      #
+      # @param  [String] name
+      #         The name of the list.
+      #
+      # @param  [Class] tag
+      #         The ZSH tag to use (e.g. command or option).
+      #
+      # @param  [Array<String>] list
+      #         The list of the entries.
+      #
+      # @return [String] The fragment.
+      #
+      def describe_fragment(command, name, tag, list)
+        if list && !list.empty?
+          <<-DOC
+_#{name}=(
+  #{Generator.indent(list.join("\n"), 1)}
+)
+_describe -t #{tag} "#{command.full_command} #{name}" _#{name}
+DOC
+        else
+          ''
+        end
+      end
+
+      # Post processes a script to remove any artifact and escape any needed
+      # character.
+      #
+      # @param  [String] string
+      #         The string to post process.
+      #
+      # @return [String] The post processed script.
+      #
+      def post_process(string)
+        string.gsub!(/\n *\n/, "\n\n")
+        string.gsub!(/`/, '\\\`')
+        string
+      end
+    end
+  end
+end

data/lib/claide_plugin.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+
+require 'claide_completion'
+CLAide::Command.send(:include, CLAideCompletion)

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: claide-completion
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fabio Pelosin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-28 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- fabiopelosin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.markdown
+- lib/claide_completion.rb
+- lib/claide_completion/gem_version.rb
+- lib/claide_completion/generator.rb
+- lib/claide_completion/generator/zsh.rb
+- lib/claide_plugin.rb
+homepage: https://github.com/CocoaPods/CLAide
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 3
+summary: CLI completion plugin for CLAide.
+test_files: []