completely 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba5123d5b0bf95ed7ea2140188a6079e0510456a754d5fd93830df1382862274
-  data.tar.gz: 0f98b90e1515d753b94817932916aad966b8b3f81ede79f1bbb40a898b82662e
+  metadata.gz: c09f951fc28b18f24c2c28fd7c80a15b3731aa07456145ab905c63c2b0dc9634
+  data.tar.gz: a9a25173ab3358e7eea42fe38552cbced8c6602bf5a0e9e6c414555420ae7af6
 SHA512:
-  metadata.gz: e3618affd00e4a624b288ae7c37fd0d857fd9cf0672d6bcc8c558eb7870e2e3001e86a1c6997bc177def3b245bdc1142287539d99423dc175f6e208a9bf8a3b9
-  data.tar.gz: a34bc567cbf492e437168afeb0a509f392eb1600a49622136d50728a936c024ad90e757d3a3ede18b0b7204302b09e08567054c73f75ea03fd3cdea9d39074e3
+  metadata.gz: b6edd13c5a0084485b7cb7114c45cf30d8c144075a3791aa51a8f5e7fc71df825cb03cb4786bc8fb3832f7bc1a46f06876614493184c4602d7e2e0dfbd3d4854
+  data.tar.gz: f8eb6cb08636c4281b50d7542d3c92fc8c6914e10597605f48e29ae342b6fb8cd31fff84de9e81dc0a7011bd5e963469c11fe025719e537238883d0a5812b5d9

data/README.md

@@ -100,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
@@ -136,6 +136,10 @@ 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"
 ```
 
 

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.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Danny Ben Shitrit