bashly 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58a2804698490f003611b4f607614fef9995bea16f426c6d56d527d78b770a29
-  data.tar.gz: 24a4c1d97b45332e424fc6932092225bab7b3ade618f5eec5e9c187ca91389ac
+  metadata.gz: a333ce419f5ba64e38000497f245fc5baf822243cd2765c1805ebdf6de2e3b46
+  data.tar.gz: 0c9ab24cc2cecd88cbd20a06ab11028740ce3000aec75080ca9a12c6769110c1
 SHA512:
-  metadata.gz: 0e62c14ede0d0295e01411cd946859a21413e50b43313f850ea494c4ed5dafe6f402b914dfc8f682c3abc8e38d9004917dbd654d78f8983b961f2f35228e97e4
-  data.tar.gz: '00309d231db02bb61fe7d9ae2c95d9d615888830a6a95c2815cda9e8b08fa4dd73e6ccc0f0127bf46a467deee4888297975f421a2a1e0c80fa5b23d871124726'
+  metadata.gz: ff95fd919a29a16d610d8f3c069f2de17b9984a41251de56e484a5dc49e86dd4114934c47ccb2274521f7f8bd5078287a54ef10478c5e18b6c8a93f462f1c503
+  data.tar.gz: 65a1be57601cc7a560a19ef48dc75b09647244fe477327f23ae52a37f8114afca4ee3871a1f72e1b046589e252a57701956a93e9015907bf76fd24455da341ff

data/README.md

@@ -32,7 +32,6 @@ a [docker image](https://hub.docker.com/r/dannyben/bashly).
 <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>
 
@@ -82,11 +81,6 @@ to contribute, feel free to [open an issue][issues] or
 
 Visit the *[How to contribute][contributing]* page for more information.
 
-## Stargazers and Forkers
-
-[![Stargazers repo roster for @DannyBen/bashly](https://reporoster.com/stars/DannyBen/bashly)](https://github.com/DannyBen/bashly/stargazers)
-
-[![Forkers repo roster for @DannyBen/bashly](https://reporoster.com/forks/DannyBen/bashly)](https://github.com/DannyBen/bashly/network/members)
 
 [issues]: https://github.com/DannyBen/bashly/issues
 [discussions]: https://github.com/DannyBen/bashly/discussions

data/lib/bashly/config.rb

@@ -2,7 +2,11 @@ require 'yaml'
 
 module Bashly
   # A convenience class to use either a hash or a filename as a configuration
-  # source
+  # source.
+  #
+  # When a filename is provided, it is loaded with these extra features:
+  # - Support for `import` keyword to merge additional YAML files
+  # - Preprocessing with ERB
   class Config
     using ComposeRefinements
 
@@ -10,7 +14,7 @@ module Bashly
 
     def self.new(config)
       if config.is_a? String
-        YAML.properly_load_file(config).compose
+        YAML.load_erb_file(config).compose
       else
         config
       end

data/lib/bashly/extensions/string.rb

@@ -13,6 +13,10 @@ class String
     gsub(/(.)([A-Z])/, '\1_\2').gsub(/[- ]/, '_').downcase
   end
 
+  def to_path
+    tr(' ', '/').downcase
+  end
+
   def wrap(length = 80)
     strip!
     split("\n").collect! do |line|

data/lib/bashly/extensions/yaml.rb

@@ -1,10 +1,12 @@
 module YAML
-  # This awkward patch is due to https://bugs.ruby-lang.org/issues/17866
-  def self.properly_load_file(path)
-    YAML.load_file path, aliases: true
-  rescue ArgumentError
-    # :nocov:
-    YAML.load_file path
-    # :nocov:
+  # We trust our loaded YAMLs
+  # This patch is due to https://bugs.ruby-lang.org/issues/17866
+  # StackOverflow: https://stackoverflow.com/questions/71191685/visit-psych-nodes-alias-unknown-alias-default-psychbadalias/71192990#71192990
+  class << self
+    alias load unsafe_load
+
+    def load_erb_file(path)
+      YAML.load ERB.new(File.read(path)).result
+    end
   end
 end

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

@@ -18,9 +18,15 @@ config_path: "%{source_dir}/bashly.yml"
 # The path to use for creating the bash script
 target_dir: .
 
-# The path to use for common library files, relative to the source dir
+# The path to use for common library files, relative to source_dir
 lib_dir: lib
 
+# The path to use for command files, relative to source_dir
+# When set to nil (~), command files will be placed directly under source_dir
+# When set to any other string, command files will be placed under this
+# directory, and each command will get its own subdirectory
+commands_dir: ~
+
 # 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)

data/lib/bashly/library_source.rb

@@ -14,7 +14,7 @@ module Bashly
     end
 
     def config
-      @config ||= YAML.properly_load_file config_path
+      @config ||= YAML.load_file config_path
     end
 
     def libraries

data/lib/bashly/message_strings.rb

@@ -13,7 +13,7 @@ module Bashly
   private
 
     def values!
-      defaults = YAML.properly_load_file asset('libraries/strings/strings.yml')
+      defaults = YAML.load_file asset('libraries/strings/strings.yml')
       defaults.merge project_strings
     end
 
@@ -23,7 +23,7 @@ module Bashly
 
     def project_strings!
       if File.exist? project_strings_path
-        YAML.properly_load_file project_strings_path
+        YAML.load_file project_strings_path
       else
         {}
       end

data/lib/bashly/refinements/compose_refinements.rb

@@ -22,7 +22,7 @@ module ComposeRefinements
     end
 
     def safe_load_yaml(path)
-      loaded = YAML.properly_load_file path
+      loaded = YAML.load_erb_file path
       return loaded if loaded.is_a?(Array) || loaded.is_a?(Hash)
 
       raise Bashly::ConfigurationError, "Cannot find a valid YAML in g`#{path}`"

data/lib/bashly/script/command.rb

@@ -159,10 +159,10 @@ module Bashly
         options['examples'].is_a?(Array) ? options['examples'] : [options['examples']]
       end
 
-      # Returns the bash filename that is expected to hold the user code
-      # for this command
+      # Returns the filename that is expected to hold the user code for this
+      # command
       def filename
-        options['filename'] || "#{action_name.to_underscore}_command.#{Settings.partials_extension}"
+        options['filename'] || implicit_filename
       end
 
       # Returns an array of Flags
@@ -314,6 +314,18 @@ module Bashly
       def whitelisted_flags
         flags.select(&:allowed)
       end
+
+    private
+
+      # Returns either a flat filename (docker_status_command.sh) or a nested
+      # path (commands/docker/status.sh)
+      def implicit_filename
+        if Settings.commands_dir
+          "#{Settings.commands_dir}/#{action_name.to_path}.#{Settings.partials_extension}"
+        else
+          "#{action_name.to_underscore}_command.#{Settings.partials_extension}"
+        end
+      end
     end
   end
 end

data/lib/bashly/settings.rb

@@ -4,6 +4,7 @@ module Bashly
       include AssetHelper
 
       attr_writer(
+        :commands_dir,
         :compact_short_flags,
         :config_path,
         :lib_dir,
@@ -15,6 +16,10 @@ module Bashly
         :usage_colors
       )
 
+      def commands_dir
+        @commands_dir ||= get :commands_dir
+      end
+
       def compact_short_flags
         @compact_short_flags ||= get :compact_short_flags
       end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.0.6'
+  VERSION = '1.0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -268,7 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator