bashly 0.7.0 → 0.7.4

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/script/base.rb

@@ -16,6 +16,7 @@ module Bashly
         environment_variables
         examples
         extensible
+        filters
         flags
         footer
         group
@@ -23,6 +24,7 @@ module Bashly
         long
         name
         parent_name
+        private
         required
         short
         validate
@@ -32,7 +34,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 +54,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/script/command.rb

@@ -2,6 +2,7 @@ module Bashly
   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/version.rb

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

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

@@ -1,7 +1,7 @@
 # :command.catch_all_filter
-% if catch_all_required?
+% if catch_all.required?
 if [[ ${#other_args[@]} -eq 0 ]]; then
-  printf "<%= strings[:missing_required_argument] % { arg: catch_all_label, usage: usage_string } %>\n"
+  printf "<%= strings[:missing_required_argument] % { arg: catch_all.label, usage: usage_string } %>\n"
   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.

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

@@ -1,3 +1,3 @@
-echo "# this file is located in '<%= Settings.source_dir %>/root_command.sh'"
+echo "# this file is located in '<%= "#{Settings.source_dir}/#{filename}" %>'"
 echo "# you can edit it freely and regenerate (it will not be overwritten)"
 inspect_args

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

@@ -6,7 +6,7 @@ export <%= env_var.name.upcase %>="${<%= env_var.name.upcase %>:-<%= env_var.def
 % end
 % if required_environment_variables.any?
 % required_environment_variables.each do |env_var|
-if [[ -z "$<%= env_var.name.upcase %>" ]]; then
+if [[ -z "${<%= env_var.name.upcase %>:-}" ]]; then
   printf "<%= strings[:missing_required_environment_variable] % { var: env_var.name.upcase } %>\n"
   exit 1
 fi

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

@@ -1,5 +1,5 @@
 # :command.fixed_flag_filter
-case "$1" in
+case "${1:-}" in
 % if short_flag_exist? "-v"
 --version )
 % else

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

@@ -2,7 +2,7 @@
 initialize() {
   version="<%= version %>"
   long_usage=''
-  set -e
+  <%= ENV['BASHLY_STRICT'] ? "set -euo pipefail" : "set -e" %>
 
 <%= load_user_file("initialize.sh", placeholder: false).indent 2 %>
 }

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

@@ -7,6 +7,7 @@ parse_requirements() {
 <%= render(:fixed_flags_filter).indent 2 %>
 <%= render(:environment_variables_filter).indent 2 %>
 <%= render(:dependencies_filter).indent 2 %>
+<%= render(:user_filter).indent 2 %>
 <%= render(:command_filter).indent 2 %>
 <%= render(:parse_requirements_while).indent 2 %>
 <%= render(:required_args_filter).indent 2 %>

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

@@ -9,7 +9,7 @@
 % condition = "elif"
 % end
 else
-% if catch_all
+% if catch_all.enabled?
   other_args+=("$1")
   shift
 % else
@@ -17,7 +17,7 @@ else
   exit 1
 % end
 fi
-% elsif catch_all
+% elsif catch_all.enabled?
   other_args+=("$1")
   shift
 % else

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

@@ -7,8 +7,8 @@ while [[ $# -gt 0 ]]; do
 
 % end
 
-  -* )
-% if catch_all
+  -?* )
+% if catch_all.enabled?
     other_args+=("$1")
     shift
     ;;

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

@@ -1,4 +1,4 @@
 # :command.root_command
 root_command() {
-<%= load_user_file("root_command.sh").indent 2 %>
+<%= load_user_file(filename).indent 2 %>
 }

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

@@ -1,15 +1,15 @@
 # :command.run
 run() {
-  declare -A args
-  declare -a other_args
-  declare -a input
+  declare -A args=()
+  declare -a other_args=()
+  declare -a input=()
   normalize_input "$@"
   parse_requirements "${input[@]}"
 
   <%- condition = "if" -%>
   <%- deep_commands.each do |command| -%>
   <%= condition %> [[ $action == "<%= command.action_name %>" ]]; then
-    if [[ ${args[--help]} ]]; then
+    if [[ ${args[--help]:-} ]]; then
       long_usage=yes
       <%= command.function_name %>_usage
     else

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

@@ -37,7 +37,7 @@
     printf "<%= strings[:options] %>\n"
 <%= render(:usage_fixed_flags).indent 4 %>
 <%= render(:usage_flags).indent 4 if flags.any? %>
-<%= render(:usage_args).indent 4 if args.any? or catch_all_help %>
+<%= render(:usage_args).indent 4 if args.any? or catch_all.help %>
 <%= render(:usage_environment_variables).indent 4 if environment_variables.any? %>
 <%= render(:usage_examples).indent 4 if examples %>
 <%= render(:footer).indent 4 if footer %>

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

@@ -6,9 +6,9 @@ printf "<%= strings[:arguments] %>\n"
 <%= arg.render(:usage) %>
 % end
 % end
-% if catch_all_help
+% if catch_all.help
 
-echo "  <%= catch_all_label %>"
-printf "<%= catch_all_help.wrap(76).indent(4).sanitize_for_print %>\n"
+echo "  <%= catch_all.label %>"
+printf "<%= catch_all.help.wrap(76).indent(4).sanitize_for_print %>\n"
 echo
 % end

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

@@ -3,7 +3,7 @@
 printf "<%= strings[:commands] %>\n"
 % end
 % maxlen = command_names.map(&:size).max
-% commands.each do |command|
+% commands.reject(&:private).each do |command|
 % summary = command.summary
 % summary = strings[:default_command_summary] % { summary: summary } if command.default
 % if command.group

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

@@ -0,0 +1,11 @@
+# :command.user_filter
+% if filters
+% filters.each do |filter|
+filter_error=$(filter_<%= filter %>)
+if [[ -n $filter_error ]]; then
+  echo "$filter_error"
+  exit 1
+fi
+
+% end
+% end

data/lib/bashly.rb

@@ -9,7 +9,8 @@ requires 'bashly/concerns'
 
 requires 'bashly/settings'
 requires 'bashly/exceptions'
+requires 'bashly/refinements'
 requires 'bashly/script/base'
 requires 'bashly/commands/base'
-requires 'bashly/library/base'
+requires 'bashly/libraries/base'
 requires 'bashly'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2022-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: mister_bin
   requirement: !ruby/object:Gem::Requirement
@@ -82,28 +82,29 @@ files:
 - lib/bashly/commands/generate.rb
 - lib/bashly/commands/init.rb
 - lib/bashly/commands/preview.rb
+- lib/bashly/commands/validate.rb
 - lib/bashly/concerns/asset_helper.rb
+- lib/bashly/concerns/command_scopes.rb
 - lib/bashly/concerns/completions.rb
 - lib/bashly/concerns/renderable.rb
 - lib/bashly/config.rb
+- lib/bashly/config_validator.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/libraries.yml
+- lib/bashly/libraries/base.rb
+- lib/bashly/libraries/completions.rb
+- lib/bashly/libraries/completions_function.rb
+- lib/bashly/libraries/completions_script.rb
+- lib/bashly/libraries/completions_yaml.rb
+- lib/bashly/library.rb
 - lib/bashly/message_strings.rb
+- lib/bashly/refinements/compose_refinements.rb
 - lib/bashly/script/argument.rb
 - lib/bashly/script/base.rb
+- lib/bashly/script/catch_all.rb
 - lib/bashly/script/command.rb
 - lib/bashly/script/environment_variable.rb
 - lib/bashly/script/flag.rb
@@ -154,6 +155,7 @@ files:
 - lib/bashly/views/command/usage_examples.erb
 - lib/bashly/views/command/usage_fixed_flags.erb
 - lib/bashly/views/command/usage_flags.erb
+- lib/bashly/views/command/user_filter.erb
 - lib/bashly/views/command/user_lib.erb
 - lib/bashly/views/command/version_command.erb
 - lib/bashly/views/command/whitelist_filter.erb
@@ -187,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator

data/lib/bashly/library/base.rb

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

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