add specs for completions concern

Author: DannyBen

lib/bashly/commands/add.rb

@@ -23,6 +23,10 @@ class Add < Base
       command "yaml", "Add standard functions for reading YAML files to the lib directory."
       command "comp", "Generate a bash completions script or function."
 
+      example "bashly add strings --force"
+      example "bashly add comp function"
+      example "bashly add comp script completions.bash"
+
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
 
       def strings_command
@@ -111,12 +115,18 @@ def save_comp_yaml(filename = nil)
         filename ||= "completions.yaml"
         File.write filename, completions.to_yaml
         say "created !txtgrn!#{filename}"
+        say ""
+        say "This file can be converted to a completions script using the !txtgrn!completely!txtrst! gem."
       end
 
       def save_comp_script(filename = nil)
         filename ||= "completions.bash"
         File.write filename, completions_script
         say "created !txtgrn!#{filename}"
+        say ""
+        say "To enable completions, run:"
+        say ""
+        say "  !txtpur!$ source #{filename}"
       end
 
       def save_comp_function(name = nil)
@@ -126,8 +136,13 @@ def save_comp_function(name = nil)
 
         FileUtils.mkdir_p target_dir unless Dir.exist? target_dir
         File.write filename, completions_function
-        
+
         say "created !txtgrn!#{filename}"
+        say ""
+        say "In order to use it in your script, create a command or a flag (for example: !txtgrn!#{command.name} completions!txtrst! or !txtgrn!#{command.name} --completions!txtrst!) that calls the !txtgrn!#{name}!txtrst! function."
+        say "Your users can then run something like this to enable completions:"
+        say ""
+        say "  !txtpur!$ eval \"$(#{command.name} completions)\""
       end
 
     end

lib/bashly/concerns/completions.rb

@@ -43,7 +43,7 @@ def completion_words(with_version: false)
         completion_flag_names + completion_actions
       )
 
-      all.uniq.sort
+      all.compact.uniq.sort
     end
 
   end

lib/bashly/concerns/renderable.rb

@@ -4,10 +4,7 @@ module Bashly
   module Renderable
     def render(view)
       template = File.read view_path(view)
-      # TODO: This new format is only supported in Ruby >= 2.6
-      #       So for now, we keep the old deprecated syntax
-      # ERB.new(template, trim_mode: '%-').result(binding)
-      ERB.new(template, nil, '%-').result(binding)
+      ERB.new(template, trim_mode: '%-').result(binding)
     end
 
     def strings

spec/approvals/cli/add/help

@@ -53,3 +53,8 @@ Parameters:
 Environment Variables:
   BASHLY_SOURCE_DIR
     The path containing the bashly configuration and source files [default: src]
+
+Examples:
+  bashly add strings --force
+  bashly add comp function
+  bashly add comp script completions.bash

spec/approvals/completions/advanced

@@ -0,0 +1,28 @@
+---
+say:
+- "--help"
+- "--version"
+- "-h"
+- "-v"
+- goodbye
+- hello
+say hello:
+- "--help"
+- "-h"
+- world
+say hello world:
+- "--force"
+- "--help"
+- "--verbose"
+- "-h"
+say goodbye:
+- "--help"
+- "-h"
+- universe
+say goodbye universe:
+- "--color"
+- "--help"
+- "--verbose"
+- "-c"
+- "-h"
+- "-v"

spec/approvals/completions/function

@@ -0,0 +1,16 @@
+custom_name() {
+  echo $'#!/usr/bin/env bash'
+  echo $''
+  echo $'# This bash completions script was generated by'
+  echo $'# completely (https://github.com/dannyben/completely)'
+  echo $'# Modifying it manually is not recommended'
+  echo $'_get_completions() {'
+  echo $'  local cur=${COMP_WORDS[COMP_CWORD]}'
+  echo $''
+  echo $'  case "$COMP_LINE" in'
+  echo $'    \'get\'*) COMPREPLY=($(compgen -W "--force --help --verbose --version -h -v" -- "$cur")) ;;'
+  echo $'  esac'
+  echo $'}'
+  echo $''
+  echo $'complete -F _get_completions get'
+}

spec/approvals/completions/script

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+# This bash completions script was generated by
+# completely (https://github.com/dannyben/completely)
+# Modifying it manually is not recommended
+_say_completions() {
+  local cur=${COMP_WORDS[COMP_CWORD]}
+
+  case "$COMP_LINE" in
+    'say goodbye universe'*) COMPREPLY=($(compgen -W "--color --help --verbose -c -h -v" -- "$cur")) ;;
+    'say hello world'*) COMPREPLY=($(compgen -W "--force --help --verbose -h" -- "$cur")) ;;
+    'say goodbye'*) COMPREPLY=($(compgen -W "--help -h universe" -- "$cur")) ;;
+    'say hello'*) COMPREPLY=($(compgen -W "--help -h world" -- "$cur")) ;;
+    'say'*) COMPREPLY=($(compgen -W "--help --version -h -v goodbye hello" -- "$cur")) ;;
+  esac
+}
+
+complete -F _say_completions say

spec/approvals/completions/simple

@@ -0,0 +1,8 @@
+---
+get:
+- "--force"
+- "--help"
+- "--verbose"
+- "--version"
+- "-h"
+- "-v"

spec/bashly/concerns/completions_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Models::Command do
+  let(:fixture) { :completions_simple }
+
+  subject do
+    options = load_fixture('models/commands')[fixture]
+    described_class.new options
+  end
+
+  describe '#completion_data' do
+    it "returns a data structure for completely" do
+      expect(subject.completion_data.to_yaml).to match_approval("completions/simple")
+    end
+  end
+
+  describe '#completion_function' do
+    it "returns a bash completion script wrapped in a function" do
+      expect(subject.completion_function "custom_name")
+        .to match_approval("completions/function")
+    end
+  end
+
+  context "with a more complex command" do
+    let(:fixture) { :completions_advanced }
+
+    describe '#completion_data' do
+      it "returns a data structure for completely" do
+        expect(subject.completion_data.to_yaml)
+          .to match_approval("completions/advanced")
+      end
+    end
+
+    describe '#completion_script' do
+      it "returns a bash completion script" do
+        expect(subject.completion_script)
+          .to match_approval("completions/script")
+      end
+    end
+  end
+end

spec/fixtures/models/commands.yml

@@ -127,3 +127,28 @@
   catch_all:
     label: additional params
     help: Any additional argument or flag
+
+:completions_simple:
+  name: get
+
+  flags:
+  - long: --force
+  - long: --verbose
+
+:completions_advanced:
+  name: say
+  commands:
+  - name: hello
+    commands:
+    - name: world
+      flags:
+      - long: --force
+      - long: --verbose
+  - name: goodbye
+    commands:
+    - name: universe
+      flags:
+      - long: --color
+        short: -c
+      - long: --verbose
+        short: -v