bashly 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e2d8e44019822a048ede2fadd9da870df078afad2931470748912b25acfb93f
-  data.tar.gz: 84738b8835be3af778b0df351154c2a73c966ee906317f61534c8100a17da9f8
+  metadata.gz: 6b573ae52d9c93016675adc209eeb011d3f6897791b0e159e25af5a76e7290d6
+  data.tar.gz: 69b99fb9b6729dd21d748688c11041130f3e35852212d148afe8af715b13804f
 SHA512:
-  metadata.gz: 653e9a5a685d321837472cb2522f93aeabc0ed0de479f97ca35dcbb1d08e2bd997d50e17653c464ce201388f6b21ac59fa4b9d28a01beed5d5119beb8b278e1b
-  data.tar.gz: 79c111478814fb30246a214511946331c7a581196187c41ef6bc249be3858123786bba3596484b27d493288714fb9d257fc18e7b4432b0f77effe8ed7baa740b
+  metadata.gz: f624d54df411325e3b4b6c8446a56d6e6bbd22e9caa2310c13d4c9d254920f84db1f19684355255374cbfa41653020a9f9d848acfa97afb88d76e448928f00d7
+  data.tar.gz: 1a98f13669d2de4a9b092afba7fdaebff16c0647a41ccf1696b6abdcda114661e6fb9995cfba1e0da348e30c79a9ae0777078bff3fc8a82cdcfd650c152c528b

data/README.md

@@ -22,15 +22,16 @@ Create beautiful bash scripts from simple YAML configuration
 - [Prerequisites](#prerequisites)
 - [What is Bashly](#what-is-bashly)
 - [Usage](#usage)
-  - [Using the input arguemnts in your code](#using-the-input-arguemnts-in-your-code)
+  - [Using the input arguments in your code](#using-the-input-arguments-in-your-code)
 - [Examples](#examples)
-  - [Sample configuraiton for a script without commands](#sample-configuraiton-for-a-script-without-commands)
-  - [Sample configuraiton for a script with commands](#sample-configuraiton-for-a-script-with-commands)
+  - [Sample configuration for a script without commands](#sample-configuration-for-a-script-without-commands)
+  - [Sample configuration for a script with commands](#sample-configuration-for-a-script-with-commands)
 - [Configuration Reference](#configuration-reference)
   - [Command options](#command-options)
   - [Argument options](#argument-options)
   - [Flag options](#flag-options)
   - [Environment Variable options](#environment-variable-options)
+- [Extensible Commands](#extensible-commands)
 - [Real World Examples](#real-world-examples)
 - [Contributing / Support](#contributing--support)
 
@@ -113,7 +114,7 @@ Finally, edit the files in the `src` folder. Each of your script's commands
 get their own file. Once you edit, run `bashly generate` again to merge the
 content from your functions back into the script.
 
-### Using the input arguemnts in your code
+### Using the input arguments in your code
 
 In order to access the parsed arguments in any of your partial scripts, you
 may simply access the `$args` associative array.
@@ -163,13 +164,13 @@ This is detected automatically by the contents of the configuration: If it
 contains a `commands` definition, it will generate a script with commands.
 
 
-### Sample configuraiton for a script without commands
+### Sample configuration for a script without commands
 
 - Generate this script by running `bashly generate --minimal`
 - [See the initial sample bashly.yml file](examples/minimal/src/bashly.yml)
 - [See the generated bash script](examples/minimal/download)
 
-### Sample configuraiton for a script with commands
+### Sample configuration for a script with commands
 
 - Generate this script by running `bashly generate`
 - [See the initial sample bashly.yml file](examples/commands/src/bashly.yml)
@@ -193,22 +194,23 @@ The `bashly.yml` configuration file consists of these types:
 
 ### Command options
 
-Unless otherwise specified, these definitiona can be used for both the root
+Unless otherwise specified, these definitions 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 cause any unrecognized command line to be passed to this command. *Applicable only in subcommands*.
+`extensible` | Specify that this command can be [externally extended](#extensible-commands).
 `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.
+`environment_variables` | Specify an array of [environment variables](#environment-variable-options) needed by your script. 
+`commands` | Specify the array of [commands](#command-options). 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](#argument-options) this script needs.
+`flags`    | Specify the array of option [flags](#flag-options) 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.
 
@@ -223,6 +225,7 @@ bash function.
 `help`     | The message to display when using `--help`. Can have multiple lines.
 `required` | Specify if this argument is required. Note that once you define an optional argument (without required: true) then you cannot define required arguments after it.
 `default`  | The value to use in case it is not provided by the user. Implies that this argument is optional.
+`allowed`  | Limit the allowed values by providing an array.
 
 ### Flag options
 
@@ -238,6 +241,7 @@ short form).
 `arg`      | If the flag requires an argument, specify its name here.
 `required` | Specify if this flag is required.
 `default`  | The value to use in case it is not provided by the user. Implies that this flag is optional, and only makes sense when the flag has an argument.
+`allowed`  | For flags with an argument, you can limit the allowed values by providing an array.
 
 #### Special handling for -v and -h
 
@@ -260,6 +264,82 @@ set.
 `required` | Specify if this variable is required.
 
 
+## Extensible Commands
+
+You may configure your generated bash script to delegate any unknown command
+to an external executable, by setting the `extensible` option to either `true`,
+or to a different external command.
+
+This is similar to how `git` works. When you execute `git whatever`, the `git`
+command will look for a file named `git-whatever` in the path, and execute it.
+
+Note that this option cannot be specified together with the `default` option,
+since both specify a handler for unknown commands.
+
+Bashly supports two operation modes.
+
+### Extension Mode (`extensible: true`)
+
+By setting `extensible` to `true`, a specially named executable will be called
+when an unknown command is called by the user.
+
+Given this `bashly.yml` configuration:
+
+```yaml
+name: myscript
+help: Example
+version: 0.1.0
+extensible: true
+
+commands:
+- name: upload
+  help: Upload a file
+```
+
+And this user command:
+
+```
+$ myscript something
+
+```
+
+The generated script will look for an executable named `myscript-something` 
+in the path. If found, it will be called.
+
+See the [extensible example](examples/extensible).
+
+
+### Delegate Mode (`extensible: <executable name>`)
+
+By setting `extensible` to any string, unknown command calls by the user will
+be delegated to the executable with that name.
+
+Given this `bashly.yml` configuration:
+
+```yaml
+name: mygit
+help: Example
+version: 0.1.0
+extensible: git
+
+commands:
+- name: push
+  help: Push to my repository
+```
+
+And this user command:
+
+```
+$ mygit status
+
+```
+
+The generated script will execute `git status`.
+
+See the [extensible-delegate example](examples/extensible-delegate).
+
+
+
 ## Real World Examples
 
 - [Rush][rush] - a Personal Package Manager
@@ -272,9 +352,9 @@ set.
 If you experience any issue, have a question or a suggestion, or if you wish
 to contribute, feel free to [open an issue][issues].
 
+
+
 [issues]: https://github.com/DannyBen/bashly/issues
 [rush]: https://github.com/DannyBen/rush-cli
 [alf]: https://github.com/DannyBen/alf
 [git-changelog]: https://github.com/DannyBen/git-changelog
-
-

data/lib/bashly/extensions/string.rb

@@ -16,7 +16,6 @@ class String
     strip!
     split("\n").collect! do |line|
       if line.length > length
-        line.gsub!(/([^\s]{#{length}})([^\s$])/, "\\1 \\2")
         line.gsub(/(.{1,#{length}})(\s+|$)/, "\\1\n").rstrip
       else
         line

data/lib/bashly/models/base.rb

@@ -6,12 +6,15 @@ module Bashly
       attr_reader :options
 
       OPTION_KEYS = %i[
+        allowed
         arg
+        catch_all
+        default
         dependencies
         description
-        default
         environment_variables
         examples
+        extensible
         flags
         group
         help

data/lib/bashly/models/command.rb

@@ -28,6 +28,30 @@ 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
+
+      # Returns a used defined help string for the catch_all directive
+      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 +183,7 @@ module Bashly
           result << arg.usage_string
         end
         result << "[options]" unless flags.empty?
+        result << "[#{catch_all_label}]" if catch_all
         result.join " "
       end
 
@@ -175,6 +200,16 @@ module Bashly
         verify_commands if commands.any?
       end
 
+      # Returns an array of all the args with a whitelist
+      def whitelisted_args
+        args.select &:allowed
+      end
+
+      # Returns an array of all the flags with a whitelist arg
+      def whitelisted_flags
+        flags.select &:allowed
+      end
+
     private
 
       def verify_commands

data/lib/bashly/templates/strings.yml

@@ -15,6 +15,7 @@ command_shortcut: "Shortcut: %{short}"
 default_command_summary: "%{summary} (default)"
 required: "(required)"
 default: "Default: %{value}"
+allowed: "Allowed: %{values}"
 
 # Fixed flags help text
 help_flag_text: Show this help
@@ -28,3 +29,5 @@ missing_required_argument: "missing required argument: %{arg}\\nusage: %{usage}"
 missing_required_flag: "missing required flag: %{usage}"
 missing_required_environment_variable: "missing required environment variable: %{var}"
 missing_dependency: "missing dependency: %{dependency}"
+disallowed_flag: "%{name} must be one of: %{allowed}"
+disallowed_argument: "%{name} must be one of: %{allowed}"

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/lib/bashly/views/argument/usage.erb

@@ -1,6 +1,9 @@
 # :argument.usage
 echo "  <%= name.upcase %>"
 printf "<%= help.wrap(76).indent(4).sanitize_for_print %>\n"
+<%- if allowed -%>
+printf "    <%= strings[:allowed] % { values: allowed.join(', ') } -%>\n"
+<%- end -%>
 <%- if default -%>
 printf "    <%= strings[:default] % { value: default } -%>\n"
 <%- end -%>

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

@@ -0,0 +1,45 @@
+# :command.command_fallback
+<%- if default_command -%>
+"" )
+  <%= function_name %>_usage
+  exit 1
+  ;;
+
+* )
+  action="<%= default_command.name %>"
+  <%= default_command.function_name %>_parse_requirements "$@"
+  shift $#
+  ;;
+<%- elsif extensible.is_a? String -%>
+"" )
+  <%= function_name %>_usage
+  exit 1
+  ;;
+
+* )
+  if [[ -x "$(command -v "<%= extensible %>")" ]]; then
+    exec <%= extensible %> "$@"
+  else
+    <%= function_name %>_usage
+    exit 1
+  fi
+<%- elsif extensible -%>
+"" )
+  <%= function_name %>_usage
+  exit 1
+  ;;
+
+* )
+  if [[ -x "$(command -v "<%= function_name %>-$action")" ]]; then
+    shift
+    exec "<%= function_name %>-$action" "$@"
+  else
+    <%= function_name %>_usage
+    exit 1
+  fi
+<%- else -%>
+* )
+  <%= function_name %>_usage
+  exit 1
+  ;;
+<%- end -%>

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

@@ -15,25 +15,7 @@ case $action in
   ;;    
 
 <%- end -%>
-<%- if default_command -%>
-"" )
-  <%= function_name %>_usage
-  exit 1
-  ;;
-
-* )
-  action="<%= default_command.name %>"
-  <%= default_command.function_name %>_parse_requirements "$@"
-  shift $#
-  ;;
-
-<%- else -%>
-* )
-  <%= function_name %>_usage
-  exit 1
-  ;;
-
-<%- end -%>
+<%= render :command_fallback %>
 esac
 <%- else -%>
 action="<%= action_name %>"

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.erb

@@ -12,6 +12,7 @@ parse_requirements() {
 <%= render(:required_flags_filter).indent 2 %>
 <%= render(:parse_requirements_while).indent 2 %>
 <%= render(:default_assignments).indent 2 %>
+<%= render(:whitelist_filter).indent 2 %>
 }
 
 <%- commands.each do |command| %>

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" -%>
@@ -14,12 +15,7 @@ run() {
     fi
   <% condition = "elif" %>
   <%- end -%>
-  <%= condition %> [[ ${args[--version]} ]]; then
-    version_command
-  elif [[ ${args[--help]} ]]; then
-    long_usage=yes
-    <%= name %>_usage
-  elif [[ $action == "root" ]]; then
+  <%= condition %> [[ $action == "root" ]]; then
     root_command
   fi
 }

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

@@ -37,7 +37,7 @@
     printf "<%= strings[:options] %>\n"
 <%= render(:usage_fixed_flags).indent 4 %>
 <%= render(:usage_flags).indent 4 if flags.any? %>
-<%= render(:usage_args).indent 4 if args.any? %>
+<%= render(:usage_args).indent 4 if args.any? or catch_all_help %>
 <%= render(:usage_environment_variables).indent 4 if environment_variables.any? %>
 <%= render(:usage_examples).indent 4 if examples %>
 

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

@@ -1,6 +1,14 @@
 # :command.usage_args
 printf "<%= strings[:arguments] %>\n"
+<%- if args.any? -%>
 
 <%- args.each do |arg| -%>
 <%= arg.render(:usage) %>
 <%- end -%>
+<%- end -%>
+<%- if catch_all_help -%>
+
+echo "  <%= catch_all_label %>"
+printf "<%= catch_all_help.wrap(76).indent(4).sanitize_for_print %>\n"
+echo
+<%- end -%>

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

@@ -0,0 +1,13 @@
+# :command.whitelist_filter
+<%- whitelisted_args.each do |arg| -%>
+if [[ ! ${args[<%= arg.name %>]} =~ ^(<%= arg.allowed.join '|' %>)$ ]]; then
+  printf "%s\n" "<%= strings[:disallowed_argument] % { name: arg.name, allowed: arg.allowed.join(', ') } %>"
+  exit 1
+fi
+<%- end -%>
+<%- whitelisted_flags.each do |flag| -%>
+if [[ ! ${args[<%= flag.name %>]} =~ ^(<%= flag.allowed.join '|' %>)$ ]]; then
+  printf "%s\n" "<%= strings[:disallowed_flag] % { name: flag.name, allowed: flag.allowed.join(', ') } %>"
+  exit 1
+fi
+<%- end -%>

data/lib/bashly/views/flag/usage.erb

@@ -1,6 +1,9 @@
 # :flag.usage
 echo "  <%= usage_string extended: true %>"
 printf "<%= help.wrap(76).indent(4).sanitize_for_print %>\n"
+<%- if allowed -%>
+printf "    <%= strings[:allowed] % { values: allowed.join(', ') } -%>\n"
+<%- end -%>
 <%- if default -%>
 printf "    <%= strings[:default] % { value: default } -%>\n"
 <%- end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-20 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -92,6 +92,7 @@ files:
 - lib/bashly/templates/strings.yml
 - lib/bashly/version.rb
 - lib/bashly/views/argument/usage.erb
+- lib/bashly/views/command/command_fallback.erb
 - lib/bashly/views/command/command_filter.erb
 - lib/bashly/views/command/command_functions.erb
 - lib/bashly/views/command/default_assignments.erb
@@ -121,6 +122,7 @@ files:
 - lib/bashly/views/command/usage_flags.erb
 - lib/bashly/views/command/user_lib.erb
 - lib/bashly/views/command/version_command.erb
+- lib/bashly/views/command/whitelist_filter.erb
 - lib/bashly/views/environment_variable/usage.erb
 - lib/bashly/views/flag/case.erb
 - lib/bashly/views/flag/usage.erb
@@ -145,7 +147,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