odysseus-cli 0.2.0 → 0.9.0

data/lib/odysseus/cli/ui.rb

@@ -0,0 +1,457 @@
+# odysseus-cli/lib/odysseus/cli/ui.rb
+#
+# Terminal UI renderer for Odysseus CLI.
+#
+# Default mode: numbered steps with animated spinners that resolve to ✓/✗.
+# Debug mode (--debug): verbose plain-text output, no spinners.
+
+module Odysseus
+  module CLI
+    # IO wrapper that redacts sensitive values before writing
+    class RedactingIO
+      def initialize(io, redact_fn)
+        @io = io
+        @redact = redact_fn
+      end
+
+      def write(str)
+        @io.write(@redact.call(str.to_s))
+      end
+
+      def puts(*args)
+        args.each { |a| @io.puts(@redact.call(a.to_s)) }
+        @io.puts if args.empty?
+      end
+
+      def print(*args)
+        args.each { |a| @io.print(@redact.call(a.to_s)) }
+      end
+
+      def flush
+        @io.flush
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        @io.respond_to?(method, include_private)
+      end
+
+      def method_missing(method, *, &)
+        @io.send(method, *, &)
+      end
+    end
+
+    class UI
+      SPINNER_FRAMES = %w[⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏].freeze
+
+      # ANSI color helpers
+      COPPER  = "\e[38;2;255;183;123m".freeze
+      MINT    = "\e[38;2;112;216;200m".freeze
+      RED     = "\e[38;2;255;100;100m".freeze
+      DIM     = "\e[2m".freeze
+      RESET   = "\e[0m".freeze
+
+      def initialize(debug: false)
+        @debug = debug
+        @step_number = 0
+      end
+
+      def debug?
+        @debug
+      end
+
+      def reset_steps!
+        @step_number = 0
+      end
+
+      def next_step!
+        @step_number += 1
+      end
+
+      # --- Header ---
+      #
+      # These three take `io` for the same reason error/warn/step below do: the
+      # interactive sessions print a header describing a terminal whose own
+      # output is stdout, so the description has to go somewhere else. The
+      # default keeps every other caller writing exactly where it did.
+
+      def header(title, io: $stdout)
+        reset_steps!
+        if debug?
+          io.puts "\e[36m#{title}\e[0m"
+        else
+          io.puts ''
+          io.puts "  #{COPPER}#{title}#{RESET}"
+        end
+      end
+
+      def info(label, value, io: $stdout)
+        if debug?
+          io.puts "  #{label}: #{value}"
+        else
+          io.puts "  #{DIM}#{label}:#{RESET} #{value}"
+        end
+      end
+
+      def blank(io: $stdout)
+        io.puts ''
+      end
+
+      # --- Single spin step ---
+      # Shows spinner while block runs, resolves to ✓/✗.
+      # Captures stdout from the block so it doesn't leak.
+
+      def spin_step(message)
+        next_step!
+        num = step_num_str
+
+        if debug?
+          puts "  #{num}  #{redact(message)}"
+          result = yield
+          puts "  #{num}  ✓ #{redact(message)}"
+          return result
+        end
+
+        result = nil
+        err = nil
+        done = false
+
+        # Capture stdout from the block
+        old_stdout = $stdout
+        rd, wr = IO.pipe
+        $stdout = wr
+
+        thread = Thread.new do
+          result = yield
+        rescue StandardError => e
+          err = e
+        ensure
+          done = true
+          wr.close
+        end
+
+        frame_idx = 0
+        loop do
+          break if done
+
+          frame = SPINNER_FRAMES[frame_idx % SPINNER_FRAMES.size]
+          old_stdout.print "\r  #{DIM}#{num}#{RESET}  #{COPPER}#{frame}#{RESET}  #{message}"
+          old_stdout.flush
+          frame_idx += 1
+          sleep 0.08
+        end
+
+        rd.close
+        $stdout = old_stdout
+        thread.join
+
+        print "\r\e[K"
+
+        if err
+          puts "  #{DIM}#{num}#{RESET}  #{RED}✗#{RESET}  #{message}"
+          raise err
+        else
+          puts "  #{DIM}#{num}#{RESET}  #{MINT}✓#{RESET}  #{message}"
+        end
+
+        result
+      end
+
+      # --- Streaming steps ---
+      # Runs a block, captures its stdout line by line, and renders each
+      # meaningful line as a sub-step with spinner → ✓.
+      # All sub-steps share the same step number.
+
+      def stream_steps(title: nil)
+        next_step!
+        num = step_num_str
+
+        if debug?
+          puts "  #{num}  > #{title}" if title
+          # In debug mode, let output flow but redact sensitive values
+          old_stdout = $stdout
+          $stdout = RedactingIO.new(old_stdout, method(:redact))
+          begin
+            yield
+          ensure
+            $stdout = old_stdout
+          end
+          return
+        end
+
+        # Show section header if provided
+        puts "  #{DIM}#{num}#{RESET}  #{COPPER}>#{RESET}  #{title}" if title
+
+        result = nil
+        err = nil
+        done = false
+        current_line = nil
+
+        # Capture stdout
+        old_stdout = $stdout
+        rd, wr = IO.pipe
+
+        thread = Thread.new do
+          $stdout = wr
+          begin
+            result = yield
+          rescue StandardError => e
+            err = e
+          ensure
+            done = true
+            wr.close
+          end
+        end
+
+        frame_idx = 0
+        buf = ''
+
+        loop do
+          # Non-blocking read from pipe
+          begin
+            chunk = rd.read_nonblock(4096)
+            buf << chunk
+          rescue IO::WaitReadable
+            # No data available yet
+          rescue EOFError
+            break
+          end
+
+          # Process complete lines
+          while (nl = buf.index("\n"))
+            line = buf.slice!(0..nl).strip
+            next if line.empty?
+
+            line = clean_line(line)
+            next unless line
+
+            # Note lines (prefixed with ~) render as indented grey text, no spinner
+            if line.start_with?('~')
+              if current_line
+                old_stdout.print "\r\e[K"
+                old_stdout.puts "  #{DIM}#{num}#{RESET}  #{MINT}✓#{RESET}  #{current_line}"
+                current_line = nil
+              end
+              old_stdout.puts "  #{DIM}#{num}#{RESET}     #{DIM}#{line[1..]}#{RESET}"
+              next
+            end
+
+            # Resolve previous sub-step
+            if current_line
+              old_stdout.print "\r\e[K"
+              old_stdout.puts "  #{DIM}#{num}#{RESET}  #{MINT}✓#{RESET}  #{current_line}"
+            end
+
+            current_line = line
+          end
+
+          # Animate spinner on current line
+          if current_line
+            frame = SPINNER_FRAMES[frame_idx % SPINNER_FRAMES.size]
+            old_stdout.print "\r  #{DIM}#{num}#{RESET}  #{COPPER}#{frame}#{RESET}  #{current_line}"
+            old_stdout.flush
+          end
+
+          frame_idx += 1
+          sleep 0.06
+
+          break if done && buf.empty?
+        end
+
+        rd.close
+        $stdout = old_stdout
+        thread.join
+
+        # Resolve the final sub-step
+        if current_line
+          print "\r\e[K"
+          puts "  #{DIM}#{num}#{RESET}  #{MINT}✓#{RESET}  #{current_line}"
+        end
+
+        raise err if err
+
+        result
+      end
+
+      # --- Immediate steps (no async) ---
+
+      def step_ok(message)
+        next_step!
+        puts "  #{DIM}#{step_num_str}#{RESET}  #{MINT}✓#{RESET}  #{message}"
+      end
+
+      def step_fail(message)
+        next_step!
+        puts "  #{DIM}#{step_num_str}#{RESET}  #{RED}✗#{RESET}  #{message}"
+      end
+
+      def step_info(message)
+        next_step!
+        puts "  #{DIM}#{step_num_str}#{RESET}  #{COPPER}➜#{RESET}  #{message}"
+      end
+
+      # --- Simple output (no numbering) ---
+
+      def success(message)
+        puts "  #{MINT}✓#{RESET} #{message}"
+      end
+
+      # `io` is for the commands whose stdout is data rather than chatter:
+      # `odysseus logs web1 > app.log` captures a log stream, and a notice about
+      # which container the logs came from does not belong in it. A default
+      # rather than a second set of methods, so every other caller keeps writing
+      # to stdout exactly as before.
+      def error(message, io: $stdout)
+        io.puts "  #{RED}✗#{RESET} #{message}"
+      end
+
+      def warn(message, io: $stdout)
+        io.puts "  \e[33m!#{RESET} #{message}"
+      end
+
+      def step(message, io: $stdout)
+        if debug?
+          io.puts "  #{redact(message)}"
+        else
+          io.puts "  #{DIM}›#{RESET} #{message}"
+        end
+      end
+
+      def detail(message)
+        puts "    #{DIM}#{redact(message)}#{RESET}" if debug?
+      end
+
+      # --- Tables ---
+
+      def table(headers:, rows:)
+        return if rows.empty?
+
+        widths = headers.map.with_index do |h, i|
+          [h.to_s.length, rows.map { |r| r[i].to_s.length }.max || 0].max
+        end
+
+        header_line = headers.map.with_index { |h, i| h.to_s.ljust(widths[i]) }.join('  ')
+        puts "  #{COPPER}#{header_line}#{RESET}"
+        puts "  #{widths.map { |w| '─' * w }.join('  ')}"
+
+        rows.each do |row|
+          line = row.map.with_index { |c, i| c.to_s.ljust(widths[i]) }.join('  ')
+          puts "  #{line}"
+        end
+      end
+
+      # --- Section divider ---
+
+      def section(title)
+        if debug?
+          puts "\e[36m=== #{title} ===\e[0m"
+        else
+          puts "  #{COPPER}▸ #{title}#{RESET}"
+        end
+      end
+
+      # --- Deploy-specific helpers ---
+
+      def deploy_header(service:, image:, image_tag:, build: false, distribution: nil)
+        header 'Odysseus Deploy'
+        info 'Service', service
+        info 'Image', "#{image}:#{image_tag}"
+        info 'Distribute', distribution if build && distribution
+        blank
+      end
+
+      def deploy_complete(duration: nil)
+        msg = 'Deployment successful'
+        msg += " in #{duration}s" if duration
+        step_ok msg
+      end
+
+      # --- Logger adapter ---
+
+      def build_logger
+        ui = self
+        Object.new.tap do |l|
+          l.define_singleton_method(:info) { |msg| ui.step(msg) }
+          l.define_singleton_method(:warn) { |msg| ui.warn(msg) }
+          l.define_singleton_method(:error) { |msg| ui.error(msg) }
+          l.define_singleton_method(:debug) { |msg| ui.detail(msg) }
+          l.define_singleton_method(:verbose?) { ui.debug? }
+        end
+      end
+
+      private
+
+      def step_num_str
+        format('%02d', @step_number)
+      end
+
+      # Redact sensitive values from output.
+      # Matches common patterns for API keys, tokens, passwords, and secrets
+      # passed as env vars or command flags.
+      def redact(text)
+        text
+          .gsub(/(-e\s+\w*(?:KEY|TOKEN|SECRET|PASSWORD|MASTER_KEY|API_KEY|CREDENTIALS)\s*=\s*)\S+/i, '\1[REDACTED]')
+          .gsub(/((?:KEY|TOKEN|SECRET|PASSWORD|MASTER_KEY|API_KEY|CREDENTIALS)\s*[=:]\s*)\S+/i, '\1[REDACTED]')
+          .gsub(/(-p\s+)\S+/, '\1[REDACTED]')
+          .gsub(/(--password\s+)\S+/, '\1[REDACTED]')
+      end
+
+      # Clean up raw output lines from core orchestrators.
+      # Returns nil for lines we should skip.
+      def clean_line(line)
+        # Strip leading whitespace
+        line = line.sub(/^\s+/, '')
+
+        # Skip empty / decorative / noise
+        return nil if line.empty?
+        return nil if line.start_with?('===', '---', '[WARN]', '[ERROR]')
+
+        # Skip verbose detail lines
+        return nil if line.match?(/^Image: /)
+        return nil if line.match?(/^Environment: /)
+        return nil if line.match?(/^Resources: /)
+        return nil if line.match?(/^Volumes: /)
+        return nil if line.match?(/^Found \d+ existing container/)
+        return nil if line.match?(/^Deploying .+ \(role: .+\)/)
+        return nil if line.match?(/^Building locally/)
+        return nil if line.match?(/^Pushing image via SSH to/)
+        return nil if line.match?(/^Deploy complete for /)
+        return nil if line.match?(/^Rolling deploy complete/)
+
+        # Skip "done" echo lines — the spinner→✓ already shows completion
+        return nil if line.match?(/^Container started: /)
+        return nil if line.match?(/^Health check passed$/)
+        return nil if line.match?(/^Caddy routing configured$/)
+        return nil if line.match?(/^Old container removed$/)
+        return nil if line.match?(/^Image pulled$/)
+        return nil if line.match?(/^Attached to proxy$/)
+
+        # Note lines — indented grey text under the previous step
+        return '~Caddy already running' if line.match?(/^Caddy already running$/)
+        return '~Caddy started' if line.match?(/^Caddy started$/)
+        return '~Caddy is ready' if line.match?(/^Caddy is ready$/)
+
+        # Map known messages to clean versions
+        CLEAN_MESSAGES.each do |pattern, replacement|
+          return line.sub(pattern, replacement) if line.match?(pattern)
+        end
+
+        line
+      end
+
+      CLEAN_MESSAGES = {
+        /^Ensuring Caddy proxy is running\.\.\./ => 'Starting Caddy',
+        /^Starting new container\.\.\.$/ => 'Starting container',
+        /^Waiting for health check.*/ => 'Health check',
+        /^Adding to Caddy proxy.*/ => 'Caddy route update',
+        /^Draining old container.*/ => 'Draining old container',
+        /^Pulling image\.\.\.$/ => 'Pulling image',
+        /^Building image: .+$/ => 'Building image',
+        /^Pushing to (.+)\.\.\./ => 'Pushing image to \1',
+        /^Starting (.+)\.\.\.$/ => 'Starting \1',
+        /^Stopping (.+) .*/ => 'Stopping \1',
+        /^Attaching (.+) to proxy.*/ => 'Attaching \1 to proxy'
+      }.freeze
+      private_constant :CLEAN_MESSAGES
+    end
+  end
+end

data/lib/odysseus/cli/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Odysseus
+  module CLI
+    VERSION = '0.9.0'
+  end
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: odysseus-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.9.0
 platform: ruby
 authors:
-- Your Name
+- Thomas
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -15,72 +15,41 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: pastel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
+        version: 0.9.0
 description: Command-line interface for deploying with Odysseus
 email:
-- your@email.com
+- thomas@imfiny.com
 executables:
 - odysseus
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.txt
 - README.md
 - bin/odysseus
 - lib/odysseus/cli/cli.rb
-- lib/odysseus/cli/gum.rb
-homepage: https://github.com/WaSystems/odysseus
+- lib/odysseus/cli/doctor_commands.rb
+- lib/odysseus/cli/interactive_commands.rb
+- lib/odysseus/cli/rollback_commands.rb
+- lib/odysseus/cli/setup_commands.rb
+- lib/odysseus/cli/ui.rb
+- lib/odysseus/cli/version.rb
+homepage: https://github.com/WA-Systems-EU/odysseus
 licenses:
-- LGPL-3.0-only
-metadata: {}
+- MIT
+metadata:
+  homepage_uri: https://github.com/WA-Systems-EU/odysseus
+  source_code_uri: https://github.com/WA-Systems-EU/odysseus
+  changelog_uri: https://github.com/WA-Systems-EU/odysseus/blob/trunk/odysseus-cli/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -88,14 +57,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
 summary: CLI for Odysseus deployment tool
 test_files: []