grepfruit 0.2.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '028c0f4cdd37b9257eb272c1dd961629c26da09a4353d7bafa42eb81314c14d1'
-  data.tar.gz: 282d0e315b69db474eed1b27b1a7cd9b5cb693057c4125b81f4883db27c262d9
+  metadata.gz: 4375b6c22cf2b2323abd76e66e35c098a4f681fe24fd63a40df0a4fa90640ea3
+  data.tar.gz: 743a2141c660fa7aa90687f56de16e5d3c9b5172abe4b9d52f7aa7ad322a773c
 SHA512:
-  metadata.gz: 6e821650c6ff4777eff717d26a0d481928bb91bfa93af7336e359023f2fc7ccfddb6ae4bdc724ecd81c0d1a3799420605f6c66e09c756fbbf87ea5b64ba30527
-  data.tar.gz: 8dacf807b6da4d56b1e7dfdc68dca009eb98f9b83b876e18415bab0803d52292cc19688081a2526cdeab1e041eddbb5025dc0b27d0093f340b4b72ea1754cf96
+  metadata.gz: d2a124c7e449b5a098c229f07e2c392ee89c06391f1c75ae5666bb485ac28d10dec33e0f556eda2bd5bbcaf659b052ea013ae4bb2617efcb2a6a2ed7c3a89fa6
+  data.tar.gz: 1e4640be220f8a72b1592e229de4d8bf70bf06e1d6d461f2fd85d663b5bd67bc7d27ea0e513867a32e6a129ab07ad13dbe4b905ef023633c89c7c61fda81cdd8

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## v1.1.0
+
+- Added `--truncate` option to truncate the output of the search results
+- Added the ability to exclude lines from the search results
+
+## 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

data/README.md

@@ -7,6 +7,8 @@ Grepfruit is a Ruby gem for searching files within a directory for a specified r
 
 <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:
@@ -31,25 +33,38 @@ 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.
-- `--search-hidden`: Search hidden files and directories. Defaults to false.
+- `-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.
 
 ### 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'
+```
+
+Search for the pattern `/FIXME|TODO/` in `dev/grepfruit` directory, excluding `bin`, `tmp/log`, and `Gemfile.lock` files and directories:
+
+```shell
+bundle exec 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`:
 
 ```shell
-bundle exec grepfruit
+bundle exec grepfruit -r 'FIXME|TODO' -e 'README.md:18'
 ```
 
-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, truncating the output of the search results to 50 characters:
 
 ```shell
-bundle exec grepfruit -r 'FIXME|TODO' -e 'log,Gemfile.lock,foo/bar.baz' /path/to/directory
+bundle exec grepfruit -r 'FIXME|TODO' -t 50
 ```
 
-Search for a pattern in the current directory, including hidden files and directories:
+Search for the pattern `/FIXME|TODO/` in the current directory, including hidden files and directories:
 
 ```shell
 bundle exec grepfruit -r 'FIXME|TODO' --search-hidden

data/exe/grepfruit

@@ -6,9 +6,10 @@ require "optparse"
 require "grepfruit"
 
 options = {
-  path: Dir.pwd,
-  regex: /TODO/,
-  exclude: [["log"], ["tmp"], ["vendor"], ["node_modules"], ["assets"]],
+  dir: Dir.pwd,
+  regex: nil,
+  exclude: [],
+  truncate: nil,
   search_hidden: false
 }
 
@@ -20,7 +21,11 @@ OptionParser.new do |opts|
   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("/") }
+    options[:exclude] = exclude.map { |path| path.split("/") }
+  end
+
+  opts.on("-t", "--truncate N", Integer, "Truncate output to N characters") do |truncate|
+    options[:truncate] = truncate
   end
 
   opts.on("--search-hidden", TrueClass, "Search hidden files and directories") do |search_hidden|
@@ -28,6 +33,11 @@ OptionParser.new do |opts|
   end
 end.parse!
 
-options[:path] = ARGV[0] if ARGV[0]
+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.run(**options)

data/grepfruit.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |spec|
   spec.version = Grepfruit::VERSION
   spec.authors = ["enjaku4"]
   spec.metadata["rubygems_mfa_required"] = "true"
-  spec.summary = "A tool for searching text patterns in files with colorized output."
+  spec.summary = "A Ruby gem for searching text patterns in files with colorized output."
   spec.homepage = "https://github.com/enjaku4/grepfruit"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.0.0", "< 3.4"

data/lib/grepfruit/version.rb

@@ -1,3 +1,3 @@
 module Grepfruit
-  VERSION = "0.2.0"
+  VERSION = "1.1.0"
 end

data/lib/grepfruit.rb

@@ -3,27 +3,34 @@ require "pathname"
 require "find"
 
 module Grepfruit
-  def self.run(path:, regex:, exclude:, search_hidden:)
+  def self.run(dir:, regex:, exclude:, truncate:, search_hidden:)
     lines = []
     files = 0
-    dir = path
+    excluded_lines = exclude.select { |e| e.any? { |s| s.include?(":") } }
+    excluded_paths = exclude - excluded_lines
 
-    puts "Searching for #{regex.inspect}...\n\n"
+    puts "Searching for #{regex.inspect} in #{dir.inspect}...\n\n"
 
-    Find.find(dir) do |pth|
-      Find.prune if exclude.any? { |e| pth.split("/").last(e.length) == e } || !search_hidden && File.basename(pth).start_with?(".")
+    Find.find(dir) do |path|
+      Find.prune if excluded_paths.any? { |e| path.split("/").last(e.length) == e } || !search_hidden && File.basename(path).start_with?(".")
 
-      next if File.directory?(pth)
+      next if File.directory?(path) || File.symlink?(path)
 
       files += 1
 
       match = false
 
-      File.foreach(pth).with_index do |line, line_num|
+      File.foreach(path).with_index do |line, line_num|
         next unless line.valid_encoding?
 
         if line.match?(regex)
-          lines << "\e[36m#{Pathname.new(pth).relative_path_from(Pathname.new(dir))}:#{line_num + 1}\e[0m: #{line.strip}"
+          path_with_line = "#{Pathname.new(path).relative_path_from(Pathname.new(dir))}:#{line_num + 1}"
+
+          next if excluded_lines.any? { |e| path_with_line.split("/").last(e.length) == e }
+
+          processed_line = line.strip
+          processed_line = "#{processed_line[0..truncate - 1]}..." if truncate && processed_line.length > truncate
+          lines << "\e[36m#{path_with_line}\e[0m: #{processed_line}"
           match = true
         end
       end
@@ -34,7 +41,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.2.0
+  version: 1.1.0
 platform: ruby
 authors:
 - enjaku4
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-28 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -50,5 +50,5 @@ requirements: []
 rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
-summary: A tool for searching text patterns in files with colorized output.
+summary: A Ruby gem for searching text patterns in files with colorized output.
 test_files: []