specs for new catch_all updates

Author: DannyBen

examples/catch-all-advanced/cli

@@ -112,7 +112,7 @@ cli_upload_usage() {
   echo
 
   printf "Usage:\n"
-  printf "  cli upload SOURCE [options]\n"
+  printf "  cli upload FILES...\n"
   printf "  cli upload --help | -h\n"
   echo
 
@@ -122,22 +122,12 @@ cli_upload_usage() {
     echo "  --help, -h"
     printf "    Show this help\n"
     echo
-    # :command.usage_flags
-    # :flag.usage
-    echo "  --user, -u USER (required)"
-    printf "    Username to use for logging in\n"
-    echo
-    
-    # :flag.usage
-    echo "  --password, -p PASSWORD"
-    printf "    Password to use for logging in\n"
-    echo
+
     # :command.usage_args
     printf "Arguments:\n"
 
-    # :argument.usage
-    echo "  SOURCE"
-    printf "    File to upload\n"
+    echo "  FILES..."
+    printf "    Files to upload\n"
     echo
 
   fi
@@ -340,67 +330,30 @@ cli_upload_parse_requirements() {
   # :command.command_filter
   action="upload"
   # :command.required_args_filter
-  if [[ $1 && $1 != -* ]]; then
-    args[source]=$1
-    shift
-  else
-    printf "missing required argument: SOURCE\nusage: cli upload SOURCE [options]\n"
-    exit 1
-  fi
   # :command.required_flags_filter
-  argstring="$*"
-  if [[ "$argstring" != *--user* && "$argstring" != *-u* ]]; then
-    printf "missing required flag: --user, -u USER\n"
-    exit 1
-  fi
   # :command.parse_requirements_while
   while [[ $# -gt 0 ]]; do
     key="$1"
     case "$key" in
-    # :flag.case
-    --user | -u )
-      if [[ $2 ]]; then
-        args[--user]="$2"
-        shift
-        shift
-      else
-        printf "%s\n" "--user requires an argument: --user, -u USER"
-        exit 1
-      fi
-      ;;
-  
-    # :flag.case
-    --password | -p )
-      if [[ $2 ]]; then
-        args[--password]="$2"
-        shift
-        shift
-      else
-        printf "%s\n" "--password requires an argument: --password, -p PASSWORD"
-        exit 1
-      fi
-      ;;
-  
 
     -* )
-      printf "invalid option: %s\n" "$key"
-      exit 1
+      other_args+=("$1")
+      shift
       ;;
 
     * )
       # :command.parse_requirements_case
-      if [[ ! ${args[source]} ]]; then
-        args[source]=$1
+        other_args+=("$1")
         shift
-      else
-        printf "invalid argument: %s\n" "$key"
-        exit 1
-      fi
       ;;
 
     esac
   done
   # :command.catch_all_filter
+  if [[ ${#other_args[@]} -eq 0 ]]; then
+    printf "missing required argument: FILES...\nusage: cli upload FILES...\n"
+    exit 1
+  fi
   # :command.default_assignments
   # :command.whitelist_filter
 }

examples/catch-all-advanced/src/bashly.yml

@@ -32,18 +32,11 @@ commands:
 - name: upload
   short: u
   help: Upload a file
-  args:
-  - name: source
-    required: true
-    help: File to upload
 
-  flags:
-  - long: --user
-    short: -u
-    arg: user
-    help: Username to use for logging in
+  # Configure catch_all for the `upload` sub-command using the extended
+  # syntax, and specifying that `catch_all` is required (which means that at 
+  # least one extra argument must be provided)
+  catch_all:
+    label: Files
+    help: Files to upload
     required: true
-  - long: --password
-    short: -p
-    arg: password
-    help: Password to use for logging in

examples/catch-all-advanced/test.sh

@@ -12,4 +12,8 @@ bashly generate
 ./cli download -h
 ./cli download source
 ./cli download source target
-./cli download source target and --additional stuff
+./cli download source target and --additional stuff
+
+./cli upload -h
+./cli upload
+./cli upload file1 "file 2" file3

lib/bashly/models/command.rb

@@ -43,11 +43,6 @@ def catch_all_label
         end
       end
 
-      # Returns a string suitable for catch all usage text
-      def catch_all_usage
-        catch_all_required? ? catch_all_label : "[#{catch_all_label}]"
-      end
-
       # Returns a used defined help string for the catch_all directive
       def catch_all_help
         return nil unless catch_all
@@ -64,6 +59,12 @@ def catch_all_required?
         catch_all.is_a?(Hash) and catch_all['required']
       end
 
+      # Returns a string suitable for catch_all Usage pattern
+      def catch_all_usage
+        return nil unless catch_all
+        catch_all_required? ? catch_all_label : "[#{catch_all_label}]"
+      end
+
       # Returns only the names of the Commands
       def command_names
         commands.map &:name
@@ -200,7 +201,7 @@ def usage_string
           result << arg.usage_string
         end
         result << "[options]" unless flags.empty?
-        result << "#{catch_all_usage}" if catch_all
+        result << catch_all_usage if catch_all
         result.join " "
       end
 

spec/approvals/examples/catch-all-advanced

@@ -73,3 +73,34 @@ other_args:
 - ${other_args[0]} = and
 - ${other_args[1]} = --additional
 - ${other_args[2]} = stuff
++ ./cli upload -h
+cli upload - Upload a file
+
+Shortcut: u
+
+Usage:
+  cli upload FILES...
+  cli upload --help | -h
+
+Options:
+  --help, -h
+    Show this help
+
+Arguments:
+  FILES...
+    Files to upload
+
++ ./cli upload
+missing required argument: FILES...
+usage: cli upload FILES...
++ ./cli upload file1 'file 2' file3
+# this file is located in 'src/upload_command.sh'
+# code for 'cli upload' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args: none
+
+other_args:
+- ${other_args[*]} = file1 file 2 file3
+- ${other_args[0]} = file1
+- ${other_args[1]} = file 2
+- ${other_args[2]} = file3

spec/bashly/models/command_spec.rb

@@ -72,15 +72,15 @@
       let(:fixture) { :catch_all_string }
 
       it "returns an uppercase version of it" do
-        expect(subject.catch_all_label).to eq "EXTRA PARAMS..."
+        expect(subject.catch_all_label).to eq "EXTRA_PARAMS..."
       end
     end
 
     context "when catch_all['label'] is a string" do
       let(:fixture) { :catch_all_hash }
 
       it "returns an uppercase version of it" do
-        expect(subject.catch_all_label).to eq "ADDITIONAL PARAMS..."
+        expect(subject.catch_all_label).to eq "ADDITIONAL_PARAMS..."
       end
     end
 
@@ -115,7 +115,62 @@
         expect(subject.catch_all_help).to be_nil
       end
     end
+  end
+
+  describe '#catch_all_required?' do
+    context "when catch_all is disabled" do
+      it "returns false" do
+        expect(subject.catch_all_required?).to be false
+      end
+    end
+
+    context "when catch_all['required'] is true" do
+      let(:fixture) { :catch_all_hash }
+
+      it "returns true" do
+        expect(subject.catch_all_required?).to be true
+      end
+    end
+
+    context "in other cases" do
+      let(:fixture) { :catch_all_string }
+
+      it "returns false" do
+        expect(subject.catch_all_required?).to be false
+      end
+    end
+  end
 
+  describe '#catch_all_usage' do
+    context "when catch_all is disabled" do
+      it "returns nil" do
+        expect(subject.catch_all_usage).to be_nil
+      end
+    end
+
+    context "when catch_all['required'] is true" do
+      let(:fixture) { :catch_all_hash }
+
+      it "returns a usage help without []" do
+        expect(subject.catch_all_usage).to eq "ADDITIONAL_PARAMS..."
+      end
+    end
+
+    context "when catch_all['required'] is false" do
+      let(:fixture) { :catch_all_string }
+
+      it "returns a usage help with []" do
+        expect(subject.catch_all_usage).to eq "[EXTRA_PARAMS...]"
+      end
+    end
+
+    context "when catch_all is true" do
+      let(:fixture) { :catch_all }
+
+      it "returns [...]" do
+        expect(subject.catch_all_usage).to eq "[...]"
+      end
+    end
   end
 
   describe '#command_names' do

spec/fixtures/models/commands.yml

@@ -119,14 +119,15 @@
 :catch_all_string:
   name: get
   help: get something from somewhere
-  catch_all: extra params
+  catch_all: extra_params
 
 :catch_all_hash:
   name: get
   help: get something from somewhere
   catch_all:
-    label: additional params
+    label: additional_params
     help: Any additional argument or flag
+    required: true
 
 :completions_simple:
   name: get