bashly 0.8.0 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3d0126229189987753e653a635054113961b1e9e0244d4cdb956beb1d5aff94
-  data.tar.gz: 886987a65edc65d16d2134589cbb4ee9f3fcb9e0b1819c8a87211bcd2d164d0c
+  metadata.gz: f3cd1ba341eabd9f1c3acead91ff8c56878db7eb07f3ef6e8f29ceb057cbce04
+  data.tar.gz: 9c8fdd62e401cf1d693d76163e61d93779fcbda67406e301f06d9be554ccbe96
 SHA512:
-  metadata.gz: 880579e8bb650c8835cc7992054f3f4dd3e765ddc1b7072f83ed6fc9049d4b56b38c4a64220c3dd154f8fdbf199462cca1ef955d36d465a0d57ecc00715bd85e
-  data.tar.gz: efa2f73f9eed6d5ba1ebb432e37ef639e618bc1556ba83059ccad4804b6568b407d86f91fe11faa3335b69103e368fdb9bf1339f90af1fd15cb742b91163b911
+  metadata.gz: e690eda52685f2b34ae5773b79b48ede2972d8e328dcc193c90d4a60b22a768ccaa1444e52652f0b11513cced19a02eff295ac011ca414d254d4d9e3b8aacf4a
+  data.tar.gz: 5b7bf250ea4cdc8d194dee285a6a61748e5d649b455d1b3836a35df1c511b6781d84ac966903a445bd84bcb471604e15c016bbd88f643afe7f030c8df65e6563

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/completions.rb

@@ -1,51 +1,76 @@
 require 'completely'
 
 module Bashly
-  # This is a `Command` concern responsible for providing bash completion data
+  # This is a `Command` and `Flag` concern responsible for providing bash
+  # completion data
   module Completions
-    def completion_data(with_version: true)
-      result = { full_name => completion_words(with_version: with_version) }
-      
-      commands.each do |command|
-        result.merge! command.completion_data(with_version: false)
-      end
+    module Flag
+      def completion_data(command_full_name)
+        result = {}
+        comps = allowed || completions
 
-      result
-    end
+        if comps
+          aliases.each do |name|
+            result["#{command_full_name}*#{name}"] = comps
+          end
+        end
 
-    def completion_script
-      completion_generator.script
+        result
+      end
     end
 
-    def completion_function(name = nil)
-      completion_generator.wrapper_function(name)
-    end
+    module Command
+      def completion_data(with_version: true)
+        result = {}
 
-  private
+        all_full_names.each do |name|
+          result[name] = completion_words(with_version: with_version)
+          flags.each do |flag|
+            result.merge! flag.completion_data(name)
+          end
+        end
+        
+        commands.each do |command|
+          result.merge! command.completion_data(with_version: false)
+        end
 
-    def completion_generator
-      Completely::Completions.new(completion_data)
-    end
+        result
+      end
 
-    def completion_flag_names
-      flags.map(&:name) + flags.map(&:short)
-    end
+      def completion_script
+        completion_generator.script
+      end
 
-    def completion_allowed_args
-      flags.map(&:allowed).flatten + args.map(&:allowed).flatten
-    end
+      def completion_function(name = nil)
+        completion_generator.wrapper_function(name)
+      end
 
-    def completion_words(with_version: false)
-      trivial_flags = %w[--help -h]
-      trivial_flags += %w[--version -v] if with_version
-      all = (
-        command_names + trivial_flags +
-        completion_flag_names + completion_allowed_args
-      )
+    private
 
-      all += completions if completions
-      all.compact.uniq.sort
-    end
+      def completion_generator
+        Completely::Completions.new(completion_data)
+      end
+
+      def completion_flag_names
+        flags.map(&:name) + flags.map(&:short)
+      end
+
+      def completion_allowed_args
+        args.map(&:allowed).flatten
+      end
+
+      def completion_words(with_version: false)
+        trivial_flags = %w[--help -h]
+        trivial_flags += %w[--version -v] if with_version
+        all = (
+          command_aliases + trivial_flags + 
+          completion_flag_names + completion_allowed_args
+        )
 
+        all += completions if completions
+        all.compact.uniq.sort
+      end
+
+    end
   end
-end
+end

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/concerns/validation_helpers.rb

@@ -52,10 +52,16 @@ module Bashly
       end
     end
 
-    def assert_uniq(key, value, array_key)
+    def assert_uniq(key, value, array_keys)
       return unless value
-      list = value.map { |c| c[array_key] }.compact.flatten
-      assert list.uniq?, "#{key} cannot have elements with similar #{array_key} values"
+      array_keys = [array_keys] unless array_keys.is_a? Array
+      list = []
+      array_keys.each do |array_key|
+        list += value.map { |c| c[array_key] }.compact.flatten
+      end
+
+      nonuniqs = list.nonuniq
+      assert nonuniqs.empty?, "#{key} contains non-unique elements (#{nonuniqs.join ', '}) in #{array_keys.join ' or '}"
     end
 
     def assert_string_or_array(key, value)

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']
@@ -61,6 +66,8 @@ module Bashly
       assert_hash key, value, Script::Flag.option_keys
       assert value['short'] || value['long'], "#{key} must have at least one of long or short name"
 
+      refute value['allowed'] && value['completions'], "#{key} cannot have both allowed and completions"
+
       assert_optional_string "#{key}.long", value['long']
       assert_optional_string "#{key}.short", value['short']
       assert_optional_string "#{key}.help", value['help']
@@ -72,6 +79,7 @@ module Bashly
       assert_boolean "#{key}.required", value['required']
       assert_array "#{key}.allowed", value['allowed'], of: :string
       assert_array "#{key}.conflicts", value['conflicts'], of: :string
+      assert_array "#{key}.completions", value['completions'], of: :string
 
       assert value['long'].match(/^--[a-zA-Z0-9_\-]+$/), "#{key}.long must be in the form of '--name'" if value['long']
       assert value['short'].match(/^-[a-zA-Z0-9]$/), "#{key}.short must be in the form of '-n'" if value['short']
@@ -86,6 +94,10 @@ module Bashly
       if value['allowed']
         assert value['arg'], "#{key}.allowed does not make sense without arg"
       end
+
+      if value['completions']
+        assert value['arg'], "#{key}.completions does not make sense without arg"
+      end
     end
 
     def assert_env_var(key, value)
@@ -110,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']
@@ -124,8 +137,7 @@ module Bashly
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
       assert_array "#{key}.examples", value['examples'], of: :string
 
-      assert_uniq "#{key}.commands", value['commands'], 'name'
-      assert_uniq "#{key}.commands", value['commands'], 'alias'
+      assert_uniq "#{key}.commands", value['commands'], ['name', 'alias']
       assert_uniq "#{key}.flags", value['flags'], 'long'
       assert_uniq "#{key}.flags", value['flags'], 'short'
       assert_uniq "#{key}.args", value['args'], 'name'
@@ -135,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/array.rb

@@ -5,8 +5,8 @@ class Array
     map { |line| "#{indentation}#{line}" }
   end
 
-  def uniq?
-    self == uniq
+  def nonuniq
+    tally.select { |key, count| count > 1 }.keys
   end
 
 end

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

@@ -1,15 +1,14 @@
 module Bashly
   module Script
     class Command < Base
-      include Completions
-      include CommandScopes
+      include Completions::Command
 
       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,15 +69,81 @@ 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]
-          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
       def environment_variables
         return [] unless options["environment_variables"]
@@ -99,27 +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 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
@@ -127,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?
@@ -137,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]
@@ -156,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/script/flag.rb

@@ -1,11 +1,13 @@
 module Bashly
   module Script
     class Flag < Base
+      include Completions::Flag
+
       class << self
         def option_keys
           @option_keys ||= %i[
-            allowed arg conflicts default help long repeatable required
-            short validate
+            allowed arg completions conflicts default help long repeatable
+            required short validate
           ]
         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.0"
+  VERSION = "0.8.3"
 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