- Rename command.deep_help to command.expose

DannyBen · DannyBen · commit 1efb2a63e530 · 2022-05-29T21:02:29.000Z
diff --git a/examples/command-groups/README.md b/examples/command-groups/README.md
@@ -70,13 +70,11 @@ Usage:
 
 File Commands:
   download   Download a file
-
-Commands:
   upload     Upload a file
-  logout     Delete login credentials to the config file
 
 Login Commands:
   login      Write login credentials to the config file
+  logout     Delete login credentials to the config file
 
 
 
@@ -94,13 +92,11 @@ Usage:
 
 File Commands:
   download   Download a file
-
-Commands:
   upload     Upload a file
-  logout     Delete login credentials to the config file
 
 Login Commands:
   login      Write login credentials to the config file
+  logout     Delete login credentials to the config file
 
 Options:
   --help, -h
diff --git a/examples/commands-expose/.gitignore b/examples/commands-expose/.gitignore
diff --git a/examples/commands-expose/README.md b/examples/commands-expose/README.md
@@ -1,4 +1,4 @@
-# Commands Deep Help Example
+# Commands Expose Example
 
 Demonstrates how to show the summary help of subcommands in the `--help`
 message of their parent command.
@@ -25,10 +25,10 @@ commands:
 - name: config
   help: Config management commands
 
-  # Setting `deep_help` to true will show the summary of the commands when
-  # running the help for this command. In this case, `config edit` and
+  # Setting `expose` to true will show the summary of the subcommands when
+  # running the help for the parent command. In this case, `config edit` and
   # `config show` will be displayed when running `cli --help`.
-  deep_help: true
+  expose: true
   commands:
   - name: edit
     help: Edit config file
@@ -38,9 +38,11 @@ commands:
 - name: server
   help: Server management commands
   
-  # Adding a `group` works well with `deep_help`.
-  deep_help: true
+  # Adding a `group` works well with `expose`. In this case, `server start` and
+  # `server stop` will be listed under `Cluster Commands`.
+  expose: true
   group: Cluster
+
   commands:
   - name: start
     help: Start the server
@@ -50,7 +52,7 @@ commands:
 - name: container
   alias: c
   help: Container management commands
-  deep_help: true
+  expose: true
   group: Cluster
   commands:
   - name: exec
diff --git a/examples/commands-expose/src/bashly.yml b/examples/commands-expose/src/bashly.yml
@@ -7,10 +7,10 @@ commands:
 - name: config
   help: Config management commands
 
-  # Setting `deep_help` to true will show the summary of the commands when
-  # running the help for this command. In this case, `config edit` and
+  # Setting `expose` to true will show the summary of the subcommands when
+  # running the help for the parent command. In this case, `config edit` and
   # `config show` will be displayed when running `cli --help`.
-  deep_help: true
+  expose: true
   commands:
   - name: edit
     help: Edit config file
@@ -20,9 +20,11 @@ commands:
 - name: server
   help: Server management commands
   
-  # Adding a `group` works well with `deep_help`.
-  deep_help: true
+  # Adding a `group` works well with `expose`. In this case, `server start` and
+  # `server stop` will be listed under `Cluster Commands`.
+  expose: true
   group: Cluster
+
   commands:
   - name: start
     help: Start the server
@@ -32,11 +34,10 @@ commands:
 - name: container
   alias: c
   help: Container management commands
-  deep_help: true
+  expose: true
   group: Cluster
   commands:
   - name: exec
     help: Run a command in the container
   - name: down
     help: Terminate a container
-
diff --git a/examples/commands-expose/test.sh b/examples/commands-expose/test.sh
diff --git a/lib/bashly/concerns/command_scopes.rb b/lib/bashly/concerns/command_scopes.rb
@@ -23,7 +23,7 @@ def command_help_data
       public_commands.each do |command|
         result[command.group_string] ||= {}
         result[command.group_string][command.name] = command.summary_string
-        next unless command.deep_help
+        next unless command.expose
 
         command.public_commands.each do |subcommand|
           result[command.group_string]["#{command.name} #{subcommand.name}"] = subcommand.summary_string
diff --git a/lib/bashly/script/command.rb b/lib/bashly/script/command.rb
@@ -8,8 +8,8 @@ class << self
         def option_keys
           @option_keys ||= %i[
             alias args catch_all commands completions
-            deep_help default dependencies environment_variables examples
-            extensible filename filters flags
+            default dependencies environment_variables examples
+            extensible expose filename filters flags
             footer group help name
             private version
             short
diff --git a/spec/approvals/examples/commands-expose b/spec/approvals/examples/commands-expose
diff --git a/spec/approvals/script/command/exposed_commands b/spec/approvals/script/command/exposed_commands
@@ -0,0 +1,13 @@
+---
+'Commands:':
+  init: Start a new project
+  config: Config management commands
+  config edit: Edit config file
+  config show: Show config file
+'Cluster Commands:':
+  server: Server management commands
+  server start: Start the server
+  server stop: Stop the server
+  container: Container management commands
+  container exec: Run a command in the container
+  container down: Terminate a container
diff --git a/spec/bashly/message_strings_spec.rb b/spec/bashly/message_strings_spec.rb
@@ -16,6 +16,10 @@
       cp config_template, userspace
     end
 
+    after do
+      reset_tmp_dir
+    end
+
     it "returns values from the user config, falling back to defaults" do
       expect(subject[:usage]).to eq "== Usage ==\\n"
     end
diff --git a/spec/bashly/script/command_spec.rb b/spec/bashly/script/command_spec.rb
@@ -83,6 +83,15 @@
     end
   end
 
+  describe '#command_help_data' do
+    let(:fixture) { :exposed }
+
+    it "returns a hash suitable for showing command and exposed subcommand help" do
+      expect(subject.command_help_data.to_yaml)
+        .to match_approval('script/command/exposed_commands')
+    end
+  end
+
   describe '#command_names' do
     let(:fixture) { :docker }
 
@@ -225,6 +234,20 @@
     end
   end
 
+  describe '#group_string' do
+    it "returns a string suitable for showing the group in usage" do
+      expect(subject.group_string).to eq "Commands:"
+    end
+
+    context "when the command is grouped" do
+      let(:fixture) { :grouped }
+
+      it "returns group string" do
+        expect(subject.group_string).to eq "Repository Commands:"
+      end
+    end
+  end
+
   describe '#load_user_file' do
     before do      
       Dir.mkdir 'spec/tmp/src' unless Dir.exist? 'spec/tmp/src'
@@ -311,6 +334,20 @@
     end
   end
 
+  describe '#summary_string' do
+    it "returns the user defined summary" do
+      expect(subject.summary_string).to eq "get something from somewhere"
+    end
+
+    context "when the command is the default" do
+      let(:fixture) { :default_command }
+
+      it "returns group string" do
+        expect(subject.default_command.summary_string).to eq "get this (default)"
+      end
+    end
+  end
+
   describe '#usage_string' do
     context "when no args and no commands are defined" do
       let(:fixture) { :git_status }
diff --git a/spec/fixtures/script/commands.yml b/spec/fixtures/script/commands.yml
@@ -109,6 +109,7 @@
   name: cli
   commands:
   - name: get
+    help: get this
     default: true
   - name: post
   - name: put
@@ -139,6 +140,40 @@
   help: perform docker container run
   parents: [docker, container]
 
+:exposed:
+  name: cli
+  commands:
+  - name: init
+    help: Start a new project
+  - name: config
+    help: Config management commands
+    expose: true
+    commands:
+    - name: edit
+      help: Edit config file
+    - name: show
+      help: Show config file
+  - name: server
+    help: Server management commands
+    expose: true
+    group: Cluster
+    commands:
+    - name: start
+      help: Start the server
+    - name: stop
+      help: Stop the server
+
+  - name: container
+    alias: c
+    help: Container management commands
+    expose: true
+    group: Cluster
+    commands:
+    - name: exec
+      help: Run a command in the container
+    - name: down
+      help: Terminate a container
+
 :filters_array:
   name: run
   filters:
@@ -171,6 +206,10 @@
   help: perform git status
   parents: [git]
 
+:grouped:
+  name: push
+  group: Repository
+
 :helpless:
   name: helpless
 
