bashly 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e2d8e44019822a048ede2fadd9da870df078afad2931470748912b25acfb93f
-  data.tar.gz: 84738b8835be3af778b0df351154c2a73c966ee906317f61534c8100a17da9f8
+  metadata.gz: 4d486637f9d7ec6604d0495aec9f2396f69153f8cd193c126d51bc7dbc329a62
+  data.tar.gz: 5c58b05ad9ccb84d432c42228b7594e678b033555e55ea275948d4e70be118c7
 SHA512:
-  metadata.gz: 653e9a5a685d321837472cb2522f93aeabc0ed0de479f97ca35dcbb1d08e2bd997d50e17653c464ce201388f6b21ac59fa4b9d28a01beed5d5119beb8b278e1b
-  data.tar.gz: 79c111478814fb30246a214511946331c7a581196187c41ef6bc249be3858123786bba3596484b27d493288714fb9d257fc18e7b4432b0f77effe8ed7baa740b
+  metadata.gz: 02fd6e6c50c5d370dde3d50047b0b6d317454c3d48531222711c6341c6e93d263cafa6a7d541bb939ff44a36b6025c9c8411e8f3820157c41e476312f4c64781
+  data.tar.gz: 031ea1db4c68fb6b780f01862b216178804cdc44f2e86fc66bc11f2910fff6d03ed250d7a01dd1c566d74c8f002ae6e9441bb13292f3e74620db455c993029e2

data/README.md

@@ -223,6 +223,7 @@ bash function.
 `help`     | The message to display when using `--help`. Can have multiple lines.
 `required` | Specify if this argument is required. Note that once you define an optional argument (without required: true) then you cannot define required arguments after it.
 `default`  | The value to use in case it is not provided by the user. Implies that this argument is optional.
+`allowed`  | Limit the allowed values by providing an array.
 
 ### Flag options
 
@@ -238,6 +239,7 @@ short form).
 `arg`      | If the flag requires an argument, specify its name here.
 `required` | Specify if this flag is required.
 `default`  | The value to use in case it is not provided by the user. Implies that this flag is optional, and only makes sense when the flag has an argument.
+`allowed`  | For flags with an argument, you can limit the allowed values by providing an array.
 
 #### Special handling for -v and -h
 

data/lib/bashly/models/base.rb

@@ -6,10 +6,11 @@ module Bashly
       attr_reader :options
 
       OPTION_KEYS = %i[
+        allowed
         arg
+        default
         dependencies
         description
-        default
         environment_variables
         examples
         flags

data/lib/bashly/models/command.rb

@@ -175,6 +175,16 @@ module Bashly
         verify_commands if commands.any?
       end
 
+      # Returns an array of all the args with a whitelist
+      def whitelisted_args
+        args.select &:allowed
+      end
+
+      # Returns an array of all the flags with a whitelist arg
+      def whitelisted_flags
+        flags.select &:allowed
+      end
+
     private
 
       def verify_commands

data/lib/bashly/templates/strings.yml

@@ -15,6 +15,7 @@ command_shortcut: "Shortcut: %{short}"
 default_command_summary: "%{summary} (default)"
 required: "(required)"
 default: "Default: %{value}"
+allowed: "Allowed: %{values}"
 
 # Fixed flags help text
 help_flag_text: Show this help
@@ -28,3 +29,5 @@ missing_required_argument: "missing required argument: %{arg}\\nusage: %{usage}"
 missing_required_flag: "missing required flag: %{usage}"
 missing_required_environment_variable: "missing required environment variable: %{var}"
 missing_dependency: "missing dependency: %{dependency}"
+disallowed_flag: "%{name} must be one of: %{allowed}"
+disallowed_argument: "%{name} must be one of: %{allowed}"

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/lib/bashly/views/argument/usage.erb

@@ -1,6 +1,9 @@
 # :argument.usage
 echo "  <%= name.upcase %>"
 printf "<%= help.wrap(76).indent(4).sanitize_for_print %>\n"
+<%- if allowed -%>
+printf "    <%= strings[:allowed] % { values: allowed.join(', ') } -%>\n"
+<%- end -%>
 <%- if default -%>
 printf "    <%= strings[:default] % { value: default } -%>\n"
 <%- end -%>

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

@@ -12,6 +12,7 @@ parse_requirements() {
 <%= render(:required_flags_filter).indent 2 %>
 <%= render(:parse_requirements_while).indent 2 %>
 <%= render(:default_assignments).indent 2 %>
+<%= render(:whitelist_filter).indent 2 %>
 }
 
 <%- commands.each do |command| %>

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

@@ -14,12 +14,7 @@ run() {
     fi
   <% condition = "elif" %>
   <%- end -%>
-  <%= condition %> [[ ${args[--version]} ]]; then
-    version_command
-  elif [[ ${args[--help]} ]]; then
-    long_usage=yes
-    <%= name %>_usage
-  elif [[ $action == "root" ]]; then
+  <%= condition %> [[ $action == "root" ]]; then
     root_command
   fi
 }

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

@@ -0,0 +1,13 @@
+# :command.whitelist_filter
+<%- whitelisted_args.each do |arg| -%>
+if [[ ! ${args[<%= arg.name %>]} =~ ^(<%= arg.allowed.join '|' %>)$ ]]; then
+  printf "%s\n" "<%= strings[:disallowed_argument] % { name: arg.name, allowed: arg.allowed.join(', ') } %>"
+  exit 1
+fi
+<%- end -%>
+<%- whitelisted_flags.each do |flag| -%>
+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 -%>

data/lib/bashly/views/flag/usage.erb

@@ -1,6 +1,9 @@
 # :flag.usage
 echo "  <%= usage_string extended: true %>"
 printf "<%= help.wrap(76).indent(4).sanitize_for_print %>\n"
+<%- if allowed -%>
+printf "    <%= strings[:allowed] % { values: allowed.join(', ') } -%>\n"
+<%- end -%>
 <%- if default -%>
 printf "    <%= strings[:default] % { value: default } -%>\n"
 <%- end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-20 00:00:00.000000000 Z
+date: 2021-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -121,6 +121,7 @@ files:
 - lib/bashly/views/command/usage_flags.erb
 - lib/bashly/views/command/user_lib.erb
 - lib/bashly/views/command/version_command.erb
+- lib/bashly/views/command/whitelist_filter.erb
 - lib/bashly/views/environment_variable/usage.erb
 - lib/bashly/views/flag/case.erb
 - lib/bashly/views/flag/usage.erb