bashly 0.5.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca34648c628c4e7fe167d5f5b0d253792e9b4d3c494b253ed68d0127e4935572
-  data.tar.gz: 5247da7780a8424dd0a808ace6d182ed4284597e094122d94a8716bfca8f343b
+  metadata.gz: 01c46120b6cecba45cf9b55dd726ce4b66888ba3fc11d3383557a554ac51b154
+  data.tar.gz: 9682934a468d1624d05924f4ca5bd76d6438c26853fed1ad8098865dae669bc2
 SHA512:
-  metadata.gz: 2145d1f4125d762c3d583f560c4caa9f4b98cfc2500e7e7b9ac977f4284a190a150a26da6e935c4e59c689f5efcd627924a10091cff0d4d91f00c3f60d26b943
-  data.tar.gz: 9df4695f43e4c57371f876de1dee3eab587bb227b7b0ee51d52d1772faf119cbd59cb117f5a1e3cbb06ef49b5796cd02b6fecba685b733aa35c51442fe9baf19
+  metadata.gz: bb068fa1b263a1f820910b548cd48fde9cc1ae8607c50eea381361f9cbfe952581a4e1c9e54ac31e20a96c6ccba876d2a58b2f0ec6e8a59c3f8a467fbe0bde43
+  data.tar.gz: 653410059e779fffdf9aa28d8c23a0a2cc8d3ba0a7911651deaf2669fc1b4d744dc3a3824124ba79140813d331510ec14a1b47f852049c305ab47fe55fe9c89d

data/README.md

@@ -15,322 +15,9 @@ Create beautiful bash scripts from simple YAML configuration
 
 </div>
 
+## Documentation
 
-## Table of Contents
-
-- [Table of Contents](#table-of-contents)
-- [Installation](#installation)
-- [Prerequisites](#prerequisites)
-- [What is Bashly](#what-is-bashly)
-- [Usage](#usage)
-  - [Using the input arguments in your code](#using-the-input-arguments-in-your-code)
-- [Examples](#examples)
-- [Configuration Reference](#configuration-reference)
-  - [Command options](#command-options)
-  - [Argument options](#argument-options)
-  - [Flag options](#flag-options)
-  - [Environment Variable options](#environment-variable-options)
-- [Extensible Scripts](#extensible-scripts)
-- [Real World Examples](#real-world-examples)
-- [Contributing / Support](#contributing--support)
-
----
-
-
-## Installation
-
-```shell
-$ 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
-
-Bashly is a command line application (written in Ruby) that lets you generate
-feature-rich bash command line tools.
-
-The design intention is to let 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.
-
-Bahsly 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 subcommands 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 subcommands).
-  - Standard flags (like **--help** and **--version**).
-- 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**.
-  - and more.
-
-
-## Usage
-
-The `bashly.yml` file can be set up to generate two types of scripts:
-
-1. Script with commands (for example, like `docker` or `git`).
-2. Script without commands (for example, like `ls`)
-
-This is detected automatically by the contents of the configuration: If it
-contains a `commands` definition, it will generate a script with commands.
-
-In an empty directory, create a sample configuration file by running
-
-```shell
-$ bashly init
-# or, to generate a simpler configuration:
-$ bashly init --minimal
-```
-
-This will create a sample `src/bashly.yml` file.
-You can edit this file to specify which arguments, flags and commands you
-need in your bash script.
-
-Then, generate an initial bash script and function placeholder scripts by
-running
-
-```shell
-$ bashly generate
-```
-
-This will:
-
-1. Create the bash executable script.
-2. Create files for you to edit in the `src` folder.
-
-Finally, edit the files in the `src` folder. Each of your script's commands
-get their own file. Once you edit, run `bashly generate` again to merge the
-content from your functions back into the script.
-
-### Using the input arguments in your code
-
-In order to access the parsed arguments in any of your partial scripts, you
-may simply access the `$args` associative array.
-
-For example:
-
-1. Generate a minimal configuration with `bashly init --minimal`
-2. Generate the bash script with `bashly generate`
-3. Run the script with `./download hello --force`
-
-You will notice that all the arguments of the associative array are printed 
-on screen. This is done by the `inspect_args` function that was inserted into
-the generated partial script `src/root_command.sh`.
-
-You can now access these variables by modifying `sec/root_command.sh` like
-this:
-
-
-```bash
-# src/root_command.sh
-source_url=${args[source]}
-force=${args[--force]}
-
-if [[ $force ]]; then
-  echo "downloading $source_url with --force"
-else
-  echo "downloading $source_url"
-fi
-```
-
-After editing the file, run `bashly generate` (or `bashly g` for short) and
-run:
-
-```
-$ ./download a --force
-downloading a with --force
-```
-
-
-## Examples
-
-The [examples folder](examples#readme) contains many detailed and documented 
-example configuration files, with their output.
-
-
-## Configuration Reference
-
-The `bashly.yml` configuration file consists of these types:
-
-- [Command](#command-options) - defines the root command as well as any 
-  subcommand.
-- [Argument](#argument-options) - defines positional arguments.
-- [Flag](#flag-options) - defines option flags.
-- [Environment Variable](#environment-variable-options) - defines 
-  environment variables required (or desired) by your script.
-
-### Command options
-
-Unless otherwise specified, these definitions can be used for both the root
-command and subcommands (under the `commands` definition).
-
- Option    | Description
------------|-------------
-`name`     | The name of the script or subcommand.
-`short`    | An additional, optional pattern - usually used to denote a one letter variation of the command name. You can add `*` as a suffix, to denote a "starts with" pattern - for example `short: m*`. *Applicable only in subcommands*.
-`help`     | The header text to display when using `--help`. This option can have multiple lines. In this case, the first line will be used as summary wherever appropriate.
-`version`  | The string to display when using `--version`. *Applicable only in the main command*.
-`default`  | Setting this to `true` on any command, will cause any unrecognized command line to be passed to this command. *Applicable only in subcommands*.
-`extensible` | Specify that this command can be [externally extended](#extensible-scripts). *Applicable only in the main command*.
-`examples` | Specify an array of examples to show when using `--help`. Each example can have multiple lines.
-`environment_variables` | Specify an array of [environment variables](#environment-variable-options) needed by your script. 
-`commands` | Specify the array of [commands](#command-options). Each command will have its own args and flags. Note: if `commands` is provided, you cannot specify flags or args at the same level.
-`args`     | Specify the array of [positional arguments](#argument-options) this script needs.
-`flags`    | Specify the array of option [flags](#flag-options) this script needs.
-`catch_all` | Specify that this command should allow for additional arbitrary arguments or flags. It can be set in one of three ways:<br>- Set to `true` to just enable it.<br>- Set to a string, to use this string in the usage help text.<br>- Set to a hash containing `label` and `help` keys, to show a detailed help for it when running with `--help`.
-`dependencies` | Specify an array of any required external dependencies (commands). The script execution will be halted with a friendly error unless all dependency commands exist.
-`group`    | In case you have many commands, use this option to specify a caption to display before this command. This option is purely for display purposes, and needs to be specified only for the first command in each group.
-`footer` | Add a custom message that will be displayed at the end of the `--help` text. 
-
-### Argument options
-
-The argument's value will be available to you as `${args[user]}` in your 
-bash function.
-
- Option    | Description
------------|-------------
-`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.
-`allowed`  | Limit the allowed values by providing an array.
-
-### Flag options
-
-The flag's value will be available to you as `${args[--output]}` in your 
-bash function (regardless of whether the user provided it with the long or 
-short form).
-
- Option    | Description
------------|-------------
-`long`     | The long form of the flag.
-`short`    | The short form of the flag.
-`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.
-`allowed`  | For flags with an argument, you can limit the allowed values by providing an array.
-
-#### Special handling for -v and -h
-
-The `-v` and `-h` flags will be used as the short options for `--version` and
-`--help` respectively **only if you are not using them in any of your own
-flags**.
-
-### Environment variable options
-
-If an environment variable is defined as required (false by default), the
-execution of the script will be halted with a friendly error if it is not
-set.
-
- Option    | Description
------------|-------------
-`name`     | The name of the variable (it will be automatically capitalized).
-`help`     | The message to display when using --help. Can have multiple lines.
-`required` | Specify if this variable is required.
-
-
-## Extensible Scripts
-
-You may configure your generated bash script to delegate any unknown command
-to an external executable, by setting the `extensible` option to either `true`,
-or to a different external command.
-
-This is similar to how `git` works. When you execute `git whatever`, the `git`
-command will look for a file named `git-whatever` in the path, and execute it.
-
-Note that this option cannot be specified together with the `default` option,
-since both specify a handler for unknown commands.
-
-Bashly supports two operation modes.
-
-### Extension Mode (`extensible: true`)
-
-By setting `extensible` to `true`, a specially named executable will be called
-when an unknown command is called by the user.
-
-Given this `bashly.yml` configuration:
-
-```yaml
-name: myscript
-help: Example
-version: 0.1.0
-extensible: true
-
-commands:
-- name: upload
-  help: Upload a file
-```
-
-And this user command:
-
-```
-$ myscript something
-
-```
-
-The generated script will look for an executable named `myscript-something` 
-in the path. If found, it will be called.
-
-See the [extensible example](examples/extensible).
-
-
-### Delegate Mode (`extensible: <executable name>`)
-
-By setting `extensible` to any string, unknown command calls by the user will
-be delegated to the executable with that name.
-
-Given this `bashly.yml` configuration:
-
-```yaml
-name: mygit
-help: Example
-version: 0.1.0
-extensible: git
-
-commands:
-- name: push
-  help: Push to my repository
-```
-
-And this user command:
-
-```
-$ mygit status
-
-```
-
-The generated script will execute `git status`.
-
-See the [extensible-delegate example](examples/extensible-delegate).
-
-
-## 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
+Visit the [Bashly Documentation][docs] site.
 
 
 ## Contributing / Support
@@ -341,6 +28,5 @@ 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
+[docs]: https://bashly.dannyb.co/
+

data/lib/bashly/commands/add.rb

@@ -8,15 +8,24 @@ module Bashly
       usage "bashly add config [--force]"
       usage "bashly add colors [--force]"
       usage "bashly add yaml [--force]"
+      usage "bashly add comp FORMAT [OUTPUT]"
       usage "bashly add (-h|--help)"
 
       option "-f --force", "Overwrite existing files"
 
+      param "FORMAT", "Output format, can be one of:\n  function : generate a function file to be included in your script.\n  script   : generate a standalone bash completions script.\n  yaml     : generate a yaml compatible with completely."
+      param "OUTPUT", "For the 'comp function' command: Name of the generated function.\nFor the 'comp script' or 'comp yaml' commands: path to output file.\nIn all cases, this is optional and will have sensible defaults."
+
       command "strings", "Copy an additional configuration file to your project, allowing you to customize all the tips and error strings."
       command "lib", "Create the additional lib directory for additional user scripts. All *.sh scripts in this folder will be included in the final bash script."
       command "config", "Add standard functions for handling INI files to the lib directory."
       command "colors", "Add standard functions for printing colorful and formatted text to the lib directory."
       command "yaml", "Add standard functions for reading YAML files to the lib directory."
+      command "comp", "Generate a bash completions script or function."
+
+      example "bashly add strings --force"
+      example "bashly add comp function"
+      example "bashly add comp script completions.bash"
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
 
@@ -40,7 +49,25 @@ module Bashly
         safe_copy_lib "yaml.sh"
       end
 
+      def comp_command
+        format = args['FORMAT']
+        output = args['OUTPUT']
+        
+        case format
+        when "function"
+          save_comp_function output
+        when "yaml"
+          save_comp_yaml output
+        when "script"
+          save_comp_script output
+        else
+          raise Error, "Unrecognized format: #{format}"
+        end
+
+      end
+
     private
+
       def safe_copy_lib(libfile)
         safe_copy asset("templates/lib/#{libfile}"), "#{Settings.source_dir}/lib/#{libfile}"
       end
@@ -63,6 +90,61 @@ module Bashly
         FileUtils.mkdir_p target_dir unless Dir.exist? target_dir
         FileUtils.cp source, target
       end
+
+      def config
+        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
+      end
+
+      def command
+        @command ||= Models::Command.new config
+      end
+
+      def completions
+        @completions ||= command.completion_data
+      end
+
+      def completions_script
+        @completions_script ||= command.completion_script
+      end
+
+      def completions_function
+        @completions_function ||= command.completion_function
+      end
+
+      def save_comp_yaml(filename = nil)
+        filename ||= "#{Settings.target_dir}/completions.yml"
+        File.write filename, completions.to_yaml
+        say "created !txtgrn!#{filename}"
+        say ""
+        say "This file can be converted to a completions script using the !txtgrn!completely!txtrst! gem."
+      end
+
+      def save_comp_script(filename = nil)
+        filename ||= "#{Settings.target_dir}/completions.bash"
+        File.write filename, completions_script
+        say "created !txtgrn!#{filename}"
+        say ""
+        say "In order to enable completions, run:"
+        say ""
+        say "  !txtpur!$ source #{filename}"
+      end
+
+      def save_comp_function(name = nil)
+        name ||= "send_completions"
+        target_dir = "#{Settings.source_dir}/lib"
+        filename = "#{target_dir}/#{name}.sh"
+        
+        FileUtils.mkdir_p target_dir unless Dir.exist? target_dir
+        File.write filename, completions_function
+
+        say "created !txtgrn!#{filename}"
+        say ""
+        say "In order to use it in your script, create a command or a flag (for example: !txtgrn!#{command.name} completions!txtrst! or !txtgrn!#{command.name} --completions!txtrst!) that calls the !txtgrn!#{name}!txtrst! function."
+        say "Your users can then run something like this to enable completions:"
+        say ""
+        say "  !txtpur!$ eval \"$(#{command.name} completions)\""
+      end
+
     end
   end
 end

data/lib/bashly/concerns/completions.rb

@@ -0,0 +1,47 @@
+require 'completely'
+
+module Bashly
+  # This is a `Command` concern responsible for providing bash completion data
+  module Completions
+    def completion_data(with_version: true)
+      result = { full_name => completion_words(with_version: with_version) }
+      
+      commands.each do |command|
+        result.merge! command.completion_data(with_version: false)
+      end
+
+      result
+    end
+
+    def completion_script
+      completion_generator.script
+    end
+
+    def completion_function(name = nil)
+      completion_generator.wrapper_function(name)
+    end
+
+  private
+
+    def completion_generator
+      Completely::Completions.new(completion_data)
+    end
+
+    def completion_flag_names
+      flags.map(&:name) + flags.map(&:short)
+    end
+
+    def completion_words(with_version: false)
+      trivial_flags = %w[--help -h]
+      trivial_flags += %w[--version -v] if with_version
+      all = (
+        command_names + trivial_flags +
+        completion_flag_names
+      )
+
+      all += completions if completions
+      all.compact.uniq.sort
+    end
+
+  end
+end

data/lib/bashly/concerns/renderable.rb

@@ -4,10 +4,7 @@ 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)
+      ERB.new(template, trim_mode: '%-').result(binding)
     end
 
     def strings

data/lib/bashly/models/base.rb

@@ -9,6 +9,7 @@ module Bashly
         allowed
         arg
         catch_all
+        completions
         default
         dependencies
         description

data/lib/bashly/models/command.rb

@@ -1,6 +1,8 @@
 module Bashly
   module Models
     class Command < Base
+      include Completions
+
       # 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
@@ -90,6 +92,11 @@ module Bashly
         commands.find { |c| c.default }
       end
 
+      # Returns an array of all the default Environment Variables
+      def default_environment_variables
+        environment_variables.select &:default
+      end
+
       # Returns an array of all the default Flags
       def default_flags
         flags.select &:default

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

@@ -17,7 +17,7 @@ config_init() {
   [[ -f "$CONFIG_FILE" ]] || touch "$CONFIG_FILE"
 }
 
-# Get a value from the config
+# Get a value from the config.
 # Usage: result=$(config_get hello)
 config_get() {
   key=$1
@@ -66,7 +66,7 @@ config_set() {
   printf "%b\n" "$output" > "$CONFIG_FILE"
 }
 
-# Delete a key from teh config.
+# Delete a key from the config.
 # Usage: config_del key
 config_del() {
   key=$1
@@ -92,7 +92,7 @@ config_show() {
   cat "$CONFIG_FILE"
 }
 
-# Return an array of the keys in the config file
+# Return an array of the keys in the config file.
 # Usage:
 #
 #   for k in $(config_keys); do
@@ -114,7 +114,7 @@ config_keys() {
   echo "${keys[@]}"
 }
 
-# Returns true if the specified key exists in the config file
+# Returns true if the specified key exists in the config file.
 # Usage:
 #
 #   if config_has_key "key" ; then

data/lib/bashly/templates/strings.yml

@@ -31,3 +31,4 @@ missing_required_environment_variable: "missing required environment variable: %
 missing_dependency: "missing dependency: %{dependency}"
 disallowed_flag: "%{name} must be one of: %{allowed}"
 disallowed_argument: "%{name} must be one of: %{allowed}"
+unsupported_bash_version: "bash version 4 or higher is required"

data/lib/bashly/version.rb

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

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

@@ -1,4 +1,9 @@
 # :command.environment_variables_filter
+<%- if default_environment_variables.any? -%>
+<%- default_environment_variables.each do |env_var| -%>
+export <%= env_var.name.upcase %>="${<%= env_var.name.upcase %>:-<%= env_var.default %>}"
+<%- end -%>
+<%- end -%>
 <%- if required_environment_variables.any? -%>
 <%- required_environment_variables.each do |env_var| -%>
 if [[ -z "$<%= env_var.name.upcase %>" ]]; then

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

@@ -2,7 +2,12 @@
 initialize() {
   version="<%= version %>"
   long_usage=''
-  set -e  
+  set -e
+
+  if [[ "${BASH_VERSINFO:-0}" -lt 4 ]]; then
+    printf "<%= strings[:unsupported_bash_version] -%>\n"
+    exit 1
+  fi
 
 <%= load_user_file("initialize.sh", placeholder: false).indent 2 %>
 }

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

@@ -1,4 +1,7 @@
 # :environment_variable.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.5.1
+  version: 0.6.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-02 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -24,6 +24,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: completely
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: mister_bin
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +89,7 @@ files:
 - lib/bashly/commands/init.rb
 - lib/bashly/commands/preview.rb
 - lib/bashly/concerns/asset_helper.rb
+- lib/bashly/concerns/completions.rb
 - lib/bashly/concerns/renderable.rb
 - lib/bashly/config.rb
 - lib/bashly/exceptions.rb
@@ -141,14 +162,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator