bashly 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01c46120b6cecba45cf9b55dd726ce4b66888ba3fc11d3383557a554ac51b154
-  data.tar.gz: 9682934a468d1624d05924f4ca5bd76d6438c26853fed1ad8098865dae669bc2
+  metadata.gz: 650f456561f180e0a39b2e6e0c66f6c5913438ac6301d44bff064470d602daba
+  data.tar.gz: 2f64d00edb50ce738d506568600d8b73b898aad6563990460a80a52d912a6e66
 SHA512:
-  metadata.gz: bb068fa1b263a1f820910b548cd48fde9cc1ae8607c50eea381361f9cbfe952581a4e1c9e54ac31e20a96c6ccba876d2a58b2f0ec6e8a59c3f8a467fbe0bde43
-  data.tar.gz: 653410059e779fffdf9aa28d8c23a0a2cc8d3ba0a7911651deaf2669fc1b4d744dc3a3824124ba79140813d331510ec14a1b47f852049c305ab47fe55fe9c89d
+  metadata.gz: 70427709c22c05bcfdfadb1daafaea8c87c5854b03488913c916ffb29861521c853eb5392f22c0c79b7bdc8fe359fc55389c0d6f0540493c250dd6ba1f7d79b5
+  data.tar.gz: 2b2aa5dc0525edc81ce3c023583b0d829907de9e1656a00fdb37d6cd87e0b4ab788e70e71fe51763a661006f8ce8fdf950a7c3e7ffcce095edec5cc799e942ed

data/README.md

@@ -3,22 +3,66 @@
 
 # Bashly - Bash CLI Framework and Generator
 
-Create beautiful bash scripts from simple YAML configuration
+Create feature-rich bash scripts using simple YAML configuration
 
 [![Gem Version](https://badge.fury.io/rb/bashly.svg)](https://badge.fury.io/rb/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)
 
+## [bashly.dannyb.co](https://bashly.dannyb.co)
+
 ---
 
 ![demo](demo/cast.svg)
 
 </div>
 
+Bashly is a command line application (written in Ruby) that lets you
+generate feature-rich bash command line tools.
+
+Bashly lets you focus on your specific code, without worrying about command line
+argument parsing, usage texts, error messages and other functions that are
+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).
+
+
 ## Documentation
 
-Visit the [Bashly Documentation][docs] site.
+- [Bashly Homepage][docs]
+- [Examples][examples]
+
+## How it works
+
+1. You provide a YAML configuration file, describing commands, sub-commands,
+   arguments, and flags. Running `bashly init` creates an initial sample YAML
+   file for you ([example](https://github.com/DannyBen/bashly/tree/master/examples/minimal#bashlyyml)).
+2. Bashly then automatically generates a bash script (when you run
+   `bashly generate`) that can parse and validate user input, provide help
+   messages, and run your code for each command ([example](https://github.com/DannyBen/bashly/blob/master/examples/minimal/download)).
+3. Your code for each command is kept in a separate file, and can be merged
+   again if you change it ([example](https://github.com/DannyBen/bashly/blob/master/examples/minimal/src/root_command.sh)).
+
+## Features
+
+Bashly is responsible for:
 
+- Generating a **single, standalone bash script**.
+- Generating **usage texts** and help screens, showing your tool's arguments, flags and commands (works for sub-commands also).
+- Parsing the user's command line and extracting:
+  - Optional or required **positional arguments**.
+  - Optional or required **option flags** (with or without flag arguments).
+  - **Commands** (and sub-commands).
+  - Standard flags (like **--help** and **--version**).
+- Preventing your script from running unless the command line is valid.
+- Providing you with a place to input your code for each of the functions your tool performs, and merging it back to the final script.
+- Providing you with additional (optional) framework-style, standard library functions:
+  - **Color output**.
+  - **Config file management** (INI format).
+  - **YAML parsing**.
+  - **Bash completions**.
+  - and more.
 
 ## Contributing / Support
 
@@ -29,4 +73,5 @@ to contribute, feel free to [open an issue][issues].
 
 [issues]: https://github.com/DannyBen/bashly/issues
 [docs]: https://bashly.dannyb.co/
+[examples]: https://github.com/DannyBen/bashly/tree/master/examples#bashly-examples
 

data/lib/bashly/models/command.rb

@@ -5,7 +5,7 @@ module Bashly
 
       # Returns the name to be used as an action.
       # - If it is the root command, the action is "root"
-      # - Else, it is all the parents, except the first tone (root) joined
+      # - Else, it is all the parents, except the first one (root) joined
       #   by space. For example, for a command like "docker container run"
       #   the action name is "container run".
       def action_name
@@ -54,6 +54,17 @@ module Bashly
         end
       end
 
+      # Returns true if catch_all is required
+      def catch_all_required?
+        catch_all.is_a?(Hash) and catch_all['required']
+      end
+
+      # Returns a string suitable for catch_all Usage pattern
+      def catch_all_usage
+        return nil unless catch_all
+        catch_all_required? ? catch_all_label : "[#{catch_all_label}]"
+      end
+
       # Returns only the names of the Commands
       def command_names
         commands.map &:name
@@ -190,7 +201,7 @@ module Bashly
           result << arg.usage_string
         end
         result << "[options]" unless flags.empty?
-        result << "[#{catch_all_label}]" if catch_all
+        result << catch_all_usage if catch_all
         result.join " "
       end
 

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.6.3"
+  VERSION = "0.6.4"
 end

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

@@ -0,0 +1,7 @@
+# :command.catch_all_filter
+<%- if catch_all_required? -%>
+if [[ ${#other_args[@]} -eq 0 ]]; then
+  printf "<%= strings[:missing_required_argument] % { arg: catch_all_label, usage: usage_string } %>\n"
+  exit 1
+fi
+<%- end -%>

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

@@ -16,7 +16,7 @@ case "$1" in
 <%- end -%>
   long_usage=yes
   <%= function_name %>_usage
-  exit 1
+  exit
   ;;
 
 esac

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(:catch_all_filter).indent 2 %>
 <%= render(:default_assignments).indent 2 %>
 <%= render(:whitelist_filter).indent 2 %>
 }

data/lib/bashly.rb

@@ -5,7 +5,6 @@ if ENV['BYEBUG']
   require 'lp'
 end
 
-requires 'bashly/polyfills'
 requires 'bashly/concerns'
 
 requires 'bashly/settings'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-25 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -102,7 +102,6 @@ files:
 - lib/bashly/models/environment_variable.rb
 - lib/bashly/models/flag.rb
 - lib/bashly/models/script.rb
-- lib/bashly/polyfills/hash.rb
 - lib/bashly/settings.rb
 - lib/bashly/templates/bashly.yml
 - lib/bashly/templates/lib/colors.sh
@@ -113,6 +112,7 @@ files:
 - lib/bashly/templates/strings.yml
 - lib/bashly/version.rb
 - lib/bashly/views/argument/usage.erb
+- lib/bashly/views/command/catch_all_filter.erb
 - lib/bashly/views/command/command_fallback.erb
 - lib/bashly/views/command/command_filter.erb
 - lib/bashly/views/command/command_functions.erb

data/lib/bashly/polyfills/hash.rb

@@ -1,12 +0,0 @@
-# :nocov:
-
-# Required for Ruby < 2.4
-if !Dir.respond_to? :empty?
-  class Dir
-    def self.empty?(path_name)
-      exist?(path_name) && (entries(path_name) - ['.', '..']).empty?
-    end
-  end
-end
-
-# :nocov: