bashly 0.8.1 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4be359964fc41fae59f83eae85c594a4e0edec41e0cc5752fec25850b7b7ca43
-  data.tar.gz: 62023932e59ae5b9856a9617f9148a7e28bfab5bca5cebca98d3fefbf401ae21
+  metadata.gz: 5bec052fd6ce0ffa90e32f48c5899a6f9ff7807750ffbe126b61b8cbd72a6210
+  data.tar.gz: 69d88a7b5a307ea324156a53f379b78d27b4b376dbe3fb3763307f4fd34ab7c3
 SHA512:
-  metadata.gz: a0e222c6ead53cfef4597653d9ce51b6e9fffd1a3556acd72eff5447b9a203371a0097cd42f4058405cd473e7f0c55f4f9a448d45d3b1af73898b74a79706df4
-  data.tar.gz: 8362eff89fccaad8c9a1f370270e33426d0089bbe131eec4fc55f586413afaa556caa81e62389daefb400941122db96fa1f8b4e04d3780a4d45ea88060dfdc1e
+  metadata.gz: cba455f059a94e300ad787e1a9ed69455160f915302033217350101e5d57e53c3f64c91192f942d6e18ad1995e1317082dcd46bf715b8f0ac7401080d409cc54
+  data.tar.gz: 48ce5d30512a9aa8ba0401c66cb1619f1f4926bcc041e0309a19543a5a99395f098b3c6d1bad0adfdf9076560e438f26849214ca3c33dbe24158beb34badd0ca

data/lib/bashly/commands/generate.rb

@@ -1,3 +1,5 @@
+require 'filewatcher'
+
 module Bashly
   module Commands
     class Generate < Base
@@ -9,7 +11,8 @@ module Bashly
       option "-f --force", "Overwrite existing files"
       option "-q --quiet", "Disable on-screen progress report"
       option "-u --upgrade", "Upgrade all added library functions"
-      option "-w --wrap FUNCTION", "Wrap the entire script in a function so it can also be sourced"
+      option "-w --watch", "Watch the source directory for changes and regenerate on change"
+      option "-r --wrap FUNCTION", "Wrap the entire script in a function so it can also be sourced"
       option "-e --env ENV", "Force the generation environment (see BASHLY_ENV)"
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
@@ -27,17 +30,50 @@ module Bashly
 
       example "bashly generate --force"
       example "bashly generate --wrap my_function"
+      example "bashly g -uw"
+
+      attr_reader :watching
 
       def run
+        Settings.env = args['--env'] if args['--env']
+        @watching = args['--watch']
+
+        generate
+        watch if watching
+      end
+
+    private
+
+      def watch
+        quiet_say "!txtgrn!watching!txtrst! #{Settings.source_dir}\n"
+
+        Filewatcher.new([Settings.source_dir]).watch do
+          reset
+          generate
+
+        rescue Bashly::ConfigurationError => e
+          say! "!undred!#{e.class}!txtrst!\n#{e.message}"
+
+        ensure
+          quiet_say "!txtgrn!waiting\n"
+        
+        end
+      end
+
+      def generate
         with_valid_config do
-          Settings.env = args['--env'] if args['--env']
           quiet_say "creating !txtgrn!production!txtrst! version" if Settings.production?
           generate_all_files
-          quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script"
+          quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script" unless watching
         end
       end
 
-    private
+      def reset
+        @config = nil
+        @config_validator = nil
+        @command = nil
+        @script = nil
+      end
 
       def quiet_say(message)
         say message unless args['--quiet']

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
@@ -18,10 +15,26 @@ module Bashly
       "# #{id}" unless Settings.production?
     end
 
+    # Reads a file from the userspace (Settings.source_dir) and returns
+    # its contents. If the file is not found, returns a string with a hint.
+    def load_user_file(file, placeholder: true)
+      path = "#{Settings.source_dir}/#{file}"
+
+      content = if File.exist? path
+        File.read(path).remove_front_matter
+      elsif placeholder
+        %q[echo "error: cannot load file"]
+      else
+        ''
+      end
+
+      Settings.production? ? content : "#{view_marker path}\n#{content}"
+    end
+
   private
 
     def view_path(view)
-      "#{self_views_path}/#{view}.erb"
+      "#{self_views_path}/#{view}.gtx"
     end
 
     def self_views_path

data/lib/bashly/config_validator.rb

@@ -41,6 +41,11 @@ module Bashly
         "#{key} must be a boolean or a string" 
     end
 
+    def assert_expose(key, value)
+      return unless value
+      assert [true, false, nil, 'always'].include?(value), "#{key} must be a boolean, or the string 'always'" 
+    end
+
     def assert_arg(key, value)
       assert_hash key, value, Script::Argument.option_keys
       assert_string "#{key}.name", value['name']
@@ -117,6 +122,7 @@ module Bashly
 
       assert_boolean "#{key}.private", value['private']
       assert_boolean "#{key}.default", value['default']
+      assert_expose "#{key}.expose", value['expose']
       assert_version "#{key}.version", value['version']
       assert_catch_all "#{key}.catch_all", value['catch_all']
       assert_string_or_array "#{key}.alias", value['alias']
@@ -141,11 +147,16 @@ module Bashly
         refute repeatable_arg, "#{key}.catch_all makes no sense with repeatable arg (#{repeatable_arg})"
       end
 
+      if value['expose']
+        assert value['commands'], "#{key}.expose makes no sense without commands"
+      end
+
       if key == "root"
         refute value['alias'], "#{key}.alias makes no sense"
         refute value['group'], "#{key}.group makes no sense"
         refute value['default'], "#{key}.default makes no sense"
         refute value['private'], "#{key}.private makes no sense"
+        refute value['expose'], "#{key}.expose makes no sense"
       else
         refute value['version'], "#{key}.version makes no sense"
         refute value['extensible'], "#{key}.extensible makes no sense"

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/script/command.rb

@@ -2,14 +2,13 @@ module Bashly
   module Script
     class Command < Base
       include Completions::Command
-      include CommandScopes
 
       class << self
         def option_keys
           @option_keys ||= %i[
             alias args catch_all commands completions
             default dependencies environment_variables examples
-            extensible filename filters flags
+            extensible expose filename filters flags
             footer group help name
             private version
             short
@@ -18,6 +17,9 @@ module Bashly
         end
       end
 
+      attr_accessor :parent_command
+      attr_writer :parents
+
       # Returns the name to be used as an action.
       # - If it is the root command, the action is "root"
       # - Else, it is all the parents, except the first one (root) joined
@@ -32,6 +34,16 @@ module Bashly
         [name] + alt
       end
 
+      # Returns an array of all full names (including aliases and aliases of
+      # parents)
+      def all_full_names
+        if parent_command
+          parent_command.all_full_names.product(aliases).map { |a| a.join ' ' }
+        else
+          aliases
+        end
+      end
+
       # Returns an array of alternative aliases if any
       def alt
         # DEPRECATION 0.8.0
@@ -57,14 +69,79 @@ module Bashly
         @catch_all ||= CatchAll.from_config options['catch_all']
       end
 
+      # Returns a full list of the Command names and aliases combined
+      def command_aliases
+        commands.map(&:aliases).flatten
+      end
+
+      # Returns a data structure for displaying subcommands help
+      def command_help_data
+        result = {}
+
+        public_commands.each do |command|
+          result[command.group_string] ||= {}
+          result[command.group_string][command.name] = { summary: command.summary_string }
+          next unless command.expose
+
+          command.public_commands.each do |subcommand|
+            result[command.group_string]["#{command.name} #{subcommand.name}"] = {
+              summary: subcommand.summary_string,
+              help_only: command.expose != 'always'
+            }
+          end
+        end
+
+        result
+      end
+
+      # Returns only the names of the Commands
+      def command_names
+        commands.map &:name
+      end
+
       # Returns an array of the Commands
       def commands
         return [] unless options["commands"]
         options["commands"].map do |options|
-          options['parents'] = parents + [name]
-          options['parent_command'] = self
-          Command.new options
+          result = Command.new options
+          result.parents = parents + [name]
+          result.parent_command = self
+          result
+        end
+      end
+
+      # Returns a flat array containing all the commands in this tree.
+      # This includes self + children + grandchildres + ...
+      def deep_commands
+        result = []
+        commands.each do |command|
+          result << command
+          if command.commands.any?
+            result += command.deep_commands
+          end
         end
+        result
+      end
+
+      # If any of this command's subcommands has the default option set to
+      # true, this default command will be returned, nil otherwise.
+      def default_command
+        commands.find { |c| c.default }
+      end
+
+      # Returns an array of all the default Args
+      def default_args
+        args.select &:default
+      end
+
+      # Returns an array of all the default Environment Variables
+      def default_environment_variables
+        environment_variables.select &:default
+      end
+
+      # Returns an array of all the default Flags
+      def default_flags
+        flags.select &:default
       end
 
       # Returns an array of EnvironmentVariables
@@ -100,32 +177,24 @@ module Bashly
         parents.any? ? (parents + [name]).join(' ') : name
       end
 
-      # Reads a file from the userspace (Settings.source_dir) and returns
-      # its contents. 
-      # If the file is not found, returns a string with a hint.
-      def load_user_file(file, placeholder: true)
-        path = "#{Settings.source_dir}/#{file}"
-
-        content = if File.exist? path
-          File.read(path).remove_front_matter
-        elsif placeholder
-          %q[echo "error: cannot load file"]
+      # Returns the string for the group caption
+      def group_string
+        if group
+          strings[:group] % { group: group } 
         else
-          ''
+          strings[:commands]
         end
-
-        Settings.production? ? content : "#{view_marker path}\n#{content}"
-      end
-
-      # Returns the Command instance of the direct parent
-      def parent_command
-        options['parent_command']
       end
 
       # Returns an array of all parents. For example, the command 
       # "docker container run" will have [docker, container] as its parents
       def parents
-        options['parents'] || []
+        @parents ||= []
+      end
+
+      # Returns only commands that are not private
+      def public_commands
+        commands.reject &:private
       end
 
       # Returns true if one of the args is repeatable
@@ -133,6 +202,21 @@ module Bashly
         args.select(&:repeatable).any?
       end
 
+      # Returns an array of all the required Arguments
+      def required_args
+        args.select &:required
+      end
+
+      # Returns an array of all the required EnvironmentVariables
+      def required_environment_variables
+        environment_variables.select &:required
+      end
+
+      # Returns an array of all the required Flags
+      def required_flags
+        flags.select &:required
+      end
+
       # Returns true if this is the root command (no parents)
       def root_command?
         parents.empty?
@@ -143,6 +227,15 @@ module Bashly
         flags.select { |f| f.short == flag }.any?
       end
 
+      # Returns the summary string
+      def summary_string
+        if default
+          strings[:default_command_summary] % { summary: summary }
+        else
+          summary
+        end
+      end
+
       # Returns a constructed string suitable for Usage pattern
       def usage_string
         result = [full_name]
@@ -162,6 +255,15 @@ module Bashly
         @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.sh"].sort
       end
 
+      # Returns an array of all the args with a whitelist
+      def whitelisted_args
+        args.select &:allowed
+      end
+
+      # Returns an array of all the flags with a whitelist arg
+      def whitelisted_flags
+        flags.select &:allowed
+      end
     end
   end
 end

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.1"
+  VERSION = "0.8.4"
 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
+
+> }
+>