bashly 0.7.9 → 0.7.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ef923a576e9bb9e16ec9f78c96c6008772c77d3bfc9520299fc2dd3cd7f3dd3
-  data.tar.gz: 593393d64ca6e63216e0e974c580db50db754fe430d319115aef8610c47d39aa
+  metadata.gz: 471a0ae8e462a056c196ebf128f02f3f30ff3a100c10aff2d2c010757d6d942e
+  data.tar.gz: d78cf8473f40b241ee412a00d819be124a244acda1f487f20e105dee1cba9842
 SHA512:
-  metadata.gz: 2b0ffb33c0c11b423cb59d594362a0c2c071a685a2ad7d4837cbdc3bb1d6a494bdcce8ff1cb3d19cfb0078ac5f167912a9d2f93c44f173d2821b415fe9cbd92e
-  data.tar.gz: c6b6989f3c75226641847feee4e4e8a73326da2a006bbbd52ce7544c7c4ffb3bf1f4a659a15f0b70f14590b1fe0392062099f6ced43134b2a3d81000d5a350f9
+  metadata.gz: 77617bc6668796730c67d33621d497a8a454a6208d7f42d7c28ecb26e940da2e4edee6b3aefd8fc98b301d8480a13f14c1f6b292ff7f4d29b6030e601cdc1b08
+  data.tar.gz: d7b851826c9dde19201f2fb48b5f4b5ff0cd9a2421f4770ed3fdbc1c340943b9d0c3b3703b26646e46dfb012dca0c2a10728c568786ac4c381ab1431dc191695

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

@@ -16,6 +16,7 @@ module Bashly
       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
@@ -29,8 +30,8 @@ module Bashly
 
       def run
         validate_config
-        ENV['BASHLY_ENV'] = args['--env'] if args['--env']
-        quiet_say "creating !txtgrn!production!txtrst! version" if Bashly.production?
+        Settings.env = args['--env'] if args['--env']
+        quiet_say "creating !txtgrn!production!txtrst! version" if Settings.production?
         create_user_files
         upgrade_libs if args['--upgrade']
         create_master_script
@@ -114,7 +115,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

data/lib/bashly/concerns/renderable.rb

@@ -15,7 +15,7 @@ module Bashly
 
     def view_marker(id = nil)
       id ||= ":#{caller_locations.first.path}"
-      "# #{id}" unless Bashly.production?
+      "# #{id}" unless Settings.production?
     end
 
   private

data/lib/bashly/config_validator.rb

@@ -138,7 +138,7 @@ module Bashly
 
       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']
@@ -161,6 +161,11 @@ module Bashly
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
       assert_array "#{key}.examples", value['examples'], of: :string
 
+      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['group'], "#{key}.group makes no sense"

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

@@ -40,7 +40,7 @@ module Bashly
 
       # Returns a string suitable to be a headline
       def caption_string
-        help ? "#{full_name} - #{summary}" : full_name
+        help.empty? ? full_name : "#{full_name} - #{summary}"
       end
 
       def catch_all
@@ -94,15 +94,16 @@ module Bashly
       # If the file is not found, returns a string with a hint.
       def load_user_file(file, placeholder: true)
         path = "#{Settings.source_dir}/#{file}"
-        default_content = placeholder ? "echo \"error: cannot load file\"" : ''
 
         content = if File.exist? path
           File.read(path).remove_front_matter
-        else 
-          default_content
+        elsif placeholder
+          %q[echo "error: cannot load file"]
+        else
+          ''
         end
 
-        Bashly.production? ? content : "#{view_marker path}\n#{content}"
+        Settings.production? ? content : "#{view_marker path}\n#{content}"
       end
 
       # Returns an array of all parents. For example, the command 
@@ -111,7 +112,12 @@ module Bashly
         options['parents'] || []
       end
 
-      # Returns trus if this is the root command (no parents)
+      # Returns true if one of the args is repeatable
+      def repeatable_arg_exist?
+        args.select(&:repeatable).any?
+      end
+
+      # Returns true if this is the root command (no parents)
       def root_command?
         parents.empty?
       end

data/lib/bashly/script/wrapper.rb

@@ -9,18 +9,22 @@ module Bashly
         @command, @function_name = command, function_name
       end
 
-      def code
-        if function_name
-          result = [header, render('wrapper')].join "\n"
+      def code(tab_indent: false)
+        tab_indent ? base_code.expand_tabs : base_code
+      end
+
+    private
+
+      def base_code
+        result = if function_name
+          [header, render('wrapper')]
         else
-          result = [header, body].join "\n"
+          [header, body]
         end
 
-        result.lint
+        result.join("\n").lint
       end
 
-    private
-
       def header
         @header ||= header!
       end

data/lib/bashly/settings.rb

@@ -1,27 +1,56 @@
 module Bashly
   class Settings
     class << self
-      attr_writer :source_dir, :target_dir, :lib_dir, :strict
+      attr_writer :source_dir, :target_dir, :lib_dir, :strict, :tab_indent
 
       def source_dir
-        @source_dir ||= ENV['BASHLY_SOURCE_DIR'] || 'src'
+        @source_dir ||= get :source_dir, 'src'
       end
 
       def target_dir
-        @target_dir ||= ENV['BASHLY_TARGET_DIR'] || '.'
+        @target_dir ||= get :target_dir, '.'
       end
 
       def lib_dir
-        @lib_dir ||= ENV['BASHLY_LIB_DIR'] || 'lib'
+        @lib_dir ||= get :lib_dir, 'lib'
       end
 
       def strict
-        @strict ||= ENV['BASHLY_STRICT']
+        @strict ||= get :strict
+      end
+
+      def tab_indent
+        @tab_indent ||= get :tab_indent
+      end
+
+      def env
+        @env ||= get(:env, :development)&.to_sym
+      end
+
+      def env=(value)
+        @env = value&.to_sym
+      end
+
+      def production?
+        env == :production
       end
 
       def full_lib_dir
         "#{source_dir}/#{lib_dir}"
       end
+
+    private
+
+      def get(key, default = nil)
+        ENV["BASHLY_#{key.upcase}"] || user_settings[key.to_s] || default
+      end
+
+      def user_settings
+        @user_settings ||= begin
+          File.exist?('settings.yml') ? Config.new('settings.yml') : {}
+        end
+      end
+
     end
   end
 end

data/lib/bashly/templates/settings.yml

@@ -0,0 +1,24 @@
+# All settings are optional (with their default values provided below), and
+# can also be set with an environment variable with the same name, capitalized
+# and prefixed by `BASHLY_` - for example: BASHLY_SOURCE_DIR
+
+# The path containing the bashly configuration and source files
+source_dir: src
+
+# The path to use for creating the bash script
+target_dir: .
+
+# The path to use for upgrading library files, relative to the source dir
+lib_dir: lib
+
+# When true, enable bash strict mode (set -euo pipefail)
+strict: false
+
+# When true, the generated script will use tab indentation instead of spaces
+# (every 2 leading spaces will be converted to a tab character)
+tab_indent: false
+
+# Set to 'production' or 'development':
+# - production    generate a smaller script, without file markers
+# - development   generate with file markers
+env: development

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.7.9"
+  VERSION = "0.7.10"
 end

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

@@ -1,38 +1,8 @@
 <%= view_marker %>
-% repeatable_arg = false
-% if args.any?
-% condition = "if"
-% args.each do |arg|
-<%= condition %> [[ -z ${args[<%= arg.name %>]+x} ]]; then
-<%= arg.render(:validations).indent 2 %>
-% if arg.repeatable
-% repeatable_arg = true
-  args[<%= arg.name %>]="\"$1\""
-  shift
-else
-  args[<%= arg.name %>]="${args[<%= arg.name %>]} \"$1\""
-  shift
-% else
-  args[<%= arg.name %>]=$1
-  shift
-% end
-% condition = "elif"
-% end
-% if !repeatable_arg
-else
-% end
 % if catch_all.enabled?
-  other_args+=("$1")
-  shift
-% elsif !repeatable_arg
-  printf "<%= strings[:invalid_argument] %>\n" "$key"
-  exit 1
-% end
-fi
-% elsif catch_all.enabled?
-  other_args+=("$1")
-  shift
-% elsif !repeatable_arg
-printf "<%= strings[:invalid_argument] %>\n" "$key"
-exit 1
+<%= render(:parse_requirements_case_catch_all) %>
+% elsif repeatable_arg_exist?
+<%= render(:parse_requirements_case_repeatable) %>
+% else
+<%= render(:parse_requirements_case_simple) %>
 % end

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

@@ -0,0 +1,18 @@
+<%= view_marker %>
+% if args.any?
+% condition = "if"
+% args.each do |arg|
+<%= condition %> [[ -z ${args[<%= arg.name %>]+x} ]]; then
+<%= arg.render(:validations).indent 2 %>
+  args[<%= arg.name %>]=$1
+  shift
+% condition = "elif"
+% end
+else
+  other_args+=("$1")
+  shift
+fi
+% else
+other_args+=("$1")
+shift
+% end

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

@@ -0,0 +1,18 @@
+<%= view_marker %>
+% condition = "if"
+% args.each do |arg|
+<%= condition %> [[ -z ${args[<%= arg.name %>]+x} ]]; then
+<%= arg.render(:validations).indent 2 %>
+% if arg.repeatable
+  args[<%= arg.name %>]="\"$1\""
+  shift
+else
+  args[<%= arg.name %>]="${args[<%= arg.name %>]} \"$1\""
+  shift
+% else
+  args[<%= arg.name %>]=$1
+  shift
+% end
+% condition = "elif"
+% end
+fi

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

@@ -0,0 +1,18 @@
+<%= view_marker %>
+% if args.any?
+% condition = "if"
+% args.each do |arg|
+<%= condition %> [[ -z ${args[<%= arg.name %>]+x} ]]; then
+<%= arg.render(:validations).indent 2 %>
+  args[<%= arg.name %>]=$1
+  shift
+% condition = "elif"
+% end
+else
+  printf "<%= strings[:invalid_argument] %>\n" "$key"
+  exit 1
+fi
+% else
+printf "<%= strings[:invalid_argument] %>\n" "$key"
+exit 1
+% end

data/lib/bashly/views/flag/case.erb

@@ -1,30 +1,4 @@
 <%= view_marker %>
 <%= aliases.join " | " %> )
 <%= render(:conflicts).indent 2 %>
-% if arg
-  if [[ -n ${2+x} ]]; then
-<%= render(:validations).indent 4 %>
-% if repeatable
-    if [[ -z ${args[<%= name %>]+x} ]]; then
-      args[<%= name %>]="\"$2\""
-    else
-      args[<%= name %>]="${args[<%= name %>]} \"$2\""
-    fi
-% else
-    args[<%= name %>]="$2"
-% end
-    shift
-    shift
-  else
-    printf "%s\n" "<%= strings[:flag_requires_an_argument] % { name: name, usage: usage_string } %>"
-    exit 1
-  fi
-% else
-% if repeatable
-  (( args[<%= name %>]+=1 ))
-% else
-  args[<%= name %>]=1
-% end
-  shift
-% end
-  ;;
+<%= render(arg ? :case_arg : :case_no_arg).indent 2 %>

data/lib/bashly/views/flag/case_arg.erb

@@ -0,0 +1,19 @@
+<%= view_marker %>
+if [[ -n ${2+x} ]]; then
+<%= render(:validations).indent 2 %>
+% if repeatable
+  if [[ -z ${args[<%= name %>]+x} ]]; then
+    args[<%= name %>]="\"$2\""
+  else
+    args[<%= name %>]="${args[<%= name %>]} \"$2\""
+  fi
+% else
+  args[<%= name %>]="$2"
+% end
+  shift
+  shift
+else
+  printf "%s\n" "<%= strings[:flag_requires_an_argument] % { name: name, usage: usage_string } %>"
+  exit 1
+fi
+;;

data/lib/bashly/views/flag/case_no_arg.erb

@@ -0,0 +1,8 @@
+<%= view_marker %>
+% if repeatable
+(( args[<%= name %>]+=1 ))
+% else
+args[<%= name %>]=1
+% end
+shift
+;;

data/lib/bashly.rb

@@ -15,15 +15,3 @@ requires 'bashly/script/base'
 requires 'bashly/commands/base'
 requires 'bashly/libraries/base'
 requires 'bashly'
-
-module Bashly
-  class << self
-    def env
-      ENV['BASHLY_ENV']&.to_sym
-    end
-
-    def production?
-      env == :production
-    end
-  end
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.7.9
+  version: 0.7.10
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-02 00:00:00.000000000 Z
+date: 2022-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -121,6 +121,7 @@ files:
 - lib/bashly/templates/lib/validations/validate_not_empty.sh
 - lib/bashly/templates/lib/yaml.sh
 - lib/bashly/templates/minimal.yml
+- lib/bashly/templates/settings.yml
 - lib/bashly/templates/strings.yml
 - lib/bashly/templates/test/approvals.bash
 - lib/bashly/version.rb
@@ -145,6 +146,9 @@ files:
 - lib/bashly/views/command/normalize_input.erb
 - lib/bashly/views/command/parse_requirements.erb
 - lib/bashly/views/command/parse_requirements_case.erb
+- lib/bashly/views/command/parse_requirements_case_catch_all.erb
+- lib/bashly/views/command/parse_requirements_case_repeatable.erb
+- lib/bashly/views/command/parse_requirements_case_simple.erb
 - lib/bashly/views/command/parse_requirements_while.erb
 - lib/bashly/views/command/required_args_filter.erb
 - lib/bashly/views/command/required_flags_filter.erb
@@ -163,6 +167,8 @@ files:
 - lib/bashly/views/command/whitelist_filter.erb
 - lib/bashly/views/environment_variable/usage.erb
 - lib/bashly/views/flag/case.erb
+- lib/bashly/views/flag/case_arg.erb
+- lib/bashly/views/flag/case_no_arg.erb
 - lib/bashly/views/flag/conflicts.erb
 - lib/bashly/views/flag/usage.erb
 - lib/bashly/views/flag/validations.erb