Merge pull request #362 from DannyBen/add/hooks

DannyBen · web-flow · commit 23100222ca54 · 2023-03-21T12:42:16.000+02:00
Add before/after hooks
diff --git a/examples/README.md b/examples/README.md
@@ -62,6 +62,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
 - [yaml](yaml#readme) - using the YAML reading functions
 - [completions](completions#readme) - adding bash completion functionality
 - [validations](validations#readme) - adding argument validation functions
+- [hooks](hooks#readme) - adding before/after hooks
 
 ## Other Examples
 
diff --git a/examples/colors/README.md b/examples/colors/README.md
@@ -13,9 +13,9 @@ $ bashly generate
 $ bashly generate
 ```
 
-The `bashly add colors` command, simply created the [src/lib/colors.sh]
-(src/lib/colors.sh) file, with useful color functions that will be
-automatically included in the generated script.
+The `bashly add colors` command, simply created the
+[src/lib/colors.sh](src/lib/colors.sh) file, with useful color functions that
+will be automatically included in the generated script.
 
 See the manually edited [src/root_command.sh](src/root_command.sh) for usage
 examples.
diff --git a/examples/hooks/.gitignore b/examples/hooks/.gitignore
@@ -0,0 +1 @@
+hooks
diff --git a/examples/hooks/README.md b/examples/hooks/README.md
@@ -0,0 +1,63 @@
+# Before/After Hooks Example
+
+This example demonstrates how to run common code before or after executing any
+command.
+
+This example was generated with:
+
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+$ bashly add hooks
+$ bashly generate
+```
+
+-----
+
+## `bashly.yml`
+
+```yaml
+name: hooks
+help: Sample application that uses before/after hooks
+version: 0.1.0
+
+flags:
+- long: --debug
+  short: -d
+  help: Enable debug mode
+```
+
+
+
+## Generated script output
+
+### `$ ./hooks`
+
+```shell
+==[ Before Hook Called ]==
+args: none
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args: none
+==[ After Hook Called ]==
+
+
+```
+
+### `$ ./hooks --debug`
+
+```shell
+==[ Before Hook Called ]==
+args:
+- ${args[--debug]} = 1
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--debug]} = 1
+==[ After Hook Called ]==
+
+
+```
+
+
+
diff --git a/examples/hooks/src/after.sh b/examples/hooks/src/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 ]=="
diff --git a/examples/hooks/src/bashly.yml b/examples/hooks/src/bashly.yml
@@ -0,0 +1,8 @@
+name: hooks
+help: Sample application that uses before/after hooks
+version: 0.1.0
+
+flags:
+- long: --debug
+  short: -d
+  help: Enable debug mode
diff --git a/examples/hooks/src/before.sh b/examples/hooks/src/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
diff --git a/examples/hooks/src/initialize.sh b/examples/hooks/src/initialize.sh
@@ -0,0 +1,6 @@
+## 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.
diff --git a/examples/hooks/src/root_command.sh b/examples/hooks/src/root_command.sh
@@ -0,0 +1,3 @@
+echo "# this file is located in 'src/root_command.sh'"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/hooks/test.sh b/examples/hooks/test.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -x
+
+bashly add hooks --force
+bashly generate
+
+### Try Me ###
+
+./hooks
+./hooks --debug
diff --git a/lib/bashly/concerns/renderable.rb b/lib/bashly/concerns/renderable.rb
@@ -10,6 +10,7 @@ def strings
       @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?
@@ -31,6 +32,9 @@ def load_user_file(file, placeholder: true)
       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}"
@@ -39,6 +43,11 @@ def user_file_path(file)
       "#{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)
diff --git a/lib/bashly/libraries/hooks/after.sh b/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 ]=="
diff --git a/lib/bashly/libraries/hooks/before.sh b/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
diff --git a/lib/bashly/libraries/libraries.yml b/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.
diff --git a/lib/bashly/views/command/master_script.gtx b/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
 
diff --git a/lib/bashly/views/command/run.gtx b/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
+
 > }
+
+
diff --git a/lib/bashly/views/command/user_hooks.gtx b/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
diff --git a/spec/approvals/cli/add/hooks_command b/spec/approvals/cli/add/hooks_command
@@ -0,0 +1,2 @@
+created spec/tmp/src/before.sh
+created spec/tmp/src/after.sh
diff --git a/spec/approvals/cli/add/list b/spec/approvals/cli/add/list
@@ -17,6 +17,10 @@ config
 help
   Add a help command, in addition to the standard --help flag.
 
+hooks
+  Add placeholders for before/after hooks which are executed before/after any
+  command.
+
 lib
   Create the lib directory for any additional user scripts.
   All *.sh scripts in this directory will be included in the final bash script.
diff --git a/spec/approvals/examples/hooks b/spec/approvals/examples/hooks
@@ -0,0 +1,25 @@
++ bashly add hooks --force
+created src/before.sh
+created src/after.sh
++ bashly generate
+creating user files in src
+skipped src/initialize.sh (exists)
+skipped src/root_command.sh (exists)
+created ./hooks
+run ./hooks --help to test your bash script
++ ./hooks
+==[ Before Hook Called ]==
+args: none
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args: none
+==[ After Hook Called ]==
++ ./hooks --debug
+==[ Before Hook Called ]==
+args:
+- ${args[--debug]} = 1
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--debug]} = 1
+==[ After Hook Called ]==
diff --git a/spec/bashly/commands/add_spec.rb b/spec/bashly/commands/add_spec.rb
@@ -94,6 +94,19 @@
     end
   end
 
+  context 'with hooks command' do
+    let(:before_hook_file) { "#{source_dir}/before.sh" }
+    let(:after_hook_file) { "#{source_dir}/after.sh" }
+
+    before { reset_tmp_dir init: true }
+
+    it 'copies before.sh and after.sh to the user space' do
+      expect { subject.execute %w[add hooks] }.to output_approval('cli/add/hooks_command')
+      expect(File).to exist(before_hook_file)
+      expect(File).to exist(after_hook_file)
+    end
+  end
+
   context 'with lib command' do
     let(:lib_file) { "#{source_dir}/lib/sample_function.sh" }
 
diff --git a/spec/bashly/library_source_spec.rb b/spec/bashly/library_source_spec.rb
@@ -103,7 +103,7 @@
     it 'returns all libraries as keys' do
       expect(subject.libraries.keys).to match_array %i[
         colors completions completions_script completions_yaml config
-        help lib settings strings test validations yaml
+        help hooks lib settings strings test validations yaml
       ]
     end
 
diff --git a/spec/bashly/script/command_spec.rb b/spec/bashly/script/command_spec.rb
@@ -353,6 +353,26 @@
     end
   end
 
+  describe '#user_file_exist?' do
+    before { FileUtils.mkdir_p 'spec/tmp/src' }
+
+    context 'when the file exists in the user source path' do
+      before { FileUtils.touch 'spec/tmp/src/test.sh' }
+
+      it 'returns true' do
+        expect(subject.user_file_exist?('test')).to be true
+      end
+    end
+
+    context 'when the file does not in the user source path' do
+      before { FileUtils.rm_f 'spec/tmp/src/test.sh' }
+
+      it 'returns false' do
+        expect(subject.user_file_exist?('test')).to be false
+      end
+    end
+  end
+
   describe '#required_args' do
     it 'returns an array of only the required Argument objects' do
       expect(subject.required_args.size).to eq 1

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+echo "# this file is located in 'src/root_command.sh'"`
	`2`	`+echo "# you can edit it freely and regenerate (it will not be overwritten)"`
	`3`	`+inspect_args`