bashly 0.6.6 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e61f83f8d8f8b4992a5f7d66731de37d640dd1da71c8bc243558ba173f56a76c
-  data.tar.gz: c85eb4ea1c11c97c494b969075553f3a341bc29ac44ba94a4763d5efe1b03af0
+  metadata.gz: 13bbac52a39c2f6afb768d043911861a31f8e6abc8ff1472340a13c2834d5944
+  data.tar.gz: 54c4fea2c664dcd0c6aace3360004d715d87b5d4ed98ffd7d3ccdc6c0a120406
 SHA512:
-  metadata.gz: 1685fa4d73c0bc652e3043e8686e39b8ce7571f7baa41e5c84fa5dcce01a49331fd65af7a817bdbd0b985200c9a0502565bfece80414d58b3eed2b1729be101d
-  data.tar.gz: d20da15898e3792bb6efeb7257d0b4a21dc6c0adc5dca00b72411dd37acfd61a926427ec70264058fd276c509c24d7a5d7b7235f66b74b075d86ff1266b2163f
+  metadata.gz: f1c273771d9048c074fb9551ba4521e9cb38c98a819f53647186822155898f767b7dd95093642e01464788378833d4dd9e408efecf304a9feb1ba09ebf2edef3
+  data.tar.gz: efbdad6c22cfe1b7fbb46533db42f4c14b828259efeb5ede1099e20980ad505773af36897e27f8c6c7b25538a523427e63c1a5dac7ff958d753ae3810caf5eb9

data/README.md

@@ -40,7 +40,7 @@ a [docker image](https://hub.docker.com/r/dannyben/bashly).
    file for you ([example](https://github.com/DannyBen/bashly/tree/master/examples/minimal#bashlyyml)).
 2. Bashly then automatically generates a bash script (when you run
    `bashly generate`) that can parse and validate user input, provide help
-   messages, and run your code for each command ([example](https://github.com/DannyBen/bashly/blob/master/examples/minimal/download)).
+   messages, and run your code for each command.
 3. Your code for each command is kept in a separate file, and can be merged
    again if you change it ([example](https://github.com/DannyBen/bashly/blob/master/examples/minimal/src/root_command.sh)).
 
@@ -67,11 +67,13 @@ Bashly is responsible for:
 ## Contributing / Support
 
 If you experience any issue, have a question or a suggestion, or if you wish
-to contribute, feel free to [open an issue][issues].
+to contribute, feel free to [open an issue][issues] or
+[start a discussion][discussions].
 
 
 
 [issues]: https://github.com/DannyBen/bashly/issues
+[discussions]: https://github.com/DannyBen/bashly/discussions
 [docs]: https://bashly.dannyb.co/
 [examples]: https://github.com/DannyBen/bashly/tree/master/examples#bashly-examples
 

data/lib/bashly/commands/add.rb

@@ -8,7 +8,8 @@ module Bashly
       usage "bashly add config [--force]"
       usage "bashly add colors [--force]"
       usage "bashly add yaml [--force]"
-      usage "bashly add comp FORMAT [OUTPUT]"
+      usage "bashly add validations [--force]"
+      usage "bashly add comp FORMAT [OUTPUT --force]"
       usage "bashly add (-h|--help)"
 
       option "-f --force", "Overwrite existing files"
@@ -21,6 +22,7 @@ module Bashly
       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 "comp", "Generate a bash completions script or function."
 
       example "bashly add strings --force"
@@ -30,119 +32,81 @@ module Bashly
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
 
       def strings_command
-        safe_copy asset("templates/strings.yml"), "#{Settings.source_dir}/bashly-strings.yml"
+        add_lib Library::Strings.new
       end
 
       def lib_command
-        safe_copy_lib "sample_function.sh"
+        add_lib Library::Sample.new
       end
 
       def config_command
-        safe_copy_lib "config.sh"
+        add_lib Library::Config.new
       end
 
       def colors_command
-        safe_copy_lib "colors.sh"
+        add_lib Library::Colors.new
       end
 
       def yaml_command
-        safe_copy_lib "yaml.sh"
+        add_lib Library::YAML.new
+      end
+
+      def validations_command
+        add_lib Library::Validations.new
       end
 
       def comp_command
         format = args['FORMAT']
         output = args['OUTPUT']
-        
+
         case format
+        when "script"
+          path = output || "#{Settings.target_dir}/completions.bash"
+          add_lib Library::CompletionsScript.new(path)
+        
         when "function"
-          save_comp_function output
+          function = output || "send_completions"
+          path = "#{Settings.source_dir}/lib/#{function}.sh"
+          add_lib Library::CompletionsFunction.new(path, function: function)
+
         when "yaml"
-          save_comp_yaml output
-        when "script"
-          save_comp_script output
+          path = output || "#{Settings.target_dir}/completions.yml"
+          add_lib Library::CompletionsYAML.new(path)
+        
         else
           raise Error, "Unrecognized format: #{format}"
+
         end
 
       end
 
     private
 
-      def safe_copy_lib(libfile)
-        safe_copy asset("templates/lib/#{libfile}"), "#{Settings.source_dir}/lib/#{libfile}"
+      def add_lib(handler)
+        files_created = 0
+        handler.files.each do |file|
+          created = safe_write file[:path], file[:content]
+          files_created += 1 if created
+        end
+        message = handler.post_install_message
+        say "\n#{message}" if message and files_created > 0
       end
 
-      def safe_copy(source, target)
+      def safe_write(path, content)
         if !Dir.exist? Settings.source_dir
           raise InitError, "Directory !txtgrn!#{Settings.source_dir}!txtrst! does not exist\nRun !txtpur!bashly init!txtrst! first"
         end
 
-        if File.exist? target and !args['--force']
-          say "skipped !txtgrn!#{target}!txtrst! (exists)"
+        if File.exist? path and !args['--force']
+          say "!txtblu!skipped!txtrst! #{path} (exists)"
+          false
+        
         else
-          deep_copy source, target
-          say "created !txtgrn!#{target}"
-        end
-      end
-
-      def deep_copy(source, target)
-        target_dir = File.dirname target
-        FileUtils.mkdir_p target_dir unless Dir.exist? target_dir
-        FileUtils.cp source, target
-      end
-
-      def config
-        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
-      end
-
-      def command
-        @command ||= Models::Command.new config
-      end
-
-      def completions
-        @completions ||= command.completion_data
-      end
-
-      def completions_script
-        @completions_script ||= command.completion_script
-      end
-
-      def completions_function
-        @completions_function ||= command.completion_function
-      end
-
-      def save_comp_yaml(filename = nil)
-        filename ||= "#{Settings.target_dir}/completions.yml"
-        File.write filename, completions.to_yaml
-        say "created !txtgrn!#{filename}"
-        say ""
-        say "This file can be converted to a completions script using the !txtgrn!completely!txtrst! gem."
-      end
-
-      def save_comp_script(filename = nil)
-        filename ||= "#{Settings.target_dir}/completions.bash"
-        File.write filename, completions_script
-        say "created !txtgrn!#{filename}"
-        say ""
-        say "In order to enable completions, run:"
-        say ""
-        say "  !txtpur!$ source #{filename}"
-      end
-
-      def save_comp_function(name = nil)
-        name ||= "send_completions"
-        target_dir = "#{Settings.source_dir}/lib"
-        filename = "#{target_dir}/#{name}.sh"
+          File.deep_write path, content
+          say "!txtgrn!created!txtrst! #{path}"
+          true
         
-        FileUtils.mkdir_p target_dir unless Dir.exist? target_dir
-        File.write filename, completions_function
-
-        say "created !txtgrn!#{filename}"
-        say ""
-        say "In order to use it 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!#{name}!txtrst! function."
-        say "Your users can then run something like this to enable completions:"
-        say ""
-        say "  !txtpur!$ eval \"$(#{command.name} completions)\""
+        end
       end
 
     end

data/lib/bashly/commands/generate.rb

@@ -3,10 +3,12 @@ module Bashly
     class Generate < Base
       help "Generate the bash script and required files"
 
-      usage "bashly generate [--force --wrap FUNCTION]"
+      usage "bashly generate [--force --quiet --upgrade --wrap FUNCTION]"
       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"
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
@@ -17,14 +19,57 @@ module Bashly
 
       def run
         create_user_files
+        upgrade_libs if args['--upgrade']
         create_master_script
-        say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script"
+        quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script"
       end
 
     private
 
+      def quiet_say(message)
+        say message unless args['--quiet']
+      end
+
+      def upgrade_libs
+        generated_files.each do |file|
+          content = File.read file
+          
+          if content =~ /\[@bashly-upgrade (.+)\]/
+            lib = $1
+            
+            case lib
+            when "colors"
+              upgrade file, Library::Colors.new
+            when "config"
+              upgrade file, Library::Config.new
+            when "yaml"
+              upgrade file, Library::YAML.new
+            when "validations"
+              upgrade file, Library::Validations.new
+            when /completions (.+)/
+              upgrade file, Library::CompletionsFunction.new(file, function: $1)
+            end
+          end
+        end
+      end
+
+      def generated_files
+        Dir["#{Settings.source_dir}/**/*.*"].sort
+      end
+
+      def upgrade(existing_file, handler)
+        file = handler.files.select { |f| f[:path] == existing_file }.first
+
+        if file
+          File.deep_write file[:path], file[:content]
+          quiet_say "!txtcyn!updated!txtrst! #{file[:path]}"
+        else
+          quiet_say "!txtred!warning!txtrst! not upgrading !txtcyn!#{existing_file}!txtrst!, path mismatch"
+        end
+      end
+
       def create_user_files
-        say "creating user files in !txtgrn!#{Settings.source_dir}"
+        quiet_say "creating user files in !txtgrn!#{Settings.source_dir}"
 
         create_file "#{Settings.source_dir}/initialize.sh", command.render(:default_initialize_script)
 
@@ -50,21 +95,21 @@ module Bashly
 
       def create_file(file, content)
         if File.exist? file and !args['--force']
-          say "skipped !txtgrn!#{file}!txtrst! (exists)"
+          quiet_say "!txtblu!skipped!txtrst! #{file} (exists)"
         else
           File.write file, content
-          say "created !txtgrn!#{file}"
+          quiet_say "!txtgrn!created!txtrst! #{file}"
         end
       end
 
       def create_master_script
         File.write master_script_path, script.code
         FileUtils.chmod "+x", master_script_path
-        say "created !txtgrn!#{master_script_path}"
+        quiet_say "!txtgrn!created!txtrst! #{master_script_path}"
       end
 
       def script
-        @script ||= Models::Script.new(command, args['--wrap'])
+        @script ||= Script::Wrapper.new(command, args['--wrap'])
       end
 
       def master_script_path
@@ -76,7 +121,7 @@ module Bashly
       end
 
       def command
-        @command ||= Models::Command.new config
+        @command ||= Script::Command.new config
       end
 
     end

data/lib/bashly/commands/init.rb

@@ -17,7 +17,7 @@ module Bashly
         end
         Dir.mkdir target_dir unless Dir.exist? target_dir
         File.write "#{target_dir}/bashly.yml", yaml_content
-        say "created !txtgrn!#{target_dir}/bashly.yml"
+        say "!txtgrn!created!txtrst! #{target_dir}/bashly.yml"
         say "run !txtpur!bashly generate!txtrst! to create the bash script"
       end
 

data/lib/bashly/commands/preview.rb

@@ -10,8 +10,8 @@ module Bashly
 
       def run
         config = Config.new "#{Settings.source_dir}/bashly.yml"
-        command = Models::Command.new(config)
-        script = Models::Script.new command
+        command = Script::Command.new(config)
+        script = Script::Wrapper.new command
         puts script.code
       end
     end

data/lib/bashly/concerns/asset_helper.rb

@@ -3,5 +3,9 @@ module Bashly
     def asset(path)
       File.expand_path "../#{path}", __dir__
     end
+
+    def asset_content(path)
+      File.read asset(path)
+    end
   end
 end

data/lib/bashly/concerns/completions.rb

@@ -31,12 +31,16 @@ module Bashly
       flags.map(&:name) + flags.map(&:short)
     end
 
+    def completion_allowed_args
+      flags.map(&:allowed).flatten + args.map(&:allowed).flatten
+    end
+
     def completion_words(with_version: false)
       trivial_flags = %w[--help -h]
       trivial_flags += %w[--version -v] if with_version
       all = (
         command_names + trivial_flags +
-        completion_flag_names
+        completion_flag_names + completion_allowed_args
       )
 
       all += completions if completions

data/lib/bashly/extensions/file.rb

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

data/lib/bashly/extensions/string.rb

@@ -24,7 +24,7 @@ class String
   end
 
   def lint
-    gsub(/\n{2,}/, "\n\n")
+    gsub(/\s+\n/m, "\n\n").lines.reject { |l| l =~ /^\s*##/ }.join ""
   end
 
 end

data/lib/bashly/library/base.rb

@@ -0,0 +1,57 @@
+module Bashly
+  module Library
+    class Base
+      include AssetHelper
+
+      attr_reader :target_path, :options
+
+      def initialize(target_path = nil, options = nil)
+        @target_path = target_path || Settings.source_dir
+        @options = options || {}
+      end
+
+      def files
+        case content
+        when String then content_from_string content
+        when Hash then [content]
+        else content
+        end
+      end
+
+      def post_install_message
+        nil
+      end
+
+      def content
+        raise NotImplementedError, "Please implement either #content"
+      end
+
+    private
+
+      def content_from_string(string)
+        if File.directory? asset("templates/lib/#{string}")
+          content_for_dir string
+        else
+          [content_for_file(string)]
+        end
+      end
+
+      def content_for_file(file)
+        {
+          path: "#{target_path}/lib/#{file}",
+          content: asset_content("templates/lib/#{file}")
+        }
+      end
+
+      def content_for_dir(dir)
+        Dir[asset("templates/lib/#{dir}/*.sh")].sort.map do |file|
+          {
+            path: "#{target_path}/lib/#{dir}/#{File.basename file}",
+            content: File.read(file)
+          }
+        end
+      end
+
+    end
+  end
+end

data/lib/bashly/library/colors.rb

@@ -0,0 +1,9 @@
+module Bashly
+  module Library
+    class Colors < Base
+      def content
+        "colors.sh"
+      end
+    end
+  end
+end

data/lib/bashly/library/completions.rb

@@ -0,0 +1,28 @@
+module Bashly
+  module Library
+    class Completions < Base
+      def content
+        { path: target_path, content: file_content }
+      end
+
+      def file_content
+        raise NotImplementedError, "Please implement #file_content"
+      end
+
+    protected
+
+      def completions
+        @completions ||= command.completion_data
+      end
+
+      def config
+        @config ||= Bashly::Config.new "#{Settings.source_dir}/bashly.yml"
+      end
+
+      def command
+        @command ||= Script::Command.new config
+      end
+   
+    end
+  end
+end

data/lib/bashly/library/completions_function.rb

@@ -0,0 +1,26 @@
+module Bashly
+  module Library
+    class CompletionsFunction < Completions
+      def file_content
+        [
+          "# [@bashly-upgrade completions #{function_name}]",
+          command.completion_function(function_name)
+        ].join "\n"
+      end
+
+      def post_install_message
+        <<~EOF
+          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
+      end
+
+      def function_name
+        options[:function]
+      end
+    end
+  end
+end

data/lib/bashly/library/completions_script.rb

@@ -0,0 +1,17 @@
+module Bashly
+  module Library
+    class CompletionsScript < Completions
+      def file_content
+        command.completion_script
+      end
+
+      def post_install_message
+        <<~EOF
+          In order to enable completions, run:
+
+            !txtpur!$ source #{target_path}
+        EOF
+      end
+    end
+  end
+end

data/lib/bashly/library/completions_yaml.rb

@@ -0,0 +1,15 @@
+module Bashly
+  module Library
+    class CompletionsYAML < Completions
+      def file_content
+        completions.to_yaml
+      end
+
+      def post_install_message
+        <<~EOF
+          This file can be converted to a completions script using the !txtgrn!completely!txtrst! gem.
+        EOF
+      end
+    end
+  end
+end

data/lib/bashly/library/config.rb

@@ -0,0 +1,9 @@
+module Bashly
+  module Library
+    class Config < Base
+      def content
+        "config.sh"
+      end
+    end
+  end
+end

data/lib/bashly/library/sample.rb

@@ -0,0 +1,9 @@
+module Bashly
+  module Library
+    class Sample < Base
+      def content
+        "sample_function.sh"
+      end
+    end
+  end
+end

data/lib/bashly/library/strings.rb

@@ -0,0 +1,12 @@
+module Bashly
+  module Library
+    class Strings < Base
+      def content
+        {
+          path: "#{target_path}/bashly-strings.yml",
+          content: asset_content("templates/strings.yml")
+        }
+      end
+    end
+  end
+end

data/lib/bashly/library/validations.rb

@@ -0,0 +1,9 @@
+module Bashly
+  module Library
+    class Validations < Base
+      def content
+        "validations"
+      end
+    end
+  end
+end

data/lib/bashly/library/yaml.rb

@@ -0,0 +1,9 @@
+module Bashly
+  module Library
+    class YAML < Base
+      def content
+        "yaml.sh"
+      end
+    end
+  end
+end

data/lib/bashly/{models → script}/argument.rb

@@ -1,5 +1,5 @@
 module Bashly
-  module Models
+  module Script
     class Argument < Base
       def usage_string
         required ? name.upcase : "[#{name.upcase}]"

data/lib/bashly/{models → script}/base.rb

@@ -1,5 +1,5 @@
 module Bashly
-  module Models
+  module Script
     class Base
       include Renderable
 
@@ -25,6 +25,7 @@ module Bashly
         parent_name
         required
         short
+        validate
         version
       ]
 

data/lib/bashly/{models → script}/command.rb

@@ -1,5 +1,5 @@
 module Bashly
-  module Models
+  module Script
     class Command < Base
       include Completions
 

data/lib/bashly/{models → script}/environment_variable.rb

@@ -1,5 +1,5 @@
 module Bashly
-  module Models
+  module Script
     class EnvironmentVariable < Base
       def usage_string(extended: false)
         result = [name.upcase]

data/lib/bashly/{models → script}/flag.rb

@@ -1,5 +1,5 @@
 module Bashly
-  module Models
+  module Script
     class Flag < Base
       def aliases
         if long and short

data/lib/bashly/{models/script.rb → script/wrapper.rb}

@@ -1,6 +1,6 @@
 module Bashly
-  module Models
-    class Script
+  module Script
+    class Wrapper
       include Renderable
 
       attr_reader :command, :function_name
@@ -22,12 +22,30 @@ module Bashly
     private
 
       def header
-        @header ||= render('header')
+        @header ||= header!
+      end
+
+      def header!
+        if File.exist? custom_header_path
+          File.read custom_header_path
+        else
+          default_header
+        end
+      end
+
+      def default_header
+        result = render('header')
+        result += render('bash3_bouncer') unless function_name
+        result
       end
 
       def body
         @body ||= command.render('master_script')
       end
+
+      def custom_header_path
+        @custom_header_path ||= "#{Settings.source_dir}/header.sh"
+      end
     end
   end
 end

data/lib/bashly/templates/lib/colors.sh

@@ -1,32 +1,42 @@
-# ---
-# Color functions
-# This file is a part of Bashly standard library
-#
-# Usage:
-# Use any of the functions below to color or format a portion of a string.
-# 
-#   echo "before $(red this is red) after"
-#   echo "before $(green_bold this is green_bold) after"
-#
-# ---
+## Color functions [@bashly-upgrade colors]
+## This file is a part of Bashly standard library
+##
+## Usage:
+## Use any of the functions below to color or format a portion of a string.
+##
+##   echo "before $(red this is red) after"
+##   echo "before $(green_bold this is green_bold) after"
+##
+## Color output will be disabled if `NO_COLOR` environment variable is set
+## in compliance with https://no-color.org/
+##
+print_in_color() {
+  local color="$1"
+  shift
+  if [[ -z ${NO_COLOR+x} ]]; then
+    printf "$color%b\e[0m\n" "$*";
+  else
+    printf "%b\n" "$*";
+  fi
+}
 
-red() { printf "\e[31m%b\e[0m\n" "$*"; }
-green() { printf "\e[32m%b\e[0m\n" "$*"; }
-yellow() { printf "\e[33m%b\e[0m\n" "$*"; }
-blue() { printf "\e[34m%b\e[0m\n" "$*"; }
-magenta() { printf "\e[35m%b\e[0m\n" "$*"; }
-cyan() { printf "\e[36m%b\e[0m\n" "$*"; }
-bold() { printf "\e[1m%b\e[0m\n" "$*"; }
-underlined() { printf "\e[4m%b\e[0m\n" "$*"; }
-red_bold() { printf "\e[1;31m%b\e[0m\n" "$*"; }
-green_bold() { printf "\e[1;32m%b\e[0m\n" "$*"; }
-yellow_bold() { printf "\e[1;33m%b\e[0m\n" "$*"; }
-blue_bold() { printf "\e[1;34m%b\e[0m\n" "$*"; }
-magenta_bold() { printf "\e[1;35m%b\e[0m\n" "$*"; }
-cyan_bold() { printf "\e[1;36m%b\e[0m\n" "$*"; }
-red_underlined() { printf "\e[4;31m%b\e[0m\n" "$*"; }
-green_underlined() { printf "\e[4;32m%b\e[0m\n" "$*"; }
-yellow_underlined() { printf "\e[4;33m%b\e[0m\n" "$*"; }
-blue_underlined() { printf "\e[4;34m%b\e[0m\n" "$*"; }
-magenta_underlined() { printf "\e[4;35m%b\e[0m\n" "$*"; }
-cyan_underlined() { printf "\e[4;36m%b\e[0m\n" "$*"; }
+red() { print_in_color "\e[31m" "$*"; }
+green() { print_in_color "\e[32m" "$*"; }
+yellow() { print_in_color "\e[33m" "$*"; }
+blue() { print_in_color "\e[34m" "$*"; }
+magenta() { print_in_color "\e[35m" "$*"; }
+cyan() { print_in_color "\e[36m" "$*"; }
+bold() { print_in_color "\e[1m" "$*"; }
+underlined() { print_in_color "\e[4m" "$*"; }
+red_bold() { print_in_color "\e[1;31m" "$*"; }
+green_bold() { print_in_color "\e[1;32m" "$*"; }
+yellow_bold() { print_in_color "\e[1;33m" "$*"; }
+blue_bold() { print_in_color "\e[1;34m" "$*"; }
+magenta_bold() { print_in_color "\e[1;35m" "$*"; }
+cyan_bold() { print_in_color "\e[1;36m" "$*"; }
+red_underlined() { print_in_color "\e[4;31m" "$*"; }
+green_underlined() { print_in_color "\e[4;32m" "$*"; }
+yellow_underlined() { print_in_color "\e[4;33m" "$*"; }
+blue_underlined() { print_in_color "\e[4;34m" "$*"; }
+magenta_underlined() { print_in_color "\e[4;35m" "$*"; }
+cyan_underlined() { print_in_color "\e[4;36m" "$*"; }

data/lib/bashly/templates/lib/config.sh

@@ -1,27 +1,27 @@
-# ---
-# Config functions
-# This file is a part of Bashly standard library
-#
-# Usage:
-# - In your script, set the CONFIG_FILE variable. For rxample:
-#   CONFIG_FILE=settings.ini.
-#   If it is unset, it will default to 'config.ini'.
-# - Use any of the functions below to access the config file.
-# ---
-
-# Create a new config file.
-# There is normally no need to use this function, it is used by other
-# functions as needed.
+## Config functions [@bashly-upgrade config]
+## This file is a part of Bashly standard library
+##
+## Usage:
+## - In your script, set the CONFIG_FILE variable. For rxample:
+##   CONFIG_FILE=settings.ini.
+##   If it is unset, it will default to 'config.ini'.
+## - Use any of the functions below to access the config file.
+##
+## Create a new config file.
+## There is normally no need to use this function, it is used by other
+## functions as needed.
+##
 config_init() {
   CONFIG_FILE=${CONFIG_FILE:=config.ini}
   [[ -f "$CONFIG_FILE" ]] || touch "$CONFIG_FILE"
 }
 
-# Get a value from the config.
-# Usage: result=$(config_get hello)
+## Get a value from the config.
+## Usage: result=$(config_get hello)
 config_get() {
-  key=$1
-  regex="^$key *= *(.+)$"
+  local key=$1
+  local regex="^$key *= *(.+)$"
+  local value=""
 
   config_init
   
@@ -35,18 +35,19 @@ config_get() {
   echo "$value"
 }
 
-# Add or update a key=value pair in the config.
-# Usage: config_set key value
+## Add or update a key=value pair in the config.
+## Usage: config_set key value
 config_set() {
-  key=$1
+  local key=$1
   shift
-  value="$*"
+  local value="$*"
 
   config_init
 
-  regex="^($key) *= *.+$"
-  output=""
-  found_key=""
+  local regex="^($key) *= *.+$"
+  local output=""
+  local found_key=""
+  local newline
   
   while IFS= read -r line || [ -n "$line" ]; do
     newline=$line
@@ -66,18 +67,17 @@ config_set() {
   printf "%b\n" "$output" > "$CONFIG_FILE"
 }
 
-# Delete a key from the config.
-# Usage: config_del key
+## Delete a key from the config.
+## Usage: config_del key
 config_del() {
-  key=$1
+  local key=$1
 
-  regex="^($key) *="
-  output=""
+  local regex="^($key) *="
+  local output=""
 
   config_init
 
   while IFS= read -r line || [ -n "$line" ]; do
-    newline=$line
     if [[ $line ]] && [[ ! $line =~ $regex ]]; then
       output="$output$line\n"
     fi
@@ -86,25 +86,27 @@ config_del() {
   printf "%b\n" "$output" > "$CONFIG_FILE"
 }
 
-# Show the config file
+## Show the config file
 config_show() {
   config_init
   cat "$CONFIG_FILE"
 }
 
-# Return an array of the keys in the config file.
-# Usage:
-#
-#   for k in $(config_keys); do
-#     echo "- $k = $(config_get "$k")";
-#   done
-#
+## Return an array of the keys in the config file.
+## Usage:
+##
+##   for k in $(config_keys); do
+##     echo "- $k = $(config_get "$k")";
+##   done
+##
 config_keys() {
-  regex="^([a-zA-Z0-9_\-\/\.]+) *="
+  local regex="^([a-zA-Z0-9_\-\/\.]+) *="
 
   config_init
 
-  keys=()
+  local keys=()
+  local key
+  
   while IFS= read -r line || [ -n "$line" ]; do
     if [[ $line =~ $regex ]]; then
       key="${BASH_REMATCH[1]}"
@@ -114,13 +116,13 @@ config_keys() {
   echo "${keys[@]}"
 }
 
-# Returns true if the specified key exists in the config file.
-# Usage:
-#
-#   if config_has_key "key" ; then
-#     echo "key exists"
-#   fi
-#
+## Returns true if the specified key exists in the config file.
+## Usage:
+##
+##   if config_has_key "key" ; then
+##     echo "key exists"
+##   fi
+##
 config_has_key() {
   [[ $(config_get "$1") ]]
 }

data/lib/bashly/templates/lib/sample_function.sh

@@ -1,13 +1,13 @@
-# Add any function here that is needed in more than one parts of your
-# application, or that you otherwise wish to extract from the main function
-# scripts.
-#
-# Note that code here should be wrapped inside bash functions, and it is
-# recommended to have a separate file for each function.
-#
-# Subdirectories will also be scanned for *.sh, so you have no reason not
-# to organize your code neatly.
-#
+## Add any function here that is needed in more than one parts of your
+## application, or that you otherwise wish to extract from the main function
+## scripts.
+##
+## Note that code here should be wrapped inside bash functions, and it is
+## recommended to have a separate file for each function.
+##
+## Subdirectories will also be scanned for *.sh, so you have no reason not
+## to organize your code neatly.
+##
 sample_function() {
   echo "it works"
 }

data/lib/bashly/templates/lib/validations/validate_dir_exists.sh

@@ -0,0 +1,4 @@
+## [@bashly-upgrade validations]
+validate_dir_exists() {
+  [[ -d "$1" ]] || echo "must be an existing directory"
+}

data/lib/bashly/templates/lib/validations/validate_file_exists.sh

@@ -0,0 +1,4 @@
+## [@bashly-upgrade validations]
+validate_file_exists() {
+  [[ -f "$1" ]] || echo "must be an existing file"
+}

data/lib/bashly/templates/lib/validations/validate_integer.sh

@@ -0,0 +1,4 @@
+## [@bashly-upgrade validations]
+validate_integer() {
+  [[ "$1" =~ ^[0-9]+$ ]] || echo "must be an integer"
+}

data/lib/bashly/templates/lib/validations/validate_not_empty.sh

@@ -0,0 +1,4 @@
+## [@bashly-upgrade validations]
+validate_not_empty() {
+  [[ -z "$1" ]] && echo "must not be empty"
+}

data/lib/bashly/templates/lib/yaml.sh

@@ -1,18 +1,15 @@
-# ---
-# YAML parser
-# This file is a part of Bashly standard library
-# Does not support arrays, only hashes
-#
-# Source: https://stackoverflow.com/a/21189044/413924
-#
-# Usage:
-#
-#   yaml_load "settings.yml"             # print variables
-#   yaml_load "settings.yml" "config_"   # use prefix
-#   eval $(yaml_load "settings.yml")     # create variables in scope
-#
-# ---
-
+## YAML parser [@bashly-upgrade yaml]
+## This file is a part of Bashly standard library
+## Does not support arrays, only hashes
+##
+## Source: https://stackoverflow.com/a/21189044/413924
+##
+## Usage:
+##
+##   yaml_load "settings.yml"             # print variables
+##   yaml_load "settings.yml" "config_"   # use prefix
+##   eval $(yaml_load "settings.yml")     # create variables in scope
+##
 yaml_load() {
    local prefix=$2
    local s='[[:space:]]*' w='[a-zA-Z0-9_]*'

data/lib/bashly/templates/strings.yml

@@ -32,3 +32,4 @@ missing_dependency: "missing dependency: %{dependency}"
 disallowed_flag: "%{name} must be one of: %{allowed}"
 disallowed_argument: "%{name} must be one of: %{allowed}"
 unsupported_bash_version: "bash version 4 or higher is required"
+validation_error: "validation error in %s:\\n%s"

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.6.6"
+  VERSION = "0.7.0"
 end

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

@@ -0,0 +1,8 @@
+# :argument.validations
+% if validate
+if [[ -n $(validate_<%= validate %> "$1") ]]; then
+  printf "<%= strings[:validation_error] %>\n" "<%= name.upcase %>" "$(validate_<%= validate %> "$1")"
+  exit 1
+fi
+
+% end

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

@@ -4,10 +4,5 @@ initialize() {
   long_usage=''
   set -e
 
-  if [[ "${BASH_VERSINFO:-0}" -lt 4 ]]; then
-    printf "<%= strings[:unsupported_bash_version] -%>\n"
-    exit 1
-  fi
-
 <%= load_user_file("initialize.sh", placeholder: false).indent 2 %>
 }

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

@@ -8,9 +8,9 @@ parse_requirements() {
 <%= render(:environment_variables_filter).indent 2 %>
 <%= render(:dependencies_filter).indent 2 %>
 <%= render(:command_filter).indent 2 %>
+<%= render(:parse_requirements_while).indent 2 %>
 <%= render(:required_args_filter).indent 2 %>
 <%= render(:required_flags_filter).indent 2 %>
-<%= render(:parse_requirements_while).indent 2 %>
 <%= render(:catch_all_filter).indent 2 %>
 <%= render(:default_assignments).indent 2 %>
 <%= render(:whitelist_filter).indent 2 %>

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

@@ -2,7 +2,8 @@
 % if args.any?
 % condition = "if"
 % args.each do |arg|
-<%= condition %> [[ ! ${args[<%= arg.name %>]} ]]; then
+<%= condition %> [[ -z ${args[<%= arg.name %>]+x} ]]; then
+<%= arg.render(:validations).indent 2 %>
   args[<%= arg.name %>]=$1
   shift
 % condition = "elif"

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

@@ -1,11 +1,7 @@
 # :command.required_args_filter
 % required_args.each do |arg|
-if [[ $1 && $1 != -* ]]; then
-  args[<%= arg.name %>]=$1
-  shift
-else
+if [[ -z ${args[<%= arg.name %>]+x} ]]; then
   printf "<%= strings[:missing_required_argument] % { arg: arg.name.upcase, usage: usage_string } %>\n"
   exit 1
 fi
-
 % end

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

@@ -1,9 +1,6 @@
 # :command.required_flags_filter
-% if required_flags.any?
-argstring="$*"
-% end
 % required_flags.each do |flag|
-if [[ <%= flag.aliases.map { |a| %Q["$argstring" != *#{a}*] }.join " && " %> ]]; then
+if [[ -z ${args[<%= flag.long %>]+x} ]]; then
   printf "<%= strings[:missing_required_flag] % { usage: flag.usage_string } %>\n"
   exit 1
 fi

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

@@ -1,7 +1,8 @@
 # :flag.case
 <%= aliases.join " | " %> )
 % if arg
-  if [[ $2 ]]; then
+  if [[ -n ${2+x} ]]; then
+<%= render(:validations).indent 4 %>
     args[<%= name %>]="$2"
     shift
     shift

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

@@ -0,0 +1,8 @@
+# :flag.validations
+% if validate
+if [[ -n $(validate_<%= validate %> "$2") ]]; then
+  printf "<%= strings[:validation_error] %>\n" "<%= usage_string %>" "$(validate_<%= validate %> "$2")"
+  exit 1
+fi
+
+% end

data/lib/bashly/views/wrapper/bash3_bouncer.erb

@@ -0,0 +1,5 @@
+# :script.bash3_bouncer
+if [[ "${BASH_VERSINFO:-0}" -lt 4 ]]; then
+  printf "<%= strings[:unsupported_bash_version] -%>\n"
+  exit 1
+fi

data/lib/bashly/views/{script → wrapper}/header.erb

@@ -1,3 +1,4 @@
 #!/usr/bin/env bash
 # This script was generated by bashly (https://github.com/DannyBen/bashly)
 # Modifying it manually is not recommended
+

data/lib/bashly.rb

@@ -9,6 +9,7 @@ requires 'bashly/concerns'
 
 requires 'bashly/settings'
 requires 'bashly/exceptions'
-requires 'bashly/models/base'
+requires 'bashly/script/base'
 requires 'bashly/commands/base'
+requires 'bashly/library/base'
 requires 'bashly'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.7.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -88,24 +88,41 @@ files:
 - lib/bashly/config.rb
 - lib/bashly/exceptions.rb
 - lib/bashly/extensions/array.rb
+- lib/bashly/extensions/file.rb
 - lib/bashly/extensions/string.rb
+- lib/bashly/library/base.rb
+- lib/bashly/library/colors.rb
+- lib/bashly/library/completions.rb
+- lib/bashly/library/completions_function.rb
+- lib/bashly/library/completions_script.rb
+- lib/bashly/library/completions_yaml.rb
+- lib/bashly/library/config.rb
+- lib/bashly/library/sample.rb
+- lib/bashly/library/strings.rb
+- lib/bashly/library/validations.rb
+- lib/bashly/library/yaml.rb
 - lib/bashly/message_strings.rb
-- lib/bashly/models/argument.rb
-- lib/bashly/models/base.rb
-- lib/bashly/models/command.rb
-- lib/bashly/models/environment_variable.rb
-- lib/bashly/models/flag.rb
-- lib/bashly/models/script.rb
+- lib/bashly/script/argument.rb
+- lib/bashly/script/base.rb
+- lib/bashly/script/command.rb
+- lib/bashly/script/environment_variable.rb
+- lib/bashly/script/flag.rb
+- lib/bashly/script/wrapper.rb
 - lib/bashly/settings.rb
 - lib/bashly/templates/bashly.yml
 - lib/bashly/templates/lib/colors.sh
 - lib/bashly/templates/lib/config.sh
 - lib/bashly/templates/lib/sample_function.sh
+- lib/bashly/templates/lib/validations/validate_dir_exists.sh
+- lib/bashly/templates/lib/validations/validate_file_exists.sh
+- lib/bashly/templates/lib/validations/validate_integer.sh
+- lib/bashly/templates/lib/validations/validate_not_empty.sh
 - lib/bashly/templates/lib/yaml.sh
 - lib/bashly/templates/minimal.yml
 - lib/bashly/templates/strings.yml
 - lib/bashly/version.rb
 - lib/bashly/views/argument/usage.erb
+- lib/bashly/views/argument/validations.erb
 - lib/bashly/views/command/catch_all_filter.erb
 - lib/bashly/views/command/command_fallback.erb
 - lib/bashly/views/command/command_filter.erb
@@ -143,8 +160,10 @@ files:
 - lib/bashly/views/environment_variable/usage.erb
 - lib/bashly/views/flag/case.erb
 - lib/bashly/views/flag/usage.erb
-- lib/bashly/views/script/header.erb
-- lib/bashly/views/script/wrapper.erb
+- lib/bashly/views/flag/validations.erb
+- lib/bashly/views/wrapper/bash3_bouncer.erb
+- lib/bashly/views/wrapper/header.erb
+- lib/bashly/views/wrapper/wrapper.erb
 homepage: https://github.com/dannyben/bashly
 licenses:
 - MIT