bashly 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e17bc036331958bd9ff237d93e287c911bc00c85b33628a4b867dd2e69c818fe
-  data.tar.gz: 236e3ba5f96e9f89fce4b77d95adf68a3030ef31d3d59a857ad0477aa871b171
+  metadata.gz: 2b90c79b66c9396dc7fda026e19761818e7db33c8b19b0e0501486b3cdf7f1e0
+  data.tar.gz: be2b5e3ae996189263e604421910ebc3b8a597e3cf9c525cf19b94e2e4434fd3
 SHA512:
-  metadata.gz: 55f3361b37d963fcd33ad97b9204ce201517b9249522e4d4fb501c4502e8ba31ef5049c629d6bf5e82d85854ca64de1435f2604a01e12913ba5a56de346994ee
-  data.tar.gz: 23832fbbfbbaec41862b61eeb75ef0a34598db175192d09c3f1ea738bf1bd81aa11d855df7a6ba9ec8461a5daa0de835bc9343cb56e72e8867f5d7a15492f8d7
+  metadata.gz: 1414d602e5fabf5e9b98dfb1811276601f01de83dc0c866ce155ab22a2246122c9a6a2605c9f83dedc70f21a47c5f397b5ed59339412d8eccf09a319429b7271
+  data.tar.gz: 8bef6713c24b2a2d24d0ef97b54c1fd957ad8ff28e041ec08fdfa96c3bedc22a5a41c6b4691367357e63e404ba87dbd9599d7eddd0102cbe9bac9184f0d1dcee

data/README.md

@@ -29,7 +29,12 @@ 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>
+<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>
 
 
 ## Documentation
@@ -69,7 +74,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/commands/doc.rb

@@ -75,7 +75,7 @@ module Bashly
       def raw_data
         @raw_data ||= begin
           result = {}
-          Dir["#{docs_dir}/*.yml"].sort.each do |path|
+          Dir["#{docs_dir}/*.yml"].each do |path|
             result.merge! YAML.load_file(path)
           end
           result

data/lib/bashly/commands/generate.rb

@@ -89,7 +89,7 @@ module Bashly
       end
 
       def generated_files
-        Dir["#{Settings.source_dir}/**/*.*"].sort
+        Dir["#{Settings.source_dir}/**/*.*"]
       end
 
       def upgrade(existing_file, library_name, *args)
@@ -125,9 +125,6 @@ module Bashly
       def create_user_files
         quiet_say "creating user files in g`#{Settings.source_dir}`"
 
-        create_file "#{Settings.source_dir}/initialize.#{Settings.partials_extension}",
-          command.render(:default_initialize_script)
-
         if command.commands.empty?
           create_root_command_file
         else

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/config_validator.rb

@@ -100,14 +100,14 @@ module Bashly
 
       refute value['name'].match(/^-/), "#{key}.name must not start with '-'"
 
-      refute value['required'] && value['default'], "#{key} cannot have both required and default"
+      refute value['required'] && value['default'], "#{key} cannot have both nub`required` and nub`default`"
     end
 
     def assert_flag(key, value)
       assert_hash key, value, keys: Script::Flag.option_keys
-      assert value['short'] || value['long'], "#{key} must have at least one of long or short name"
+      assert value['short'] || value['long'], "#{key} must have at least one of nub`long` or nub`short`"
 
-      refute value['allowed'] && value['completions'], "#{key} cannot have both allowed and completions"
+      refute value['allowed'] && value['completions'], "#{key} cannot have both nub`allowed` and nub`completions`"
 
       assert_optional_string "#{key}.long", value['long']
       assert_optional_string "#{key}.short", value['short']
@@ -127,18 +127,18 @@ module Bashly
       assert value['short'].match(/^-[a-zA-Z0-9]$/), "#{key}.short must be in the form of '-n'" if value['short']
       refute value['arg'].match(/^-/), "#{key}.arg must not start with '-'" if value['arg']
 
-      refute value['required'] && value['default'], "#{key} cannot have both required and default"
+      refute value['required'] && value['default'], "#{key} cannot have both nub`required` and nub`default`"
 
       if value['default']
-        assert value['arg'], "#{key}.default does not make sense without arg"
+        assert value['arg'], "#{key}.default does not make sense without nub`arg`"
       end
 
       if value['allowed']
-        assert value['arg'], "#{key}.allowed does not make sense without arg"
+        assert value['arg'], "#{key}.allowed does not make sense without nub`arg`"
       end
 
       if value['completions']
-        assert value['arg'], "#{key}.completions does not make sense without arg"
+        assert value['arg'], "#{key}.completions does not make sense without nub`arg`"
       end
     end
 
@@ -154,8 +154,8 @@ module Bashly
     def assert_command(key, value)
       assert_hash key, value, keys: Script::Command.option_keys
 
-      refute value['commands'] && value['args'], "#{key} cannot have both commands and args"
-      refute value['commands'] && value['catch_all'], "#{key} cannot have both commands and catch_all"
+      refute value['commands'] && value['args'], "#{key} cannot have both nub`commands` and nub`args`"
+      refute value['commands'] && value['catch_all'], "#{key} cannot have both nub`commands` and nub`catch_all`"
 
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
@@ -202,7 +202,7 @@ module Bashly
       end
 
       if value['expose']
-        assert value['commands'], "#{key}.expose makes no sense without commands"
+        assert value['commands'], "#{key}.expose makes no sense without nub`commands`"
       end
 
       if key == 'root'

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/hooks/initialize.sh

@@ -0,0 +1,6 @@
+## initialize hook
+##
+## Any code here will be placed inside the `initialize()` function and called
+## before running anything else.
+##
+## You can safely delete this file if you do not need it.

data/lib/bashly/libraries/libraries.yml

@@ -29,6 +29,16 @@ help:
   help: Add a help command, in addition to the standard --help flag.
   handler: Bashly::Libraries::Help
 
+hooks:
+  help: Add placeholders for initialize/before/after hooks which are executed on script initialization, and before/after any command.
+  files:
+    - source: "hooks/initialize.sh"
+      target: "%{user_source_dir}/initialize.%{user_ext}"
+    - 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/script/command.rb

@@ -297,7 +297,7 @@ module Bashly
       # This is meant to provide the user with the ability to add custom
       # functions
       def user_lib
-        @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.#{Settings.partials_extension}"].sort
+        @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.#{Settings.partials_extension}"]
       end
 
       # Returns an array of all the args with a whitelist

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.0.1'
+  VERSION = '1.0.3'
 end

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

@@ -6,7 +6,7 @@ if default_args.any? or default_flags.any?
   end
 
   default_flags.each do |flag|
-    > [[ -n ${args['{{ flag.long }}']:-} ]] || args['{{ flag.long }}']="{{ flag.default }}"
+    > [[ -n ${args['{{ flag.name }}']:-} ]] || args['{{ flag.name }}']="{{ flag.default }}"
   end
 
   >

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

@@ -1,4 +1,4 @@
-if dependencies
+if dependencies.any?
   = view_marker
 
   dependencies.each do |dependency|

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

@@ -4,4 +4,4 @@ if default_environment_variables.any?
   default_environment_variables.each do |env_var|
     > export {{ env_var.name.upcase }}="${<%= env_var.name.upcase %>:-<%= env_var.default %>}"
   end
-end
+end

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

@@ -4,13 +4,16 @@
 >   version="<%= version %>"
 >   long_usage=''
 >   {{ Settings.strict_string }}
-> 
 
 if root_command?
+  > 
   = render(:environment_variables_default).indent 2
 end
 
-= load_user_file("initialize.sh", placeholder: false).indent 2
+if user_file_exist?('initialize')
+  > 
+  = load_user_file('initialize').indent 2
+end
 
 > }
 >

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/required_flags_filter.gtx

@@ -2,7 +2,7 @@ if required_flags.any?
   = view_marker
 
   required_flags.each do |flag|
-    > if [[ -z ${args['{{ flag.long }}']+x} ]]; then
+    > if [[ -z ${args['{{ flag.name }}']+x} ]]; then
     >   printf "{{ strings[:missing_required_flag] % { usage: flag.usage_string } }}\n" >&2
     >   exit 1
     > fi

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

@@ -7,26 +7,26 @@
 >   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

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

@@ -12,7 +12,7 @@ if whitelisted_args.any? or whitelisted_flags.any?
       > done
 
     else
-      > if [[ ! ${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 }}']} =~ ^({{ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-03 00:00:00.000000000 Z
+date: 2023-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -155,6 +155,9 @@ 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/hooks/initialize.sh
 - lib/bashly/libraries/lib/sample_function.sh
 - lib/bashly/libraries/libraries.yml
 - lib/bashly/libraries/settings/settings.yml
@@ -190,7 +193,6 @@ files:
 - lib/bashly/views/command/command_filter.gtx
 - lib/bashly/views/command/command_functions.gtx
 - lib/bashly/views/command/default_assignments.gtx
-- lib/bashly/views/command/default_initialize_script.gtx
 - lib/bashly/views/command/default_root_script.gtx
 - lib/bashly/views/command/default_script.gtx
 - lib/bashly/views/command/dependencies_filter.gtx
@@ -222,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
@@ -252,14 +255,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator

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

@@ -1,7 +0,0 @@
-> ## Code here runs inside the initialize() function
-> ## Use it for anything that you need to run before any other function, like
-> ## setting environment variables:
-> ## CONFIG_FILE=settings.ini
-> ##
-> ## Feel free to empty (but not delete) this file.
->