bashly 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7382bd9a007cc8e3c9b4451e7f3fdbccd62bf740f66cc76f24b03c0e6ef1abdd
-  data.tar.gz: 32b2ee626d40efd3f60bab256b08e486b2322b3ef4d429c1de090f0d849f5982
+  metadata.gz: 67c0cd0da5f37edbad28313553ac30b878edae7d2255158d940af0deb8aa0a05
+  data.tar.gz: 6cf9bac796564e7730f3a55e6022d78a962506b418eb00cdecbe1111f3770ffb
 SHA512:
-  metadata.gz: 947f2accba281a365338b86580fe9113ca0a4e5286fa206ee3d11e3816514113f9af80417298b24101c63b8fc84cd95fbca4d6d6abf2be32d95c2a122f092050
-  data.tar.gz: b70e60017a58d0107e44388dfdf228d3089b39d9e1bb3f650c6b4565905b08604f1a400ed4cb4648cc91846298e8e5320d54f45064f5ecc36dfaacb9e609d8bc
+  metadata.gz: 16eb355eb439bfc24457b184dd8255c091bb62dc1646c15e6d2842160f8848595de799cb453e54e43cdf5c2605906ed8f8c49ee21f5afda3999c9224b8d6fbc6
+  data.tar.gz: 889722479c576c8b30c3be1081911d0a7f61613664fc146fb4a2867b65d7199a5283464cc59eb40530e2c43f8270fbaa11e7f3a3d851cedc87a71515aef235b8

data/README.md

@@ -1,5 +1,5 @@
 <div align='center'>
-<img src='logo.svg' width=280>
+<img src='support/img/bashly-logo.svg' width=280>
 
 # Bashly - Bash CLI Framework and Generator
 
@@ -13,7 +13,7 @@ Create feature-rich bash scripts using simple YAML configuration
 
 ---
 
-![demo](demo/cast.gif)
+![demo](support/demo/cast.gif)
 
 </div>
 
@@ -27,6 +27,11 @@ usually handled by a framework in any other programming language.
 It is available both as a [ruby gem](https://rubygems.org/gems/bashly) and as
 a [docker image](https://hub.docker.com/r/dannyben/bashly).
 
+## Bashly is Sponsored By
+
+<a href="https://rhodecode.com/"><img src='support/img/RhodeCode-logo.png' width=280></a>
+
+
 ## Documentation
 
 - [Bashly Homepage][docs]
@@ -64,7 +69,7 @@ Bashly is responsible for:
   - **Bash completions**.
   - and more.
 
-## 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] or

data/lib/bashly/concerns/renderable.rb

@@ -10,6 +10,7 @@ module Bashly
       @strings ||= MessageStrings.new
     end
 
+    # Outputs a comment that describes the view unless in production mode
     def view_marker(id = nil)
       id ||= ":#{caller_locations(1..1).first.path}"
       "# #{id}" unless Settings.production?
@@ -18,7 +19,7 @@ module Bashly
     # Reads a file from the userspace (Settings.source_dir) and returns
     # its contents. If the file is not found, returns a string with a hint.
     def load_user_file(file, placeholder: true)
-      path = "#{Settings.source_dir}/#{file}"
+      path = user_file_path file
 
       content = if File.exist? path
         File.read(path).remove_front_matter
@@ -31,6 +32,22 @@ module Bashly
       Settings.production? ? content : "#{view_marker path}\n#{content}"
     end
 
+    # Returns a path to a file in the user's source_dir. The file argument
+    # should either be without exteneion, or with the user's configured
+    # partials_extension.
+    def user_file_path(file)
+      path = "#{Settings.source_dir}/#{file}"
+      ext = ".#{Settings.partials_extension}"
+      return path if path.end_with? ext
+
+      "#{path}#{ext}"
+    end
+
+    # Returns true if the user's source file exists
+    def user_file_exist?(file)
+      File.exist? user_file_path(file)
+    end
+
   private
 
     def view_path(view)

data/lib/bashly/concerns/validation_helpers.rb

@@ -35,19 +35,13 @@ module Bashly
       end
     end
 
-    def assert_hash(key, value, keys: nil, of: nil)
+    def assert_hash(key, value, keys: nil)
       assert value.is_a?(Hash), "#{key} must be a hash"
 
-      if keys
-        invalid_keys = value.keys.map(&:to_sym) - keys
-        assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join ', '}"
-      end
-
-      return unless of
+      return unless keys
 
-      value.each do |k, v|
-        send "assert_#{of}".to_sym, "#{key}.#{k}", v
-      end
+      invalid_keys = value.keys.map(&:to_sym) - keys
+      assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join ', '}"
     end
 
     def assert_uniq(key, value, array_keys)

data/lib/bashly/config_validator.rb

@@ -50,13 +50,30 @@ module Bashly
       when Array
         assert_array key, value, of: :string
       when Hash
-        assert_hash key, value, of: :string
+        assert_dependencies_hash key, value
       else
         assert [Array, Hash].include?(value.class),
           "#{key} must be an array or a hash"
       end
     end
 
+    def assert_dependencies_hash(key, value)
+      value.each do |k, v|
+        assert_dependency "#{key}.#{k}", v
+      end
+    end
+
+    def assert_dependency(key, value)
+      assert [String, Hash, NilClass].include?(value.class),
+        "#{key} must be a string, a hash or nil"
+
+      return unless value.is_a? Hash
+
+      assert_hash key, value, keys: Script::Dependency.option_keys
+      assert_string_or_array "#{key}.command", value['command']
+      assert_optional_string "#{key}.help", value['help']
+    end
+
     def assert_extensible(key, value)
       return unless value
 
@@ -157,8 +174,8 @@ module Bashly
       assert_extensible "#{key}.extensible", value['extensible']
       assert_dependencies "#{key}.dependencies", value['dependencies']
 
-      assert value['name'].match(/^[a-z0-9_-]+$/),
-        "#{key}.name must only contain lowercase alphanumeric characters, hyphens and underscores"
+      assert value['name'].match(/^[a-z0-9_\-.]+$/),
+        "#{key}.name must only contain lowercase alphanumeric characters, hyphens, dots and underscores"
 
       refute value['name'].start_with?('-'), "#{key}.name must not start with a hyphen"
 

data/lib/bashly/docs/command.yml

@@ -113,10 +113,18 @@ command.dependencies:
     - docker
     - curl
 
-    # Hash syntax, to provide additional help message
+    # Simple hash syntax, to provide additional (optional) help message
     dependencies:
       docker: see https://docker.com for installation instructions
       git: "install by running: sudo apt install git"
+      ruby:
+
+    # Explicit hash syntax, to provide additional help message and
+    # look for "one of" a given list of dependencies
+    dependencies:
+      http_client:
+        command: [curl, wget]
+        help: Run 'sudo apt install curl' or 'sudo apt install wget'
   
 command.environment_variables:
   help: Define a list of environment variables. See `environment_variable` for reference.

data/lib/bashly/libraries/hooks/after.sh

@@ -0,0 +1,7 @@
+## after hook
+##
+## Any code here will be placed inside an `after_hook()` function and called
+## after running any command.
+##
+## You can safely delete this file if you do not need it.
+echo "==[ After Hook Called ]=="

data/lib/bashly/libraries/hooks/before.sh

@@ -0,0 +1,8 @@
+## before hook
+##
+## Any code here will be placed inside a `before_hook()` function and called
+## before running any command (but after processing its arguments).
+##
+## You can safely delete this file if you do not need it.
+echo "==[ Before Hook Called ]=="
+inspect_args

data/lib/bashly/libraries/libraries.yml

@@ -29,6 +29,14 @@ help:
   help: Add a help command, in addition to the standard --help flag.
   handler: Bashly::Libraries::Help
 
+hooks:
+  help: Add placeholders for before/after hooks which are executed before/after any command.
+  files:
+    - source: "hooks/before.sh"
+      target: "%{user_source_dir}/before.%{user_ext}"
+    - source: "hooks/after.sh"
+      target: "%{user_source_dir}/after.%{user_ext}"
+
 lib:
   help: |-
     Create the lib directory for any additional user scripts.

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

@@ -12,16 +12,20 @@
 # The path containing the bashly source files
 source_dir: src
 
-# Tha path to bashly.yml
+# The path to bashly.yml
 config_path: "%{source_dir}/bashly.yml"
 
 # The path to use for creating the bash script
 target_dir: .
 
-# The path to use for upgrading library files, relative to the source dir
+# The path to use for common library files, relative to the source dir
 lib_dir: lib
 
-# When true, enable bash strict mode (set -euo pipefail)
+# 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)
+# strict: ''         Do not add any 'set' directive
+# strict: <string>   Add any other custom 'set' directive
 strict: false
 
 # When true, the generated script will use tab indentation instead of spaces
@@ -33,11 +37,11 @@ tab_indent: false
 compact_short_flags: true
 
 # Set to 'production' or 'development':
-# - production    generate a smaller script, without file markers
-# - development   generate with file markers
+# env: production    Generate a smaller script, without file markers
+# env: development   Generate with file markers
 env: development
 
-# The extension to use when reading/writing partial script snippets.
+# The extension to use when reading/writing partial script snippets
 partials_extension: sh
 
 # Display various usage elements in color by providing the name of the color

data/lib/bashly/script/command.rb

@@ -53,6 +53,7 @@ module Bashly
         help.empty? ? full_name : "#{full_name} - #{summary}"
       end
 
+      # Returns an object representing the catch_all configuration
       def catch_all
         @catch_all ||= CatchAll.from_config options['catch_all']
       end
@@ -133,7 +134,16 @@ module Bashly
         flags.select(&:default)
       end
 
-      # Returns an array of EnvironmentVariables
+      # Returns an array of Dependency objects
+      def dependencies
+        return [] unless options['dependencies']
+
+        @dependencies ||= options['dependencies'].map do |key, value|
+          Dependency.from_config key, value
+        end
+      end
+
+      # Returns an array of EnvironmentVariable objects
       def environment_variables
         return [] unless options['environment_variables']
 

data/lib/bashly/script/dependency.rb

@@ -0,0 +1,42 @@
+module Bashly
+  module Script
+    class Dependency
+      attr_reader :label, :commands, :help
+
+      class << self
+        def option_keys
+          @option_keys ||= %i[command help]
+        end
+
+        def from_config(key, value)
+          options = case value
+          when nil
+            { label: key, commands: key }
+          when String
+            { label: key, commands: key, help: value }
+          when Hash
+            { label: key, commands: value['command'], help: value['help'] }
+          else
+            {}
+          end
+
+          new(**options)
+        end
+      end
+
+      def initialize(label: nil, commands: nil, help: nil)
+        @label = label
+        @commands = commands.is_a?(String) ? [commands] : commands
+        @help = help&.empty? ? nil : help
+      end
+
+      def multi?
+        @multi ||= commands.size > 1
+      end
+
+      def name
+        @name ||= multi? ? "#{label} (#{commands.join '/'})" : label
+      end
+    end
+  end
+end

data/lib/bashly/settings.rb

@@ -55,6 +55,16 @@ module Bashly
         @strict ||= get :strict
       end
 
+      def strict_string
+        if Settings.strict.is_a? String
+          Settings.strict
+        elsif Settings.strict
+          'set -euo pipefail'
+        else
+          'set -e'
+        end
+      end
+
       def tab_indent
         @tab_indent ||= get :tab_indent
       end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.0.0'
+  VERSION = '1.0.2'
 end

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

@@ -1,11 +1,13 @@
-if dependencies
+if dependencies.any?
   = view_marker
 
-  dependencies.each do |dependency, message|
-    > if ! command -v {{ dependency }} >/dev/null 2>&1; then
-    >   printf "{{ strings[:missing_dependency] % { dependency: dependency } }}\n" >&2
-    if message and !message.empty?
-      >   printf "%s\n" "{{ message }}" >&2
+  dependencies.each do |dependency|
+    > if command -v {{ dependency.commands.join(' ') }} >/dev/null 2>&1; then
+    >   deps['{{ dependency.label }}']="$(command -v {{ dependency.commands.join(' ') }} | head -n1)"
+    > else
+    >   printf "{{ strings[:missing_dependency] % { dependency: dependency.name } }}\n" >&2
+    if dependency.help
+      >   printf "%s\n" "{{ dependency.help }}" >&2
     end
     >   exit 1
     > fi

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

@@ -3,14 +3,14 @@
 > initialize() {
 >   version="<%= version %>"
 >   long_usage=''
->   {{ Settings.strict ? "set -euo pipefail" : "set -e" }}
+>   {{ Settings.strict_string }}
 > 
 
 if root_command?
   = render(:environment_variables_default).indent 2
 end
 
-= load_user_file("initialize.sh", placeholder: false).indent 2
+= load_user_file("initialize", placeholder: false).indent 2
 
 > }
 >

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

@@ -1,8 +1,8 @@
 = view_marker
 
 > inspect_args() {
->   readarray -t sorted_keys < <(printf '%s\n' "${!args[@]}" | sort)
 >   if ((${#args[@]})); then
+>     readarray -t sorted_keys < <(printf '%s\n' "${!args[@]}" | sort)
 >     echo args:
 >     for k in "${sorted_keys[@]}"; do echo "- \${args[$k]} = ${args[$k]}"; done
 >   else
@@ -17,5 +17,13 @@
 >       echo "- \${other_args[$i]} = ${other_args[$i]}"
 >     done
 >   fi
+>
+>   if ((${#deps[@]})); then
+>     readarray -t sorted_keys < <(printf '%s\n' "${!deps[@]}" | sort)
+>     echo
+>     echo deps:
+>     for k in "${sorted_keys[@]}"; do echo "- \${deps[$k]} = ${deps[$k]}"; done
+>   fi
+>
 > }
 > 

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

@@ -8,6 +8,7 @@
 = render :user_lib if user_lib.any?
 = render :command_functions
 = render :parse_requirements
+= render :user_hooks
 = render :initialize
 = render :run
 

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

@@ -2,30 +2,31 @@
 
 > run() {
 >   declare -A args=()
+>   declare -A deps=()
 >   declare -a other_args=()
 >   declare -a input=()
 >   normalize_input "$@"
 >   parse_requirements "${input[@]}"
+if user_file_exist?('before')
+  >   before_hook
+end
 > 
 >   case "$action" in
 
 deep_commands.each do |command|
-  >     "{{ command.action_name }}")
-  >       if [[ ${args['--help']:-} ]]; then
-  >         long_usage=yes
-  >         {{ command.function_name }}_usage
-  >       else
-  >         {{ command.function_name }}_command
-  >       fi
-  >       ;;
-  >
+  >     "{{ command.action_name }}") {{ command.function_name }}_command ;;
 end
 
 if commands.empty?
-  >     "root")
-  >       root_command
-  >       ;;
+  >     "root") root_command ;;
 end
->
 >   esac
+
+if user_file_exist?('after')
+  >
+  >   after_hook
+end
+
 > }
+
+

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

@@ -0,0 +1,17 @@
+if user_file_exist?('before') || user_file_exist?('after')
+  = view_marker
+end
+
+if user_file_exist?('before')
+  > before_hook() {
+  = load_user_file("before").indent 2
+  > }
+  >
+end
+
+if user_file_exist?('after')
+  > after_hook() {
+  = load_user_file("after").indent 2
+  > }
+  >
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2023-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -155,6 +155,8 @@ files:
 - lib/bashly/libraries/config/config.sh
 - lib/bashly/libraries/help/help.rb
 - lib/bashly/libraries/help/help_command.sh
+- lib/bashly/libraries/hooks/after.sh
+- lib/bashly/libraries/hooks/before.sh
 - lib/bashly/libraries/lib/sample_function.sh
 - lib/bashly/libraries/libraries.yml
 - lib/bashly/libraries/settings/settings.yml
@@ -174,6 +176,7 @@ files:
 - lib/bashly/script/base.rb
 - lib/bashly/script/catch_all.rb
 - lib/bashly/script/command.rb
+- lib/bashly/script/dependency.rb
 - lib/bashly/script/environment_variable.rb
 - lib/bashly/script/flag.rb
 - lib/bashly/script/wrapper.rb
@@ -221,6 +224,7 @@ files:
 - lib/bashly/views/command/usage_fixed_flags.gtx
 - lib/bashly/views/command/usage_flags.gtx
 - lib/bashly/views/command/user_filter.gtx
+- lib/bashly/views/command/user_hooks.gtx
 - lib/bashly/views/command/user_lib.gtx
 - lib/bashly/views/command/version_command.gtx
 - lib/bashly/views/command/whitelist_filter.gtx
@@ -258,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.8
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator