grepfruit 2.0.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 510715dadc6ac5afba47b5a02b122eb6ae53e46dcb4454a3d83adf7374615b1e
-  data.tar.gz: 4797c7612d6f0ab3e0ec3c15a3c48941984f9eba4837a919ba98f10551d3c4fb
+  metadata.gz: 21bbe94a4fe8b462011334fbba7773cf570da96f5497d7b9ad7e125351b92b13
+  data.tar.gz: 2ad07b148d00350ed821d973c29675d9b91f3a99dc9a2f3e64f3acbce7018932
 SHA512:
-  metadata.gz: a62a669cb08f455f3105ee73b4f70d991216c7b34e68477adf6546d922e43e5994ff9a9cfca38671adf69b90cb89edf1960019b8d5dd2fb3bb8df5602f6ccc2c
-  data.tar.gz: b85bd902107f90713cd14be4ce8662250975c76dfd95e7757a12f36da4004261098545e7929abe103c9b8204b7c457c011d129ff5daff5cc5dafa5e4aa163b34
+  metadata.gz: d8b5a7b272696fc8dd60993fcb10fc3bdf9bf527d51ba0ef36a7a86adb1bb152f834c1a0b9cefadae6d630acd87ce635028b07ae12cdb162caf68bc15a10b1eb
+  data.tar.gz: 0f497ea749fc6cb5740c1e8c16b7672970c75333e46cd1e95418aa0d701d8a3db7b08ffb1775b51c32b66297ce202458768276a8b3065e2b3e25fd4d97fe313d

data/CHANGELOG.md

@@ -1,4 +1,13 @@
+## v3.0.0
+
+- Dropped support for Ruby 3.1
+- Optimized search algorithm for better performance
+- Changed the interface: now use `grepfruit search` instead of just `grepfruit` to perform searches
+- Added JSON output format for search results
+- Added parallel processing and --jobs option to control worker count
+
 ## v2.0.4
+
 - Fixed path resolution bug where searching in relative directories such as `.`, `./`, or `..` did not work correctly
 
 ## v2.0.3

data/README.md

@@ -3,17 +3,14 @@
 [![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 intelligent exclusion options and 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 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:**
 
-- Regular expression search within files and directories
-- Intelligent file and directory exclusion capabilities
+- Parallel search using Ractors
+- JSON output format for programmatic integration
 - Colorized output for improved readability
-- Hidden file and directory search support
-- Configurable output truncation
-- CI/CD pipeline friendly with meaningful exit codes
-- Line-specific exclusion for precise control
+- CI/CD pipeline friendly exit codes
 
 ## Table of Contents
 
@@ -31,20 +28,8 @@ Grepfruit is a Ruby gem for searching files within a directory for specified reg
 
 ## Installation
 
-Add Grepfruit to your Gemfile:
-
-```rb
-gem "grepfruit"
-```
-
 Install the gem:
 
-```bash
-bundle install
-```
-
-Or install it directly:
-
 ```bash
 gem install grepfruit
 ```
@@ -54,7 +39,13 @@ gem install grepfruit
 Search for regex patterns within files in a specified directory:
 
 ```bash
-grepfruit [options] PATH
+grepfruit search [options] [PATH]
+```
+
+Or using shorthand `s` command:
+
+```bash
+grepfruit s [options] [PATH]
 ```
 
 If no PATH is specified, Grepfruit searches the current directory.
@@ -66,7 +57,9 @@ 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 |
 | `-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 |
+| `--json` | Output results in JSON format |
 
 ## Usage Examples
 
@@ -75,7 +68,7 @@ If no PATH is specified, Grepfruit searches the current directory.
 Search for `TODO` comments in the current directory:
 
 ```bash
-grepfruit -r 'TODO'
+grepfruit search -r 'TODO'
 ```
 
 ### Excluding Directories
@@ -83,7 +76,7 @@ grepfruit -r 'TODO'
 Search for `TODO` patterns while excluding common build and dependency directories:
 
 ```bash
-grepfruit -r 'TODO' -e 'log,tmp,vendor,node_modules,assets'
+grepfruit search -r 'TODO' -e 'log,tmp,vendor,node_modules,assets'
 ```
 
 ### Multiple Pattern Search Excluding Both Directories and Files
@@ -91,7 +84,7 @@ grepfruit -r 'TODO' -e 'log,tmp,vendor,node_modules,assets'
 Search for both `FIXME` and `TODO` comments in a specific directory:
 
 ```bash
-grepfruit -r 'FIXME|TODO' -e 'bin,tmp/log,Gemfile.lock' dev/grepfruit
+grepfruit search -r 'FIXME|TODO' -e 'bin,tmp/log,Gemfile.lock' dev/my_app
 ```
 
 ### Line-Specific Exclusion
@@ -99,7 +92,7 @@ grepfruit -r 'FIXME|TODO' -e 'bin,tmp/log,Gemfile.lock' dev/grepfruit
 Exclude specific lines from search results:
 
 ```bash
-grepfruit -r 'FIXME|TODO' -e 'README.md:18'
+grepfruit search -r 'FIXME|TODO' -e 'README.md:18'
 ```
 
 ### Output Truncation
@@ -107,7 +100,7 @@ grepfruit -r 'FIXME|TODO' -e 'README.md:18'
 Limit output length for cleaner results:
 
 ```bash
-grepfruit -r 'FIXME|TODO' -t 50
+grepfruit search -r 'FIXME|TODO' -t 50
 ```
 
 ### Including Hidden Files
@@ -115,15 +108,58 @@ grepfruit -r 'FIXME|TODO' -t 50
 Search hidden files and directories:
 
 ```bash
-grepfruit -r 'FIXME|TODO' --search-hidden
+grepfruit search -r 'FIXME|TODO' --search-hidden
+```
+
+### JSON Output for Automation
+
+Get structured JSON output for scripts and CI/CD pipelines:
+
+```bash
+grepfruit search -r 'TODO' --json
+```
+
+This outputs a structured JSON response containing search metadata, summary statistics, and detailed match information:
+
+```json
+{
+  "search": {
+    "pattern": "/TODO/",
+    "directory": "/path/to/search",
+    "exclusions": ["node_modules"],
+    "timestamp": "2025-01-16T10:30:00+00:00"
+  },
+  "summary": {
+    "files_checked": 42,
+    "files_with_matches": 8,
+    "total_matches": 23
+  },
+  "matches": [
+    {
+      "file": "src/main.js",
+      "line": 15,
+      "content": "// TODO: Implement error handling"
+    },
+    // ...
+  ]
+}
+```
+
+### Parallel Processing
+
+Control the number of parallel workers:
+
+```bash
+grepfruit search -r 'TODO' -j 8  # Use 8 parallel workers
+grepfruit search -r 'TODO' -j 1  # Sequential processing
 ```
 
 ## Exit Status
 
 Grepfruit returns meaningful exit codes for CI/CD integration:
 
-- **Exit code 0**: No matches found
-- **Exit code 1**: Pattern matches were found
+- **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
 

data/exe/grepfruit

@@ -1,31 +1,9 @@
 #!/usr/bin/env ruby
 
+RubyVM::YJIT.enable if defined?(RubyVM::YJIT) && RubyVM::YJIT.respond_to?(:enable)
+
 $LOAD_PATH.unshift("#{__dir__}/../lib")
 
-require "optparse"
 require "grepfruit"
 
-options = {
-  dir: ".",
-  regex: nil,
-  exclude: [],
-  truncate: nil,
-  search_hidden: false
-}
-
-OptionParser.new do |opts|
-  opts.banner = "Usage: grepfruit [options] PATH"
-  opts.on("-r", "--regex REGEX", Regexp, "Regex pattern to search for") { options[:regex] = _1 }
-  opts.on("-e", "--exclude x,y,z", Array, "Comma-separated list of files and directories to exclude") { options[:exclude] = _1 }
-  opts.on("-t", "--truncate N", Integer, "Truncate output to N characters") { options[:truncate] = _1 }
-  opts.on("--search-hidden", TrueClass, "Search hidden files and directories") { options[:search_hidden] = _1 }
-end.parse!
-
-if options[:regex].nil?
-  puts "Error: You must specify a regex pattern using the -r or --regex option."
-  exit 1
-end
-
-options[:dir] = ARGV[0] if ARGV[0]
-
-Grepfruit::Search.new(**options).run
+Grepfruit::CLI.start(ARGV)

data/grepfruit.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.metadata["rubygems_mfa_required"] = "true"
   spec.summary = "A Ruby gem for searching text patterns in files with colorized output"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.1", "< 3.5"
+  spec.required_ruby_version = ">= 3.2", "< 3.5"
 
   spec.files = [
     "grepfruit.gemspec", "README.md", "CHANGELOG.md", "LICENSE.txt"
@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = ["grepfruit"]
   spec.require_paths = ["lib"]
+
+  spec.add_dependency "dry-cli", "~> 1.2"
 end

data/lib/grepfruit/cli.rb

@@ -0,0 +1,62 @@
+require "dry/cli"
+
+module Grepfruit
+  module Commands
+    extend Dry::CLI::Registry
+
+    class Search < Dry::CLI::Command
+      desc "Search for regex patterns in files"
+
+      argument :path, required: false, default: ".", desc: "Directory or file to search in"
+
+      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 :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)"
+      option :json, type: :boolean, default: false, desc: "Output results in JSON format"
+
+      def call(path: ".", **options)
+        validate_options!(options)
+
+        Grepfruit::Search.new(
+          dir: path,
+          regex: create_regex(options[:regex]),
+          exclude: options[:exclude] || [],
+          truncate: options[:truncate]&.to_i,
+          search_hidden: !!options[:search_hidden],
+          jobs: options[:jobs]&.to_i,
+          json_output: !!options[:json]
+        ).run
+      end
+
+      private
+
+      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
+      end
+
+      def create_regex(pattern)
+        Regexp.new(pattern)
+      rescue RegexpError => e
+        error_exit("Invalid regex pattern - #{e.message}")
+      end
+
+      def error_exit(message)
+        puts "Error: #{message}"
+        exit 1
+      end
+    end
+
+    register "search", Search, aliases: ["s"]
+  end
+
+  class CLI < Dry::CLI
+    def self.start(argv = ARGV)
+      Dry::CLI.new(Commands).call(arguments: argv)
+    end
+  end
+end

data/lib/grepfruit/decorator.rb

@@ -1,45 +1,23 @@
 module Grepfruit
   module Decorator
-    COLORS = { cyan: "\e[36m", red: "\e[31m", green: "\e[32m", reset: "\e[0m" }
-    private_constant :COLORS
+    COLORS = { cyan: "\e[36m", red: "\e[31m", green: "\e[32m", reset: "\e[0m" }.freeze
 
     private
 
-    def green(text)
-      "#{COLORS[:green]}#{text}#{COLORS[:reset]}"
-    end
-
-    def red(text)
-      "#{COLORS[:red]}#{text}#{COLORS[:reset]}"
-    end
+    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 cyan(text)
-      "#{COLORS[:cyan]}#{text}#{COLORS[:reset]}"
-    end
-
-    def number_of_files(num)
-      "#{num} file#{'s' if num > 1}"
-    end
-
-    def number_of_matches(num)
-      "#{num} match#{'es' if num > 1}"
-    end
+    def number_of_files(num) = "#{num} file#{'s' if num != 1}"
+    def number_of_matches(num) = "#{num} match#{'es' if num != 1}"
 
     def relative_path(path)
-      Pathname.new(path).relative_path_from(Pathname.new(dir)).to_s
-    end
-
-    def relative_path_with_line_num(path, line_num)
-      "#{relative_path(path)}:#{line_num + 1}"
+      path.delete_prefix("#{dir}/")
     end
 
     def processed_line(line)
       stripped_line = line.strip
-      truncate && stripped_line.length > truncate ? "#{stripped_line[0..truncate - 1]}..." : stripped_line
-    end
-
-    def decorated_line(path, line_num, line)
-      "#{cyan(relative_path_with_line_num(path, line_num))}: #{processed_line(line)}"
+      truncate && stripped_line.length > truncate ? "#{stripped_line[0...truncate]}..." : stripped_line
     end
 
     def display_results(lines, files, files_with_matches)
@@ -54,5 +32,40 @@ module Grepfruit
         exit(1)
       end
     end
+
+    def display_json_results(raw_matches, total_files, files_with_matches)
+      require "json"
+
+      search_info = {
+        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")
+      }
+
+      summary = {
+        files_checked: total_files,
+        files_with_matches: files_with_matches,
+        total_matches: raw_matches.size
+      }
+
+      matches = raw_matches.map do |relative_path, line_num, line_content|
+        {
+          file: relative_path,
+          line: line_num,
+          content: line_content.strip
+        }
+      end
+
+      result = {
+        search: search_info,
+        summary: summary,
+        matches: matches
+      }
+
+      puts JSON.pretty_generate(result)
+
+      exit(raw_matches.empty? ? 0 : 1)
+    end
   end
 end

data/lib/grepfruit/search.rb

@@ -1,79 +1,142 @@
-require "pathname"
 require "find"
-require "byebug"
+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
+    attr_reader :dir, :regex, :excluded_paths, :excluded_lines, :truncate, :search_hidden, :jobs, :json_output
 
-    def initialize(dir:, regex:, exclude:, truncate:, search_hidden:)
+    def initialize(dir:, regex:, exclude:, 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?(":") }
       @truncate = truncate
       @search_hidden = search_hidden
+      @jobs = jobs || Etc.nprocessors
+      @json_output = json_output
+      @start_time = Time.now
     end
 
     def run
-      lines, files, files_with_matches = [], 0, 0
+      puts "Searching for #{regex.inspect} in #{dir.inspect}...\n\n" unless json_output
 
-      puts "Searching for #{regex.inspect} in #{dir.inspect}...\n\n"
+      all_lines, total_files_with_matches, total_files = [], 0, 0
+      raw_matches = []
+      workers = create_workers
+      file_enumerator = create_file_enumerator
+      active_workers = {}
 
-      Find.find(dir) do |path|
-        Find.prune if excluded_path?(path)
+      workers.each do |worker|
+        file_path = get_next_file(file_enumerator)
+        next unless file_path
 
-        next if not_searchable?(path)
+        worker.send([file_path, regex, excluded_lines, dir])
+        active_workers[worker] = file_path
+        total_files += 1
+      end
 
-        files += 1
-        match = process_file(path, lines)
+      while active_workers.any?
+        ready_worker, (file_results, has_matches) = Ractor.select(*active_workers.keys)
+        active_workers.delete(ready_worker)
 
-        if match
-          files_with_matches += 1
-          print red("M")
-        else
-          print green(".")
-        end
+        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
       end
 
-      display_results(lines, files, files_with_matches)
+      workers.each(&:close_outgoing)
+
+      if json_output
+        display_json_results(raw_matches, total_files, total_files_with_matches)
+      else
+        display_results(all_lines, total_files, total_files_with_matches)
+      end
     end
 
     private
 
-    def not_searchable?(path)
-      File.directory?(path) || File.symlink?(path)
+    def get_next_file(enumerator)
+      enumerator.next
+    rescue StopIteration
+      nil
     end
 
-    def process_file(path, lines)
-      lines_size = lines.size
+    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
+
+            File.foreach(file_path).with_index do |line, line_num|
+              next unless line.valid_encoding? && line.match?(pattern)
 
-      File.foreach(path).with_index do |line, line_num|
-        next if !line.valid_encoding? || !line.match?(regex) || excluded_line?(path, line_num)
+              relative_path = file_path.delete_prefix("#{base_dir}/")
+              next if exc_lines.any? { |exc| "#{relative_path}:#{line_num + 1}".end_with?(exc.join("/")) }
 
-        lines << decorated_line(path, line_num, line)
+              results << [relative_path, line_num + 1, line]
+              has_matches = true
+            end
+
+            Ractor.yield([results, has_matches])
+          end
+        end
       end
+    end
+
+    def create_file_enumerator
+      Enumerator.new do |yielder|
+        Find.find(dir) do |path|
+          Find.prune if excluded_path?(path)
+
+          next unless File.file?(path)
 
-      lines.size > lines_size
+          yielder << path
+        end
+      rescue Errno::ENOENT
+        puts "Error: Directory '#{dir}' does not exist."
+        exit 1
+      end
     end
 
-    def excluded_path?(path)
-      excluded?(excluded_paths, relative_path(path)) || !search_hidden && hidden?(path)
+    def process_worker_result(file_results, has_matches, all_lines, raw_matches)
+      if has_matches
+        raw_matches.concat(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)
+          print red("M")
+        end
+        true
+      else
+        print green(".") unless json_output
+        false
+      end
     end
 
-    def excluded_line?(path, line_num)
-      excluded?(excluded_lines, relative_path_with_line_num(path, line_num))
+    def excluded_path?(path)
+      excluded?(excluded_paths, relative_path(path)) || (!search_hidden && File.basename(path).start_with?("."))
     end
 
     def excluded?(list, path)
       list.any? { path.split("/").last(_1.length) == _1 }
     end
 
-    def hidden?(path)
-      File.basename(path).start_with?(".")
+    def relative_path(path)
+      path.delete_prefix("#{dir}/")
     end
   end
 end

data/lib/grepfruit/version.rb

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

data/lib/grepfruit.rb

@@ -1,5 +1,6 @@
 require_relative "grepfruit/version"
 require_relative "grepfruit/search"
+require_relative "grepfruit/cli"
 
 module Grepfruit
   class Error < StandardError; end

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: grepfruit
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 3.0.0
 platform: ruby
 authors:
 - enjaku4
 bindir: exe
 cert_chain: []
-date: 2025-05-30 00:00:00.000000000 Z
-dependencies: []
+date: 2025-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 executables:
 - grepfruit
 extensions: []
@@ -20,6 +34,7 @@ files:
 - exe/grepfruit
 - grepfruit.gemspec
 - lib/grepfruit.rb
+- lib/grepfruit/cli.rb
 - lib/grepfruit/decorator.rb
 - lib/grepfruit/search.rb
 - lib/grepfruit/version.rb
@@ -38,7 +53,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
   - - "<"
     - !ruby/object:Gem::Version
       version: '3.5'
@@ -48,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A Ruby gem for searching text patterns in files with colorized output
 test_files: []