completely 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd3ae4ec92d7318bd4ef32fdd465d9bff3341931f5f965d2db8f263c1b95e38b
+  data.tar.gz: 01ccb2fa2e1f050b7a45944b552590fad6aab9bafc90ef4cb98b8d6284200392
+SHA512:
+  metadata.gz: fd06256b9cb4c42364d118ea1392b180ef662e98b2ea9c6b24ca815f5fa5cf1f16d6c0a6792090c9bc5f376ab7dfb04e9b8c732cb83292140acb59676d6090a9
+  data.tar.gz: b1985849259627803ebe3f7c56b4adc98137456b172fb36cbf1379b4677257dca6cc671d85a12106596fb246de02aad07c5e9d51c5dd0abc7301518d9b7529b2

data/README.md

@@ -0,0 +1,130 @@
+# Completely - Bash Completions Generator
+
+[![Gem Version](https://badge.fury.io/rb/completely.svg)](https://badge.fury.io/rb/completely)
+[![Build Status](https://github.com/DannyBen/completely/workflows/Test/badge.svg)](https://github.com/DannyBen/completely/actions?query=workflow%3ATest)
+
+---
+
+Completely is a command line utility and a Ruby library that lets you generate
+bash completion scripts from simple YAML configuration.
+
+This tool is for you it:
+
+1. You develop your own command line tools.
+2. Your life feels empty without bash completions.
+3. Bash completion scripts scare you.
+
+---
+
+
+## Install
+
+```
+$ gem install completely
+```
+
+## Usage
+
+The `completely` command line works with a simple YAML configuration file as
+input, and generates a bash completions script as output.
+
+The configuration file is built like this:
+
+```yaml
+pattern:
+  - --argument
+  - --param
+  - command
+```
+
+You can save a sample YAML file by running:
+
+```
+$ completely new
+```
+
+This will generate a file named `completely.yaml` with this content:
+
+```yaml
+mygit:
+- --help
+- --version
+- status
+- init
+- commit
+
+mygit status:
+- --help
+- --verbose
+- --branch
+
+mygit init:
+- --bare
+- <directory>
+
+mygit commit:
+- <file>
+- --help
+- --message
+- --all
+- -a
+- --quiet
+- -q
+```
+
+Each pattern in this configuration file will be checked against the user's
+input, and if the input **starts with** a matching pattern, the list that 
+follows it will be suggested as completions.
+
+To generate the bash script, simply run:
+
+```
+$ completely generate
+
+# or, to just preview it without saving:
+$ completely preview
+```
+
+For more options (like setting input/output path), run
+
+```
+$ completely --help
+```
+
+### Suggesting files and directories
+
+You may have noticed that the sample file contains two special entries:
+
+- `<file>`
+- `<directory>`
+
+These patterns will add the list of files and directories
+(when `<file>` is used) or just directories (when `<directory` is used) to
+the list of suggestions.
+
+For those interested in the technical details, any word between `<...>` will
+simply be added using the [`compgen -A action`][compgen] function, so you can 
+in fact use any of its supported arguments.
+
+
+### Using the generated completion scripts
+
+In order to enable the completions, simply source the generated script:
+
+```
+$ source completely.bash
+```
+
+You may wish to add this to your `~/.bashrc` file to enable this for future
+sessions (just be sure to use absolute path).
+
+
+## Contributing / Support
+
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+---
+
+[issues]: https://github.com/DannyBen/completely/issues
+[compgen]: https://www.gnu.org/software/bash/manual/html_node/Programmable-Completion-Builtins.html

data/bin/completely

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+require 'completely'
+require 'completely/cli'
+require 'colsole'
+include Colsole
+
+runner = Completely::CLI.runner
+
+begin
+  exit runner.run ARGV
+
+rescue => e
+  puts e.backtrace.reverse if ENV['DEBUG']
+  say! "!undred!#{e.class}!txtrst!\n#{e.message}"
+  exit 1
+end

data/lib/completely.rb

@@ -0,0 +1,9 @@
+require 'requires'
+
+if ENV['BYEBUG']
+  require 'byebug'
+  require 'lp'
+end
+
+# requires 'completely'
+require 'completely/completions'

data/lib/completely/cli.rb

@@ -0,0 +1,11 @@
+require 'mister_bin'
+require 'completely/command'
+require 'completely/version'
+
+module Completely
+  class CLI
+    def self.runner
+      MisterBin::Runner.new handler: Command
+    end
+  end
+end

data/lib/completely/command.rb

@@ -0,0 +1,72 @@
+module Completely
+  class Command < MisterBin::Command
+    help "Bash completion script generator"
+    version Completely::VERSION
+
+    usage "completely new [CONFIG_PATH]"
+    usage "completely preview [CONFIG_PATH --function NAME]"
+    usage "completely generate [CONFIG_PATH OUTPUT_PATH --function NAME]"
+    usage "completely (-h|--help|--version)"
+
+    command "new", "Create a new sample YAML configuration file"
+    command "preview", "Generate the bash completion script to STDOUT"
+    command "generate", "Generate the bash completion script to a file"
+
+    option "-f --function NAME", "Modify the name of the function in the generated script"
+
+    param "CONFIG_PATH", "Path to the YAML configuration file"
+    param "OUTPUT_PATH", "Path to the output bash script"
+
+    example "completely new"
+    example "completely new input.yaml"
+    example "completely preview --function my_completions"
+    example "completely generate"
+    example "completely generate input.yaml"
+    example "completely generate input.yaml output.sh -f my_completions"
+
+    def new_command
+      if File.exist? config_path
+        raise "File already exists: #{config_path}"
+      else
+        File.write config_path, sample
+        say "Saved !txtpur!#{config_path}"
+      end
+    end
+
+    def preview_command
+      puts script
+    end
+    
+    def generate_command
+      File.write output_path, script
+      say "Saved !txtpur!#{output_path}"
+    end
+
+  private
+
+    def config_path
+      @config_path ||= args['CONFIG_PATH'] || "completely.yaml"
+    end
+
+    def output_path
+      @output_path ||= args['OUTPUT_PATH'] || "completely.bash"
+    end
+
+    def sample
+      @sample ||= File.read(sample_path)
+    end
+
+    def sample_path
+      @sample_path ||= File.expand_path("sample.yaml", __dir__)
+    end
+
+    def script
+      @script ||= completions.script
+    end
+
+    def completions
+      @completions ||= Completions.load(config_path, function_name: args['--function'])
+    end
+
+  end
+end

data/lib/completely/completions.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+require 'erb'
+
+module Completely
+  class Completions
+    attr_reader :config, :function_name
+
+    class << self
+      def load(config_path, function_name: nil)
+        new YAML.load_file(config_path), function_name: function_name
+      end
+    end
+
+    def initialize(config, function_name: nil)
+      @config, @function_name = config, function_name
+    end
+
+    def script
+      ERB.new(template, trim_mode: '%-').result(binding)
+    end
+
+  private
+
+    def template_path
+      @template_path ||= File.expand_path("template.erb", __dir__)
+    end
+
+    def template
+      @template ||= File.read(template_path)
+    end
+
+    def command
+      @command ||= config.keys.first
+    end
+
+    def patterns
+      @patterns ||= config.to_a.sort_by { |k, v| -k.size }.to_h
+    end
+
+    def function_name
+      @function_name ||= "_#{command}_completions"
+    end
+
+  end
+end

data/lib/completely/sample.yaml

@@ -0,0 +1,24 @@
+mygit:
+- --help
+- --version
+- status
+- init
+- commit
+
+mygit status:
+- --help
+- --verbose
+- --branch
+
+mygit init:
+- --bare
+- <directory>
+
+mygit commit:
+- <file>
+- --help
+- --message
+- --all
+- -a
+- --quiet
+- -q

data/lib/completely/template.erb

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# This bash completions script was generated by
+# completely (https://github.com/dannyben/completely)
+# Modifying it manually is not recommended
+<%= function_name %>() {
+  local cur=${COMP_WORDS[COMP_CWORD]}
+
+  case "$COMP_LINE" in    
+% patterns.each do |pattern, words|
+% next unless words
+% clean_words = words.reject { |w| w =~ /^<.*>$/ }.join " "
+% functions = words.filter_map { |w| func = w[/^<(.+)>$/, 1] ; "-A #{func}" if func }
+% flags = functions.any? ? "#{functions.join ' '} -W" : "-W"
+    '<%= pattern %>'*) COMPREPLY=($(compgen <%= flags %> "<%= clean_words %>" -- "$cur")) ;;
+% end
+  esac
+}
+
+complete -F <%= function_name %> <%= command %>

data/lib/completely/version.rb

@@ -0,0 +1,3 @@
+module Completely
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: completely
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colsole
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: mister_bin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: requires
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Generate bash completion scripts using simple YAML configuration
+email: db@dannyben.com
+executables:
+- completely
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/completely
+- lib/completely.rb
+- lib/completely/cli.rb
+- lib/completely/command.rb
+- lib/completely/completions.rb
+- lib/completely/sample.yaml
+- lib/completely/template.erb
+- lib/completely/version.rb
+homepage: https://github.com/dannyben/completely
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key: 
+specification_version: 4
+summary: Bash Completions Generator
+test_files: []