bashly 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d40ad6e14ab17c88a939cea3be81f4b72fe8383021478d94c93328c4842fb395
-  data.tar.gz: 4cb84c229411360da7633dd4ad4a15bb53bfdf49fba81e82aecbf88ec3422d72
+  metadata.gz: 30efdcbeb1d466ddb9a273e1faee68a2f2a2d4290d75e6ea405e594c60cf029d
+  data.tar.gz: 637e95e22f679ade3483129a473c3cb912c16db6c976a6eb49d47921ab2fd4c9
 SHA512:
-  metadata.gz: cb14645de6f614ce24393820591f6917bd92a7c41c48f14456b789183648c8031653c0304f8e59a2c43fecd7a4f0ed0e9ab4cf6a5092f0e5bd742de157af7b0c
-  data.tar.gz: b1b9fca567512ade4957a9b484d853b871f2c2edbefb267fc0c8fdbea8e5c2b1c5792cc011e04b60d07dc9e09b62996e18c826fd67902d28549e505bce8c30ce
+  metadata.gz: 6bfd470d14131da08363c8b2f65412c09487927213a1ce2afdef0d1ebf06f3c655718d55275baed2502bd6a4f7f9c5ed723f1970e56d196b5d42585d0e84dd63
+  data.tar.gz: b203ffe70e063a58f0e0fd3a0bfd4d5fff42ac4a9e23aaaa18ea68a89c2fd204a4aafb06fc13b23bf21084283b487fb207c84f46610242056be582e456283f41

data/README.md

@@ -39,12 +39,13 @@ programming language.
 
 Bahsly is responsible for:
 
+- Generating a **single, standalone bash script**.
 - Generating **usage texts** and help screens, showing your tool's arguments, 
   flags and subcommands (works for subcommands also).
 - Parsing the user's command line and extracting:
   - Optional or required **positional arguments**.
   - Optional or required **option flags** (with or without flag arguments).
-  - **Subcommands**.
+  - **Subcommands** (and sub-subcommands).
   - Standard flags (like **--help** and **--version**).
 - 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.
@@ -52,6 +53,7 @@ Bahsly is responsible for:
   library functions:
   - **Color output**.
   - **Config file management** (INI format).
+  - **YAML parsing**.
 
 Usage
 --------------------------------------------------
@@ -126,10 +128,11 @@ command and subcommands (under the `commands` definition).
 # The name of the script or subcommand
 name: myscript
 
-# An additional, optional name - usually used to denote a one letter 
-# variation of the command name
+# 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
+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
@@ -154,17 +157,17 @@ environment_variable:
 
 # Specify the array of subcommands to generate.
 # Each subcommand will have its own args and flags.
-# If this is provided, you cannot provide flags or args for the main script.
+# 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 provide commands for the main script.
+# If this is provided, then you cannot specify commands.
 args:
 - ...
 
 # Specify the array of option flags this script needs.
-# If this is provided, then you cannot provide commands for the main script.
+# If this is provided, then you cannot specify commands.
 flags:
 - ...
 ```

data/lib/bashly/commands/add.rb

@@ -7,6 +7,7 @@ module Bashly
       usage "bashly add lib [--force]"
       usage "bashly add config [--force]"
       usage "bashly add colors [--force]"
+      usage "bashly add yaml [--force]"
       usage "bashly add (-h|--help)"
 
       option "-f --force", "Overwrite existing files"
@@ -15,6 +16,7 @@ module Bashly
       command "lib", "Create the additional lib directory for additional user scripts. All *.sh scripts in this folder will be included in the final bash script."
       command "config", "Add standard functions for handling INI files to the lib directory."
       command "colors", "Add standard functions for printing colorful and formatted text to the lib directory."
+      command "yaml", "Add standard functions for reading YAML files to the lib directory."
 
       environment "BASHLY_SOURCE_DIR", "The path to use for creating the configuration file [default: src]"
 
@@ -34,6 +36,10 @@ module Bashly
         safe_copy_lib "colors.sh"
       end
 
+      def yaml_command
+        safe_copy_lib "yaml.sh"
+      end
+
     private
       def safe_copy_lib(libfile)
         safe_copy asset("templates/lib/#{libfile}"), "#{Settings.source_dir}/lib/#{libfile}"

data/lib/bashly/commands/generate.rb

@@ -54,7 +54,7 @@ module Bashly
       end
 
       def create_master_script
-        master_script = command.render 'master_script'
+        master_script = command.render('master_script').lint
         File.write master_script_path, master_script
         FileUtils.chmod "+x", master_script_path
         say "created !txtgrn!#{master_script_path}"

data/lib/bashly/extensions/string.rb

@@ -24,4 +24,8 @@ class String
     end * "\n"
   end
 
+  def lint
+    gsub(/\n{2,}/, "\n\n")
+  end
+
 end

data/lib/bashly/templates/lib/colors.sh

@@ -5,8 +5,8 @@
 # Usage:
 # Use any of the functions below to color or format a portion of a string.
 # 
-#  echo "before $(red this is red) after"
-#  echo "before $(green_bold this is green_bold) after"
+#   echo "before $(red this is red) after"
+#   echo "before $(green_bold this is green_bold) after"
 #
 # ---
 

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

@@ -10,8 +10,8 @@
 # ---
 
 # Create a new config file.
-# There is normally no need to use this fucntion, it is used by othe rfunctions
-# as needed.
+# There is normally no need to use this fucntion, it is used by other
+# functions as needed.
 config_init() {
   CONFIG_FILE=${CONFIG_FILE:=config.ini}
   [[ -f "$CONFIG_FILE" ]] || touch "$CONFIG_FILE"

data/lib/bashly/templates/lib/yaml.sh

@@ -0,0 +1,35 @@
+# ---
+# YAML parser
+# This file is a part of Bashly standard library
+# Does not support arrays, only hashes
+#
+# Source: https://stackoverflow.com/a/21189044/413924
+#
+# Usage:
+#
+#   yaml_load "settings.yml"             # print variables
+#   yaml_load "settings.yml" "config_"   # use prefix
+#   eval $(yaml_load "settings.yml")     # create variables in scope
+#
+# ---
+
+yaml_load() {
+   local prefix=$2
+   local s='[[:space:]]*' w='[a-zA-Z0-9_]*'
+   local fs
+
+   fs=$(echo @|tr @ '\034')
+
+   sed -ne "s|^\($s\):|\1|" \
+        -e "s|^\($s\)\($w\)$s:${s}[\"']\(.*\)[\"']$s\$|\1$fs\2$fs\3|p" \
+        -e "s|^\($s\)\($w\)$s:$s\(.*\)$s\$|\1$fs\2$fs\3|p"  "$1" |
+   awk -F"$fs" '{
+      indent = length($1)/2;
+      vname[indent] = $2;
+      for (i in vname) {if (i > indent) {delete vname[i]}}
+      if (length($3) > 0) {
+         vn=""; for (i=0; i<indent; i++) {vn=(vn)(vname[i])("_")}
+         printf("%s%s%s=\"%s\"\n", "'"$prefix"'",vn, $2, $3);
+      }
+   }'
+}

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-24 00:00:00.000000000 Z
+date: 2019-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -85,6 +85,7 @@ files:
 - lib/bashly/templates/lib/colors.sh
 - lib/bashly/templates/lib/config.sh
 - lib/bashly/templates/lib/sample_function.sh
+- lib/bashly/templates/lib/yaml.sh
 - lib/bashly/templates/minimal.yml
 - lib/bashly/templates/strings.yml
 - lib/bashly/version.rb