bashly 0.4.5 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebe193249a02f2a5d25cd5a80a3172dbbc43ea16d18653368e4687841f19846c
-  data.tar.gz: d38bbde76e731eaf5a0455edc8b47ef011c6c8dba40ec9a220f7747bb98b238c
+  metadata.gz: 3a6c888335f32b6223149d91ed739e189ffbc6921afec05ff709380c76387338
+  data.tar.gz: b964b4ac7a5fa86f8766b350a3240ee00882be5cfc574e97f001a832a506e342
 SHA512:
-  metadata.gz: d0963491e70542e96061395cbe7568d8c77014024ca53bdf2e56c93c3a2588bd5d46ea9e6952d8d0c1166772e46d47f69227c0e45e763970120a805079cd60a8
-  data.tar.gz: 9896cbf1635cf43f30c42452273c93bed40fbb4d126d9dcf921fdc6a9609b3db70a0a2cee5e7753e8974a182b550c3976ac8d45d968399ed870f0c27ca43d73e
+  metadata.gz: e1e2757a735e55ffc4d4b27633d6df020184521ed8eb6377c0f26f8edd7442d28fb2a3c56c056de4558aab2204f7d522e15df6374f1962fcbaf26226f590d22b
+  data.tar.gz: a8aa77fba152f005136ff8ee8aacdc7236f15975042c4066f6d94e7e400133e2ca4137ffbbe9bc6f458c2aae2784aa956721d9179862cd78bf95ec6f99f39bd3

data/README.md

@@ -15,6 +15,7 @@ Create beautiful bash scripts from simple YAML configuration
 
 </div>
 
+
 ## Table of Contents
 
 - [Table of Contents](#table-of-contents)
@@ -24,18 +25,19 @@ Create beautiful bash scripts from simple YAML configuration
 - [Usage](#usage)
   - [Using the input arguments in your code](#using-the-input-arguments-in-your-code)
 - [Examples](#examples)
-  - [Sample configuration for a script without commands](#sample-configuration-for-a-script-without-commands)
-  - [Sample configuration for a script with commands](#sample-configuration-for-a-script-with-commands)
 - [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)
+- [Bash Completions](#bash-completions)
 - [Real World Examples](#real-world-examples)
 - [Contributing / Support](#contributing--support)
 
 ---
 
+
 ## Installation
 
 ```shell
@@ -74,6 +76,7 @@ Bahsly is responsible for:
   - Optional or required **option flags** (with or without flag arguments).
   - **Commands** (and subcommands).
   - 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
@@ -81,10 +84,20 @@ Bahsly is responsible for:
   - **Color output**.
   - **Config file management** (INI format).
   - **YAML parsing**.
+  - **Bash completions**.
   - 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
@@ -152,32 +165,11 @@ $ ./download a --force
 downloading a with --force
 ```
 
-## Examples
 
-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.
-
-
-### Sample configuration for a script without commands
-
-- Generate this script by running `bashly generate --minimal`
-- [See the initial sample bashly.yml file](examples/minimal/src/bashly.yml)
-- [See the generated bash script](examples/minimal/download)
-
-### Sample configuration for a script with commands
-
-- Generate this script by running `bashly generate`
-- [See the initial sample bashly.yml file](examples/commands/src/bashly.yml)
-- [See the generated bash script](examples/commands/cli)
-
-
-See the [examples](examples) folder for more examples.
+## Examples
 
+The [examples folder](examples#readme) contains many detailed and documented 
+example configuration files, with their output.
 
 
 ## Configuration Reference
@@ -203,14 +195,17 @@ command and subcommands (under the `commands` definition).
 `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.
+`completions` | Specify an array of additional completion suggestions when used in conjunction with `bashly add comp`. See [Bash Completions](#bash-completions).
 `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
 
@@ -247,9 +242,7 @@ 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
-
-The below configuration generates this environment variable usage text:
+### 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
@@ -262,6 +255,125 @@ set.
 `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.
+
+The `extensible` option 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).
+
+
+## Bash Completions
+
+Bashly comes with built-in bash completions generator, provided by the 
+[completely][completely] gem.
+
+By running any of the `bashly add comp` commands, you can add this
+functionality to your script in one of three ways:
+
+- `bashly add comp function` - creates a function in your `./src/lib` directory
+   that echoes a completion script. You can then call this function from any
+   command (for example `yourcli completions`) and your users will be able to 
+   install the completions by running `eval "$(yourcli completions)"`.
+- `bashly add comp script` - creates a standalone completion script that can be
+  sourced or copies to the system's bash completions directory.
+- `bashly add comp yaml` - creates the "raw data" YAML file. This is intended
+  mainly for development purposes.
+
+The bash completions generation is completely automatic, and you will have to 
+rerun the `bashly add comp *` command whenever you change your `bashly.yml` 
+file.
+
+In addition to suggesting subcommands and flags, you can instruct bashly to
+also suggest files, directories, users, git branches and more. To do this,
+add another option in your `bashly.yml` on the command you wish to alter:
+
+```yaml
+# bashly.yml
+commands:
+- name: upload
+  help: Upload a file
+  completions:
+  - <directory>
+  - <user>
+  - $(git branch 2> /dev/null)
+
+```
+
+- Anything between `<...>` will be added using the `compgen -A action` flag.
+- Anything else, will be appended to the `compgen -W` flag.
+
+For more information about these custom completions, see the documentation for
+the [completely][completely] gem.
+
+
 ## Real World Examples
 
 - [Rush][rush] - a Personal Package Manager
@@ -280,3 +392,5 @@ to contribute, feel free to [open an issue][issues].
 [rush]: https://github.com/DannyBen/rush-cli
 [alf]: https://github.com/DannyBen/alf
 [git-changelog]: https://github.com/DannyBen/git-changelog
+[completely]: https://github.com/DannyBen/completely
+[compgen]: https://www.gnu.org/software/bash/manual/html_node/Programmable-Completion-Builtins.html

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,12 +9,15 @@ module Bashly
         allowed
         arg
         catch_all
+        completions
         default
         dependencies
         description
         environment_variables
         examples
+        extensible
         flags
+        footer
         group
         help
         long

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

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.4.5"
+  VERSION = "0.6.1"
 end

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

@@ -0,0 +1,45 @@
+# :command.command_fallback
+<%- if default_command -%>
+"" )
+  <%= function_name %>_usage
+  exit 1
+  ;;
+
+* )
+  action="<%= default_command.name %>"
+  <%= default_command.function_name %>_parse_requirements "$@"
+  shift $#
+  ;;
+<%- elsif extensible.is_a? String -%>
+"" )
+  <%= function_name %>_usage
+  exit 1
+  ;;
+
+* )
+  if [[ -x "$(command -v "<%= extensible %>")" ]]; then
+    exec <%= extensible %> "$@"
+  else
+    <%= function_name %>_usage
+    exit 1
+  fi
+<%- elsif extensible -%>
+"" )
+  <%= function_name %>_usage
+  exit 1
+  ;;
+
+* )
+  if [[ -x "$(command -v "<%= function_name %>-$action")" ]]; then
+    shift
+    exec "<%= function_name %>-$action" "$@"
+  else
+    <%= function_name %>_usage
+    exit 1
+  fi
+<%- else -%>
+* )
+  <%= function_name %>_usage
+  exit 1
+  ;;
+<%- end -%>

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

@@ -15,25 +15,7 @@ case $action in
   ;;    
 
 <%- end -%>
-<%- if default_command -%>
-"" )
-  <%= function_name %>_usage
-  exit 1
-  ;;
-
-* )
-  action="<%= default_command.name %>"
-  <%= default_command.function_name %>_parse_requirements "$@"
-  shift $#
-  ;;
-
-<%- else -%>
-* )
-  <%= function_name %>_usage
-  exit 1
-  ;;
-
-<%- end -%>
+<%= render :command_fallback %>
 esac
 <%- else -%>
 action="<%= action_name %>"

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

@@ -0,0 +1,2 @@
+printf "<%= footer.gsub("\n", '\n').gsub('"', '\"') %>\n"
+echo

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

@@ -40,6 +40,7 @@
 <%= render(:usage_args).indent 4 if args.any? or catch_all_help %>
 <%= render(:usage_environment_variables).indent 4 if environment_variables.any? %>
 <%= render(:usage_examples).indent 4 if examples %>
+<%= render(:footer).indent 4 if footer %>
 
   fi
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.6.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2021-07-21 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
@@ -92,6 +113,7 @@ files:
 - lib/bashly/templates/strings.yml
 - lib/bashly/version.rb
 - lib/bashly/views/argument/usage.erb
+- lib/bashly/views/command/command_fallback.erb
 - lib/bashly/views/command/command_filter.erb
 - lib/bashly/views/command/command_functions.erb
 - lib/bashly/views/command/default_assignments.erb
@@ -101,6 +123,7 @@ files:
 - lib/bashly/views/command/dependencies_filter.erb
 - lib/bashly/views/command/environment_variables_filter.erb
 - lib/bashly/views/command/fixed_flags_filter.erb
+- lib/bashly/views/command/footer.erb
 - lib/bashly/views/command/function.erb
 - lib/bashly/views/command/initialize.erb
 - lib/bashly/views/command/inspect_args.erb
@@ -139,7 +162,7 @@ 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:
   - - ">="