Merge pull request #120 from DannyBen/add/custom-script-header

Add support for a custom script header

Author: DannyBen

examples/completions/README.md

@@ -172,12 +172,13 @@ Options:
 # Modifying it manually is not recommended
 _cli_completions() {
   local cur=${COMP_WORDS[COMP_CWORD]}
+  local comp_line="${COMP_WORDS[*]:1}"
 
-  case "$COMP_LINE" in
-    'cli completions'*) COMPREPLY=($(compgen -W "--help -h" -- "$cur")) ;;
-    'cli download'*) COMPREPLY=($(compgen -A file -W "--force --help -f -h" -- "$cur")) ;;
-    'cli upload'*) COMPREPLY=($(compgen -A directory -A user -W "--help --password --user -h -p -u" -- "$cur")) ;;
-    'cli'*) COMPREPLY=($(compgen -W "--help --version -h -v completions download upload" -- "$cur")) ;;
+  case "$comp_line" in
+    'completions'*) COMPREPLY=($(compgen -W "--help -h" -- "$cur")) ;;
+    'download'*) COMPREPLY=($(compgen -A file -W "--force --help -f -h" -- "$cur")) ;;
+    'upload'*) COMPREPLY=($(compgen -A directory -A user -W "--help --password --user -h -p -u" -- "$cur")) ;;
+    ''*) COMPREPLY=($(compgen -W "--help --version -h -v completions download upload" -- "$cur")) ;;
   esac
 }
 

examples/custom-script-header/.gitignore

@@ -0,0 +1 @@
+download

examples/custom-script-header/README.md

@@ -0,0 +1,75 @@
+# Custom Script Header Example
+
+This example shows how to replace the script header by simply placing a 
+file called `header.sh` in your `src` folder.
+
+Under most circumstances, you should not do it, and instead put your
+initialization code in `src/initialize.sh`.
+
+This example was generated with:
+
+```bash
+$ bashly init --minimal
+$ bashly generate
+```
+
+<!-- include: src/header.sh -->
+
+-----
+
+## `bashly.yml`
+
+```yaml
+name: download
+help: Sample minimal application without commands
+version: 0.1.0
+
+args:
+- name: source
+  required: true
+  help: URL to download from
+- name: target
+  help: "Target filename (default: same as source)"
+
+flags:
+- long: --force
+  short: -f
+  help: Overwrite existing files
+
+examples:
+- download example.com
+- download example.com ./output -f
+```
+
+## `src/header.sh`
+
+```bash
+#!/usr/bin/env bash
+
+# This is a custom header that will be injected to the very top of the 
+# script, replacing the original header.
+# Note that in most cases you should use initialize.sh instead.
+
+some_condition=true
+
+if [ "$some_condition" = true ]; then
+  echo "Some condition was met, aborting"
+  exit
+fi
+
+
+```
+
+
+## Generated script output
+
+### `$ ./download`
+
+```shell
+Some condition was met, aborting
+
+
+```
+
+
+

examples/custom-script-header/src/bashly.yml

@@ -0,0 +1,19 @@
+name: download
+help: Sample minimal application without commands
+version: 0.1.0
+
+args:
+- name: source
+  required: true
+  help: URL to download from
+- name: target
+  help: "Target filename (default: same as source)"
+
+flags:
+- long: --force
+  short: -f
+  help: Overwrite existing files
+
+examples:
+- download example.com
+- download example.com ./output -f

examples/custom-script-header/src/header.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# This is a custom header that will be injected to the very top of the 
+# script, replacing the original header.
+# Note that in most cases you should use initialize.sh instead.
+
+some_condition=true
+
+if [ "$some_condition" = true ]; then
+  echo "Some condition was met, aborting"
+  exit
+fi
+

examples/custom-script-header/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 vairables:
+# CONFIG_FILE=settings.ini
+#
+# Feel free to empty (but not delete) this file.

examples/custom-script-header/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

examples/custom-script-header/test.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -x
+
+bashly generate
+
+### Try Me ###
+
+./download

lib/bashly/models/script.rb

@@ -22,12 +22,24 @@ def code
     private
 
       def header
-        @header ||= render('header')
+        @header ||= header!
+      end
+
+      def header!
+        if File.exist? custom_header_path
+          File.read custom_header_path
+        else
+          render('header')
+        end
       end
 
       def body
         @body ||= command.render('master_script')
       end
+
+      def custom_header_path
+        @custom_header_path ||= "#{Settings.source_dir}/header.sh"
+      end
     end
   end
 end

spec/README.md

@@ -10,7 +10,14 @@ Run tests with either of these commands:
     $ [bundle exec] run spec
     $ [bundle exec] rspec
 
-Also note that running the tests will regenerate all examples.
+## Notes about Example Tests
+
+1. Running the tests will regenerate all examples.
+2. The generated example executables are .gitignored.
+3. Each example contains a `test.sh` file, which calls `bashly generate` 
+  (without `bundle exec`) before proceeding with the test. For this reason, you 
+  *might* need to install the local gem before running tests, you can do so by
+  running `run gem build --install`).
 
 
 [1]: https://github.com/DannyBen/rspec_approvals