grepfruit 3.2.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe98ab0d2336cca1ac32274bd34aac1b21599fbf0754e3d282c85bb1f91062f3
-  data.tar.gz: db3c4492f5aa9d45131dff7c0342dd58e74c96b04bfacb538c6131e4ca2950ee
+  metadata.gz: 5756a4241133424de6c099a46fcd450f8144cbbbf72951af6312ceffedc565a3
+  data.tar.gz: 9e248f116cf6a8d1742a63a33b1330c7008fd03cc9c11c393cbf4e2bebbb8734
 SHA512:
-  metadata.gz: 30c29450c9e0535f2926de44a66adbcccf1021537c1d00ed3e4a9282cda2862c34f4235f1847740488c67dde79083e9b86b175a729cd8f5ee980cf2ee9a02e1c
-  data.tar.gz: cb46abd7db199d7305d4a1c5f67b9fa6153a422ff8219213b7ef30dc196632d1fcac78a2c6442602713b79df2bddf1c015eb692631468d1cb3a6e1a8b85c2b6c
+  metadata.gz: d41210632eb24008ac4f14742aed37e44da75f19540b8d26c973a1bda8d473b3d6648a4fe37691423c87c3e7ba1fa03e60530d19109e8cc0fd6108809ebc101e
+  data.tar.gz: 9b787719f4bb9d63fe2641f5b15a4214a7dd95921df63a4f010ce59dce71f87c17e62a2fd888dbc2d5c3206c303d98e5497a6b838fac4e8396b6ca5809989f89

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v4.0.0
+
+- Match results now always contain absolute file paths
+- Renamed `directory` key to `path` in programmatic API search results
+- Minor performance improvements
+- Dropped support for Ruby 3.2
+
 ## v3.2.1
 
 - Skip unreadable files instead of crashing

data/README.md

@@ -1,24 +1,18 @@
-# Grepfruit: Text Search Tool
+# Grepfruit: Regex Search in Files
 
 [![Gem Version](https://badge.fury.io/rb/grepfruit.svg)](http://badge.fury.io/rb/grepfruit)
 [![Downloads](https://img.shields.io/gem/dt/grepfruit.svg)](https://rubygems.org/gems/grepfruit)
 [![Github Actions badge](https://github.com/enjaku4/grepfruit/actions/workflows/ci.yml/badge.svg)](https://github.com/enjaku4/grepfruit/actions/workflows/ci.yml)
 [![License](https://img.shields.io/github/license/enjaku4/grepfruit.svg)](LICENSE)
 
-Grepfruit is a tool for searching regex patterns in files, with a CLI designed for CI/CD pipelines and a programmatic API for Ruby applications.
-
-<img width="774" height="155" alt="Screenshot 2026-01-02 at 17 15 48" src="https://github.com/user-attachments/assets/550057e0-7783-4bd2-be9b-ce49f48bdc04" />
-<img width="598" height="484" alt="Screenshot 2026-01-02 at 17 16 52" src="https://github.com/user-attachments/assets/6eff05af-b58d-4e28-a496-343e243b79a2" />
+Grepfruit is a Ruby gem for regex pattern searching, offering both a programmatic API and a CI/CD-friendly CLI.
 
 ## Table of Contents
 
 **Gem Usage:**
   - [Installation](#installation)
-  - [Basic Usage](#basic-usage)
-  - [Command Line Options](#command-line-options)
-  - [Usage Examples](#usage-examples)
-  - [Exit Status](#exit-status)
   - [Programmatic API](#programmatic-api)
+  - [CLI](#cli)
 
 **Community Resources:**
   - [Getting Help and Contributing](#getting-help-and-contributing)
@@ -33,7 +27,48 @@ Install the gem:
 gem install grepfruit
 ```
 
-## Basic Usage
+## Programmatic API
+
+Use Grepfruit directly in Ruby applications:
+
+```rb
+result = Grepfruit.search(
+  regex: /TODO|FIXME/,
+  path: "app",
+  exclude: ["tmp", "vendor"],
+  include: ["*.rb"],
+  truncate: 80,
+  search_hidden: false,
+  jobs: 4,
+  count: false
+)
+```
+
+Returns a hash (when `count: true`, the `matches` key is omitted):
+
+```rb
+{
+  search: {
+    pattern: /TODO|FIXME/,
+    path: "/path/to/app",
+    exclusions: ["tmp", "vendor"],
+    inclusions: ["*.rb"]
+  },
+  summary: {
+    files_checked: 42,
+    files_with_matches: 8,
+    total_matches: 23
+  },
+  matches: [
+    { file: "/path/to/app/models/user.rb", line: 15, content: "# TODO: add validation" },
+    # ...
+  ]
+}
+```
+
+All keyword arguments correspond to their CLI flag counterparts.
+
+## CLI
 
 Search for regex patterns within files in a specified directory:
 
@@ -49,7 +84,7 @@ grepfruit s [options] [PATH]
 
 If no PATH is specified, Grepfruit searches the current directory.
 
-## Command Line Options
+### Command Line Options
 
 | Option | Description |
 |--------|-------------|
@@ -62,9 +97,9 @@ If no PATH is specified, Grepfruit searches the current directory.
 | `--search-hidden` | Include hidden files and directories in search |
 | `--json` | Output results in JSON format |
 
-## Usage Examples
+### Usage Examples
 
-### Basic Pattern Search
+**Basic Pattern Search**
 
 Search for `TODO` comments in the current directory:
 
@@ -72,7 +107,7 @@ Search for `TODO` comments in the current directory:
 grepfruit search -r 'TODO'
 ```
 
-### Excluding Directories
+**Excluding Directories**
 
 Search for `TODO` patterns while excluding common build and dependency directories:
 
@@ -80,7 +115,7 @@ Search for `TODO` patterns while excluding common build and dependency directori
 grepfruit search -r 'TODO' -e 'log,tmp,vendor,node_modules,assets'
 ```
 
-### Multiple Pattern Search Excluding Both Directories and Files
+**Multiple Pattern Search Excluding Both Directories and Files**
 
 Search for both `FIXME` and `TODO` comments in a specific directory:
 
@@ -88,7 +123,7 @@ Search for both `FIXME` and `TODO` comments in a specific directory:
 grepfruit search -r 'FIXME|TODO' -e 'bin,*.md,tmp/log,Gemfile.lock' dev/my_app
 ```
 
-### Line-Specific Exclusion
+**Line-Specific Exclusion**
 
 Exclude specific lines from search results:
 
@@ -96,7 +131,7 @@ Exclude specific lines from search results:
 grepfruit search -r 'FIXME|TODO' -e 'README.md:18'
 ```
 
-### Including Specific File Types
+**Including Specific File Types**
 
 Search only in specific file types using patterns:
 
@@ -105,7 +140,7 @@ grepfruit search -r 'TODO' -i '*.rb,*.js'
 grepfruit search -r 'FIXME' -i '*.py'
 ```
 
-### Output Truncation
+**Output Truncation**
 
 Limit output length for cleaner results:
 
@@ -113,7 +148,7 @@ Limit output length for cleaner results:
 grepfruit search -r 'FIXME|TODO' -t 50
 ```
 
-### Including Hidden Files
+**Including Hidden Files**
 
 Search hidden files and directories:
 
@@ -121,7 +156,7 @@ Search hidden files and directories:
 grepfruit search -r 'FIXME|TODO' --search-hidden
 ```
 
-### JSON Output
+**JSON Output**
 
 Get structured JSON output:
 
@@ -135,7 +170,7 @@ This outputs a JSON response containing search metadata, summary statistics, and
 {
   "search": {
     "pattern": "/TODO/",
-    "directory": "/path/to/search",
+    "path": "/path/to/search",
     "exclusions": ["node_modules"],
     "inclusions": ["*.rb", "*.js"],
     "timestamp": "2025-01-16T10:30:00+00:00"
@@ -147,7 +182,7 @@ This outputs a JSON response containing search metadata, summary statistics, and
   },
   "matches": [
     {
-      "file": "src/main.js",
+      "file": "/path/to/search/src/main.js",
       "line": 15,
       "content": "// TODO: Implement error handling"
     },
@@ -156,7 +191,7 @@ This outputs a JSON response containing search metadata, summary statistics, and
 }
 ```
 
-### Count Only Mode
+**Count Only Mode**
 
 Show only match counts without displaying the actual matches:
 
@@ -165,7 +200,7 @@ grepfruit search -r 'TODO' --count
 grepfruit search -r 'FIXME|TODO' -c -e 'vendor,node_modules'
 ```
 
-### Parallel Processing
+**Parallel Processing**
 
 Grepfruit uses ractors for true parallel processing across CPU cores. Control the number of parallel workers:
 
@@ -174,58 +209,17 @@ grepfruit search -r 'TODO' -j 8  # Use 8 parallel workers
 grepfruit search -r 'TODO' -j 1  # Sequential processing
 ```
 
-## Exit Status
+### Exit Status
 
 Grepfruit returns meaningful exit codes for CI/CD integration:
 
-- **Exit code 0**: No matches found (ideal for quality gates - code is clean)
-- **Exit code 1**: Pattern matches were found (CI should fail - issues detected)
-
-## Programmatic API
-
-Use Grepfruit directly in Ruby applications:
-
-```rb
-result = Grepfruit.search(
-  regex: /TODO|FIXME/,
-  path: "app",
-  exclude: ["tmp", "vendor"],
-  include: ["*.rb"],
-  truncate: 80,
-  search_hidden: false,
-  jobs: 4,
-  count: false
-)
-```
-
-Returns a hash (note: when `count: true`, the `matches` key is omitted):
-
-```rb
-{
-  search: {
-    pattern: /TODO|FIXME/,
-    directory: "/path/to/app",
-    exclusions: ["tmp", "vendor"],
-    inclusions: ["*.rb"]
-  },
-  summary: {
-    files_checked: 42,
-    files_with_matches: 8,
-    total_matches: 23
-  },
-  matches: [
-    { file: "models/user.rb", line: 15, content: "# TODO: add validation" },
-    # ...
-  ]
-}
-```
-
-All keyword arguments correspond to their CLI flag counterparts.
+- **Exit code 0**: No matches found (useful for quality gates)
+- **Exit code 1**: Pattern matches were found (indicates issues)
 
 ## Getting Help and Contributing
 
 ### Getting Help
-Have a question or need assistance? Open a discussion in our [discussions section](https://github.com/enjaku4/grepfruit/discussions) for:
+Have a question or need assistance? Open a discussion in the [discussions section](https://github.com/enjaku4/grepfruit/discussions) for:
 - Usage questions
 - Implementation guidance
 - Feature suggestions
@@ -240,7 +234,7 @@ Found a bug? Please [create an issue](https://github.com/enjaku4/grepfruit/issue
 Ready to contribute? You can:
 - Fix bugs by submitting pull requests
 - Improve documentation
-- Add new features (please discuss first in our [discussions section](https://github.com/enjaku4/grepfruit/discussions))
+- Add new features (please discuss first in the [discussions section](https://github.com/enjaku4/grepfruit/discussions))
 
 Before contributing, please read the [contributing guidelines](https://github.com/enjaku4/grepfruit/blob/master/CONTRIBUTING.md)
 

data/grepfruit.gemspec

@@ -13,10 +13,10 @@ Gem::Specification.new do |spec|
   spec.metadata["documentation_uri"] = "#{spec.homepage}/blob/master/README.md"
   spec.metadata["mailing_list_uri"] = "#{spec.homepage}/discussions"
   spec.metadata["rubygems_mfa_required"] = "true"
-  spec.summary = "Text search tool"
-  spec.description = "A tool for searching regex patterns in files with a CI/CD-friendly CLI and a programmatic Ruby API"
+  spec.summary = "Tool for searching regex patterns in files"
+  spec.description = "A tool for searching regex patterns in files with a programmatic API and a CI/CD-friendly CLI"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.2", "< 4.1"
+  spec.required_ruby_version = ">= 3.3", "< 4.1"
 
   spec.files = [
     "grepfruit.gemspec", "README.md", "CHANGELOG.md", "LICENSE.txt"

data/lib/grepfruit/cli_search.rb

@@ -5,7 +5,7 @@ module Grepfruit
     include Grepfruit::CliDecorator
 
     def execute
-      puts "Error: Directory '#{path}' does not exist." and exit 1 unless File.exist?(path)
+      puts "Error: Path '#{path}' does not exist." and exit 1 unless File.exist?(path)
 
       puts "Searching for #{regex.inspect} in #{path.inspect}..." unless json
 

data/lib/grepfruit/programmatic_search.rb

@@ -1,7 +1,7 @@
 module Grepfruit
   class ProgrammaticSearch < Search
     def execute
-      raise ArgumentError, "directory '#{path}' does not exist." unless File.exist?(path)
+      raise ArgumentError, "path '#{path}' does not exist." unless File.exist?(path)
 
       build_result_hash(execute_search)
     end

data/lib/grepfruit/search.rb

@@ -6,7 +6,7 @@ Warning[:experimental] = false
 
 module Grepfruit
   class Search
-    attr_reader :path, :regex, :exclusions, :inclusions, :excluded_paths, :excluded_lines, :included_paths, :truncate, :search_hidden, :jobs, :json, :count
+    attr_reader :path, :regex, :exclusions, :inclusions, :excluded_paths, :excluded_lines, :truncate, :search_hidden, :jobs, :json, :count
 
     def initialize(path:, regex:, exclude:, include:, truncate:, search_hidden:, jobs:, json: false, count: false)
       @path = File.expand_path(path)
@@ -14,7 +14,6 @@ module Grepfruit
       @exclusions = exclude
       @inclusions = include
       @excluded_lines, @excluded_paths = exclude.partition { _1.split("/").last.include?(":") }
-      @included_paths = include
       @truncate = truncate
       @search_hidden = search_hidden
       @jobs = jobs || Etc.nprocessors
@@ -28,9 +27,9 @@ module Grepfruit
       result_hash = {
         search: {
           pattern: regex,
-          directory: path,
-          exclusions: exclusions,
-          inclusions: inclusions
+          path:,
+          exclusions:,
+          inclusions:
         },
         summary: {
           files_checked: results.total_files,
@@ -40,9 +39,9 @@ module Grepfruit
       }
 
       unless count
-        result_hash[:matches] = results.raw_matches.map do |relative_path, line_num, line_content|
+        result_hash[:matches] = results.raw_matches.map do |file_path, line_num, line_content|
           {
-            file: relative_path,
+            file: file_path,
             line: line_num,
             content: processed_line(line_content)
           }
@@ -92,15 +91,15 @@ module Grepfruit
           work = Ractor.receive
           break if work == :quit
 
-          file_path, relative_path, pattern, exc_lines, count = work
+          file_path, pattern, exc_lines, count = work
           file_results, has_matches, match_count = [], false, 0
 
           File.foreach(file_path).with_index do |line, line_num|
             next unless line.valid_encoding? && line.match?(pattern)
 
-            next if exc_lines.any? { "#{relative_path}:#{line_num + 1}".end_with?(_1) }
+            next if exc_lines.any? { "#{file_path}:#{line_num + 1}".end_with?(_1) }
 
-            file_results << [relative_path, line_num + 1, line] unless count
+            file_results << [file_path, line_num + 1, line] unless count
             has_matches = true
             match_count += 1
           end
@@ -111,10 +110,10 @@ module Grepfruit
     end
 
     def assign_file_to_worker(worker, port, file_enumerator, active_workers, results)
-      file_path, rel_path = get_next_file(file_enumerator)
+      file_path = get_next_file(file_enumerator)
       return unless file_path
 
-      RactorCompat.send_work(worker, [file_path, rel_path, regex, excluded_lines, count])
+      RactorCompat.send_work(worker, [file_path, regex, excluded_lines, count])
       active_workers[worker] = port
       results.total_files += 1
     end
@@ -132,18 +131,19 @@ module Grepfruit
     def create_file_enumerator
       Enumerator.new do |yielder|
         Find.find(path) do |file_path|
-          rel_path = file_path.delete_prefix("#{path}/")
-          Find.prune if excluded_path?(file_path, rel_path)
+          is_file = File.file?(file_path)
 
-          next unless File.file?(file_path) && File.readable?(file_path)
+          Find.prune if excluded_path?(is_file, file_path, file_path.delete_prefix("#{path}/"))
 
-          yielder << [file_path, rel_path]
+          next unless is_file && File.readable?(file_path)
+
+          yielder << file_path
         end
       end
     end
 
-    def excluded_path?(file_path, rel_path)
-      (File.file?(file_path) && included_paths.any? && !matches_pattern?(included_paths, rel_path)) ||
+    def excluded_path?(is_file, file_path, rel_path)
+      (is_file && inclusions.any? && !matches_pattern?(inclusions, rel_path)) ||
         matches_pattern?(excluded_paths, rel_path) ||
         (!search_hidden && File.basename(file_path).start_with?("."))
     end

data/lib/grepfruit/version.rb

@@ -1,3 +1,3 @@
 module Grepfruit
-  VERSION = "3.2.1".freeze
+  VERSION = "4.0.0".freeze
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: grepfruit
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 4.0.0
 platform: ruby
 authors:
 - enjaku4
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -23,8 +23,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-description: A tool for searching regex patterns in files with a CI/CD-friendly CLI
-  and a programmatic Ruby API
+description: A tool for searching regex patterns in files with a programmatic API
+  and a CI/CD-friendly CLI
 email:
 - contact@brownbox.dev
 executables:
@@ -64,7 +64,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4.1'
@@ -74,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.0
+rubygems_version: 4.0.8
 specification_version: 4
-summary: Text search tool
+summary: Tool for searching regex patterns in files
 test_files: []