bashly 0.6.1 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a6c888335f32b6223149d91ed739e189ffbc6921afec05ff709380c76387338
-  data.tar.gz: b964b4ac7a5fa86f8766b350a3240ee00882be5cfc574e97f001a832a506e342
+  metadata.gz: 5b02a163470ebeb4c59a97f475b40b760477d36df16189addb48049b11b8842a
+  data.tar.gz: 625b89b6a09fc59f6a4a19fceaf05f645dec0c45cc33cda3a445fe123f43dbb6
 SHA512:
-  metadata.gz: e1e2757a735e55ffc4d4b27633d6df020184521ed8eb6377c0f26f8edd7442d28fb2a3c56c056de4558aab2204f7d522e15df6374f1962fcbaf26226f590d22b
-  data.tar.gz: a8aa77fba152f005136ff8ee8aacdc7236f15975042c4066f6d94e7e400133e2ca4137ffbbe9bc6f458c2aae2784aa956721d9179862cd78bf95ec6f99f39bd3
+  metadata.gz: 6e2bd2c31ab003d916efa2590e8571b7cbf3b6e88c3cee9122f5bc24d57b9624e52d7589bffdf2604132d55b040ff735effc02d49e4b6a8479817122ce98f612
+  data.tar.gz: 8fe5d95ea5061d88fb0b0da02266b69ed6530379d3e030d5f71fd1edf8bd97c3690ea82a89c36bb55a27790363ccd52be4de9e4aa1ba5ae07cb0c8ce87b8fd89

data/README.md

@@ -3,384 +3,67 @@
 
 # Bashly - Bash CLI Framework and Generator
 
-Create beautiful bash scripts from simple YAML configuration
+Create feature-rich bash scripts using simple YAML configuration
 
 [![Gem Version](https://badge.fury.io/rb/bashly.svg)](https://badge.fury.io/rb/bashly)
 [![Build Status](https://github.com/DannyBen/bashly/workflows/Test/badge.svg)](https://github.com/DannyBen/bashly/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/8cf89047e50ca601e431/maintainability)](https://codeclimate.com/github/DannyBen/bashly/maintainability)
 
+## [bashly.dannyb.co](https://bashly.dannyb.co)
+
 ---
 
 ![demo](demo/cast.svg)
 
 </div>
 
+Bashly is a command line application (written in Ruby) that lets you
+generate feature-rich bash command line tools.
 
-## Table of Contents
-
-- [Table of Contents](#table-of-contents)
-- [Installation](#installation)
-- [Prerequisites](#prerequisites)
-- [What is Bashly](#what-is-bashly)
-- [Usage](#usage)
-  - [Using the input arguments in your code](#using-the-input-arguments-in-your-code)
-- [Examples](#examples)
-- [Configuration Reference](#configuration-reference)
-  - [Command options](#command-options)
-  - [Argument options](#argument-options)
-  - [Flag options](#flag-options)
-  - [Environment Variable options](#environment-variable-options)
-- [Extensible Scripts](#extensible-scripts)
-- [Bash Completions](#bash-completions)
-- [Real World Examples](#real-world-examples)
-- [Contributing / Support](#contributing--support)
-
----
-
-
-## Installation
+Bashly lets you focus on your specific code, without worrying about command line
+argument parsing, usage texts, error messages and other functions that are
+usually handled by a framework in any other programming language.
 
-```shell
-$ gem install bashly
-```
+It is available both as a [ruby gem](https://rubygems.org/gems/bashly) and as
+a [docker image](https://hub.docker.com/r/dannyben/bashly).
 
-or with Docker:
 
-```shell
-$ alias bashly='docker run --rm -it --volume "$PWD:/app" dannyben/bashly'
-```
+## Documentation
 
-## Prerequisites
+- [Bashly Homepage][docs]
+- [Examples][examples]
 
-The bash scripts generated by bashly require bash 4 or higher due to heavy
-use of associative arrays.
+## How it works
 
+1. You provide a YAML configuration file, describing commands, sub-commands,
+   arguments, and flags. Running `bashly init` creates an initial sample YAML
+   file for you ([example](https://github.com/DannyBen/bashly/tree/master/examples/minimal#bashlyyml)).
+2. Bashly then automatically generates a bash script (when you run
+   `bashly generate`) that can parse and validate user input, provide help
+   messages, and run your code for each command ([example](https://github.com/DannyBen/bashly/blob/master/examples/minimal/download)).
+3. Your code for each command is kept in a separate file, and can be merged
+   again if you change it ([example](https://github.com/DannyBen/bashly/blob/master/examples/minimal/src/root_command.sh)).
 
-## What is Bashly
+## Features
 
-Bashly is a command line application (written in Ruby) that lets you generate
-feature-rich bash command line tools.
-
-The design intention is to let you focus on your specific code, without 
-worrying about command line argument parsing, usage texts, error messages
-and other functions that are usually handled by a framework in any other
-programming language.
-
-Bahsly is responsible for:
+Bashly is responsible for:
 
 - Generating a **single, standalone bash script**.
-- Generating **usage texts** and help screens, showing your tool's arguments, 
-  flags and commands (works for subcommands also).
+- Generating **usage texts** and help screens, showing your tool's arguments, flags and commands (works for sub-commands also).
 - Parsing the user's command line and extracting:
   - Optional or required **positional arguments**.
   - Optional or required **option flags** (with or without flag arguments).
-  - **Commands** (and subcommands).
+  - **Commands** (and sub-commands).
   - Standard flags (like **--help** and **--version**).
 - Preventing your script from running unless the command line is valid.
-- Providing you with a place to input your code for each of the functions 
-  your tool performs, and merging it back to the final script.
-- Providing you with additional (optional) framework-style, standard
-  library functions:
+- Providing you with a place to input your code for each of the functions your tool performs, and merging it back to the final script.
+- Providing you with additional (optional) framework-style, standard library functions:
   - **Color output**.
   - **Config file management** (INI format).
   - **YAML parsing**.
   - **Bash completions**.
   - and more.
 
-
-## Usage
-
-The `bashly.yml` file can be set up to generate two types of scripts:
-
-1. Script with commands (for example, like `docker` or `git`).
-2. Script without commands (for example, like `ls`)
-
-This is detected automatically by the contents of the configuration: If it
-contains a `commands` definition, it will generate a script with commands.
-
-In an empty directory, create a sample configuration file by running
-
-```shell
-$ bashly init
-# or, to generate a simpler configuration:
-$ bashly init --minimal
-```
-
-This will create a sample `src/bashly.yml` file.
-You can edit this file to specify which arguments, flags and commands you
-need in your bash script.
-
-Then, generate an initial bash script and function placeholder scripts by
-running
-
-```shell
-$ bashly generate
-```
-
-This will:
-
-1. Create the bash executable script.
-2. Create files for you to edit in the `src` folder.
-
-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 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.
-
-For example:
-
-1. Generate a minimal configuration with `bashly init --minimal`
-2. Generate the bash script with `bashly generate`
-3. Run the script with `./download hello --force`
-
-You will notice that all the arguments of the associative array are printed 
-on screen. This is done by the `inspect_args` function that was inserted into
-the generated partial script `src/root_command.sh`.
-
-You can now access these variables by modifying `sec/root_command.sh` like
-this:
-
-
-```bash
-# src/root_command.sh
-source_url=${args[source]}
-force=${args[--force]}
-
-if [[ $force ]]; then
-  echo "downloading $source_url with --force"
-else
-  echo "downloading $source_url"
-fi
-```
-
-After editing the file, run `bashly generate` (or `bashly g` for short) and
-run:
-
-```
-$ ./download a --force
-downloading a with --force
-```
-
-
-## Examples
-
-The [examples folder](examples#readme) contains many detailed and documented 
-example configuration files, with their output.
-
-
-## Configuration Reference
-
-The `bashly.yml` configuration file consists of these types:
-
-- [Command](#command-options) - defines the root command as well as any 
-  subcommand.
-- [Argument](#argument-options) - defines positional arguments.
-- [Flag](#flag-options) - defines option flags.
-- [Environment Variable](#environment-variable-options) - defines 
-  environment variables required (or desired) by your script.
-
-### Command options
-
-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 `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-scripts). *Applicable only in the main command*.
-`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](#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.
-`completions` | Specify an array of additional completion suggestions when used in conjunction with `bashly add comp`. See [Bash Completions](#bash-completions).
-`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.
-`footer` | Add a custom message that will be displayed at the end of the `--help` text. 
-
-### Argument options
-
-The argument's value will be available to you as `${args[user]}` in your 
-bash function.
-
- Option    | Description
------------|-------------
-`name`     | The name of the argument.
-`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
-
-The flag's value will be available to you as `${args[--output]}` in your 
-bash function (regardless of whether the user provided it with the long or 
-short form).
-
- Option    | Description
------------|-------------
-`long`     | The long form of the flag.
-`short`    | The short form of the flag.
-`help`     | The text to display when using `--help`. Can have multiple lines.
-`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
-
-The `-v` and `-h` flags will be used as the short options for `--version` and
-`--help` respectively **only if you are not using them in any of your own
-flags**.
-
-### Environment variable options
-
-If an environment variable is defined as required (false by default), the
-execution of the script will be halted with a friendly error if it is not
-set.
-
- Option    | Description
------------|-------------
-`name`     | The name of the variable (it will be automatically capitalized).
-`help`     | The message to display when using --help. Can have multiple lines.
-`required` | Specify if this variable is required.
-
-
-## Extensible Scripts
-
-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.
-
-The `extensible` option 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).
-
-
-## Bash Completions
-
-Bashly comes with built-in bash completions generator, provided by the 
-[completely][completely] gem.
-
-By running any of the `bashly add comp` commands, you can add this
-functionality to your script in one of three ways:
-
-- `bashly add comp function` - creates a function in your `./src/lib` directory
-   that echoes a completion script. You can then call this function from any
-   command (for example `yourcli completions`) and your users will be able to 
-   install the completions by running `eval "$(yourcli completions)"`.
-- `bashly add comp script` - creates a standalone completion script that can be
-  sourced or copies to the system's bash completions directory.
-- `bashly add comp yaml` - creates the "raw data" YAML file. This is intended
-  mainly for development purposes.
-
-The bash completions generation is completely automatic, and you will have to 
-rerun the `bashly add comp *` command whenever you change your `bashly.yml` 
-file.
-
-In addition to suggesting subcommands and flags, you can instruct bashly to
-also suggest files, directories, users, git branches and more. To do this,
-add another option in your `bashly.yml` on the command you wish to alter:
-
-```yaml
-# bashly.yml
-commands:
-- name: upload
-  help: Upload a file
-  completions:
-  - <directory>
-  - <user>
-  - $(git branch 2> /dev/null)
-
-```
-
-- Anything between `<...>` will be added using the `compgen -A action` flag.
-- Anything else, will be appended to the `compgen -W` flag.
-
-For more information about these custom completions, see the documentation for
-the [completely][completely] gem.
-
-
-## Real World Examples
-
-- [Rush][rush] - a Personal Package Manager
-- [Alf][alf] - a generator for bash aliases and sub-aliases
-- [git-changelog][git-changelog] - a change log generator
-
-
 ## Contributing / Support
 
 If you experience any issue, have a question or a suggestion, or if you wish
@@ -389,8 +72,6 @@ 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
-[completely]: https://github.com/DannyBen/completely
-[compgen]: https://www.gnu.org/software/bash/manual/html_node/Programmable-Completion-Builtins.html
+[docs]: https://bashly.dannyb.co/
+[examples]: https://github.com/DannyBen/bashly/tree/master/examples#bashly-examples
+

data/lib/bashly/commands/add.rb

@@ -13,7 +13,7 @@ module Bashly
 
       option "-f --force", "Overwrite existing files"
 
-      param "FORMAT", "Output format, can be one of:\n  function : generate a function file to be included in your script.\n  script   : generate a standalone bash completions script\n  yaml     : generate a yaml compatible with 'completely'"
+      param "FORMAT", "Output format, can be one of:\n  function : generate a function file to be included in your script.\n  script   : generate a standalone bash completions script.\n  yaml     : generate a yaml compatible with completely."
       param "OUTPUT", "For the 'comp function' command: Name of the generated function.\nFor the 'comp script' or 'comp yaml' commands: path to output file.\nIn all cases, this is optional and will have sensible defaults."
 
       command "strings", "Copy an additional configuration file to your project, allowing you to customize all the tips and error strings."

data/lib/bashly/models/command.rb

@@ -5,7 +5,7 @@ module Bashly
 
       # Returns the name to be used as an action.
       # - If it is the root command, the action is "root"
-      # - Else, it is all the parents, except the first tone (root) joined
+      # - Else, it is all the parents, except the first one (root) joined
       #   by space. For example, for a command like "docker container run"
       #   the action name is "container run".
       def action_name
@@ -54,6 +54,17 @@ module Bashly
         end
       end
 
+      # Returns true if catch_all is required
+      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
@@ -92,6 +103,11 @@ module Bashly
         commands.find { |c| c.default }
       end
 
+      # Returns an array of all the default Environment Variables
+      def default_environment_variables
+        environment_variables.select &:default
+      end
+
       # Returns an array of all the default Flags
       def default_flags
         flags.select &:default
@@ -185,7 +201,7 @@ module Bashly
           result << arg.usage_string
         end
         result << "[options]" unless flags.empty?
-        result << "[#{catch_all_label}]" if catch_all
+        result << catch_all_usage if catch_all
         result.join " "
       end
 

data/lib/bashly/templates/lib/config.sh

@@ -10,14 +10,14 @@
 # ---
 
 # Create a new config file.
-# There is normally no need to use this fucntion, it is used by other
+# There is normally no need to use this function, it is used by other
 # functions as needed.
 config_init() {
   CONFIG_FILE=${CONFIG_FILE:=config.ini}
   [[ -f "$CONFIG_FILE" ]] || touch "$CONFIG_FILE"
 }
 
-# Get a value from the config
+# Get a value from the config.
 # Usage: result=$(config_get hello)
 config_get() {
   key=$1
@@ -66,7 +66,7 @@ config_set() {
   printf "%b\n" "$output" > "$CONFIG_FILE"
 }
 
-# Delete a key from teh config.
+# Delete a key from the config.
 # Usage: config_del key
 config_del() {
   key=$1
@@ -92,7 +92,7 @@ config_show() {
   cat "$CONFIG_FILE"
 }
 
-# Return an array of the keys in the config file
+# Return an array of the keys in the config file.
 # Usage:
 #
 #   for k in $(config_keys); do
@@ -114,7 +114,7 @@ config_keys() {
   echo "${keys[@]}"
 }
 
-# Returns true if the specified key exists in the config file
+# Returns true if the specified key exists in the config file.
 # Usage:
 #
 #   if config_has_key "key" ; then

data/lib/bashly/templates/strings.yml

@@ -31,3 +31,4 @@ missing_required_environment_variable: "missing required environment variable: %
 missing_dependency: "missing dependency: %{dependency}"
 disallowed_flag: "%{name} must be one of: %{allowed}"
 disallowed_argument: "%{name} must be one of: %{allowed}"
+unsupported_bash_version: "bash version 4 or higher is required"

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.6.1"
+  VERSION = "0.6.5"
 end

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

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

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

@@ -0,0 +1,7 @@
+# :command.catch_all_filter
+% if catch_all_required?
+if [[ ${#other_args[@]} -eq 0 ]]; then
+  printf "<%= strings[:missing_required_argument] % { arg: catch_all_label, usage: usage_string } %>\n"
+  exit 1
+fi
+% end

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

@@ -1,5 +1,5 @@
 # :command.command_fallback
-<%- if default_command -%>
+% if default_command
 "" )
   <%= function_name %>_usage
   exit 1
@@ -10,7 +10,7 @@
   <%= default_command.function_name %>_parse_requirements "$@"
   shift $#
   ;;
-<%- elsif extensible.is_a? String -%>
+% elsif extensible.is_a? String
 "" )
   <%= function_name %>_usage
   exit 1
@@ -23,7 +23,7 @@
     <%= function_name %>_usage
     exit 1
   fi
-<%- elsif extensible -%>
+% elsif extensible
 "" )
   <%= function_name %>_usage
   exit 1
@@ -37,9 +37,9 @@
     <%= function_name %>_usage
     exit 1
   fi
-<%- else -%>
+% else
 * )
   <%= function_name %>_usage
   exit 1
   ;;
-<%- end -%>
+% end

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

@@ -1,12 +1,12 @@
 # :command.command_filter
-<%- if commands.any? -%>
+% if commands.any?
 action=$1
 
 case $action in
 -* )
   ;;
 
-<%- commands.each do |command| -%>
+% commands.each do |command|
 <%= command.aliases.join " | " %> )
   action="<%= command.name %>"
   shift
@@ -14,9 +14,9 @@ case $action in
   shift $#
   ;;    
 
-<%- end -%>
+% end
 <%= render :command_fallback %>
 esac
-<%- else -%>
+% else
 action="<%= action_name %>"
-<%- end -%>
+% end

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

@@ -1,4 +1,4 @@
 # :command.command_functions
-<%- deep_commands.each do |command| -%>
+% deep_commands.each do |command|
 <%= command.render :function unless command.commands.any? %>
-<%- end -%>
+% end

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

@@ -1,7 +1,7 @@
 # :command.default_assignments
-<%- default_args.each do |arg| -%>
+% default_args.each do |arg|
 [[ -n ${args[<%= arg.name %>]} ]] || args[<%= arg.name %>]="<%= arg.default %>"
-<%- end -%>
-<%- default_flags.each do |flag| -%>
+% end
+% default_flags.each do |flag|
 [[ -n ${args[<%= flag.long %>]} ]] || args[<%= flag.long %>]="<%= flag.default %>"
-<%- end -%>
+% end

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

@@ -1,9 +1,9 @@
 # :command.dependencies_filter
-<%- if dependencies -%>
-<%- dependencies.each do |dependency| -%>
+% if dependencies
+% dependencies.each do |dependency|
 if ! [[ -x "$(command -v <%= dependency %>)" ]]; then
   printf "<%= strings[:missing_dependency] % { dependency: dependency } -%>\n"
   exit 1
 fi
-<%- end -%>
-<%- end -%>
+% end
+% end

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

@@ -1,9 +1,14 @@
 # :command.environment_variables_filter
-<%- if required_environment_variables.any? -%>
-<%- required_environment_variables.each do |env_var| -%>
+% if default_environment_variables.any?
+% default_environment_variables.each do |env_var|
+export <%= env_var.name.upcase %>="${<%= env_var.name.upcase %>:-<%= env_var.default %>}"
+% end
+% end
+% if required_environment_variables.any?
+% required_environment_variables.each do |env_var|
 if [[ -z "$<%= env_var.name.upcase %>" ]]; then
-  printf "<%= strings[:missing_required_environment_variable] % { var: env_var.name.upcase } -%>\n"
+  printf "<%= strings[:missing_required_environment_variable] % { var: env_var.name.upcase } %>\n"
   exit 1
 fi
-<%- end -%>
-<%- end -%>
+% end
+% end

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

@@ -1,22 +1,22 @@
 # :command.fixed_flag_filter
 case "$1" in
-<%- if short_flag_exist? "-v" -%>
+% if short_flag_exist? "-v"
 --version )
-<%- else -%>
+% else
 --version | -v )
-<%- end -%>
+% end
   version_command
   exit
   ;;
 
-<%- if short_flag_exist? "-h" -%>
+% if short_flag_exist? "-h"
 --help )
-<%- else -%>
+% else
 --help | -h )
-<%- end -%>
+% end
   long_usage=yes
   <%= function_name %>_usage
-  exit 1
+  exit
   ;;
 
 esac

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

@@ -2,7 +2,12 @@
 initialize() {
   version="<%= version %>"
   long_usage=''
-  set -e  
+  set -e
+
+  if [[ "${BASH_VERSINFO:-0}" -lt 4 ]]; then
+    printf "<%= strings[:unsupported_bash_version] -%>\n"
+    exit 1
+  fi
 
 <%= load_user_file("initialize.sh", placeholder: false).indent 2 %>
 }

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

@@ -1,9 +1,9 @@
 # :command.parse_requirements
-<%- if root_command? -%>
+% if root_command?
 parse_requirements() {
-<%- else -%>
+% else
 <%= function_name %>_parse_requirements() {
-<%- end -%>
+% end
 <%= render(:fixed_flags_filter).indent 2 %>
 <%= render(:environment_variables_filter).indent 2 %>
 <%= render(:dependencies_filter).indent 2 %>
@@ -11,10 +11,11 @@ parse_requirements() {
 <%= render(:required_args_filter).indent 2 %>
 <%= render(:required_flags_filter).indent 2 %>
 <%= render(:parse_requirements_while).indent 2 %>
+<%= render(:catch_all_filter).indent 2 %>
 <%= render(:default_assignments).indent 2 %>
 <%= render(:whitelist_filter).indent 2 %>
 }
 
-<%- commands.each do |command| %>
+% commands.each do |command|
 <%= command.render :parse_requirements %>
-<%- end -%>
+% end

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

@@ -1,25 +1,25 @@
 # :command.parse_requirements_case
-<%- if args.any? -%>
-<%- condition = "if" -%>
-<%- args.each do |arg| -%>
+% if args.any?
+% condition = "if"
+% args.each do |arg|
 <%= condition %> [[ ! ${args[<%= arg.name %>]} ]]; then
   args[<%= arg.name %>]=$1
   shift
-<%- condition = "elif" -%>
-<%- end -%>
+% condition = "elif"
+% end
 else
-<%- if catch_all -%>
+% if catch_all
   other_args+=("$1")
   shift
-<%- else -%>
+% else
   printf "<%= strings[:invalid_argument] %>\n" "$key"
   exit 1
-<%- end -%>
+% end
 fi
-<%- elsif catch_all -%>
+% elsif catch_all
   other_args+=("$1")
   shift
-<%- else -%>
+% else
 printf "<%= strings[:invalid_argument] %>\n" "$key"
 exit 1
-<%- end -%>
+% end

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

@@ -2,21 +2,21 @@
 while [[ $# -gt 0 ]]; do
   key="$1"
   case "$key" in
-  <%- flags.each do |flag| -%>
+% flags.each do |flag|
 <%= flag.render(:case).indent 2 %>
 
-  <%- end -%>
+% end
 
   -* )
-<%- if catch_all -%>
+% if catch_all
     other_args+=("$1")
     shift
     ;;
-<%- else -%>
+% else
     printf "<%= strings[:invalid_flag] %>\n" "$key"
     exit 1
     ;;
-<%- end -%>
+% end
 
   * )
 <%= render(:parse_requirements_case).indent 4 %>

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

@@ -1,5 +1,5 @@
 # :command.required_args_filter
-<%- required_args.each do |arg| -%>
+% required_args.each do |arg|
 if [[ $1 && $1 != -* ]]; then
   args[<%= arg.name %>]=$1
   shift
@@ -8,4 +8,4 @@ else
   exit 1
 fi
 
-<%- end %>
+% end

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

@@ -1,10 +1,10 @@
 # :command.required_flags_filter
-<%- if required_flags.any? -%>
+% if required_flags.any?
 argstring="$*"
-<%- end -%>
-<%- required_flags.each do |flag| -%>
+% end
+% required_flags.each do |flag|
 if [[ <%= flag.aliases.map { |a| %Q["$argstring" != *#{a}*] }.join " && " %> ]]; then
   printf "<%= strings[:missing_required_flag] % { usage: flag.usage_string } %>\n"
   exit 1
 fi
-<%- end %>
+% end

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

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

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

@@ -1,18 +1,18 @@
 # :command.usage_commands
-<%- unless commands.first.group -%>
+% unless commands.first.group
 printf "<%= strings[:commands] %>\n"
-<%- end -%>
-<%- maxlen = command_names.map(&:size).max -%>
-<%- commands.each do |command| -%>
-<%- summary = command.summary -%>
-<%- summary = strings[:default_command_summary] % { summary: summary } if command.default -%>
-<%- if command.group -%>
-<%- if command.name == commands.first.name -%>
+% end
+% maxlen = command_names.map(&:size).max
+% commands.each do |command|
+% summary = command.summary
+% summary = strings[:default_command_summary] % { summary: summary } if command.default
+% if command.group
+% if command.name == commands.first.name
 printf "<%= strings[:group] % { group: command.group } %>\n"
-<%- else -%>
+% else
 printf "\n<%= strings[:group] % { group: command.group } %>\n"
-<%- end -%>
-<%- end -%>
+% end
+% end
 echo "  <%= command.name.ljust maxlen %>   <%= summary %>"
-<%- end -%>
+% end
 echo

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

@@ -1,6 +1,6 @@
 # :command.usage_environment_variables
 printf "<%= strings[:environment_variables] %>\n"
 
-<%- environment_variables.each do |env_var| -%>
+% environment_variables.each do |env_var|
 <%= env_var.render(:usage) %>
-<%- end -%>
+% end

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

@@ -1,7 +1,7 @@
 # :command.usage_examples
 printf "<%= strings[:examples] %>\n"
 
-<%- examples.each do |example| -%>
+% examples.each do |example|
 printf "<%= example.wrap(78).indent(2).sanitize_for_print %>\n"
-<%- end -%>
+% end
 echo

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

@@ -1,17 +1,17 @@
 # :command.usage_fixed_flags
-<%- if short_flag_exist? "-h" -%>
+% if short_flag_exist? "-h"
 echo "  --help"
-<%- else -%>
+% else
 echo "  --help, -h"
-<%- end -%>
+% end
 printf "    <%= strings[:help_flag_text] %>\n"
 echo
-<%- if root_command? -%>
-<%- if short_flag_exist? "-v" -%>
+% if root_command?
+% if short_flag_exist? "-v"
 echo "  --version"
-<%- else -%>
+% else
 echo "  --version, -v"
-<%- end -%>
+% end
 printf "    <%= strings[:version_flag_text] %>\n"
 echo
-<%- end -%>
+% end

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

@@ -1,4 +1,4 @@
 # :command.usage_flags
-<%- flags.each do |flag| -%>
+% flags.each do |flag|
 <%= flag.render(:usage) %>
-<%- end -%>
+% end

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

@@ -1,6 +1,6 @@
 # :command.user_lib
-<%- user_lib.each do |file| -%>
+% user_lib.each do |file|
 # <%= ":#{file}" %>
 <%= File.read file %>
 
-<%- end -%>
+% end

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

@@ -1,13 +1,13 @@
 # :command.whitelist_filter
-<%- whitelisted_args.each do |arg| -%>
+% 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| -%>
+% 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 -%>
+% end

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

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

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

@@ -1,6 +1,6 @@
 # :flag.case
 <%= aliases.join " | " %> )
-  <%- if arg -%>
+% if arg
   if [[ $2 ]]; then
     args[<%= name %>]="$2"
     shift
@@ -9,8 +9,8 @@
     printf "%s\n" "<%= strings[:flag_requires_an_argument] % { name: name, usage: usage_string } %>"
     exit 1
   fi
-  <%- else -%>
+% else
   args[<%= name %>]=1
   shift
-  <%- end -%>
+% end
   ;;

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

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

data/lib/bashly.rb

@@ -5,7 +5,6 @@ if ENV['BYEBUG']
   require 'lp'
 end
 
-requires 'bashly/polyfills'
 requires 'bashly/concerns'
 
 requires 'bashly/settings'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.5
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -30,20 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: mister_bin
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +96,6 @@ files:
 - lib/bashly/models/environment_variable.rb
 - lib/bashly/models/flag.rb
 - lib/bashly/models/script.rb
-- lib/bashly/polyfills/hash.rb
 - lib/bashly/settings.rb
 - lib/bashly/templates/bashly.yml
 - lib/bashly/templates/lib/colors.sh
@@ -113,6 +106,7 @@ files:
 - lib/bashly/templates/strings.yml
 - lib/bashly/version.rb
 - lib/bashly/views/argument/usage.erb
+- lib/bashly/views/command/catch_all_filter.erb
 - lib/bashly/views/command/command_fallback.erb
 - lib/bashly/views/command/command_filter.erb
 - lib/bashly/views/command/command_functions.erb
@@ -153,7 +147,11 @@ files:
 homepage: https://github.com/dannyben/bashly
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/DannyBen/bashly/issues
+  changelog_uri: https://github.com/DannyBen/bashly/blob/master/CHANGELOG.md
+  homepage_uri: https://bashly.dannyb.co/
+  source_code_uri: https://github.com/DannyBen/bashly
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -169,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator

data/lib/bashly/polyfills/hash.rb

@@ -1,12 +0,0 @@
-# :nocov:
-
-# Required for Ruby < 2.4
-if !Dir.respond_to? :empty?
-  class Dir
-    def self.empty?(path_name)
-      exist?(path_name) && (entries(path_name) - ['.', '..']).empty?
-    end
-  end
-end
-
-# :nocov: