bashly 0.7.6 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98fc7fa0a703a1bdef30afdd0e4ff4b5a4d5cc6025380e4aa952aeb77c0b9aa8
-  data.tar.gz: 2d148783f32363862d4039b424ef8ddd5fa050c849bbe742f7195096cdf78830
+  metadata.gz: 187dd845a74d432185c8c53460836cf856251384c750cc4c0e4f2d2d894946c9
+  data.tar.gz: 1b4f519c55758ca113be95a0149ca8050481e0a57c64ba5a01ce1596d0aa1035
 SHA512:
-  metadata.gz: 309afb5a2c73c170fafacf9ab02066bd1e4d29934c6a94f6518328dbfd246a8679fc0e8ffc51e00a3359adc90cc25d1d9433e8944db7def0cf806ac5dd99d89d
-  data.tar.gz: fd16952f25275a54d0aaaf990b00575a19fc5d38cab3206918722240466df9e1ae7f55f439ccfc1129ca5d8733181583fbd4280bf18cb42615119a9122f666d8
+  metadata.gz: 92a1416625eeb9d8f8e3d3b5c7b1cfaadf0b43b5d7e329af5f89173f82eb1f5d9bda10fa33d486d5e86262a8858b36ff5a8e794271d10ec57b8191f0ed96dd06
+  data.tar.gz: f52974cfdabc844b12ba046b155fe77dd598f5dcbfd3d7dbbf6e7b7dd0103cefb006e08cfebc0ecb93a811748e523afe18a57883ce6e71bdb080a7ec0cf138ed

data/lib/bashly/commands/add.rb

@@ -32,6 +32,7 @@ module Bashly
       example "bashly add comp script completions.bash"
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
+      environment "BASHLY_LIB_DIR", "The path to use for creating the library files, relative to the source dir [default: lib]"
 
       def strings_command
         add_lib 'strings'

data/lib/bashly/commands/base.rb

@@ -5,6 +5,12 @@ module Bashly
   module Commands
     class Base < MisterBin::Command
       include AssetHelper
+
+      def validate_config
+        config = Config.new "#{Settings.source_dir}/bashly.yml"
+        validator = ConfigValidator.new config
+        validator.validate
+      end
     end
   end
 end

data/lib/bashly/commands/generate.rb

@@ -13,12 +13,14 @@ module Bashly
 
       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)"
 
       example "bashly generate --force"
       example "bashly generate --wrap my_function"
 
       def run
+        validate_config
         create_user_files
         upgrade_libs if args['--upgrade']
         create_master_script

data/lib/bashly/commands/validate.rb

@@ -9,9 +9,7 @@ module Bashly
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
 
       def run
-        config = Config.new "#{Settings.source_dir}/bashly.yml"
-        validator = ConfigValidator.new config
-        validator.validate
+        validate_config
         say "!txtgrn!OK"
       end
     end

data/lib/bashly/config.rb

@@ -10,7 +10,7 @@ module Bashly
 
     def self.new(config)
       if config.is_a? String
-        YAML.load_file(config).compose
+        YAML.properly_load_file(config).compose
       else
         config
       end

data/lib/bashly/config_validator.rb

@@ -84,6 +84,8 @@ module Bashly
       assert_array "#{key}.allowed", value['allowed'], of: :string
 
       refute value['name'].match(/^-/), "#{key}.name must not start with '-'"
+
+      refute value['required'] && value['default'], "#{key} cannot have both required and default"
     end
 
     def assert_flag(key, value)
@@ -104,6 +106,16 @@ module Bashly
       assert value['long'].match(/^--[a-zA-Z0-9_\-]+$/), "#{key}.long must be in the form of '--name'" if value['long']
       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"
+
+      if value['default']
+        assert value['arg'], "#{key}.default does not make sense without arg"
+      end
+
+      if value['allowed']
+        assert value['arg'], "#{key}.allowed does not make sense without arg"
+      end
     end
 
     def assert_env_var(key, value)
@@ -140,6 +152,16 @@ module Bashly
       assert_array "#{key}.filters", value['filters'], of: :string
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
       assert_array "#{key}.examples", value['examples'], of: :string
+
+      if key == "root"
+        refute value['short'], "#{key}.short makes no sense"
+        refute value['group'], "#{key}.group makes no sense"
+        refute value['default'], "#{key}.default makes no sense"
+        refute value['private'], "#{key}.private makes no sense"
+      else
+        refute value['version'], "#{key}.version makes no sense"
+        refute value['extensible'], "#{key}.extensible makes no sense"
+      end
     end
   end
 end

data/lib/bashly/extensions/yaml.rb

@@ -0,0 +1,8 @@
+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
+    YAML.load_file path
+  end
+end

data/lib/bashly/libraries/completions_function.rb

@@ -4,7 +4,7 @@ module Bashly
       def files
         [
           {
-            path: "#{Settings.source_dir}/lib/#{function_name}.sh",
+            path: "#{Settings.full_lib_dir}/#{function_name}.sh",
             content: completions_function_code(function_name)
           }
         ]

data/lib/bashly/libraries.yml

@@ -1,22 +1,22 @@
 colors:
   files:
     - source: "templates/lib/colors.sh"
-      target: "%{user_source_dir}/lib/colors.sh"
+      target: "%{user_lib_dir}/colors.sh"
 
 config:
   files:
     - source: "templates/lib/config.sh"
-      target: "%{user_source_dir}/lib/config.sh"
+      target: "%{user_lib_dir}/config.sh"
 
 yaml:
   files:
     - source: "templates/lib/yaml.sh"
-      target: "%{user_source_dir}/lib/yaml.sh"
+      target: "%{user_lib_dir}/yaml.sh"
 
 lib:
   files:
     - source: "templates/lib/sample_function.sh"
-      target: "%{user_source_dir}/lib/sample_function.sh"
+      target: "%{user_lib_dir}/sample_function.sh"
 
 strings:
   files:
@@ -41,13 +41,13 @@ test:
 validations:
   files:
     - source: "templates/lib/validations/validate_dir_exists.sh"
-      target: "%{user_source_dir}/lib/validations/validate_dir_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_dir_exists.sh"
     - source: "templates/lib/validations/validate_file_exists.sh"
-      target: "%{user_source_dir}/lib/validations/validate_file_exists.sh"
+      target: "%{user_lib_dir}/validations/validate_file_exists.sh"
     - source: "templates/lib/validations/validate_integer.sh"
-      target: "%{user_source_dir}/lib/validations/validate_integer.sh"
+      target: "%{user_lib_dir}/validations/validate_integer.sh"
     - source: "templates/lib/validations/validate_not_empty.sh"
-      target: "%{user_source_dir}/lib/validations/validate_not_empty.sh"
+      target: "%{user_lib_dir}/validations/validate_not_empty.sh"
 
 completions: :CompletionsFunction
 completions_script: :CompletionsScript

data/lib/bashly/library.rb

@@ -6,7 +6,7 @@ module Bashly
       end
 
       def config
-        @config ||= YAML.load_file(config_path)
+        @config ||= YAML.properly_load_file(config_path)
       end
 
       def config_path
@@ -59,7 +59,8 @@ module Bashly
     def target_file_args
       {
         user_source_dir: Settings.source_dir,
-        user_target_dir: Settings.target_dir
+        user_target_dir: Settings.target_dir,
+        user_lib_dir: Settings.full_lib_dir,
       }
     end
   end

data/lib/bashly/message_strings.rb

@@ -13,7 +13,7 @@ module Bashly
   private
 
     def values!
-      defaults = YAML.load_file asset("templates/strings.yml")
+      defaults = YAML.properly_load_file asset("templates/strings.yml")
       defaults.merge project_strings
     end
 
@@ -23,7 +23,7 @@ module Bashly
 
     def project_strings!
       if File.exist? project_strings_path
-        YAML.load_file project_strings_path
+        YAML.properly_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.load_file path
+      loaded = YAML.properly_load_file path
       return loaded if loaded.is_a? Array or loaded.is_a? Hash
       raise Bashly::ConfigurationError, "Cannot find a valid YAML in !txtgrn!#{path}"
 

data/lib/bashly/script/base.rb

@@ -36,7 +36,6 @@ module Bashly
       def initialize(options)
         raise Error, "Invalid options provided" unless options.respond_to? :keys
         @options = options
-        validate_options if respond_to? :validate_options
       end
 
       def optional

data/lib/bashly/script/command.rb

@@ -125,13 +125,7 @@ module Bashly
       # This is meant to provide the user with the ability to add custom
       # functions
       def user_lib
-        @user_lib ||= Dir["#{Settings.source_dir}/lib/**/*.sh"].sort
-      end
-
-      # Raise an exception if there are some serious issues with the command
-      # definition. This is called by Base#initialize.
-      def validate_options
-        Bashly::ConfigValidator.new(options).validate
+        @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.sh"].sort
       end
 
     end

data/lib/bashly/settings.rb

@@ -1,7 +1,7 @@
 module Bashly
   class Settings
     class << self
-      attr_writer :source_dir, :target_dir
+      attr_writer :source_dir, :target_dir, :lib_dir, :strict
 
       def source_dir
         @source_dir ||= ENV['BASHLY_SOURCE_DIR'] || 'src'
@@ -10,6 +10,18 @@ module Bashly
       def target_dir
         @target_dir ||= ENV['BASHLY_TARGET_DIR'] || '.'
       end
+
+      def lib_dir
+        @lib_dir ||= ENV['BASHLY_LIB_DIR'] || 'lib'
+      end
+
+      def strict
+        @strict ||= ENV['BASHLY_STRICT']
+      end
+
+      def full_lib_dir
+        "#{source_dir}/#{lib_dir}"
+      end
     end
   end
 end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.7.6"
+  VERSION = "0.7.7"
 end

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

@@ -2,7 +2,7 @@
 initialize() {
   version="<%= version %>"
   long_usage=''
-  <%= ENV['BASHLY_STRICT'] ? "set -euo pipefail" : "set -e" %>
+  <%= Settings.strict ? "set -euo pipefail" : "set -e" %>
 
 <%= load_user_file("initialize.sh", placeholder: false).indent 2 %>
 }

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

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

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

@@ -1,4 +1,4 @@
 #!/usr/bin/env bash
-# This script was generated by bashly (https://github.com/DannyBen/bashly)
+# This script was generated by bashly <%= Bashly::VERSION %> (https://bashly.dannyb.co)
 # Modifying it manually is not recommended
 

data/lib/bashly.rb

@@ -7,6 +7,7 @@ end
 
 requires 'bashly/concerns'
 
+requires 'bashly/extensions'
 requires 'bashly/settings'
 requires 'bashly/exceptions'
 requires 'bashly/refinements'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-18 00:00:00.000000000 Z
+date: 2022-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -93,6 +93,7 @@ files:
 - lib/bashly/extensions/array.rb
 - lib/bashly/extensions/file.rb
 - lib/bashly/extensions/string.rb
+- lib/bashly/extensions/yaml.rb
 - lib/bashly/libraries.yml
 - lib/bashly/libraries/base.rb
 - lib/bashly/libraries/completions.rb
@@ -191,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator