docopt-compgen 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3f524e54bf6f9520b41f0e64f2cd710d64a87241d7b0780fc2421655983eb1f
+  data.tar.gz: 5204ce5211e06c02871b42e05f49371c2b6e3b4731dd6669ae39a7f026167e07
+SHA512:
+  metadata.gz: 53ae0d920fb9d37eab1298fc07d1172d4c57ffa6e607a2243cb283e84f77bdf9eb7b87d3f33c3c86701e1646d7a3137ad338eb1c2c9fb11c7ea11dc366aae103
+  data.tar.gz: c9935c4ca6acdb855a87d2bb663bf279c4cc6ec9df5d2c145f9479f212dbd3290d7a7b590ab8841b633532ec52acc96f1e8963712fcf5025fea81c985656b9b2

data/bin/docopt-compgen

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+trap(:SIGINT) { puts; exit 130 }
+Signal.trap(:SIGPIPE, :SYSTEM_DEFAULT)
+require 'docopt'
+
+usage = <<~EOF
+    Usage:
+        #{File.basename($0)} [options] [<command>]
+
+    Options:
+        --command-name NAME    Command name
+                               If not specified then the slugified basename of <command> will be used
+        --namespace NAME       Prefix for generated bash functions [default: cmd]
+        -h, --help             Show help
+EOF
+
+begin
+    opts = Docopt.docopt(usage)
+rescue Docopt::Exit
+    puts usage
+    exit 2
+end
+
+require 'colorize'
+
+if $stdin.tty?
+    command = opts['<command>']
+    if command.nil?
+        $stderr.puts 'Error: <command> is mandatory when not passing help via stdin'.red
+        puts usage
+        exit 1
+    end
+
+    begin
+        help = `#{command} --help`
+    rescue => e
+        $stderr.puts e.to_s.red
+        exit 1
+    end
+else
+    if !opts['--command-name']
+        $stderr.puts 'Error: --command-name is mandatory when passing help via stdin'.red
+        puts usage
+        exit 1
+    end
+
+    help = $stdin.read
+end
+
+if help.nil? || help.lines.first !~ /Usage:/
+    $stderr.puts 'Unable to parse help output from "%s"'.red % command
+    exit 1
+end
+
+require_relative '../lib/docopt-compgen'
+
+parser = DocoptCompgen::Parser.new(help)
+generator = DocoptCompgen::Generator.new(
+    command,
+    parser.to_node,
+    command_name: opts['--command-name'],
+    namespace: opts['--namespace'],
+)
+
+puts generator.to_s

data/lib/docopt-compgen/generator.rb

@@ -0,0 +1,128 @@
+module DocoptCompgen
+    class Generator
+        def initialize(command, node, command_name: nil, namespace: nil)
+            @command = command ? File.basename(command) : command_name
+            @node = node
+            @command_name = command_name || Util.slugify(@command)
+            @namespace = '_' + namespace
+        end
+
+        def indent(str, level)
+            "\n" + str.strip.lines.map { |s| (' ' * level) + s }.join
+        end
+
+        def get_op(node)
+            if node.subcommands.length > 0
+                'eq'
+            else
+                'ge'
+            end
+        end
+
+        def path_arguments?(arguments)
+            arguments.any? { |a| %w[<file> <dir> <path>].include?(a) }
+        end
+
+        def path_options?(options)
+            options.any? { |a| %w[--file --dir --path].include?(a) }
+        end
+
+        def include_files?(node)
+            return path_arguments?(node.arguments) || path_options?(node.options)
+        end
+
+        def make_compreply(node)
+            words = []
+
+            if node.options.length > 0
+                words << node.options
+            end
+
+            words << node.subcommands.keys
+
+            return [include_files?(node), words.flatten.join(' ')]
+        end
+
+        def make(command_name, node, level)
+            subcommand_switch = make_subcommand_switch(
+                command_name,
+                level,
+                node.subcommands,
+            )
+
+            op = get_op(node)
+            include_files, words = make_compreply(node)
+
+            functions = [
+                make_function(
+                    command_name,
+                    op,
+                    level,
+                    words,
+                    include_files,
+                    subcommand_switch,
+                ),
+            ]
+
+            node.subcommands.each do |subcommand_name, subcommand_node|
+                functions << make(
+                    '%s_%s' % [command_name, subcommand_name],
+                    subcommand_node,
+                    level + 1,
+                )
+            end
+
+            return functions.join("\n")
+        end
+
+        def make_function(command_name, op, level, words, include_files, subcommand_switch) # rubocop:disable Metrics/ParameterLists
+            files = ''
+            if include_files
+                files = indent(<<~EOF, 8)
+                    local IFS=$'\\n' # Handle filenames with spaces.
+                    COMPREPLY+=($(compgen -f -- "$cur"))
+                EOF
+            end
+
+            return <<~EOF
+                function #{@namespace}_#{command_name} {
+                    local cur
+                    cur="${COMP_WORDS[COMP_CWORD]}"
+
+                    if [ "$COMP_CWORD" -#{op} #{level} ]; then
+                        COMPREPLY=($(compgen -W '#{words}' -- "$cur"))#{files}#{subcommand_switch}
+                    fi
+                }
+            EOF
+        end
+
+        def make_subcommand_switch(command_name, level, subcommands)
+            if subcommands.length == 0
+                return ''
+            end
+
+            cases = subcommands.map do |subcommand_name, _node|
+                "#{subcommand_name}) #{@namespace}_#{command_name}_#{subcommand_name} ;;"
+            end.join("\n        ")
+
+            return indent(<<~EOF, 4)
+                else
+                    case ${COMP_WORDS[#{level}]} in
+                        #{cases}
+                    esac
+            EOF
+        end
+
+        def to_s
+            content = make(@command_name, @node, 1)
+
+            return <<~EOF
+                #!/bin/bash
+                # shellcheck disable=SC2207
+
+                #{content}
+                complete -o bashdefault -o default -o filenames -F #{@namespace}_#{@command_name} #{@command}
+            EOF
+        end
+    end
+end

data/lib/docopt-compgen/node.rb

@@ -0,0 +1,37 @@
+module DocoptCompgen
+    class Node
+        attr_reader :arguments
+        attr_reader :subcommands
+        attr_reader :parent
+
+        def initialize(parent = nil)
+            @parent = parent
+            @subcommands = {}
+            @options = []
+            @arguments = []
+        end
+
+        def add_argument(argument)
+            @arguments << argument
+        end
+
+        def add_option(option)
+            @options << option
+        end
+
+        def options
+            options = @options
+            if @parent
+                options += @parent.options
+            end
+            options.uniq
+        end
+
+        def add_subcommand(name)
+            if @subcommands[name].nil?
+                @subcommands[name] = Node.new(self)
+            end
+            @subcommands[name]
+        end
+    end
+end

data/lib/docopt-compgen/parser.rb

@@ -0,0 +1,81 @@
+module DocoptCompgen
+    class Parser
+        def initialize(help)
+            @help = help
+        end
+
+        def to_node
+            build(parse_docopt, Node.new)
+        end
+
+        private
+
+        def parse_docopt
+            options = Docopt.parse_defaults(@help)
+
+            pattern = Docopt.parse_pattern(
+                Docopt.formal_usage(Docopt.printable_usage(@help)),
+                options,
+            )
+
+            # Options explicitly specified in subcommands cannot be used for a
+            # general [options] placeholder. This is necessary so that options
+            # can be restricted to specific subcommands while still allowing the
+            # remaining to be used in place of [options].
+            used_options = pattern.flat(Docopt::Option).uniq
+            pattern.flat(Docopt::AnyOptions).each do |any_options|
+                any_options.children = options.reject do |option|
+                    used_options.include?(option)
+                end.uniq
+            end
+
+            return pattern
+        end
+
+        def build(pattern, node)
+            wrappers = [
+                Docopt::Either,
+                Docopt::Optional,
+                Docopt::OneOrMore,
+                Docopt::AnyOptions,
+            ]
+
+            if wrappers.include?(pattern.class)
+                pattern.children.each do |child|
+                    build(child, node)
+                end
+            end
+
+            if [Docopt::Required].include?(pattern.class)
+                pattern.children.each do |child|
+                    new_node = build(child, node)
+                    if child.is_a?(Docopt::Command)
+                        node = new_node
+                    end
+                end
+            end
+
+            # rubocop:disable Style/SoleNestedConditional
+            if [Docopt::Option].include?(pattern.class)
+                # if pattern.short
+                #     node.add_option(pattern.short)
+                # end
+
+                if pattern.long
+                    node.add_option(pattern.long)
+                end
+            end
+            # rubocop:enable Style/SoleNestedConditional
+
+            if [Docopt::Argument].include?(pattern.class)
+                node.add_argument(pattern.name)
+            end
+
+            if [Docopt::Command].include?(pattern.class)
+                node = node.add_subcommand(pattern.name)
+            end
+
+            return node
+        end
+    end
+end

data/lib/docopt-compgen/util.rb

@@ -0,0 +1,11 @@
+module DocoptCompgen
+    class Util
+        def self.slugify(str)
+            str.gsub(' ', '_')
+               .gsub(/[^\w_]/, '_')
+               .gsub(/_+/, '_')
+               .gsub(/_$/, '')
+               .gsub(/^_/, '')
+        end
+    end
+end

data/lib/docopt-compgen/version.rb

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

data/lib/docopt-compgen.rb

@@ -0,0 +1,11 @@
+module DocoptCompgen
+    def self.root_dir
+        File.expand_path('../..', __FILE__)
+    end
+end
+
+require_relative 'docopt-compgen/version'
+require_relative 'docopt-compgen/util'
+require_relative 'docopt-compgen/node'
+require_relative 'docopt-compgen/parser'
+require_relative 'docopt-compgen/generator'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: docopt-compgen
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- crdx
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description:
+email:
+executables:
+- docopt-compgen
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/docopt-compgen
+- lib/docopt-compgen.rb
+- lib/docopt-compgen/generator.rb
+- lib/docopt-compgen/node.rb
+- lib/docopt-compgen/parser.rb
+- lib/docopt-compgen/util.rb
+- lib/docopt-compgen/version.rb
+homepage: https://github.com/crdx/docopt-compgen
+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: []
+rubygems_version: 3.2.21
+signing_key:
+specification_version: 4
+summary: docopt completion generator
+test_files: []