bashly 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36c0868dbf2a0e4d5d2fecdc5854aac4e1bea8f7953a07712ccc985289c89b57
-  data.tar.gz: 63df3d720e1b36ce7ab658224fde796fb9460c92c7946bd867204c0e0caea304
+  metadata.gz: cde8d4a8294ffd7dee63567440b351ffbd67b69f1295306b20931b8f4328a77c
+  data.tar.gz: e99ca77abffd677b1469e145383ef74a90a28da29af88625d7bf378563909031
 SHA512:
-  metadata.gz: 39e367d86e8bf21ae076c35887157234e7d39d003f17a596aa4711a02a87c6b3856ac27b0f1c73c30837b2589358e479c069dba4cff657431fdca98f44116718
-  data.tar.gz: eceaabeafea2e93a9cf7c9d7c2f999a2303c0d9172ddd7799bb0d1f9eafe62166ee9512d8688ad9cc6547dd28e20b7c8925ca489cb2639fd3cd2456517461e7a
+  metadata.gz: 3f33a67b5da7958d3dccc0e8ada2f5fb097d786fd35045e8a8148ac543ec1326e0d1da51c2b264b674ba1f8ffb1c5dc868dc2244afccc5b8d93c7429b68797c1
+  data.tar.gz: 9972faa37b1f14b4dd38be6c0d15a743640f065357b7a347299f3255a8f50377a580e64b284631ae99cf8eb1207045ce08eb4c9e65860d67827a55be435219e3

data/lib/bashly/commands/shell.rb

@@ -19,7 +19,7 @@ module Bashly
           terminal = MisterBin::Terminal.new runner, {
             autocomplete: autocomplete,
             show_usage:   true,
-            prompt:       "$ bashly ",
+            prompt:       '$ bashly ',
           }
 
           terminal.on('help') { runner.run %w[--help] }

data/lib/bashly/concerns/completions.rb

@@ -29,7 +29,7 @@ module Bashly
           end
         end
 
-        public_commands.each do |command|
+        visible_commands.each do |command|
           result.merge! command.completion_data(with_version: false)
         end
 
@@ -62,7 +62,7 @@ module Bashly
       end
 
       def completion_flag_names
-        public_flags.map(&:name) + public_flags.map(&:short)
+        visible_flags.map(&:name) + visible_flags.map(&:short)
       end
 
       def completion_allowed_args
@@ -73,7 +73,7 @@ module Bashly
         trivial_flags = %w[--help -h]
         trivial_flags += %w[--version -v] if with_version
         all = (
-          public_command_aliases + trivial_flags +
+          visible_command_aliases + trivial_flags +
           completion_flag_names + completion_allowed_args
         )
 

data/lib/bashly/docs/env.yml

@@ -49,6 +49,16 @@ environment_variable.required:
   help: Specify that this variable is required.
   url: https://bashly.dannyb.co/configuration/environment-variable/#required
   example: |-
+    environment_variables:
     - name: api_key
       help: Your API key
       required: true
+
+environment_variable.validate:
+  help: Apply custom validation functions.
+
+  url: https://bashly.dannyb.co/configuration/environment-variable/#validate
+  example: |-
+    environment_variables:
+    - name: build_dir
+      validate: dir_exists

data/lib/bashly/docs/flag.yml

@@ -113,6 +113,29 @@ flag.long:
       short: -s
       help: Clone using SSH
 
+flag.needs:
+  help: Specify that this flag needs one or more additional flags. Use the long name of these needed flags.
+  url: https://bashly.dannyb.co/configuration/flag/#needs
+  example: |-
+    flags:
+    - long: --add
+      arg: alias
+
+      # When using --add, --command and --target must also be provided
+      needs: [--command, --target]
+
+    - long: --command
+      arg: command
+      help: Command for the alias
+      
+      # Note that this relationship is marked on both sides
+      needs: [--add]
+
+    - long: --target
+      arg: target
+      help: Where to add the alias
+      needs: [--add]
+
 flag.private:
   help: Specify that this flag should not be displayed in the help text.
   url: https://bashly.dannyb.co/configuration/flag/#private

data/lib/bashly/libraries/render/mandoc/mandoc.gtx

@@ -43,7 +43,7 @@ if extensible
 end
 >
 
-if public_commands.any?
+if visible_commands.any?
   grouped_commands.each do |group, commands|
     > {{ group.gsub(/:$/, '').upcase }}
     > ==================================================
@@ -127,6 +127,9 @@ if flags.any?
     if flag.conflicts
       > - Conflicts With: **{{ flag.conflicts.join(', ') }}**
     end
+    if flag.needs
+      > - Needs: **{{ flag.needs.join(', ') }}**
+    end
     >
   end
 end
@@ -147,11 +150,11 @@ if dependencies.any?
   end
 end
 
-if public_environment_variables.any?
+if visible_environment_variables.any?
   > ENVIRONMENT VARIABLES
   > ==================================================
   >
-  public_environment_variables.each do |environment_variable|
+  visible_environment_variables.each do |environment_variable|
     > {{ environment_variable.name.upcase }}
     > --------------------------------------------------
     >
@@ -183,7 +186,7 @@ end
 
 see_also = []
 see_also << parents.first if parents.any?
-see_also += public_commands.map { |x| x.full_name.to_hyphen } if public_commands.any?
+see_also += visible_commands.map { |x| x.full_name.to_hyphen } if visible_commands.any?
 see_also += x_mandoc_see_also if x_mandoc_see_also && x_mandoc_see_also.is_a?(Array)
 see_also.map! do |item|
   item.match(/(.+)(\(\d\))/) ? "**#{$1}**#{$2}" : "**#{item}**(1)"

data/lib/bashly/libraries/render/markdown/markdown.gtx

@@ -62,10 +62,10 @@ end
 
 # === Environment Variables
 
-if public_environment_variables.any?
+if visible_environment_variables.any?
   > ## Environment Variables
   >
-  public_environment_variables.each do |environment_variable|
+  visible_environment_variables.each do |environment_variable|
     attributes = environment_variable.required || environment_variable.default
 
     > #### *{{ environment_variable.name.upcase }}*
@@ -152,7 +152,8 @@ if flags.any?
   > ## Options
   >
   flags.each do |flag|
-    attributes = flag.required || flag.repeatable || flag.default || flag.allowed || flag.conflicts
+    attributes = flag.required || flag.repeatable || flag.default ||
+      flag.allowed || flag.conflicts || flag.needs
 
     > #### *{{ flag.usage_string }}*
     >
@@ -177,6 +178,9 @@ if flags.any?
       if flag.conflicts
         > | Conflicts With: | *{{ flag.conflicts.join(', ') }}*
       end
+      if flag.needs
+        > | Needs: | *{{ flag.needs.join(', ') }}*
+      end
       >
     end
   end

data/lib/bashly/libraries/settings/settings.yml

@@ -59,6 +59,11 @@ partials_extension: sh
 # required arguments
 show_examples_on_error: false
 
+# When using private commands, flags, or environment variables, you may set 
+# this option to a name of an environment variable that, if set, will reveal
+# all the private elements in the usage texts, as if they were public.
+private_reveal_key: ~
+
 # Display various usage elements in color by providing the name of the color
 # function. The value for each property is a name of a function that is
 # available in your script, for example: `green` or `bold`.

data/lib/bashly/libraries/strings/strings.yml

@@ -18,6 +18,8 @@ required: "(required)"
 repeatable: "(repeatable)"
 default: "Default: %{value}"
 allowed: "Allowed: %{values}"
+needs: "Needs: %{values}"
+conflicts: "Conflicts: %{values}"
 
 # Fixed flags help text
 help_flag_text: Show this help
@@ -25,6 +27,7 @@ version_flag_text: Show version number
 
 # Error messages
 flag_requires_an_argument: "%{name} requires an argument: %{usage}"
+flag_needs_another: "%{name} needs %{need}"
 invalid_argument: "invalid argument: %s"
 invalid_flag: "invalid option: %s"
 invalid_command: "invalid command: %s"
@@ -39,3 +42,4 @@ disallowed_argument: "%{name} must be one of: %{allowed}"
 disallowed_environment_variable: "%{name} environment variable must be one of: %{allowed}"
 unsupported_bash_version: "bash version 4 or higher is required"
 validation_error: "validation error in %s:\\n%s"
+environment_variable_validation_error: "validation error in environment variable %s:\\n%s"

data/lib/bashly/script/command.rb

@@ -2,6 +2,13 @@ module Bashly
   module Script
     class Command < Base
       include Completions::Command
+      include Introspection::Arguments
+      include Introspection::Commands
+      include Introspection::Dependencies
+      include Introspection::EnvironmentVariables
+      include Introspection::Examples
+      include Introspection::Flags
+      include Introspection::Visibility
 
       class << self
         def option_keys
@@ -39,15 +46,6 @@ module Bashly
         options['alias'].is_a?(String) ? [options['alias']] : options['alias']
       end
 
-      # Returns an array of Arguments
-      def args
-        return [] unless options['args']
-
-        options['args'].map do |options|
-          Argument.new options
-        end
-      end
-
       # Returns a string suitable to be a headline
       def caption_string
         help.empty? ? full_name : "#{full_name} - #{summary}"
@@ -58,123 +56,12 @@ 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|
-          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 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 Dependency objects
-      def dependencies
-        return [] unless options['dependencies']
-
-        @dependencies ||= options['dependencies'].map do |key, value|
-          Dependency.from_config key, value
-        end
-      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 an array of examples
-      def examples
-        return nil unless options['examples']
-
-        options['examples'].is_a?(Array) ? options['examples'] : [options['examples']]
-      end
-
       # Returns the filename that is expected to hold the user code for this
       # command
       def filename
         options['filename'] || implicit_filename
       end
 
-      # Returns an array of Flags
-      def flags
-        return [] unless options['flags']
-
-        options['flags'].map do |options|
-          Flag.new options
-        end
-      end
-
       # Returns a unique name, suitable to be used in a bash function
       def function_name
         options['function'] || full_name.to_underscore
@@ -186,12 +73,6 @@ module Bashly
         parents.any? ? (parents + [name]).join(' ') : name
       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 the string for the group caption
       def group_string
         if group
@@ -201,23 +82,6 @@ module Bashly
         end
       end
 
-      # Returns subcommands by group
-      def grouped_commands
-        result = {}
-
-        public_commands.each do |command|
-          result[command.group_string] ||= []
-          result[command.group_string] << command
-          next unless command.expose
-
-          command.public_commands.each do |subcommand|
-            result[command.group_string] << subcommand
-          end
-        end
-
-        result
-      end
-
       # Returns true if this command, or any subcommand (deep) as any arg or
       # flag with arg that is defined as unique
       def has_unique_args_or_flags?
@@ -246,56 +110,11 @@ module Bashly
         @parents ||= []
       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 environment variables that are not private
-      def public_environment_variables
-        environment_variables.reject(&:private)
-      end
-
-      # Returns only flags that are not private
-      def public_flags
-        flags.reject(&:private)
-      end
-
-      # Returns true if one of the args is repeatable
-      def repeatable_arg_exist?
-        args.any?(&:repeatable)
-      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?
       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 the summary string
       def summary_string
         if default
@@ -322,11 +141,8 @@ module Bashly
         result.compact.join ' '
       end
 
-      # Returns an array of args usage_string for the command's usage_string
-      def usage_string_args
-        args.map(&:usage_string)
-      end
-
+      # Returns a base usage string that considers whether this command is the
+      # default, and if it has any parents. Used internally by `usage_string`.
       def base_usage_pattern
         usage_pattern = default ? "[#{name}]" : name
         parents.any? ? (parents + [usage_pattern]).join(' ') : usage_pattern
@@ -344,21 +160,6 @@ module Bashly
         @validatables ||= args.select(&:validate) + flags.select(&:validate)
       end
 
-      # Returns an array of all the args with a whitelist
-      def whitelisted_args
-        args.select(&:allowed)
-      end
-
-      # Returns an array of all the environment_variables with a whitelist arg
-      def whitelisted_environment_variables
-        environment_variables.select(&:allowed)
-      end
-
-      # Returns an array of all the flags with a whitelist arg
-      def whitelisted_flags
-        flags.select(&:allowed)
-      end
-
     private
 
       # Returns either a flat filename (docker_status_command.sh) or a nested

data/lib/bashly/script/environment_variable.rb

@@ -1,9 +1,13 @@
 module Bashly
   module Script
     class EnvironmentVariable < Base
+      include Introspection::Visibility
+
       class << self
         def option_keys
-          @option_keys ||= %i[allowed default help name required private]
+          @option_keys ||= %i[
+            allowed default help name required private validate
+          ]
         end
       end
 

data/lib/bashly/script/flag.rb

@@ -1,13 +1,16 @@
+require 'shellwords'
+
 module Bashly
   module Script
     class Flag < Base
       include Completions::Flag
+      include Introspection::Visibility
 
       class << self
         def option_keys
           @option_keys ||= %i[
-            allowed arg completions conflicts default help long repeatable
-            required short unique validate private
+            allowed arg completions conflicts default help long needs
+            repeatable required short unique validate private
           ]
         end
       end

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

@@ -0,0 +1,41 @@
+module Bashly
+  module Script
+    module Introspection
+      module Arguments
+        # Returns an array of Arguments
+        def args
+          return [] unless options['args']
+
+          options['args'].map do |options|
+            Argument.new options
+          end
+        end
+
+        # Returns an array of all the default Args
+        def default_args
+          args.select(&:default)
+        end
+
+        # Returns true if one of the args is repeatable
+        def repeatable_arg_exist?
+          args.any?(&:repeatable)
+        end
+
+        # Returns an array of all the required Arguments
+        def required_args
+          args.select(&:required)
+        end
+
+        # Returns an array of args usage_string for the command's usage_string
+        def usage_string_args
+          args.map(&:usage_string)
+        end
+
+        # Returns an array of all the args with a whitelist
+        def whitelisted_args
+          args.select(&:allowed)
+        end
+      end
+    end
+  end
+end

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.1'
+  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/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/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/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.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-25 00:00:00.000000000 Z
+date: 2024-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -100,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: requires
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: tty-markdown
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +234,13 @@ files:
 - lib/bashly/script/dependency.rb
 - lib/bashly/script/environment_variable.rb
 - lib/bashly/script/flag.rb
+- lib/bashly/script/introspection/arguments.rb
+- lib/bashly/script/introspection/commands.rb
+- lib/bashly/script/introspection/dependencies.rb
+- lib/bashly/script/introspection/environment_variables.rb
+- lib/bashly/script/introspection/examples.rb
+- lib/bashly/script/introspection/flags.rb
+- lib/bashly/script/introspection/visibility.rb
 - lib/bashly/script/wrapper.rb
 - lib/bashly/settings.rb
 - lib/bashly/templates/bashly.yml
@@ -248,6 +269,7 @@ files:
 - lib/bashly/views/command/inspect_args.gtx
 - lib/bashly/views/command/long_usage.gtx
 - lib/bashly/views/command/master_script.gtx
+- lib/bashly/views/command/needy_flags_filter.gtx
 - lib/bashly/views/command/normalize_input.gtx
 - lib/bashly/views/command/normalize_input_function.gtx
 - lib/bashly/views/command/normalize_input_simple.gtx
@@ -275,10 +297,12 @@ files:
 - lib/bashly/views/command/version_command.gtx
 - lib/bashly/views/command/whitelist_filter.gtx
 - lib/bashly/views/environment_variable/usage.gtx
+- lib/bashly/views/environment_variable/validations.gtx
 - lib/bashly/views/flag/case.gtx
 - lib/bashly/views/flag/case_arg.gtx
 - lib/bashly/views/flag/case_no_arg.gtx
 - lib/bashly/views/flag/conflicts.gtx
+- lib/bashly/views/flag/needs.gtx
 - lib/bashly/views/flag/usage.gtx
 - lib/bashly/views/flag/validations.gtx
 - lib/bashly/views/wrapper/bash3_bouncer.gtx
@@ -308,7 +332,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Bash Command Line Tool Generator