bashly 0.8.2 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc4a83c90c751c1df692c55db4f7335619c927cb86a30de4fcb7eef5115710a1
-  data.tar.gz: 343ede4e31e7a0833b6335a9690c9ecbe060da1983d829cfbdf197bbfe5dc640
+  metadata.gz: 47591327725b9e1265c7c4b7a38d7992a939ee47956e3a1ff1bb764edd0da282
+  data.tar.gz: 3911b50fe1c23add51a538f0ed7b078b7ce23df5a6959f0f1dbe4451ebec3e39
 SHA512:
-  metadata.gz: 3b5873adb5c173a4676ae071f6d83b11975053addd8b39e50613375032d441b227d6f27c4ad860719bdf22e37f7ce8882217e5c622c607dcff048fe7dfdaab18
-  data.tar.gz: c01a6a3c20aee19338c3cddfbac0254d7316c5b9aa8f2423bbd6ba65746b439e1ce7e3eec2f2654087c3a6b55388fdeca645dfe786e4adcac97997f1a0f778e4
+  metadata.gz: f1aab1a02d6648e28ba7274350b68a2a1e6fd5719939f0c5e340604637573ef3069f4800719ec6c1923d18b2c9e602f2366d5bc54ca12330dc962526ae2dbb71
+  data.tar.gz: 577f8eed84b30bd7fdbdb864f97487cc9ed22b8e8f768b43a8b61091511e56dbeeac9b10d0030dbaac54e06bcb6fdcdd1b5c2d4207f8c68c28923f2f382c8e27

data/lib/bashly/concerns/renderable.rb

@@ -1,12 +1,9 @@
-require 'erb'
+require 'gtx'
 
 module Bashly
   module Renderable
     def render(view)
-      template = File.read view_path(view)
-      erb = ERB.new(template, trim_mode: '%-')
-      erb.filename = "#{views_subfolder}.#{view}"
-      erb.result binding
+      GTX.render_file view_path(view), context: binding, filename: "#{views_subfolder}.#{view}"
     end
 
     def strings
@@ -37,7 +34,7 @@ module Bashly
   private
 
     def view_path(view)
-      "#{self_views_path}/#{view}.erb"
+      "#{self_views_path}/#{view}.gtx"
     end
 
     def self_views_path

data/lib/bashly/extensions/string.rb

@@ -5,7 +5,7 @@ class String
 
   def indent(offset)
     return self unless offset > 0
-    split("\n").indent(offset).join("\n")
+    lines.indent(offset).join
   end
 
   def to_underscore
@@ -24,7 +24,7 @@ class String
   end
 
   def lint
-    gsub(/\s+\n/m, "\n\n").lines.reject { |l| l =~ /^\s*##/ }.join ""
+    gsub(/\s+\n/m, "\n\n").lines.reject { |l| l =~ /^\s*##/ }.join
   end
 
   def remove_front_matter

data/lib/bashly/templates/strings.yml

@@ -26,6 +26,7 @@ version_flag_text: Show version number
 flag_requires_an_argument: "%{name} requires an argument: %{usage}"
 invalid_argument: "invalid argument: %s"
 invalid_flag: "invalid option: %s"
+invalid_command: "invalid command: %s"
 conflicting_flags: "conflicting options: %s cannot be used with %s"
 missing_required_argument: "missing required argument: %{arg}\\nusage: %{usage}"
 missing_required_flag: "missing required flag: %{usage}"

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.8.2"
+  VERSION = "0.8.5"
 end

data/lib/bashly/views/README.md

@@ -0,0 +1,6 @@
+# View Tempaltes
+
+These are [GTX](https://github.com/dannyben/gtx) templates.
+
+For syntax highlighting, set up your editor to treat `*.gtx` files as Ruby
+source code.

data/lib/bashly/views/argument/usage.gtx

@@ -0,0 +1,15 @@
+= view_marker
+
+> echo "  {{ label }}"
+> printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
+
+if allowed
+  > printf "    {{ strings[:allowed] % { values: allowed.join(', ') } }}\n"
+end
+
+if default
+  > printf "    {{ strings[:default] % { value: default } }}\n"
+end
+
+> echo
+> 

data/lib/bashly/views/argument/validations.gtx

@@ -0,0 +1,11 @@
+if validate
+
+= view_marker
+
+> if [[ -n $(validate_{{ validate }} "$1") ]]; then
+>   printf "{{ strings[:validation_error] }}\n" "{{ name.upcase }}" "$(validate_{{ validate }} "$1")"
+>   exit 1
+> fi
+> 
+
+end

data/lib/bashly/views/command/catch_all_filter.gtx

@@ -0,0 +1,10 @@
+if catch_all.required?
+  = view_marker
+
+  > if [[ ${#other_args[@]} -eq 0 ]]; then
+  >   printf "{{ strings[:missing_required_argument] % { arg: catch_all.label, usage: usage_string } }}\n"
+  >   exit 1
+  > fi
+  >
+
+end

data/lib/bashly/views/command/command_fallback.gtx

@@ -0,0 +1,42 @@
+= view_marker
+
+> "" )
+>   {{ function_name }}_usage
+>   exit 1
+>   ;;
+>
+> * )
+
+if default_command
+  >   action="{{ default_command.name }}"
+  >   {{ default_command.function_name }}_parse_requirements "$@"
+  >   shift $#
+  >   ;;
+  >
+
+elsif extensible.is_a? String
+  >   if [[ -x "$(command -v "{{ extensible }}")" ]]; then
+  >     exec {{ extensible }} "$@"
+  >   else
+  >     printf "{{ strings[:invalid_command] }}\n" "$action"
+  >     exit 1
+  >   fi
+  >
+
+elsif extensible
+  >   if [[ -x "$(command -v "{{ function_name }}-$action")" ]]; then
+  >     shift
+  >     exec "{{ function_name }}-$action" "$@"
+  >   else
+  >     printf "{{ strings[:invalid_command] }}\n" "$action"
+  >     exit 1
+  >   fi
+  >
+
+else
+  >   printf "{{ strings[:invalid_command] }}\n" "$action"
+  >   exit 1
+  >   ;;
+  >
+
+end

data/lib/bashly/views/command/command_filter.gtx

@@ -0,0 +1,29 @@
+= view_marker
+
+if commands.any?
+  > action=${1:-}
+  > 
+  > case $action in
+  > -* )
+  >   ;;
+  > 
+
+  commands.each do |command|
+    > {{ command.aliases.join " | " }} )
+    >   action="{{ command.name }}"
+    >   shift
+    >   {{ command.function_name }}_parse_requirements "$@"
+    >   shift $#
+    >   ;;    
+    > 
+
+  end
+
+  = render :command_fallback
+  > esac
+  >
+
+else
+  > action="{{ action_name }}"
+
+end

data/lib/bashly/views/command/command_functions.gtx

@@ -0,0 +1,5 @@
+= view_marker
+
+deep_commands.each do |command|
+  = command.render :function unless command.commands.any?
+end

data/lib/bashly/views/command/default_assignments.gtx

@@ -0,0 +1,13 @@
+if default_args.any? or default_flags.any?
+  = view_marker
+
+  default_args.each do |arg|
+    > [[ -n ${args[{{ arg.name }}]:-} ]] || args[{{ arg.name }}]="{{ arg.default }}"
+  end
+
+  default_flags.each do |flag|
+    > [[ -n ${args[{{ flag.long }}]:-} ]] || args[{{ flag.long }}]="{{ flag.default }}"
+  end
+
+  >
+end

data/lib/bashly/views/command/default_initialize_script.gtx

@@ -0,0 +1,7 @@
+> ## 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.
+>

data/lib/bashly/views/command/default_root_script.gtx

@@ -0,0 +1,4 @@
+> echo "# this file is located in '{{ "#{Settings.source_dir}/#{filename}" }}'"
+> echo "# you can edit it freely and regenerate (it will not be overwritten)"
+> inspect_args
+>

data/lib/bashly/views/command/default_script.gtx

@@ -0,0 +1,5 @@
+> echo "# this file is located in '{{ "#{Settings.source_dir}/#{filename}" }}'"
+> echo "# code for '{{ full_name }}' goes here"
+> echo "# you can edit it freely and regenerate (it will not be overwritten)"
+> inspect_args
+>

data/lib/bashly/views/command/dependencies_filter.gtx

@@ -0,0 +1,10 @@
+if dependencies
+  = view_marker
+
+  dependencies.each do |dependency|
+    > if ! [[ -x "$(command -v {{ dependency }})" ]]; then
+    >   printf "{{ strings[:missing_dependency] % { dependency: dependency } }}\n"
+    >   exit 1
+    > fi
+  end
+end

data/lib/bashly/views/command/environment_variables_filter.gtx

@@ -0,0 +1,18 @@
+if default_environment_variables.any? or required_environment_variables.any?
+  = view_marker 
+
+  if default_environment_variables.any?
+    default_environment_variables.each do |env_var|
+      > export {{ env_var.name.upcase }}="${<%= env_var.name.upcase %>:-<%= env_var.default %>}"
+    end
+  end
+
+  if required_environment_variables.any?
+    required_environment_variables.each do |env_var|
+      > if [[ -z "${<%= env_var.name.upcase %>:-}" ]]; then
+      >   printf "{{ strings[:missing_required_environment_variable] % { var: env_var.name.upcase } }}\n"
+      >   exit 1
+      > fi
+    end
+  end
+end

data/lib/bashly/views/command/fixed_flags_filter.gtx

@@ -0,0 +1,20 @@
+= view_marker
+
+> case "${1:-}" in
+
+if root_command?
+  = short_flag_exist?("-v") ? "--version )" : "--version | -v )"
+  >   version_command
+  >   exit
+  >   ;;
+  > 
+end
+
+= short_flag_exist?("-h") ? "--help )" : "--help | -h )"
+>   long_usage=yes
+>   <%= function_name %>_usage
+>   exit
+>   ;;
+> 
+> esac
+>

data/lib/bashly/views/command/footer.gtx

@@ -0,0 +1,5 @@
+= view_marker
+
+> printf "{{ footer.gsub("\n", '\n').gsub('"', '\"') }}\n"
+> echo
+>

data/lib/bashly/views/command/function.gtx

@@ -0,0 +1,6 @@
+= view_marker
+
+> {{ function_name }}_command() {
+= load_user_file(filename).indent 2
+> }
+>

data/lib/bashly/views/command/initialize.gtx

@@ -0,0 +1,12 @@
+= view_marker
+
+> initialize() {
+>   version="<%= version %>"
+>   long_usage=''
+>   {{ Settings.strict ? "set -euo pipefail" : "set -e" }}
+> 
+
+= load_user_file("initialize.sh", placeholder: false).indent 2
+
+> }
+>

data/lib/bashly/views/command/inspect_args.gtx

@@ -0,0 +1,21 @@
+= view_marker
+
+> 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
+> 
+>   if (( ${#other_args[@]} )); then
+>     echo
+>     echo other_args:
+>     echo "- \${other_args[*]} = ${other_args[*]}"
+>     for i in "${!other_args[@]}"; do
+>       echo "- \${other_args[$i]} = ${other_args[$i]}"
+>     done
+>   fi
+> }
+> 

data/lib/bashly/views/command/long_usage.gtx

@@ -0,0 +1,13 @@
+= view_marker
+
+> if [[ -n $long_usage ]]; then
+>   printf "{{ strings[:options] }}\n"
+>
+= render(:usage_fixed_flags).indent 2
+= render(:usage_flags).indent 2 if flags.any?
+= render(:usage_args).indent 2 if args.any? or catch_all.help
+= render(:usage_environment_variables).indent 2 if environment_variables.any?
+= render(:usage_examples).indent 2 if examples
+= render(:footer).indent 2 if footer
+>
+> fi

data/lib/bashly/views/command/master_script.gtx

@@ -0,0 +1,17 @@
+= view_marker
+
+= render :root_command if commands.empty?
+= render :version_command
+= render :usage
+= render :normalize_input
+= render :inspect_args
+= render :user_lib if user_lib.any?
+= render :command_functions
+= render :parse_requirements
+= render :initialize
+= render :run
+
+> 
+> initialize
+> run "$@"
+> 

data/lib/bashly/views/command/normalize_input.gtx

@@ -0,0 +1,25 @@
+= view_marker
+
+> normalize_input() {
+>   local arg flags
+> 
+>   while [[ $# -gt 0 ]]; do
+>     arg="$1"
+>     if [[ $arg =~ ^(--[a-zA-Z0-9_\-]+)=(.+)$ ]]; then
+>       input+=("${BASH_REMATCH[1]}")
+>       input+=("${BASH_REMATCH[2]}")
+>     elif [[ $arg =~ ^(-[a-zA-Z0-9])=(.+)$ ]]; then
+>       input+=("${BASH_REMATCH[1]}")
+>       input+=("${BASH_REMATCH[2]}")
+>     elif [[ $arg =~ ^-([a-zA-Z0-9][a-zA-Z0-9]+)$ ]]; then
+>       flags="${BASH_REMATCH[1]}"
+>       for (( i=0 ; i < ${#flags} ; i++ )); do
+>         input+=("-${flags:i:1}")
+>       done
+>     else
+>       input+=("$arg")
+>     fi
+> 
+>     shift
+>   done
+> }

data/lib/bashly/views/command/parse_requirements.gtx

@@ -0,0 +1,26 @@
+= view_marker
+
+if root_command?
+  > parse_requirements() {
+else
+  > {{ function_name }}_parse_requirements() {
+end
+
+= render(:fixed_flags_filter).indent 2
+= render(:environment_variables_filter).indent 2
+= render(:dependencies_filter).indent 2
+= render(:command_filter).indent 2
+= render(:parse_requirements_while).indent 2
+= render(:required_args_filter).indent 2
+= render(:required_flags_filter).indent 2
+= render(:catch_all_filter).indent 2
+= render(:default_assignments).indent 2
+= render(:whitelist_filter).indent 2
+= render(:user_filter).indent 2
+
+> }
+> 
+
+commands.each do |command|
+  = command.render :parse_requirements
+end

data/lib/bashly/views/command/parse_requirements_case.gtx

@@ -0,0 +1,11 @@
+= view_marker
+
+if catch_all.enabled?
+  = render :parse_requirements_case_catch_all
+elsif repeatable_arg_exist?
+  = render :parse_requirements_case_repeatable
+else
+  = render :parse_requirements_case_simple
+end
+
+>

data/lib/bashly/views/command/parse_requirements_case_catch_all.gtx

@@ -0,0 +1,23 @@
+= view_marker
+
+if args.any?
+  condition = "if"
+  args.each do |arg|
+    > {{ condition }} [[ -z ${args[{{ arg.name }}]+x} ]]; then
+    =   arg.render(:validations).indent 2
+    >   args[{{ arg.name }}]=$1
+    >   shift
+    
+    condition = "elif"
+  end
+
+  > else
+  >   other_args+=("$1")
+  >   shift
+  > fi
+
+else
+  > other_args+=("$1")
+  > shift
+
+end

data/lib/bashly/views/command/parse_requirements_case_repeatable.gtx

@@ -0,0 +1,24 @@
+= view_marker
+
+condition = "if"
+args.each do |arg|
+  > {{ condition }} [[ -z ${args[{{ arg.name }}]+x} ]]; then
+  = arg.render(:validations).indent 2
+
+  if arg.repeatable
+    >   args[{{ arg.name }}]="\"$1\""
+    >   shift
+    > else
+    >   args[{{ arg.name }}]="${args[{{ arg.name }}]} \"$1\""
+    >   shift
+
+  else
+    >   args[{{ arg.name }}]=$1
+    >   shift
+
+  end
+  condition = "elif"
+end
+
+> fi
+> 

data/lib/bashly/views/command/parse_requirements_case_simple.gtx

@@ -0,0 +1,25 @@
+= view_marker
+
+if args.any?
+  condition = "if"
+  args.each do |arg|
+    > {{ condition }} [[ -z ${args[{{ arg.name }}]+x} ]]; then
+    > {{ arg.render(:validations).indent 2 }}
+    >   args[{{ arg.name }}]=$1
+    >   shift
+
+    condition = "elif"
+  end
+
+  > else
+  >   printf "{{ strings[:invalid_argument] }}\n" "$key"
+  >   exit 1
+  > fi
+
+else
+  > printf "{{ strings[:invalid_argument] }}\n" "$key"
+  > exit 1
+
+end
+
+>

data/lib/bashly/views/command/parse_requirements_while.gtx

@@ -0,0 +1,33 @@
+= view_marker
+
+> while [[ $# -gt 0 ]]; do
+>   key="$1"
+>   case "$key" in
+
+flags.each do |flag|
+  = flag.render(:case).indent 2
+end
+
+>
+>   -?* )
+
+if catch_all.enabled?
+  >     other_args+=("$1")
+  >     shift
+  >     ;;
+
+else
+  >     printf "<%= strings[:invalid_flag] %>\n" "$key"
+  >     exit 1
+  >     ;;
+
+end
+
+> 
+>   * )
+= render(:parse_requirements_case).indent 4
+>     ;;
+> 
+>   esac
+> done
+

data/lib/bashly/views/command/required_args_filter.gtx

@@ -0,0 +1,13 @@
+if required_args.any?
+  = view_marker
+
+  required_args.each do |arg|
+    > if [[ -z ${args[{{ arg.name }}]+x} ]]; then
+    >   printf "{{ strings[:missing_required_argument] % { arg: arg.name.upcase, usage: usage_string } }}\n"
+    >   exit 1
+    > fi
+  end
+
+  >
+
+end

data/lib/bashly/views/command/required_flags_filter.gtx

@@ -0,0 +1,12 @@
+if required_flags.any?
+  = view_marker
+
+  required_flags.each do |flag|
+    > if [[ -z ${args[{{ flag.long }}]+x} ]]; then
+    >   printf "{{ strings[:missing_required_flag] % { usage: flag.usage_string } }}\n"
+    >   exit 1
+    > fi
+  end
+
+  >
+end

data/lib/bashly/views/command/root_command.gtx

@@ -0,0 +1,6 @@
+= view_marker
+
+> root_command() {
+= load_user_file(filename).indent 2
+> }
+> 

data/lib/bashly/views/command/run.gtx

@@ -0,0 +1,28 @@
+= view_marker
+
+> run() {
+>   declare -A args=()
+>   declare -a other_args=()
+>   declare -a input=()
+>   normalize_input "$@"
+>   parse_requirements "${input[@]}"
+> 
+
+condition = "if"
+deep_commands.each do |command|
+  >   {{ condition }} [[ $action == "{{ command.action_name }}" ]]; then
+  >     if [[ ${args[--help]:-} ]]; then
+  >       long_usage=yes
+  >       {{ command.function_name }}_usage
+  >     else
+  >       {{ command.function_name }}_command
+  >     fi
+  >
+    
+  condition = "elif"
+end
+
+>   {{ condition }} [[ $action == "root" ]]; then
+>     root_command
+>   fi
+> }

data/lib/bashly/views/command/usage.gtx

@@ -0,0 +1,50 @@
+= view_marker
+
+> {{ function_name }}_usage() {
+>   if [[ -n $long_usage ]]; then
+
+if summary == help
+  >     printf "{{ caption_string }}\n"
+  >     echo 
+else
+  >     printf "{{ full_name }}\n"
+  >     echo 
+  >     printf "{{ help.wrap(78).indent(2).sanitize_for_print }}\n"
+  >     echo 
+end
+
+>   else
+>     printf "{{ caption_string }}\n"
+>     echo 
+>   fi
+> 
+
+if alt&.any?
+  >   printf "{{ strings[:command_alias] % { alias: alt.join(', ') } }}\n"
+  >   echo
+end
+
+>
+>   printf "{{ strings[:usage] }}\n"
+>   printf "  {{ usage_string }}\n"
+
+if commands.any?
+  >   printf "  {{ full_name }} [command] --help{{ " | -h" unless short_flag_exist? "-h" }}\n"
+else
+  >   printf "  {{ full_name }} --help{{ " | -h" unless short_flag_exist? "-h" }}\n"
+end
+
+if root_command?
+  >   printf "  {{ full_name }} --version{{ " | -v" unless short_flag_exist? "-v" }}\n"
+end
+  >   echo
+
+= render(:usage_commands).indent 2 if commands.any?
+>
+= render(:long_usage).indent 2
+> }
+>
+
+commands.each do |command|
+  = command.render 'usage'
+end