bashly 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b40fa2dc3cc6b3f0f65b961ea06dab0230eb0346eaa7c51575f12e27f16bcc3e
-  data.tar.gz: 704cc06b8d06539c123d2fabd450764fa8926705acc584ef47da87e5f2ab3e87
+  metadata.gz: 457aceee843507aa8834ede40e17d0ede1bfdfadea943688d5d74277bdee1446
+  data.tar.gz: 56b445b5d0517045e5deafbd994bce1ef5cf60b8fae536bd522a53d82bf20bf4
 SHA512:
-  metadata.gz: 6b5755ebda8ded8cc3a414063b8c9f7559b34fb5682d8f351f55f2be768ac4d39868cacca11c7b6a39741f3c00b13c8ee1f2d14d24307518f8e9954afabbe3d4
-  data.tar.gz: 540459bf266a62c289fd0fc0799f45e0e72bfbe3117dcf975ad623c022beba7327f97331d6a6539b69901ccf82fc2696a329622f0b7126951fc53cfdf583d0c7
+  metadata.gz: 00f9df5aa5d43035267d49ec83ccfff4225f8866da6b350ee085d42e968ab04739feacbcf6e85a5d105f6c40ccc504f1be6bc2423a87c96c2a740157f6fd8fd6
+  data.tar.gz: d372d3e369e6d3a3e54a6630285db36251b89149717813248e1370ee9f2ec93ea98d594addc68e1499174e2b48a0c1bc67a9c7c437b7f71abe4fd7e80651c02e

data/README.md

@@ -133,147 +133,59 @@ 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).
 
-```yaml
-# The name of the script or subcommand
-name: myscript
-
-# An additional, optional pattern - usually used to denote a one letter 
-# variation of the command name.
-# You can add '*' as suffix, to denote a "starts with" pattern.
-# Applicable only in subcommands
-short: m*
-
-# The header text to display when using --help
-# This can have multiple lines. In this case, the first line will be used as
-# summary wherever appropriate.
-help: a sample script generated with bashly
-
-# The string to display when using --version
-# Applicable only in the main command
-version: 0.1.0
-
-# Specify an array of examples to show when using --help
-# Each example can have multiple lines.
-examples:
-- myscript download
-- myscript download --force
-
-# Specify an array of environment variables needed by your script.
-environment_variables:
-- ... see below ...
-
-# Specify the array of subcommands to generate.
-# Each subcommand will have its own args and flags.
-# If this is provided, you cannot specify flags or args.
-commands: 
-- ...
-
-# Specify the array of positional arguments this script needs.
-# If this is provided, then you cannot specify commands.
-args:
-- ... see below ...
-
-# Specify the array of option flags this script needs.
-# If this is provided, then you cannot specify commands.
-flags:
-- ... see below ...
-
-# Specify an array of any required external dependencies (commands).
-# The script execution will be halted with a friendly error unless all
-# dependency commands exist.
-dependencies:
-- curl
-```
 
+ 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 subcommand, 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 subcommands. Each subcommand 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.
+`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.
 
 ### Argument options
 
-The below configuration generates this argument:
-
-```
-  Usage: 
-    myscript USER
-
-  Arguments:
-    USER
-      Username to use for logging in
-```
-
 The argument's value will be available to you as `${args[user]}` in your 
 bash function.
 
-```yaml
-# The name of the argument.
-name: user
-
-# The message to display when using --help.
-# This can have multiple lines.
-help: Username to use for logging in
-
-# 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.
-required: true
-```
+ 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.
 
 ### Flag options
 
-The below configuration generates this flag:
-
-```
-  Options:
-    -o, --output DIRECTORY (required)
-      Specify the output directory
-```
-
 The flag's value will be available to you as `${args[--output]}` in your 
 bash function (regardless of whether the user provided ut with the long or 
 short form).
 
-```yaml
-# The long form of the flag.
-long: --output
-
-# The short form of the flag.
-short: -o
-
-# The text to display when using --help
-# This can have multiple lines.
-help: Specify the output directory
-
-# If the flag requires an argument, specify its name here.
-arg: directory
-
-# Specify if this flag is required.
-required: true
-```
+ 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.
 
 ### Environment Variable options
 
 The below configuration generates this environment variable usage text:
 
-```
-  Environment Variables:
-    SECRET_KEY (required)
-      Your API secret key
-```
-
 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.
 
-```yaml
-# The name of the variable (it will be automatically capitalized).
-name: secret_key
-
-# The message to display when using --help.
-# This can have multiple lines.
-help: Your API secret key
-
-# Specify if this variable is required.
-required: true
-```
-
+ 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.
 
 
 Real World Examples

data/lib/bashly/models/base.rb

@@ -9,6 +9,7 @@ module Bashly
         arg
         dependencies
         description
+        default
         environment_variables
         examples
         flags

data/lib/bashly/models/command.rb

@@ -55,6 +55,12 @@ module Bashly
         result
       end
 
+      # If any of this command's subcommands has the default option set to
+      # true, this default command will be returned, nil otherwise.
+      def default_command
+        commands.find { |c| c.default }
+      end
+
       # Returns an array of EnvironmentVariables
       def environment_variables
         return [] unless options["environment_variables"]

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

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

@@ -15,11 +15,25 @@ 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 -%>
 esac
 <%- else -%>
 action="<%= action_name %>"

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

@@ -2,6 +2,8 @@
 echo -e "<%= strings[:commands] %>"
 <%- maxlen = command_names.map(&:size).max -%>
 <%- commands.each do |command| -%>
-echo "  <%= command.name.ljust maxlen %>   <%= command.summary %>"
+<%- summary = command.summary -%>
+<%- summary = "#{summary} (default)" if command.default -%>
+echo "  <%= command.name.ljust maxlen %>   <%= summary %>"
 <%- end -%>
 echo

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-28 00:00:00.000000000 Z
+date: 2019-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole