summaryrefslogtreecommitdiff
path: root/home/.oh-my-zsh/plugins/gem
diff options
context:
space:
mode:
authornavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
committernavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
commit02f14a9cb152561a5e44062aac79f3b700403b40 (patch)
tree2db8ebda3b7f6f8777783aeb5c60018e6e1359d8 /home/.oh-my-zsh/plugins/gem
parentcbbdeb2f6b40a102a829f0c47cff052937231f00 (diff)
omz
Diffstat (limited to 'home/.oh-my-zsh/plugins/gem')
-rw-r--r--home/.oh-my-zsh/plugins/gem/README.md17
-rw-r--r--home/.oh-my-zsh/plugins/gem/completions/_gem72
-rw-r--r--home/.oh-my-zsh/plugins/gem/gem.plugin.zsh32
3 files changed, 121 insertions, 0 deletions
diff --git a/home/.oh-my-zsh/plugins/gem/README.md b/home/.oh-my-zsh/plugins/gem/README.md
new file mode 100644
index 0000000..decd87b
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/gem/README.md
@@ -0,0 +1,17 @@
+# Gem plugin
+
+This plugin adds completions and aliases for [Gem](https://rubygems.org/). The completions include the common `gem` subcommands as well as the installed gems in the current directory.
+
+To use it, add `gem` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... gem)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+|----------------------|-------------------------------|--------------------------------------------|
+| gemb | `gem build *.gemspec` | Build a gem from a gemspec |
+| gemp | `gem push *.gem` | Push a gem up to the gem server |
+| gemy [gem] [version] | `gem yank [gem] -v [version]` | Remove a pushed gem version from the index |
diff --git a/home/.oh-my-zsh/plugins/gem/completions/_gem b/home/.oh-my-zsh/plugins/gem/completions/_gem
new file mode 100644
index 0000000..92feebe
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/gem/completions/_gem
@@ -0,0 +1,72 @@
+#compdef gem
+#autoload
+
+# gem zsh completion, based on homebrew completion
+
+_gem_installed() {
+ installed_gems=(${(f)"$(gem list --local --no-versions)"})
+}
+
+local -a _1st_arguments
+
+_1st_arguments=(
+ 'build:Build a gem from a gemspec'
+ 'cert:Manage RubyGems certificates and signing settings'
+ 'check:Check a gem repository for added or missing files'
+ 'cleanup:Clean up old versions of installed gems in the local repository'
+ 'contents:Display the contents of the installed gems'
+ 'dependency:Show the dependencies of an installed gem'
+ 'environment:Display information about the RubyGems environment'
+ 'fetch:Download a gem and place it in the current directory'
+ 'generate_index:Generates the index files for a gem server directory'
+ 'help:Provide help on the `gem` command'
+ 'install:Install a gem into the local repository'
+ 'list:Display gems whose name starts with STRING'
+ 'lock:Generate a lockdown list of gems'
+ 'mirror:Mirror all gem files (requires rubygems-mirror)'
+ 'outdated:Display all gems that need updates'
+ 'owner:Manage gem owners on RubyGems.org.'
+ 'pristine:Restores installed gems to pristine condition from files located in the gem cache'
+ 'push:Push a gem up to RubyGems.org'
+ 'query:Query gem information in local or remote repositories'
+ 'rdoc:Generates RDoc for pre-installed gems'
+ 'search:Display all gems whose name contains STRING'
+ 'server:Documentation and gem repository HTTP server'
+ 'sources:Manage the sources and cache file RubyGems uses to search for gems'
+ 'specification:Display gem specification (in yaml)'
+ 'stale:List gems along with access times'
+ 'uninstall:Uninstall gems from the local repository'
+ 'unpack:Unpack an installed gem to the current directory'
+ 'update:Update installed gems to the latest version'
+ 'which:Find the location of a library file you can require'
+ 'yank:Remove a specific gem version release from RubyGems.org'
+)
+
+local expl
+local -a gems installed_gems
+
+_arguments \
+ '(-v --version)'{-v,--version}'[show version]' \
+ '(-h --help)'{-h,--help}'[show help]' \
+ '*:: :->subcmds' && return 0
+
+if (( CURRENT == 1 )); then
+ _describe -t commands "gem subcommand" _1st_arguments
+ return
+fi
+
+case "$words[1]" in
+ build)
+ _files -g "*.gemspec"
+ ;;
+ install)
+ _files ;;
+ list)
+ if [[ "$state" == forms ]]; then
+ _gem_installed
+ _requested installed_gems expl 'installed gems' compadd -a installed_gems
+ fi ;;
+ uninstall|update)
+ _gem_installed
+ _wanted installed_gems expl 'installed gems' compadd -a installed_gems ;;
+esac
diff --git a/home/.oh-my-zsh/plugins/gem/gem.plugin.zsh b/home/.oh-my-zsh/plugins/gem/gem.plugin.zsh
new file mode 100644
index 0000000..41c434a
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/gem/gem.plugin.zsh
@@ -0,0 +1,32 @@
+alias gemb="gem build *.gemspec"
+alias gemp="gem push *.gem"
+
+# gemy GEM 0.0.0 = gem yank GEM -v 0.0.0
+function gemy {
+ gem yank $1 -v $2
+}
+
+# If the completion file doesn't exist yet, we need to autoload it and
+# bind it to `gem`. Otherwise, compinit will have already done that.
+if [[ ! -f "$ZSH_CACHE_DIR/completions/_gem" ]]; then
+ typeset -g -A _comps
+ autoload -Uz _gem
+ _comps[gem]=_gem
+fi
+
+# zsh 5.5 already provides completion for `_gem`. With this we ensure that
+# our provided completion (which is not optimal but is enough in most cases)
+# is used for older versions
+autoload -Uz is-at-least
+if is-at-least 5.5; then
+ return 0
+fi
+
+{
+ # Standardized $0 handling
+ # https://zdharma-continuum.github.io/Zsh-100-Commits-Club/Zsh-Plugin-Standard.html
+ 0="${${ZERO:-${0:#$ZSH_ARGZERO}}:-${(%):-%N}}"
+ 0="${${(M)0:#/*}:-$PWD/$0}"
+
+ command cp -f "${0:h}/completions/_gem" "$ZSH_CACHE_DIR/completions/_gem"
+} &|