bashly 0.7.8 → 0.8.0

data/lib/bashly/script/base.rb

@@ -5,33 +5,11 @@ module Bashly
 
       attr_reader :options
 
-      OPTION_KEYS = %i[
-        allowed
-        arg
-        catch_all
-        completions
-        conflicts
-        default
-        dependencies
-        description
-        environment_variables
-        examples
-        extensible
-        filters
-        flags
-        footer
-        group
-        help
-        long
-        name
-        parent_name
-        private
-        repeatable
-        required
-        short
-        validate
-        version
-      ]
+      class << self
+        def option_keys
+          @option_keys ||= []
+        end
+      end
 
       def initialize(options)
         raise Error, "Invalid options provided" unless options.respond_to? :keys
@@ -39,7 +17,7 @@ module Bashly
       end
 
       def optional
-        !required
+        !options['required']
       end
 
       def summary
@@ -56,7 +34,7 @@ module Bashly
       end
 
       def respond_to_missing?(method_name, include_private = false)
-        OPTION_KEYS.include?(method_name) || super
+        self.class.option_keys.include?(method_name) || super
       end
     end
   end

data/lib/bashly/script/catch_all.rb

@@ -2,6 +2,10 @@ module Bashly
   module Script
     class CatchAll
       class << self
+        def option_keys
+          @option_keys ||= %i[label help required]
+        end
+
         def from_config(config)
           options = case config
           when nil

data/lib/bashly/script/command.rb

@@ -4,6 +4,20 @@ module Bashly
       include Completions
       include CommandScopes
 
+      class << self
+        def option_keys
+          @option_keys ||= %i[
+            alias args catch_all commands completions
+            default dependencies environment_variables examples
+            extensible filename filters flags
+            footer group help name
+            private version
+            short
+          ]
+          # DEPRECATION 0.8.0
+        end
+      end
+
       # Returns the name to be used as an action.
       # - If it is the root command, the action is "root"
       # - Else, it is all the parents, except the first one (root) joined
@@ -15,7 +29,15 @@ module Bashly
 
       # Returns all the possible aliases for this command
       def aliases
-        short ? [name, short] : [name]
+        [name] + alt
+      end
+
+      # Returns an array of alternative aliases if any
+      def alt
+        # DEPRECATION 0.8.0
+        options['alias'] ||= options['short']
+        return [] unless options["alias"]
+        options['alias'].is_a?(String) ? [options['alias']] : options['alias']
       end
 
       # Returns an array of Arguments
@@ -28,7 +50,7 @@ module Bashly
 
       # Returns a string suitable to be a headline
       def caption_string
-        help ? "#{full_name} - #{summary}" : full_name
+        help.empty? ? full_name : "#{full_name} - #{summary}"
       end
 
       def catch_all
@@ -82,15 +104,16 @@ module Bashly
       # If the file is not found, returns a string with a hint.
       def load_user_file(file, placeholder: true)
         path = "#{Settings.source_dir}/#{file}"
-        default_content = placeholder ? "echo \"error: cannot load file\"" : ''
 
         content = if File.exist? path
           File.read(path).remove_front_matter
-        else 
-          default_content
+        elsif placeholder
+          %q[echo "error: cannot load file"]
+        else
+          ''
         end
 
-        "# :#{path}\n#{content}"
+        Settings.production? ? content : "#{view_marker path}\n#{content}"
       end
 
       # Returns an array of all parents. For example, the command 
@@ -99,7 +122,12 @@ module Bashly
         options['parents'] || []
       end
 
-      # Returns trus if this is the root command (no parents)
+      # Returns true if one of the args is repeatable
+      def repeatable_arg_exist?
+        args.select(&:repeatable).any?
+      end
+
+      # Returns true if this is the root command (no parents)
       def root_command?
         parents.empty?
       end

data/lib/bashly/script/environment_variable.rb

@@ -1,6 +1,12 @@
 module Bashly
   module Script
     class EnvironmentVariable < Base
+      class << self
+        def option_keys
+          @option_keys ||= %i[default help name required]
+        end
+      end
+      
       def usage_string(extended: false)
         result = [name.upcase]
         result << strings[:required] if required and extended

data/lib/bashly/script/flag.rb

@@ -1,6 +1,15 @@
 module Bashly
   module Script
     class Flag < Base
+      class << self
+        def option_keys
+          @option_keys ||= %i[
+            allowed arg conflicts default help long repeatable required
+            short validate
+          ]
+        end
+      end
+      
       def aliases
         if long and short
           [long, short]

data/lib/bashly/script/wrapper.rb

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

data/lib/bashly/settings.rb

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

data/lib/bashly/templates/bashly.yml

@@ -8,7 +8,7 @@ environment_variables:
 
 commands:
 - name: download
-  short: d
+  alias: d
   help: Download a file
 
   args:
@@ -32,7 +32,7 @@ commands:
     help: Set the default location to download to
 
 - name: upload
-  short: u
+  alias: u
   help: Upload a file
   args:
   - name: source

data/lib/bashly/templates/settings.yml

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

data/lib/bashly/templates/strings.yml

@@ -11,7 +11,7 @@ environment_variables: "Environment Variables:"
 group: "%{group} Commands:"
 
 # Usage helpers
-command_shortcut: "Shortcut: %{short}"
+command_alias: "Alias: %{alias}"
 default_command_summary: "%{summary} (default)"
 required: "(required)"
 repeatable: "(repeatable)"

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.7.8"
+  VERSION = "0.8.0"
 end

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

@@ -1,5 +1,5 @@
-# :argument.usage
-echo "  <%= name.upcase %>"
+<%= view_marker %>
+echo "  <%= label %>"
 printf "<%= help.wrap(76).indent(4).sanitize_for_print %>\n"
 % if allowed
 printf "    <%= strings[:allowed] % { values: allowed.join(', ') } -%>\n"

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

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

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

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

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

@@ -1,4 +1,4 @@
-# :command.command_fallback
+<%= view_marker %>
 % if default_command
 "" )
   <%= function_name %>_usage

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

@@ -1,4 +1,4 @@
-# :command.command_filter
+<%= view_marker %>
 % if commands.any?
 action=${1:-}
 

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

@@ -1,4 +1,4 @@
-# :command.command_functions
+<%= view_marker %>
 % deep_commands.each do |command|
 <%= command.render :function unless command.commands.any? %>
 % end

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

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

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

@@ -1,4 +1,4 @@
-# :command.dependencies_filter
+<%= view_marker %>
 % if dependencies
 % dependencies.each do |dependency|
 if ! [[ -x "$(command -v <%= dependency %>)" ]]; then

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

@@ -1,4 +1,4 @@
-# :command.environment_variables_filter
+<%= view_marker %>
 % if default_environment_variables.any?
 % default_environment_variables.each do |env_var|
 export <%= env_var.name.upcase %>="${<%= env_var.name.upcase %>:-<%= env_var.default %>}"

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

@@ -1,4 +1,4 @@
-# :command.fixed_flag_filter
+<%= view_marker %>
 case "${1:-}" in
 % if root_command?
 % if short_flag_exist? "-v"

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

@@ -1,2 +1,3 @@
+<%= view_marker %>
 printf "<%= footer.gsub("\n", '\n').gsub('"', '\"') %>\n"
 echo

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

@@ -1,4 +1,4 @@
-# :command.function
+<%= view_marker %>
 <%= function_name %>_command() {
 <%= load_user_file(filename).indent 2 %>
 }

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

@@ -1,4 +1,4 @@
-# :command.initialize
+<%= view_marker %>
 initialize() {
   version="<%= version %>"
   long_usage=''

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

@@ -1,4 +1,4 @@
-# :command.inspect_args
+<%= view_marker %>
 inspect_args() {
   readarray -t sorted_keys < <(printf '%s\n' "${!args[@]}" | sort)
   if (( ${#args[@]} )); then

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

@@ -1,3 +1,4 @@
+<%= view_marker %>
 <%= render :root_command if commands.empty? %>
 <%= render :version_command %>
 <%= render :usage %>

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

@@ -1,4 +1,4 @@
-# :command.normalize_input
+<%= view_marker %>
 normalize_input() {
   local arg flags
 

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

@@ -1,4 +1,4 @@
-# :command.parse_requirements
+<%= view_marker %>
 % if root_command?
 parse_requirements() {
 % else

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

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

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

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-# :command.parse_requirements_while
+<%= view_marker %>
 while [[ $# -gt 0 ]]; do
   key="$1"
   case "$key" in

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

@@ -1,4 +1,4 @@
-# :command.required_args_filter
+<%= view_marker %>
 % required_args.each do |arg|
 if [[ -z ${args[<%= arg.name %>]+x} ]]; then
   printf "<%= strings[:missing_required_argument] % { arg: arg.name.upcase, usage: usage_string } %>\n"

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

@@ -1,4 +1,4 @@
-# :command.required_flags_filter
+<%= view_marker %>
 % required_flags.each do |flag|
 if [[ -z ${args[<%= flag.long %>]+x} ]]; then
   printf "<%= strings[:missing_required_flag] % { usage: flag.usage_string } %>\n"

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

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

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

@@ -1,4 +1,4 @@
-# :command.run
+<%= view_marker %>
 run() {
   declare -A args=()
   declare -a other_args=()

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

@@ -1,4 +1,4 @@
-# :command.usage
+<%= view_marker %>
 <%= function_name %>_usage() {
   if [[ -n $long_usage ]]; then
     <%- if summary == help -%>
@@ -15,8 +15,8 @@
     echo 
   fi
 
-  <%- if short -%>
-  printf "<%= strings[:command_shortcut] % { short: short } %>\n"
+  <%- if alt&.any? -%>
+  printf "<%= strings[:command_alias] % { alias: alt.join(', ') } %>\n"
   echo
   <%- end -%>
 

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

@@ -1,4 +1,4 @@
-# :command.usage_args
+<%= view_marker %>
 printf "<%= strings[:arguments] %>\n"
 % if args.any?
 

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

@@ -1,4 +1,4 @@
-# :command.usage_commands
+<%= view_marker %>
 % unless commands.first.group
 printf "<%= strings[:commands] %>\n"
 % end

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

@@ -1,4 +1,4 @@
-# :command.usage_environment_variables
+<%= view_marker %>
 printf "<%= strings[:environment_variables] %>\n"
 
 % environment_variables.each do |env_var|

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

@@ -1,4 +1,4 @@
-# :command.usage_examples
+<%= view_marker %>
 printf "<%= strings[:examples] %>\n"
 
 % examples.each do |example|

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

@@ -1,4 +1,4 @@
-# :command.usage_fixed_flags
+<%= view_marker %>
 % if short_flag_exist? "-h"
 echo "  --help"
 % else

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

@@ -1,4 +1,4 @@
-# :command.usage_flags
+<%= view_marker %>
 % flags.each do |flag|
 <%= flag.render(:usage) %>
 % end

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

@@ -1,4 +1,4 @@
-# :command.user_filter
+<%= view_marker %>
 % if filters
 % filters.each do |filter|
 filter_error=$(filter_<%= filter %>)

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

@@ -1,6 +1,6 @@
-# :command.user_lib
+<%= view_marker %>
 % user_lib.each do |file|
-# <%= ":#{file}" %>
+<%= view_marker file %>
 <%= File.read file %>
 
 % end