grepfruit 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64111f942b9dd8e2b1b6957b552e582fc9b7870225dd40e8042de30e06832dca
-  data.tar.gz: 40c9d6fe5cd104aa4deca5c0eadd0299851bcd286b086fd50da2ed02bbf385af
+  metadata.gz: 793a10b4b4676491d13d45fd598316ce327cfa660962ce37c7e3404a383f1a2e
+  data.tar.gz: 84f8ab7c8ff9350c95182dcc1127e7ec779b8f5a0f0f9567d845680275bda9c3
 SHA512:
-  metadata.gz: 0bf856a22a4ab91c636e7b9ab9ae03f947b5344c9fa3266617aa4c8812e7ffd0228a84a88fa0fad9bcd10479b7b40258c85a213a160eb6d740d615111f7fbc04
-  data.tar.gz: 6901c591fc559557064034ffce12a79c7d3f6ca8972bb00134429bed51dfab404fcc93b13b350d10acf1a281c54fe844cbbcf54a337ddb706e5dcf8af4883067
+  metadata.gz: d9a329e3105b5ab178180fb415ca72af96c62ab91a47d18669a3ac8514f25a5380e0d5840f457863b3f00b76766d7ddba3ca53951cfa8010e86525bca445ed41
+  data.tar.gz: d94287b1c4f5954920853f9303586803fb918877c7f18146528add86457b53940a4cfcda47ca63794b8caf002a7b6d02b0b3e19b6c39d5b03d5bad32b1d7e8a8

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## v1.0.0
+
+- Removed default values for `--exclude` and `--regex` options
+- Made `--regex` option required
+- Fixed an error that was raised when a symbolic link was encountered during the search
+
+## v0.2.0
+
+- Added `--search-hidden` option to search hidden files and directories
+
 ## v0.1.0
 
 - Initial release

data/README.md

@@ -1,9 +1,14 @@
 # Grepfruit
 
+[![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)
+
 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.
 
 <img width="416" alt="Screenshot 2024-07-28 at 03 52 37" src="https://github.com/user-attachments/assets/95b26b81-dcc1-430b-ac44-641251cb84b6">
 
+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.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,26 +28,35 @@ bundle install
 You can use Grepfruit from the command line to search for a regex pattern within files in a specified directory.
 
 ```shell
-grepfruit [options] PATH
+bundle exec grepfruit [options] PATH
 ```
 
 ### Options
 
-- `-r, --regex REGEX: Regex pattern to search for. Defaults to /TODO/.
-- `-e, --exclude x,y,z: Comma-separated list of files and directories to exclude from the search. Defaults to log, tmp, vendor, node_modules, assets.
+- `-r, --regex REGEX`: Regex pattern to search for (required). 
+- `-e, --exclude x,y,z`: Comma-separated list of files and directories to exclude from the search.
+- `--search-hidden`: Search hidden files and directories.
 
 ### Examples
 
-Search for the pattern `TODO` in the current directory, excluding the default directories:
+Search for the pattern `/TODO/` in the current directory, excluding `log`, `tmp`, `vendor`, `node_modules`, and `assets` directories:
+
+```shell
+bundle exec grepfruit -r 'TODO' -e 'log,tmp,vendor,node_modules,assets'
+# or
+bundle exec grepfruit --regex 'TODO' --exclude '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:
 
 ```shell
-grepfruit
+bundle exec grepfruit -r 'FIXME|TODO' -e 'bin,tmp/log,Gemfile.lock' dev/grepfruit
 ```
 
-Search for a custom pattern in another directory, while specifying files and directories to exclude:
+Search for the pattern `/FIXME|TODO/` in the current directory, including hidden files and directories:
 
 ```shell
-grepfruit -r 'FIXME|TODO' -e 'bin,log,Rakefile,Gemfile.lock' /path/to/directory
+bundle exec grepfruit -r 'FIXME|TODO' --search-hidden
 ```
 
 ## Problems?

data/exe/grepfruit

@@ -7,22 +7,32 @@ require "grepfruit"
 
 options = {
   path: Dir.pwd,
-  regex: /TODO/,
-  exclude: [["log"], ["tmp"], ["vendor"], ["node_modules"], ["assets"]]
+  regex: nil,
+  exclude: [],
+  search_hidden: false
 }
 
 OptionParser.new do |opts|
   opts.banner = "Usage: grepfruit [options] PATH"
 
-  opts.on("-r", "--regex REGEX", "Regex pattern to search for") do |regex|
-    options[:regex] = /#{regex}/
+  opts.on("-r", "--regex REGEX", Regexp, "Regex pattern to search for") do |regex|
+    options[:regex] = regex
   end
 
   opts.on("-e", "--exclude x,y,z", Array, "Comma-separated list of files and directories to exclude") do |exclude|
     options[:exclude] = exclude.map! { |path| path.split("/") }
   end
+
+  opts.on("--search-hidden", TrueClass, "Search hidden files and directories") do |search_hidden|
+    options[:search_hidden] = search_hidden
+  end
 end.parse!
 
+if options[:regex].nil?
+  puts "Error: You must specify a regex pattern using the -r or --regex option."
+  exit 1
+end
+
 options[:path] = ARGV[0] if ARGV[0]
 
 Grepfruit.run(**options)

data/lib/grepfruit/version.rb

@@ -1,3 +1,3 @@
 module Grepfruit
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/grepfruit.rb

@@ -3,7 +3,7 @@ require "pathname"
 require "find"
 
 module Grepfruit
-  def self.run(path:, regex:, exclude:)
+  def self.run(path:, regex:, exclude:, search_hidden:)
     lines = []
     files = 0
     dir = path
@@ -11,9 +11,9 @@ module Grepfruit
     puts "Searching for #{regex.inspect}...\n\n"
 
     Find.find(dir) do |pth|
-      Find.prune if exclude.any? { |e| pth.split("/").last(e.length) == e } || File.basename(pth).start_with?(".")
+      Find.prune if exclude.any? { |e| pth.split("/").last(e.length) == e } || !search_hidden && File.basename(pth).start_with?(".")
 
-      next if File.directory?(pth)
+      next if File.directory?(pth) || File.symlink?(pth)
 
       files += 1
 
@@ -34,7 +34,7 @@ module Grepfruit
     puts "\n\n"
 
     if lines.empty?
-      puts "#{files} files checked, \e[32mno matches found\e[0m"
+      puts "#{files} file#{'s' if files > 1} checked, \e[32mno matches found\e[0m"
       exit(0)
     else
       puts "Matches:\n\n"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grepfruit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - enjaku4
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-28 00:00:00.000000000 Z
+date: 2024-07-30 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -47,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A tool for searching text patterns in files with colorized output.