bashly 0.3.6 → 0.4.1rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffda5465535e873bf8f7beea1491d33ffd9e417adcd7cd2a79d8798e24fad6e2
-  data.tar.gz: 4b4f2a5fe32494fd4527b88be16d5f3b414ce46f07eb421397f5f3715da2351e
+  metadata.gz: e31810f90eb5199f74dd9fd0dc0aedfb4bfd5dd4f38bc4e36473ab6c3e4f10d2
+  data.tar.gz: 5de458e2eea4ec796e44a67cddeabaf848ef069ec2d37ad7ddb1f3cc660bad27
 SHA512:
-  metadata.gz: 1fba52e408663920eb145112f9c80bc0a6ce4731f017688ca299c8fad975c4bd4ef2fc8e330cf6e5452f797502a44a43342a95ccf9e95b50935c378a56ade85a
-  data.tar.gz: 4670e9c1b054c36cbb91d1c2264d37f4011ab8e242b0b47b5e07c85558d463fa806a299fa88f5c6b0aa2b61fc44b4fae7641727549f910aa3c9047b087ebaec1
+  metadata.gz: 72a03554e17b648efda96ac0208bd4ee8223680717933a71907994ca3a3db3ffd629ea3572fc27143babb6634a65ad2f0b83fdeaeea2ab01d0c4755ea630f674
+  data.tar.gz: eb955f344c428e92b82150b95256f3c9d90e3461353bb6b13cad68eeb17bf5e6220991590aa1d797b447ee5c92f414ef9b5042b13569a284595dac0cadd7babd

data/README.md

@@ -1,8 +1,7 @@
 <div align='center'>
 <img src='logo.svg' width=280>
 
-Bashly - Bash CLI Framework and Generator
-==================================================
+# Bashly - Bash CLI Framework and Generator
 
 Create beautiful bash scripts from simple YAML configuration
 
@@ -16,18 +15,46 @@ Create beautiful bash scripts from simple YAML configuration
 
 </div>
 
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Installation](#installation)
+- [Prerequisites](#prerequisites)
+- [What is Bashly](#what-is-bashly)
+- [Usage](#usage)
+  - [Using the input arguemnts in your code](#using-the-input-arguemnts-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)
+- [Configuration Reference](#configuration-reference)
+  - [Command options](#command-options)
+  - [Argument options](#argument-options)
+  - [Flag options](#flag-options)
+  - [Environment Variable options](#environment-variable-options)
+- [Real World Examples](#real-world-examples)
+- [Contributing / Support](#contributing--support)
+
 ---
 
-Installation
---------------------------------------------------
+## Installation
 
 ```shell
 $ gem install bashly
 ```
 
+or with Docker:
+
+```shell
+$ alias bashly='docker run --rm -it --volume "$PWD:/app" dannyben/bashly'
+```
+
+## Prerequisites
+
+The bash scripts generated by bashly require bash 4 or higher due to heavy
+use of associative arrays.
 
-What is Bashly
---------------------------------------------------
+
+## What is Bashly
 
 Bashly is a command line application (written in Ruby) that lets you generate
 feature-rich bash command line tools.
@@ -54,9 +81,9 @@ Bahsly is responsible for:
   - **Color output**.
   - **Config file management** (INI format).
   - **YAML parsing**.
+  - and more.
 
-Usage
---------------------------------------------------
+## Usage
 
 In an empty directory, create a sample configuration file by running
 
@@ -86,9 +113,46 @@ 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
+
+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`.
 
-Examples
---------------------------------------------------
+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 `bashly.yml` file can be set up to generate two types of scripts:
 
@@ -116,8 +180,7 @@ See the [examples](examples) folder for more examples.
 
 
 
-Configuration Reference
---------------------------------------------------
+## Configuration Reference
 
 The `bashly.yml` configuration file consists of these types:
 
@@ -159,6 +222,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 +237,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
 
@@ -195,17 +260,21 @@ set.
 `required` | Specify if this variable is required.
 
 
-Real World Examples
---------------------------------------------------
+## 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
---------------------------------------------------
+## Contributing / Support
 
 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/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"]
@@ -148,7 +158,7 @@ module Bashly
         args.each do |arg|
           result << arg.usage_string
         end
-        result << "[options]"
+        result << "[options]" unless flags.empty?
         result.join " "
       end
 

data/lib/bashly/models/flag.rb

@@ -11,6 +11,10 @@ module Bashly
         end
       end
 
+      def name
+        long || short
+      end
+
       def usage_string(extended: false)
         result = [aliases.join(", ")]
         result << arg.upcase if arg

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

@@ -21,7 +21,7 @@ config_init() {
 # Usage: result=$(config_get hello)
 config_get() {
   key=$1
-  regex="^$key\s*=\s*(.+)$"
+  regex="^$key *= *(.+)$"
 
   config_init
   
@@ -44,7 +44,7 @@ config_set() {
 
   config_init
 
-  regex="^($key)\s*=\s*.+$"
+  regex="^($key) *= *.+$"
   output=""
   found_key=""
   
@@ -71,7 +71,7 @@ config_set() {
 config_del() {
   key=$1
 
-  regex="^($key)\s*="
+  regex="^($key) *="
   output=""
 
   config_init
@@ -100,7 +100,7 @@ config_show() {
 #   done
 #
 config_keys() {
-  regex="^(.*)\s*="
+  regex="^([a-zA-Z0-9_\-\/\.]+) *="
 
   config_init
 
@@ -113,3 +113,14 @@ config_keys() {
   done < "$CONFIG_FILE"
   echo "${keys[@]}"
 }
+
+# Returns true if the specified key exists in the config file
+# Usage:
+#
+#   if config_has_key "key" ; then
+#     echo "key exists"
+#   fi
+#
+config_has_key() {
+  [[ $(config_get "$1") ]]
+}

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,13 +14,14 @@ 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
 version_flag_text: Show version number
 
 # Error messages
-flag_requires_an_argument: "%{long} requires an argument: %{usage}"
+flag_requires_an_argument: "%{name} requires an argument: %{usage}"
 invalid_argument: "invalid argument: %s"
 invalid_flag: "invalid option: %s"
 missing_required_argument: "missing required argument: %{arg}\\nusage: %{usage}"

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.3.6"
+  VERSION = "0.4.1rc1"
 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/inspect_args.erb

@@ -1,5 +1,10 @@
 # :command.inspect_args
 inspect_args() {
-  echo args:
-  for k in "${!args[@]}"; do echo "- \${args[$k]} = ${args[$k]}"; done
+  readarray -t sorted_keys < <(printf '%s\n' "${!args[@]}" | sort)
+  if (( ${#args[@]} )); then
+    echo args:
+    for k in "${sorted_keys[@]}"; do echo "- \${args[$k]} = ${args[$k]}"; done
+  else
+    echo args: none
+  fi
 }

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

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

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.4.1rc1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-06 00:00:00.000000000 Z
+date: 2021-02-18 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
@@ -137,11 +138,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator