bashly 1.0.0.rc1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b23af9b1533c906c685ef6f62620bb32b55fb45599e354e85548e800d7ecf832
-  data.tar.gz: e65e8f10fefd0b2945c9c31459ee427b9688a5d8565880ddbce3021d2b8b1c6a
+  metadata.gz: e17bc036331958bd9ff237d93e287c911bc00c85b33628a4b867dd2e69c818fe
+  data.tar.gz: 236e3ba5f96e9f89fce4b77d95adf68a3030ef31d3d59a857ad0477aa871b171
 SHA512:
-  metadata.gz: 4c82c7e9a804e2d95d1a4179aaf96948c7f9e8150f64ace8d8b87b990a5157f22def814289f2aebb82869fafdd38fb03fc3aeec4fc752ff836c37efe0e53e389
-  data.tar.gz: b82bc5d7be814046b42fc959238f3a455d3f1f9c17fa0d2a5e1a3cd2e516db64db33ed9d62afcdfef8368f33a7c3b5a4b65ac58bd9d3aa308aacc1130e9983de
+  metadata.gz: 55f3361b37d963fcd33ad97b9204ce201517b9249522e4d4fb501c4502e8ba31ef5049c629d6bf5e82d85854ca64de1435f2604a01e12913ba5a56de346994ee
+  data.tar.gz: 23832fbbfbbaec41862b61eeb75ef0a34598db175192d09c3f1ea738bf1bd81aa11d855df7a6ba9ec8461a5daa0de835bc9343cb56e72e8867f5d7a15492f8d7

data/README.md

@@ -1,5 +1,5 @@
 <div align='center'>
-<img src='logo.svg' width=280>
+<img src='support/img/bashly-logo.svg' width=280>
 
 # Bashly - Bash CLI Framework and Generator
 
@@ -13,7 +13,7 @@ Create feature-rich bash scripts using simple YAML configuration
 
 ---
 
-![demo](demo/cast.gif)
+![demo](support/demo/cast.gif)
 
 </div>
 
@@ -27,6 +27,11 @@ usually handled by a framework in any other programming language.
 It is available both as a [ruby gem](https://rubygems.org/gems/bashly) and as
 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>
+
+
 ## Documentation
 
 - [Bashly Homepage][docs]
@@ -64,7 +69,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/concerns/validation_helpers.rb

@@ -35,19 +35,13 @@ module Bashly
       end
     end
 
-    def assert_hash(key, value, keys: nil, of: nil)
+    def assert_hash(key, value, keys: nil)
       assert value.is_a?(Hash), "#{key} must be a hash"
 
-      if keys
-        invalid_keys = value.keys.map(&:to_sym) - keys
-        assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join ', '}"
-      end
-
-      return unless of
+      return unless keys
 
-      value.each do |k, v|
-        send "assert_#{of}".to_sym, "#{key}.#{k}", v
-      end
+      invalid_keys = value.keys.map(&:to_sym) - keys
+      assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join ', '}"
     end
 
     def assert_uniq(key, value, array_keys)

data/lib/bashly/config_validator.rb

@@ -50,13 +50,30 @@ module Bashly
       when Array
         assert_array key, value, of: :string
       when Hash
-        assert_hash key, value, of: :string
+        assert_dependencies_hash key, value
       else
         assert [Array, Hash].include?(value.class),
           "#{key} must be an array or a hash"
       end
     end
 
+    def assert_dependencies_hash(key, value)
+      value.each do |k, v|
+        assert_dependency "#{key}.#{k}", v
+      end
+    end
+
+    def assert_dependency(key, value)
+      assert [String, Hash, NilClass].include?(value.class),
+        "#{key} must be a string, a hash or nil"
+
+      return unless value.is_a? Hash
+
+      assert_hash key, value, keys: Script::Dependency.option_keys
+      assert_string_or_array "#{key}.command", value['command']
+      assert_optional_string "#{key}.help", value['help']
+    end
+
     def assert_extensible(key, value)
       return unless value
 
@@ -157,6 +174,11 @@ module Bashly
       assert_extensible "#{key}.extensible", value['extensible']
       assert_dependencies "#{key}.dependencies", value['dependencies']
 
+      assert value['name'].match(/^[a-z0-9_\-.]+$/),
+        "#{key}.name must only contain lowercase alphanumeric characters, hyphens, dots and underscores"
+
+      refute value['name'].start_with?('-'), "#{key}.name must not start with a hyphen"
+
       assert_array "#{key}.args", value['args'], of: :arg
       assert_array "#{key}.flags", value['flags'], of: :flag
       assert_array "#{key}.commands", value['commands'], of: :command

data/lib/bashly/docs/command.yml

@@ -113,10 +113,18 @@ command.dependencies:
     - docker
     - curl
 
-    # Hash syntax, to provide additional help message
+    # Simple hash syntax, to provide additional (optional) help message
     dependencies:
       docker: see https://docker.com for installation instructions
       git: "install by running: sudo apt install git"
+      ruby:
+
+    # Explicit hash syntax, to provide additional help message and
+    # look for "one of" a given list of dependencies
+    dependencies:
+      http_client:
+        command: [curl, wget]
+        help: Run 'sudo apt install curl' or 'sudo apt install wget'
   
 command.environment_variables:
   help: Define a list of environment variables. See `environment_variable` for reference.

data/lib/bashly/libraries/settings/settings.yml

@@ -12,16 +12,20 @@
 # The path containing the bashly source files
 source_dir: src
 
-# Tha path to bashly.yml
+# The path to bashly.yml
 config_path: "%{source_dir}/bashly.yml"
 
 # The path to use for creating the bash script
 target_dir: .
 
-# The path to use for upgrading library files, relative to the source dir
+# The path to use for common library files, relative to the source dir
 lib_dir: lib
 
-# When true, enable bash strict mode (set -euo pipefail)
+# Configure the bash options that will be added to the initialize function:
+# strict: true       Bash strict mode (set -euo pipefail)
+# strict: false      Only exit on errors (set -e)
+# strict: ''         Do not add any 'set' directive
+# strict: <string>   Add any other custom 'set' directive
 strict: false
 
 # When true, the generated script will use tab indentation instead of spaces
@@ -33,11 +37,11 @@ tab_indent: false
 compact_short_flags: true
 
 # Set to 'production' or 'development':
-# - production    generate a smaller script, without file markers
-# - development   generate with file markers
+# env: production    Generate a smaller script, without file markers
+# env: development   Generate with file markers
 env: development
 
-# The extension to use when reading/writing partial script snippets.
+# The extension to use when reading/writing partial script snippets
 partials_extension: sh
 
 # Display various usage elements in color by providing the name of the color

data/lib/bashly/script/command.rb

@@ -53,6 +53,7 @@ module Bashly
         help.empty? ? full_name : "#{full_name} - #{summary}"
       end
 
+      # Returns an object representing the catch_all configuration
       def catch_all
         @catch_all ||= CatchAll.from_config options['catch_all']
       end
@@ -133,7 +134,16 @@ module Bashly
         flags.select(&:default)
       end
 
-      # Returns an array of EnvironmentVariables
+      # Returns an array of Dependency objects
+      def dependencies
+        return [] unless options['dependencies']
+
+        @dependencies ||= options['dependencies'].map do |key, value|
+          Dependency.from_config key, value
+        end
+      end
+
+      # Returns an array of EnvironmentVariable objects
       def environment_variables
         return [] unless options['environment_variables']
 

data/lib/bashly/script/dependency.rb

@@ -0,0 +1,42 @@
+module Bashly
+  module Script
+    class Dependency
+      attr_reader :label, :commands, :help
+
+      class << self
+        def option_keys
+          @option_keys ||= %i[command help]
+        end
+
+        def from_config(key, value)
+          options = case value
+          when nil
+            { label: key, commands: key }
+          when String
+            { label: key, commands: key, help: value }
+          when Hash
+            { label: key, commands: value['command'], help: value['help'] }
+          else
+            {}
+          end
+
+          new(**options)
+        end
+      end
+
+      def initialize(label: nil, commands: nil, help: nil)
+        @label = label
+        @commands = commands.is_a?(String) ? [commands] : commands
+        @help = help&.empty? ? nil : help
+      end
+
+      def multi?
+        @multi ||= commands.size > 1
+      end
+
+      def name
+        @name ||= multi? ? "#{label} (#{commands.join '/'})" : label
+      end
+    end
+  end
+end

data/lib/bashly/settings.rb

@@ -55,6 +55,16 @@ module Bashly
         @strict ||= get :strict
       end
 
+      def strict_string
+        if Settings.strict.is_a? String
+          Settings.strict
+        elsif Settings.strict
+          'set -euo pipefail'
+        else
+          'set -e'
+        end
+      end
+
       def tab_indent
         @tab_indent ||= get :tab_indent
       end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.0.0.rc1'
+  VERSION = '1.0.1'
 end

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

@@ -1,11 +1,13 @@
 if dependencies
   = view_marker
 
-  dependencies.each do |dependency, message|
-    > if ! command -v {{ dependency }} >/dev/null 2>&1; then
-    >   printf "{{ strings[:missing_dependency] % { dependency: dependency } }}\n" >&2
-    if message and !message.empty?
-      >   printf "%s\n" "{{ message }}" >&2
+  dependencies.each do |dependency|
+    > if command -v {{ dependency.commands.join(' ') }} >/dev/null 2>&1; then
+    >   deps['{{ dependency.label }}']="$(command -v {{ dependency.commands.join(' ') }} | head -n1)"
+    > else
+    >   printf "{{ strings[:missing_dependency] % { dependency: dependency.name } }}\n" >&2
+    if dependency.help
+      >   printf "%s\n" "{{ dependency.help }}" >&2
     end
     >   exit 1
     > fi

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

@@ -3,7 +3,7 @@
 > initialize() {
 >   version="<%= version %>"
 >   long_usage=''
->   {{ Settings.strict ? "set -euo pipefail" : "set -e" }}
+>   {{ Settings.strict_string }}
 > 
 
 if root_command?

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

@@ -1,8 +1,8 @@
 = view_marker
 
 > inspect_args() {
->   readarray -t sorted_keys < <(printf '%s\n' "${!args[@]}" | sort)
 >   if ((${#args[@]})); then
+>     readarray -t sorted_keys < <(printf '%s\n' "${!args[@]}" | sort)
 >     echo args:
 >     for k in "${sorted_keys[@]}"; do echo "- \${args[$k]} = ${args[$k]}"; done
 >   else
@@ -17,5 +17,13 @@
 >       echo "- \${other_args[$i]} = ${other_args[$i]}"
 >     done
 >   fi
+>
+>   if ((${#deps[@]})); then
+>     readarray -t sorted_keys < <(printf '%s\n' "${!deps[@]}" | sort)
+>     echo
+>     echo deps:
+>     for k in "${sorted_keys[@]}"; do echo "- \${deps[$k]} = ${deps[$k]}"; done
+>   fi
+>
 > }
 > 

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

@@ -2,6 +2,7 @@
 
 > run() {
 >   declare -A args=()
+>   declare -A deps=()
 >   declare -a other_args=()
 >   declare -a input=()
 >   normalize_input "$@"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-12 00:00:00.000000000 Z
+date: 2023-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -174,6 +174,7 @@ files:
 - lib/bashly/script/base.rb
 - lib/bashly/script/catch_all.rb
 - lib/bashly/script/command.rb
+- lib/bashly/script/dependency.rb
 - lib/bashly/script/environment_variable.rb
 - lib/bashly/script/flag.rb
 - lib/bashly/script/wrapper.rb
@@ -254,11 +255,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.7
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator