bashly 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95bc5fa6ee6c14e2e4cd269aecbfef7af9f005e7837c182c2f222d4640778e40
-  data.tar.gz: c8214a96d5d63094cb6f86e07022022f30b471da362b4aa087fe16ddaf96aada
+  metadata.gz: 14ee3d9cf49b4497ffbb7e374894cc0cfe18e1a1493a58c638cf4fd8896f30e2
+  data.tar.gz: 18dd37e6cfc3efd1f3c3d103f943e5ba8db4b414b2b26bed1bb096728c40cd1d
 SHA512:
-  metadata.gz: e25fd6d234783d9eb96a5e4f4a5bcc836740cbb6ee5ff2f5486a4fcea376a5e61c31f6b5eb762693708225ee8b2a2aac3d163d23d37d07dfe902687ee8d4a22b
-  data.tar.gz: 8bc3e1595cdb52c6001d55600f7fb4a1fda2d7d525b933641e04f4041de694354895eeb37d0e53d6c0cdc286b632643dfb812c8fb40cf958e93f94a5a005dcf5
+  metadata.gz: 2564fbacc1cd7584e6a0a4da943a25fa70bb51e01a935e18e1c15cb98f3a95e75147f404f858f294df26e18499233e1f82d99f3b344a8464e8ecfccd90c5a0e2
+  data.tar.gz: d638eff5ef4a4d407b558ba153e199ede105fe34b23ee00b7c8961c843cd8e5ef23e21de1396c92b6f3742f9ec7585f02ac182ccd19329b0008f5c2f5b702cc7

data/README.md

@@ -7,7 +7,7 @@ Bashly - Bash CLI Framework and Generator
 Create beautiful bash scripts from simple YAML configuration
 
 [![Gem Version](https://badge.fury.io/rb/bashly.svg)](https://badge.fury.io/rb/bashly)
-[![Build Status](https://travis-ci.com/DannyBen/bashly.svg?branch=master)](https://travis-ci.com/DannyBen/bashly)
+[![Build Status](https://github.com/DannyBen/bashly/workflows/Test/badge.svg)](https://github.com/DannyBen/bashly/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/8cf89047e50ca601e431/maintainability)](https://codeclimate.com/github/DannyBen/bashly/maintainability)
 
 ---
@@ -25,6 +25,18 @@ Installation
 $ gem install bashly
 ```
 
+or with Docker:
+
+```shell
+$ alias bashly='docker run --rm -it --volume "$PWD:/app" dannyben/bashly'
+```
+
+Prerequisites
+--------------------------------------------------
+
+The bash scripts generated by bashly require bash 4 or higher due to heavy
+use of associative arrays.
+
 
 What is Bashly
 --------------------------------------------------
@@ -54,6 +66,7 @@ Bahsly is responsible for:
   - **Color output**.
   - **Config file management** (INI format).
   - **YAML parsing**.
+  - and more.
 
 Usage
 --------------------------------------------------
@@ -159,6 +172,7 @@ bash function.
 `name`     | The name of the argument.
 `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.
 
 ### Flag options
 
@@ -173,6 +187,7 @@ short form).
 `help`     | The text to display when using `--help`. Can have multiple lines.
 `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.
 
 #### Special handling for -v and -h
 
@@ -199,6 +214,8 @@ Real World Examples
 --------------------------------------------------
 
 - [Rush][rush] - a Personal Package Manager
+- [Alf][alf] - a generator for bash aliases and sub-aliases
+- [git-changelog][git-changelog] - a change log generator
 
 
 Contributing / Support
@@ -209,3 +226,7 @@ to contribute, feel free to [open an issue][issues].
 
 [issues]: https://github.com/DannyBen/bashly/issues
 [rush]: https://github.com/DannyBen/rush-cli
+[alf]: https://github.com/DannyBen/alf
+[git-changelog]: https://github.com/DannyBen/git-changelog
+
+

data/lib/bashly/concerns/renderable.rb

@@ -4,6 +4,9 @@ module Bashly
   module Renderable
     def render(view)
       template = File.read view_path(view)
+      # TODO: This new format is only supported in Ruby >= 2.6
+      #       So for now, we keep the old deprecated syntax
+      # ERB.new(template, trim_mode: '%-').result(binding)
       ERB.new(template, nil, '%-').result(binding)
     end
 

data/lib/bashly/models/command.rb

@@ -38,7 +38,7 @@ module Bashly
         return [] unless options["commands"]
         options["commands"].map do |options|
           options['parents'] = parents + [name]
-          command = Command.new options
+          Command.new options
         end
       end
 
@@ -55,12 +55,22 @@ module Bashly
         result
       end
 
+      # Returns an array of all the default Args
+      def default_args
+        args.select &:default
+      end
+
       # If any of this command's subcommands has the default option set to
       # true, this default command will be returned, nil otherwise.
       def default_command
         commands.find { |c| c.default }
       end
 
+      # Returns an array of all the default Flags
+      def default_flags
+        flags.select &:default
+      end
+
       # Returns an array of EnvironmentVariables
       def environment_variables
         return [] unless options["environment_variables"]
@@ -148,7 +158,7 @@ module Bashly
         args.each do |arg|
           result << arg.usage_string
         end
-        result << "[options]"
+        result << "[options]" unless flags.empty?
         result.join " "
       end
 

data/lib/bashly/models/flag.rb

@@ -11,6 +11,10 @@ module Bashly
         end
       end
 
+      def name
+        long || short
+      end
+
       def usage_string(extended: false)
         result = [aliases.join(", ")]
         result << arg.upcase if arg

data/lib/bashly/polyfills/hash.rb

@@ -7,4 +7,6 @@ if !Dir.respond_to? :empty?
       exist?(path_name) && (entries(path_name) - ['.', '..']).empty?
     end
   end
-end
+end
+
+# :nocov:

data/lib/bashly/templates/lib/config.sh

@@ -21,7 +21,7 @@ config_init() {
 # Usage: result=$(config_get hello)
 config_get() {
   key=$1
-  regex="^$key\s*=\s*(.+)$"
+  regex="^$key *= *(.+)$"
 
   config_init
   
@@ -44,7 +44,7 @@ config_set() {
 
   config_init
 
-  regex="^($key)\s*=\s*.+$"
+  regex="^($key) *= *.+$"
   output=""
   found_key=""
   
@@ -71,7 +71,7 @@ config_set() {
 config_del() {
   key=$1
 
-  regex="^($key)\s*="
+  regex="^($key) *="
   output=""
 
   config_init
@@ -100,7 +100,7 @@ config_show() {
 #   done
 #
 config_keys() {
-  regex="^(.*)\s*="
+  regex="^([a-zA-Z0-9_\-\/\.]+) *="
 
   config_init
 
@@ -113,3 +113,14 @@ config_keys() {
   done < "$CONFIG_FILE"
   echo "${keys[@]}"
 }
+
+# Returns true if the specified key exists in the config file
+# Usage:
+#
+#   if config_has_key "key" ; then
+#     echo "key exists"
+#   fi
+#
+config_has_key() {
+  [[ $(config_get "$1") ]]
+}

data/lib/bashly/templates/lib/sample_function.sh

@@ -6,7 +6,7 @@
 # recommended to have a separate file for each function.
 #
 # Subdirectories will also be scanned for *.sh, so you have no reason not
-# to organize your code nearly.
+# to organize your code neatly.
 #
 sample_function() {
   echo "it works"

data/lib/bashly/templates/strings.yml

@@ -14,13 +14,14 @@ group: "%{group} Commands:"
 command_shortcut: "Shortcut: %{short}"
 default_command_summary: "%{summary} (default)"
 required: "(required)"
+default: "Default: %{value}"
 
 # Fixed flags help text
 help_flag_text: Show this help
 version_flag_text: Show version number
 
 # Error messages
-flag_requires_an_argument: "%{long} requires an argument: %{usage}"
+flag_requires_an_argument: "%{name} requires an argument: %{usage}"
 invalid_argument: "invalid argument: %s"
 invalid_flag: "invalid option: %s"
 missing_required_argument: "missing required argument: %{arg}\\nusage: %{usage}"

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.3.5"
+  VERSION = "0.4.0"
 end

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

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

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

@@ -0,0 +1,7 @@
+# :command.default_assignments
+<%- default_args.each do |arg| -%>
+[[ -n ${args[<%= arg.name %>]} ]] || args[<%= arg.name %>]="<%= arg.default %>"
+<%- end -%>
+<%- default_flags.each do |flag| -%>
+[[ -n ${args[<%= flag.long %>]} ]] || args[<%= flag.long %>]="<%= flag.default %>"
+<%- end -%>

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

@@ -6,7 +6,7 @@ case "$1" in
 --version | -v )
 <%- end -%>
   version_command
-  exit 1
+  exit
   ;;
 
 <%- if short_flag_exist? "-h" -%>

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

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

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

@@ -2,15 +2,15 @@
 <%= aliases.join " | " %> )
   <%- if arg -%>
   if [[ $2 && $2 != -* ]]; then
-    args[<%= long %>]="$2"
+    args[<%= name %>]="$2"
     shift
     shift
   else
-    printf "%s\n" "<%= strings[:flag_requires_an_argument] % { long: long, usage: usage_string } %>"
+    printf "%s\n" "<%= strings[:flag_requires_an_argument] % { name: name, usage: usage_string } %>"
     exit 1
   fi
   <%- else -%>
-  args[<%= long %>]=1
+  args[<%= name %>]=1
   shift
   <%- end -%>
   ;;

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-23 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -93,6 +93,7 @@ files:
 - lib/bashly/views/argument/usage.erb
 - lib/bashly/views/command/command_filter.erb
 - lib/bashly/views/command/command_functions.erb
+- lib/bashly/views/command/default_assignments.erb
 - lib/bashly/views/command/default_initialize_script.erb
 - lib/bashly/views/command/default_root_script.erb
 - lib/bashly/views/command/default_script.erb
@@ -141,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator