completely 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd3ae4ec92d7318bd4ef32fdd465d9bff3341931f5f965d2db8f263c1b95e38b
-  data.tar.gz: 01ccb2fa2e1f050b7a45944b552590fad6aab9bafc90ef4cb98b8d6284200392
+  metadata.gz: c09f951fc28b18f24c2c28fd7c80a15b3731aa07456145ab905c63c2b0dc9634
+  data.tar.gz: a9a25173ab3358e7eea42fe38552cbced8c6602bf5a0e9e6c414555420ae7af6
 SHA512:
-  metadata.gz: fd06256b9cb4c42364d118ea1392b180ef662e98b2ea9c6b24ca815f5fa5cf1f16d6c0a6792090c9bc5f376ab7dfb04e9b8c732cb83292140acb59676d6090a9
-  data.tar.gz: b1985849259627803ebe3f7c56b4adc98137456b172fb36cbf1379b4677257dca6cc671d85a12106596fb246de02aad07c5e9d51c5dd0abc7301518d9b7529b2
+  metadata.gz: b6edd13c5a0084485b7cb7114c45cf30d8c144075a3791aa51a8f5e7fc71df825cb03cb4786bc8fb3832f7bc1a46f06876614493184c4602d7e2e0dfbd3d4854
+  data.tar.gz: f8eb6cb08636c4281b50d7542d3c92fc8c6914e10597605f48e29ae342b6fb8cd31fff84de9e81dc0a7011bd5e963469c11fe025719e537238883d0a5812b5d9

data/README.md

@@ -2,13 +2,14 @@
 
 [![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)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6c021b8309ac796c3919/maintainability)](https://codeclimate.com/github/DannyBen/completely/maintainability)
 
 ---
 
 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:
+This tool is for you if:
 
 1. You develop your own command line tools.
 2. Your life feels empty without bash completions.
@@ -19,11 +20,11 @@ This tool is for you it:
 
 ## Install
 
-```
+```bash
 $ gem install completely
 ```
 
-## Usage
+## Using the `completely` command line
 
 The `completely` command line works with a simple YAML configuration file as
 input, and generates a bash completions script as output.
@@ -78,7 +79,7 @@ follows it will be suggested as completions.
 
 To generate the bash script, simply run:
 
-```
+```bash
 $ completely generate
 
 # or, to just preview it without saving:
@@ -87,7 +88,7 @@ $ completely preview
 
 For more options (like setting input/output path), run
 
-```
+```bash
 $ completely --help
 ```
 
@@ -99,7 +100,7 @@ You may have noticed that the sample file contains two special entries:
 - `<directory>`
 
 These patterns will add the list of files and directories
-(when `<file>` is used) or just directories (when `<directory` is used) to
+(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
@@ -107,17 +108,40 @@ 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
+## Using the generated completion scripts
 
 In order to enable the completions, simply source the generated script:
 
-```
+```bash
 $ 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).
 
+## Using from within Ruby code
+
+```ruby
+require 'completely'
+
+# Load from file
+completions = Completely::Completions.load "input.yaml"
+
+# Or, from a hash
+input = {
+  "mygit" => %w[--help --version status init commit],
+  "mygit status" => %w[--help --verbose --branch]
+}
+completions = Completely::Completions.new input
+
+# Generate the script
+puts completions.script
+
+# Or, generate a function that echos the script
+puts completions.wrapper_function
+puts completions.wrapper_function "custom_function_name"
+```
+
 
 ## Contributing / Support
 

data/lib/completely/cli.rb

@@ -1,6 +1,6 @@
 require 'mister_bin'
-require 'completely/command'
 require 'completely/version'
+require 'completely/command'
 
 module Completely
   class CLI

data/lib/completely/command.rb

@@ -5,7 +5,7 @@ module Completely
 
     usage "completely new [CONFIG_PATH]"
     usage "completely preview [CONFIG_PATH --function NAME]"
-    usage "completely generate [CONFIG_PATH OUTPUT_PATH --function NAME]"
+    usage "completely generate [CONFIG_PATH OUTPUT_PATH --function NAME --wrap NAME]"
     usage "completely (-h|--help|--version)"
 
     command "new", "Create a new sample YAML configuration file"
@@ -13,16 +13,18 @@ module Completely
     command "generate", "Generate the bash completion script to a file"
 
     option "-f --function NAME", "Modify the name of the function in the generated script"
+    option "-w --wrap NAME", "Wrap the completion script inside a function that echos the script. This is useful if you wish to embed it directly in your 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 preview --function _my_completions"
     example "completely generate"
     example "completely generate input.yaml"
-    example "completely generate input.yaml output.sh -f my_completions"
+    example "completely generate input.yaml output.sh -f _my_completions"
+    example "completely generate -w give_comps -f my_completions"
 
     def new_command
       if File.exist? config_path
@@ -38,7 +40,9 @@ module Completely
     end
     
     def generate_command
-      File.write output_path, script
+      wrap = args['--wrap']
+      output = wrap ? wrapper_function(wrap) : script
+      File.write output_path, output
       say "Saved !txtpur!#{output_path}"
     end
 
@@ -64,6 +68,10 @@ module Completely
       @script ||= completions.script
     end
 
+    def wrapper_function(wrapper_name)
+      completions.wrapper_function wrapper_name
+    end
+
     def completions
       @completions ||= Completions.load(config_path, function_name: args['--function'])
     end

data/lib/completely/completions.rb

@@ -19,6 +19,17 @@ module Completely
       ERB.new(template, trim_mode: '%-').result(binding)
     end
 
+    def wrapper_function(name = nil)
+      name ||= "send_completions"
+
+      script_lines = script.split("\n").map do |line|
+        clean_line = line.gsub("'") { "\\'" }
+        %Q[  echo $'#{clean_line}']
+      end.join("\n")
+
+      "#{name}() {\n#{script_lines}\n}"
+    end
+
   private
 
     def template_path

data/lib/completely/template.erb

@@ -6,7 +6,7 @@
 <%= function_name %>() {
   local cur=${COMP_WORDS[COMP_CWORD]}
 
-  case "$COMP_LINE" in    
+  case "$COMP_LINE" in
 % patterns.each do |pattern, words|
 % next unless words
 % clean_words = words.reject { |w| w =~ /^<.*>$/ }.join " "

data/lib/completely/version.rb

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

data/lib/completely.rb

@@ -1,5 +1,3 @@
-require 'requires'
-
 if ENV['BYEBUG']
   require 'byebug'
   require 'lp'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !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: