bashly 0.4.0 → 0.4.1rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14ee3d9cf49b4497ffbb7e374894cc0cfe18e1a1493a58c638cf4fd8896f30e2
-  data.tar.gz: 18dd37e6cfc3efd1f3c3d103f943e5ba8db4b414b2b26bed1bb096728c40cd1d
+  metadata.gz: e31810f90eb5199f74dd9fd0dc0aedfb4bfd5dd4f38bc4e36473ab6c3e4f10d2
+  data.tar.gz: 5de458e2eea4ec796e44a67cddeabaf848ef069ec2d37ad7ddb1f3cc660bad27
 SHA512:
-  metadata.gz: 2564fbacc1cd7584e6a0a4da943a25fa70bb51e01a935e18e1c15cb98f3a95e75147f404f858f294df26e18499233e1f82d99f3b344a8464e8ecfccd90c5a0e2
-  data.tar.gz: d638eff5ef4a4d407b558ba153e199ede105fe34b23ee00b7c8961c843cd8e5ef23e21de1396c92b6f3742f9ec7585f02ac182ccd19329b0008f5c2f5b702cc7
+  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,10 +15,28 @@ 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
@@ -31,15 +48,13 @@ or with Docker:
 $ alias bashly='docker run --rm -it --volume "$PWD:/app" dannyben/bashly'
 ```
 
-Prerequisites
---------------------------------------------------
+## 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.
@@ -68,8 +83,7 @@ Bahsly is responsible for:
   - **YAML parsing**.
   - and more.
 
-Usage
---------------------------------------------------
+## Usage
 
 In an empty directory, create a sample configuration file by running
 
@@ -99,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`.
+
+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
---------------------------------------------------
+## Examples
 
 The `bashly.yml` file can be set up to generate two types of scripts:
 
@@ -129,8 +180,7 @@ See the [examples](examples) folder for more examples.
 
 
 
-Configuration Reference
---------------------------------------------------
+## Configuration Reference
 
 The `bashly.yml` configuration file consists of these types:
 
@@ -210,16 +260,14 @@ 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].

data/lib/bashly/version.rb

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

@@ -1,7 +1,7 @@
 # :flag.case
 <%= aliases.join " | " %> )
   <%- if arg -%>
-  if [[ $2 && $2 != -* ]]; then
+  if [[ $2 ]]; then
     args[<%= name %>]="$2"
     shift
     shift

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1rc1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -138,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.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator