bashly 1.0.6 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58a2804698490f003611b4f607614fef9995bea16f426c6d56d527d78b770a29
-  data.tar.gz: 24a4c1d97b45332e424fc6932092225bab7b3ade618f5eec5e9c187ca91389ac
+  metadata.gz: b82e5ead650cc1774cf3870af91b9046b1e5f69f05484d833f72dd4090eab091
+  data.tar.gz: 26626b09b79382d2d4530241b5517ed04d3e4a27c004130adadad3b27421f100
 SHA512:
-  metadata.gz: 0e62c14ede0d0295e01411cd946859a21413e50b43313f850ea494c4ed5dafe6f402b914dfc8f682c3abc8e38d9004917dbd654d78f8983b961f2f35228e97e4
-  data.tar.gz: '00309d231db02bb61fe7d9ae2c95d9d615888830a6a95c2815cda9e8b08fa4dd73e6ccc0f0127bf46a467deee4888297975f421a2a1e0c80fa5b23d871124726'
+  metadata.gz: 9e3b78d5975c92954347be94d567f28d240d628e080fb3d136382cc4f8fa1ae81827057ad3b61ac144b5ab930c3f5353128f9d6068b983d0e2e77ac996d4ab0d
+  data.tar.gz: 2595428ca74b3ada25619fc7839f99993f98bcda169b47fcda84c82b279ebcaa1882864d2d842c67f05ca1ca946f2f64867d6905892f2ff5f5f5107f32f49037

data/README.md

@@ -32,7 +32,6 @@ a [docker image](https://hub.docker.com/r/dannyben/bashly).
 <table>
    <tr>
       <td><a href="https://rhodecode.com/"><img src='support/img/RhodeCode-logo.png' width=240></a></td>
-      <td><a href="https://decisiohealth.com/"><img src='support/img/decisio-logo.png' width=240></a></td>
    </tr>
 </table>
 
@@ -82,11 +81,6 @@ to contribute, feel free to [open an issue][issues] or
 
 Visit the *[How to contribute][contributing]* page for more information.
 
-## Stargazers and Forkers
-
-[![Stargazers repo roster for @DannyBen/bashly](https://reporoster.com/stars/DannyBen/bashly)](https://github.com/DannyBen/bashly/stargazers)
-
-[![Forkers repo roster for @DannyBen/bashly](https://reporoster.com/forks/DannyBen/bashly)](https://github.com/DannyBen/bashly/network/members)
 
 [issues]: https://github.com/DannyBen/bashly/issues
 [discussions]: https://github.com/DannyBen/bashly/discussions

data/lib/bashly/commands/completions.rb

@@ -4,7 +4,7 @@ module Bashly
       summary 'Install bash completions for bashly itself'
       help 'Display the bash completions script or install it directly to your bash completions directory'
 
-      usage 'bashly completions [--install --uninstall]'
+      usage 'bashly completions [--install|--uninstall]'
       usage 'bashly completions (-h|--help)'
 
       option '-i --install', 'Install the completions script to your bash completions directory'

data/lib/bashly/config.rb

@@ -2,7 +2,11 @@ require 'yaml'
 
 module Bashly
   # A convenience class to use either a hash or a filename as a configuration
-  # source
+  # source.
+  #
+  # When a filename is provided, it is loaded with these extra features:
+  # - Support for `import` keyword to merge additional YAML files
+  # - Preprocessing with ERB
   class Config
     using ComposeRefinements
 
@@ -10,7 +14,7 @@ module Bashly
 
     def self.new(config)
       if config.is_a? String
-        YAML.properly_load_file(config).compose
+        YAML.load_erb_file(config).compose
       else
         config
       end

data/lib/bashly/extensions/string.rb

@@ -13,6 +13,10 @@ class String
     gsub(/(.)([A-Z])/, '\1_\2').gsub(/[- ]/, '_').downcase
   end
 
+  def to_path
+    tr(' ', '/').downcase
+  end
+
   def wrap(length = 80)
     strip!
     split("\n").collect! do |line|

data/lib/bashly/extensions/yaml.rb

@@ -1,10 +1,12 @@
 module YAML
-  # This awkward patch is due to https://bugs.ruby-lang.org/issues/17866
-  def self.properly_load_file(path)
-    YAML.load_file path, aliases: true
-  rescue ArgumentError
-    # :nocov:
-    YAML.load_file path
-    # :nocov:
+  # We trust our loaded YAMLs
+  # This patch is due to https://bugs.ruby-lang.org/issues/17866
+  # StackOverflow: https://stackoverflow.com/questions/71191685/visit-psych-nodes-alias-unknown-alias-default-psychbadalias/71192990#71192990
+  class << self
+    alias load unsafe_load
+
+    def load_erb_file(path)
+      YAML.load ERB.new(File.read(path)).result
+    end
   end
 end

data/lib/bashly/libraries/config/config.sh

@@ -1,128 +1,108 @@
-## Config functions [@bashly-upgrade config]
+## Config (INI) functions [@bashly-upgrade config]
 ## This file is a part of Bashly standard library
 ##
 ## Usage:
-## - In your script, set the CONFIG_FILE variable. For rxample:
-##   CONFIG_FILE=settings.ini.
-##   If it is unset, it will default to 'config.ini'.
-## - Use any of the functions below to access the config file.
 ##
-## Create a new config file.
-## There is normally no need to use this function, it is used by other
-## functions as needed.
+## - Set the global variable CONFIG_FILE to the path of your INI file somewhere
+##   in your script (for example, in src/initialize.sh).
+## - Use any of the following functions to access and manipulate the values.
+## - INI sections are optional (i.e., sectionless key=value pairs are allowed).
 ##
-config_init() {
-  CONFIG_FILE=${CONFIG_FILE:=config.ini}
-  [[ -f "$CONFIG_FILE" ]] || touch "$CONFIG_FILE"
+
+## Show all the key=value pairs from your config file
+config_show() {
+  config_load
+  ini_show
 }
 
-## Get a value from the config.
-## Usage: result=$(config_get hello)
+## Get a single value from the config file:
+##
+##   config_get login.email
+##
+## Get the value or a default one if it is not set:
+##
+##   config_get login.user guest
+##
+## Assign the result to a variable:
+##
+##   theme="$(config_get interface.theme)"
+##
 config_get() {
-  local key=$1
-  local regex="^$key *= *(.+)$"
-  local value=""
-
-  config_init
+  local key="$1"
+  local default_value="$2"
 
-  while IFS= read -r line || [ -n "$line" ]; do
-    if [[ $line =~ $regex ]]; then
-      value="${BASH_REMATCH[1]}"
-      break
-    fi
-  done <"$CONFIG_FILE"
-
-  echo "$value"
+  config_load
+  echo "${ini["$key"]:-$default_value}"
 }
 
-## Add or update a key=value pair in the config.
-## Usage: config_set key value
+## Create/update a key=value pair:
+##
+##   config_set cloud.provider aws
+##
 config_set() {
-  local key=$1
+  local key="$1"
   shift
   local value="$*"
 
-  config_init
-
-  local regex="^($key) *= *.+$"
-  local output=""
-  local found_key=""
-  local newline
-
-  while IFS= read -r line || [ -n "$line" ]; do
-    newline=$line
-    if [[ $line =~ $regex ]]; then
-      found_key="${BASH_REMATCH[1]}"
-      newline="$key = $value"
-      output="$output$newline\n"
-    elif [[ $line ]]; then
-      output="$output$line\n"
-    fi
-  done <"$CONFIG_FILE"
-
-  if [[ -z $found_key ]]; then
-    output="$output$key = $value\n"
-  fi
-
-  printf "%b\n" "$output" >"$CONFIG_FILE"
+  config_load
+  ini["$key"]="$value"
+  config_save
 }
 
-## Delete a key from the config.
-## Usage: config_del key
+## Delete a key=value pair:
+##
+##   config_del login.email
+##
 config_del() {
-  local key=$1
+  local key="$1"
 
-  local regex="^($key) *="
-  local output=""
-
-  config_init
-
-  while IFS= read -r line || [ -n "$line" ]; do
-    if [[ $line ]] && [[ ! $line =~ $regex ]]; then
-      output="$output$line\n"
-    fi
-  done <"$CONFIG_FILE"
-
-  printf "%b\n" "$output" >"$CONFIG_FILE"
-}
-
-## Show the config file
-config_show() {
-  config_init
-  cat "$CONFIG_FILE"
+  config_load
+  unset "ini[$key]"
+  config_save
 }
 
-## Return an array of the keys in the config file.
-## Usage:
+## Get an array of all keys:
 ##
-##   for k in $(config_keys); do
-##     echo "- $k = $(config_get "$k")";
+##   for key in $(config_keys); do
+##     echo "- $key = $(config_get "$key")";
 ##   done
 ##
 config_keys() {
-  local regex="^([a-zA-Z0-9_\-\/\.]+) *="
-
-  config_init
-
-  local keys=()
-  local key
-
-  while IFS= read -r line || [ -n "$line" ]; do
-    if [[ $line =~ $regex ]]; then
-      key="${BASH_REMATCH[1]}"
-      keys+=("$key")
-    fi
-  done <"$CONFIG_FILE"
-  echo "${keys[@]}"
+  config_load
+  ini_keys
 }
 
-## Returns true if the specified key exists in the config file.
-## Usage:
+## Check if a key exists:
 ##
-##   if config_has_key "key"; then
+##   if config_has_key login.password; then
 ##     echo "key exists"
 ##   fi
 ##
 config_has_key() {
   [[ $(config_get "$1") ]]
 }
+
+## Force-load from file
+## This should normally not be called, unless you suspect that the INI file
+## was modified by external means during the run of your script.
+config_reload() {
+  declare -g config_loaded=false
+  config_load
+}
+
+## Load an INI file (unless loaded) and populate the associative array
+## NOTE: Normally there is no need to call this function, it is called as needed
+config_load() {
+  [[ "$config_loaded" == "true" ]] && return
+
+  declare -g CONFIG_FILE=${CONFIG_FILE:=config.ini}
+  declare -g config_loaded=true
+  [[ -f "$CONFIG_FILE" ]] || touch "$CONFIG_FILE"
+  ini_load "$CONFIG_FILE"
+}
+
+## Save the associative array back to a file
+## NOTE: Normally there is no need to call this function, it is called as needed
+config_save() {
+  ini_save "$CONFIG_FILE"
+}

data/lib/bashly/libraries/ini/ini.sh

@@ -0,0 +1,110 @@
+## INI functions [@bashly-upgrade ini]
+## This file is a part of Bashly standard library
+##
+## Usage:
+##
+## - In your script, call `ini_load path/to/config.ini`.
+## - A global associative array named `ini` will become available to you,
+## - When updating any of the associative array's values, call
+##   `ini_save path/to/config.ini` to save the data.
+## - INI sections are optional.
+##
+## Get a value:
+##
+##   ${ini[section1.key1]}  # for keys under a [section]
+##   ${ini[key1]}           # for keys not under a [section]
+##   ${ini[key1]:-default}  # get a default value if the INI key is unset
+##
+## Update/create a value:
+##
+##   ini[section1.key1]="value"
+##   ini_save path/to/config.ini
+##
+## Delete a value
+##
+##   unset ini[section1.key1]
+##   ini_save path/to/config.ini
+##
+
+## Load an INI file and populate the associative array `ini`.
+ini_load() {
+  declare -gA ini
+
+  local ini_file="$1"
+
+  local section=""
+  local key=""
+  local value=""
+  local section_regex="^\[(.+)\]"
+  local key_regex="^([^ =]+) *= *(.*) *$"
+  local comment_regex="^;"
+
+  while IFS= read -r line; do
+    if [[ $line =~ $comment_regex ]]; then
+      continue
+    elif [[ $line =~ $section_regex ]]; then
+      section="${BASH_REMATCH[1]}."
+    elif [[ $line =~ $key_regex ]]; then
+      key="${BASH_REMATCH[1]}"
+      value="${BASH_REMATCH[2]}"
+      ini["${section}${key}"]="$value"
+    fi
+  done <"$ini_file"
+}
+
+## Save the associative array `ini` back to a file
+ini_save() {
+  declare -gA ini
+
+  local ini_file="$1"
+
+  local current_section=""
+  local has_free_keys=false
+
+  rm -f "$ini_file"
+
+  for key in $(ini_keys); do
+    [[ $key == *.* ]] && continue
+    has_free_keys=true
+    value="${ini[$key]}"
+    echo "$key = $value" >>"$ini_file"
+  done
+
+  [[ "${has_free_keys}" == "true" ]] && echo >>"$ini_file"
+
+  for key in $(ini_keys); do
+    [[ $key == *.* ]] || continue
+    value="${ini[$key]}"
+    IFS="." read -r section_name key_name <<<"$key"
+
+    if [[ "$current_section" != "$section_name" ]]; then
+      [[ $current_section ]] && echo >>"$ini_file"
+      echo "[$section_name]" >>"$ini_file"
+      current_section="$section_name"
+    fi
+    
+    echo "$key_name = $value" >>"$ini_file"
+  done
+}
+
+## Show all loaded key-value pairs
+ini_show() {
+  declare -gA ini
+
+  for key in $(ini_keys); do
+    echo "$key = ${ini[$key]}"
+  done
+}
+
+## Get an array of all keys:
+##
+##   for key in $(ini_keys); do
+##     echo "- $key = ${ini[$key]}";
+##   done
+##
+ini_keys() {
+  declare -gA ini
+
+  local keys=("${!ini[@]}")
+  for a in "${keys[@]}"; do echo "$a"; done | sort
+}

data/lib/bashly/libraries/libraries.yml

@@ -20,10 +20,12 @@ completions_yaml:
   handler: Bashly::Libraries::CompletionsYAML
 
 config:
-  help: Add standard functions for handling INI files to the lib directory.
+  help: Add functions for handling INI configuration files to the lib directory.
   files:
     - source: "config/config.sh"
       target: "%{user_lib_dir}/config.%{user_ext}"
+    - source: "ini/ini.sh"
+      target: "%{user_lib_dir}/ini.%{user_ext}"
 
 help:
   help: Add a help command, in addition to the standard --help flag.
@@ -39,6 +41,12 @@ hooks:
     - source: "hooks/after.sh"
       target: "%{user_source_dir}/after.%{user_ext}"
 
+ini:
+  help: Add low level functions for reading/writing INI files to the lib directory.
+  files:
+    - source: "ini/ini.sh"
+      target: "%{user_lib_dir}/ini.%{user_ext}"
+
 lib:
   help: |-
     Create the lib directory for any additional user scripts.

data/lib/bashly/libraries/settings/settings.yml

@@ -18,9 +18,15 @@ config_path: "%{source_dir}/bashly.yml"
 # The path to use for creating the bash script
 target_dir: .
 
-# The path to use for common library files, relative to the source dir
+# The path to use for common library files, relative to source_dir
 lib_dir: lib
 
+# The path to use for command files, relative to source_dir
+# When set to nil (~), command files will be placed directly under source_dir
+# When set to any other string, command files will be placed under this
+# directory, and each command will get its own subdirectory
+commands_dir: ~
+
 # Configure the bash options that will be added to the initialize function:
 # strict: true       Bash strict mode (set -euo pipefail)
 # strict: false      Only exit on errors (set -e)

data/lib/bashly/library_source.rb

@@ -14,7 +14,7 @@ module Bashly
     end
 
     def config
-      @config ||= YAML.properly_load_file config_path
+      @config ||= YAML.load_file config_path
     end
 
     def libraries

data/lib/bashly/message_strings.rb

@@ -13,7 +13,7 @@ module Bashly
   private
 
     def values!
-      defaults = YAML.properly_load_file asset('libraries/strings/strings.yml')
+      defaults = YAML.load_file asset('libraries/strings/strings.yml')
       defaults.merge project_strings
     end
 
@@ -23,7 +23,7 @@ module Bashly
 
     def project_strings!
       if File.exist? project_strings_path
-        YAML.properly_load_file project_strings_path
+        YAML.load_file project_strings_path
       else
         {}
       end

data/lib/bashly/refinements/compose_refinements.rb

@@ -22,7 +22,7 @@ module ComposeRefinements
     end
 
     def safe_load_yaml(path)
-      loaded = YAML.properly_load_file path
+      loaded = YAML.load_erb_file path
       return loaded if loaded.is_a?(Array) || loaded.is_a?(Hash)
 
       raise Bashly::ConfigurationError, "Cannot find a valid YAML in g`#{path}`"

data/lib/bashly/script/command.rb

@@ -159,10 +159,10 @@ module Bashly
         options['examples'].is_a?(Array) ? options['examples'] : [options['examples']]
       end
 
-      # Returns the bash filename that is expected to hold the user code
-      # for this command
+      # Returns the filename that is expected to hold the user code for this
+      # command
       def filename
-        options['filename'] || "#{action_name.to_underscore}_command.#{Settings.partials_extension}"
+        options['filename'] || implicit_filename
       end
 
       # Returns an array of Flags
@@ -314,6 +314,18 @@ module Bashly
       def whitelisted_flags
         flags.select(&:allowed)
       end
+
+    private
+
+      # Returns either a flat filename (docker_status_command.sh) or a nested
+      # path (commands/docker/status.sh)
+      def implicit_filename
+        if Settings.commands_dir
+          "#{Settings.commands_dir}/#{action_name.to_path}.#{Settings.partials_extension}"
+        else
+          "#{action_name.to_underscore}_command.#{Settings.partials_extension}"
+        end
+      end
     end
   end
 end

data/lib/bashly/settings.rb

@@ -4,6 +4,7 @@ module Bashly
       include AssetHelper
 
       attr_writer(
+        :commands_dir,
         :compact_short_flags,
         :config_path,
         :lib_dir,
@@ -15,6 +16,10 @@ module Bashly
         :usage_colors
       )
 
+      def commands_dir
+        @commands_dir ||= get :commands_dir
+      end
+
       def compact_short_flags
         @compact_short_flags ||= get :compact_short_flags
       end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.0.6'
+  VERSION = '1.0.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.8
 platform: ruby
 authors:
 - Danny Ben Shitrit
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -114,6 +114,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 description: Generate bash command line tools using YAML configuration
 email: db@dannyben.com
 executables:
@@ -164,6 +184,7 @@ files:
 - lib/bashly/libraries/hooks/after.sh
 - lib/bashly/libraries/hooks/before.sh
 - lib/bashly/libraries/hooks/initialize.sh
+- lib/bashly/libraries/ini/ini.sh
 - lib/bashly/libraries/lib/sample_function.sh
 - lib/bashly/libraries/libraries.yml
 - lib/bashly/libraries/settings/settings.yml
@@ -253,7 +274,7 @@ metadata:
   homepage_uri: https://bashly.dannyb.co/
   source_code_uri: https://github.com/DannyBen/bashly
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -268,8 +289,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
-signing_key: 
+rubygems_version: 3.4.18
+signing_key:
 specification_version: 4
 summary: Bash Command Line Tool Generator
 test_files: []