bashly 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d486637f9d7ec6604d0495aec9f2396f69153f8cd193c126d51bc7dbc329a62
-  data.tar.gz: 5c58b05ad9ccb84d432c42228b7594e678b033555e55ea275948d4e70be118c7
+  metadata.gz: 01c9356631608d3410b0feb58688189fe86eaa382cc69331e290dbf5f66dfdb0
+  data.tar.gz: 49a1f418c8b8f2743eeee74337e1a86239563a55e58f3afdabb2ecd8f8a9960c
 SHA512:
-  metadata.gz: 02fd6e6c50c5d370dde3d50047b0b6d317454c3d48531222711c6341c6e93d263cafa6a7d541bb939ff44a36b6025c9c8411e8f3820157c41e476312f4c64781
-  data.tar.gz: 031ea1db4c68fb6b780f01862b216178804cdc44f2e86fc66bc11f2910fff6d03ed250d7a01dd1c566d74c8f002ae6e9441bb13292f3e74620db455c993029e2
+  metadata.gz: 45f8ed4008439aee2571e768160cf5109dcf7a2ca770bccd74367ee1983e535a6db9c5cd28ec6438ca5de2091f4e0c7c4a86a3cd78e20ff19a283e840bff4760
+  data.tar.gz: 1a31d5dbe060275a17874d3bcce680d89a3c5a4f58582b011d0b955370d8c43092064b2da3b2033b705a3e1edd0d8b4501e9fc6c2ffe1f1e2ba2400e2b952a9f

data/README.md

@@ -196,19 +196,19 @@ The `bashly.yml` configuration file consists of these types:
 Unless otherwise specified, these definitiona can be used for both the root
 command and subcommands (under the `commands` definition).
 
-
  Option    | Description
 -----------|-------------
 `name`     | The name of the script or subcommand.
 `short`    | An additional, optional pattern - usually used to denote a one letter variation of the command name. You can add `*` as a suffix, to denote a "starts with" pattern - for example `short: m*`. *Applicable only in subcommands*.
 `help`     | The header text to display when using `--help`. This option can have multiple lines. In this case, the first line will be used as summary wherever appropriate.
 `version`  | The string to display when using `--version`. *Applicable only in the main command*.
-`default`  | Setting this to `yes` on any command, will make unrecognized command line arguments to be passed to this command. *Applicable only in subcommands*.
+`default`  | Setting this to `true` on any command, will make unrecognized command line arguments to be passed to this command. *Applicable only in subcommands*.
 `examples` | Specify an array of examples to show when using `--help`. Each example can have multiple lines.
 `environment_variables` | Specify an array of environment variables needed by your script. 
 `commands` | Specify the array of commands. Each command will have its own args and flags. Note: if `commands` is provided, you cannot specify flags or args at the same level.
 `args`     | Specify the array of positional arguments this script needs.
 `flags`    | Specify the array of option flags this script needs.
+`catch_all` | Specify that this command should allow for additional arbitrary arguments or flags. It can be set in one of three ways:<br>- Set to `true` to just enable it.<br>- Set to a string, to use this string in the usage help text.<br>- Set to a hash containing `label` and `help` keys, to show a detailed help for it when running with `--help`.
 `dependencies` | Specify an array of any required external dependencies (commands). The script execution will be halted with a friendly error unless all dependency commands exist.
 `group`    | In case you have many commands, use this option to specify a caption to display before this command. This option is purely for display purposes, and needs to be specified only for the first command in each group.
 

data/lib/bashly/models/base.rb

@@ -8,6 +8,7 @@ module Bashly
       OPTION_KEYS = %i[
         allowed
         arg
+        catch_all
         default
         dependencies
         description

data/lib/bashly/models/command.rb

@@ -28,6 +28,29 @@ module Bashly
         help ? "#{full_name} - #{summary}" : full_name
       end
 
+      # Returns a label for the catch_all directive
+      def catch_all_label
+        return nil unless catch_all
+
+        if catch_all.is_a? String
+          "#{catch_all.upcase}..."
+        elsif catch_all.is_a?(Hash) and catch_all['label'].is_a?(String)
+          "#{catch_all['label'].upcase}..."
+        else
+          "..."
+        end
+      end
+
+      def catch_all_help
+        return nil unless catch_all
+
+        if catch_all.is_a?(Hash) and catch_all['help'].is_a?(String)
+          catch_all['help']
+        else
+          nil
+        end
+      end
+
       # Returns only the names of the Commands
       def command_names
         commands.map &:name
@@ -159,6 +182,7 @@ module Bashly
           result << arg.usage_string
         end
         result << "[options]" unless flags.empty?
+        result << "[#{catch_all_label}]" if catch_all
         result.join " "
       end
 

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/lib/bashly/views/command/inspect_args.erb

@@ -7,4 +7,13 @@ inspect_args() {
   else
     echo args: none
   fi
+
+  if (( ${#other_args[@]} )); then
+    echo
+    echo other_args:
+    echo "- \${other_args[*]} = ${other_args[*]}"
+    for i in "${!other_args[@]}"; do
+      echo "- \${other_args[$i]} = ${other_args[$i]}"
+    done
+  fi
 }

data/lib/bashly/views/command/parse_requirements_case.erb

@@ -8,9 +8,17 @@
 <%- condition = "elif" -%>
 <%- end -%>
 else
+<%- if catch_all -%>
+  other_args+=("$1")
+  shift
+<%- else -%>
   printf "<%= strings[:invalid_argument] %>\n" "$key"
   exit 1
+<%- end -%>
 fi
+<%- elsif catch_all -%>
+  other_args+=("$1")
+  shift
 <%- else -%>
 printf "<%= strings[:invalid_argument] %>\n" "$key"
 exit 1

data/lib/bashly/views/command/parse_requirements_while.erb

@@ -8,9 +8,15 @@ while [[ $# -gt 0 ]]; do
   <%- end -%>
 
   -* )
+<%- if catch_all -%>
+    other_args+=("$1")
+    shift
+    ;;
+<%- else -%>
     printf "<%= strings[:invalid_flag] %>\n" "$key"
     exit 1
     ;;
+<%- end -%>
 
   * )
 <%= render(:parse_requirements_case).indent 4 %>

data/lib/bashly/views/command/run.erb

@@ -1,6 +1,7 @@
 # :command.run
 run() {
   declare -A args
+  declare -a other_args
   parse_requirements "$@"
 
   <%- condition = "if" -%>

data/lib/bashly/views/command/usage_args.erb

@@ -4,3 +4,9 @@ printf "<%= strings[:arguments] %>\n"
 <%- args.each do |arg| -%>
 <%= arg.render(:usage) %>
 <%- end -%>
+
+<%- if catch_all_help -%>
+echo "  <%= catch_all_label %>"
+printf "<%= catch_all_help.wrap(76).indent(4).sanitize_for_print %>\n"
+echo
+<%- end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator