bashly 1.2.2 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cde8d4a8294ffd7dee63567440b351ffbd67b69f1295306b20931b8f4328a77c
-  data.tar.gz: e99ca77abffd677b1469e145383ef74a90a28da29af88625d7bf378563909031
+  metadata.gz: 8cc30c6d61489ca1a61dc4c8380476d9db8f6e5298bb5c079b964966e7266dbd
+  data.tar.gz: 695681a9817474ed89e833ea4b0cdd5fb2c7ecda7dfb032cc017540f0f04a986
 SHA512:
-  metadata.gz: 3f33a67b5da7958d3dccc0e8ada2f5fb097d786fd35045e8a8148ac543ec1326e0d1da51c2b264b674ba1f8ffb1c5dc868dc2244afccc5b8d93c7429b68797c1
-  data.tar.gz: 9972faa37b1f14b4dd38be6c0d15a743640f065357b7a347299f3255a8f50377a580e64b284631ae99cf8eb1207045ce08eb4c9e65860d67827a55be435219e3
+  metadata.gz: 7d3786ae3d2bd0171705eaa15fd644228e10774023c3042255102e81b7570af318fbe2e6dbae301c319e12830dd914fbfe3385fc90aca5dcd1dd49f8884e29c8
+  data.tar.gz: 197fab7301ad30ccb93bf80c799d4aa978626220db9f748ab5048da9a857b2a47b71777c42a641aae3718d8e57d2923a672ea4e859280d097295bbd2fc4c3768

data/lib/bashly/config_validator.rb

@@ -24,7 +24,7 @@ module Bashly
     def assert_catch_all(key, value)
       return unless value
 
-      assert [TrueClass, String, Hash].include?(value.class),
+      assert [TrueClass, FalseClass, String, Hash].include?(value.class),
         "#{key} must be a boolean, a string or a hash"
 
       assert_catch_all_hash key, value if value.is_a? Hash
@@ -77,7 +77,7 @@ module Bashly
     def assert_extensible(key, value)
       return unless value
 
-      assert [TrueClass, String].include?(value.class),
+      assert [TrueClass, FalseClass, String].include?(value.class),
         "#{key} must be a boolean or a string"
     end
 
@@ -173,6 +173,11 @@ module Bashly
       refute value['required'] && value['default'], "#{key} cannot have both nub`required` and nub`default`"
     end
 
+    def assert_var(key, value)
+      assert_hash key, value, keys: Script::Variable.option_keys
+      assert_string "#{key}.name", value['name']
+    end
+
     def assert_command(key, value)
       assert_hash key, value, keys: Script::Command.option_keys
 
@@ -207,6 +212,7 @@ module Bashly
       assert_array "#{key}.completions", value['completions'], of: :string
       assert_array "#{key}.filters", value['filters'], of: :string
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
+      assert_array "#{key}.variables", value['variables'], of: :var
 
       assert_uniq "#{key}.commands", value['commands'], %w[name alias]
       assert_uniq "#{key}.flags", value['flags'], 'long'

data/lib/bashly/docs/command.yml

@@ -309,6 +309,27 @@ command.private:
       help: Send bash completions
       private: true
 
+command.variables:
+  help: Define a list of global bash variables. See `variable` for reference.
+  url: https://bashly.dannyb.co/configuration/command/#variables
+  example: |-
+    variables:
+    # Simple value
+    - name: output_folder
+      value: output
+
+    # Array
+    - name: download_sources
+      value:
+      - youtube
+      - instagram
+
+    # Associative array
+    - name: zip_options
+      value:
+        pattern: "*.json"
+        compression_level: fast
+
 command.version:
   help: Specify the version to show when running with `--version`.
   url: https://bashly.dannyb.co/configuration/command/#version

data/lib/bashly/docs/var.yml

@@ -0,0 +1,51 @@
+variable:
+  help: Define variables that will be available to your script.
+  url: https://bashly.dannyb.co/configuration/variable/
+  example: |-
+    variables:
+    # Simple value
+    - name: output_folder
+      value: output
+
+    # Array
+    - name: download_sources
+      value:
+      - youtube
+      - instagram
+
+    # Associative array
+    - name: zip_options
+      value:
+        pattern: "*.json"
+        compression_level: fast
+
+variable.name:
+  help: Specify the name of the variable.
+  url: https://bashly.dannyb.co/configuration/variable/#name
+  example: |-
+    variables:
+    - name: output_folder
+      value: output
+
+variable.value:
+  help: |-
+    Specify the value for this variable.
+    This can be any value type, including array and hash (associative array).
+  url: https://bashly.dannyb.co/configuration/variable/#value
+  example: |-
+    variables:
+    # Simple value
+    - name: output_folder
+      value: output
+
+    # Array
+    - name: download_sources
+      value:
+      - youtube
+      - instagram
+
+    # Associative array
+    - name: zip_options
+      value:
+        pattern: "*.json"
+        compression_level: fast

data/lib/bashly/libraries/colors/colors.sh

@@ -26,17 +26,26 @@ yellow() { print_in_color "\e[33m" "$*"; }
 blue() { print_in_color "\e[34m" "$*"; }
 magenta() { print_in_color "\e[35m" "$*"; }
 cyan() { print_in_color "\e[36m" "$*"; }
+black() { print_in_color "\e[30m" "$*"; }
+white() { print_in_color "\e[37m" "$*"; }
+
 bold() { print_in_color "\e[1m" "$*"; }
 underlined() { print_in_color "\e[4m" "$*"; }
+
 red_bold() { print_in_color "\e[1;31m" "$*"; }
 green_bold() { print_in_color "\e[1;32m" "$*"; }
 yellow_bold() { print_in_color "\e[1;33m" "$*"; }
 blue_bold() { print_in_color "\e[1;34m" "$*"; }
 magenta_bold() { print_in_color "\e[1;35m" "$*"; }
 cyan_bold() { print_in_color "\e[1;36m" "$*"; }
+black_bold() { print_in_color "\e[1;30m" "$*"; }
+white_bold() { print_in_color "\e[1;37m" "$*"; }
+
 red_underlined() { print_in_color "\e[4;31m" "$*"; }
 green_underlined() { print_in_color "\e[4;32m" "$*"; }
 yellow_underlined() { print_in_color "\e[4;33m" "$*"; }
 blue_underlined() { print_in_color "\e[4;34m" "$*"; }
 magenta_underlined() { print_in_color "\e[4;35m" "$*"; }
 cyan_underlined() { print_in_color "\e[4;36m" "$*"; }
+black_underlined() { print_in_color "\e[4;30m" "$*"; }
+white_underlined() { print_in_color "\e[4;37m" "$*"; }

data/lib/bashly/libraries/ini/ini.sh

@@ -27,6 +27,7 @@
 ##
 ## Load an INI file and populate the associative array `ini`.
 ini_load() {
+  unset ini
   declare -gA ini
 
   local ini_file="$1"

data/lib/bashly/script/command.rb

@@ -8,6 +8,7 @@ module Bashly
       include Introspection::EnvironmentVariables
       include Introspection::Examples
       include Introspection::Flags
+      include Introspection::Variables
       include Introspection::Visibility
 
       class << self
@@ -17,7 +18,7 @@ module Bashly
             default dependencies environment_variables examples
             extensible expose filename filters flags
             footer function group help name
-            private version
+            private variables version
           ]
         end
       end

data/lib/bashly/script/introspection/variables.rb

@@ -0,0 +1,16 @@
+module Bashly
+  module Script
+    module Introspection
+      module Variables
+        # Returns an array of Variable objects
+        def variables
+          return [] unless options['variables']
+
+          options['variables'].map do |options|
+            Variable.new options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bashly/script/variable.rb

@@ -0,0 +1,11 @@
+module Bashly
+  module Script
+    class Variable < Base
+      class << self
+        def option_keys
+          @option_keys ||= %i[name value]
+        end
+      end
+    end
+  end
+end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.2.2'
+  VERSION = '1.2.4'
 end

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

@@ -1,7 +1,8 @@
 = view_marker
 
 > while [[ $# -gt 0 ]]; do
->   case "${1:-}" in
+>   key="$1"
+>   case "$key" in
 
 if root_command?
   = (short_flag_exist?("-v") ? "--version)" : "--version | -v)").indent(4)

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

@@ -1,6 +1,7 @@
 = view_marker
 
 > {{ function_name }}_command() {
+= render(:variables).indent(2) if variables&.any?
 = load_user_file(filename).indent 2
 > }
 >

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

@@ -9,6 +9,7 @@
 if has_unique_args_or_flags?
   >   declare -A unique_lookup=()
 end
+= render(:variables).indent(2) if variables&.any?
 >   normalize_input "$@"
 >   parse_requirements "${input[@]}"
 if user_file_exist?('before')

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

@@ -0,0 +1,5 @@
+= view_marker
+
+variables.each do |var|
+  = var.render(:definition)
+end

data/lib/bashly/views/variable/definition.gtx

@@ -0,0 +1,28 @@
+= view_marker
+
+case value
+when Array
+  if value.empty?
+  > declare -a {{ name }}=()
+  else
+  > declare -a {{ name }}=(
+    value.each do |v|
+  >   "{{ v }}"
+    end
+  > )
+  end
+when Hash
+  if value.empty?
+  > declare -A {{ name }}=()
+  else
+  > declare -A {{ name }}=(
+    value.each do |k, v|
+  >   ["{{ k }}"]="{{ v }}"
+    end
+  > )
+  end
+when String, NilClass
+  > {{ name }}="{{ value }}"
+else
+  > {{ name }}={{ value }}
+end

data/lib/bashly.rb

@@ -22,13 +22,13 @@ module Bashly
   module Script
     autoloads 'bashly/script', %i[
       Argument Base CatchAll Command Dependency EnvironmentVariable Flag
-      Wrapper
+      Variable Wrapper
     ]
 
     module Introspection
       autoloads 'bashly/script/introspection', %i[
         Arguments Commands Dependencies EnvironmentVariables Examples Flags
-        Visibility
+        Variables Visibility
       ]
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-17 00:00:00.000000000 Z
+date: 2024-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -128,6 +128,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +224,7 @@ files:
 - lib/bashly/docs/command.yml
 - lib/bashly/docs/env.yml
 - lib/bashly/docs/flag.yml
+- lib/bashly/docs/var.yml
 - lib/bashly/exceptions.rb
 - lib/bashly/extensions/array.rb
 - lib/bashly/extensions/file.rb
@@ -240,7 +281,9 @@ files:
 - lib/bashly/script/introspection/environment_variables.rb
 - lib/bashly/script/introspection/examples.rb
 - lib/bashly/script/introspection/flags.rb
+- lib/bashly/script/introspection/variables.rb
 - lib/bashly/script/introspection/visibility.rb
+- lib/bashly/script/variable.rb
 - lib/bashly/script/wrapper.rb
 - lib/bashly/settings.rb
 - lib/bashly/templates/bashly.yml
@@ -294,6 +337,7 @@ files:
 - lib/bashly/views/command/user_hooks.gtx
 - lib/bashly/views/command/user_lib.gtx
 - lib/bashly/views/command/validations.gtx
+- lib/bashly/views/command/variables.gtx
 - lib/bashly/views/command/version_command.gtx
 - lib/bashly/views/command/whitelist_filter.gtx
 - lib/bashly/views/environment_variable/usage.gtx
@@ -305,6 +349,7 @@ files:
 - lib/bashly/views/flag/needs.gtx
 - lib/bashly/views/flag/usage.gtx
 - lib/bashly/views/flag/validations.gtx
+- lib/bashly/views/variable/definition.gtx
 - lib/bashly/views/wrapper/bash3_bouncer.gtx
 - lib/bashly/views/wrapper/header.gtx
 - lib/bashly/views/wrapper/wrapper.gtx
@@ -332,7 +377,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Bash Command Line Tool Generator