bashly 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67c0cd0da5f37edbad28313553ac30b878edae7d2255158d940af0deb8aa0a05
-  data.tar.gz: 6cf9bac796564e7730f3a55e6022d78a962506b418eb00cdecbe1111f3770ffb
+  metadata.gz: e8541b3056b57bf3b312972de9468334a8590dbf9c759a0a099de12230b164e4
+  data.tar.gz: 2ad5a9367d40f95fed80dcb5da2743469237f24e7935ba1d7530459adbc9dfc8
 SHA512:
-  metadata.gz: 16eb355eb439bfc24457b184dd8255c091bb62dc1646c15e6d2842160f8848595de799cb453e54e43cdf5c2605906ed8f8c49ee21f5afda3999c9224b8d6fbc6
-  data.tar.gz: 889722479c576c8b30c3be1081911d0a7f61613664fc146fb4a2867b65d7199a5283464cc59eb40530e2c43f8270fbaa11e7f3a3d851cedc87a71515aef235b8
+  metadata.gz: 1bd9c8ce895b05bae99c0fa658a23816426c10d33ea965cd0186460da5de6e088f3a1c9f6acf5969ef84022db3c10321163a0740966162646b39744855c1984f
+  data.tar.gz: 12a626b4e5875110003c5a8b22ea9b289e63b0e05638ba37d25c353e73b86149e65b7e5b9e5460ae5c356c971057a2cef8d73a472f09f851533d64c665b71f2d

data/README.md

@@ -29,7 +29,12 @@ a [docker image](https://hub.docker.com/r/dannyben/bashly).
 
 ## Bashly is Sponsored By
 
-<a href="https://rhodecode.com/"><img src='support/img/RhodeCode-logo.png' width=280></a>
+<table>
+   <tr>
+      <td><a href="https://rhodecode.com/"><img src='support/img/RhodeCode-logo.png' width=240></a></td>
+      <td><a href="https://decisiohealth.com/"><img src='support/img/decisio-logo.png' width=240></a></td>
+   </tr>
+</table>
 
 
 ## Documentation
@@ -69,7 +74,7 @@ Bashly is responsible for:
   - **Bash completions**.
   - and more.
 
-  ## Contributing / Support
+## Contributing / Support
 
 If you experience any issue, have a question or a suggestion, or if you wish
 to contribute, feel free to [open an issue][issues] or

data/lib/bashly/commands/doc.rb

@@ -75,7 +75,7 @@ module Bashly
       def raw_data
         @raw_data ||= begin
           result = {}
-          Dir["#{docs_dir}/*.yml"].sort.each do |path|
+          Dir["#{docs_dir}/*.yml"].each do |path|
             result.merge! YAML.load_file(path)
           end
           result

data/lib/bashly/commands/generate.rb

@@ -89,7 +89,7 @@ module Bashly
       end
 
       def generated_files
-        Dir["#{Settings.source_dir}/**/*.*"].sort
+        Dir["#{Settings.source_dir}/**/*.*"]
       end
 
       def upgrade(existing_file, library_name, *args)
@@ -125,9 +125,6 @@ module Bashly
       def create_user_files
         quiet_say "creating user files in g`#{Settings.source_dir}`"
 
-        create_file "#{Settings.source_dir}/initialize.#{Settings.partials_extension}",
-          command.render(:default_initialize_script)
-
         if command.commands.empty?
           create_root_command_file
         else

data/lib/bashly/concerns/completions.rb

@@ -29,7 +29,7 @@ module Bashly
           end
         end
 
-        commands.each do |command|
+        public_commands.each do |command|
           result.merge! command.completion_data(with_version: false)
         end
 
@@ -62,7 +62,7 @@ module Bashly
       end
 
       def completion_flag_names
-        flags.map(&:name) + flags.map(&:short)
+        public_flags.map(&:name) + public_flags.map(&:short)
       end
 
       def completion_allowed_args
@@ -73,7 +73,7 @@ module Bashly
         trivial_flags = %w[--help -h]
         trivial_flags += %w[--version -v] if with_version
         all = (
-          command_aliases + trivial_flags +
+          public_command_aliases + trivial_flags +
           completion_flag_names + completion_allowed_args
         )
 

data/lib/bashly/config_validator.rb

@@ -100,14 +100,14 @@ module Bashly
 
       refute value['name'].match(/^-/), "#{key}.name must not start with '-'"
 
-      refute value['required'] && value['default'], "#{key} cannot have both required and default"
+      refute value['required'] && value['default'], "#{key} cannot have both nub`required` and nub`default`"
     end
 
     def assert_flag(key, value)
       assert_hash key, value, keys: Script::Flag.option_keys
-      assert value['short'] || value['long'], "#{key} must have at least one of long or short name"
+      assert value['short'] || value['long'], "#{key} must have at least one of nub`long` or nub`short`"
 
-      refute value['allowed'] && value['completions'], "#{key} cannot have both allowed and completions"
+      refute value['allowed'] && value['completions'], "#{key} cannot have both nub`allowed` and nub`completions`"
 
       assert_optional_string "#{key}.long", value['long']
       assert_optional_string "#{key}.short", value['short']
@@ -127,18 +127,18 @@ module Bashly
       assert value['short'].match(/^-[a-zA-Z0-9]$/), "#{key}.short must be in the form of '-n'" if value['short']
       refute value['arg'].match(/^-/), "#{key}.arg must not start with '-'" if value['arg']
 
-      refute value['required'] && value['default'], "#{key} cannot have both required and default"
+      refute value['required'] && value['default'], "#{key} cannot have both nub`required` and nub`default`"
 
       if value['default']
-        assert value['arg'], "#{key}.default does not make sense without arg"
+        assert value['arg'], "#{key}.default does not make sense without nub`arg`"
       end
 
       if value['allowed']
-        assert value['arg'], "#{key}.allowed does not make sense without arg"
+        assert value['arg'], "#{key}.allowed does not make sense without nub`arg`"
       end
 
       if value['completions']
-        assert value['arg'], "#{key}.completions does not make sense without arg"
+        assert value['arg'], "#{key}.completions does not make sense without nub`arg`"
       end
     end
 
@@ -154,8 +154,8 @@ module Bashly
     def assert_command(key, value)
       assert_hash key, value, keys: Script::Command.option_keys
 
-      refute value['commands'] && value['args'], "#{key} cannot have both commands and args"
-      refute value['commands'] && value['catch_all'], "#{key} cannot have both commands and catch_all"
+      refute value['commands'] && value['args'], "#{key} cannot have both nub`commands` and nub`args`"
+      refute value['commands'] && value['catch_all'], "#{key} cannot have both nub`commands` and nub`catch_all`"
 
       assert_string "#{key}.name", value['name']
       assert_optional_string "#{key}.help", value['help']
@@ -202,7 +202,7 @@ module Bashly
       end
 
       if value['expose']
-        assert value['commands'], "#{key}.expose makes no sense without commands"
+        assert value['commands'], "#{key}.expose makes no sense without nub`commands`"
       end
 
       if key == 'root'

data/lib/bashly/libraries/hooks/initialize.sh

@@ -0,0 +1,6 @@
+## initialize hook
+##
+## Any code here will be placed inside the `initialize()` function and called
+## before running anything else.
+##
+## You can safely delete this file if you do not need it.

data/lib/bashly/libraries/libraries.yml

@@ -30,8 +30,10 @@ help:
   handler: Bashly::Libraries::Help
 
 hooks:
-  help: Add placeholders for before/after hooks which are executed before/after any command.
+  help: Add placeholders for initialize/before/after hooks which are executed on script initialization, and before/after any command.
   files:
+    - source: "hooks/initialize.sh"
+      target: "%{user_source_dir}/initialize.%{user_ext}"
     - source: "hooks/before.sh"
       target: "%{user_source_dir}/before.%{user_ext}"
     - source: "hooks/after.sh"

data/lib/bashly/script/command.rb

@@ -223,6 +223,11 @@ module Bashly
         commands.reject(&:private)
       end
 
+      # Returns a full list of the public Command names and aliases combined
+      def public_command_aliases
+        public_commands.map(&:aliases).flatten
+      end
+
       # Returns only environment variables that are not private
       def public_environment_variables
         environment_variables.reject(&:private)
@@ -297,7 +302,7 @@ module Bashly
       # This is meant to provide the user with the ability to add custom
       # functions
       def user_lib
-        @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.#{Settings.partials_extension}"].sort
+        @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.#{Settings.partials_extension}"]
       end
 
       # Returns an array of all the args with a whitelist

data/lib/bashly/settings.rb

@@ -56,9 +56,9 @@ module Bashly
       end
 
       def strict_string
-        if Settings.strict.is_a? String
-          Settings.strict
-        elsif Settings.strict
+        if strict.is_a? String
+          strict
+        elsif strict
           'set -euo pipefail'
         else
           'set -e'
@@ -101,7 +101,13 @@ module Bashly
       end
 
       def user_settings_path
-        ENV['BASHLY_SETTINGS_PATH'] || 'settings.yml'
+        @user_settings_path ||= if ENV['BASHLY_SETTINGS_PATH']
+          ENV['BASHLY_SETTINGS_PATH']
+        elsif File.exist? 'bashly-settings.yml'
+          'bashly-settings.yml'
+        else
+          'settings.yml'
+        end
       end
 
       def defsult_settings

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.0.2'
+  VERSION = '1.0.4'
 end

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

@@ -6,7 +6,7 @@ if default_args.any? or default_flags.any?
   end
 
   default_flags.each do |flag|
-    > [[ -n ${args['{{ flag.long }}']:-} ]] || args['{{ flag.long }}']="{{ flag.default }}"
+    > [[ -n ${args['{{ flag.name }}']:-} ]] || args['{{ flag.name }}']="{{ flag.default }}"
   end
 
   >

data/lib/bashly/views/command/environment_variables_default.gtx

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

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

@@ -4,13 +4,16 @@
 >   version="<%= version %>"
 >   long_usage=''
 >   {{ Settings.strict_string }}
-> 
 
 if root_command?
+  > 
   = render(:environment_variables_default).indent 2
 end
 
-= load_user_file("initialize", placeholder: false).indent 2
+if user_file_exist?('initialize')
+  > 
+  = load_user_file('initialize').indent 2
+end
 
 > }
 >

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

@@ -2,7 +2,7 @@ if required_flags.any?
   = view_marker
 
   required_flags.each do |flag|
-    > if [[ -z ${args['{{ flag.long }}']+x} ]]; then
+    > if [[ -z ${args['{{ flag.name }}']+x} ]]; then
     >   printf "{{ strings[:missing_required_flag] % { usage: flag.usage_string } }}\n" >&2
     >   exit 1
     > fi

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

@@ -12,7 +12,7 @@ if whitelisted_args.any? or whitelisted_flags.any?
       > done
 
     else
-      > if [[ ! ${args['{{ arg.name }}']} =~ ^({{ arg.allowed.join '|' }})$ ]]; then
+      > if [[ -n ${args['{{ arg.name }}']} ]] && [[ ! ${args['{{ arg.name }}']} =~ ^({{ arg.allowed.join '|' }})$ ]]; then
       >   printf "%s\n" "{{ strings[:disallowed_argument] % { name: arg.name, allowed: arg.allowed.join(', ') } }}" >&2
       >   exit 1
       > fi
@@ -31,7 +31,7 @@ if whitelisted_args.any? or whitelisted_flags.any?
       > done
     
     else
-      > if [[ ! ${args['{{ flag.name }}']} =~ ^({{ flag.allowed.join '|' }})$ ]]; then
+      > if [[ ${args['{{ flag.name }}']} ]] && [[ ! ${args['{{ flag.name }}']} =~ ^({{ flag.allowed.join '|' }})$ ]]; then
       >   printf "%s\n" "{{ strings[:disallowed_flag] % { name: flag.name, allowed: flag.allowed.join(', ') } }}" >&2
       >   exit 1
       > fi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-23 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -157,6 +157,7 @@ files:
 - lib/bashly/libraries/help/help_command.sh
 - lib/bashly/libraries/hooks/after.sh
 - lib/bashly/libraries/hooks/before.sh
+- lib/bashly/libraries/hooks/initialize.sh
 - lib/bashly/libraries/lib/sample_function.sh
 - lib/bashly/libraries/libraries.yml
 - lib/bashly/libraries/settings/settings.yml
@@ -192,7 +193,6 @@ files:
 - lib/bashly/views/command/command_filter.gtx
 - lib/bashly/views/command/command_functions.gtx
 - lib/bashly/views/command/default_assignments.gtx
-- lib/bashly/views/command/default_initialize_script.gtx
 - lib/bashly/views/command/default_root_script.gtx
 - lib/bashly/views/command/default_script.gtx
 - lib/bashly/views/command/dependencies_filter.gtx
@@ -255,14 +255,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator

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

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