grepfruit 2.0.2 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c4d580e130902313d154cc1584dcc1a610252638678dcbb05f6010226987bf9
-  data.tar.gz: e0814d3764457e9386b3c5850cb82719cfa6dd580016ce213ef4ddb3fd76d310
+  metadata.gz: 510715dadc6ac5afba47b5a02b122eb6ae53e46dcb4454a3d83adf7374615b1e
+  data.tar.gz: 4797c7612d6f0ab3e0ec3c15a3c48941984f9eba4837a919ba98f10551d3c4fb
 SHA512:
-  metadata.gz: b73b3561372a4f7fe6a86d7b38de4b618fd1a5b730883bbe6ad338035a8a44c1c6788fee5d3202cde8d78c9d8ee4bd9d3ec65251f92dfae3fa5d4a06a1634df0
-  data.tar.gz: 8772fcef03d57c21a9dea7e7135027c878e351f9d58b221d7c831435064035c7ce93cb0bac20be43051a6edcb2d5778dbf4040dc3709f3e1a9b53e3f2b826496
+  metadata.gz: a62a669cb08f455f3105ee73b4f70d991216c7b34e68477adf6546d922e43e5994ff9a9cfca38671adf69b90cb89edf1960019b8d5dd2fb3bb8df5602f6ccc2c
+  data.tar.gz: b85bd902107f90713cd14be4ce8662250975c76dfd95e7757a12f36da4004261098545e7929abe103c9b8204b7c457c011d129ff5daff5cc5dafa5e4aa163b34

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v2.0.4
+- Fixed path resolution bug where searching in relative directories such as `.`, `./`, or `..` did not work correctly
+
+## v2.0.3
+
+- Updated gemspec metadata to include the correct homepage URL
+
 ## v2.0.2
 
 - Replaced `git ls-files` with `Dir.glob` in gemspec for improved portability and compatibility

data/README.md

@@ -1,102 +1,156 @@
-# Grepfruit
+# Grepfruit: File Pattern Search Tool for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/grepfruit.svg)](http://badge.fury.io/rb/grepfruit)
-[![Github Actions badge](https://github.com/enjaku4/grepfruit/actions/workflows/main.yml/badge.svg)](https://github.com/enjaku4/grepfruit/actions/workflows/main.yml)
+[![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 a specified regular expression pattern, with options to exclude certain files or directories from the search and colorized output for better readability.
+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.
 
-<img width="431" alt="Screenshot 2024-12-26 at 18 01 39" src="https://github.com/user-attachments/assets/e3fdb4f7-c4d9-4c8d-9a5a-228f2be55d52" />
+**Key Features:**
 
-Grepfruit was originally created to be used in CI/CD pipelines to search for `TODO` comments in Ruby on Rails applications and provide more user-friendly output than the standard `grep` command, but it is flexible enough to be used for other similar purposes as well.
+- Regular expression search within files and directories
+- Intelligent file and directory exclusion capabilities
+- 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
+
+## 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)
+
+**Community Resources:**
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Code of Conduct](#code-of-conduct)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add Grepfruit to your Gemfile:
 
-```ruby
+```rb
 gem "grepfruit"
 ```
 
-And then execute:
+Install the gem:
 
-```shell
+```bash
 bundle install
 ```
 
-Or install it yourself as:
+Or install it directly:
 
-```shell
+```bash
 gem install grepfruit
 ```
 
-## Usage
+## Basic Usage
 
-You can use Grepfruit from the command line to search for a regex pattern within files in a specified directory.
+Search for regex patterns within files in a specified directory:
 
-```shell
+```bash
 grepfruit [options] PATH
 ```
 
-If no matches are found, Grepfruit returns exit status 0; otherwise, it returns exit status 1.
+If no PATH is specified, Grepfruit searches the current directory.
+
+## Command Line Options
 
-### Options
+| 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 |
+| `-t, --truncate N` | Truncate search result output to N characters |
+| `--search-hidden` | Include hidden files and directories in search |
 
-- `-r, --regex REGEX`: Regex pattern to search for (required).
-- `-e, --exclude x,y,z`: Comma-separated list of files, directories, or lines to exclude from the search.
-- `-t, --truncate N`: Truncate the output of the search results to N characters.
-- `--search-hidden`: Search hidden files and directories.
+## Usage Examples
+
+### Basic Pattern Search
+
+Search for `TODO` comments in the current directory:
+
+```bash
+grepfruit -r 'TODO'
+```
 
-### Examples
+### Excluding Directories
 
-Search for the pattern `/TODO/` in the current directory, excluding `log`, `tmp`, `vendor`, `node_modules`, and `assets` directories:
+Search for `TODO` patterns while excluding common build and dependency directories:
 
-```shell
+```bash
 grepfruit -r 'TODO' -e 'log,tmp,vendor,node_modules,assets'
 ```
 
-Search for the pattern `/FIXME|TODO/` in `dev/grepfruit` directory, excluding `bin`, `tmp/log`, and `Gemfile.lock` files and directories:
+### Multiple Pattern Search Excluding Both Directories and Files
 
-```shell
+Search for both `FIXME` and `TODO` comments in a specific directory:
+
+```bash
 grepfruit -r 'FIXME|TODO' -e 'bin,tmp/log,Gemfile.lock' dev/grepfruit
 ```
 
-Search for the pattern `/FIXME|TODO/` in the current directory, excluding line 18 of `README.md`:
+### Line-Specific Exclusion
+
+Exclude specific lines from search results:
 
-```shell
+```bash
 grepfruit -r 'FIXME|TODO' -e 'README.md:18'
 ```
 
-Search for the pattern `/FIXME|TODO/` in the current directory, truncating the output of the search results to 50 characters:
+### Output Truncation
 
-```shell
+Limit output length for cleaner results:
+
+```bash
 grepfruit -r 'FIXME|TODO' -t 50
 ```
 
-Search for the pattern `/FIXME|TODO/` in the current directory, including hidden files and directories:
+### Including Hidden Files
+
+Search hidden files and directories:
 
-```shell
+```bash
 grepfruit -r 'FIXME|TODO' --search-hidden
 ```
 
-## Problems?
+## Exit Status
 
-Facing a problem or want to suggest an enhancement?
+Grepfruit returns meaningful exit codes for CI/CD integration:
 
-- **Open a Discussion**: If you have a question, experience difficulties using the gem, or have a suggestion for improvements, feel free to use the Discussions section.
+- **Exit code 0**: No matches found
+- **Exit code 1**: Pattern matches were found
 
-Encountered a bug?
+## Contributing
 
-- **Create an Issue**: If you've identified a bug, please create an issue. Be sure to provide detailed information about the problem, including the steps to reproduce it.
-- **Contribute a Solution**: Found a fix for the issue? Feel free to create a pull request with your changes.
+### Getting Help
+Have a question or need assistance? Open a discussion in our [discussions section](https://github.com/brownboxdev/grepfruit/discussions) for:
+- Usage questions
+- Implementation guidance
+- Feature suggestions
 
-## Contributing
+### Reporting Issues
+Found a bug? Please [create an issue](https://github.com/brownboxdev/grepfruit/issues) with:
+- A clear description of the problem
+- Steps to reproduce the issue
+- Your environment details (Ruby version, OS, etc.)
+
+### Contributing Code
+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/brownboxdev/grepfruit/discussions))
 
-Before creating an issue or a pull request, please read the [contributing guidelines](https://github.com/enjaku4/grepfruit/blob/master/CONTRIBUTING.md).
+Before contributing, please read the [contributing guidelines](https://github.com/brownboxdev/grepfruit/blob/master/CONTRIBUTING.md)
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://github.com/enjaku4/grepfruit/blob/master/LICENSE.txt).
+The gem is available as open source under the terms of the [MIT License](https://github.com/brownboxdev/grepfruit/blob/master/LICENSE.txt).
 
 ## Code of Conduct
 
-Everyone interacting in the Grepfruit project is expected to follow the [code of conduct](https://github.com/enjaku4/grepfruit/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Grepfruit project is expected to follow the [code of conduct](https://github.com/brownboxdev/grepfruit/blob/master/CODE_OF_CONDUCT.md).

data/exe/grepfruit

@@ -6,7 +6,7 @@ require "optparse"
 require "grepfruit"
 
 options = {
-  dir: Dir.pwd,
+  dir: ".",
   regex: nil,
   exclude: [],
   truncate: nil,

data/grepfruit.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.name = "grepfruit"
   spec.version = Grepfruit::VERSION
   spec.authors = ["enjaku4"]
-  spec.homepage = "https://github.com/enjaku4/grepfruit"
+  spec.homepage = "https://github.com/brownboxdev/grepfruit"
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"

data/lib/grepfruit/decorator.rb

@@ -0,0 +1,58 @@
+module Grepfruit
+  module Decorator
+    COLORS = { cyan: "\e[36m", red: "\e[31m", green: "\e[32m", reset: "\e[0m" }
+    private_constant :COLORS
+
+    private
+
+    def green(text)
+      "#{COLORS[:green]}#{text}#{COLORS[:reset]}"
+    end
+
+    def red(text)
+      "#{COLORS[:red]}#{text}#{COLORS[:reset]}"
+    end
+
+    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 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}"
+    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)}"
+    end
+
+    def display_results(lines, files, files_with_matches)
+      puts "\n\n" if files.positive?
+
+      if lines.empty?
+        puts "#{number_of_files(files)} checked, #{green('no matches found')}"
+        exit(0)
+      else
+        puts "Matches:\n\n#{lines.join("\n")}\n\n"
+        puts "#{number_of_files(files)} checked, #{red("#{number_of_matches(lines.size)} found in #{number_of_files(files_with_matches)}")}"
+        exit(1)
+      end
+    end
+  end
+end

data/lib/{search.rb → grepfruit/search.rb}

@@ -1,12 +1,17 @@
 require "pathname"
 require "find"
+require "byebug"
+
+require_relative "decorator"
 
 module Grepfruit
   class Search
+    include Decorator
+
     attr_reader :dir, :regex, :excluded_paths, :excluded_lines, :truncate, :search_hidden
 
     def initialize(dir:, regex:, exclude:, truncate:, search_hidden:)
-      @dir = dir
+      @dir = File.expand_path(dir)
       @regex = regex
       @excluded_lines, @excluded_paths = exclude.map { _1.split("/") }.partition { _1.last.include?(":") }
       @truncate = truncate
@@ -28,18 +33,15 @@ module Grepfruit
 
         if match
           files_with_matches += 1
-          print "#{COLORS[:red]}M#{COLORS[:reset]}"
+          print red("M")
         else
-          print "#{COLORS[:green]}.#{COLORS[:reset]}"
+          print green(".")
         end
       end
 
       display_results(lines, files, files_with_matches)
     end
 
-    COLORS = { cyan: "\e[36m", red: "\e[31m", green: "\e[32m", reset: "\e[0m" }
-    private_constant :COLORS
-
     private
 
     def not_searchable?(path)
@@ -52,25 +54,12 @@ module Grepfruit
       File.foreach(path).with_index do |line, line_num|
         next if !line.valid_encoding? || !line.match?(regex) || excluded_line?(path, line_num)
 
-        lines << "#{COLORS[:cyan]}#{relative_path_with_line_num(path, line_num)}#{COLORS[:reset]}: #{processed_line(line)}"
+        lines << decorated_line(path, line_num, line)
       end
 
       lines.size > lines_size
     end
 
-    def display_results(lines, files, files_with_matches)
-      puts "\n\n" if files.positive?
-
-      if lines.empty?
-        puts "#{number_of_files(files)} checked, #{COLORS[:green]}no matches found#{COLORS[:reset]}"
-        exit(0)
-      else
-        puts "Matches:\n\n#{lines.join("\n")}\n\n"
-        puts "#{number_of_files(files)} checked, #{COLORS[:red]}#{number_of_matches(lines.size)} found in #{number_of_files(files_with_matches)}#{COLORS[:reset]}"
-        exit(1)
-      end
-    end
-
     def excluded_path?(path)
       excluded?(excluded_paths, relative_path(path)) || !search_hidden && hidden?(path)
     end
@@ -83,29 +72,8 @@ module Grepfruit
       list.any? { path.split("/").last(_1.length) == _1 }
     end
 
-    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}"
-    end
-
-    def processed_line(line)
-      stripped_line = line.strip
-      truncate && stripped_line.length > truncate ? "#{stripped_line[0..truncate - 1]}..." : stripped_line
-    end
-
     def hidden?(path)
       File.basename(path).start_with?(".")
     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
   end
 end

data/lib/grepfruit/version.rb

@@ -1,3 +1,3 @@
 module Grepfruit
-  VERSION = "2.0.2"
+  VERSION = "2.0.4"
 end

data/lib/grepfruit.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: grepfruit
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.4
 platform: ruby
 authors:
 - enjaku4
 bindir: exe
 cert_chain: []
-date: 2025-02-21 00:00:00.000000000 Z
+date: 2025-05-30 00:00:00.000000000 Z
 dependencies: []
 executables:
 - grepfruit
@@ -20,15 +20,16 @@ files:
 - exe/grepfruit
 - grepfruit.gemspec
 - lib/grepfruit.rb
+- lib/grepfruit/decorator.rb
+- lib/grepfruit/search.rb
 - lib/grepfruit/version.rb
-- lib/search.rb
-homepage: https://github.com/enjaku4/grepfruit
+homepage: https://github.com/brownboxdev/grepfruit
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/enjaku4/grepfruit
-  source_code_uri: https://github.com/enjaku4/grepfruit
-  changelog_uri: https://github.com/enjaku4/grepfruit/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/brownboxdev/grepfruit
+  source_code_uri: https://github.com/brownboxdev/grepfruit
+  changelog_uri: https://github.com/brownboxdev/grepfruit/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: