mui-fzf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 321b6f6ee6029ab32b87d375e399c916ed02ab31c7585771a19af848419e6d7f
+  data.tar.gz: b8b15902af7fce3559a9c476ea068de35a6cbbe7f3ea8f5bde1cc64949661a41
+SHA512:
+  metadata.gz: ef073888aa00a55e59d07959691c8564550afc05e140c29023fdf82c8e4aecd0cabef33e99a810a90c48e61609afad66469b371ec2125314feb1e1b5a3e151b8
+  data.tar.gz: cb14ea1b678606039894ced0176b05d3e0a8215df42df155de420a26803933ae0898c6e42f0035680793c6ac305b086bd855808915f910fd0312d520a4e83955

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-12-11
+
+### Added
+- Initial release of mui-fzf plugin
+- `:Fzf` command for fuzzy file finding with preview (`head -100`)
+- `:Rg` command for interactive ripgrep search:
+  - Without arguments: Opens fzf with empty query, type to search file contents in real-time
+  - With arguments (`:Rg pattern`): Pre-populates search query, allows further refinement
+  - Opens selected file at the matching line number
+- `:Ag` command for interactive The Silver Searcher:
+  - Same behavior as `:Rg` but uses `ag` instead of `rg`
+  - Without arguments: Opens fzf with empty query for interactive search
+  - With arguments (`:Ag pattern`): Pre-populates search query
+  - Opens selected file at the matching line number
+- Automatic plugin registration with Mui via `Mui.plugin_manager.register`
+- ANSI color support for search result highlighting in fzf

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 S-H-GAMELINKS
+
+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,103 @@
+# Mui::Fzf
+
+fzf integration plugin for [Mui](https://github.com/S-H-GAMELINKS/mui) editor.
+
+Provides `:Fzf`, `:Rg`, and `:Ag` commands for fuzzy file searching.
+
+## Requirements
+
+- [fzf](https://github.com/junegunn/fzf) must be installed
+- For `:Rg` command: [ripgrep](https://github.com/BurntSushi/ripgrep)
+- For `:Ag` command: [The Silver Searcher](https://github.com/ggreer/the_silver_searcher)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mui-fzf'
+```
+
+And then execute:
+
+```sh
+$ bundle install
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install mui-fzf
+```
+
+## Usage
+
+Add the following to your `~/.muirc`:
+
+```ruby
+Mui.use "mui-fzf"
+```
+
+### Commands
+
+| Command | Description |
+|---------|-------------|
+| `:Fzf` | Open fzf file finder with preview |
+| `:Rg` | Interactive ripgrep search (type to search file contents) |
+| `:Rg [query]` | Interactive ripgrep search with initial query |
+| `:Ag` | Interactive ag search (type to search file contents) |
+| `:Ag [query]` | Interactive ag search with initial query |
+
+### Interactive Search (`:Rg` and `:Ag`)
+
+The `:Rg` and `:Ag` commands provide interactive grep functionality:
+
+1. **Without arguments** (`:Rg` or `:Ag`):
+   - Opens fzf with an empty search field
+   - Start typing to search file contents in real-time
+   - Results update as you type
+
+2. **With arguments** (`:Rg pattern` or `:Ag pattern`):
+   - Opens fzf with the pattern pre-filled
+   - Initial results are shown immediately
+   - Modify the query to refine results
+
+3. **Opening files**:
+   - Select a result and press Enter
+   - The file opens at the matching line number
+   - Status line shows the opened file and line number
+
+### Key Mappings
+
+You can add custom key mappings in your `~/.muirc`:
+
+```ruby
+# Ctrl-P to open fzf
+Mui.keymap :normal, "<C-p>" do |ctx|
+  ctx.run_command :Fzf
+end
+
+# Space + f for fzf
+Mui.keymap :normal, "<Space>f" do |ctx|
+  ctx.run_command :Fzf
+end
+
+# Space + r for ripgrep
+Mui.keymap :normal, "<Space>r" do |ctx|
+  ctx.run_command :Rg
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/S-H-GAMELINKS/mui-fzf.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/mui/fzf/plugin.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+module Mui
+  module Fzf
+    # fzf integration plugin for Mui editor
+    # Provides :Fzf, :Rg, and :Ag commands for fuzzy file searching
+    class Plugin < Mui::Plugin
+      name "fzf"
+
+      FZF_CANCEL_EXIT_CODE = 130
+      FZF_PREVIEW_COMMAND = "head -100 {}"
+      # Preview command for grep results (file:line:content format)
+      # Extract filename with cut -d: -f1, line number with cut -d: -f2
+      GREP_PREVIEW_COMMAND = "head -100 $(echo {} | cut -d: -f1)"
+
+      def setup
+        register_fzf_command
+        register_rg_command
+        register_ag_command
+      end
+
+      private
+
+      def register_fzf_command
+        plugin = self
+        Mui.command(:Fzf) do |context, _args|
+          plugin.execute_fzf(context, plugin.build_fzf_command, grep_mode: false)
+        end
+      end
+
+      def register_rg_command
+        plugin = self
+        Mui.command(:Rg) do |context, args|
+          plugin.execute_rg(context, args)
+        end
+      end
+
+      def register_ag_command
+        plugin = self
+        Mui.command(:Ag) do |context, args|
+          plugin.execute_ag(context, args)
+        end
+      end
+
+      public
+
+      def execute_fzf(context, cmd, grep_mode: false)
+        unless context.command_exists?("fzf")
+          context.set_message("Error: fzf is not installed")
+          return
+        end
+
+        result = context.run_interactive_command(cmd)
+        handle_result(context, result, grep_mode:)
+      end
+
+      def execute_rg(context, args)
+        unless context.command_exists?("rg")
+          context.set_message("Error: rg (ripgrep) is not installed")
+          return
+        end
+
+        query = args&.strip || ""
+        # Always use interactive grep mode (start empty or with initial query)
+        execute_fzf(context, build_rg_command(query), grep_mode: true)
+      end
+
+      def execute_ag(context, args)
+        unless context.command_exists?("ag")
+          context.set_message("Error: ag (the_silver_searcher) is not installed")
+          return
+        end
+
+        query = args&.strip || ""
+        # Always use interactive grep mode (start empty or with initial query)
+        execute_fzf(context, build_ag_command(query), grep_mode: true)
+      end
+
+      def build_fzf_command
+        "fzf --preview '#{FZF_PREVIEW_COMMAND}'"
+      end
+
+      def build_file_list_command(list_cmd)
+        "#{list_cmd} | fzf --preview '#{FZF_PREVIEW_COMMAND}'"
+      end
+
+      def build_rg_command(query)
+        initial_query = escape_query(query)
+        rg_cmd = "rg --color=always --line-number --no-heading"
+        if initial_query.empty?
+          # No initial query: start with empty list, search on input
+          "echo '' | fzf --ansi --disabled " \
+            "--bind 'change:reload:#{rg_cmd} {q} || true' " \
+            "--preview '#{GREP_PREVIEW_COMMAND}'"
+        else
+          # With initial query: run rg first, then allow filtering
+          "#{rg_cmd} '#{initial_query}' | " \
+            "fzf --ansi --disabled --query '#{initial_query}' " \
+            "--bind 'change:reload:#{rg_cmd} {q} || true' " \
+            "--preview '#{GREP_PREVIEW_COMMAND}'"
+        end
+      end
+
+      def build_ag_command(query)
+        initial_query = escape_query(query)
+        ag_cmd = "ag --color --nogroup"
+        if initial_query.empty?
+          # No initial query: start with empty list, search on input
+          "echo '' | fzf --ansi --disabled " \
+            "--bind 'change:reload:#{ag_cmd} {q} || true' " \
+            "--preview '#{GREP_PREVIEW_COMMAND}'"
+        else
+          # With initial query: run ag first, then allow filtering
+          "#{ag_cmd} '#{initial_query}' | " \
+            "fzf --ansi --disabled --query '#{initial_query}' " \
+            "--bind 'change:reload:#{ag_cmd} {q} || true' " \
+            "--preview '#{GREP_PREVIEW_COMMAND}'"
+        end
+      end
+
+      private
+
+      def handle_result(context, result, grep_mode: false)
+        # User cancelled (Esc or Ctrl-C)
+        return if cancelled?(result)
+
+        # fzf error
+        unless result[:success]
+          context.set_message("fzf error: #{result[:stderr]}")
+          return
+        end
+
+        # Open selected file
+        selected = result[:stdout].strip
+        return if selected.empty?
+
+        if grep_mode
+          open_grep_result(context, selected)
+        else
+          open_selected_file(context, selected)
+        end
+      end
+
+      def cancelled?(result)
+        result[:exit_status] == FZF_CANCEL_EXIT_CODE ||
+          result[:stdout].strip.empty?
+      end
+
+      def open_selected_file(context, file_path)
+        buffer = Mui::Buffer.new
+        buffer.load(file_path)
+        context.window.buffer = buffer
+        context.set_message("\"#{file_path}\" opened")
+      rescue SystemCallError => e
+        context.set_message("Error: #{e.message}")
+      end
+
+      def open_grep_result(context, selected)
+        # Parse "file:line:content" format (handle ANSI codes)
+        clean = selected.gsub(/\e\[[0-9;]*m/, "")
+        parts = clean.split(":", 3)
+        return if parts.length < 2
+
+        file_path = parts[0]
+        line_number = parts[1].to_i
+
+        buffer = Mui::Buffer.new
+        buffer.load(file_path)
+        context.window.buffer = buffer
+
+        # Move cursor to the matched line
+        if line_number.positive?
+          context.window.cursor_row = line_number - 1
+          context.window.ensure_cursor_visible
+        end
+
+        context.set_message("\"#{file_path}\" opened at line #{line_number}")
+      rescue SystemCallError => e
+        context.set_message("Error: #{e.message}")
+      end
+
+      def escape_query(query)
+        query.gsub("'") { "'\\''" }
+      end
+    end
+  end
+end

data/lib/mui/fzf/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Mui
+  module Fzf
+    VERSION = "0.1.0"
+  end
+end

data/lib/mui/fzf.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "mui"
+
+require_relative "fzf/version"
+require_relative "fzf/plugin"
+
+module Mui
+  module Fzf
+    class Error < StandardError; end
+  end
+end
+
+# Register the plugin with Mui
+Mui.plugin_manager.register(:fzf, Mui::Fzf::Plugin)

data/lib/mui_fzf.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "mui/fzf"

data/sig/mui/fzf.rbs

@@ -0,0 +1,6 @@
+module Mui
+  module Fzf
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: mui-fzf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- S-H-GAMELINKS
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Provides :Fzf, :Rg, and :Ag commands for fuzzy file searching in Mui
+  editor
+email:
+- gamelinks007@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mui/fzf.rb
+- lib/mui/fzf/plugin.rb
+- lib/mui/fzf/version.rb
+- lib/mui_fzf.rb
+- sig/mui/fzf.rbs
+homepage: https://github.com/S-H-GAMELINKS/mui-fzf
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/S-H-GAMELINKS/mui-fzf
+  source_code_uri: https://github.com/S-H-GAMELINKS/mui-fzf
+  changelog_uri: https://github.com/S-H-GAMELINKS/mui-fzf/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.0.beta2
+specification_version: 4
+summary: fzf integration plugin for Mui editor
+test_files: []