slk 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f633ce48448a37653aed188faa126b5f5d009a3c393128602ee5cb3ac01ff469
-  data.tar.gz: a9a342b35df6960696c800e6007c3cdab422edd0d3132e82e3bd7f91d4a8aeb4
+  metadata.gz: fd09692101d4658e57208d39e81d770e6dc36d2218088194ef55ad5fad0adbd0
+  data.tar.gz: 88e03a0be601536ffb3fd8f1b986900f8f57144b03a52ec5fa24b0b5dbdfbc57
 SHA512:
-  metadata.gz: 3422fcd166300be8a976c6996107c9e95623a1ee24d6850c365c8da8f14e57e81d089902405b027fc5552006ad38468a326b79a8fdfc49916abef875f36c5b6a
-  data.tar.gz: 23def7efe41b31edbe1791e8baf603676d4250ff04d92d0ef90932ae8682bcf3a6babdc9c514f40f64e980703afc9d1057bb70ab9a46380b8a038520ba9de160
+  metadata.gz: 399ca26d5d030704ad553e579fab75376db1578e0814f1ad8a9c2e4115c44e32c8173263fb39c8839eb7a0014ca1758d4e1aaa33b8d65353ba64e6fe83fa8efe
+  data.tar.gz: 64bfbe31c44af1961f43cd7f027bd352847af05434b957bbceb03e26c8bdf820ee805c1fb67d2adac80e18e7ddc286fd643572a17695209db1e3e7826c358baa

data/CHANGELOG.md

@@ -7,7 +7,43 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-<!-- TODO: Remove post_install_message from slk.gemspec before releasing 0.3.0 -->
+## [0.4.0] - 2026-01-30
+
+### Added
+
+- **Windows Support** - slk now runs on Windows
+  - Uses `%APPDATA%` and `%LOCALAPPDATA%` for config/cache directories
+  - Cross-platform command detection with `Open3.capture3`
+  - Proper NTFS permission handling (skips `chmod` on Windows)
+  - New `Support::Platform` module for OS-specific behavior
+  - CI testing on Windows (Ruby 3.2, 3.3, 3.4, 4.0)
+
+### Changed
+
+- New `UserLookup` service consolidates duplicate user name resolution logic
+- Removed ~65 lines of duplicated code from `MentionReplacer` and `MessageFormatter`
+
+## [0.3.0] - 2026-01-16
+
+### Added
+
+- `-vv`/`--very-verbose` flag for detailed API debugging with timing and response bodies
+- SSH key validation and token migration when keys change
+- Public key validation (ensures it matches private key)
+- `config unset` command for removing configuration values
+- CI infrastructure with GitHub Actions (Ruby 3.2-4.0, macOS, Ubuntu)
+
+### Changed
+
+- Improved error handling throughout with comprehensive tests
+- Better SSH key error messages with public key prompting
+- Cache user lookups to reduce API calls
+- Improved rate limit error messages
+
+### Fixed
+
+- Test output no longer leaks to stdout
+- All rubocop offenses resolved
 
 ## [0.2.0] - 2025-01-15
 
@@ -63,5 +99,7 @@ Initial release of the Ruby rewrite. Pure Ruby, no external dependencies.
   - Pure Ruby stdlib - no gem dependencies
   - Ruby 3.2+ with modern features (Data.define, pattern matching)
 
+[0.4.0]: https://github.com/ericboehs/slk/releases/tag/v0.4.0
+[0.3.0]: https://github.com/ericboehs/slk/releases/tag/v0.3.0
 [0.2.0]: https://github.com/ericboehs/slk/releases/tag/v0.2.0
 [0.1.0]: https://github.com/ericboehs/slk/releases/tag/v0.1.0

data/README.md

@@ -12,6 +12,22 @@ gem install slk
 
 Requires Ruby 3.2+.
 
+### Windows
+
+```powershell
+# Install Ruby (if needed) via RubyInstaller or Chocolatey
+winget install RubyInstallerTeam.Ruby.3.3
+# or: choco install ruby
+
+# Install slk
+gem install slk
+
+# (Optional) Install age for encrypted token storage
+choco install age.portable
+```
+
+Configuration is stored in `%APPDATA%\slk\` on Windows.
+
 ## Setup
 
 Run the setup wizard:
@@ -56,10 +72,10 @@ slk dnd off               # Disable DND
 ### Messages
 
 ```bash
-slk messages #general           # Read channel messages
+slk messages general            # Read channel messages
 slk messages @username          # Read DM with user
-slk messages #general -n 50     # Show 50 messages
-slk messages #general --json    # Output as JSON
+slk messages general -n 50      # Show 50 messages
+slk messages general --json     # Output as JSON
 ```
 
 ### Activity
@@ -86,7 +102,7 @@ Use `--show-messages` (or `-m`) to preview the actual message content for each a
 ```bash
 slk unread                # Show unread counts
 slk unread clear          # Mark all as read
-slk unread clear #general # Mark channel as read
+slk unread clear general  # Mark channel as read
 ```
 
 ### Catchup (Interactive Triage)
@@ -155,13 +171,13 @@ Tokens will be stored encrypted in `~/.config/slk/tokens.age`.
 
 ## Configuration
 
-Files are stored in XDG-compliant locations:
+Files are stored in XDG-compliant locations (or `%APPDATA%`/`%LOCALAPPDATA%` on Windows):
 
-- **Config**: `~/.config/slk/`
+- **Config**: `~/.config/slk/` (Windows: `%APPDATA%\slk\`)
   - `config.json` - Settings
   - `tokens.json` or `tokens.age` - Workspace tokens
   - `presets.json` - Status presets
-- **Cache**: `~/.cache/slk/`
+- **Cache**: `~/.cache/slk/` (Windows: `%LOCALAPPDATA%\slk\`)
   - `users-{workspace}.json` - User cache
   - `channels-{workspace}.json` - Channel cache
 
@@ -177,13 +193,15 @@ ruby -Ilib bin/slk --version
 
 # Run tests
 rake test
+```
 
-# Build gem
-gem build slk.gemspec
+### Releasing
 
-# Install locally
-gem install ./slk-0.1.0.gem
-```
+1. Update version in `lib/slk/version.rb`
+2. Update `CHANGELOG.md` (move Unreleased to new version, add date)
+3. Commit: `git commit -am "Release vX.Y.Z"`
+4. Release to RubyGems: `rake release`
+5. Create GitHub Release: `gh release create vX.Y.Z --generate-notes`
 
 ## License
 

data/bin/ci

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+# Run the full CI suite (tests + linting)
+set -e
+
+cd "$(dirname "$0")/.."
+
+echo "==> Running tests..."
+rake test
+
+echo ""
+echo "==> Running rubocop..."
+rubocop
+
+echo ""
+echo "==> All checks passed!"

data/bin/coverage

@@ -0,0 +1,225 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'nokogiri'
+end
+
+# Path to the SimpleCov HTML report
+coverage_file = File.join(Dir.pwd, 'coverage', 'index.html')
+
+unless File.exist?(coverage_file)
+  puts "No coverage report found at #{coverage_file}"
+  puts 'Run tests first: COVERAGE=1 bundle exec rake test'
+  exit 1
+end
+
+# Parse the HTML file
+doc = Nokogiri::HTML(File.read(coverage_file))
+
+# Extract overall line coverage
+line_percent = doc.css('.covered_percent span').first&.text&.strip
+total_lines = doc.css('.t-line-summary b').first&.text&.strip
+covered_lines = doc.css('.t-line-summary .green b').first&.text&.strip
+missed_lines = doc.css('.t-line-summary .red b').first&.text&.strip
+
+# Extract overall branch coverage (first t-branch-summary is the overall stats)
+overall_branch_summary = doc.css('.t-branch-summary').first
+if overall_branch_summary
+  branch_percent = overall_branch_summary.css('span').last.text.strip.gsub(/[()]/, '')
+  branch_summary_spans = overall_branch_summary.css('span b')
+  overall_total_branches = branch_summary_spans[0]&.text&.strip
+  overall_covered_branches = branch_summary_spans[1]&.text&.strip
+  overall_missed_branches = branch_summary_spans[2]&.text&.strip
+else
+  # No branch coverage available
+  branch_percent = nil
+  overall_total_branches = nil
+  overall_covered_branches = nil
+  overall_missed_branches = nil
+end
+
+# Extract timestamp
+timestamp = doc.css('.timestamp .timeago').first&.attr('title')
+
+puts '## SimpleCov Coverage Report'
+puts "Generated: #{timestamp}"
+puts ''
+
+puts "### Line Coverage: #{line_percent}"
+puts "  #{covered_lines}/#{total_lines} lines covered"
+puts "  #{missed_lines} lines missed"
+puts ''
+
+if branch_percent
+  puts "### Branch Coverage: #{branch_percent}"
+  puts "  #{overall_covered_branches}/#{overall_total_branches} branches covered"
+  puts "  #{overall_missed_branches} branches missed"
+  puts ''
+end
+
+# Show file-by-file breakdown if there are missed lines or branches
+if missed_lines.to_i.positive? || overall_missed_branches&.to_i&.positive?
+  # First, collect all files with missing coverage
+  files_with_issues = []
+  files_shown = Set.new
+
+  doc.css('tbody .t-file').each do |row|
+    file_name = row.css('.t-file__name a').first&.text&.strip
+    line_coverage = row.css('.t-file__coverage').first&.text&.strip
+    branch_coverage = row.css('.t-file__branch-coverage').first&.text&.strip
+
+    # Only include files that aren't 100% covered and haven't been seen yet
+    should_skip = files_shown.include?(file_name) ||
+                  (line_coverage == '100.00 %' && (!branch_coverage || branch_coverage == '100.00 %'))
+    next if should_skip
+
+    files_shown.add(file_name)
+    files_with_issues << row
+  end
+
+  total_files_with_issues = files_with_issues.length
+  files_to_show = files_with_issues.take(50)
+
+  puts '### Files with missing coverage:'
+  puts ''
+  if total_files_with_issues > 50
+    puts "Showing top 50 of #{total_files_with_issues} files with missing coverage:"
+    puts ''
+  end
+
+  # rubocop:disable Metrics/BlockLength
+  files_to_show.each do |row|
+    file_name = row.css('.t-file__name a').first&.text&.strip
+    line_coverage = row.css('.t-file__coverage').first&.text&.strip
+    branch_coverage = row.css('.t-file__branch-coverage').first&.text&.strip
+    file_link = row.css('.t-file__name a').first&.attr('href')
+
+    # Extract detailed line information for this file
+    missed_lines = []
+    missed_branches = []
+    total_file_lines = 0
+    covered_file_lines = 0
+
+    if file_link
+      file_id = file_link.gsub('#', '')
+      file_section = doc.css("##{file_id}")
+
+      if file_section.any?
+        # Get the actual counts from SimpleCov's summary
+        line_summary = file_section.css('.t-line-summary')
+        if line_summary.any? # rubocop:disable Metrics/BlockNesting
+          summary_text = line_summary.text
+          # Extract numbers from text like "13 relevant lines. 12 lines covered and 1 lines missed."
+          total_file_lines = Regexp.last_match(1).to_i if summary_text.match(/(\d+)\s+relevant\s+lines/) # rubocop:disable Metrics/BlockNesting
+          covered_file_lines = Regexp.last_match(1).to_i if summary_text.match(/(\d+)\s+lines\s+covered/) # rubocop:disable Metrics/BlockNesting
+        end
+
+        # Find missed lines and branches
+        file_section.css('li').each do |line_item|
+          line_number = line_item.attr('data-linenumber')
+          line_class = line_item.attr('class')
+
+          if line_class&.include?('missed') && !line_class.include?('missed-branch') # rubocop:disable Metrics/BlockNesting
+            missed_lines << line_number
+          elsif line_class&.include?('missed-branch') # rubocop:disable Metrics/BlockNesting
+            missed_branches << line_number
+          end
+        end
+      end
+    end
+
+    # Format the line ranges more clearly
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def format_line_ranges(lines)
+      return '' if lines.empty?
+
+      ranges = []
+      current_range = [lines.first.to_i]
+
+      lines.map(&:to_i).sort[1..]&.each do |line|
+        if line == current_range.last + 1
+          current_range << line
+        else
+          ranges << format_range(current_range)
+          current_range = [line]
+        end
+      end
+      ranges << format_range(current_range)
+
+      "L#{ranges.join(', L')}"
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    def format_range(range)
+      if range.length == 1
+        range.first.to_s
+      else
+        "#{range.first}-#{range.last}"
+      end
+    end
+
+    # Get branch counts from the file section
+    covered_branches = 0
+    total_branches = 0
+
+    if file_link
+      file_id = file_link.gsub('#', '')
+      file_section = doc.css("##{file_id}")
+      branch_summary = file_section.css('.t-branch-summary')
+
+      if branch_summary.any?
+        branch_spans = branch_summary.css('span b')
+        total_branches = branch_spans[0]&.text.to_i
+        covered_branches = branch_spans[1]&.text.to_i
+      end
+    end
+
+    branch_display = branch_coverage ? "Branch: #{branch_coverage}" : 'Branch: N/A'
+    puts "  #{file_name} (Line: #{line_coverage}, #{branch_display}):"
+
+    line_info = "Lines: #{covered_file_lines}/#{total_file_lines}"
+    line_info += " (missed: #{format_line_ranges(missed_lines)})" unless missed_lines.empty?
+    puts "         #{line_info}"
+
+    if total_branches.positive?
+      branch_info = "Branches: #{covered_branches}/#{total_branches}"
+      branch_info += " (missed: #{format_line_ranges(missed_branches)})" unless missed_branches.empty?
+      puts "         #{branch_info}"
+    end
+
+    puts ''
+  end
+  # rubocop:enable Metrics/BlockLength
+end
+
+# Write to GitHub Actions job summary if available
+if ENV['GITHUB_STEP_SUMMARY']
+  File.open(ENV['GITHUB_STEP_SUMMARY'], 'a') do |f|
+    f.puts ''
+    f.puts '## Test Coverage Report'
+    f.puts ''
+    f.puts "**Line Coverage:** #{line_percent} (#{covered_lines}/#{total_lines} lines)"
+    f.puts ''
+
+    if branch_percent
+      f.puts "**Branch Coverage:** #{branch_percent} (#{overall_covered_branches}/#{overall_total_branches} branches)"
+      f.puts ''
+    end
+
+    # Add visual indicators
+    line_pct_value = line_percent.gsub('%', '').to_f
+    branch_pct_value = branch_percent&.gsub('%', '')&.to_f
+
+    if line_pct_value >= 95 && (!branch_pct_value || branch_pct_value >= 95)
+      f.puts 'Coverage meets quality thresholds'
+    elsif line_pct_value >= 80 && (!branch_pct_value || branch_pct_value >= 80)
+      f.puts 'Coverage is acceptable but could be improved'
+    else
+      f.puts 'Coverage is below recommended thresholds'
+    end
+  end
+end

data/bin/test

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+# Run the test suite
+set -e
+
+cd "$(dirname "$0")/.."
+
+rake test "$@"

data/lib/slk/api/search.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Slk
+  module Api
+    # Wrapper for Slack search.* API endpoints
+    # Note: search.messages requires user tokens (xoxc/xoxs), NOT bot tokens (xoxb)
+    class Search
+      def initialize(api_client, workspace)
+        @api = api_client
+        @workspace = workspace
+      end
+
+      # Search for messages across channels and DMs
+      # @param query [String] Search query with optional modifiers (in:, from:, before:, after:, etc.)
+      # @param count [Integer] Number of results per page (max 100)
+      # @param page [Integer] Page number (1-indexed)
+      # @param sort [String] Sort field: 'score' or 'timestamp'
+      # @param sort_dir [String] Sort direction: 'asc' or 'desc'
+      # @return [Hash] API response with messages.matches array
+      def messages(query:, count: 20, page: 1, sort: 'timestamp', sort_dir: 'desc')
+        @api.get(@workspace, 'search.messages', {
+                   query: query,
+                   count: [count, 100].min,
+                   page: page,
+                   sort: sort,
+                   sort_dir: sort_dir
+                 })
+      end
+    end
+  end
+end

data/lib/slk/cli.rb

@@ -13,6 +13,7 @@ module Slk
       'unread' => Commands::Unread,
       'catchup' => Commands::Catchup,
       'activity' => Commands::Activity,
+      'search' => Commands::Search,
       'preset' => Commands::Preset,
       'workspaces' => Commands::Workspaces,
       'cache' => Commands::Cache,
@@ -115,10 +116,12 @@ module Slk
     end
 
     def build_runner(args)
-      verbose = args.include?('-v') || args.include?('--verbose')
-      output = Formatters::Output.new(verbose: verbose)
+      verbose = verbose_mode?(args)
+      very_verbose = args.include?('-vv') || args.include?('--very-verbose')
+      output = @output || Formatters::Output.new(verbose: verbose)
       runner = Runner.new(output: output)
       setup_verbose_logging(runner, output) if verbose
+      setup_very_verbose_logging(runner, output) if very_verbose
       runner
     end
 
@@ -128,6 +131,49 @@ module Slk
       }
     end
 
+    def setup_very_verbose_logging(runner, output)
+      setup_response_header_logging(runner, output)
+      setup_request_body_logging(runner, output)
+      setup_response_body_logging(runner, output)
+      setup_cache_logging(runner, output)
+    end
+
+    def setup_response_header_logging(runner, output)
+      runner.api_client.on_response = lambda { |method, code, headers|
+        next if headers.empty?
+
+        elapsed = headers.delete('elapsed_ms')
+        req_id = headers.delete('X-Slack-Req-Id')
+        rate_parts = headers.map { |k, v| "#{k.sub('X-RateLimit-', '')}=#{v}" }
+
+        parts = ["#{elapsed}ms"]
+        parts << "req=#{req_id}" if req_id
+        parts.concat(rate_parts)
+        output.debug("  #{method} #{code}: #{parts.join(', ')}")
+      }
+    end
+
+    def setup_request_body_logging(runner, output)
+      runner.api_client.on_request_body = lambda { |method, body|
+        truncated = body.length > 500 ? "#{body[0..500]}..." : body
+        output.debug("  #{method} request: #{truncated}")
+      }
+    end
+
+    def setup_response_body_logging(runner, output)
+      runner.api_client.on_response_body = lambda { |method, body|
+        truncated = body.length > 500 ? "#{body[0..500]}..." : body
+        output.debug("  #{method} response: #{truncated}")
+      }
+    end
+
+    def setup_cache_logging(runner, output)
+      runner.cache_store.on_cache_access = lambda { |type, _workspace, key, hit, value|
+        status = hit ? "HIT (#{value})" : 'MISS'
+        output.debug("  [Cache] #{type} #{key}: #{status}")
+      }
+    end
+
     def execute_command(command_class, args, runner)
       command = command_class.new(args, runner: runner)
       result = command.execute
@@ -136,7 +182,8 @@ module Slk
     end
 
     def verbose_mode?(args)
-      args.include?('-v') || args.include?('--verbose')
+      args.include?('-v') || args.include?('--verbose') ||
+        args.include?('-vv') || args.include?('--very-verbose')
     end
 
     def log_api_call_count(runner)

data/lib/slk/commands/base.rb

@@ -69,6 +69,7 @@ module Slk
         when '--no-wrap' then @options[:width] = nil
         when '--all' then @options[:all] = true
         when '-v', '--verbose' then @options[:verbose] = true
+        when '-vv', '--very-verbose' then @options[:verbose] = @options[:very_verbose] = true
         when '-q', '--quiet' then @options[:quiet] = true
         when '--json' then @options[:json] = true
         when '-h', '--help' then @options[:help] = true

data/lib/slk/commands/catchup.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../support/help_formatter'
+require_relative '../support/platform'
 
 module Slk
   module Commands
@@ -293,7 +294,7 @@ module Slk
 
       def open_channel_in_slack(workspace, channel_id)
         team_id = runner.client_api(workspace.name).team_id
-        system('open', "slack://channel?team=#{team_id}&id=#{channel_id}")
+        Support::Platform.open_url("slack://channel?team=#{team_id}&id=#{channel_id}")
         success('Opened in Slack')
         :next
       end
@@ -402,7 +403,7 @@ module Slk
         first = thread_mark_data.first
         team_id = runner.client_api(workspace.name).team_id
         url = "slack://channel?team=#{team_id}&id=#{first[:channel]}&thread_ts=#{first[:thread_ts]}"
-        system('open', url)
+        Support::Platform.open_url(url)
         success('Opened in Slack')
       end
     end