bashly 0.7.8 → 0.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d05f653ff5439edd7108eaff3c6265926dc4e894453fce1c59bc4727c4c98d1f
-  data.tar.gz: 39afd30e66779103285d9df99f74f4e3cc8af61220d15a6b1cb02b21a4bebe57
+  metadata.gz: 2ef923a576e9bb9e16ec9f78c96c6008772c77d3bfc9520299fc2dd3cd7f3dd3
+  data.tar.gz: 593393d64ca6e63216e0e974c580db50db754fe430d319115aef8610c47d39aa
 SHA512:
-  metadata.gz: 8db8291a3db5a496626676942eddcadb61f7080ab316ed17652af5f58376e40efa85473e7a665a3966dbbfdbc37b6662577a3e13b50d9f49c36a87792854cefc
-  data.tar.gz: c844bf07c523c6f04a21874a08e3c2c40fafe4562829f419f77fd17f74ebaa70b5006e61c50b430399dcca00158f9d4b4fdb7afe4dfeb2e3a425c8eb544fcc22
+  metadata.gz: 2b0ffb33c0c11b423cb59d594362a0c2c071a685a2ad7d4837cbdc3bb1d6a494bdcce8ff1cb3d19cfb0078ac5f167912a9d2f93c44f173d2821b415fe9cbd92e
+  data.tar.gz: c6b6989f3c75226641847feee4e4e8a73326da2a006bbbd52ce7544c7c4ffb3bf1f4a659a15f0b70f14590b1fe0392062099f6ced43134b2a3d81000d5a350f9

data/lib/bashly/cli.rb

@@ -6,7 +6,8 @@ module Bashly
   class CLI
     def self.runner
       runner = MisterBin::Runner.new version: Bashly::VERSION,
-        header: "Bashly - Bash CLI Generator"
+        header: "Bashly - Bash CLI Generator",
+        footer: "Help: !txtpur!bashly COMMAND --help!txtrst!\nDocs: !undblu!https://bashly.dannyb.co"
 
       runner.route 'init',      to: Commands::Init
       runner.route 'preview',   to: Commands::Preview

data/lib/bashly/commands/generate.rb

@@ -3,24 +3,34 @@ module Bashly
     class Generate < Base
       help "Generate the bash script and required files"
 
-      usage "bashly generate [--force --quiet --upgrade --wrap FUNCTION]"
+      usage "bashly generate [options]"
       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"
+      option "-e --env ENV", "Force the generation environment (see BASHLY_ENV)"
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
       environment "BASHLY_TARGET_DIR", "The path to use for creating the bash script [default: .]"
       environment "BASHLY_LIB_DIR", "The path to use for upgrading library files, relative to the source dir [default: lib]"
       environment "BASHLY_STRICT", "When not empty, enable bash strict mode (set -euo pipefail)"
+      environment "BASHLY_ENV", <<~EOF
+        Set to 'production' or 'development':
+        - production    generate a smaller script, without file markers
+        - development   generate with file markers
+
+        Can be overridden with --env [default: development]
+      EOF
 
       example "bashly generate --force"
       example "bashly generate --wrap my_function"
 
       def run
         validate_config
+        ENV['BASHLY_ENV'] = args['--env'] if args['--env']
+        quiet_say "creating !txtgrn!production!txtrst! version" if Bashly.production?
         create_user_files
         upgrade_libs if args['--upgrade']
         create_master_script

data/lib/bashly/concerns/renderable.rb

@@ -4,13 +4,20 @@ module Bashly
   module Renderable
     def render(view)
       template = File.read view_path(view)
-      ERB.new(template, trim_mode: '%-').result(binding)
+      erb = ERB.new(template, trim_mode: '%-')
+      erb.filename = "#{views_subfolder}.#{view}"
+      erb.result binding
     end
 
     def strings
       @strings ||= MessageStrings.new
     end
 
+    def view_marker(id = nil)
+      id ||= ":#{caller_locations.first.path}"
+      "# #{id}" unless Bashly.production?
+    end
+
   private
 
     def view_path(view)

data/lib/bashly/config_validator.rb

@@ -42,8 +42,13 @@ module Bashly
       end
     end
 
-    def assert_hash(key, value)
+    def assert_hash(key, value, whitelist = nil)
       assert value.is_a?(Hash), "#{key} must be a hash"
+      
+      if whitelist
+        invalid_keys = value.keys.map(&:to_sym) - whitelist
+        assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join(', ')}"
+      end
     end
 
     def assert_version(key, value)
@@ -61,6 +66,7 @@ module Bashly
     end
 
     def assert_catch_all_hash(key, value)
+      assert_hash key, value, Script::CatchAll.option_keys
       assert_string "#{key}.label", value['label']
       assert_optional_string "#{key}.help", value['help']
       assert_boolean "#{key}.required", value['required']
@@ -73,7 +79,7 @@ module Bashly
     end
 
     def assert_arg(key, value)
-      assert_hash key, value
+      assert_hash key, value, Script::Argument.option_keys
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.default", value['default']
@@ -89,7 +95,7 @@ module Bashly
     end
 
     def assert_flag(key, value)
-      assert_hash key, value
+      assert_hash key, value, Script::Flag.option_keys
       assert value['short'] || value['long'], "#{key} must have at least one of long or short name"
 
       assert_optional_string "#{key}.long", value['long']
@@ -99,6 +105,7 @@ module Bashly
       assert_optional_string "#{key}.default", value['default']
       assert_optional_string "#{key}.validate", value['validate']
       
+      assert_boolean "#{key}.repeatable", value['repeatable']
       assert_boolean "#{key}.required", value['required']
       assert_array "#{key}.allowed", value['allowed'], of: :string
       assert_array "#{key}.conflicts", value['conflicts'], of: :string
@@ -119,7 +126,7 @@ module Bashly
     end
 
     def assert_env_var(key, value)
-      assert_hash key, value
+      assert_hash key, value, Script::EnvironmentVariable.option_keys
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.default", value['default']
@@ -127,7 +134,7 @@ module Bashly
     end
 
     def assert_command(key, value)
-      assert_hash key, value
+      assert_hash key, value, Script::Command.option_keys
 
       refute value['commands'] && value['args'], "#{key} cannot have both commands and args"
       refute value['commands'] && value['flags'], "#{key} cannot have both commands and flags"
@@ -139,6 +146,7 @@ module Bashly
       assert_optional_string "#{key}.group", value['group']
       assert_optional_string "#{key}.filename", value['filename']
 
+      assert_boolean "#{key}.private", value['private']
       assert_boolean "#{key}.default", value['default']
       assert_version "#{key}.version", value['version']
       assert_catch_all "#{key}.catch_all", value['catch_all']

data/lib/bashly/extensions/yaml.rb

@@ -3,6 +3,8 @@ module YAML
   def self.properly_load_file(path)
     YAML.load_file path, aliases: true
   rescue ArgumentError
+    # :nocov:
     YAML.load_file path
+    # :nocov:
   end
 end

data/lib/bashly/script/argument.rb

@@ -1,8 +1,20 @@
 module Bashly
   module Script
     class Argument < Base
+      class << self
+        def option_keys
+          @option_keys ||= %i[
+            allowed default help name repeatable required validate
+          ]
+        end
+      end
+
       def usage_string
-        required ? name.upcase : "[#{name.upcase}]"
+        required ? label : "[#{label}]"
+      end
+
+      def label
+        repeatable ? "#{name.upcase}..." : name.upcase
       end
     end
   end

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,18 @@ module Bashly
       include Completions
       include CommandScopes
 
+      class << self
+        def option_keys
+          @option_keys ||= %i[
+            args catch_all commands completions
+            default dependencies environment_variables examples
+            extensible filename filters flags
+            footer group help name
+            private short version
+          ]
+        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
@@ -90,7 +102,7 @@ module Bashly
           default_content
         end
 
-        "# :#{path}\n#{content}"
+        Bashly.production? ? content : "#{view_marker path}\n#{content}"
       end
 
       # Returns an array of all parents. For example, the command 

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/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.7.8"
+  VERSION = "0.7.9"
 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,18 +1,30 @@
-# :command.parse_requirements_case
+<%= view_marker %>
+% repeatable_arg = false
 % if args.any?
 % condition = "if"
 % args.each do |arg|
 <%= condition %> [[ -z ${args[<%= arg.name %>]+x} ]]; then
 <%= arg.render(:validations).indent 2 %>
+% if arg.repeatable
+% repeatable_arg = true
+  args[<%= arg.name %>]="\"$1\""
+  shift
+else
+  args[<%= arg.name %>]="${args[<%= arg.name %>]} \"$1\""
+  shift
+% else
   args[<%= arg.name %>]=$1
   shift
+% end
 % condition = "elif"
 % end
+% if !repeatable_arg
 else
+% end
 % if catch_all.enabled?
   other_args+=("$1")
   shift
-% else
+% elsif !repeatable_arg
   printf "<%= strings[:invalid_argument] %>\n" "$key"
   exit 1
 % end
@@ -20,7 +32,7 @@ fi
 % elsif catch_all.enabled?
   other_args+=("$1")
   shift
-% else
+% elsif !repeatable_arg
 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 -%>

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

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

@@ -1,4 +1,4 @@
-# :command.version_command
+<%= view_marker %>
 version_command() {
   echo "$version"
 }

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

@@ -1,10 +1,20 @@
-# :command.whitelist_filter
+<%= view_marker %>
 % whitelisted_args.each do |arg|
+% if arg.repeatable
+eval "input_array=(${args[<%= arg.name %>]})"
+for i in "${input_array[@]}"; do
+  if [[ ! $i =~ ^(<%= arg.allowed.join '|' %>)$ ]]; then
+    printf "%s\n" "<%= strings[:disallowed_argument] % { name: arg.name, allowed: arg.allowed.join(', ') } %>"
+    exit 1
+  fi
+done
+% else
 if [[ ! ${args[<%= arg.name %>]} =~ ^(<%= arg.allowed.join '|' %>)$ ]]; then
   printf "%s\n" "<%= strings[:disallowed_argument] % { name: arg.name, allowed: arg.allowed.join(', ') } %>"
   exit 1
 fi
 % end
+% end
 % whitelisted_flags.each do |flag|
 % if flag.repeatable
 eval "input_array=(${args[<%= flag.name %>]})"

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

@@ -1,4 +1,4 @@
-# :environment_variable.usage
+<%= view_marker %>
 echo "  <%= usage_string extended: true %>"
 printf "<%= help.wrap(76).indent(4).sanitize_for_print %>\n"
 % if default

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

@@ -1,4 +1,4 @@
-# :flag.case
+<%= view_marker %>
 <%= aliases.join " | " %> )
 <%= render(:conflicts).indent 2 %>
 % if arg

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

@@ -1,4 +1,4 @@
-# :flag.conflicts
+<%= view_marker %>
 % if conflicts
 % if conflicts.count == 1
 if [[ -n "${args[<%= conflicts.first %>]:-}" ]]; then

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

@@ -1,4 +1,4 @@
-# :flag.usage
+<%= view_marker %>
 echo "  <%= usage_string extended: true %>"
 printf "<%= help.wrap(76).indent(4).sanitize_for_print %>\n"
 % if allowed

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

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

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

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

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

@@ -1,4 +1,4 @@
-# :script.wrapper
+<%= view_marker %>
 <%= function_name %>() {
 <%= body.indent 2 %>
 }

data/lib/bashly.rb

@@ -15,3 +15,15 @@ requires 'bashly/script/base'
 requires 'bashly/commands/base'
 requires 'bashly/libraries/base'
 requires 'bashly'
+
+module Bashly
+  class << self
+    def env
+      ENV['BASHLY_ENV']&.to_sym
+    end
+
+    def production?
+      env == :production
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.7.9
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole