bashly 0.6.9 → 0.7.3

data/lib/bashly/libraries/completions_script.rb

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

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,6 +23,7 @@ module Bashly
         long
         name
         parent_name
+        private
         required
         short
         validate
@@ -32,7 +33,7 @@ module Bashly
       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
@@ -52,9 +53,9 @@ module Bashly
         respond_to?(method_name) ? options[key] : super
       end
 
-      def respond_to?(method_name, include_private = false)
+      def respond_to_missing?(method_name, include_private = false)
         OPTION_KEYS.include?(method_name) || super
       end
     end
   end
-end
+end

data/lib/bashly/script/catch_all.rb

@@ -0,0 +1,49 @@
+module Bashly
+  module Script
+    class CatchAll
+      class << self
+        def from_config(config)
+          options = case config
+          when nil
+            { enabled: false }
+          when String
+            { label: config }
+          when Hash
+            { label: config['label'], help: config['help'], required: config['required'] }
+          else
+            {}
+          end
+
+          new **options
+        end
+      end
+
+      def initialize(label: nil, help: nil, required: false, enabled: true)
+        @label, @help, @required, @enabled = label, help, required, enabled
+      end
+
+      def enabled?
+        @enabled
+      end
+
+      def label
+        enabled? ? "#{@label&.upcase}..." : nil
+      end
+
+      def help
+        enabled? ? @help : nil
+      end
+
+      def required?
+        @required
+      end
+
+      def usage_string
+        return nil unless enabled?
+        required? ? label : "[#{label}]"
+      end
+
+    end
+  end
+end
+

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

@@ -1,7 +1,8 @@
 module Bashly
-  module Models
+  module Script
     class Command < Base
       include Completions
+      include CommandScopes
 
       # Returns the name to be used as an action.
       # - If it is the root command, the action is "root"
@@ -30,44 +31,8 @@ module Bashly
         help ? "#{full_name} - #{summary}" : full_name
       end
 
-      # 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
-          "..."
-        end
-      end
-
-      # Returns a used defined help string for the catch_all directive
-      def catch_all_help
-        return nil unless catch_all
-
-        if catch_all.is_a?(Hash) and catch_all['help'].is_a?(String)
-          catch_all['help']
-        else
-          nil
-        end
-      end
-
-      # Returns true if catch_all is required
-      def catch_all_required?
-        catch_all.is_a?(Hash) and catch_all['required']
-      end
-
-      # Returns a string suitable for catch_all Usage pattern
-      def catch_all_usage
-        return nil unless catch_all
-        catch_all_required? ? catch_all_label : "[#{catch_all_label}]"
-      end
-
-      # Returns only the names of the Commands
-      def command_names
-        commands.map &:name
+      def catch_all
+        @catch_all ||= CatchAll.from_config options['catch_all']
       end
 
       # Returns an array of the Commands
@@ -79,40 +44,6 @@ module Bashly
         end
       end
 
-      # Returns a flat array containing all the commands in this tree.
-      # This includes self + children + grandchildres + ...
-      def deep_commands
-        result = []
-        commands.each do |command|
-          result << command
-          if command.commands.any?
-            result += command.deep_commands
-          end
-        end
-        result
-      end
-
-      # Returns an array of all the default Args
-      def default_args
-        args.select &:default
-      end
-
-      # If any of this command's subcommands has the default option set to
-      # true, this default command will be returned, nil otherwise.
-      def default_command
-        commands.find { |c| c.default }
-      end
-
-      # Returns an array of all the default Environment Variables
-      def default_environment_variables
-        environment_variables.select &:default
-      end
-
-      # Returns an array of all the default Flags
-      def default_flags
-        flags.select &:default
-      end
-
       # Returns an array of EnvironmentVariables
       def environment_variables
         return [] unless options["environment_variables"]
@@ -124,7 +55,7 @@ module Bashly
       # Returns the bash filename that is expected to hold the user code
       # for this command
       def filename
-        "#{action_name.to_underscore}_command.sh"
+        options["filename"] || "#{action_name.to_underscore}_command.sh"
       end
 
       # Returns an array of Flags
@@ -154,7 +85,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
@@ -168,21 +99,6 @@ module Bashly
         options['parents'] || []
       end
 
-      # Returns an array of all the required Arguments
-      def required_args
-        args.select &:required
-      end
-
-      # Returns an array of all the required EnvironmentVariables
-      def required_environment_variables
-        environment_variables.select &:required
-      end
-
-      # Returns an array of all the required Flags
-      def required_flags
-        flags.select &:required
-      end
-
       # Returns trus if this is the root command (no parents)
       def root_command?
         parents.empty?
@@ -201,7 +117,7 @@ module Bashly
           result << arg.usage_string
         end
         result << "[options]" unless flags.empty?
-        result << catch_all_usage if catch_all
+        result << catch_all.usage_string if catch_all.enabled?
         result.join " "
       end
 
@@ -213,27 +129,9 @@ module Bashly
       end
 
       # Raise an exception if there are some serious issues with the command
-      # definition.
-      def verify
-        verify_commands if commands.any?
-      end
-
-      # Returns an array of all the args with a whitelist
-      def whitelisted_args
-        args.select &:allowed
-      end
-
-      # Returns an array of all the flags with a whitelist arg
-      def whitelisted_flags
-        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
+      # definition. This is called by Base#initialize.
+      def validate_options
+        Bashly::ConfigValidator.new(options).validate
       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

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

@@ -1,18 +1,15 @@
-# ---
-# 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 output will be disabled if `NO_COLOR` environment variable is set
-# in compliance with https://no-color.org/
-#
-# ---
-
+## 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

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

@@ -1,3 +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

@@ -1,3 +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

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