bashly 0.6.7 → 0.7.1

data/lib/bashly/libraries/completions_yaml.rb

@@ -0,0 +1,27 @@
+module Bashly
+  module Libraries
+    class CompletionsYAML < Completions
+      def files
+        [
+          {
+            path: target_path,
+            content: command.completion_data.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
+
+    private
+
+      def target_path
+        @target_path ||= args[0] || "#{Settings.target_dir}/completions.yml"
+      end
+
+    end
+  end
+end

data/lib/bashly/libraries.yml

@@ -0,0 +1,39 @@
+colors:
+  files:
+    - source: "templates/lib/colors.sh"
+      target: "%{user_source_dir}/lib/colors.sh"
+
+config:
+  files:
+    - source: "templates/lib/config.sh"
+      target: "%{user_source_dir}/lib/config.sh"
+
+yaml:
+  files:
+    - source: "templates/lib/yaml.sh"
+      target: "%{user_source_dir}/lib/yaml.sh"
+
+lib:
+  files:
+    - source: "templates/lib/sample_function.sh"
+      target: "%{user_source_dir}/lib/sample_function.sh"
+
+strings:
+  files:
+    - source: "templates/strings.yml"
+      target: "%{user_source_dir}/bashly-strings.yml"
+
+validations:
+  files:
+    - source: "templates/lib/validations/validate_dir_exists.sh"
+      target: "%{user_source_dir}/lib/validations/validate_dir_exists.sh"
+    - source: "templates/lib/validations/validate_file_exists.sh"
+      target: "%{user_source_dir}/lib/validations/validate_file_exists.sh"
+    - source: "templates/lib/validations/validate_integer.sh"
+      target: "%{user_source_dir}/lib/validations/validate_integer.sh"
+    - source: "templates/lib/validations/validate_not_empty.sh"
+      target: "%{user_source_dir}/lib/validations/validate_not_empty.sh"
+
+completions: :CompletionsFunction
+completions_script: :CompletionsScript
+completions_yaml: :CompletionsYAML

data/lib/bashly/library.rb

@@ -0,0 +1,63 @@
+module Bashly
+  class Library
+    class << self
+      def exist?(name)
+        config.has_key? name.to_s
+      end
+
+      def config
+        @config ||= YAML.load_file(config_path)
+      end
+
+      def config_path
+        @config_path ||= File.expand_path 'libraries.yml', __dir__
+      end
+    end
+
+    include AssetHelper
+    attr_reader :name, :args
+
+    def initialize(name, *args)
+      @name, @args = name.to_s, args
+    end
+
+    def files
+      if custom_handler
+        custom_handler.files
+
+      else
+        config['files'].map do |file|
+          { path: file['target'] % target_file_args,
+            content: asset_content(file['source']) }
+        end
+      end
+    end
+
+    def post_install_message
+      if custom_handler
+        custom_handler.post_install_message
+      else
+        config['post_install_message']
+      end
+    end
+
+    def find_file(path)
+      files.select { |f| f[:path] == path }.first
+    end
+
+  private
+
+    def custom_handler
+      return nil unless config.is_a? Symbol
+      @custom_handler ||= Bashly::Libraries.const_get(config).new(*args)
+    end
+
+    def config
+      @config ||= self.class.config[name]
+    end
+
+    def target_file_args
+      { user_source_dir: Settings.source_dir }
+    end
+  end
+end

data/lib/bashly/refinements/compose_refinements.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+
+module ComposeRefinements
+  refine Hash do
+    def compose(keyword = 'import')
+      result = {}
+      each do |k, v|
+        if k.to_s == keyword
+          sub = safe_load_yaml(v).compose keyword
+          if sub.is_a? Array
+            result = sub
+          else
+            result.merge! sub
+          end
+        elsif v.respond_to? :compose
+          result[k] = v.compose keyword
+        else
+          result[k] = v
+        end
+      end
+      result
+    end
+
+    def safe_load_yaml(path)
+      loaded = YAML.load_file path
+      return loaded if loaded.is_a? Array or loaded.is_a? Hash
+      raise Bashly::ConfigurationError, "Cannot find a valid YAML in !txtgrn!#{path}"
+
+    rescue Errno::ENOENT
+      raise Bashly::ConfigurationError, "Cannot find import file !txtgrn!#{path}"
+    end
+  end
+
+  refine Array do
+    def compose(keyword = 'import')
+      map do |x|
+        if x.respond_to? :compose
+          x.compose keyword
+        else
+          x
+        end
+      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
 
@@ -23,15 +23,17 @@ module Bashly
         long
         name
         parent_name
+        private
         required
         short
+        validate
         version
       ]
 
       def initialize(options)
         raise Error, "Invalid options provided" unless options.respond_to? :keys
         @options = options
-        verify if respond_to? :verify
+        validate_options if respond_to? :validate_options
       end
 
       def optional

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

@@ -1,5 +1,5 @@
 module Bashly
-  module Models
+  module Script
     class Command < Base
       include Completions
 
@@ -32,18 +32,15 @@ module Bashly
 
       # Returns a label for the catch_all directive
       def catch_all_label
-        return nil unless catch_all
-
-        if catch_all.is_a? String
-          "#{catch_all.upcase}..."
-        elsif catch_all.is_a?(Hash) and catch_all['label'].is_a?(String)
-          "#{catch_all['label'].upcase}..."
-        else
-          "..."
+        case catch_all
+        when nil then nil
+        when String then "#{catch_all.upcase}..."
+        when Hash then "#{catch_all['label'].upcase}..."
+        else "..."
         end
       end
 
-      # Returns a used defined help string for the catch_all directive
+      # Returns a user defined help string for the catch_all directive
       def catch_all_help
         return nil unless catch_all
 
@@ -154,7 +151,7 @@ module Bashly
         default_content = placeholder ? "echo \"error: cannot load file\"" : ''
 
         content = if File.exist? path
-          File.read path
+          File.read(path).remove_front_matter
         else 
           default_content
         end
@@ -213,9 +210,9 @@ module Bashly
       end
 
       # Raise an exception if there are some serious issues with the command
-      # definition.
-      def verify
-        verify_commands if commands.any?
+      # definition. This is called by Base#initialize.
+      def validate_options
+        Bashly::ConfigValidator.new(options).validate
       end
 
       # Returns an array of all the args with a whitelist
@@ -228,14 +225,6 @@ module Bashly
         flags.select &:allowed
       end
 
-    private
-
-      def verify_commands
-        if args.any? or flags.any?
-          raise ConfigurationError, "Error in the !txtgrn!#{full_name}!txtrst! command.\nThe !txtgrn!commands!txtrst! key cannot be at the same level as the !txtgrn!args!txtrst! or !txtgrn!flags!txtrst! keys."
-        end
-      end
-
     end
   end
 end

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,24 +1,23 @@
-# ---
-# 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() {
   local key=$1
   local regex="^$key *= *(.+)$"
@@ -36,8 +35,8 @@ 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() {
   local key=$1
   shift
@@ -68,8 +67,8 @@ 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() {
   local key=$1
 
@@ -87,19 +86,19 @@ 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() {
   local regex="^([a-zA-Z0-9_\-\/\.]+) *="
 
@@ -117,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.7"
+  VERSION = "0.7.1"
 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/command_filter.erb

@@ -1,6 +1,6 @@
 # :command.command_filter
 % if commands.any?
-action=$1
+action=${1:-}
 
 case $action in
 -* )

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

@@ -1,7 +1,7 @@
 # :command.default_assignments
 % default_args.each do |arg|
-[[ -n ${args[<%= arg.name %>]} ]] || args[<%= arg.name %>]="<%= arg.default %>"
+[[ -n ${args[<%= arg.name %>]:-} ]] || args[<%= arg.name %>]="<%= arg.default %>"
 % end
 % default_flags.each do |flag|
-[[ -n ${args[<%= flag.long %>]} ]] || args[<%= flag.long %>]="<%= flag.default %>"
+[[ -n ${args[<%= flag.long %>]:-} ]] || args[<%= flag.long %>]="<%= flag.default %>"
 % end

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

@@ -1,6 +1,6 @@
-# Code here runs inside the initialize() function
-# Use it for anything that you need to run before any other function, like
-# setting environment vairables:
-# CONFIG_FILE=settings.ini
-#
-# Feel free to empty (but not delete) this file.
+## Code here runs inside the initialize() function
+## Use it for anything that you need to run before any other function, like
+## setting environment vairables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.