bashly 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4be359964fc41fae59f83eae85c594a4e0edec41e0cc5752fec25850b7b7ca43
-  data.tar.gz: 62023932e59ae5b9856a9617f9148a7e28bfab5bca5cebca98d3fefbf401ae21
+  metadata.gz: bc4a83c90c751c1df692c55db4f7335619c927cb86a30de4fcb7eef5115710a1
+  data.tar.gz: 343ede4e31e7a0833b6335a9690c9ecbe060da1983d829cfbdf197bbfe5dc640
 SHA512:
-  metadata.gz: a0e222c6ead53cfef4597653d9ce51b6e9fffd1a3556acd72eff5447b9a203371a0097cd42f4058405cd473e7f0c55f4f9a448d45d3b1af73898b74a79706df4
-  data.tar.gz: 8362eff89fccaad8c9a1f370270e33426d0089bbe131eec4fc55f586413afaa556caa81e62389daefb400941122db96fa1f8b4e04d3780a4d45ea88060dfdc1e
+  metadata.gz: 3b5873adb5c173a4676ae071f6d83b11975053addd8b39e50613375032d441b227d6f27c4ad860719bdf22e37f7ce8882217e5c622c607dcff048fe7dfdaab18
+  data.tar.gz: c01a6a3c20aee19338c3cddfbac0254d7316c5b9aa8f2423bbd6ba65746b439e1ce7e3eec2f2654087c3a6b55388fdeca645dfe786e4adcac97997f1a0f778e4

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

@@ -18,6 +18,22 @@ 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)

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

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

data/lib/bashly/views/command/usage_commands.erb

@@ -1,18 +1,13 @@
 <%= view_marker %>
-% unless commands.first.group
-printf "<%= strings[:commands] %>\n"
-% end
-% maxlen = command_names.map(&:size).max
-% commands.reject(&:private).each do |command|
-% summary = command.summary
-% summary = strings[:default_command_summary] % { summary: summary } if command.default
-% if command.group
-% if command.name == commands.first.name
-printf "<%= strings[:group] % { group: command.group } %>\n"
+% maxlen = command_help_data.values.map(&:keys).flatten.map(&:size).max
+% command_help_data.each do |group, commands|
+printf "<%= group %>\n"
+% commands.each do |command, info|
+% if info[:help_only]
+[[ -n $long_usage ]] && echo "  <%= command.ljust maxlen %>   <%= info[:summary] %>"
 % else
-printf "\n<%= strings[:group] % { group: command.group } %>\n"
-% end
+echo "  <%= command.ljust maxlen %>   <%= info[:summary] %>"
 % end
-echo "  <%= command.name.ljust maxlen %>   <%= summary %>"
 % end
 echo
+% end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-22 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: mister_bin
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: Generate bash command line tools using YAML configuration
 email: db@dannyben.com
 executables:
@@ -84,7 +98,6 @@ files:
 - lib/bashly/commands/preview.rb
 - lib/bashly/commands/validate.rb
 - lib/bashly/concerns/asset_helper.rb
-- lib/bashly/concerns/command_scopes.rb
 - lib/bashly/concerns/completions.rb
 - lib/bashly/concerns/renderable.rb
 - lib/bashly/concerns/validation_helpers.rb
@@ -200,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator

data/lib/bashly/concerns/command_scopes.rb

@@ -1,83 +0,0 @@
-module Bashly
-  # This is a `Command` concern responsible for providing additional scopes.
-  module CommandScopes
-    # 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 a full list of the Command names and aliases combined
-    def command_aliases
-      commands.map(&:aliases).flatten
-    end
-
-    # Returns only the names of the Commands
-    def command_names
-      commands.map &:name
-    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 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 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