Merge pull request #308 from DannyBen/add/configurable-extension

DannyBen · web-flow · commit eb08b55c8159 · 2022-12-03T21:24:09.000+02:00
Add the ability to choose .bash as the partials extension
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -9,7 +9,9 @@ inherit_gem:
 
 AllCops:
   TargetRubyVersion: 2.7
-  SuggestExtensions: false
+  Exclude:
+    - debug.rb
+    - dev/**/*
 
 # The `ConfigValidator` class is a DSL, let it be
 Metrics/AbcSize:              { Exclude: [lib/bashly/config_validator.rb] }
diff --git a/lib/bashly/commands/add.rb b/lib/bashly/commands/add.rb
@@ -34,8 +34,11 @@ class Add < Base
       command 'comp', 'Generate a bash completions script or function.'
       command 'config', 'Add standard functions for handling INI files to the lib directory.'
       command 'help', 'Add a help command, in addition to the standard --help flag.'
-      command 'lib', 'Create the additional lib directory for additional user scripts. All *.sh scripts in this ' \
-        'folder will be included in the final bash script.'
+      command 'lib', <<~USAGE
+        Create the lib directory for any additional user scripts.
+        All *.sh scripts in this directory will be included in the final bash script.
+        Note that if you configured a different partials_extension, then the extensions of the files in this directory need to match.
+      USAGE
 
       command 'settings', 'Copy a sample settings.yml file to your project, allowing you to customize some ' \
         'bashly options.'
diff --git a/lib/bashly/commands/generate.rb b/lib/bashly/commands/generate.rb
@@ -130,7 +130,8 @@ def upgrade!(existing_file, library_name, *args)
       def create_user_files
         quiet_say "creating user files in !txtgrn!#{Settings.source_dir}"
 
-        create_file "#{Settings.source_dir}/initialize.sh", command.render(:default_initialize_script)
+        create_file "#{Settings.source_dir}/initialize.#{Settings.partials_extension}",
+          command.render(:default_initialize_script)
 
         if command.commands.empty?
           create_root_command_file
diff --git a/lib/bashly/libraries.yml b/lib/bashly/libraries.yml
@@ -1,7 +1,7 @@
 colors:
   files:
     - source: "templates/lib/colors.sh"
-      target: "%{user_lib_dir}/colors.sh"
+      target: "%{user_lib_dir}/colors.%{user_ext}"
 
 completions: :CompletionsFunction
 completions_script: :CompletionsScript
@@ -10,14 +10,14 @@ completions_yaml: :CompletionsYAML
 config:
   files:
     - source: "templates/lib/config.sh"
-      target: "%{user_lib_dir}/config.sh"
+      target: "%{user_lib_dir}/config.%{user_ext}"
 
 help: :Help
 
 lib:
   files:
     - source: "templates/lib/sample_function.sh"
-      target: "%{user_lib_dir}/sample_function.sh"
+      target: "%{user_lib_dir}/sample_function.%{user_ext}"
 
 settings:
   files:
@@ -46,15 +46,15 @@ test:
 validations:
   files:
     - source: "templates/lib/validations/validate_dir_exists.sh"
-      target: "%{user_lib_dir}/validations/validate_dir_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_dir_exists.%{user_ext}"
     - source: "templates/lib/validations/validate_file_exists.sh"
-      target: "%{user_lib_dir}/validations/validate_file_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_file_exists.%{user_ext}"
     - source: "templates/lib/validations/validate_integer.sh"
-      target: "%{user_lib_dir}/validations/validate_integer.sh"
+      target: "%{user_lib_dir}/validations/validate_integer.%{user_ext}"
     - source: "templates/lib/validations/validate_not_empty.sh"
-      target: "%{user_lib_dir}/validations/validate_not_empty.sh"
+      target: "%{user_lib_dir}/validations/validate_not_empty.%{user_ext}"
 
 yaml:
   files:
     - source: "templates/lib/yaml.sh"
-      target: "%{user_lib_dir}/yaml.sh"
+      target: "%{user_lib_dir}/yaml.%{user_ext}"
diff --git a/lib/bashly/libraries/completions_function.rb b/lib/bashly/libraries/completions_function.rb
@@ -4,7 +4,7 @@ class CompletionsFunction < Base
       def files
         [
           {
-            path:    "#{Settings.full_lib_dir}/#{function_name}.sh",
+            path:    "#{Settings.full_lib_dir}/#{function_name}.#{Settings.partials_extension}",
             content: completions_function_code(function_name),
           },
         ]
diff --git a/lib/bashly/libraries/help.rb b/lib/bashly/libraries/help.rb
@@ -6,7 +6,7 @@ class Help < Base
       def files
         [
           {
-            path:    "#{Settings.source_dir}/help_command.sh",
+            path:    "#{Settings.source_dir}/help_command.#{Settings.partials_extension}",
             content: help_command,
           },
         ]
diff --git a/lib/bashly/library.rb b/lib/bashly/library.rb
@@ -63,6 +63,7 @@ def target_file_args
         user_source_dir: Settings.source_dir,
         user_target_dir: Settings.target_dir,
         user_lib_dir:    Settings.full_lib_dir,
+        user_ext:        Settings.partials_extension,
       }
     end
   end
diff --git a/lib/bashly/script/command.rb b/lib/bashly/script/command.rb
@@ -156,7 +156,7 @@ def examples
       # Returns the bash filename that is expected to hold the user code
       # for this command
       def filename
-        options['filename'] || "#{action_name.to_underscore}_command.sh"
+        options['filename'] || "#{action_name.to_underscore}_command.#{Settings.partials_extension}"
       end
 
       # Returns an array of Flags
@@ -281,7 +281,7 @@ def usage_string_args
       # This is meant to provide the user with the ability to add custom
       # functions
       def user_lib
-        @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.sh"].sort
+        @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.#{Settings.partials_extension}"].sort
       end
 
       # Returns an array of all the args with a whitelist
diff --git a/lib/bashly/script/wrapper.rb b/lib/bashly/script/wrapper.rb
@@ -49,7 +49,7 @@ def body
       end
 
       def custom_header_path
-        @custom_header_path ||= "#{Settings.source_dir}/header.sh"
+        @custom_header_path ||= "#{Settings.source_dir}/header.#{Settings.partials_extension}"
       end
     end
   end
diff --git a/lib/bashly/settings.rb b/lib/bashly/settings.rb
@@ -3,47 +3,51 @@ class Settings
     class << self
       include AssetHelper
 
-      attr_writer :compact_short_flags, :source_dir, :target_dir,
-        :lib_dir, :strict, :tab_indent
+      attr_writer :compact_short_flags, :lib_dir, :partials_extension,
+        :source_dir, :strict, :tab_indent, :target_dir
 
-      def source_dir
-        @source_dir ||= get :source_dir
+      def compact_short_flags
+        @compact_short_flags ||= get :compact_short_flags
       end
 
-      def target_dir
-        @target_dir ||= get :target_dir
+      def env
+        @env ||= get(:env)&.to_sym
       end
 
-      def lib_dir
-        @lib_dir ||= get :lib_dir
+      def env=(value)
+        @env = value&.to_sym
       end
 
-      def strict
-        @strict ||= get :strict
+      def full_lib_dir
+        "#{source_dir}/#{lib_dir}"
       end
 
-      def tab_indent
-        @tab_indent ||= get :tab_indent
+      def lib_dir
+        @lib_dir ||= get :lib_dir
       end
 
-      def compact_short_flags
-        @compact_short_flags ||= get :compact_short_flags
+      def partials_extension
+        @partials_extension ||= get :partials_extension
       end
 
-      def env
-        @env ||= get(:env)&.to_sym
+      def production?
+        env == :production
       end
 
-      def env=(value)
-        @env = value&.to_sym
+      def source_dir
+        @source_dir ||= get :source_dir
       end
 
-      def production?
-        env == :production
+      def strict
+        @strict ||= get :strict
       end
 
-      def full_lib_dir
-        "#{source_dir}/#{lib_dir}"
+      def tab_indent
+        @tab_indent ||= get :tab_indent
+      end
+
+      def target_dir
+        @target_dir ||= get :target_dir
       end
 
     private
diff --git a/lib/bashly/templates/settings.yml b/lib/bashly/templates/settings.yml
@@ -30,3 +30,6 @@ compact_short_flags: true
 # - production    generate a smaller script, without file markers
 # - development   generate with file markers
 env: development
+
+# The extension to use when reading/writing partial script snippets.
+partials_extension: sh
diff --git a/spec/approvals/cli/add/help b/spec/approvals/cli/add/help
@@ -28,8 +28,11 @@ Commands:
     Add a help command, in addition to the standard --help flag.
 
   lib
-    Create the additional lib directory for additional user scripts. All *.sh
-    scripts in this folder will be included in the final bash script.
+    Create the lib directory for any additional user scripts.
+    All *.sh scripts in this directory will be included in the final bash
+    script.
+    Note that if you configured a different partials_extension, then the
+    extensions of the files in this directory need to match.
 
   settings
     Copy a sample settings.yml file to your project, allowing you to customize
diff --git a/spec/approvals/fixtures/partials_extension b/spec/approvals/fixtures/partials_extension
@@ -0,0 +1,104 @@
++ export BASHLY_PARTIALS_EXTENSION=bash
++ BASHLY_PARTIALS_EXTENSION=bash
++ bundle exec bashly init
+created src/bashly.yml
+run bashly generate to create the bash script
++ bundle exec bashly generate
+creating user files in src
+created src/initialize.bash
+created src/download_command.bash
+created src/upload_command.bash
+created ./cli
+run ./cli --help to test your bash script
++ bundle exec bashly add colors
+created src/lib/colors.bash
++ bundle exec bashly add comp function
+created src/lib/send_completions.bash
+
+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)"
+
++ bundle exec bashly add config
+created src/lib/config.bash
++ bundle exec bashly add help
+created src/help_command.bash
+
+Add this as a command to your bashly.yml:
+
+  commands:
+    - name: help
+      help: Show help about a command
+      args:
+      - name: command
+        help: Help subject
+
+
++ bundle exec bashly add lib
+created src/lib/sample_function.bash
++ bundle exec bashly add validations
+created src/lib/validations/validate_dir_exists.bash
+created src/lib/validations/validate_file_exists.bash
+created src/lib/validations/validate_integer.bash
+created src/lib/validations/validate_not_empty.bash
++ bundle exec bashly add yaml
+created src/lib/yaml.bash
++ bundle exec bashly generate --upgrade
+creating user files in src
+skipped src/initialize.bash (exists)
+skipped src/download_command.bash (exists)
+skipped src/upload_command.bash (exists)
+updated src/help_command.bash
+updated src/lib/colors.bash
+updated src/lib/config.bash
+updated src/lib/send_completions.bash
+updated src/lib/validations/validate_dir_exists.bash
+updated src/lib/validations/validate_file_exists.bash
+updated src/lib/validations/validate_integer.bash
+updated src/lib/validations/validate_not_empty.bash
+updated src/lib/yaml.bash
+created ./cli
+run ./cli --help to test your bash script
++ ./cli
+cli - Sample application
+
+Usage:
+  cli COMMAND
+  cli [COMMAND] --help | -h
+  cli --version | -v
+
+Commands:
+  download   Download a file
+  upload     Upload a file
+
++ ./cli --help
+cli - Sample application
+
+Usage:
+  cli COMMAND
+  cli [COMMAND] --help | -h
+  cli --version | -v
+
+Commands:
+  download   Download a file
+  upload     Upload a file
+
+Options:
+  --help, -h
+    Show this help
+
+  --version, -v
+    Show version number
+
+Environment Variables:
+  API_KEY
+    Set your API key
+
++ ./cli download something
+# this file is located in 'src/download_command.bash'
+# code for 'cli download' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[source]} = something
diff --git a/spec/bashly/integration/examples_spec.rb b/spec/bashly/integration/examples_spec.rb
@@ -23,7 +23,7 @@
   test_cases.each do |example|
     approval_name = example.gsub 'spec/fixtures/workspaces', 'fixtures'
 
-    next if ENV['EXAMPLE'] and !example.include? ENV['EXAMPLE']
+    next if ENV['EXAMPLE'] && !example.include?(ENV['EXAMPLE'])
 
     describe example do
       it 'is executed properly' do
diff --git a/spec/fixtures/workspaces/partials_extension/.gitignore b/spec/fixtures/workspaces/partials_extension/.gitignore
@@ -0,0 +1,4 @@
+cli
+settings.yml
+src
+test
diff --git a/spec/fixtures/workspaces/partials_extension/README.md b/spec/fixtures/workspaces/partials_extension/README.md
@@ -0,0 +1,2 @@
+This fixture tests that changing the setting partials_extension to bash
+applies the desired extension to all generated files.
diff --git a/spec/fixtures/workspaces/partials_extension/test.sh b/spec/fixtures/workspaces/partials_extension/test.sh
@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+
+# This fixture tests that changing the setting partials_extension to bash
+# applies the desired extension to all generated files.
+
+rm -rf ./src
+
+set -x
+
+# Make it so
+export BASHLY_PARTIALS_EXTENSION=bash
+
+# Generate the initial script
+bundle exec bashly init
+bundle exec bashly generate
+
+# Add all libraries known to mankind (those that generate .sh files)
+bundle exec bashly add colors
+bundle exec bashly add comp function
+bundle exec bashly add config
+bundle exec bashly add help
+bundle exec bashly add lib
+bundle exec bashly add validations
+bundle exec bashly add yaml
+
+# Verify upgrading works
+bundle exec bashly generate --upgrade
+
+# Finally, verify the script actually works
+./cli
+./cli --help
+./cli download something

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ class CompletionsFunction < Base`
`4`	`4`	`def files`
`5`	`5`	`[`
`6`	`6`	`{`
`7`		`- path: "#{Settings.full_lib_dir}/#{function_name}.sh",`
	`7`	`+ path: "#{Settings.full_lib_dir}/#{function_name}.#{Settings.partials_extension}",`
`8`	`8`	`content: completions_function_code(function_name),`
`9`	`9`	`},`
`10`	`10`	`]`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ class Help < Base`
`6`	`6`	`def files`
`7`	`7`	`[`
`8`	`8`	`{`
`9`		`- path: "#{Settings.source_dir}/help_command.sh",`
	`9`	`+ path: "#{Settings.source_dir}/help_command.#{Settings.partials_extension}",`
`10`	`10`	`content: help_command,`
`11`	`11`	`},`
`12`	`12`	`]`
Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,7 @@ def target_file_args`
`63`	`63`	`user_source_dir: Settings.source_dir,`
`64`	`64`	`user_target_dir: Settings.target_dir,`
`65`	`65`	`user_lib_dir: Settings.full_lib_dir,`
	`66`	`+ user_ext: Settings.partials_extension,`
`66`	`67`	`}`
`67`	`68`	`end`
`68`	`69`	`end`