complete specs

Author: DannyBen

Gemfile

@@ -8,6 +8,12 @@ gem 'runfile'
 gem 'runfile-tasks'
 gem 'simplecov'
 
-gem 'completely', path: '/vagrant/gems/completely'
+# === REMOVE BEFORE FLIGHT ===
+if Dir.exist? '/vagrant/gems/completely'
+  gem 'completely', path: '/vagrant/gems/completely'
+else
+  gem 'completely', git: "https://github.com/dannyben/completely.git"
+end
+# === REMOVE BEFORE FLIGHT ===
 
 gemspec

lib/bashly/concerns/command_scopes.rb

@@ -10,16 +10,16 @@ def all_full_names
       end
     end
 
-    # Returns only the names of the Commands
-    def command_names
-      commands.map &:name
-    end
-
     # Returns a full list of the Command names and aliases combined
     def command_aliases
       commands.map(&:aliases).flatten
     end
 
+    # Returns only the names of the Commands
+    def command_names
+      commands.map &:name
+    end
+
     # Returns a flat array containing all the commands in this tree.
     # This includes self + children + grandchildres + ...
     def deep_commands

spec/approvals/completions/advanced

@@ -25,7 +25,14 @@ say goodbye universe:
 - "$(git branch)"
 - "--color"
 - "--help"
+- "--path"
 - "--verbose"
 - "-c"
 - "-h"
 - "-v"
+say goodbye universe*--color: &1
+- green
+- red
+say goodbye universe*-c: *1
+say goodbye universe*--path:
+- "<file>"

spec/approvals/completions/flag-allowed

@@ -0,0 +1,6 @@
+---
+some command*--protocol: &1
+- ssh
+- sftp
+- https
+some command*-p: *1

spec/approvals/completions/flag-completions

@@ -0,0 +1,5 @@
+---
+some command*--path: &1
+- "<file>"
+- README.md
+some command*-p: *1

spec/approvals/completions/script

@@ -11,7 +11,10 @@ _say_completions() {
   compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
 
   case "$compline" in
-    'goodbye universe'*) COMPREPLY=($(compgen -W "$(git branch) --color --help --verbose -c -h -v" -- "$cur")) ;;
+    'goodbye universe'*'--color') COMPREPLY=($(compgen -W "green red" -- "$cur")) ;;
+    'goodbye universe'*'--path') COMPREPLY=($(compgen -A file -- "$cur")) ;;
+    'goodbye universe'*'-c') COMPREPLY=($(compgen -W "green red" -- "$cur")) ;;
+    'goodbye universe'*) COMPREPLY=($(compgen -W "$(git branch) --color --help --path --verbose -c -h -v" -- "$cur")) ;;
     'hello world'*) COMPREPLY=($(compgen -A directory -A user -W "--force --help --verbose -h" -- "$cur")) ;;
     'goodbye'*) COMPREPLY=($(compgen -W "--help -h universe" -- "$cur")) ;;
     'hello'*) COMPREPLY=($(compgen -W "--help -h world" -- "$cur")) ;;

spec/bashly/concerns/completions_spec.rb renamed to spec/bashly/concerns/completions_command_spec.rb

@@ -1,12 +1,10 @@
 require 'spec_helper'
 
 describe Script::Command do
-  let(:fixture) { :completions_simple }
+  fixtures = load_fixture('script/commands')
 
-  subject do
-    options = load_fixture('script/commands')[fixture]
-    described_class.new options
-  end
+  let(:fixture) { :completions_simple }
+  subject { described_class.new fixtures[fixture] }
 
   describe '#completion_data' do
     it "returns a data structure for completely" do

spec/bashly/concerns/completions_flag_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Script::Flag do
+  fixtures = load_fixture('script/flags')
+
+  let(:fixture) { :basic_flag }
+  let(:command) { "some command"}
+  
+  subject { described_class.new fixtures[fixture] }
+
+  describe '#completion_data' do
+    context "when the flag has allowed defined" do
+      let(:fixture) { :completions_allowed }
+
+      it "returns a data structure for completely with the allowed list" do
+        expect(subject.completion_data(command).to_yaml).to match_approval("completions/flag-allowed")
+      end
+    end
+
+    context "when the flag has completions defined" do
+      let(:fixture) { :completions_completions }
+
+      it "returns a data structure for completely with the completions list" do
+        expect(subject.completion_data(command).to_yaml).to match_approval("completions/flag-completions")
+      end
+    end
+
+    context "when the flag does not have allowed or completions" do
+      it "returns an empty hash" do
+        expect(subject.completion_data(command)).to eq({})
+      end
+    end
+  end
+end

spec/bashly/script/command_spec.rb

@@ -2,11 +2,8 @@
 
 describe Script::Command do
   let(:fixture) { :basic_command }
-
-  subject do
-    options = load_fixture('script/commands')[fixture]
-    described_class.new options
-  end
+  fixtures = load_fixture('script/commands')
+  subject { described_class.new fixtures[fixture] }
 
   describe '#action_name' do
     context "when it is the root command" do
@@ -48,6 +45,14 @@
     end
   end
 
+  describe '#all_full_names' do
+    let(:fixture) { :aliases }
+    
+    it "returns an array of all full names including aliases" do
+      expect(subject.commands.first.all_full_names).to eq ["apt download", "apt d", "apt pull"]
+    end
+  end
+
   describe '#args' do
     it "returns an array of Argument objects" do
       expect(subject.args).to be_an Array
@@ -69,6 +74,14 @@
     end
   end
 
+  describe '#command_aliases' do
+    let(:fixture) { :aliases }
+
+    it "returns an array of command aliases" do
+      expect(subject.command_aliases).to eq ["download", "d", "pull", "upload", "u", "push", "update", "upgrade"]
+    end
+  end
+
   describe '#command_names' do
     let(:fixture) { :docker }
 

spec/fixtures/script/commands.yml

@@ -1,3 +1,13 @@
+:aliases:
+  name: apt
+  commands:
+  - name: download
+    alias: [d, pull]
+  - name: upload
+    alias: [u, push]
+  - name: update
+    alias: upgrade
+
 :basic_command:
   name: get
   alias: g
@@ -20,84 +30,6 @@
     required: true
   - name: target_folder
 
-:git_status:
-  name: status
-  help: perform git status
-  parents: [git]
-
-:docker:
-  name: docker
-  help: run docker commands
-  commands:
-  - name: container
-    commands:
-    - name: run
-    - name: stop
-  - name: image
-
-:docker_container_run:
-  name: run
-  help: perform docker container run
-  parents: [docker, container]
-
-:long_only_command:
-  name: get
-  help: get something from somewhere
-
-:flags_only_command:
-  name: status
-  help: perform git status
-  flags:
-  - long: --force
-  - long: --verbose
-  parents: [git]
-
-:helpless:
-  name: helpless
-
-:default_command:
-  name: cli
-  commands:
-  - name: get
-    default: true
-  - name: post
-  - name: put
-
-:flag_hog:
-  name: cli
-  help: test when -h and -v are defined
-  flags:
-  - short: -h
-    long: --hello
-  - short: -v
-    long: --vorld
-
-:default_values:
-  name: cli
-  args:
-  - name: files
-    default: "*.jpg"
-  flags:
-  - short: -f
-    long: --format
-    arg: format
-    default: png
-
-:whitelist:
-  name: cli
-  args:
-  - name: region
-    allowed: [eu, us]
-  - name: environment
-
-  flags:
-  - long: --user
-    arg: name
-    allowed: [user, admin]
-
-  - long: --protocol
-    arg: type
-
 :catch_all:
   name: get
   help: get something from somewhere
@@ -145,6 +77,9 @@
       flags:
       - long: --color
         short: -c
+        allowed: [green, red]
+      - long: --path
+        completions: [<file>]
       - long: --verbose
         short: -v
 
@@ -163,12 +98,46 @@
     arg: name
     allowed: [get, post]
 
+:custom_filename:
+  name: run
+  filename: ops/run_command.sh
+
 :custom_header:
   name: check
 
-:custom_filename:
+:default_command:
+  name: cli
+  commands:
+  - name: get
+    default: true
+  - name: post
+  - name: put
+
+:default_values:
+  name: cli
+  args:
+  - name: files
+    default: "*.jpg"
+  flags:
+  - short: -f
+    long: --format
+    arg: format
+    default: png
+
+:docker:
+  name: docker
+  help: run docker commands
+  commands:
+  - name: container
+    commands:
+    - name: run
+    - name: stop
+  - name: image
+
+:docker_container_run:
   name: run
-  filename: ops/run_command.sh
+  help: perform docker container run
+  parents: [docker, container]
 
 :filters_array:
   name: run
@@ -180,9 +149,54 @@
   name: run
   filters: docker_running
 
+:flag_hog:
+  name: cli
+  help: test when -h and -v are defined
+  flags:
+  - short: -h
+    long: --hello
+  - short: -v
+    long: --vorld
+
+:flags_only_command:
+  name: status
+  help: perform git status
+  flags:
+  - long: --force
+  - long: --verbose
+  parents: [git]
+
+:git_status:
+  name: status
+  help: perform git status
+  parents: [git]
+
+:helpless:
+  name: helpless
+
+:long_only_command:
+  name: get
+  help: get something from somewhere
+
 :repeatable_arg:
   name: get
   args:
   - name: source
   - name: target
     repeatable: true
+
+:whitelist:
+  name: cli
+  args:
+  - name: region
+    allowed: [eu, us]
+  - name: environment
+
+  flags:
+  - long: --user
+    arg: name
+    allowed: [user, admin]
+
+  - long: --protocol
+    arg: type
+