renuo-cli 4.21.2 → 4.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9120767921d12d64d169446d7dc3a7e0329f498e80fc5c4f4afca46583ff9418
-  data.tar.gz: e16008accec27c375cb831856ce4fb9acce1ac2630fcdae9dfffcbc0a9a63c2f
+  metadata.gz: 13ccfc20af1ba9cda74f9ffb3a9b8f24cbbf34808a4d94e5baab28f6da384d26
+  data.tar.gz: ac1d41b13a258f07268bb78ed0f6b697eaf4abd2ffe4ae324b4c41880bb253df
 SHA512:
-  metadata.gz: 93c42b19caa65fb26adf806fe0079c842b6ed8661aaaa639ed5325bc4cd64d62d783363a6374db2aed5b3df50bc6769af4220b703359f75c0a38f5ef77dbc0c8
-  data.tar.gz: 3966f6f6510994401559c46b32931645d51f726d84a67a402977b5df6d9640b8e146c3208f04d54c05c3e0decee308c54da9a3c952a8ce6a068af637a2551c53
+  metadata.gz: 72fa17d236d416cb18c8f99d1e463ee8e90c6740102348df812090269c996337fad30a48c953f94ad31fc710f835d311dbf45a8190eb9e982398f7d404d88358
+  data.tar.gz: d0cf0de0355ae2b5bef63e1209b74fd818a362072054386106c495035df5c67053b3e1e18a79eecb480812dfe801acc1974b9f8e3d97dc9e198231c42db0ad0d

data/README.md

@@ -14,6 +14,16 @@ gem install renuo-cli
 renuo -h
 ```
 
+### Shell Autocompletion
+
+To enable zsh autocompletion for renuo-cli commands:
+
+```sh
+renuo setup-autocompletion
+```
+
+This will install the completion script and provide instructions to add it to your shell configuration.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/renuo/cli/commands/configure_semaphore.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class Renuo::Cli::Commands::ConfigureSemaphore
+  include CredentialsHelper
+
   attr_accessor :project_name, :environment, :slack_endpoint
 
   command "configure-semaphore" do |c|
@@ -13,7 +15,7 @@ class Renuo::Cli::Commands::ConfigureSemaphore
 
   def initialize
     @project_name = File.basename(Dir.getwd)
-    @slack_endpoint = "https://hooks.slack.com/services/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"
+    @slack_endpoint = credentials[:slack_endpoint]
   end
 
   def run # rubocop:disable Metrics/MethodLength

data/lib/renuo/cli/commands/create_deploio_app.rb

@@ -175,6 +175,7 @@ class Renuo::Cli::Commands::CreateDeploioApp # rubocop:disable Metrics/ClassLeng
         --basic-auth=#{environment == "develop"} \\
         --build-env=SECRET_KEY_BASE="$(rails secret)" \\
         --language=ruby \\
+        --buildpack-stack=heroku \\
         --size=mini
     OUTPUT
   end

data/lib/renuo/cli/commands/setup_autocompletion.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "../helpers/commander_introspector"
+require_relative "../helpers/zsh_completion_script"
+
+class Renuo::Cli::Commands::SetupAutocompletion
+  include CommandHelper
+
+  COMPLETION_DIR = File.expand_path("~/.zfunc")
+  COMPLETION_FILENAME = "_renuo"
+  COMPLETION_FILE_PATH = File.join(COMPLETION_DIR, COMPLETION_FILENAME)
+  VERSION_STAMP_PREFIX = "# renuo-cli-version: "
+
+  command "setup-autocompletion" do |c|
+    c.syntax = "renuo setup-autocompletion"
+    c.summary = "Sets up zsh autocompletion for renuo-cli"
+    c.description = "Installs zsh autocompletion script for renuo-cli commands and options"
+    c.example "renuo setup-autocompletion", "Sets up zsh autocompletion"
+    c.action { new.run }
+  end
+
+  def self.refresh_if_stale
+    return unless File.exist?(COMPLETION_FILE_PATH)
+    return if File.foreach(COMPLETION_FILE_PATH).first(2).last&.include?("#{VERSION_STAMP_PREFIX}#{Renuo::Cli::VERSION}")
+
+    new.write_completion_file(silent: true)
+  end
+
+  def run
+    write_completion_file
+    print_installation_instructions
+  end
+
+  def write_completion_file(silent: false)
+    say "Setting up zsh autocompletion for renuo-cli...".colorize(:green) unless silent
+    FileUtils.mkdir_p(COMPLETION_DIR)
+    File.write(COMPLETION_FILE_PATH, stamped_script)
+    say "✓ Completion script installed to #{COMPLETION_FILE_PATH}".colorize(:green) unless silent
+  end
+
+  private
+
+  def stamped_script
+    script = completion_script
+    first_line, rest = script.split("\n", 2)
+    "#{first_line}\n#{VERSION_STAMP_PREFIX}#{Renuo::Cli::VERSION}\n#{rest}"
+  end
+
+  def completion_script
+    ZshCompletionScript.new(CommanderIntrospector.commands_data).render
+  end
+
+  def print_installation_instructions
+    say ""
+    say "To enable autocompletion, add the following to your ~/.zshrc:".colorize(:blue)
+    say ""
+    say "  # Enable renuo-cli autocompletion"
+    say "  fpath+=#{COMPLETION_DIR}"
+    say ""
+    say "Then restart your shell or run:".colorize(:blue)
+    say "  exec zsh"
+    say "On the next renuo-cli update, the completion script will be automatically refreshed".colorize(:cyan)
+  end
+end

data/lib/renuo/cli/credentials.yml.enc

@@ -0,0 +1 @@
+kQgNz+OSHLaY1YKXAXJi5Nb/qP2N2+2BHy2anqFasu1HBitNqrEfV+rfFKNfzFY1hNtAezy3SiCA3csD3jsIa7Ew/UHcys493oGNF6p9m07y7/gE+sK4fiQVIRMWxVZ7RPy5qszve+E=--emz3hoXKrKnjz9cq--GxOYIZ9IVxnCjhrg/3kHpQ==

data/lib/renuo/cli/helpers/commander_introspector.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "shellwords"
+
+module CommanderIntrospector
+  module_function
+
+  HELP_FLAGS = ["-h", "--help"].freeze
+
+  def commands_data
+    runner_commands = Commander::Runner.instance.commands
+    entries = runner_commands.reject { |name, _| name.to_s == "help" }
+                             .map { |name, cmd| build_command_data(name.to_s, cmd) }
+    (entries + [help_entry]).sort_by { |cmd| cmd[:name] }
+  end
+
+  def build_command_data(name, command)
+    {
+      name: name,
+      summary: clean(command.summary),
+      description: first_line(clean(command.description.to_s)),
+      syntax: command.syntax.to_s,
+      options: extract_options(command.options),
+      examples: extract_examples(name, command.examples)
+    }
+  end
+
+  def help_entry
+    {
+      name: "help",
+      summary: "Display global or command help documentation",
+      description: "Display global or command help documentation",
+      syntax: "renuo help [command]",
+      options: [], examples: []
+    }
+  end
+
+  def extract_options(options) # rubocop:disable Metrics/AbcSize
+    options.filter_map do |opt|
+      switches = opt[:switches]
+      next if switches.intersect?(HELP_FLAGS)
+
+      long = switches.find { |s| s.start_with?("--") }
+      next unless long
+
+      {
+        flags: [switches.find { |s| s.match?(/\A-[^-]/) }, long.split.first].compact,
+        description: clean(opt[:description]),
+        argument: switches.filter_map { |s| s[/<([^>]+)>/, 1] }.first
+      }
+    end
+  end
+
+  def extract_examples(command_name, examples)
+    return [] if examples.blank?
+
+    prefix = ["renuo", *command_name.split]
+    examples.filter_map { |pair| pick_command(pair, prefix) }.uniq
+  end
+
+  def pick_command(pair, prefix)
+    Array(pair).find do |text|
+      next false unless text.is_a?(String)
+
+      tokens = safe_split(text)
+      tokens && tokens.first(prefix.size) == prefix
+    end
+  end
+
+  def safe_split(text)
+    Shellwords.split(text)
+  rescue ArgumentError
+    nil
+  end
+
+  def clean(text)
+    text.to_s.gsub(/['\[\]]/, "").strip
+  end
+
+  def first_line(text)
+    text.split("\n").map(&:strip).reject(&:empty?).first.to_s
+  end
+end

data/lib/renuo/cli/helpers/credentials_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "active_support/encrypted_configuration"
+
+module CredentialsHelper
+  CONFIG = ActiveSupport::EncryptedConfiguration.new(
+    config_path: File.expand_path("../credentials.yml.enc", __dir__),
+    key_path: "", env_key: "RENUO_CLI_MASTER_KEY", raise_if_missing_key: true
+  )
+
+  def credentials
+    CONFIG.config
+  end
+end

data/lib/renuo/cli/helpers/zsh_completion_script.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "erb"
+
+class ZshCompletionScript
+  TEMPLATE_PATH = File.expand_path("../templates/zsh_completion.erb", __dir__)
+
+  def initialize(commands)
+    @commands = commands
+  end
+
+  def render
+    ERB.new(File.read(TEMPLATE_PATH), trim_mode: "-").result(binding)
+  end
+
+  private
+
+  def namespaced_groups
+    groups.select { |_, sub_commands| sub_commands.first[:subname] }
+  end
+
+  def flat_commands
+    groups.reject { |_, sub_commands| sub_commands.first[:subname] }.map { |_, sub_commands| sub_commands.first }
+  end
+
+  def top_level_entries
+    groups.map do |name, sub_commands|
+      summary = sub_commands.first[:subname] ? "#{name} subcommands" : sub_commands.first[:summary]
+      { name: name, summary: summary }
+    end
+  end
+
+  def groups
+    @groups ||= @commands.each_with_object({}) do |cmd, acc|
+      head, sub = cmd[:name].split(" ", 2)
+      key = sub ? head : cmd[:name]
+      (acc[key] ||= []) << cmd.merge(subname: sub)
+    end
+  end
+
+  def command_body(cmd, indent:)
+    pad = " " * indent
+    messages = message_blocks(cmd, pad)
+    return [arguments_block(cmd, pad), *messages].join("\n") if cmd[:options].any?
+
+    inner_messages = message_blocks(cmd, "#{pad}    ")
+    [
+      %(#{pad}if [[ "${words[CURRENT]}" == -* ]]; then),
+      %(#{pad}    _arguments '--help[show help]'),
+      "#{pad}else",
+      *inner_messages,
+      "#{pad}fi"
+    ].join("\n")
+  end
+
+  def message_blocks(cmd, pad) # rubocop:disable Metrics/AbcSize
+    blocks = []
+    blocks << message_block("syntax", [cmd[:syntax]], pad) unless cmd[:syntax].to_s.empty?
+    blocks << message_block("description", [cmd[:description]], pad) unless cmd[:description].to_s.empty?
+    blocks << message_block("example", cmd[:examples], pad) unless cmd[:examples].empty?
+    blocks
+  end
+
+  def arguments_block(cmd, pad)
+    specs = ["'--help[show help]'"]
+    cmd[:options].each { |opt| specs << option_spec(opt) }
+    specs << "'*: :( )'"
+    "#{pad}_arguments \\\n#{specs.map { |s| "#{pad}    #{s}" }.join(" \\\n")}"
+  end
+
+  def option_spec(option)
+    flags = option[:flags]
+    bracket = "[#{escape_bracket(option[:description])}]"
+    arg_part = option[:argument] ? ":#{option[:argument]}:" : ""
+    return "'#{flags.first}#{bracket}#{arg_part}'" if flags.size < 2
+
+    "'(#{flags.join(" ")})'{#{flags.join(",")}}'#{bracket}#{arg_part}'"
+  end
+
+  def message_block(header, lines, pad)
+    payload = (["-- #{header} --"] + lines + [""]).join("\n")
+    "#{pad}_message -r '#{escape_single(payload)}'"
+  end
+
+  def escape_bracket(text)
+    text.to_s.gsub("]") { "\\]" }.gsub("'") { "'\\''" }
+  end
+
+  def escape_single(text)
+    text.to_s.gsub("'") { "'\\''" }
+  end
+end

data/lib/renuo/cli/templates/zsh_completion.erb

@@ -0,0 +1,61 @@
+#compdef renuo
+
+_renuo() {
+    local curcontext="$curcontext" state
+    typeset -A opt_args
+
+    zstyle ":completion:${curcontext}:*:descriptions" format '\n -- %d --'
+    zstyle ":completion:${curcontext}:*" group-name ''
+    zstyle ":completion:${curcontext}:*" prefix-needed no
+
+    _arguments -C \
+        '--help[show help]' \
+        '--version[show version]' \
+        '--trace[show backtrace on error]' \
+        '1: :_renuo_commands' \
+        '*:: :->args' && return 0
+
+    case $state in
+        args)
+            local cmd_key="${words[1]}"
+<% namespaced_groups.each do |group, subs| -%>
+            if [[ "$cmd_key" == "<%= group %>" ]]; then
+                case "${words[2]}" in
+<% subs.each do |sub| -%>
+                    <%= sub[:subname] %>)
+<%= command_body(sub, indent: 24) %>
+                        ;;
+<% end -%>
+                esac
+                return
+            fi
+<% end -%>
+            case "$cmd_key" in
+<% flat_commands.each do |cmd| -%>
+                <%= cmd[:name] %>)
+<% if cmd[:name] == "help" -%>
+                    _arguments \
+                        '--help[show help]' \
+                        '*:command:_renuo_commands'
+<% else -%>
+<%= command_body(cmd, indent: 20) %>
+<% end -%>
+                    ;;
+<% end -%>
+            esac
+            ;;
+    esac
+}
+
+_renuo_commands() {
+    local commands
+    commands=(
+<% top_level_entries.each do |entry| -%>
+        '<%= entry[:name] %>:<%= entry[:summary] %>'
+<% end -%>
+    )
+
+    _describe 'commands' commands
+}
+
+_renuo "$@"

data/lib/renuo/cli/version.rb

@@ -3,7 +3,7 @@
 # :nocov:
 module Renuo
   class Cli
-    VERSION = "4.21.2"
+    VERSION = "4.22.0"
     NAME = "renuo-cli"
   end
 end

data/lib/renuo/cli.rb

@@ -35,6 +35,7 @@ module Renuo
       program :help_paging, false
 
       Dir[File.expand_path("cli/{commands,services}/**/*.rb", __dir__)].each { |f| require f }
+      Renuo::Cli::Commands::SetupAutocompletion.refresh_if_stale
       default_command :help
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: renuo-cli
 version: !ruby/object:Gem::Version
-  version: 4.21.2
+  version: 4.22.0
 platform: ruby
 authors:
 - Renuo AG
@@ -88,11 +88,16 @@ files:
 - lib/renuo/cli/commands/heroku_users.rb
 - lib/renuo/cli/commands/list_large_git_files.rb
 - lib/renuo/cli/commands/release.rb
+- lib/renuo/cli/commands/setup_autocompletion.rb
 - lib/renuo/cli/commands/setup_uptimerobot.rb
 - lib/renuo/cli/commands/upgrade_laptop.rb
+- lib/renuo/cli/credentials.yml.enc
 - lib/renuo/cli/helpers/command_helper.rb
+- lib/renuo/cli/helpers/commander_introspector.rb
+- lib/renuo/cli/helpers/credentials_helper.rb
 - lib/renuo/cli/helpers/environments.rb
 - lib/renuo/cli/helpers/renuo_version.rb
+- lib/renuo/cli/helpers/zsh_completion_script.rb
 - lib/renuo/cli/services/cache.rb
 - lib/renuo/cli/services/cloudfront_config_service.rb
 - lib/renuo/cli/services/deploio.rb
@@ -106,6 +111,7 @@ files:
 - lib/renuo/cli/templates/semaphore/semaphore.yml.erb
 - lib/renuo/cli/templates/slidev/README.md.erb
 - lib/renuo/cli/templates/slidev/package.json.erb
+- lib/renuo/cli/templates/zsh_completion.erb
 - lib/renuo/cli/version.rb
 homepage: https://github.com/renuo/renuo-cli
 licenses: