grepfruit 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d27a11eff0190c85e32b6081219b6db2b3f79e92170f85443e7e422df011bd5e
-  data.tar.gz: 7d1ab993aa73df36b9cfd1653721757d0e6f0473413562900231da351f9dbc89
+  metadata.gz: 9c0935c8c65aa93564bbac5b7e4c109ac46df6f359a61da5f20f0fb5d1c50941
+  data.tar.gz: 9a5b235ee6c08a82c9dd1e416b3fce19d192224182a59bcf6ce3a73bf45a1d50
 SHA512:
-  metadata.gz: a8f66005b0f1ddc8a75747fa4c24b16e6401332fad5061b57220f766eba2a64691a46f9686c349dce4f7b7b42b308e5e7141da58177b338a5104386573f5322e
-  data.tar.gz: 8ed7dc08c649a3becacc813a9e6f7bfbb0722c14a5b63cf3749e9a00cf2333fa75b8990ac2656d82c47dea5422bcb06e48ebc00eb413aca362fdb6d6e91b754a
+  metadata.gz: a2bc081cc743ec0441464fb5af636f93666e93e5510f0a3694895f47c23cccfc413631fe8498458890af9e91e2beecaa5ced0369f0bf68a628bb46a10ca75554
+  data.tar.gz: 8c728cca15c6ce8cfe07248f5622508407ce2e4dd41459a01bd801652651eeb7c360a76e8c8bb99e2ff7d34be43d78b5520a6f59b068c808c5f85a29bd5c4cb9

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## v4.1.0
+
+- Added --relative-paths option to return match paths relative to the search directory
+- Fixed absolute paths in --exclude and --include being silently ignored instead of rejected
+- Fixed line exclusions also applying to files whose path only ends with the given path
+- Fixed wildcards in --exclude and --include not matching hidden files when --search-hidden is enabled
+- Minor performance improvements
+
+## v4.0.2
+
+- Fixed searches silently checking no files when the search path itself was hidden or matched an exclusion
+- Fixed a crash backtrace being printed after the error message when the search path does not exist
+- Fixed the whole search crashing when a file is deleted or becomes unreadable mid-search
+
 ## v4.0.1
 
 - Restored accidentally removed CLI progress indicator

data/README.md

@@ -40,7 +40,8 @@ result = Grepfruit.search(
   truncate: 80,
   search_hidden: false,
   jobs: 4,
-  count: false
+  count: false,
+  relative_paths: false
 )
 ```
 
@@ -66,6 +67,8 @@ Returns a hash (when `count: true`, the `matches` key is omitted):
 }
 ```
 
+Match paths are absolute by default. With `relative_paths: true`, they are relative to the search directory, or just the file name when a single file is searched. `search.path` is always absolute.
+
 All keyword arguments correspond to their CLI flag counterparts.
 
 ## CLI
@@ -89,11 +92,12 @@ If no PATH is specified, Grepfruit searches the current directory.
 | Option | Description |
 |--------|-------------|
 | `-r, --regex REGEX` | Regex pattern to search for (required) |
-| `-e, --exclude x,y,z` | Comma-separated list of files, directories, or lines to exclude |
-| `-i, --include x,y,z` | Comma-separated list of file patterns to include (only these files will be searched) |
+| `-e, --exclude x,y,z` | Comma-separated list of files, directories, or lines to exclude: names, wildcards, paths relative to the search directory, or `file:line` |
+| `-i, --include x,y,z` | Comma-separated list of files to include: names, wildcards, or paths relative to the search directory |
 | `-t, --truncate N` | Truncate search result output to N characters |
 | `-j, --jobs N` | Number of parallel workers (default: number of CPU cores) |
 | `-c, --count` | Show only match counts, not match details |
+| `-p, --relative-paths` | Show match paths relative to the search directory |
 | `--search-hidden` | Include hidden files and directories in search |
 | `--json` | Output results in JSON format |
 
@@ -200,6 +204,15 @@ grepfruit search -r 'TODO' --count
 grepfruit search -r 'FIXME|TODO' -c -e 'vendor,node_modules'
 ```
 
+**Relative Paths**
+
+Match paths are absolute by default. Show them relative to the search directory instead:
+
+```bash
+grepfruit search -r 'TODO' --relative-paths dev/my_app
+grepfruit search -r 'TODO' -p dev/my_app/README.md  # Shows just the file name
+```
+
 **Parallel Processing**
 
 Grepfruit uses ractors for true parallel processing across CPU cores. Control the number of parallel workers:

data/exe/grepfruit

@@ -2,6 +2,8 @@
 
 RubyVM::YJIT.enable if defined?(RubyVM::YJIT) && RubyVM::YJIT.respond_to?(:enable)
 
+Warning[:experimental] = false
+
 $LOAD_PATH.unshift("#{__dir__}/../lib")
 
 require "grepfruit"

data/lib/grepfruit/cli.rb

@@ -17,13 +17,16 @@ module Grepfruit
       option :jobs, aliases: ["-j"], type: :integer, desc: "Number of parallel workers (default: all CPU cores, use 1 for sequential)"
       option :json, type: :flag, default: false, desc: "Output results in JSON format"
       option :count, aliases: ["-c"], type: :flag, default: false, desc: "Show only counts, not match details"
+      option :relative_paths, aliases: ["-p"], type: :flag, default: false, desc: "Show match paths relative to the search directory"
 
       def call(path: ".", **options)
         error_exit("You must specify a regex pattern using the -r or --regex option.") unless options[:regex]
         error_exit("Jobs must be at least 1") if options[:jobs] && options[:jobs].to_i < 1
+        error_exit("Exclude must contain only relative paths") if options[:exclude].any? { File.absolute_path?(_1) }
+        error_exit("Include must contain only relative paths") if options[:include].any? { File.absolute_path?(_1) }
 
         begin
-          regex_pattern = Regexp.new(options[:regex])
+          regex_pattern = Regexp.new(options[:regex]).freeze
         rescue RegexpError => e
           error_exit("Invalid regex pattern - #{e.message}")
         end
@@ -37,7 +40,8 @@ module Grepfruit
           search_hidden: options[:search_hidden],
           jobs: options[:jobs]&.to_i,
           json: options[:json],
-          count: options[:count]
+          count: options[:count],
+          relative_paths: options[:relative_paths]
         ).execute
       end
 

data/lib/grepfruit/cli_search.rb

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

data/lib/grepfruit/search.rb

@@ -2,23 +2,26 @@ require "find"
 require "etc"
 require_relative "ractor_compat"
 
-Warning[:experimental] = false
-
 module Grepfruit
   class Search
-    attr_reader :path, :regex, :exclusions, :inclusions, :excluded_paths, :excluded_lines, :truncate, :search_hidden, :jobs, :json, :count
+    attr_reader :path, :regex, :exclusions, :inclusions, :excluded_paths, :excluded_lines, :truncate, :search_hidden, :jobs, :json, :count, :relative_paths
 
-    def initialize(path:, regex:, exclude:, include:, truncate:, search_hidden:, jobs:, json: false, count: false)
+    def initialize(path:, regex:, exclude:, include:, truncate:, search_hidden:, jobs:, json: false, count: false, relative_paths: false)
       @path = File.expand_path(path)
       @regex = regex
       @exclusions = exclude
       @inclusions = include
-      @excluded_lines, @excluded_paths = exclude.partition { _1.split("/").last.include?(":") }
+      line_exclusions, @excluded_paths = exclude.partition { _1.split("/").last.include?(":") }
+      @excluded_lines = line_exclusions.map do |exclusion|
+        pattern, _, line = exclusion.rpartition(":")
+        [pattern, line.to_i]
+      end
       @truncate = truncate
       @search_hidden = search_hidden
       @jobs = jobs || Etc.nprocessors
       @json = json
       @count = count
+      @relative_paths = relative_paths
     end
 
     private
@@ -95,17 +98,21 @@ module Grepfruit
           work = Ractor.receive
           break if work == :quit
 
-          file_path, pattern, exc_lines, count = work
+          file_path, match_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)
+          begin
+            File.foreach(file_path).with_index do |line, line_num|
+              next unless line.valid_encoding? && line.match?(pattern)
 
-            next if exc_lines.any? { "#{file_path}:#{line_num + 1}".end_with?(_1) }
+              next if exc_lines.include?(line_num + 1)
 
-            file_results << [file_path, line_num + 1, line] unless count
-            has_matches = true
-            match_count += 1
+              file_results << [match_path, line_num + 1, line] unless count
+              has_matches = true
+              match_count += 1
+            end
+          rescue Errno::ENOENT, Errno::EACCES, Errno::EISDIR
+            file_results, has_matches, match_count = [], false, 0
           end
 
           RactorCompat.yield_result(port, [file_results, has_matches, match_count])
@@ -114,10 +121,10 @@ module Grepfruit
     end
 
     def assign_file_to_worker(worker, port, file_enumerator, active_workers, results)
-      file_path = get_next_file(file_enumerator)
+      file_path, match_path, file_excluded_lines = get_next_file(file_enumerator)
       return unless file_path
 
-      RactorCompat.send_work(worker, [file_path, regex, excluded_lines, count])
+      RactorCompat.send_work(worker, [file_path, match_path, regex, file_excluded_lines, count])
       active_workers[worker] = port
       results.total_files += 1
     end
@@ -133,29 +140,37 @@ module Grepfruit
     end
 
     def create_file_enumerator
+      relative_base = File.join(File.directory?(path) ? path : File.dirname(path), "")
+
       Enumerator.new do |yielder|
         Find.find(path) do |file_path|
           is_file = File.file?(file_path)
+          rel_path = file_path.delete_prefix(relative_base)
+          name = File.basename(file_path)
 
-          Find.prune if excluded_path?(is_file, file_path, file_path.delete_prefix("#{path}/"))
+          Find.prune if file_path != path && excluded_path?(is_file, rel_path, name)
 
           next unless is_file && File.readable?(file_path)
 
-          yielder << file_path
+          file_excluded_lines = excluded_lines.filter_map { |pattern, line| line if matches_pattern?(pattern, rel_path, name) }
+
+          yielder << [file_path, relative_paths ? rel_path : file_path, file_excluded_lines]
         end
       end
     end
 
-    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?("."))
+    def excluded_path?(is_file, rel_path, name)
+      (is_file && inclusions.any? && !matches_any?(inclusions, rel_path, name)) ||
+        matches_any?(excluded_paths, rel_path, name) ||
+        (!search_hidden && name.start_with?("."))
     end
 
-    def matches_pattern?(pattern_list, path)
-      pattern_list.any? do |pattern|
-        File.fnmatch?(pattern, path, File::FNM_PATHNAME) || File.fnmatch?(pattern, File.basename(path))
-      end
+    def matches_any?(patterns, rel_path, name)
+      patterns.any? { matches_pattern?(_1, rel_path, name) }
+    end
+
+    def matches_pattern?(pattern, rel_path, name)
+      File.fnmatch?(pattern, rel_path, File::FNM_PATHNAME | File::FNM_DOTMATCH) || File.fnmatch?(pattern, name, File::FNM_DOTMATCH)
     end
 
     def processed_line(line)

data/lib/grepfruit/version.rb

@@ -1,3 +1,3 @@
 module Grepfruit
-  VERSION = "4.0.1".freeze
+  VERSION = "4.1.0".freeze
 end

data/lib/grepfruit.rb

@@ -6,14 +6,17 @@ require_relative "grepfruit/cli"
 require_relative "grepfruit/cli_search"
 
 module Grepfruit
-  def self.search(regex:, path: ".", exclude: [], include: [], truncate: nil, search_hidden: false, jobs: nil, count: false)
+  def self.search(regex:, path: ".", exclude: [], include: [], truncate: nil, search_hidden: false, jobs: nil, count: false, relative_paths: false)
     raise ArgumentError, "regex is required" unless regex.is_a?(Regexp)
     raise ArgumentError, "path must be a string" unless path.is_a?(String)
     raise ArgumentError, "exclude must be an array" unless exclude.is_a?(Array)
     raise ArgumentError, "include must be an array" unless include.is_a?(Array)
+    raise ArgumentError, "exclude must contain only relative paths" if exclude.any? { File.absolute_path?(_1) }
+    raise ArgumentError, "include must contain only relative paths" if include.any? { File.absolute_path?(_1) }
     raise ArgumentError, "truncate must be a positive integer" if truncate && (!truncate.is_a?(Integer) || truncate <= 0)
     raise ArgumentError, "search_hidden must be a boolean" unless [true, false].include?(search_hidden)
     raise ArgumentError, "count must be a boolean" unless [true, false].include?(count)
+    raise ArgumentError, "relative_paths must be a boolean" unless [true, false].include?(relative_paths)
     raise ArgumentError, "jobs must be at least 1" if jobs && (!jobs.is_a?(Integer) || jobs < 1)
 
     ProgrammaticSearch.new(
@@ -25,7 +28,8 @@ module Grepfruit
       search_hidden: search_hidden,
       jobs: jobs,
       json: false,
-      count: count
+      count: count,
+      relative_paths: relative_paths
     ).execute
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: grepfruit
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - enjaku4
 bindir: exe
 cert_chain: []
-date: 2026-07-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -74,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.8
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Tool for searching regex patterns in files
 test_files: []