hank 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e219d6cebabc8bf82ab4a659651c32e26fec0307d1a99aa5056209607023e10
+  data.tar.gz: 4322b70a37b63927ecc0e614d7559baacd074728801169b3ea17eb366071fc31
+SHA512:
+  metadata.gz: c0f7a2893fa7c325cebc65cd3dca8afc31a9712b2b7ae6e192d9687ec9221936d0f1a02a63539aedb5b92288028f930c1912f5dcbf19c7258043d78e1b2c0d3f
+  data.tar.gz: 798201a727a850d0c57cd7746978c980b5e770c923a61950c6fbe7bf1406c82a43954caaf96e95bf4255c03283b016b38dd88a013a230286f308f7c0ed640ef8

data/.clodignore

@@ -0,0 +1,32 @@
+# Default .clodignore file for Claude uploader
+# Add patterns to ignore files when uploading to Claude
+
+*.dll
+*.dylib
+*.exe
+*.gif
+*.ico
+*.jar
+*.jpg
+*.jpeg
+*.mp3
+*.mp4
+*.png
+*.so
+*.svg
+*.tar.gz
+*.zip
+.clod
+.git
+build
+dist
+node_modules
+out
+target
+*.log
+Cargo.lock
+package-lock.json
+pnpm-lock.yaml
+yarn.lock
+.gitignore
+.clodignore

data/.rubocop.yml

@@ -0,0 +1,59 @@
+plugins:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+
+Metrics/MethodLength:
+  Exclude:
+    - 'test/**/*'
+    - 'lib/hank/cli.rb'
+    - 'lib/hank/file_selector.rb'
+    - 'lib/hank/path_utils.rb'
+    - 'lib/hank/symlink_manager.rb'
+    - 'lib/hank/validator.rb'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'test/**/*'
+    - 'lib/hank/cli.rb'
+    - 'lib/hank/file_selector.rb'
+    - 'lib/hank/symlink_manager.rb'
+    - 'lib/hank/validator.rb'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/hank/cli.rb'
+    - 'lib/hank/file_selector.rb'
+    - 'lib/hank/symlink_manager.rb'
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/hank/cli.rb'
+    - 'lib/hank/file_selector.rb'
+    - 'lib/hank/symlink_manager.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/hank/cli.rb'
+    - 'lib/hank/file_selector.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'lib/hank/file_selector.rb'
+    - 'lib/hank/validator.rb'
+    - 'hank.gemspec'
+    - 'test/**/*'
+
+Minitest/MultipleAssertions:
+  Exclude:
+    - 'test/**/*'
+
+Style/Documentation:
+  Exclude:
+    - 'lib/hank/version.rb'
+    - 'test/**/*'
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec

data/CLAUDE.md

@@ -0,0 +1,22 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Build/Test Commands
+- Run all tests: `bundle exec rake test`
+- Run single test: `bundle exec ruby -Itest test/hank/specific_test.rb -n test_method_name`
+- Run linter: `bundle exec rake rubocop`
+- Default task (tests + lint): `bundle exec rake`
+- Build gem: `bundle exec rake build`
+- Install gem locally: `bundle exec rake install`
+
+## Code Style Guidelines
+- **Typing**: Uses Sorbet for static typing with `# typed: strict` at top of files and `extend T::Sig`
+- **Type Signatures**: Methods defined with `sig { params(...).returns(...) }` blocks
+- **Imports**: Require statements at top with `# frozen_string_literal: true` comment
+- **Formatting**: 2-space indentation, RuboCop enforced style
+- **Naming**: Snake_case for methods/variables, CamelCase for classes/modules
+- **Namespacing**: All classes under `Hank::` module
+- **Error Handling**: Custom `Hank::Error` class, specific rescue blocks with colorized warnings
+- **Testing**: Minitest framework with `_test.rb` suffix in `test/` directory mirroring lib structure
+- **Dependencies**: Managed in gemspec with versioned requirements

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'minitest', '~> 5.16'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.36'
+gem 'sorbet', '~> 0.5'
+gem 'sorbet-runtime', '~> 0.5'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Fuzz Leonard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# Hank
+
+[![Gem Version](https://badge.fury.io/rb/hank.svg)](https://badge.fury.io/rb/hank)
+
+Hank manages symlinks between source paths and flattened pathnames within a git repository, making it easier to manage configuration files and collaborate with AI tools.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+$ gem install hank
+```
+
+## Usage
+
+Run the `hank` command in the directory where you want to manage your files:
+
+```bash
+$ hank
+```
+
+If no Hankfile exists, Hank will offer to create one and guide you through selecting files to manage.
+
+To edit an existing Hankfile:
+
+```bash
+$ hank edit
+```
+
+Check the version:
+
+```bash
+$ hank --version
+```
+
+## How It Works
+
+Hank maintains a Hankfile (in TOML format) that maps source paths to flattened pathnames within your repository. When you run `hank`, it ensures all source paths are symlinks pointing to their corresponding targets in your repository.
+
+For example, if you want to manage your `.bashrc` file, Hank will:
+
+1. Create a file named `dot--bashrc` in your repository
+2. Create a symlink from `~/.bashrc` to this file
+
+This allows you to version control your configuration files while keeping them in their original locations.
+
+## Features
+
+- Manages symlinks between source paths and repository files
+- Converts dotfiles to visible files with "dot--" prefix
+- Flattens pathnames for better organization
+- Detects text files using libmagic
+- Provides a simple GUI for file selection
+- Integrates with git for version control
+- Includes comprehensive test coverage
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fuzz/hank.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'rubocop-minitest'
+require 'rubocop-rake'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/hank

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'hank'
+require 'hank/cli'
+
+Hank::CLI.start(ARGV)

data/hank.gemspec

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative 'lib/hank/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'hank'
+  spec.version = Hank::VERSION
+  spec.authors = ['Fuzz Leonard']
+  spec.email = ['ink@fuzz.ink']
+
+  spec.summary = 'Symlink manager for easier file management and AI collaboration'
+  spec.description = 'Hank manages symlinks between source paths and flattened pathnames within a git repository, ' \
+                     'making it easier to manage configuration files and collaborate with AI tools.'
+  spec.homepage = 'https://github.com/fuzz/hank'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/fuzz/hank'
+  spec.metadata['changelog_uri'] = 'https://github.com/fuzz/hank/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'bin'
+  spec.executables = ['hank']
+  spec.require_paths = ['lib']
+
+  # Dependencies
+  spec.add_dependency 'colorize', '~> 0.8'
+  spec.add_dependency 'curses', '~> 1.4'
+  spec.add_dependency 'diffy', '~> 3.4'
+  spec.add_dependency 'fiddle', '~> 1.1'
+  spec.add_dependency 'logger', '~> 1.5'
+  spec.add_dependency 'ruby-filemagic', '~> 0.7'
+  spec.add_dependency 'sorbet-runtime', '~> 0.5'
+  spec.add_dependency 'thor', '~> 1.2'
+  spec.add_dependency 'toml-rb', '~> 2.2'
+
+  # Development dependencies
+  spec.add_development_dependency 'minitest', '~> 5.16'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.36'
+  spec.add_development_dependency 'rubocop-minitest', '~> 0.38'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.7'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
+  spec.add_development_dependency 'sorbet', '~> 0.5'
+  spec.add_development_dependency 'tapioca', '~> 0.16'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/hank/cli.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+# typed: strict
+
+module Hank
+  # Command line interface for Hank
+  class CLI < Thor
+    extend T::Sig
+
+    desc '', 'Verify or create symlinks based on Hankfile'
+    sig { void }
+    def index
+      hankfile_path = Pathname.new(Dir.pwd).join('Hankfile')
+
+      if hankfile_path.exist?
+        process_existing_hankfile(hankfile_path)
+      else
+        create_new_hankfile(hankfile_path)
+      end
+    end
+    default_task :index
+
+    desc 'edit', 'Edit Hankfile using GUI file browser'
+    sig { returns(NilClass) }
+    def edit
+      hankfile_path = Pathname.new(Dir.pwd).join('Hankfile')
+
+      unless hankfile_path.exist?
+        puts "No Hankfile found in current directory. Run 'hank' to create one.".red
+        exit 1
+      end
+
+      hankfile = Hankfile.from_file(hankfile_path)
+      file_selector = FileSelector.new(hankfile.mappings.keys)
+      selected_files = file_selector.run
+
+      if selected_files
+        hankfile.update_mappings(selected_files)
+        puts 'Hankfile updated with selected files.'
+      else
+        puts 'Edit cancelled.'
+      end
+    end
+
+    map '--version' => :version
+    desc '--version', 'Display version information'
+    sig { returns(NilClass) }
+    def version
+      puts "Hank version #{Hank::VERSION}"
+    end
+
+    private
+
+    sig { params(hankfile_path: Pathname).void }
+    def process_existing_hankfile(hankfile_path)
+      hankfile = Hankfile.from_file(hankfile_path)
+      symlink_manager = SymlinkManager.new(hankfile)
+      validator = Validator.new(hankfile)
+
+      issues = validator.validate
+
+      if issues.empty?
+        puts 'All symlinks are correctly configured.'.green
+      else
+        puts "Found #{issues.size} issues:".yellow
+
+        issues.each do |issue|
+          handle_issue(issue, symlink_manager, hankfile_path.to_s)
+        end
+      end
+    end
+
+    sig { params(issue: Validator::Issue, symlink_manager: SymlinkManager, _hankfile_path: T.nilable(String)).void }
+    def handle_issue(issue, symlink_manager, _hankfile_path = nil)
+      source_path = issue.source_path
+      target_path = issue.target_path
+
+      case issue.type
+      when :missing
+        puts "Creating symlink for #{source_path} -> #{target_path}".yellow
+        symlink_manager.create_symlink(source_path, target_path)
+      when :wrong_target
+        puts "Symlink #{source_path} points to wrong target:".red
+        puts "  Current: #{issue.current_target}"
+        puts "  Expected: #{target_path}"
+        puts 'Options:'
+        puts '  1. Update symlink to point to correct target'
+        puts '  2. Remove from Hankfile'
+        print 'Choose option (1/2): '
+        choice = gets.chomp
+
+        if choice == '1'
+          symlink_manager.create_symlink(source_path, target_path, force: true)
+        elsif choice == '2'
+          symlink_manager.remove_mapping(source_path)
+        else
+          puts 'Invalid choice. Skipping.'.red
+        end
+      when :not_symlink
+        if File.directory?(source_path)
+          puts "#{source_path} is a directory, skipping.".yellow
+        else
+          puts "#{source_path} is a regular file, not a symlink:".red
+          target_path_full = symlink_manager.base_dir.join(target_path).to_s
+          if File.file?(source_path) && File.file?(target_path_full)
+            diff = Diffy::Diff.new(source_path, target_path_full,
+                                   source: 'files').to_s(:color)
+            puts diff
+          end
+          puts 'Options:'
+          puts '  1. Replace with symlink (backup existing file)'
+          puts '  2. Remove from Hankfile'
+          print 'Choose option (1/2): '
+          choice = gets.chomp
+
+          if choice == '1'
+            symlink_manager.create_symlink(source_path, target_path, force: true)
+          elsif choice == '2'
+            symlink_manager.remove_mapping(source_path)
+          else
+            puts 'Invalid choice. Skipping.'.red
+          end
+        end
+      end
+    end
+
+    sig { params(_hankfile_path: Pathname).void }
+    def create_new_hankfile(_hankfile_path)
+      puts 'No Hankfile found in current directory.'
+      print 'Would you like to create one? (y/n): '
+
+      answer = gets.chomp.downcase
+      return unless answer == 'y'
+
+      file_selector = FileSelector.new
+      selected_files = file_selector.run
+
+      return puts 'No files selected. Exiting.'.yellow if selected_files.nil? || selected_files.empty?
+
+      hankfile = Hankfile.new
+      Pathname.new(Dir.pwd)
+
+      selected_files.each do |source_path|
+        target_path = PathUtils.flatten_path(source_path)
+        hankfile.add_mapping(source_path, target_path)
+      end
+
+      puts "\nProposed Hankfile contents:"
+      puts hankfile
+
+      print "\nWould you like to proceed to copy source files and create symlinks? (y/n): "
+      answer = gets.chomp.downcase
+
+      if answer == 'y'
+        symlink_manager = SymlinkManager.new(hankfile)
+        symlink_manager.install_all
+        puts 'Hankfile created and symlinks installed.'.green
+      else
+        puts 'Operation cancelled.'.yellow
+      end
+    end
+  end
+end

data/lib/hank/file_selector.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+# typed: strict
+
+require 'curses'
+
+module Hank
+  # Interactive curses-based file selection interface
+  class FileSelector
+    extend T::Sig
+
+    sig { params(initial_files: T.nilable(T::Array[String])).void }
+    def initialize(initial_files = nil)
+      @initial_files = T.let(initial_files || [], T::Array[String])
+      @selected_files = T.let(@initial_files.dup, T::Array[String])
+      @current_path = T.let(Pathname.new('/'), Pathname)
+      @file_list = T.let([], T::Array[String])
+      @current_index = T.let(0, Integer)
+      @offset = T.let(0, Integer)
+    end
+
+    sig { returns(T.nilable(T::Array[String])) }
+    def run
+      init_curses
+      begin
+        load_files
+        draw_screen
+        handle_input
+      ensure
+        close_curses
+      end
+
+      @selected_files.empty? ? nil : @selected_files
+    end
+
+    private
+
+    sig { void }
+    def init_curses
+      Curses.init_screen
+      Curses.start_color
+      Curses.curs_set(0)  # Hide cursor
+      Curses.noecho       # Don't echo input
+      Curses.cbreak       # Immediate key input
+      Curses.stdscr.keypad(true) # Enable arrow keys
+
+      # Define color pairs
+      Curses.init_pair(1, Curses::COLOR_WHITE, Curses::COLOR_BLUE)    # Header/footer
+      Curses.init_pair(2, Curses::COLOR_BLACK, Curses::COLOR_WHITE)   # Selected item
+      Curses.init_pair(3, Curses::COLOR_GREEN, Curses::COLOR_BLACK)   # Directory
+      Curses.init_pair(4, Curses::COLOR_WHITE, Curses::COLOR_BLACK)   # File
+      Curses.init_pair(5, Curses::COLOR_YELLOW, Curses::COLOR_BLACK)  # Selected file
+    end
+
+    sig { void }
+    def close_curses
+      Curses.close_screen
+    end
+
+    sig { void }
+    def load_files
+      @file_list = []
+
+      # Add parent directory option
+      @file_list << '..'
+
+      # Add directories
+      dirs = Dir.entries(@current_path.to_s)
+                .select { |entry| File.directory?(File.join(@current_path, entry)) && entry != '.' && entry != '..' }
+                .sort
+                .map { |entry| "#{entry}/" }
+
+      @file_list.concat(dirs)
+
+      # Add text files
+      files = Dir.entries(@current_path.to_s)
+                 .select do |entry|
+        path = File.join(@current_path, entry)
+        File.file?(path) && !File.symlink?(path) && PathUtils.text_file?(path)
+      end
+               .sort
+
+      @file_list.concat(files)
+
+      # Reset current index if needed
+      @current_index = 0 if @current_index >= @file_list.length
+      @offset = 0 if @offset >= @file_list.length
+    end
+
+    sig { void }
+    def draw_screen
+      Curses.clear
+      height = Curses.lines
+      width = Curses.cols
+
+      # Draw header
+      Curses.attron(Curses.color_pair(1))
+      Curses.setpos(0, 0)
+      Curses.addstr(' ' * width)
+      Curses.setpos(0, 0)
+      Curses.addstr(" Hank File Selector - #{@current_path}")
+      Curses.attroff(Curses.color_pair(1))
+
+      # Draw file list
+      visible_items = height - 4 # Header, footer, and help line
+      @offset = @current_index - visible_items + 1 if @current_index >= @offset + visible_items
+      @offset = @current_index if @current_index < @offset
+
+      visible_files = @file_list[@offset, visible_items]
+      visible_files&.each_with_index do |file, idx|
+        row = idx + 1
+        real_idx = idx + @offset
+        is_selected = @current_index == real_idx
+        is_dir = file.end_with?('/')
+        is_chosen = @selected_files.include?(File.join(@current_path, file.chomp('/')).to_s)
+
+        # Select color based on file type and selection status
+        if is_selected
+          Curses.attron(Curses.color_pair(2))
+        elsif is_dir
+          Curses.attron(Curses.color_pair(3))
+        elsif is_chosen
+          Curses.attron(Curses.color_pair(5))
+        else
+          Curses.attron(Curses.color_pair(4))
+        end
+
+        Curses.setpos(row, 0)
+        Curses.addstr(' ' * width)
+        Curses.setpos(row, 0)
+        prefix = is_chosen ? '[*] ' : '[ ] '
+        Curses.addstr("#{prefix}#{file}")
+
+        # Reset attributes
+        if is_selected
+          Curses.attroff(Curses.color_pair(2))
+        elsif is_dir
+          Curses.attroff(Curses.color_pair(3))
+        elsif is_chosen
+          Curses.attroff(Curses.color_pair(5))
+        else
+          Curses.attroff(Curses.color_pair(4))
+        end
+      end
+
+      # Draw help line
+      Curses.setpos(height - 2, 0)
+      Curses.addstr(' ' * width)
+      Curses.setpos(height - 2, 0)
+      Curses.addstr(' ↑/↓: Navigate | Space: Select | Enter: Open | q: Quit | d: Done')
+
+      # Draw footer with stats
+      Curses.attron(Curses.color_pair(1))
+      Curses.setpos(height - 1, 0)
+      Curses.addstr(' ' * width)
+      Curses.setpos(height - 1, 0)
+      Curses.addstr(" Selected: #{@selected_files.size} files")
+      Curses.attroff(Curses.color_pair(1))
+
+      Curses.refresh
+    end
+
+    sig { returns(T.nilable(T::Array[String])) }
+    def handle_input
+      loop do
+        draw_screen
+        key = Curses.getch
+
+        case key
+        when Curses::KEY_UP
+          @current_index -= 1 if @current_index.positive?
+        when Curses::KEY_DOWN
+          @current_index += 1 if @current_index < @file_list.length - 1
+        when Curses::KEY_ENTER, 10, 13 # Enter key
+          file = @file_list[@current_index]
+          if file == '..'
+            @current_path = @current_path.parent
+            load_files
+          elsif T.must(file).end_with?('/')
+            @current_path = @current_path.join(T.must(file).chomp('/'))
+            load_files
+          end
+        when ' ' # Space key for selection
+          file = @file_list[@current_index]
+          next if file == '..' # Skip parent directory
+
+          path = if T.must(file).end_with?('/') # Directory
+                   File.join(@current_path, T.must(file).chomp('/')).to_s
+                 else # File
+                   File.join(@current_path, file).to_s
+                 end
+          if @selected_files.include?(path)
+            @selected_files.delete(path)
+          else
+            @selected_files << path
+          end
+        when 'q', 'Q'
+          return nil # Cancel
+        when 'd', 'D'
+          return @selected_files
+        end
+      end
+    end
+  end
+end