bashly 0.8.10 → 0.9.1

data/lib/bashly/concerns/validation_helpers.rb

@@ -2,7 +2,6 @@ module Bashly
   # This is a `ConfigValidator` concern responsible for providing basic
   # assertion methods.
   module ValidationHelpers
-
     def deprecations
       @deprecations ||= []
     end
@@ -30,34 +29,42 @@ module Bashly
     end
 
     def assert_boolean(key, value)
-      assert [true, false, nil].include?(value), "#{key} must be a boolean" 
+      assert [true, false, nil].include?(value), "#{key} must be a boolean"
     end
 
     def assert_array(key, value, of: nil)
       return unless value
+
       assert value.is_a?(Array), "#{key} must be an array"
-      if of
-        value.each_with_index do |val, i|
-          send "assert_#{of}".to_sym, "#{key}[#{i}]", val
-        end
+      return unless of
+
+      value.each_with_index do |val, i|
+        send "assert_#{of}".to_sym, "#{key}[#{i}]", val
       end
     end
 
-    def assert_hash(key, value, whitelist = nil)
+    def assert_hash(key, value, keys: nil, of: nil)
       assert value.is_a?(Hash), "#{key} must be a hash"
-      
-      if whitelist
-        invalid_keys = value.keys.map(&:to_sym) - whitelist
-        assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join(', ')}"
+
+      if keys
+        invalid_keys = value.keys.map(&:to_sym) - keys
+        assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join ', '}"
+      end
+
+      return unless of
+
+      value.each do |k, v|
+        send "assert_#{of}".to_sym, "#{key}.#{k}", v
       end
     end
 
     def assert_uniq(key, value, array_keys)
       return unless value
+
       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
+        list += value.filter_map { |c| c[array_key] }.flatten
       end
 
       nonuniqs = list.nonuniq
@@ -66,6 +73,7 @@ module Bashly
 
     def assert_string_or_array(key, value)
       return unless value
+
       assert [Array, String].include?(value.class),
         "#{key} must be a string or an array"
 

data/lib/bashly/config.rb

@@ -16,4 +16,4 @@ module Bashly
       end
     end
   end
-end
+end

data/lib/bashly/config_validator.rb

@@ -9,52 +9,76 @@ module Bashly
     end
 
     def validate
-      assert_command "root", data
+      assert_command 'root', data
     end
 
   private
 
     def assert_version(key, value)
       return unless value
+
       assert [String, Integer, Float].include?(value.class),
-        "#{key} must be a string or a number" 
+        "#{key} must be a string or a number"
     end
 
     def assert_catch_all(key, value)
       return unless value
+
       assert [TrueClass, String, Hash].include?(value.class),
-        "#{key} must be a boolean, a string or a hash" 
+        "#{key} must be a boolean, a string or a hash"
 
       assert_catch_all_hash key, value if value.is_a? Hash
     end
 
     def assert_catch_all_hash(key, value)
-      assert_hash key, value, Script::CatchAll.option_keys
+      assert_hash key, value, keys: Script::CatchAll.option_keys
       assert_string "#{key}.label", value['label']
       assert_optional_string "#{key}.help", value['help']
       assert_boolean "#{key}.required", value['required']
     end
 
+    def assert_default_command(key, value)
+      return unless value
+
+      assert [true, false, nil, 'force'].include?(value), "#{key} must be a boolean, or the string 'force'"
+    end
+
+    def assert_dependencies(key, value)
+      return unless value
+
+      case value
+      when Array
+        assert_array key, value, of: :string
+      when Hash
+        assert_hash key, value, of: :string
+      else
+        assert [Array, Hash].include?(value.class),
+          "#{key} must be an array or a hash"
+      end
+    end
+
     def assert_extensible(key, value)
       return unless value
+
       assert [TrueClass, String].include?(value.class),
-        "#{key} must be a boolean or a string" 
+        "#{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'" 
+
+      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_hash key, value, keys: Script::Argument.option_keys
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.default", value['default']
       assert_optional_string "#{key}.validate", value['validate']
       assert_boolean "#{key}.required", value['required']
       assert_boolean "#{key}.repeatable", value['repeatable']
-      
+
       assert_array "#{key}.allowed", value['allowed'], of: :string
 
       refute value['name'].match(/^-/), "#{key}.name must not start with '-'"
@@ -63,7 +87,7 @@ module Bashly
     end
 
     def assert_flag(key, value)
-      assert_hash key, value, Script::Flag.option_keys
+      assert_hash key, value, keys: 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"
@@ -74,14 +98,14 @@ module Bashly
       assert_optional_string "#{key}.arg", value['arg']
       assert_optional_string "#{key}.default", value['default']
       assert_optional_string "#{key}.validate", value['validate']
-      
+
       assert_boolean "#{key}.repeatable", value['repeatable']
       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['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']
       refute value['arg'].match(/^-/), "#{key}.arg must not start with '-'" if value['arg']
 
@@ -101,15 +125,20 @@ module Bashly
     end
 
     def assert_env_var(key, value)
-      assert_hash key, value, Script::EnvironmentVariable.option_keys
+      assert_hash key, value, keys: Script::EnvironmentVariable.option_keys
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.default", value['default']
       assert_boolean "#{key}.required", value['required']
+      assert_boolean "#{key}.private", value['private']
+
+      if value['private']
+        assert value['default'], "#{key}.private makes no sense without default"
+      end
     end
 
     def assert_command(key, value)
-      assert_hash key, value, Script::Command.option_keys
+      assert_hash key, value, keys: Script::Command.option_keys
 
       refute value['commands'] && value['args'], "#{key} cannot have both commands and args"
       refute value['commands'] && value['catch_all'], "#{key} cannot have both commands and catch_all"
@@ -122,37 +151,34 @@ module Bashly
       assert_optional_string "#{key}.function", value['function']
 
       assert_boolean "#{key}.private", value['private']
-      assert_boolean "#{key}.default", value['default']
+      assert_default_command "#{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']
       assert_string_or_array "#{key}.examples", value['examples']
       assert_extensible "#{key}.extensible", value['extensible']
-      
+      assert_dependencies "#{key}.dependencies", value['dependencies']
+
       assert_array "#{key}.args", value['args'], of: :arg
-      assert_array "#{key}.flags", value['flags'] , of: :flag
+      assert_array "#{key}.flags", value['flags'], of: :flag
       assert_array "#{key}.commands", value['commands'], of: :command
       assert_array "#{key}.completions", value['completions'], of: :string
-      assert_array "#{key}.dependencies", value['dependencies'], of: :string
       assert_array "#{key}.filters", value['filters'], of: :string
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
 
-      assert_uniq "#{key}.commands", value['commands'], ['name', 'alias']
+      assert_uniq "#{key}.commands", value['commands'], %w[name alias]
       assert_uniq "#{key}.flags", value['flags'], 'long'
       assert_uniq "#{key}.flags", value['flags'], 'short'
       assert_uniq "#{key}.args", value['args'], 'name'
 
       if value['function']
-        assert value['function'].match(/^[a-z0-9_]+$/), "#{key}.function must contain lowercase alphanumeric characters and underscores only" 
-      end
-
-      if value['default']
-        assert value['args'], "#{key}.default makes no sense without args"
+        assert value['function'].match(/^[a-z0-9_]+$/),
+          "#{key}.function must contain lowercase alphanumeric characters and underscores only"
       end
 
-      if value['catch_all'] and value['args']
-        repeatable_arg = value['args'].select { |a| a['repeatable'] }.first&.dig 'name'
+      if value['catch_all'] && value['args']
+        repeatable_arg = value['args'].find { |a| a['repeatable'] }&.dig 'name'
         refute repeatable_arg, "#{key}.catch_all makes no sense with repeatable arg (#{repeatable_arg})"
       end
 
@@ -160,7 +186,7 @@ module Bashly
         assert value['commands'], "#{key}.expose makes no sense without commands"
       end
 
-      if key == "root"
+      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"
@@ -173,7 +199,7 @@ module Bashly
 
       # DEPRECATION 0.8.0
       if value['short']
-        deprecate "#{key}.short", replacement: "alias", reference: "https://github.com/DannyBen/bashly/pull/220"
+        deprecate "#{key}.short", replacement: 'alias', reference: 'https://github.com/DannyBen/bashly/pull/220'
       end
     end
   end

data/lib/bashly/deprecation.rb

@@ -3,23 +3,25 @@ module Bashly
     attr_reader :old, :replacement, :reference
 
     def initialize(old, replacement: nil, reference: nil)
-      @old, @replacement, @reference = old, replacement, reference
+      @old = old
+      @replacement = replacement
+      @reference = reference
     end
 
     def message
-      result = ["Deprecation Warning:", "!txtred!#{old}!txtrst! is deprecated"]
+      result = ['Deprecation Warning:', "!txtred!#{old}!txtrst! is deprecated"]
       result.push "use !txtgrn!#{replacement}!txtrst! instead" if replacement
       result.push "see !undblu!#{reference}!txtrst!" if reference
-      
-      result.map { |line| "!txtred!▐!txtrst! #{line}"}.join("\n")
+
+      result.map { |line| "!txtred!▐!txtrst! #{line}" }.join("\n")
     end
 
     def to_h
       {
-        old: old,
+        old:         old,
         replacement: replacement,
-        reference: reference
+        reference:   reference,
       }
     end
   end
-end
+end

data/lib/bashly/exceptions.rb

@@ -3,4 +3,4 @@ module Bashly
   class Error < StandardError; end
   class InitError < Error; end
   class ConfigurationError < Error; end
-end
+end

data/lib/bashly/extensions/array.rb

@@ -1,12 +1,12 @@
 class Array
   def indent(offset)
-    return self unless offset > 0
-    indentation = " " * offset
+    return self unless offset.positive?
+
+    indentation = ' ' * offset
     map { |line| "#{indentation}#{line}" }
   end
 
   def nonuniq
-    tally.select { |key, count| count > 1 }.keys
+    tally.select { |_key, count| count > 1 }.keys
   end
-
 end

data/lib/bashly/extensions/file.rb

@@ -1,13 +1,13 @@
-require "fileutils"
+require 'fileutils'
 
 class File
   def self.deep_write(file, content)
     dir = File.dirname file
-    FileUtils.mkdir_p dir unless Dir.exist? dir
+    FileUtils.mkdir_p dir
     File.write file, content
   end
 
   def self.append(path, content)
-    File.open(path, "a") { |f| f << content }
+    File.open(path, 'a') { |f| f << content }
   end
 end

data/lib/bashly/extensions/string.rb

@@ -1,15 +1,16 @@
 class String
   def sanitize_for_print
-    gsub("\n", "\\n").gsub("\"", "\\\"")
+    gsub("\n", '\\n').gsub('"', '\"')
   end
 
   def indent(offset)
-    return self unless offset > 0
+    return self unless offset.positive?
+
     lines.indent(offset).join
   end
 
   def to_underscore
-    gsub(/(.)([A-Z])/,'\1_\2').gsub(/[\- ]/, '_').downcase
+    gsub(/(.)([A-Z])/, '\1_\2').gsub(/[- ]/, '_').downcase
   end
 
   def wrap(length = 80)
@@ -24,7 +25,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.grep_v(/^\s*##/).join
   end
 
   def remove_front_matter
@@ -33,8 +34,7 @@ class String
 
   def expand_tabs(tabstop = 2)
     gsub(/^( {#{tabstop}}+)/) do
-      "\t" * ($1.size / tabstop)
+      "\t" * (::Regexp.last_match(1).size / tabstop)
     end
   end
-
 end

data/lib/bashly/libraries/base.rb

@@ -8,12 +8,22 @@ module Bashly
       end
 
       def files
-        raise NotImplementedError, "Please implement #files"
+        raise NotImplementedError, 'Please implement #files'
       end
 
       def post_install_message
         nil
       end
+
+    protected
+
+      def command
+        @command ||= Script::Command.new config
+      end
+
+      def config
+        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
+      end
     end
   end
 end

data/lib/bashly/libraries/completions_function.rb

@@ -1,23 +1,23 @@
 module Bashly
   module Libraries
-    class CompletionsFunction < Completions
+    class CompletionsFunction < Base
       def files
         [
           {
-            path: "#{Settings.full_lib_dir}/#{function_name}.sh",
-            content: completions_function_code(function_name)
-          }
+            path:    "#{Settings.full_lib_dir}/#{function_name}.#{Settings.partials_extension}",
+            content: completions_function_code(function_name),
+          },
         ]
       end
 
       def post_install_message
-        <<~EOF
+        <<~MESSAGE
           In order to enable completions in your script, create a command or a flag (for example: !txtgrn!#{command.name} completions!txtrst! or !txtgrn!#{command.name} --completions!txtrst!) that calls the !txtgrn!#{function_name}!txtrst! function.
 
           Your users can then run something like this to enable completions:
 
-            !txtpur!$ eval \"$(#{command.name} completions)\"
-        EOF
+            !txtpur!$ eval "$(#{command.name} completions)"
+        MESSAGE
       end
 
     private
@@ -29,10 +29,9 @@ module Bashly
       def completions_function_code(function_name)
         [
           "## [@bashly-upgrade completions #{function_name}]",
-          command.completion_function(function_name)
+          command.completion_function(function_name),
         ].join "\n"
       end
-
     end
   end
-end
+end

data/lib/bashly/libraries/completions_script.rb

@@ -1,21 +1,21 @@
 module Bashly
   module Libraries
-    class CompletionsScript < Completions
+    class CompletionsScript < Base
       def files
         [
           {
-            path: target_path,
-            content: command.completion_script
-          }
+            path:    target_path,
+            content: command.completion_script,
+          },
         ]
       end
 
       def post_install_message
-        <<~EOF
+        <<~MESSAGE
           In order to enable completions, run:
 
             !txtpur!$ source #{target_path}
-        EOF
+        MESSAGE
       end
 
     private
@@ -23,7 +23,6 @@ module Bashly
       def target_path
         @target_path ||= args[0] || "#{Settings.target_dir}/completions.bash"
       end
-
     end
   end
-end
+end

data/lib/bashly/libraries/completions_yaml.rb

@@ -1,19 +1,19 @@
 module Bashly
   module Libraries
-    class CompletionsYAML < Completions
+    class CompletionsYAML < Base
       def files
         [
           {
-            path: target_path,
-            content: command.completion_data.to_yaml
-          }
+            path:    target_path,
+            content: command.completion_data.to_yaml,
+          },
         ]
       end
 
       def post_install_message
-        <<~EOF
+        <<~MESSAGE
           This file can be converted to a completions script using the !txtgrn!completely!txtrst! gem.
-        EOF
+        MESSAGE
       end
 
     private
@@ -21,7 +21,6 @@ module Bashly
       def target_path
         @target_path ||= args[0] || "#{Settings.target_dir}/completions.yml"
       end
-
     end
   end
-end
+end

data/lib/bashly/libraries/help.rb

@@ -0,0 +1,36 @@
+module Bashly
+  module Libraries
+    class Help < Base
+      include AssetHelper
+
+      def files
+        [
+          {
+            path:    "#{Settings.source_dir}/help_command.#{Settings.partials_extension}",
+            content: help_command,
+          },
+        ]
+      end
+
+      def post_install_message
+        <<~MESSAGE
+          Add this as a command to your bashly.yml:
+
+            !txtgrn!commands:
+              !txtgrn!- name: !txtpur!help
+              !txtgrn!  help: !txtpur!Show help about a command
+              !txtgrn!  args:
+                !txtgrn!- name: !txtpur!command
+                !txtgrn!  help: !txtpur!Help subject
+
+        MESSAGE
+      end
+
+    private
+
+      def help_command
+        asset_content('templates/help/help_command.sh') % { name: command.name }
+      end
+    end
+  end
+end

data/lib/bashly/libraries.yml

@@ -1,7 +1,7 @@
 colors:
   files:
     - source: "templates/lib/colors.sh"
-      target: "%{user_lib_dir}/colors.sh"
+      target: "%{user_lib_dir}/colors.%{user_ext}"
 
 completions: :CompletionsFunction
 completions_script: :CompletionsScript
@@ -10,12 +10,14 @@ completions_yaml: :CompletionsYAML
 config:
   files:
     - source: "templates/lib/config.sh"
-      target: "%{user_lib_dir}/config.sh"
+      target: "%{user_lib_dir}/config.%{user_ext}"
+
+help: :Help
 
 lib:
   files:
     - source: "templates/lib/sample_function.sh"
-      target: "%{user_lib_dir}/sample_function.sh"
+      target: "%{user_lib_dir}/sample_function.%{user_ext}"
 
 settings:
   files:
@@ -37,22 +39,22 @@ test:
   post_install_message: |
     Edit your tests in !txtgrn!test/approve!txtrst! and then run:
 
-      !txtpur!$ ./test/approve!txtrst!"
+      !txtpur!$ test/approve!txtrst!
 
     Docs: !undblu!https://github.com/DannyBen/approvals.bash
 
 validations:
   files:
     - source: "templates/lib/validations/validate_dir_exists.sh"
-      target: "%{user_lib_dir}/validations/validate_dir_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_dir_exists.%{user_ext}"
     - source: "templates/lib/validations/validate_file_exists.sh"
-      target: "%{user_lib_dir}/validations/validate_file_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_file_exists.%{user_ext}"
     - source: "templates/lib/validations/validate_integer.sh"
-      target: "%{user_lib_dir}/validations/validate_integer.sh"
+      target: "%{user_lib_dir}/validations/validate_integer.%{user_ext}"
     - source: "templates/lib/validations/validate_not_empty.sh"
-      target: "%{user_lib_dir}/validations/validate_not_empty.sh"
+      target: "%{user_lib_dir}/validations/validate_not_empty.%{user_ext}"
 
 yaml:
   files:
     - source: "templates/lib/yaml.sh"
-      target: "%{user_lib_dir}/yaml.sh"
+      target: "%{user_lib_dir}/yaml.%{user_ext}"

data/lib/bashly/library.rb

@@ -6,7 +6,7 @@ module Bashly
       end
 
       def config
-        @config ||= YAML.properly_load_file(config_path)
+        @config ||= YAML.properly_load_file config_path
       end
 
       def config_path
@@ -18,7 +18,8 @@ module Bashly
     attr_reader :name, :args
 
     def initialize(name, *args)
-      @name, @args = name.to_s, args
+      @name = name.to_s
+      @args = args
     end
 
     def files
@@ -27,7 +28,7 @@ module Bashly
 
       else
         config['files'].map do |file|
-          { path: file['target'] % target_file_args,
+          { path:    file['target'] % target_file_args,
             content: asset_content(file['source']) }
         end
       end
@@ -42,13 +43,14 @@ module Bashly
     end
 
     def find_file(path)
-      files.select { |f| f[:path] == path }.first
+      files.find { |f| f[:path] == path }
     end
 
   private
 
     def custom_handler
       return nil unless config.is_a? Symbol
+
       @custom_handler ||= Bashly::Libraries.const_get(config).new(*args)
     end
 
@@ -60,7 +62,8 @@ module Bashly
       {
         user_source_dir: Settings.source_dir,
         user_target_dir: Settings.target_dir,
-        user_lib_dir: Settings.full_lib_dir,
+        user_lib_dir:    Settings.full_lib_dir,
+        user_ext:        Settings.partials_extension,
       }
     end
   end