bashly 0.7.8 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d05f653ff5439edd7108eaff3c6265926dc4e894453fce1c59bc4727c4c98d1f
-  data.tar.gz: 39afd30e66779103285d9df99f74f4e3cc8af61220d15a6b1cb02b21a4bebe57
+  metadata.gz: d3d0126229189987753e653a635054113961b1e9e0244d4cdb956beb1d5aff94
+  data.tar.gz: 886987a65edc65d16d2134589cbb4ee9f3fcb9e0b1819c8a87211bcd2d164d0c
 SHA512:
-  metadata.gz: 8db8291a3db5a496626676942eddcadb61f7080ab316ed17652af5f58376e40efa85473e7a665a3966dbbfdbc37b6662577a3e13b50d9f49c36a87792854cefc
-  data.tar.gz: c844bf07c523c6f04a21874a08e3c2c40fafe4562829f419f77fd17f74ebaa70b5006e61c50b430399dcca00158f9d4b4fdb7afe4dfeb2e3a425c8eb544fcc22
+  metadata.gz: 880579e8bb650c8835cc7992054f3f4dd3e765ddc1b7072f83ed6fc9049d4b56b38c4a64220c3dd154f8fdbf199462cca1ef955d36d465a0d57ecc00715bd85e
+  data.tar.gz: efa2f73f9eed6d5ba1ebb432e37ef639e618bc1556ba83059ccad4804b6568b407d86f91fe11faa3335b69103e368fdb9bf1339f90af1fd15cb742b91163b911

data/lib/bashly/cli.rb

@@ -6,7 +6,8 @@ module Bashly
   class CLI
     def self.runner
       runner = MisterBin::Runner.new version: Bashly::VERSION,
-        header: "Bashly - Bash CLI Generator"
+        header: "Bashly - Bash CLI Generator",
+        footer: "Help: !txtpur!bashly COMMAND --help!txtrst!\nDocs: !undblu!https://bashly.dannyb.co"
 
       runner.route 'init',      to: Commands::Init
       runner.route 'preview',   to: Commands::Preview

data/lib/bashly/commands/add.rb

@@ -3,14 +3,15 @@ module Bashly
     class Add < Base
       help "Add extra features and customization to your script"
 
-      usage "bashly add strings [--force]"
-      usage "bashly add lib [--force]"
-      usage "bashly add config [--force]"
       usage "bashly add colors [--force]"
-      usage "bashly add yaml [--force]"
-      usage "bashly add validations [--force]"
-      usage "bashly add test [--force]"
       usage "bashly add comp FORMAT [OUTPUT --force]"
+      usage "bashly add config [--force]"
+      usage "bashly add lib [--force]"
+      usage "bashly add settings [--force]"
+      usage "bashly add strings [--force]"
+      usage "bashly add test [--force]"
+      usage "bashly add validations [--force]"
+      usage "bashly add yaml [--force]"
       usage "bashly add (-h|--help)"
 
       option "-f --force", "Overwrite existing files"
@@ -18,14 +19,15 @@ module Bashly
       param "FORMAT", "Output format, can be one of:\n  function : generate a function file to be included in your script.\n  script   : generate a standalone bash completions script.\n  yaml     : generate a yaml compatible with completely."
       param "OUTPUT", "For the 'comp function' command: Name of the generated function.\nFor the 'comp script' or 'comp yaml' commands: path to output file.\nIn all cases, this is optional and will have sensible defaults."
 
-      command "strings", "Copy an additional configuration file to your project, allowing you to customize all the tips and error strings."
-      command "lib", "Create the additional lib directory for additional user scripts. All *.sh scripts in this folder will be included in the final bash script."
-      command "config", "Add standard functions for handling INI files to the lib directory."
       command "colors", "Add standard functions for printing colorful and formatted text to the lib directory."
-      command "yaml", "Add standard functions for reading YAML files to the lib directory."
-      command "validations", "Add argument validation functions to the lib directory."
-      command "test", "Add approval testing."
       command "comp", "Generate a bash completions script or function."
+      command "config", "Add standard functions for handling INI files to the lib directory."
+      command "lib", "Create the additional lib directory for additional user scripts. All *.sh scripts in this folder will be included in the final bash script."
+      command "settings", "Copy a sample settings.yml file to your project, allowing you to customize some bashly options."
+      command "strings", "Copy an additional configuration file to your project, allowing you to customize all the tips and error strings."
+      command "test", "Add approval testing."
+      command "validations", "Add argument validation functions to the lib directory."
+      command "yaml", "Add standard functions for reading YAML files to the lib directory."
 
       example "bashly add strings --force"
       example "bashly add comp function"
@@ -34,45 +36,51 @@ module Bashly
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
       environment "BASHLY_LIB_DIR", "The path to use for creating the library files, relative to the source dir [default: lib]"
 
-      def strings_command
-        add_lib 'strings'
+      attr_reader :skip_src_check
+
+      def colors_command
+        add_lib 'colors'
       end
 
-      def lib_command
-        add_lib 'lib'
+      def comp_command
+        format = args['FORMAT']
+        output = args['OUTPUT']
+
+        case format
+        when "script"   then add_lib 'completions_script', output
+        when "function" then add_lib 'completions', output
+        when "yaml"     then add_lib 'completions_yaml', output
+        else            raise Error, "Unrecognized format: #{format}"
+        end
       end
 
       def config_command
         add_lib 'config'
       end
 
-      def colors_command
-        add_lib 'colors'
+      def settings_command
+        @skip_src_check = true
+        add_lib 'settings'
       end
 
-      def yaml_command
-        add_lib 'yaml'
+      def strings_command
+        add_lib 'strings'
       end
 
-      def validations_command
-        add_lib 'validations'
+      def lib_command
+        add_lib 'lib'
       end
 
       def test_command
         add_lib 'test'
       end
 
-      def comp_command
-        format = args['FORMAT']
-        output = args['OUTPUT']
-
-        case format
-        when "script"   then add_lib 'completions_script', output
-        when "function" then add_lib 'completions', output
-        when "yaml"     then add_lib 'completions_yaml', output
-        else            raise Error, "Unrecognized format: #{format}"
-        end
+      def yaml_command
+        add_lib 'yaml'
+      end
 
+      def validations_command
+        add_lib 'validations'
       end
 
     private
@@ -89,7 +97,7 @@ module Bashly
       end
 
       def safe_write(path, content)
-        if !Dir.exist? Settings.source_dir
+        if !skip_src_check and !Dir.exist? Settings.source_dir
           raise InitError, "Directory !txtgrn!#{Settings.source_dir}!txtrst! does not exist\nRun !txtpur!bashly init!txtrst! first"
         end
 

data/lib/bashly/commands/base.rb

@@ -6,10 +6,28 @@ module Bashly
     class Base < MisterBin::Command
       include AssetHelper
 
+      def config
+        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
+      end
+
+      def config_validator
+        @config_validator ||= ConfigValidator.new config
+      end
+
       def validate_config
-        config = Config.new "#{Settings.source_dir}/bashly.yml"
-        validator = ConfigValidator.new config
-        validator.validate
+        config_validator.validate
+      end
+
+      def with_valid_config
+        validate_config
+        yield
+        show_deprecations
+      end
+
+      def show_deprecations
+        return if config_validator.deprecations.empty? or ENV['BASHLY_HIDE_DEPRECATIONS']
+        messages = "\n" + config_validator.deprecations.map(&:message).join("\n\n") + "\n\n"
+        say! messages
       end
     end
   end

data/lib/bashly/commands/generate.rb

@@ -3,28 +3,38 @@ module Bashly
     class Generate < Base
       help "Generate the bash script and required files"
 
-      usage "bashly generate [--force --quiet --upgrade --wrap FUNCTION]"
+      usage "bashly generate [options]"
       usage "bashly generate (-h|--help)"
 
       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 "-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]"
       environment "BASHLY_TARGET_DIR", "The path to use for creating the bash script [default: .]"
       environment "BASHLY_LIB_DIR", "The path to use for upgrading library files, relative to the source dir [default: lib]"
       environment "BASHLY_STRICT", "When not empty, enable bash strict mode (set -euo pipefail)"
+      environment "BASHLY_TAB_INDENT", "When not empty, the generated script will use tab indentation instead of spaces (every 2 leading spaces will be converted to a tab character)"
+      environment "BASHLY_ENV", <<~EOF
+        Set to 'production' or 'development':
+        - production    generate a smaller script, without file markers
+        - development   generate with file markers
+
+        Can be overridden with --env [default: development]
+      EOF
 
       example "bashly generate --force"
       example "bashly generate --wrap my_function"
 
       def run
-        validate_config
-        create_user_files
-        upgrade_libs if args['--upgrade']
-        create_master_script
-        quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script"
+        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"
+        end
       end
 
     private
@@ -33,6 +43,12 @@ module Bashly
         say message unless args['--quiet']
       end
 
+      def generate_all_files
+        create_user_files
+        upgrade_libs if args['--upgrade']
+        create_master_script
+      end
+
       def upgrade_libs
         generated_files.each do |file|
           content = File.read file
@@ -104,7 +120,7 @@ module Bashly
       end
 
       def create_master_script
-        File.write master_script_path, script.code
+        File.write master_script_path, script.code(tab_indent: Settings.tab_indent)
         FileUtils.chmod "+x", master_script_path
         quiet_say "!txtgrn!created!txtrst! #{master_script_path}"
       end
@@ -117,10 +133,6 @@ module Bashly
         "#{Settings.target_dir}/#{command.name}"
       end
 
-      def config
-        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
-      end
-
       def command
         @command ||= Script::Command.new config
       end

data/lib/bashly/commands/preview.rb

@@ -9,10 +9,11 @@ module Bashly
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
 
       def run
-        config = Config.new "#{Settings.source_dir}/bashly.yml"
-        command = Script::Command.new(config)
-        script = Script::Wrapper.new command
-        puts script.code
+        with_valid_config do
+          command = Script::Command.new config
+          script = Script::Wrapper.new command
+          puts script.code
+        end
       end
     end
   end

data/lib/bashly/commands/validate.rb

@@ -10,7 +10,13 @@ module Bashly
 
       def run
         validate_config
-        say "!txtgrn!OK"
+        show_deprecations
+        deprecations = config_validator.deprecations
+        if deprecations.empty?
+          say "!txtgrn!OK"
+        else
+          say "!txtred!WARNING!txtrst! Found #{deprecations.count} deprecations"
+        end
       end
     end
   end

data/lib/bashly/concerns/renderable.rb

@@ -4,13 +4,20 @@ module Bashly
   module Renderable
     def render(view)
       template = File.read view_path(view)
-      ERB.new(template, trim_mode: '%-').result(binding)
+      erb = ERB.new(template, trim_mode: '%-')
+      erb.filename = "#{views_subfolder}.#{view}"
+      erb.result binding
     end
 
     def strings
       @strings ||= MessageStrings.new
     end
 
+    def view_marker(id = nil)
+      id ||= ":#{caller_locations.first.path}"
+      "# #{id}" unless Settings.production?
+    end
+
   private
 
     def view_path(view)

data/lib/bashly/concerns/validation_helpers.rb

@@ -0,0 +1,69 @@
+module Bashly
+  # This is a `ConfigValidator` concern responsible for providing basic
+  # assertion methods.
+  module ValidationHelpers
+
+    def deprecations
+      @deprecations ||= []
+    end
+
+  protected
+
+    def assert(valid, message)
+      raise ConfigurationError, message unless valid
+    end
+
+    def refute(invalid, message)
+      assert !invalid, message
+    end
+
+    def deprecate(key, **options)
+      deprecations.push Deprecation.new(key, **options)
+    end
+
+    def assert_string(key, value)
+      assert value.is_a?(String), "#{key} must be a string"
+    end
+
+    def assert_optional_string(key, value)
+      assert_string key, value if value
+    end
+
+    def assert_boolean(key, value)
+      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
+      end
+    end
+
+    def assert_hash(key, value, whitelist = 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(', ')}"
+      end
+    end
+
+    def assert_uniq(key, value, array_key)
+      return unless value
+      list = value.map { |c| c[array_key] }.compact.flatten
+      assert list.uniq?, "#{key} cannot have elements with similar #{array_key} values"
+    end
+
+    def assert_string_or_array(key, value)
+      return unless value
+      assert [Array, String].include?(value.class),
+        "#{key} must be a string or an array"
+
+      assert_array key, value, of: :string if value.is_a? Array
+    end
+  end
+end

data/lib/bashly/config_validator.rb

@@ -1,5 +1,7 @@
 module Bashly
   class ConfigValidator
+    include ValidationHelpers
+
     attr_reader :data
 
     def initialize(data)
@@ -12,40 +14,6 @@ module Bashly
 
   private
 
-    def assert(valid, message)
-      raise ConfigurationError, message unless valid
-    end
-
-    def refute(invalid, message)
-      assert !invalid, message
-    end
-
-    def assert_string(key, value)
-      assert value.is_a?(String), "#{key} must be a string"
-    end
-
-    def assert_optional_string(key, value)
-      assert_string key, value if value
-    end
-
-    def assert_boolean(key, value)
-      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
-      end
-    end
-
-    def assert_hash(key, value)
-      assert value.is_a?(Hash), "#{key} must be a hash"
-    end
-
     def assert_version(key, value)
       return unless value
       assert [String, Integer, Float].include?(value.class),
@@ -61,6 +29,7 @@ module Bashly
     end
 
     def assert_catch_all_hash(key, value)
+      assert_hash key, value, Script::CatchAll.option_keys
       assert_string "#{key}.label", value['label']
       assert_optional_string "#{key}.help", value['help']
       assert_boolean "#{key}.required", value['required']
@@ -73,7 +42,7 @@ module Bashly
     end
 
     def assert_arg(key, value)
-      assert_hash key, value
+      assert_hash key, value, Script::Argument.option_keys
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.default", value['default']
@@ -89,7 +58,7 @@ module Bashly
     end
 
     def assert_flag(key, value)
-      assert_hash key, value
+      assert_hash key, value, Script::Flag.option_keys
       assert value['short'] || value['long'], "#{key} must have at least one of long or short name"
 
       assert_optional_string "#{key}.long", value['long']
@@ -99,6 +68,7 @@ module Bashly
       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
@@ -119,7 +89,7 @@ module Bashly
     end
 
     def assert_env_var(key, value)
-      assert_hash key, value
+      assert_hash key, value, Script::EnvironmentVariable.option_keys
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.default", value['default']
@@ -127,21 +97,22 @@ module Bashly
     end
 
     def assert_command(key, value)
-      assert_hash key, value
+      assert_hash key, value, Script::Command.option_keys
 
       refute value['commands'] && value['args'], "#{key} cannot have both commands and args"
       refute value['commands'] && value['flags'], "#{key} cannot have both commands and flags"
-      
+
       assert_string "#{key}.name", value['name']
-      assert_optional_string "#{key}.short", value['short']
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.footer", value['footer']
       assert_optional_string "#{key}.group", value['group']
       assert_optional_string "#{key}.filename", value['filename']
 
+      assert_boolean "#{key}.private", value['private']
       assert_boolean "#{key}.default", value['default']
       assert_version "#{key}.version", value['version']
       assert_catch_all "#{key}.catch_all", value['catch_all']
+      assert_string_or_array "#{key}.alias", value['alias']
       assert_extensible "#{key}.extensible", value['extensible']
       
       assert_array "#{key}.args", value['args'], of: :arg
@@ -153,8 +124,19 @@ module Bashly
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
       assert_array "#{key}.examples", value['examples'], of: :string
 
+      assert_uniq "#{key}.commands", value['commands'], 'name'
+      assert_uniq "#{key}.commands", value['commands'], 'alias'
+      assert_uniq "#{key}.flags", value['flags'], 'long'
+      assert_uniq "#{key}.flags", value['flags'], 'short'
+      assert_uniq "#{key}.args", value['args'], 'name'
+
+      if value['catch_all'] and value['args']
+        repeatable_arg = value['args'].select { |a| a['repeatable'] }.first&.dig 'name'
+        refute repeatable_arg, "#{key}.catch_all makes no sense with repeatable arg (#{repeatable_arg})"
+      end
+
       if key == "root"
-        refute value['short'], "#{key}.short makes no sense"
+        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"
@@ -162,6 +144,11 @@ module Bashly
         refute value['version'], "#{key}.version makes no sense"
         refute value['extensible'], "#{key}.extensible makes no sense"
       end
+
+      # DEPRECATION 0.8.0
+      if value['short']
+        deprecate "#{key}.short", replacement: "alias", reference: "https://github.com/DannyBen/bashly/pull/220"
+      end
     end
   end
 end

data/lib/bashly/deprecation.rb

@@ -0,0 +1,25 @@
+module Bashly
+  class Deprecation
+    attr_reader :old, :replacement, :reference
+
+    def initialize(old, replacement: nil, reference: nil)
+      @old, @replacement, @reference = old, replacement, reference
+    end
+
+    def message
+      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")
+    end
+
+    def to_h
+      {
+        old: old,
+        replacement: replacement,
+        reference: reference
+      }
+    end
+  end
+end

data/lib/bashly/extensions/array.rb

@@ -4,4 +4,9 @@ class Array
     indentation = " " * offset
     map { |line| "#{indentation}#{line}" }
   end
+
+  def uniq?
+    self == uniq
+  end
+
 end

data/lib/bashly/extensions/string.rb

@@ -31,4 +31,10 @@ class String
     split(/^---\s*/).last
   end
 
+  def expand_tabs(tabstop = 2)
+    gsub(/^( {#{tabstop}}+)/) do
+      "\t" * ($1.size / tabstop)
+    end
+  end
+
 end

data/lib/bashly/extensions/yaml.rb

@@ -3,6 +3,8 @@ module YAML
   def self.properly_load_file(path)
     YAML.load_file path, aliases: true
   rescue ArgumentError
+    # :nocov:
     YAML.load_file path
+    # :nocov:
   end
 end

data/lib/bashly/libraries.yml

@@ -3,21 +3,25 @@ colors:
     - source: "templates/lib/colors.sh"
       target: "%{user_lib_dir}/colors.sh"
 
+completions: :CompletionsFunction
+completions_script: :CompletionsScript
+completions_yaml: :CompletionsYAML
+
 config:
   files:
     - source: "templates/lib/config.sh"
       target: "%{user_lib_dir}/config.sh"
 
-yaml:
-  files:
-    - source: "templates/lib/yaml.sh"
-      target: "%{user_lib_dir}/yaml.sh"
-
 lib:
   files:
     - source: "templates/lib/sample_function.sh"
       target: "%{user_lib_dir}/sample_function.sh"
 
+settings:
+  files:
+    - source: "templates/settings.yml"
+      target: "settings.yml"
+
 strings:
   files:
     - source: "templates/strings.yml"
@@ -37,7 +41,6 @@ test:
 
     Docs: !undblu!https://github.com/DannyBen/approvals.bash
 
-
 validations:
   files:
     - source: "templates/lib/validations/validate_dir_exists.sh"
@@ -49,6 +52,7 @@ validations:
     - source: "templates/lib/validations/validate_not_empty.sh"
       target: "%{user_lib_dir}/validations/validate_not_empty.sh"
 
-completions: :CompletionsFunction
-completions_script: :CompletionsScript
-completions_yaml: :CompletionsYAML
+yaml:
+  files:
+    - source: "templates/lib/yaml.sh"
+      target: "%{user_lib_dir}/yaml.sh"

data/lib/bashly/script/argument.rb

@@ -1,8 +1,20 @@
 module Bashly
   module Script
     class Argument < Base
+      class << self
+        def option_keys
+          @option_keys ||= %i[
+            allowed default help name repeatable required validate
+          ]
+        end
+      end
+
       def usage_string
-        required ? name.upcase : "[#{name.upcase}]"
+        required ? label : "[#{label}]"
+      end
+
+      def label
+        repeatable ? "#{name.upcase}..." : name.upcase
       end
     end
   end