grepfruit 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21bbe94a4fe8b462011334fbba7773cf570da96f5497d7b9ad7e125351b92b13
-  data.tar.gz: 2ad07b148d00350ed821d973c29675d9b91f3a99dc9a2f3e64f3acbce7018932
+  metadata.gz: 50c38c621aa4a7c34b262cd61c45ced836cca10158b33566d709fd76bdb18f9f
+  data.tar.gz: f0a93887ab397d50a0a22e0600bb06925013632beab1040adf768c831bb6e5ac
 SHA512:
-  metadata.gz: d8b5a7b272696fc8dd60993fcb10fc3bdf9bf527d51ba0ef36a7a86adb1bb152f834c1a0b9cefadae6d630acd87ce635028b07ae12cdb162caf68bc15a10b1eb
-  data.tar.gz: 0f497ea749fc6cb5740c1e8c16b7672970c75333e46cd1e95418aa0d701d8a3db7b08ffb1775b51c32b66297ce202458768276a8b3065e2b3e25fd4d97fe313d
+  metadata.gz: 50838340c7e1b6168675ee64bf0f0608beaa708237d12b40efc0fb8099afbde20ae5f18860747984e37e60cf090d4ff4b5e96667cd728dd51299bc5b44ebcdf2
+  data.tar.gz: 66e4d2c8cda063641243eaad779c43bd5fba37ecaad1bda19c81de996986688ff2eb825d86260da1f6a2bda0b522de73c5e5af304b3fe166f2d0438d15fa270f

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v3.1.0
+
+- Added --include option to specify files to include in the search
+- Both --exclude and --include options can now accept multiple 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,6 +24,7 @@ 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],
           jobs: options[:jobs]&.to_i,

data/lib/grepfruit/decorator.rb

@@ -40,6 +40,7 @@ module Grepfruit
         pattern: regex.inspect,
         directory: dir,
         exclusions: (excluded_paths + excluded_lines).map { |path_parts| path_parts.join("/") },
+        inclusions: included_paths.map { |path_parts| path_parts.join("/") },
         timestamp: @start_time.strftime("%Y-%m-%dT%H:%M:%S%z")
       }
 

data/lib/grepfruit/search.rb

@@ -9,12 +9,13 @@ 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
@@ -32,12 +33,7 @@ module Grepfruit
       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) && total_files += 1
       end
 
       while active_workers.any?
@@ -46,12 +42,7 @@ module Grepfruit
 
         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
+        assign_file_to_worker(ready_worker, file_enumerator, active_workers) && total_files += 1
       end
 
       workers.each(&:close_outgoing)
@@ -65,6 +56,15 @@ module Grepfruit
 
     private
 
+    def assign_file_to_worker(worker, file_enumerator, active_workers)
+      file_path = get_next_file(file_enumerator)
+      return false unless file_path
+
+      worker.send([file_path, regex, excluded_lines, dir])
+      active_workers[worker] = file_path
+      true
+    end
+
     def get_next_file(enumerator)
       enumerator.next
     rescue StopIteration
@@ -82,7 +82,7 @@ module Grepfruit
               next unless line.valid_encoding? && line.match?(pattern)
 
               relative_path = file_path.delete_prefix("#{base_dir}/")
-              next if exc_lines.any? { |exc| "#{relative_path}:#{line_num + 1}".end_with?(exc.join("/")) }
+              next if exc_lines.any? { "#{relative_path}:#{line_num + 1}".end_with?(_1.join("/")) }
 
               results << [relative_path, line_num + 1, line]
               has_matches = true
@@ -128,11 +128,24 @@ module Grepfruit
     end
 
     def excluded_path?(path)
-      excluded?(excluded_paths, relative_path(path)) || (!search_hidden && File.basename(path).start_with?("."))
+      rel_path = relative_path(path)
+
+      not_included_path?(path, rel_path) || matches_pattern?(excluded_paths, rel_path) || excluded_hidden?(path)
     end
 
-    def excluded?(list, path)
-      list.any? { path.split("/").last(_1.length) == _1 }
+    def not_included_path?(path, rel_path)
+      File.file?(path) && included_paths.any? && !matches_pattern?(included_paths, rel_path)
+    end
+
+    def excluded_hidden?(path)
+      !search_hidden && File.basename(path).start_with?(".")
+    end
+
+    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
 
     def relative_path(path)

data/lib/grepfruit/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: grepfruit
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - enjaku4
 bindir: exe
 cert_chain: []
-date: 2025-06-16 00:00:00.000000000 Z
+date: 2025-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli