- Add generate --wrap FUNCTION_NAME option to generate sourcing-friendly output

DannyBen · DannyBen · commit e7843623054b · 2021-02-20T12:09:44.000Z
diff --git a/examples/command-default/ftp b/examples/command-default/ftp
@@ -2,6 +2,7 @@
 # This script was generated by bashly (https://github.com/DannyBen/bashly)
 # Modifying it manually is not recommended
 
+
 # :command.version_command
 version_command() {
   echo "$version"
diff --git a/examples/command-groups/ftp b/examples/command-groups/ftp
@@ -2,6 +2,7 @@
 # This script was generated by bashly (https://github.com/DannyBen/bashly)
 # Modifying it manually is not recommended
 
+
 # :command.version_command
 version_command() {
   echo "$version"
diff --git a/examples/commands-nested/cli b/examples/commands-nested/cli
@@ -2,6 +2,7 @@
 # This script was generated by bashly (https://github.com/DannyBen/bashly)
 # Modifying it manually is not recommended
 
+
 # :command.version_command
 version_command() {
   echo "$version"
diff --git a/examples/commands/cli b/examples/commands/cli
@@ -2,6 +2,7 @@
 # This script was generated by bashly (https://github.com/DannyBen/bashly)
 # Modifying it manually is not recommended
 
+
 # :command.version_command
 version_command() {
   echo "$version"
diff --git a/examples/config-ini/configly b/examples/config-ini/configly
@@ -2,6 +2,7 @@
 # This script was generated by bashly (https://github.com/DannyBen/bashly)
 # Modifying it manually is not recommended
 
+
 # :command.version_command
 version_command() {
   echo "$version"
diff --git a/examples/dependencies/cli b/examples/dependencies/cli
@@ -2,6 +2,7 @@
 # This script was generated by bashly (https://github.com/DannyBen/bashly)
 # Modifying it manually is not recommended
 
+
 # :command.version_command
 version_command() {
   echo "$version"
diff --git a/examples/docker-like/docker b/examples/docker-like/docker
@@ -2,6 +2,7 @@
 # This script was generated by bashly (https://github.com/DannyBen/bashly)
 # Modifying it manually is not recommended
 
+
 # :command.version_command
 version_command() {
   echo "$version"
diff --git a/examples/environment-variables/cli b/examples/environment-variables/cli
@@ -2,6 +2,7 @@
 # This script was generated by bashly (https://github.com/DannyBen/bashly)
 # Modifying it manually is not recommended
 
+
 # :command.version_command
 version_command() {
   echo "$version"
diff --git a/examples/git-like/git b/examples/git-like/git
@@ -2,6 +2,7 @@
 # This script was generated by bashly (https://github.com/DannyBen/bashly)
 # Modifying it manually is not recommended
 
+
 # :command.version_command
 version_command() {
   echo "$version"
diff --git a/examples/multiline/multi b/examples/multiline/multi
@@ -2,6 +2,7 @@
 # This script was generated by bashly (https://github.com/DannyBen/bashly)
 # Modifying it manually is not recommended
 
+
 # :command.version_command
 version_command() {
   echo "$version"
diff --git a/lib/bashly/commands/generate.rb b/lib/bashly/commands/generate.rb
@@ -3,14 +3,18 @@ module Commands
     class Generate < Base
       help "Generate the bash script and required files"
 
-      usage "bashly generate [--force]"
+      usage "bashly generate [--force --wrap FUNCTION]"
       usage "bashly generate (-h|--help)"
 
       option "-f --force", "Overwrite existing files"
+      option "-w --wrap FUNCTION", "Wrap the entire script in a function so it can also be sourced"
 
       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: .]"
 
+      example "bashly generate --force"
+      example "bashly generate --wrap my_function"
+
       def run
         create_user_files
         create_master_script
@@ -54,12 +58,15 @@ def create_file(file, content)
       end
 
       def create_master_script
-        master_script = command.render('master_script').lint
-        File.write master_script_path, master_script
+        File.write master_script_path, script.code
         FileUtils.chmod "+x", master_script_path
         say "created !txtgrn!#{master_script_path}"
       end
 
+      def script
+        @script ||= Models::Script.new(command, args['--wrap'])
+      end
+
       def master_script_path
         "#{Settings.target_dir}/#{command.name}"
       end
diff --git a/lib/bashly/commands/preview.rb b/lib/bashly/commands/preview.rb
@@ -11,7 +11,8 @@ class Preview < Base
       def run
         config = Config.new "#{Settings.source_dir}/bashly.yml"
         command = Models::Command.new(config)
-        puts command.render 'master_script'
+        script = Models::Script.new command
+        puts script.code
       end
     end
   end
diff --git a/lib/bashly/models/script.rb b/lib/bashly/models/script.rb
@@ -0,0 +1,31 @@
+module Bashly
+  module Models
+    class Script
+      include Renderable
+
+      attr_reader :command, :function_name
+
+      def initialize(command, function_name = nil)
+        @command, @function_name = command, function_name
+      end
+
+      def code
+        if function_name
+          [header, render('wrapper').lint].join "\n"
+        else
+          [header, body].join "\n"
+        end
+      end
+
+    private
+
+      def header
+        @header ||= render('header')
+      end
+
+      def body
+        @body ||= command.render('master_script').lint
+      end
+    end
+  end
+end
diff --git a/lib/bashly/views/command/master_script.erb b/lib/bashly/views/command/master_script.erb
@@ -1,7 +1,3 @@
-#!/usr/bin/env bash
-# This script was generated by bashly (https://github.com/DannyBen/bashly)
-# Modifying it manually is not recommended
-
 <%= render :root_command if commands.empty? %>
 <%= render :version_command %>
 <%= render :usage %>
diff --git a/lib/bashly/views/script/header.erb b/lib/bashly/views/script/header.erb
@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+# This script was generated by bashly (https://github.com/DannyBen/bashly)
+# Modifying it manually is not recommended
diff --git a/lib/bashly/views/script/wrapper.erb b/lib/bashly/views/script/wrapper.erb
@@ -0,0 +1,6 @@
+# :script.wrapper
+<%= function_name %>() {
+<%= body.indent 2 %>
+}
+
+(return 0 2>/dev/null) || <%= function_name %> "$@"
diff --git a/out.txt b/out.txt
@@ -0,0 +1,201 @@
+#!/usr/bin/env bash
+# This script was generated by bashly (https://github.com/DannyBen/bashly)
+# Modifying it manually is not recommended
+
+# :command.root_command
+root_command() {
+  # :spec/tmp/src/root_command.sh
+  echo "error: cannot load file"
+}
+
+# :command.version_command
+version_command() {
+  echo "$version"
+}
+
+# :command.usage
+get_usage() {
+  if [[ -n $long_usage ]]; then
+    printf "get\n"
+    echo 
+    printf "  get something from somewhere\n  this is the second line\n"
+    echo 
+  else
+    printf "get - get something from somewhere\n"
+    echo 
+  fi
+
+  printf "Shortcut: g\n"
+  echo
+
+  printf "Usage:\n"
+  printf "  get SOURCE [TARGET] [options]\n"
+  printf "  get --help | -h\n"
+  printf "  get --version | -v\n"
+  echo
+
+  if [[ -n $long_usage ]]; then
+    printf "Options:\n"
+    # :command.usage_fixed_flags
+    echo "  --help, -h"
+    printf "    Show this help\n"
+    echo
+    echo "  --version, -v"
+    printf "    Show version number\n"
+    echo
+    # :command.usage_flags
+    # :flag.usage
+    echo "  --force (required)"
+    printf "\n"
+    echo
+    
+    # :flag.usage
+    echo "  --verbose"
+    printf "\n"
+    echo
+    # :command.usage_args
+    printf "Arguments:\n"
+    
+    # :argument.usage
+    echo "  SOURCE"
+    printf "\n"
+    echo
+    
+    # :argument.usage
+    echo "  TARGET"
+    printf "\n"
+    echo
+    # :command.usage_environment_variables
+    printf "Environment Variables:\n"
+    
+    # :environment_variable.usage
+    echo "  SECRET_KEY (required)"
+    printf "\n"
+    echo
+    
+    # :environment_variable.usage
+    echo "  TARGET_FOLDER"
+    printf "\n"
+    echo
+
+  fi
+}
+
+# :command.inspect_args
+inspect_args() {
+  readarray -t sorted_keys < <(printf '%s\n' "${!args[@]}" | sort)
+  if (( ${#args[@]} )); then
+    echo args:
+    for k in "${sorted_keys[@]}"; do echo "- \${args[$k]} = ${args[$k]}"; done
+  else
+    echo args: none
+  fi
+}
+
+# :command.command_functions
+
+# :command.parse_requirements
+parse_requirements() {
+  # :command.fixed_flag_filter
+  case "$1" in
+  --version | -v )
+    version_command
+    exit
+    ;;
+  
+  --help | -h )
+    long_usage=yes
+    get_usage
+    exit 1
+    ;;
+  
+  esac
+  # :command.environment_variables_filter
+  if [[ -z "$SECRET_KEY" ]]; then
+    printf "missing required environment variable: SECRET_KEY\n"
+    exit 1
+  fi
+  # :command.dependencies_filter
+  # :command.command_filter
+  action="root"
+  # :command.required_args_filter
+  if [[ $1 && $1 != -* ]]; then
+    args[source]=$1
+    shift
+  else
+    printf "missing required argument: SOURCE\nusage: get SOURCE [TARGET] [options]\n"
+    exit 1
+  fi
+  # :command.required_flags_filter
+  argstring="$*"
+  if [[ "$argstring" != *--force* ]]; then
+    printf "missing required flag: --force\n"
+    exit 1
+  fi
+  # :command.parse_requirements_while
+  while [[ $# -gt 0 ]]; do
+    key="$1"
+    case "$key" in
+    # :flag.case
+    --force )
+      args[--force]=1
+      shift
+      ;;
+  
+    # :flag.case
+    --verbose )
+      args[--verbose]=1
+      shift
+      ;;
+  
+  
+    -* )
+      printf "invalid option: %s\n" "$key"
+      exit 1
+      ;;
+  
+    * )
+      # :command.parse_requirements_case
+      if [[ ! ${args[source]} ]]; then
+        args[source]=$1
+        shift
+      elif [[ ! ${args[target]} ]]; then
+        args[target]=$1
+        shift
+      else
+        printf "invalid argument: %s\n" "$key"
+        exit 1
+      fi
+      ;;
+  
+    esac
+  done
+  # :command.default_assignments
+}
+
+# :command.initialize
+initialize() {
+  version=""
+  long_usage=''
+  set -e  
+
+  # :spec/tmp/src/initialize.sh
+}
+
+# :command.run
+run() {
+  declare -A args
+  parse_requirements "$@"
+
+  if [[ ${args[--version]} ]]; then
+    version_command
+  elif [[ ${args[--help]} ]]; then
+    long_usage=yes
+    get_usage
+  elif [[ $action == "root" ]]; then
+    root_command
+  fi
+}
+
+initialize
+run "$@"
diff --git a/spec/approvals/cli/generate/help b/spec/approvals/cli/generate/help
diff --git a/spec/approvals/cli/generate/wrap-function b/spec/approvals/cli/generate/wrap-function
diff --git a/spec/bashly/commands/generate_spec.rb b/spec/bashly/commands/generate_spec.rb
diff --git a/spec/bashly/models/script_spec.rb b/spec/bashly/models/script_spec.rb
