bashly 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffda5465535e873bf8f7beea1491d33ffd9e417adcd7cd2a79d8798e24fad6e2
-  data.tar.gz: 4b4f2a5fe32494fd4527b88be16d5f3b414ce46f07eb421397f5f3715da2351e
+  metadata.gz: 36db0864b7a077abc473fbad4aa91d14b7428e914be51b537f583f1dc2f97490
+  data.tar.gz: 1e6c19c9cb0b05e09287b3c4e0986fa1c6d1d001f5d03e4c9fd70a72dfe768dc
 SHA512:
-  metadata.gz: 1fba52e408663920eb145112f9c80bc0a6ce4731f017688ca299c8fad975c4bd4ef2fc8e330cf6e5452f797502a44a43342a95ccf9e95b50935c378a56ade85a
-  data.tar.gz: 4670e9c1b054c36cbb91d1c2264d37f4011ab8e242b0b47b5e07c85558d463fa806a299fa88f5c6b0aa2b61fc44b4fae7641727549f910aa3c9047b087ebaec1
+  metadata.gz: 7d63a0ebf4158eaeb220a13b6f2ac4ea4c092f930281450cb7cf8d9e85fe495c46e5fa504fb77df19fba3a8e47c71027c6a713f349d108b24f6c930090bdbf8a
+  data.tar.gz: fca3133104b49a68468aacf5a01ef28ca8374df6e1b177bf380fbb6dd6bcc618bf69c1f7022745b34789965abc0534fab2960a7cb57906ce6ba636ae2705cc50

data/README.md

@@ -26,6 +26,13 @@ $ gem install bashly
 ```
 
 
+Prerequisites
+--------------------------------------------------
+
+The bash scripts generated by bashly require bash 4 or higher due to heavy
+use of associative arrays.
+
+
 What is Bashly
 --------------------------------------------------
 
@@ -159,6 +166,7 @@ bash function.
 `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.
 
 ### Flag options
 
@@ -173,6 +181,7 @@ short form).
 `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.
 
 #### Special handling for -v and -h
 

data/lib/bashly/models/command.rb

@@ -55,12 +55,22 @@ module Bashly
         result
       end
 
+      # Returns an array of all the default Args
+      def default_args
+        args.select &:default
+      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 all the default Flags
+      def default_flags
+        flags.select &:default
+      end
+
       # Returns an array of EnvironmentVariables
       def environment_variables
         return [] unless options["environment_variables"]

data/lib/bashly/templates/lib/sample_function.sh

@@ -6,7 +6,7 @@
 # recommended to have a separate file for each function.
 #
 # Subdirectories will also be scanned for *.sh, so you have no reason not
-# to organize your code nearly.
+# to organize your code neatly.
 #
 sample_function() {
   echo "it works"

data/lib/bashly/templates/strings.yml

@@ -14,6 +14,7 @@ group: "%{group} Commands:"
 command_shortcut: "Shortcut: %{short}"
 default_command_summary: "%{summary} (default)"
 required: "(required)"
+default: "Default: %{value}"
 
 # Fixed flags help text
 help_flag_text: Show this help

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.3.6"
+  VERSION = "0.3.7"
 end

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

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

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

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

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

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

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

@@ -1,4 +1,7 @@
 # :flag.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-06 00:00:00.000000000 Z
+date: 2020-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -93,6 +93,7 @@ files:
 - lib/bashly/views/argument/usage.erb
 - lib/bashly/views/command/command_filter.erb
 - lib/bashly/views/command/command_functions.erb
+- lib/bashly/views/command/default_assignments.erb
 - lib/bashly/views/command/default_initialize_script.erb
 - lib/bashly/views/command/default_root_script.erb
 - lib/bashly/views/command/default_script.erb