Merge pull request #193 from DannyBen/add/lib-path-setting

DannyBen · web-flow · commit 65107a07fa9d · 2022-02-19T14:46:31.000+02:00
Add `BASHLY_LIB_DIR` configuration variable
diff --git a/lib/bashly/commands/add.rb b/lib/bashly/commands/add.rb
@@ -32,6 +32,7 @@ class Add < Base
       example "bashly add comp script completions.bash"
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
+      environment "BASHLY_LIB_DIR", "The path to use for creating the library files, relative to the source dir [default: lib]"
 
       def strings_command
         add_lib 'strings'
diff --git a/lib/bashly/commands/generate.rb b/lib/bashly/commands/generate.rb
@@ -13,6 +13,7 @@ class Generate < Base
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
       environment "BASHLY_TARGET_DIR", "The path to use for creating the bash script [default: .]"
+      environment "BASHLY_LIB_DIR", "The path to use for upgrading library files, relative to the source dir [default: lib]"
       environment "BASHLY_STRICT", "When not empty, enable bash strict mode (set -euo pipefail)"
 
       example "bashly generate --force"
diff --git a/lib/bashly/libraries.yml b/lib/bashly/libraries.yml
@@ -1,22 +1,22 @@
 colors:
   files:
     - source: "templates/lib/colors.sh"
-      target: "%{user_source_dir}/lib/colors.sh"
+      target: "%{user_lib_dir}/colors.sh"
 
 config:
   files:
     - source: "templates/lib/config.sh"
-      target: "%{user_source_dir}/lib/config.sh"
+      target: "%{user_lib_dir}/config.sh"
 
 yaml:
   files:
     - source: "templates/lib/yaml.sh"
-      target: "%{user_source_dir}/lib/yaml.sh"
+      target: "%{user_lib_dir}/yaml.sh"
 
 lib:
   files:
     - source: "templates/lib/sample_function.sh"
-      target: "%{user_source_dir}/lib/sample_function.sh"
+      target: "%{user_lib_dir}/sample_function.sh"
 
 strings:
   files:
@@ -41,13 +41,13 @@ test:
 validations:
   files:
     - source: "templates/lib/validations/validate_dir_exists.sh"
-      target: "%{user_source_dir}/lib/validations/validate_dir_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_dir_exists.sh"
     - source: "templates/lib/validations/validate_file_exists.sh"
-      target: "%{user_source_dir}/lib/validations/validate_file_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_file_exists.sh"
     - source: "templates/lib/validations/validate_integer.sh"
-      target: "%{user_source_dir}/lib/validations/validate_integer.sh"
+      target: "%{user_lib_dir}/validations/validate_integer.sh"
     - source: "templates/lib/validations/validate_not_empty.sh"
-      target: "%{user_source_dir}/lib/validations/validate_not_empty.sh"
+      target: "%{user_lib_dir}/validations/validate_not_empty.sh"
 
 completions: :CompletionsFunction
 completions_script: :CompletionsScript
diff --git a/lib/bashly/libraries/completions_function.rb b/lib/bashly/libraries/completions_function.rb
@@ -4,7 +4,7 @@ class CompletionsFunction < Completions
       def files
         [
           {
-            path: "#{Settings.source_dir}/lib/#{function_name}.sh",
+            path: "#{Settings.full_lib_dir}/#{function_name}.sh",
             content: completions_function_code(function_name)
           }
         ]
diff --git a/lib/bashly/library.rb b/lib/bashly/library.rb
@@ -59,7 +59,8 @@ def config
     def target_file_args
       {
         user_source_dir: Settings.source_dir,
-        user_target_dir: Settings.target_dir
+        user_target_dir: Settings.target_dir,
+        user_lib_dir: Settings.full_lib_dir,
       }
     end
   end
diff --git a/lib/bashly/script/command.rb b/lib/bashly/script/command.rb
@@ -125,7 +125,7 @@ def usage_string
       # This is meant to provide the user with the ability to add custom
       # functions
       def user_lib
-        @user_lib ||= Dir["#{Settings.source_dir}/lib/**/*.sh"].sort
+        @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.sh"].sort
       end
 
       # Raise an exception if there are some serious issues with the command
diff --git a/lib/bashly/settings.rb b/lib/bashly/settings.rb
@@ -1,7 +1,7 @@
 module Bashly
   class Settings
     class << self
-      attr_writer :source_dir, :target_dir
+      attr_writer :source_dir, :target_dir, :lib_dir, :strict
 
       def source_dir
         @source_dir ||= ENV['BASHLY_SOURCE_DIR'] || 'src'
@@ -10,6 +10,18 @@ def source_dir
       def target_dir
         @target_dir ||= ENV['BASHLY_TARGET_DIR'] || '.'
       end
+
+      def lib_dir
+        @lib_dir ||= ENV['BASHLY_LIB_DIR'] || 'lib'
+      end
+
+      def strict
+        @strict ||= ENV['BASHLY_STRICT']
+      end
+
+      def full_lib_dir
+        "#{source_dir}/#{lib_dir}"
+      end
     end
   end
 end
diff --git a/lib/bashly/views/command/initialize.erb b/lib/bashly/views/command/initialize.erb
@@ -2,7 +2,7 @@
 initialize() {
   version="<%= version %>"
   long_usage=''
-  <%= ENV['BASHLY_STRICT'] ? "set -euo pipefail" : "set -e" %>
+  <%= Settings.strict ? "set -euo pipefail" : "set -e" %>
 
 <%= load_user_file("initialize.sh", placeholder: false).indent 2 %>
 }
diff --git a/spec/approvals/cli/add/help b/spec/approvals/cli/add/help
@@ -62,6 +62,10 @@ Environment Variables:
   BASHLY_SOURCE_DIR
     The path containing the bashly configuration and source files [default: src]
 
+  BASHLY_LIB_DIR
+    The path to use for creating the library files, relative to the source dir
+    [default: lib]
+
 Examples:
   bashly add strings --force
   bashly add comp function
diff --git a/spec/approvals/cli/generate/help b/spec/approvals/cli/generate/help
@@ -27,6 +27,10 @@ Environment Variables:
   BASHLY_TARGET_DIR
     The path to use for creating the bash script [default: .]
 
+  BASHLY_LIB_DIR
+    The path to use for upgrading library files, relative to the source dir
+    [default: lib]
+
   BASHLY_STRICT
     When not empty, enable bash strict mode (set -euo pipefail)
 
diff --git a/spec/approvals/fixtures/lib-custom-path b/spec/approvals/fixtures/lib-custom-path
@@ -0,0 +1,34 @@
++ bundle exec bashly generate
+creating user files in src
+skipped src/initialize.sh (exists)
+skipped src/root_command.sh (exists)
+created ./cli
+run ./cli --help to test your bash script
++ bundle exec bashly add lib
+created src/my-libz/sample_function.sh
++ bundle exec bashly add colors
+created src/my-libz/colors.sh
++ bundle exec bashly generate
+creating user files in src
+skipped src/initialize.sh (exists)
+skipped src/root_command.sh (exists)
+created ./cli
+run ./cli --help to test your bash script
++ ./cli
+it works
++ bundle exec bashly generate --upgrade
+creating user files in src
+skipped src/initialize.sh (exists)
+skipped src/root_command.sh (exists)
+updated src/my-libz/colors.sh
+created ./cli
+run ./cli --help to test your bash script
++ bundle exec bashly add comp function
+created src/my-libz/send_completions.sh
+
+In order to enable completions in your script, create a command or a flag (for example: cli completions or cli --completions) that calls the send_completions function.
+
+Your users can then run something like this to enable completions:
+
+  $ eval "$(cli completions)"
+
diff --git a/spec/fixtures/workspaces/lib-custom-path/.gitignore b/spec/fixtures/workspaces/lib-custom-path/.gitignore
@@ -0,0 +1,2 @@
+cli
+src/my-libz
diff --git a/spec/fixtures/workspaces/lib-custom-path/README.md b/spec/fixtures/workspaces/lib-custom-path/README.md
@@ -0,0 +1 @@
+This fixture workspace is used for testing custom BASHLY_LIB_DIR.
diff --git a/spec/fixtures/workspaces/lib-custom-path/src/bashly.yml b/spec/fixtures/workspaces/lib-custom-path/src/bashly.yml
@@ -0,0 +1,2 @@
+name: cli
+help: Sample application
diff --git a/spec/fixtures/workspaces/lib-custom-path/src/initialize.sh b/spec/fixtures/workspaces/lib-custom-path/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.
diff --git a/spec/fixtures/workspaces/lib-custom-path/src/root_command.sh b/spec/fixtures/workspaces/lib-custom-path/src/root_command.sh
@@ -0,0 +1,2 @@
+# Call the lib function to ensure it was included
+sample_function
diff --git a/spec/fixtures/workspaces/lib-custom-path/test.sh b/spec/fixtures/workspaces/lib-custom-path/test.sh
@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+# This fixture tests that BASHLY_LIB_DIR properly influences all commands that 
+# use it.
+# It is executed as part of the Runfile examples test
+
+rm -f ./cli
+rm -rf ./src/my-libz
+export BASHLY_LIB_DIR=my-libz
+
+set -x
+
+bundle exec bashly generate
+bundle exec bashly add lib
+bundle exec bashly add colors
+bundle exec bashly generate
+./cli
+bundle exec bashly generate --upgrade
+bundle exec bashly add comp function
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -14,16 +14,14 @@
 # Set up working directory for the specs
 Settings.source_dir = 'spec/tmp/src'
 Settings.target_dir = 'spec/tmp'
+Settings.strict = '1' # generate scripts with `set -euo pipefile`
 reset_tmp_dir
 
 # Consistent Colsole output (for rspec_fixtures)
 ENV['TTY'] = 'off'
 ENV['COLUMNS'] = '80'
 ENV['LINES'] = '30'
 
-# Force generated scripts to strict mode (set -euo pipefile)
-ENV['BASHLY_STRICT'] = '1'
-
 RSpec.configure do |c|
   c.include SpecMixin
   c.strip_ansi_escape = true

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ class CompletionsFunction < Completions`
`4`	`4`	`def files`
`5`	`5`	`[`
`6`	`6`	`{`
`7`		`- path: "#{Settings.source_dir}/lib/#{function_name}.sh",`
	`7`	`+ path: "#{Settings.full_lib_dir}/#{function_name}.sh",`
`8`	`8`	`content: completions_function_code(function_name)`
`9`	`9`	`}`
`10`	`10`	`]`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,8 @@ def config`
`59`	`59`	`def target_file_args`
`60`	`60`	`{`
`61`	`61`	`user_source_dir: Settings.source_dir,`
`62`		`- user_target_dir: Settings.target_dir`
	`62`	`+ user_target_dir: Settings.target_dir,`
	`63`	`+ user_lib_dir: Settings.full_lib_dir,`
`63`	`64`	`}`
`64`	`65`	`end`
`65`	`66`	`end`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`initialize() {`
`3`	`3`	`version="<%= version %>"`
`4`	`4`	`long_usage=''`
`5`		`- <%= ENV['BASHLY_STRICT'] ? "set -euo pipefail" : "set -e" %>`
	`5`	`+ <%= Settings.strict ? "set -euo pipefail" : "set -e" %>`
`6`	`6`
`7`	`7`	`<%= load_user_file("initialize.sh", placeholder: false).indent 2 %>`
`8`	`8`	`}`