bashly 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca34648c628c4e7fe167d5f5b0d253792e9b4d3c494b253ed68d0127e4935572
-  data.tar.gz: 5247da7780a8424dd0a808ace6d182ed4284597e094122d94a8716bfca8f343b
+  metadata.gz: 7fe733a46c8634cc39b4c792b177ca9ac7610a8d408714fa482b3c0ad15fc10f
+  data.tar.gz: 908960de1cb2d682ff801630e0f6667a42df171612ed6a92aee72bcc369cc0e2
 SHA512:
-  metadata.gz: 2145d1f4125d762c3d583f560c4caa9f4b98cfc2500e7e7b9ac977f4284a190a150a26da6e935c4e59c689f5efcd627924a10091cff0d4d91f00c3f60d26b943
-  data.tar.gz: 9df4695f43e4c57371f876de1dee3eab587bb227b7b0ee51d52d1772faf119cbd59cb117f5a1e3cbb06ef49b5796cd02b6fecba685b733aa35c51442fe9baf19
+  metadata.gz: 9e0dcf39faf63d5d798fac7ed41768994ec6715a58b898e390ec2a6019948497d314c08bc8ce1041fb5f1a105884a04d759e258085fdcf7fbbe87af1c4a7a4e0
+  data.tar.gz: 83279b0a7df6eb6f3c2a779bbc54221e9cad58e6e08c4a207f1d592aa12329cc488d7169b682191be02474f098dbfda0f3d6ad6cd03e3a91e1bf793bb29fcdc3

data/README.md

@@ -31,6 +31,7 @@ Create beautiful bash scripts from simple YAML configuration
   - [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)
 
@@ -75,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
@@ -82,6 +84,7 @@ Bahsly is responsible for:
   - **Color output**.
   - **Config file management** (INI format).
   - **YAML parsing**.
+  - **Bash completions**.
   - and more.
 
 
@@ -198,6 +201,7 @@ command and subcommands (under the `commands` definition).
 `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.
@@ -263,7 +267,7 @@ 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.
+The `extensible` option supports two operation modes:
 
 ### Extension Mode (`extensible: true`)
 
@@ -326,6 +330,71 @@ 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` 
+script.
+
+In addition to suggesting subcommands and flags, you can instruct bashly to
+also suggest files, directories, users 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]
+
+```
+
+Valid completion additions are:
+
+| Keyword     | Meaning
+|-------------|---------------------
+| `alias`     | Alias names
+| `arrayvar`  | Array variable names
+| `binding`   | Readline key binding names
+| `builtin`   | Names of shell builtin commands
+| `command`   | Command names
+| `directory` | Directory names
+| `disabled`  | Names of disabled shell builtins
+| `enabled`   | Names of enabled shell builtins
+| `export`    | Names of exported shell variables
+| `file`      | File names
+| `function`  | Names of shell functions
+| `group`     | Group names
+| `helptopic` | Help topics as accepted by the help builtin
+| `hostname`  | Hostnames, as taken from the file specified by the HOSTFILE shell variable
+| `job`       | Job names
+| `keyword`   | Shell reserved words
+| `running`   | Names of running jobs
+| `service`   | Service names
+| `signal`    | Signal names
+| `stopped`   | Names of stopped jobs
+| `user`      | User names
+| `variable`  | Names of all shell variables
+
+Note that these are taken from the [Programmable Completion Builtin][compgen], 
+and will simply be added using the `compgen -A action` command.
+
+
 ## Real World Examples
 
 - [Rush][rush] - a Personal Package Manager
@@ -344,3 +413,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,50 @@
+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_actions
+      completions ? completions.map { |c| "<#{c}>" } : []
+    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 + completion_actions
+      )
+
+      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

data/lib/bashly/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-02 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
@@ -141,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:
   - - ">="