bashly 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e17bc036331958bd9ff237d93e287c911bc00c85b33628a4b867dd2e69c818fe
-  data.tar.gz: 236e3ba5f96e9f89fce4b77d95adf68a3030ef31d3d59a857ad0477aa871b171
+  metadata.gz: 67c0cd0da5f37edbad28313553ac30b878edae7d2255158d940af0deb8aa0a05
+  data.tar.gz: 6cf9bac796564e7730f3a55e6022d78a962506b418eb00cdecbe1111f3770ffb
 SHA512:
-  metadata.gz: 55f3361b37d963fcd33ad97b9204ce201517b9249522e4d4fb501c4502e8ba31ef5049c629d6bf5e82d85854ca64de1435f2604a01e12913ba5a56de346994ee
-  data.tar.gz: 23832fbbfbbaec41862b61eeb75ef0a34598db175192d09c3f1ea738bf1bd81aa11d855df7a6ba9ec8461a5daa0de835bc9343cb56e72e8867f5d7a15492f8d7
+  metadata.gz: 16eb355eb439bfc24457b184dd8255c091bb62dc1646c15e6d2842160f8848595de799cb453e54e43cdf5c2605906ed8f8c49ee21f5afda3999c9224b8d6fbc6
+  data.tar.gz: 889722479c576c8b30c3be1081911d0a7f61613664fc146fb4a2867b65d7199a5283464cc59eb40530e2c43f8270fbaa11e7f3a3d851cedc87a71515aef235b8

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

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 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/initialize.gtx

@@ -10,7 +10,7 @@ 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/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

@@ -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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-03 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
@@ -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
@@ -259,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.8
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator