bashly 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d333139a3555fdc50cdb3ddf21119712fcada4ab837f5703f29529f346c6ad24
-  data.tar.gz: 0a40e42bfa542ed5d4f8d59792aa2a19518ae1c9098db0309f9349db391c74b2
+  metadata.gz: c90e3d5380ed91982c50ec46ff37c490e6b00785b80b75c60c4ddbb163902099
+  data.tar.gz: b1777dac4776226205c27781cf86af045deed8f25a282e0e2a1a8fd3848e0115
 SHA512:
-  metadata.gz: e601e098208e0a5de186279e67c001ff58c44536f09e5cea6815722e9bef3ec3dc1b257c1b9ca2267e94977f05514916a66f03721c88c5a795cab93e8eadb20d
-  data.tar.gz: 670bcae80903cdabc5d76b5139b1c6d80b1ee3ca33af03078a340a847c4ef1385ca74ca08b2b0a274845f0be5ecfc7ecd9822575b8f8ea8cb3592b821df22760
+  metadata.gz: 24c19fb49d0cfe9a1ed96bfd0fa3d77973136ed2dfda747c11aa54244c30d2af17384f6aa4f7604c1a41562e41ffe9e5c1ad2a204a7dd85ac6e2d797c588d65b
+  data.tar.gz: b2020a3dcf36073049511f4484d32542a5e54037a464c9e838c7a3ffb2fb48141223ea96ecf334aeb8b4609bedaeca3491d23901d02a481c5fb621354e695936

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

@@ -8,7 +8,6 @@
 ## - Use any of the following functions to access and manipulate the values.
 ## - INI sections are optional (i.e., sectionless key=value pairs are allowed).
 ##
-
 ## Show all the key=value pairs from your config file
 config_show() {
   config_load
@@ -28,8 +27,8 @@ config_show() {
 ##   theme="$(config_get interface.theme)"
 ##
 config_get() {
-  local key="$1"
-  local default_value="$2"
+  local key="${1-}"
+  local default_value="${2-}"
 
   config_load
   echo "${ini["$key"]:-$default_value}"
@@ -40,7 +39,7 @@ config_get() {
 ##   config_set cloud.provider aws
 ##
 config_set() {
-  local key="$1"
+  local key="${1-}"
   shift
   local value="$*"
 
@@ -54,7 +53,7 @@ config_set() {
 ##   config_del login.email
 ##
 config_del() {
-  local key="$1"
+  local key="${1-}"
 
   config_load
   unset "ini[$key]"
@@ -93,7 +92,7 @@ config_reload() {
 ## 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
+  [[ "${config_loaded-}" == "true" ]] && return
 
   declare -g CONFIG_FILE=${CONFIG_FILE:=config.ini}
   declare -g config_loaded=true

data/lib/bashly/libraries/help/help_command.sh

@@ -10,7 +10,7 @@
 ##       - name: command
 ##         help: Help subject
 ##
-command="${args[command]}"
+command="${args[command]:-}"
 long_usage=yes
 
 if [[ -z "$command" ]]; then

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

@@ -25,7 +25,6 @@
 ##   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
@@ -47,6 +46,7 @@ ini_load() {
     elif [[ $line =~ $key_regex ]]; then
       key="${BASH_REMATCH[1]}"
       value="${BASH_REMATCH[2]}"
+      [[ $value == *\$* ]] && eval "value=\"$value\""
       ini["${section}${key}"]="$value"
     fi
   done <"$ini_file"

data/lib/bashly/libraries/render/mandoc/README.md

@@ -43,3 +43,21 @@ Add an authors string to your man pages.
 ```yaml
 x_mandoc_authors: Lana Lang
 ```
+
+### See Also: `x_mandoc_see_also`
+
+Adds additional pages to the `SEE ALSO` section, in addition to the
+pages that are added automatically (like the parent command, and
+sub commands).
+
+This property should be an array of strings. You can optionally add
+a section number in parentheses. If not provided, `(1)` will be used
+as default.
+
+#### Example
+
+```yaml
+x_mandoc_see_also:
+  - docker
+  - docker-compose.yml(5)
+```

data/lib/bashly/libraries/render/mandoc/mandoc.gtx

@@ -181,14 +181,19 @@ if examples
   >
 end
 
-if public_commands.any? || parents.any?
+see_also = []
+see_also << parents.first if parents.any?
+see_also += public_commands.map { |x| x.full_name.to_hyphen } if public_commands.any?
+see_also += x_mandoc_see_also if x_mandoc_see_also && x_mandoc_see_also.is_a?(Array)
+see_also.map! do |item|
+  item.match(/(.+)(\(\d\))/) ? "**#{$1}**#{$2}" : "**#{item}**(1)"
+end
+
+if see_also.any?
   > SEE ALSO
   > ==================================================
   >
-  if parents.any?
-    > **{{ parents.first }}**(1)
-  end
-  = public_commands.map { |x| "**#{x.full_name.to_hyphen}**(1)" }.join ', '
+  = see_also.join ', '
   >
 end
 

data/lib/bashly/libraries/test/approvals.bash

@@ -1,4 +1,4 @@
-# approvals.bash v0.3.3
+# approvals.bash v0.4.0
 #
 # Interactive approval testing for Bash.
 # https://github.com/DannyBen/approvals.bash
@@ -9,6 +9,10 @@ approve() {
   cmd=$1
   last_exit_code=0
   actual=$(eval "$cmd" 2>&1) || last_exit_code=$?
+  if [[ "$allow_diff_regex" ]]; then
+    actual=$(echo "$actual" | sed "s/$allow_diff_regex/*/g")
+    unset allow_diff_regex
+  fi
   approval=$(printf "%b" "$cmd" | tr -s -c "[:alnum:]" _)
   approval_file="$approvals_dir/${2:-"$approval"}"
 
@@ -35,6 +39,10 @@ approve() {
   fi
 }
 
+allow_diff() {
+  allow_diff_regex="$1"
+}
+
 describe() {
   echo
   blue "= $*"

data/lib/bashly/library_source.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'tmpdir'
 
 module Bashly
   class LibrarySource
@@ -14,7 +15,7 @@ module Bashly
     end
 
     def config
-      @config ||= YAML.load_file config_path
+      @config ||= LibrarySourceConfig.new(config_path).validated_data
     end
 
     def libraries

data/lib/bashly/library_source_config.rb

@@ -0,0 +1,48 @@
+module Bashly
+  class LibrarySourceConfig
+    include ValidationHelpers
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def data
+      @data ||= YAML.load_file path
+    end
+
+    def validated_data
+      validate
+      data
+    end
+
+    def validate
+      assert_root path, data
+    end
+
+  private
+
+    def assert_root(path, value)
+      assert_hash path, value
+      data.each { |id, spec| assert_lib "[#{path}] #{id}", spec }
+    end
+
+    def assert_lib(key, value)
+      assert_string "#{key}.help", value['help']
+
+      assert_optional_string "#{key}.usage", value['usage']
+      assert_optional_string "#{key}.handler", value['handler']
+      assert_optional_string "#{key}.post_install_message", value['post_install_message']
+
+      return if value['handler']
+
+      assert_array "#{key}.files", value['files'], of: :filespec
+    end
+
+    def assert_filespec(key, value)
+      assert_string "#{key}.source", value['source']
+      assert_string "#{key}.target", value['target']
+    end
+  end
+end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.1.0'
+  VERSION = '1.1.2'
 end

data/lib/bashly/views/command/whitelist_filter.gtx

@@ -12,7 +12,7 @@ if whitelisted_args.any? or whitelisted_flags.any?
       > done
 
     else
-      > if [[ -n ${args['{{ arg.name }}']} ]] && [[ ! ${args['{{ arg.name }}']} =~ ^({{ arg.allowed.join '|' }})$ ]]; then
+      > if [[ -n ${args['{{ arg.name }}']:-} ]] && [[ ! ${args['{{ arg.name }}']:-} =~ ^({{ arg.allowed.join '|' }})$ ]]; then
       >   printf "%s\n" "{{ strings[:disallowed_argument] % { name: arg.name, allowed: arg.allowed.join(', ') } }}" >&2
       >   exit 1
       > fi
@@ -31,7 +31,7 @@ if whitelisted_args.any? or whitelisted_flags.any?
       > done
     
     else
-      > if [[ ${args['{{ flag.name }}']} ]] && [[ ! ${args['{{ flag.name }}']} =~ ^({{ flag.allowed.join '|' }})$ ]]; then
+      > if [[ ${args['{{ flag.name }}']:-} ]] && [[ ! ${args['{{ flag.name }}']:-} =~ ^({{ flag.allowed.join '|' }})$ ]]; then
       >   printf "%s\n" "{{ strings[:disallowed_flag] % { name: flag.name, allowed: flag.allowed.join(', ') } }}" >&2
       >   exit 1
       > fi

data/lib/bashly.rb

@@ -15,6 +15,7 @@ module Bashly
   autoload :ConfigValidator, 'bashly/config_validator'
   autoload :Library, 'bashly/library'
   autoload :LibrarySource, 'bashly/library_source'
+  autoload :LibrarySourceConfig, 'bashly/library_source_config'
   autoload :MessageStrings, 'bashly/message_strings'
   autoload :RenderContext, 'bashly/render_context'
   autoload :RenderSource, 'bashly/render_source'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-28 00:00:00.000000000 Z
+date: 2023-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -207,6 +207,7 @@ files:
 - lib/bashly/libraries/yaml/yaml.sh
 - lib/bashly/library.rb
 - lib/bashly/library_source.rb
+- lib/bashly/library_source_config.rb
 - lib/bashly/message_strings.rb
 - lib/bashly/refinements/compose_refinements.rb
 - lib/bashly/render_context.rb