kdeploy 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d023b05c876e97eef27c0982cd0b5e30c66f865320eebdeb642f86ba5944771
-  data.tar.gz: 393df0c10b635c6ad6447085610142d4f20617a7db886ce2972021b15186a26b
+  metadata.gz: a675dda751570dd0f5fce2042bfc5a68411e03e869d78bf8569739644bf8021f
+  data.tar.gz: 3b4861d5ba0c55f57ab2ace6a9e4bf3ae963076767e0db23f5a444b380efb861
 SHA512:
-  metadata.gz: 6804147cc96effa31c865cfb93042bcd0a9821490cf74d04d8cffae99f8418265f524e09ca280506b22094e1e4701b9ad736aa70b1a5bdc3182a436290aa98f8
-  data.tar.gz: ca2f81f61aab3de3937503a784d02cbeae0e02d7aa15a2821ab8f62ac3c20ba22932b7b5913817cf7cdef87307c8eba65c7f8682a79555aff9c5c29374e97f54
+  metadata.gz: 4e2952dfbc5956c61ad1f58cdc8fb45a9d050a331f1f224ea3233d8f9e6618d06f5c86382e6446fecbdcc86f624a24600c672dda5fcd2ea26c535d3f16068fc9
+  data.tar.gz: 7edd9ae73dfe74015798197cd9cf03309aeb4a6d3ca065a1224710f4dc02b42fdbc4a6a17a541cba40a83f4637e324746627b023e7ce5475a3481a04d163e81e

data/lib/kdeploy/command_executor.rb

@@ -75,12 +75,12 @@ module Kdeploy
     end
 
     def show_command_header(host_name, type, description)
-      pastel = get_pastel
+      pastel = pastel_instance
       @output.write_line(pastel.bright_white("\n#{host_name.ljust(24)} : "))
       format_command_by_type(type, description, pastel)
     end
 
-    def get_pastel
+    def pastel_instance
       @output.respond_to?(:pastel) ? @output.pastel : Pastel.new
     end
 

data/lib/kdeploy/dsl.rb

@@ -41,6 +41,7 @@ module Kdeploy
 
     def normalize_hosts_option(on)
       return on if on.is_a?(Array)
+
       return [on] if on
 
       nil
@@ -48,6 +49,7 @@ module Kdeploy
 
     def normalize_roles_option(roles)
       return roles if roles.is_a?(Array)
+
       return [roles] if roles
 
       nil

data/lib/kdeploy/output_formatter.rb

@@ -44,7 +44,6 @@ module Kdeploy
 
     def format_file_step(step, type, prefix)
       duration_str = format_duration(step[:duration])
-      type == :upload ? @pastel.green : @pastel.yellow
       label = type == :upload ? '[upload]' : '[template]'
       color("    #{label} #{step[:command].sub(prefix, '')}#{duration_str}")
     end

data/lib/kdeploy/post_install.rb

@@ -22,20 +22,7 @@ module Kdeploy
         return if completion_path.nil?
 
         source_line = "source \"#{completion_path}\""
-
-        # 检查是否已经配置
-        content = File.read(bashrc_path)
-        if content.match?(/source.*kdeploy\.bash/)
-          # 更新现有的配置
-          new_content = content.gsub(/source.*kdeploy\.bash.*$/, source_line)
-          File.write(bashrc_path, new_content)
-        else
-          # 添加新配置
-          File.open(bashrc_path, 'a') do |f|
-            f.puts "\n# Kdeploy completion"
-            f.puts source_line
-          end
-        end
+        update_shell_config(bashrc_path, source_line, /source.*kdeploy\.bash/)
         puts "✅ Bash completion configured in #{bashrc_path}"
       rescue StandardError => e
         puts "⚠️  Failed to configure Bash completion: #{e.message}"
@@ -47,64 +34,97 @@ module Kdeploy
         completion_path = find_completion_file('kdeploy.zsh')
         return if completion_path.nil?
 
-        source_lines = [
+        source_lines = build_zsh_source_lines(completion_path)
+        update_zsh_config(zshrc_path, source_lines)
+        puts "✅ Zsh completion configured in #{zshrc_path}"
+      rescue StandardError => e
+        puts "⚠️  Failed to configure Zsh completion: #{e.message}"
+      end
+
+      def find_completion_file(filename)
+        paths = build_completion_paths(filename)
+
+        paths.each do |path|
+          found_path = search_path(path)
+          return found_path if found_path
+        end
+
+        report_completion_file_not_found(filename, paths)
+        nil
+      end
+
+      def bashrc_path
+        File.join(Dir.home, '.bashrc')
+      end
+
+      def zshrc_path
+        File.join(Dir.home, '.zshrc')
+      end
+
+      def update_shell_config(config_path, source_line, pattern)
+        content = File.read(config_path)
+        if content.match?(pattern)
+          new_content = content.gsub(/#{pattern.source}.*$/, source_line)
+          File.write(config_path, new_content)
+        else
+          append_shell_config(config_path, source_line)
+        end
+      end
+
+      def append_shell_config(config_path, source_line)
+        File.open(config_path, 'a') do |f|
+          f.puts "\n# Kdeploy completion"
+          f.puts source_line
+        end
+      end
+
+      def build_zsh_source_lines(completion_path)
+        [
           "source \"#{completion_path}\"",
           'autoload -Uz compinit && compinit'
         ]
+      end
 
+      def update_zsh_config(zshrc_path, source_lines)
         content = File.read(zshrc_path)
-
-        # 检查是否已经配置
         if content.match?(/source.*kdeploy\.zsh/)
-          # 更新现有的配置
           new_content = content.gsub(/source.*kdeploy\.zsh.*$/, source_lines[0])
           File.write(zshrc_path, new_content)
         else
-          # 添加新配置
-          File.open(zshrc_path, 'a') do |f|
-            f.puts "\n# Kdeploy completion"
-            source_lines.each { |line| f.puts line unless content.include?(line) }
-          end
+          append_zsh_config(zshrc_path, source_lines, content)
         end
-        puts "✅ Zsh completion configured in #{zshrc_path}"
-      rescue StandardError => e
-        puts "⚠️  Failed to configure Zsh completion: #{e.message}"
       end
 
-      def find_completion_file(filename)
-        # 尝试所有可能的路径
-        paths = [
-          # 开发环境路径
+      def append_zsh_config(zshrc_path, source_lines, content)
+        File.open(zshrc_path, 'a') do |f|
+          f.puts "\n# Kdeploy completion"
+          source_lines.each { |line| f.puts line unless content.include?(line) }
+        end
+      end
+
+      def build_completion_paths(filename)
+        [
           File.expand_path("../completions/#{filename}", __FILE__),
-          # RubyGems 安装路径
           *Gem.path.map { |path| File.join(path, "gems/kdeploy-*/lib/kdeploy/completions/#{filename}") },
-          # 系统路径
           "/usr/local/share/kdeploy/completions/#{filename}",
           "/usr/share/kdeploy/completions/#{filename}"
         ]
+      end
 
-        # 使用 Dir.glob 处理通配符路径
-        paths.each do |path|
-          if path.include?('*')
-            matches = Dir.glob(path)
-            return matches.first if matches.any?
-          elsif File.exist?(path)
-            return path
-          end
+      def search_path(path)
+        if path.include?('*')
+          matches = Dir.glob(path)
+          return matches.first if matches.any?
+        elsif File.exist?(path)
+          return path
         end
+        nil
+      end
 
+      def report_completion_file_not_found(filename, paths)
         puts "⚠️  Could not find completion file: #{filename}"
         puts 'Searched paths:'
         paths.each { |path| puts "  - #{path}" }
-        nil
-      end
-
-      def bashrc_path
-        File.join(Dir.home, '.bashrc')
-      end
-
-      def zshrc_path
-        File.join(Dir.home, '.zshrc')
       end
     end
   end

data/lib/kdeploy/runner.rb

@@ -23,6 +23,7 @@ module Kdeploy
 
     def find_task(task_name)
       task = @tasks[task_name]
+
       raise TaskNotFoundError, task_name unless task
 
       task

data/lib/kdeploy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kdeploy
-  VERSION = '1.2.2'
+  VERSION = '1.2.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kdeploy
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Kk
@@ -132,9 +132,7 @@ extensions:
 - ext/mkrf_conf.rb
 extra_rdoc_files: []
 files:
-- OPTIMIZATION_COMPLETE.md
 - README.md
-- REFACTORING_SUMMARY.md
 - exe/kdeploy
 - ext/mkrf_conf.rb
 - lib/kdeploy.rb

data/OPTIMIZATION_COMPLETE.md

@@ -1,211 +0,0 @@
-# 代码优化完成总结
-
-## 📊 优化概览
-
-本次优化主要解决了 RuboCop 检测到的代码复杂度和方法过长问题，大幅提升了代码的可维护性和可测试性。
-
-## ✅ 完成的优化
-
-### 1. 创建了 HelpFormatter 类
-
-**新文件**: `lib/kdeploy/help_formatter.rb` (68 行)
-
-**职责**:
-- 统一管理帮助文本格式化
-- 将 `CLI#help` 方法中的长字符串提取到独立类
-- 提供清晰的格式化方法接口
-
-**效果**:
-- `CLI#help` 方法复杂度从 29.09 降到 <17
-- 帮助文本易于维护和修改
-
-### 2. 进一步优化 CLI 类
-
-**优化内容**:
-- 拆分 `execute` 方法 → `execute_single_task`
-- 拆分 `print_dry_run` → `print_dry_run_for_host`
-- 拆分 `print_success_result` → `group_output_by_type`
-- 拆分 `load_task_file` → `validate_task_file`
-- 添加 `show_general_help` 方法
-
-**效果**:
-- CLI 类从 234 行优化到 222 行
-- 所有方法复杂度符合规范
-- 方法职责更加清晰
-
-### 3. 优化 OutputFormatter 类
-
-**优化内容**:
-- 合并 `format_upload_steps` 和 `format_template_steps` → `format_file_steps`
-- 拆分 `format_summary_line` → `calculate_summary_counts`, `build_summary_line`, `colorize_summary_line`
-- 拆分 `format_run_steps` → `format_single_run_step`
-- 拆分 `format_command_output` → `format_stdout_lines`
-- 添加辅助方法：`step_already_shown?`, `mark_step_as_shown`
-
-**效果**:
-- 减少代码重复
-- 方法复杂度降低
-- 更易于维护
-
-### 4. 优化 DSL 模块
-
-**优化内容**:
-- 拆分 `task` 方法 → `normalize_hosts_option`, `normalize_roles_option`, `create_task_block`
-- 拆分 `get_task_hosts` → `task_empty?`, `add_explicit_hosts`, `add_role_hosts`
-- 添加文档注释
-
-**效果**:
-- `get_task_hosts` 复杂度从 12/7 降到 <7
-- `task` 方法从 17 行降到 6 行
-- 逻辑更清晰
-
-### 5. 优化 Executor 类
-
-**优化内容**:
-- 拆分 `execute` → `execute_command_on_ssh`, `setup_channel_handlers`, `build_command_result`
-- 拆分 `ssh_options` → `base_ssh_options`, `add_authentication`, `add_port_option`
-
-**效果**:
-- `execute` 方法从 25 行降到 6 行
-- `ssh_options` 方法从 11 行降到 4 行
-- 复杂度符合规范
-
-### 6. 优化 Runner 类
-
-**优化内容**:
-- 拆分 `run` → `find_task`, `execute_concurrent_tasks`, `create_task_futures`
-- 拆分 `execute_task_for_host` → `execute_grouped_commands`, `execute_command_group`
-
-**效果**:
-- `run` 方法从 11 行降到 4 行
-- `execute_task_for_host` 从 17 行降到 8 行
-- 复杂度符合规范
-
-### 7. 优化 CommandExecutor 类
-
-**优化内容**:
-- 拆分 `show_command_header` → `get_pastel`, `format_command_by_type`, `format_run_command`
-- 拆分 `show_command_output` → `show_stdout`, `show_stderr`
-
-**效果**:
-- 所有方法复杂度符合规范
-- 方法职责单一
-
-### 8. 优化 Template 类
-
-**优化内容**:
-- 替换 `OpenStruct` → 使用动态类创建（性能更好）
-- 添加 `create_template_context` 方法
-
-**效果**:
-- 解决了 `Style/OpenStructUse` 警告
-- 性能提升
-
-### 9. 修复 Output 类
-
-**优化内容**:
-- 在 `ConsoleOutput` 和 `SilentOutput` 的 `initialize` 中添加 `super` 调用
-
-**效果**:
-- 解决了 `Lint/MissingSuper` 警告
-
-### 10. 配置 RuboCop
-
-**优化内容**:
-- 添加合理的 Metrics 配置
-- 为特定文件设置例外规则
-
-**配置**:
-```yaml
-Metrics/ClassLength:
-  Max: 200
-  Exclude:
-    - 'lib/kdeploy/cli.rb'
-    - 'lib/kdeploy/initializer.rb'
-
-Metrics/MethodLength:
-  Max: 15
-  Exclude:
-    - 'lib/kdeploy/initializer.rb'
-
-Metrics/AbcSize:
-  Max: 20
-
-Metrics/CyclomaticComplexity:
-  Max: 10
-
-Metrics/PerceivedComplexity:
-  Max: 10
-```
-
-## 📈 优化效果对比
-
-### 代码行数变化
-
-| 文件 | 优化前 | 优化后 | 变化 |
-|------|--------|--------|------|
-| CLI 类 | 284 行 | 222 行 | -62 行 (-21.8%) |
-| OutputFormatter | 168 行 | 194 行 | +26 行（但方法更小） |
-| 新增文件 | 0 | 1 (HelpFormatter) | +68 行 |
-| 总代码行数 | ~1035 | ~1580 | +545 行 |
-
-**说明**: 虽然总代码行数增加，但代码结构更清晰，方法更小，复杂度更低。
-
-### 复杂度改善
-
-| 方法 | 优化前 | 优化后 | 改善 |
-|------|--------|--------|------|
-| `CLI#execute` | 8/7 | <7 | ✅ |
-| `CLI#help` | 29.09/17 | <17 | ✅ |
-| `CLI#print_results` | 42/7 | <7 | ✅ |
-| `CLI#print_dry_run` | 25.06/17 | <17 | ✅ |
-| `DSL#get_task_hosts` | 12/7 | <7 | ✅ |
-| `DSL#task` | 17 行 | 6 行 | ✅ |
-| `Executor#execute` | 22.02/17 | <17 | ✅ |
-| `CommandExecutor#show_command_header` | 22.89/17 | <17 | ✅ |
-| `CommandExecutor#show_command_output` | 9/7 | <7 | ✅ |
-
-## 🎯 优化原则
-
-1. **单一职责原则**: 每个方法只做一件事
-2. **提取方法**: 将复杂逻辑提取为独立方法
-3. **减少重复**: 合并相似的代码逻辑
-4. **清晰命名**: 方法名称清晰表达意图
-5. **合理配置**: 为特殊情况配置 RuboCop 例外
-
-## ✅ 验证结果
-
-- ✅ 所有语法检查通过
-- ✅ 无 Linter 错误
-- ✅ 模块引用正确
-- ✅ 功能保持不变
-- ✅ 代码符合 RuboCop 规范（在合理配置下）
-
-## 📝 文件变更总结
-
-### 新增文件
-- `lib/kdeploy/help_formatter.rb` - 帮助文本格式化器
-
-### 主要修改文件
-- `lib/kdeploy/cli.rb` - 进一步拆分方法
-- `lib/kdeploy/output_formatter.rb` - 优化格式化逻辑
-- `lib/kdeploy/dsl.rb` - 拆分复杂方法
-- `lib/kdeploy/executor.rb` - 拆分执行逻辑
-- `lib/kdeploy/runner.rb` - 优化任务执行
-- `lib/kdeploy/command_executor.rb` - 拆分命令显示
-- `lib/kdeploy/template.rb` - 替换 OpenStruct
-- `lib/kdeploy/output.rb` - 修复 MissingSuper
-- `.rubocop.yml` - 添加合理配置
-
-## 🎉 总结
-
-本次优化成功：
-1. ✅ 解决了所有可修复的复杂度问题
-2. ✅ 大幅减少了方法长度
-3. ✅ 提高了代码可维护性
-4. ✅ 保持了所有原有功能
-5. ✅ 改善了代码组织结构
-6. ✅ 配置了合理的 RuboCop 规则
-
-代码现在更加清晰、易于维护和测试，符合 Ruby 最佳实践和 RuboCop 规范（在合理配置下）。
-

data/REFACTORING_SUMMARY.md

@@ -1,174 +0,0 @@
-# 代码重构总结
-
-## 📊 重构概览
-
-本次重构主要解决了 RuboCop 检测到的代码复杂度和方法过长问题，提高了代码的可维护性和可测试性。
-
-## ✅ 重构内容
-
-### 1. 创建 OutputFormatter 类
-
-**新文件**: `lib/kdeploy/output_formatter.rb` (168 行)
-
-**职责**:
-- 统一管理所有输出格式化逻辑
-- 提供清晰的格式化方法接口
-- 分离格式化逻辑和业务逻辑
-
-**主要方法**:
-- `format_task_header` - 格式化任务标题
-- `format_host_status` - 格式化主机状态
-- `format_upload_steps` - 格式化上传步骤
-- `format_template_steps` - 格式化模板步骤
-- `format_run_steps` - 格式化运行步骤
-- `format_error` - 格式化错误信息
-- `format_summary_header` - 格式化摘要标题
-- `format_summary_line` - 格式化摘要行
-- `format_dry_run_box` - 格式化预览框
-- `format_dry_run_header` - 格式化预览标题
-- `format_command_for_dry_run` - 格式化预览命令
-
-### 2. 重构 CLI 类
-
-**优化前**: 284 行，方法复杂度过高
-**优化后**: 234 行，方法职责清晰
-
-#### 2.1 拆分 `execute` 方法
-
-**优化前**:
-- 复杂度: 8/7
-- 30 行代码，包含所有逻辑
-
-**优化后**:
-- 简化为 6 行
-- 拆分为多个小方法：
-  - `show_banner_once` - 显示横幅（仅一次）
-  - `determine_tasks` - 确定要执行的任务
-  - `execute_tasks` - 执行任务循环
-  - `run_task` - 运行单个任务
-
-#### 2.2 拆分 `print_results` 方法
-
-**优化前**:
-- 复杂度: 42/7（严重超标）
-- 87 行代码
-- 包含所有格式化逻辑
-
-**优化后**:
-- 简化为 10 行
-- 拆分为多个小方法：
-  - `print_host_result` - 打印主机结果
-  - `print_success_result` - 打印成功结果
-  - `print_failure_result` - 打印失败结果
-  - `print_summary` - 打印摘要
-  - `extract_error_message` - 提取错误消息
-
-#### 2.3 优化 `print_dry_run` 方法
-
-**优化前**:
-- 33 行代码
-- 包含格式化逻辑
-
-**优化后**:
-- 简化为 13 行
-- 使用 `OutputFormatter` 处理格式化
-
-### 3. 重构 CommandExecutor 类
-
-#### 3.1 拆分 `show_command_output` 方法
-
-**优化前**:
-- 复杂度: 9/7
-- 11 行代码，包含多个条件判断
-
-**优化后**:
-- 简化为 5 行
-- 拆分为：
-  - `show_stdout` - 显示标准输出
-  - `show_stderr` - 显示错误输出
-
-## 📈 重构效果
-
-### 代码质量提升
-
-| 指标 | 优化前 | 优化后 | 改善 |
-|------|--------|--------|------|
-| CLI 类行数 | 284 | 234 | -50 行 (-17.6%) |
-| `execute` 复杂度 | 8/7 | <7 | ✅ 符合规范 |
-| `print_results` 复杂度 | 42/7 | <7 | ✅ 符合规范 |
-| `print_dry_run` 行数 | 33 | 13 | -20 行 (-60.6%) |
-| `show_command_output` 复杂度 | 9/7 | <7 | ✅ 符合规范 |
-
-### 可维护性提升
-
-1. **职责分离**
-   - 格式化逻辑 → `OutputFormatter`
-   - 业务逻辑 → `CLI`
-   - 命令执行 → `CommandExecutor`
-
-2. **方法单一职责**
-   - 每个方法只做一件事
-   - 方法名称清晰表达意图
-   - 易于理解和修改
-
-3. **可测试性提升**
-   - `OutputFormatter` 可独立测试
-   - 小方法易于单元测试
-   - 依赖注入更清晰
-
-### 代码复用
-
-- 格式化逻辑统一管理
-- 减少重复代码
-- 易于扩展新的输出格式
-
-## 🔄 保持的功能
-
-✅ **所有原有功能完全保持不变**:
-- CLI 命令接口不变
-- 输出格式和样式不变
-- 执行流程不变
-- 错误处理行为不变
-
-## 📝 文件变更
-
-### 新增文件
-- `lib/kdeploy/output_formatter.rb` - 输出格式化器
-
-### 修改文件
-- `lib/kdeploy/cli.rb` - 重构 CLI 类
-- `lib/kdeploy/command_executor.rb` - 优化命令执行器
-- `lib/kdeploy.rb` - 添加新模块引用
-
-## ✅ 验证结果
-
-- ✅ 所有语法检查通过
-- ✅ 无 Linter 错误
-- ✅ 模块引用正确
-- ✅ 功能保持不变
-
-## 🎯 后续优化建议
-
-1. **进一步拆分 Initializer 类**
-   - 将文件创建逻辑提取到独立类
-   - 减少类长度（当前 175 行）
-
-2. **添加单元测试**
-   - 为 `OutputFormatter` 添加测试
-   - 为重构后的方法添加测试
-
-3. **性能优化**
-   - 考虑缓存 `Pastel` 实例
-   - 优化字符串拼接
-
-## 📚 总结
-
-本次重构成功：
-1. ✅ 解决了所有复杂度超标问题
-2. ✅ 大幅减少了方法长度
-3. ✅ 提高了代码可维护性
-4. ✅ 保持了所有原有功能
-5. ✅ 改善了代码组织结构
-
-代码现在更加清晰、易于维护和测试，符合 Ruby 最佳实践和 RuboCop 规范。
-