bashly 1.2.0 → 1.2.2

data/lib/bashly/script/introspection/commands.rb

@@ -0,0 +1,111 @@
+module Bashly
+  module Script
+    module Introspection
+      module Commands
+        # 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 = {}
+
+          commands.each do |command|
+            result[command.group_string] ||= {}
+            result[command.group_string][command.name] = {
+              summary:    command.summary_string,
+              visibility: command.visibility,
+            }
+            next unless command.expose
+
+            command.commands.each do |subcommand|
+              result[command.group_string]["#{command.name} #{subcommand.name}"] = {
+                summary:    subcommand.summary_string,
+                visibility: subcommand.visibility,
+                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|
+            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 children + grandchildren (recursive), and may include self
+        def deep_commands(include_self: false)
+          result = []
+          result << self if include_self
+          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(&:default)
+        end
+
+        # Returns subcommands by group
+        def grouped_commands
+          result = {}
+
+          visible_commands.each do |command|
+            result[command.group_string] ||= []
+            result[command.group_string] << command
+            next unless command.expose
+
+            command.visible_commands.each do |subcommand|
+              result[command.group_string] << subcommand
+            end
+          end
+
+          result
+        end
+
+        # Returns only commands that are not private
+        def public_commands
+          commands.reject(&:private)
+        end
+
+        # Returns a full list of the public Command names and aliases combined
+        def public_command_aliases
+          public_commands.map(&:aliases).flatten
+        end
+
+        # Returns only public commands, or both public and private commands
+        # if Settings.private_reveal_key is set
+        def visible_commands
+          Settings.private_reveal_key ? commands : public_commands
+        end
+
+        # Returns a full list of the visible Command names and aliases combined
+        def visible_command_aliases
+          visible_commands.map(&:aliases).flatten
+        end
+      end
+    end
+  end
+end

data/lib/bashly/script/introspection/dependencies.rb

@@ -0,0 +1,16 @@
+module Bashly
+  module Script
+    module Introspection
+      module Dependencies
+        # Returns an array of Dependency objects
+        def dependencies
+          return [] unless options['dependencies']
+
+          @dependencies ||= options['dependencies'].map do |key, value|
+            Dependency.from_config key, value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bashly/script/introspection/environment_variables.rb

@@ -0,0 +1,47 @@
+module Bashly
+  module Script
+    module Introspection
+      module EnvironmentVariables
+        # Returns an array of all the Environment Variables with default values
+        def default_environment_variables
+          environment_variables.select(&:default)
+        end
+
+        # Returns an array of EnvironmentVariable objects
+        def environment_variables
+          return [] unless options['environment_variables']
+
+          options['environment_variables'].map do |options|
+            EnvironmentVariable.new options
+          end
+        end
+
+        # Returns only environment variables that are not private
+        def public_environment_variables
+          environment_variables.reject(&:private)
+        end
+
+        # Returns an array of all the required EnvironmentVariables
+        def required_environment_variables
+          environment_variables.select(&:required)
+        end
+
+        # Returns an array of all the environment_variables with a validation
+        def validated_environment_variables
+          environment_variables.select(&:validate)
+        end
+
+        # Returns only public environment variables, or both public and private
+        # environment variables if Settings.private_reveal_key is set
+        def visible_environment_variables
+          Settings.private_reveal_key ? environment_variables : public_environment_variables
+        end
+
+        # Returns an array of all the environment_variables with a whitelist arg
+        def whitelisted_environment_variables
+          environment_variables.select(&:allowed)
+        end
+      end
+    end
+  end
+end

data/lib/bashly/script/introspection/examples.rb

@@ -0,0 +1,14 @@
+module Bashly
+  module Script
+    module Introspection
+      module Examples
+        # Returns an array of examples
+        def examples
+          return nil unless options['examples']
+
+          options['examples'].is_a?(Array) ? options['examples'] : [options['examples']]
+        end
+      end
+    end
+  end
+end

data/lib/bashly/script/introspection/flags.rb

@@ -0,0 +1,58 @@
+module Bashly
+  module Script
+    module Introspection
+      module Flags
+        # Returns an array of all the default Flags
+        def default_flags
+          flags.select(&:default)
+        end
+
+        # Returns an array of Flags
+        def flags
+          return [] unless options['flags']
+
+          options['flags'].map do |options|
+            Flag.new options
+          end
+        end
+
+        # Returns true if this command's flags should be considered as gloal
+        # flags, and cascade to subcommands
+        def global_flags?
+          flags.any? and commands.any?
+        end
+
+        # Returns an array of all fpags that need other flags
+        def needy_flags
+          flags.select(&:needs)
+        end
+
+        # Returns only flags that are not private
+        def public_flags
+          flags.reject(&:private)
+        end
+
+        # Returns an array of all the required Flags
+        def required_flags
+          flags.select(&:required)
+        end
+
+        # Returns true if one of the flags matches the provided short code
+        def short_flag_exist?(flag)
+          flags.any? { |f| f.short == flag }
+        end
+
+        # Returns only public flags, or both public and private flags if
+        # Settings.private_reveal_key is set
+        def visible_flags
+          Settings.private_reveal_key ? flags : public_flags
+        end
+
+        # Returns an array of all the flags with a whitelist arg
+        def whitelisted_flags
+          flags.select(&:allowed)
+        end
+      end
+    end
+  end
+end

data/lib/bashly/script/introspection/visibility.rb

@@ -0,0 +1,19 @@
+module Bashly
+  module Script
+    module Introspection
+      module Visibility
+        # Returns :public, :private, or :semi_private based on the `private`
+        # option of the host, in conjunction with `Settings.private_reveal_key`.
+        def visibility
+          if !options['private']
+            :public
+          elsif Settings.private_reveal_key
+            :semi_private
+          else
+            :private
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bashly/settings.rb

@@ -10,6 +10,7 @@ module Bashly
         :config_path,
         :lib_dir,
         :partials_extension,
+        :private_reveal_key,
         :show_examples_on_error,
         :source_dir,
         :strict,
@@ -54,6 +55,10 @@ module Bashly
         @partials_extension ||= get :partials_extension
       end
 
+      def private_reveal_key
+        @private_reveal_key ||= get :private_reveal_key
+      end
+
       def production?
         env == :production
       end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.2.0'
+  VERSION = '1.2.2'
 end

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

@@ -4,14 +4,14 @@
 > printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
 
 if allowed
-  > printf "    {{ strings[:allowed] % { values: allowed.join(', ') } }}\n"
+  > printf "    %s\n" "{{ strings[:allowed] % { values: allowed.join(', ') } }}"
 end
 
 if default
   if default.is_a? Array
-    > printf "    {{ strings[:default] % { value: default.join(', ') } }}\n"
+    > printf "    %s\n" "{{ strings[:default] % { value: default.join(', ') } }}"
   else
-    > printf "    {{ strings[:default] % { value: default } }}\n"
+    > printf "    %s\n" "{{ strings[:default] % { value: default } }}"
   end
 end
 

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

@@ -3,6 +3,7 @@ if validate
 
   if repeatable
     > if [[ -v args['{{ name }}'] ]]; then
+    >   values=''
     >   eval "values=(${args['{{ name }}']})"
     >   for value in "${values[@]}"; do
     >     if [[ -n $(validate_{{ validate }} "$value") ]]; then

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

@@ -4,7 +4,9 @@ if commands.any?
   > action=${1:-}
   > 
   > case $action in
-  >   -*) ;;
+  unless default_command
+    >   -*) ;;
+  end
   > 
 
   commands.each do |command|

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

@@ -24,3 +24,9 @@ if whitelisted_environment_variables.any?
     > fi
   end
 end
+
+if validated_environment_variables.any?
+  validated_environment_variables.each do |env_var|
+    = env_var.render(:validations)
+  end
+end

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

@@ -1,13 +1,17 @@
 = view_marker
 
-> if [[ -n $long_usage ]]; then
-options_caption = public_commands.any? && public_flags.any? ? strings[:global_options] : strings[:options]
+> if [[ -n "$long_usage" ]]; then
+options_caption = strings[:options]
+if commands.any? && (public_flags.any? || (flags.any? && Settings.private_reveal_key))
+  options_caption = strings[:global_options]
+end
+
 >   printf "%s\n" "{{ options_caption.color(:caption) }}"
 >
-= render(:usage_flags).indent 2 if public_flags.any?
+= render(:usage_flags).indent 2 if flags.any?
 = render(:usage_fixed_flags).indent 2
 = render(:usage_args).indent 2 if args.any? or catch_all.help
-= render(:usage_environment_variables).indent 2 if public_environment_variables.any?
+= render(:usage_environment_variables).indent 2 if environment_variables.any?
 = render(:usage_examples).indent 2 if examples
 = render(:footer).indent 2 if footer
 >

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

@@ -0,0 +1,9 @@
+if needy_flags.any?
+  = view_marker
+
+  needy_flags.each do |flag|
+    = flag.render(:needs)
+  end
+
+  >
+end

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

@@ -1,7 +1,11 @@
 = view_marker
 
 > normalize_input() {
->   local arg flags passthru
+if Settings.compact_short_flags
+>   local arg passthru flags
+else
+>   local arg passthru
+end
 >   passthru=false
 > 
 >   while [[ $# -gt 0 ]]; do

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

@@ -13,6 +13,7 @@ end
 = render(:parse_requirements_while).indent 2
 = render(:required_args_filter).indent 2
 = render(:required_flags_filter).indent 2
+= render(:needy_flags_filter).indent 2
 = render(:catch_all_filter).indent 2
 = render(:default_assignments).indent 2
 = render(:validations).indent 2

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

@@ -6,11 +6,18 @@ command_help_data.each do |group, commands|
   > printf "%s\n" "{{ group.color(:caption) }}"
 
   commands.each do |command, info|
+    next if info[:visibility] == :private
+
+    line = %Q[printf "  %s   #{info[:summary].sanitize_for_print}\\n" "#{command.ljust(maxlen).color(:command)}"]
     if info[:help_only]
-      > [[ -n $long_usage ]] && printf "  %s   {{ info[:summary].sanitize_for_print }}\n" "{{ command.ljust(maxlen).color(:command) }}"
-    else
-      > printf "  %s   {{ info[:summary].sanitize_for_print }}\n" "{{ command.ljust(maxlen).color(:command) }}"
+      line = %Q[[[ -n "$long_usage" ]] && #{line}]
+    end
+
+    if info[:visibility] == :semi_private
+      line = %Q[[[ -n "${#{Settings.private_reveal_key}:-}" ]] && #{line}]
     end
+
+    = line
   end
 
   > echo

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

@@ -1,10 +1,26 @@
 = view_marker
 
-> printf "%s\n" "{{ strings[:environment_variables].color(:caption) }}"
-> 
+caption = %Q[printf "%s\\n" "#{strings[:environment_variables].color(:caption)}"]
+if public_environment_variables.any?
+  = caption
+  > 
+elsif environment_variables.any? && Settings.private_reveal_key
+  > if [[ -n "${{{ Settings.private_reveal_key }}:-}" ]]; then
+    = caption.indent(2)
+  > fi
+  > 
+end
+
+environment_variables.each do |env_var|
+  next if env_var.visibility == :private
 
-public_environment_variables.each do |env_var|
-  = env_var.render :usage
+  if env_var.visibility == :semi_private
+    > if [[ -n "${{{ Settings.private_reveal_key }}:-}" ]]; then
+      = env_var.render(:usage).indent(2)
+    > fi
+  else
+    = env_var.render :usage
+  end
 end
 
 >

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

@@ -1,7 +1,15 @@
 = view_marker
 
-public_flags.each do |flag|
-  = flag.render :usage
+flags.each do |flag|
+  next if flag.visibility == :private
+
+  if flag.visibility == :semi_private
+    > if [[ -n "${{{ Settings.private_reveal_key }}:-}" ]]; then
+      = flag.render(:usage).indent(2)
+    > fi
+  else
+    = flag.render :usage
+  end
 end
 
 >

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

@@ -3,6 +3,7 @@ if whitelisted_args.any? or whitelisted_flags.any?
 
   whitelisted_args.each do |arg|
     if arg.repeatable
+      > input_array=''
       > eval "input_array=(${args[{{ arg.name }}]})"
       > for i in "${input_array[@]}"; do
       >   if [[ ! $i =~ ^({{ arg.allowed.join '|' }})$ ]]; then
@@ -22,6 +23,7 @@ if whitelisted_args.any? or whitelisted_flags.any?
 
   whitelisted_flags.each do |flag|
     if flag.repeatable
+      > input_array=''
       > eval "input_array=(${args[{{ flag.name }}]})"
       > for i in "${input_array[@]}"; do
       >   if [[ ! $i =~ ^({{ flag.allowed.join '|' }})$ ]]; then

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

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

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

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

data/lib/bashly/views/flag/needs.gtx

@@ -0,0 +1,22 @@
+if needs
+
+  = view_marker
+
+  if needs.count == 1
+    > if [[ -n ${args['{{ name }}']+x} ]] && [[ -z "${args[{{ needs.first }}]:-}" ]]; then
+    >   printf "%s\n" "{{ strings[:flag_needs_another] % { name: name, need: needs.first } }}" >&2
+    >   exit 1
+    > fi
+    >
+  else
+    > if [[ -n ${args['{{ name }}']+x} ]]; then
+    >   for need in {{ needs.join ' ' }}; do
+    >     if [[ -z "${args[$need]:-}" ]]; then
+    >       printf "%s\n" "{{ strings[:flag_needs_another] % { name: name, need: "$need" } }}" >&2
+    >       exit 1
+    >     fi
+    >   done
+    > fi
+    >
+  end
+end

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

@@ -4,16 +4,24 @@
 > printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
 
 if allowed
-  > printf "    {{ strings[:allowed] % { values: allowed.join(', ') } }}\n"
+  > printf "    %s\n" "{{ strings[:allowed] % { values: allowed.join(', ') } }}"
 end
 
 if default
   if default.is_a? Array
-    > printf "    {{ strings[:default] % { value: default.join(', ') } }}\n"
+    > printf "    %s\n" "{{ strings[:default] % { value: default.join(', ') } }}"
   else
-    > printf "    {{ strings[:default] % { value: default } }}\n"
+    > printf "    %s\n" "{{ strings[:default] % { value: default } }}"
   end
 end
 
+if needs
+  > printf "    %s\n" "{{ strings[:needs] % { values: needs.join(', ') } }}"
+end
+
+if conflicts
+  > printf "    %s\n" "{{ strings[:conflicts] % { values: conflicts.join(', ') } }}"
+end
+
 > echo
 > 

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

@@ -3,6 +3,7 @@ if validate
 
   if repeatable
     > if [[ -v args['{{ long }}'] ]]; then
+    >   values=''
     >   eval "values=(${args['{{ long }}']})"
     >   for value in "${values[@]}"; do
     >     if [[ -n $(validate_{{ validate }} "$value") ]]; then

data/lib/bashly.rb

@@ -3,53 +3,40 @@ if ENV['DEBUGGER']
   require 'lp'
 end
 
-require 'bashly/extensions/array'
-require 'bashly/extensions/file'
-require 'bashly/extensions/string'
-require 'bashly/extensions/yaml'
-require 'bashly/exceptions'
+require 'requires'
+requires 'bashly/extensions'
+requires 'bashly/exceptions'
 
 module Bashly
-  autoload :CLI, 'bashly/cli'
-  autoload :Config, 'bashly/config'
-  autoload :ConfigValidator, 'bashly/config_validator'
-  autoload :Library, 'bashly/library'
-  autoload :LibrarySource, 'bashly/library_source'
-  autoload :LibrarySourceConfig, 'bashly/library_source_config'
-  autoload :MessageStrings, 'bashly/message_strings'
-  autoload :RenderContext, 'bashly/render_context'
-  autoload :RenderSource, 'bashly/render_source'
-  autoload :VERSION, 'bashly/version'
-
-  autoload :AssetHelper, 'bashly/concerns/asset_helper'
-  autoload :Completions, 'bashly/concerns/completions'
-  autoload :ComposeRefinements, 'bashly/refinements/compose_refinements'
-  autoload :Renderable, 'bashly/concerns/renderable'
-  autoload :Settings, 'bashly/settings'
-  autoload :ValidationHelpers, 'bashly/concerns/validation_helpers'
+  autoloads 'bashly/refinements', %i[ComposeRefinements]
+
+  autoloads 'bashly', %i[
+    CLI Config ConfigValidator Library LibrarySource LibrarySourceConfig
+    MessageStrings RenderContext RenderSource Settings VERSION
+  ]
+
+  autoloads 'bashly/concerns', %i[
+    AssetHelper Completions Renderable ValidationHelpers
+  ]
 
   module Script
-    autoload :Argument, 'bashly/script/argument'
-    autoload :Base, 'bashly/script/base'
-    autoload :CatchAll, 'bashly/script/catch_all'
-    autoload :Command, 'bashly/script/command'
-    autoload :Dependency, 'bashly/script/dependency'
-    autoload :EnvironmentVariable, 'bashly/script/environment_variable'
-    autoload :Flag, 'bashly/script/flag'
-    autoload :Wrapper, 'bashly/script/wrapper'
+    autoloads 'bashly/script', %i[
+      Argument Base CatchAll Command Dependency EnvironmentVariable Flag
+      Wrapper
+    ]
+
+    module Introspection
+      autoloads 'bashly/script/introspection', %i[
+        Arguments Commands Dependencies EnvironmentVariables Examples Flags
+        Visibility
+      ]
+    end
   end
 
   module Commands
-    autoload :Add, 'bashly/commands/add'
-    autoload :Base, 'bashly/commands/base'
-    autoload :Completions, 'bashly/commands/completions'
-    autoload :Doc, 'bashly/commands/doc'
-    autoload :Generate, 'bashly/commands/generate'
-    autoload :Init, 'bashly/commands/init'
-    autoload :Preview, 'bashly/commands/preview'
-    autoload :Render, 'bashly/commands/render'
-    autoload :Shell, 'bashly/commands/shell'
-    autoload :Validate, 'bashly/commands/validate'
+    autoloads 'bashly/commands', %i[
+      Add Base Completions Doc Generate Init Preview Render Shell Validate
+    ]
   end
 
   module Libraries