grepfruit 1.1.2 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6d72bac5375937fd7214c4d0f13de9f619695de3614202af1d877aaffdaf1f4
-  data.tar.gz: 7d1abd0f67111b48ccf0e988c8bfcab18fd90cf0510d02571292d29f2b4642b1
+  metadata.gz: 96acccb252509097d33a932f2d463358358d1ee20aea951561e94c7aed2e995d
+  data.tar.gz: 1dd758ab6f2fef47cea4890cf8fe09ed4f31cd5477d04e0be9891614ed605457
 SHA512:
-  metadata.gz: 18e978abd3bd6beeb29e14b88e8847f1410e3adfe8e1ad4b82910075cae099e25e5139c4ca8c4077b3666e7b2ad63911eb9a5cb637c8b3306ac42ad908f3caf1
-  data.tar.gz: 7d48ec2fd3f5f04baa4c69b9187675e0664c46d728907702aaa9a82f62b4689f999fc923bf5cc6035feb298d80350d9cd4f2906e006276b79b6e1a9768a6bc5b
+  metadata.gz: '02887d74be8c339a488626d15d53fc8609b5ec8b6ec68396d988b30d5bd147e1f643d6dc07bfdb75a71db40f4c18e5d40e556ea464814664ff8dcfa676fb5beb'
+  data.tar.gz: 17d41be73711460f8da710759850b53f2d622d5a03442e00521123c2c0c964e01effdb93e97a768e5d75db33d4087ec03a64a42d4466f462d4d5a65e4def5b2c

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v2.0.1
+
+- Enhanced output to include the number of files with matches
+
+## v2.0.0
+
+- Added support for Ruby 3.4
+- Dropped support for Ruby 3.0
+
 ## v1.1.2
 
 - Refactored code significantly for improved search efficiency and easier maintenance

data/README.md

@@ -5,7 +5,7 @@
 
 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">
+<img width="440" alt="Screenshot 2024-08-16 at 21 17 25" src="https://github.com/user-attachments/assets/3caaa1f4-5636-4ca1-ae45-6fc56f8945e4">
 
 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.
 
@@ -23,14 +23,22 @@ And then execute:
 bundle install
 ```
 
+Or install it yourself as:
+
+```shell
+gem install grepfruit
+```
+
 ## Usage
 
 You can use Grepfruit from the command line to search for a regex pattern within files in a specified directory.
 
 ```shell
-bundle exec grepfruit [options] PATH
+grepfruit [options] PATH
 ```
 
+If no matches are found, Grepfruit returns exit status 0; otherwise, it returns exit status 1.
+
 ### Options
 
 - `-r, --regex REGEX`: Regex pattern to search for (required).
@@ -43,31 +51,31 @@ bundle exec grepfruit [options] PATH
 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'
+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
+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 -r 'FIXME|TODO' -e 'README.md:18'
+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:
 
 ```shell
-bundle exec grepfruit -r 'FIXME|TODO' -t 50
+grepfruit -r 'FIXME|TODO' -t 50
 ```
 
 Search for the pattern `/FIXME|TODO/` in the current directory, including hidden files and directories:
 
 ```shell
-bundle exec grepfruit -r 'FIXME|TODO' --search-hidden
+grepfruit -r 'FIXME|TODO' --search-hidden
 ```
 
 ## Problems?

data/exe/grepfruit

@@ -15,22 +15,10 @@ options = {
 
 OptionParser.new do |opts|
   opts.banner = "Usage: grepfruit [options] PATH"
-
-  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
-  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|
-    options[:search_hidden] = search_hidden
-  end
+  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?

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.0", "< 3.4"
+  spec.required_ruby_version = ">= 3.1", "< 3.5"
 
   spec.files = [
     "grepfruit.gemspec", "README.md", "CHANGELOG.md", "LICENSE.txt"

data/lib/grepfruit/version.rb

@@ -1,3 +1,3 @@
 module Grepfruit
-  VERSION = "1.1.2"
+  VERSION = "2.0.1"
 end

data/lib/search.rb

@@ -3,66 +3,76 @@ require "find"
 
 module Grepfruit
   class Search
-    CYAN = "\e[36m"
-    RED = "\e[31m"
-    GREEN = "\e[32m"
-    RESET = "\e[0m"
-
     attr_reader :dir, :regex, :excluded_paths, :excluded_lines, :truncate, :search_hidden
 
     def initialize(dir:, regex:, exclude:, truncate:, search_hidden:)
       @dir = dir
       @regex = regex
-      @excluded_lines, @excluded_paths = exclude.map { |e| e.split("/") }.partition { |e| e.last.include?(":") }
+      @excluded_lines, @excluded_paths = exclude.map { _1.split("/") }.partition { _1.last.include?(":") }
       @truncate = truncate
       @search_hidden = search_hidden
     end
 
     def run
-      lines, files = [], 0
+      lines, files, files_with_matches = [], 0, 0
 
       puts "Searching for #{regex.inspect} in #{dir.inspect}...\n\n"
 
       Find.find(dir) do |path|
-        Find.prune if excluded_path?(path) || !search_hidden && hidden?(path)
+        Find.prune if excluded_path?(path)
 
-        next if File.directory?(path) || File.symlink?(path)
+        next if not_searchable?(path)
 
         files += 1
+        match = process_file(path, lines)
 
-        match = false
+        if match
+          files_with_matches += 1
+          print "#{COLORS[:red]}M#{COLORS[:reset]}"
+        else
+          print "#{COLORS[:green]}.#{COLORS[:reset]}"
+        end
+      end
 
-        File.foreach(path).with_index do |line, line_num|
-          next unless line.valid_encoding?
+      display_results(lines, files, files_with_matches)
+    end
 
-          if line.match?(regex)
-            next if excluded_line?(path, line_num)
+    COLORS = { cyan: "\e[36m", red: "\e[31m", green: "\e[32m", reset: "\e[0m" }
+    private_constant :COLORS
 
-            lines << "#{CYAN}#{relative_path_with_line_num(path, line_num)}#{RESET}: #{processed_line(line)}"
-            match = true
-          end
-        end
+    private
+
+    def not_searchable?(path)
+      File.directory?(path) || File.symlink?(path)
+    end
+
+    def process_file(path, lines)
+      lines_size = lines.size
 
-        print match ? "#{RED}M#{RESET}" : "#{GREEN}.#{RESET}"
+      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)}"
       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, #{GREEN}no matches found#{RESET}"
+        puts "#{number_of_files(files)} checked, #{COLORS[:green]}no matches found#{COLORS[:reset]}"
         exit(0)
       else
-        puts "Matches:\n\n"
-        puts "#{lines.join("\n")}\n\n"
-        puts "#{number_of_files(files)} checked, #{RED}#{number_of_matches(lines.size)} found#{RESET}"
+        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
 
-    private
-
     def excluded_path?(path)
-      excluded?(excluded_paths, relative_path(path))
+      excluded?(excluded_paths, relative_path(path)) || !search_hidden && hidden?(path)
     end
 
     def excluded_line?(path, line_num)
@@ -70,7 +80,7 @@ module Grepfruit
     end
 
     def excluded?(list, path)
-      list.any? { |e| path.split("/").last(e.length) == e }
+      list.any? { path.split("/").last(_1.length) == _1 }
     end
 
     def relative_path(path)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grepfruit
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.1
 platform: ruby
 authors:
 - enjaku4
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-15 00:00:00.000000000 Z
+date: 2024-12-26 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -41,17 +41,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3.4'
+      version: '3.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: A Ruby gem for searching text patterns in files with colorized output