grepfruit 3.0.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21bbe94a4fe8b462011334fbba7773cf570da96f5497d7b9ad7e125351b92b13
-  data.tar.gz: 2ad07b148d00350ed821d973c29675d9b91f3a99dc9a2f3e64f3acbce7018932
+  metadata.gz: 51c0381a8449c749e2017cf4feac9cf35fb2c58e38f19a6a00fe994997d38b17
+  data.tar.gz: 61bca9861ce7d63331285d7b089e8521eac58f19465c293a50b07c5e4eb3cf01
 SHA512:
-  metadata.gz: d8b5a7b272696fc8dd60993fcb10fc3bdf9bf527d51ba0ef36a7a86adb1bb152f834c1a0b9cefadae6d630acd87ce635028b07ae12cdb162caf68bc15a10b1eb
-  data.tar.gz: 0f497ea749fc6cb5740c1e8c16b7672970c75333e46cd1e95418aa0d701d8a3db7b08ffb1775b51c32b66297ce202458768276a8b3065e2b3e25fd4d97fe313d
+  metadata.gz: e16bd1bc1c78d56b9253e2be32788f7dc5a03584de099e6ff6e7b78f581ea7ba9af018dc6c7b17dda06a7f55ab61488181237320b16fc3cd5768422a16d0cf8f
+  data.tar.gz: 948e8fadc208c058cfa943eeabb79a8b17d499fb78277e757b0655357dd028d8f312d008c52098c14bdcc2d1e94279fcefc1a821467e54020a26b209a72000d1

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## v3.1.1
+
+- Fixed JSON timestamp to reflect result generation time
+- Minor optimization
+
+## v3.1.0
+
+- Added --include option to specify files to include in the search
+- Both --exclude and --include options can now accept wildcard patterns
+
 ## v3.0.0
 
 - Dropped support for Ruby 3.1

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/grepfruit.svg)](http://badge.fury.io/rb/grepfruit)
 [![Github Actions badge](https://github.com/brownboxdev/grepfruit/actions/workflows/ci.yml/badge.svg)](https://github.com/brownboxdev/grepfruit/actions/workflows/ci.yml)
 
-Grepfruit is a Ruby gem for searching files within a directory for specified regular expression patterns, with exclusion options and JSON-formatted or colorized output for enhanced readability. Originally designed for CI/CD pipelines to search for `TODO` comments in Ruby on Rails applications, Grepfruit provides more user-friendly output than the standard `grep` command while maintaining the flexibility for diverse search scenarios.
+Grepfruit is a Ruby gem for searching files within a directory for specified regular expression patterns, with exclusion and inclusion options and JSON-formatted or colorized output for enhanced readability. Originally designed for CI/CD pipelines to search for `TODO` comments in Ruby on Rails applications, Grepfruit provides more user-friendly output than the standard `grep` command while maintaining the flexibility for diverse search scenarios.
 
 **Key Features:**
 
@@ -22,7 +22,7 @@ Grepfruit is a Ruby gem for searching files within a directory for specified reg
   - [Exit Status](#exit-status)
 
 **Community Resources:**
-  - [Contributing](#contributing)
+  - [Getting Help and Contributing](#getting-help-and-contributing)
   - [License](#license)
   - [Code of Conduct](#code-of-conduct)
 
@@ -56,6 +56,7 @@ If no PATH is specified, Grepfruit searches the current directory.
 |--------|-------------|
 | `-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) |
 | `-t, --truncate N` | Truncate search result output to N characters |
 | `-j, --jobs N` | Number of parallel workers (default: number of CPU cores) |
 | `--search-hidden` | Include hidden files and directories in search |
@@ -84,7 +85,7 @@ grepfruit search -r 'TODO' -e 'log,tmp,vendor,node_modules,assets'
 Search for both `FIXME` and `TODO` comments in a specific directory:
 
 ```bash
-grepfruit search -r 'FIXME|TODO' -e 'bin,tmp/log,Gemfile.lock' dev/my_app
+grepfruit search -r 'FIXME|TODO' -e 'bin,*.md,tmp/log,Gemfile.lock' dev/my_app
 ```
 
 ### Line-Specific Exclusion
@@ -95,6 +96,15 @@ Exclude specific lines from search results:
 grepfruit search -r 'FIXME|TODO' -e 'README.md:18'
 ```
 
+### Including Specific File Types
+
+Search only in specific file types using patterns:
+
+```bash
+grepfruit search -r 'TODO' -i '*.rb,*.js'
+grepfruit search -r 'FIXME' -i '*.py'
+```
+
 ### Output Truncation
 
 Limit output length for cleaner results:
@@ -111,22 +121,23 @@ Search hidden files and directories:
 grepfruit search -r 'FIXME|TODO' --search-hidden
 ```
 
-### JSON Output for Automation
+### JSON Output
 
-Get structured JSON output for scripts and CI/CD pipelines:
+Get structured JSON output:
 
 ```bash
-grepfruit search -r 'TODO' --json
+grepfruit search -r 'TODO' -e 'node_modules' -i '*.rb,*.js' --json /path/to/search
 ```
 
-This outputs a structured JSON response containing search metadata, summary statistics, and detailed match information:
+This outputs a JSON response containing search metadata, summary statistics, and detailed match information:
 
-```json
+```jsonc
 {
   "search": {
     "pattern": "/TODO/",
     "directory": "/path/to/search",
     "exclusions": ["node_modules"],
+    "inclusions": ["*.rb", "*.js"],
     "timestamp": "2025-01-16T10:30:00+00:00"
   },
   "summary": {
@@ -161,7 +172,7 @@ 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)
 
-## Contributing
+## Getting Help and Contributing
 
 ### Getting Help
 Have a question or need assistance? Open a discussion in our [discussions section](https://github.com/brownboxdev/grepfruit/discussions) for:

data/lib/grepfruit/cli.rb

@@ -11,6 +11,7 @@ module Grepfruit
 
       option :regex, aliases: ["-r"], required: true, desc: "Regex pattern to search for"
       option :exclude, aliases: ["-e"], type: :array, default: [], desc: "Comma-separated list of files and directories to exclude"
+      option :include, aliases: ["-i"], type: :array, default: [], desc: "Comma-separated list of file patterns to include (only these files will be searched)"
       option :truncate, aliases: ["-t"], type: :integer, desc: "Truncate output to N characters"
       option :search_hidden, type: :boolean, default: false, desc: "Search hidden files and directories"
       option :jobs, aliases: ["-j"], type: :integer, desc: "Number of parallel workers (default: all CPU cores, use 1 for sequential)"
@@ -23,10 +24,11 @@ module Grepfruit
           dir: path,
           regex: create_regex(options[:regex]),
           exclude: options[:exclude] || [],
+          include: options[:include] || [],
           truncate: options[:truncate]&.to_i,
-          search_hidden: !!options[:search_hidden],
+          search_hidden: options[:search_hidden],
           jobs: options[:jobs]&.to_i,
-          json_output: !!options[:json]
+          json_output: options[:json]
         ).run
       end
 
@@ -34,9 +36,7 @@ module Grepfruit
 
       def validate_options!(options)
         error_exit("You must specify a regex pattern using the -r or --regex option.") unless options[:regex]
-
-        jobs = options[:jobs]&.to_i
-        error_exit("Number of jobs must be at least 1") if jobs && jobs < 1
+        error_exit("Number of jobs must be at least 1") if (jobs = options[:jobs]&.to_i) && jobs < 1
       end
 
       def create_regex(pattern)

data/lib/grepfruit/decorator.rb

@@ -4,9 +4,10 @@ module Grepfruit
 
     private
 
-    def green(text) = "#{COLORS[:green]}#{text}#{COLORS[:reset]}"
-    def red(text) = "#{COLORS[:red]}#{text}#{COLORS[:reset]}"
-    def cyan(text) = "#{COLORS[:cyan]}#{text}#{COLORS[:reset]}"
+    def colorize(text, color) = "#{COLORS[color]}#{text}#{COLORS[:reset]}"
+    def green(text) = colorize(text, :green)
+    def red(text) = colorize(text, :red)
+    def cyan(text) = colorize(text, :cyan)
 
     def number_of_files(num) = "#{num} file#{'s' if num != 1}"
     def number_of_matches(num) = "#{num} match#{'es' if num != 1}"
@@ -16,8 +17,8 @@ module Grepfruit
     end
 
     def processed_line(line)
-      stripped_line = line.strip
-      truncate && stripped_line.length > truncate ? "#{stripped_line[0...truncate]}..." : stripped_line
+      stripped = line.strip
+      truncate && stripped.length > truncate ? "#{stripped[0...truncate]}..." : stripped
     end
 
     def display_results(lines, files, files_with_matches)
@@ -40,7 +41,8 @@ module Grepfruit
         pattern: regex.inspect,
         directory: dir,
         exclusions: (excluded_paths + excluded_lines).map { |path_parts| path_parts.join("/") },
-        timestamp: @start_time.strftime("%Y-%m-%dT%H:%M:%S%z")
+        inclusions: included_paths.map { |path_parts| path_parts.join("/") },
+        timestamp: Time.now.strftime("%Y-%m-%dT%H:%M:%S%z")
       }
 
       summary = {

data/lib/grepfruit/search.rb

@@ -1,99 +1,107 @@
 require "find"
 require "etc"
 
-require_relative "decorator"
-
 Warning[:experimental] = false
 
 module Grepfruit
   class Search
     include Decorator
 
-    attr_reader :dir, :regex, :excluded_paths, :excluded_lines, :truncate, :search_hidden, :jobs, :json_output
+    attr_reader :dir, :regex, :excluded_paths, :excluded_lines, :included_paths, :truncate, :search_hidden, :jobs, :json_output
 
-    def initialize(dir:, regex:, exclude:, truncate:, search_hidden:, jobs:, json_output: false)
+    def initialize(dir:, regex:, exclude:, include:, truncate:, search_hidden:, jobs:, json_output: false)
       @dir = File.expand_path(dir)
       @regex = regex
       @excluded_lines, @excluded_paths = exclude.map { _1.split("/") }.partition { _1.last.include?(":") }
+      @included_paths = include.map { _1.split("/") }
       @truncate = truncate
       @search_hidden = search_hidden
       @jobs = jobs || Etc.nprocessors
       @json_output = json_output
-      @start_time = Time.now
     end
 
     def run
       puts "Searching for #{regex.inspect} in #{dir.inspect}...\n\n" unless json_output
 
-      all_lines, total_files_with_matches, total_files = [], 0, 0
-      raw_matches = []
-      workers = create_workers
+      display_final_results(execute_search)
+    end
+
+    private
+
+    def execute_search
+      results = SearchResults.new
+      workers = Array.new(jobs) { create_persistent_worker }
       file_enumerator = create_file_enumerator
       active_workers = {}
 
       workers.each do |worker|
-        file_path = get_next_file(file_enumerator)
-        next unless file_path
-
-        worker.send([file_path, regex, excluded_lines, dir])
-        active_workers[worker] = file_path
-        total_files += 1
+        assign_file_to_worker(worker, file_enumerator, active_workers, results)
       end
 
       while active_workers.any?
-        ready_worker, (file_results, has_matches) = Ractor.select(*active_workers.keys)
+        ready_worker, worker_result = Ractor.select(*active_workers.keys)
         active_workers.delete(ready_worker)
 
-        total_files_with_matches += 1 if process_worker_result(file_results, has_matches, all_lines, raw_matches)
-
-        next_file = get_next_file(file_enumerator)
-        next unless next_file
-
-        ready_worker.send([next_file, regex, excluded_lines, dir])
-        active_workers[ready_worker] = next_file
-        total_files += 1
+        results.increment_files_with_matches if process_worker_result(worker_result, results)
+        assign_file_to_worker(ready_worker, file_enumerator, active_workers, results)
       end
 
-      workers.each(&:close_outgoing)
+      shutdown_workers(workers)
+      results
+    end
 
+    def display_final_results(results)
       if json_output
-        display_json_results(raw_matches, total_files, total_files_with_matches)
+        display_json_results(results.raw_matches, results.total_files, results.total_files_with_matches)
       else
-        display_results(all_lines, total_files, total_files_with_matches)
+        display_results(results.all_lines, results.total_files, results.total_files_with_matches)
       end
     end
 
-    private
-
-    def get_next_file(enumerator)
-      enumerator.next
-    rescue StopIteration
-      nil
-    end
-
-    def create_workers
-      Array.new(jobs) do
-        Ractor.new do
-          loop do
-            file_path, pattern, exc_lines, base_dir = Ractor.receive
-            results, has_matches = [], false
+    def create_persistent_worker
+      Ractor.new do
+        loop do
+          work = Ractor.receive
+          break if work == :quit
 
-            File.foreach(file_path).with_index do |line, line_num|
-              next unless line.valid_encoding? && line.match?(pattern)
+          file_path, pattern, exc_lines, base_dir = work
+          file_results, has_matches = [], false
 
-              relative_path = file_path.delete_prefix("#{base_dir}/")
-              next if exc_lines.any? { |exc| "#{relative_path}:#{line_num + 1}".end_with?(exc.join("/")) }
+          File.foreach(file_path).with_index do |line, line_num|
+            next unless line.valid_encoding? && line.match?(pattern)
 
-              results << [relative_path, line_num + 1, line]
-              has_matches = true
-            end
+            relative_path = file_path.delete_prefix("#{base_dir}/")
+            next if exc_lines.any? { "#{relative_path}:#{line_num + 1}".end_with?(_1.join("/")) }
 
-            Ractor.yield([results, has_matches])
+            file_results << [relative_path, line_num + 1, line]
+            has_matches = true
           end
+
+          Ractor.yield([file_results, has_matches])
         end
       end
     end
 
+    def assign_file_to_worker(worker, file_enumerator, active_workers, results)
+      file_path = get_next_file(file_enumerator)
+      return unless file_path
+
+      worker.send([file_path, regex, excluded_lines, dir])
+      active_workers[worker] = file_path
+      results.total_files += 1
+    end
+
+    def get_next_file(enumerator)
+      enumerator.next
+    rescue StopIteration
+      nil
+    end
+
+    def shutdown_workers(workers)
+      workers.each { |worker| worker.send(:quit) }
+      workers.each(&:close_outgoing)
+    end
+
     def create_file_enumerator
       Enumerator.new do |yielder|
         Find.find(dir) do |path|
@@ -109,34 +117,39 @@ module Grepfruit
       end
     end
 
-    def process_worker_result(file_results, has_matches, all_lines, raw_matches)
+    def process_worker_result(worker_result, results)
+      file_results, has_matches = worker_result
+
       if has_matches
-        raw_matches.concat(file_results) if json_output
+        results.add_raw_matches(file_results) if json_output
 
         unless json_output
           colored_lines = file_results.map do |relative_path, line_num, line_content|
             "#{cyan("#{relative_path}:#{line_num}")}: #{processed_line(line_content)}"
           end
-          all_lines.concat(colored_lines)
+          results.add_lines(colored_lines)
           print red("M")
         end
-        true
       else
         print green(".") unless json_output
-        false
       end
+
+      has_matches
     end
 
     def excluded_path?(path)
-      excluded?(excluded_paths, relative_path(path)) || (!search_hidden && File.basename(path).start_with?("."))
-    end
+      rel_path = path.delete_prefix("#{dir}/")
 
-    def excluded?(list, path)
-      list.any? { path.split("/").last(_1.length) == _1 }
+      (File.file?(path) && included_paths.any? && !matches_pattern?(included_paths, rel_path)) ||
+        matches_pattern?(excluded_paths, rel_path) ||
+        (!search_hidden && File.basename(path).start_with?("."))
     end
 
-    def relative_path(path)
-      path.delete_prefix("#{dir}/")
+    def matches_pattern?(pattern_list, path)
+      pattern_list.any? do |pattern_parts|
+        pattern = pattern_parts.join("/")
+        File.fnmatch?(pattern, path, File::FNM_PATHNAME) || File.fnmatch?(pattern, File.basename(path))
+      end
     end
   end
 end

data/lib/grepfruit/search_results.rb

@@ -0,0 +1,25 @@
+module Grepfruit
+  class SearchResults
+    attr_reader :all_lines, :raw_matches, :total_files_with_matches
+    attr_accessor :total_files
+
+    def initialize
+      @all_lines = []
+      @raw_matches = []
+      @total_files = 0
+      @total_files_with_matches = 0
+    end
+
+    def increment_files_with_matches
+      @total_files_with_matches += 1
+    end
+
+    def add_lines(lines)
+      @all_lines.concat(lines)
+    end
+
+    def add_raw_matches(matches)
+      @raw_matches.concat(matches)
+    end
+  end
+end

data/lib/grepfruit/version.rb

@@ -1,3 +1,3 @@
 module Grepfruit
-  VERSION = "3.0.0".freeze
+  VERSION = "3.1.1".freeze
 end

data/lib/grepfruit.rb

@@ -1,4 +1,6 @@
 require_relative "grepfruit/version"
+require_relative "grepfruit/decorator"
+require_relative "grepfruit/search_results"
 require_relative "grepfruit/search"
 require_relative "grepfruit/cli"
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: grepfruit
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.1
 platform: ruby
 authors:
 - enjaku4
 bindir: exe
 cert_chain: []
-date: 2025-06-16 00:00:00.000000000 Z
+date: 2025-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -37,6 +37,7 @@ files:
 - lib/grepfruit/cli.rb
 - lib/grepfruit/decorator.rb
 - lib/grepfruit/search.rb
+- lib/grepfruit/search_results.rb
 - lib/grepfruit/version.rb
 homepage: https://github.com/brownboxdev/grepfruit
 licenses: