grepfruit 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32c9440099c6773c0462e07588d75db0dbc068417e01f1d9a1449dcdc2ee1031
-  data.tar.gz: 6ee33ae41606b4ee5d65204e6a9ae0c7d162d0b3fe6a30bac230aec272e91940
+  metadata.gz: 8e88618b796ae6c0d9f54ec4bc64033e44ecee9fef5a3a889a0585dff11741e4
+  data.tar.gz: 1d6acc4c77b5175b9d13b3c4eb23b8ed069caf6f8e031037a1ec0244d945fa5c
 SHA512:
-  metadata.gz: be872e34b8520febbadefc4ab7a747f7bdf0bc4f59fc4a7b09902d6eb3b1caba434820b6745c0086dacde3d82c21c21c0722f3e7b492a014c08311586188b865
-  data.tar.gz: 10c7be4bc77fa12b3f7da587ac921073424af09df6534d4df4929f8d24402a76daf349fd2ded696be121469dbea1fb1fad7323ba11559809dfa3aa87d5827286
+  metadata.gz: 1690b2abec8f59847eace9a70cbaa9d8b08c54d64e35b76ef5d8f2ce6c707478a044e40fad514932f2bbcd9ec2cd289129e05b47497b102ab83fa6ed78dd631b
+  data.tar.gz: 322537a62dbb5d81731af9d973f8b5e69dc557e0721cfabbd8add2da69712b88a231371d5842b2e710fa882b7d03c9e7fd3ed9dfc4a3a5422c893ce0b9f21050

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 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
+- Enhanced search result output for better readability
+
 ## v1.1.1
 
 - Added test dataset to make testing and development easier

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.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|
-    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?
@@ -40,4 +28,4 @@ end
 
 options[:dir] = ARGV[0] if ARGV[0]
 
-Grepfruit.run(**options)
+Grepfruit::Search.new(**options).run

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.1"
+  VERSION = "2.0.0"
 end

data/lib/grepfruit.rb

@@ -1,53 +1,6 @@
 require_relative "grepfruit/version"
-require "pathname"
-require "find"
+require_relative "search"
 
 module Grepfruit
-  def self.run(dir:, regex:, exclude:, truncate:, search_hidden:)
-    lines = []
-    files = 0
-    excluded_lines = exclude.select { |e| e.any? { |s| s.include?(":") } }
-    excluded_paths = exclude - excluded_lines
-
-    puts "Searching for #{regex.inspect} in #{dir.inspect}...\n\n"
-
-    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?(path) || File.symlink?(path)
-
-      files += 1
-
-      match = false
-
-      File.foreach(path).with_index do |line, line_num|
-        next unless line.valid_encoding?
-
-        if line.match?(regex)
-          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
-
-      print match ? "\e[31mF\e[0m" : "\e[32m.\e[0m"
-    end
-
-    puts "\n\n"
-
-    if lines.empty?
-      puts "#{files} file#{'s' if files > 1} checked, \e[32mno matches found\e[0m"
-      exit(0)
-    else
-      puts "Matches:\n\n"
-      puts "#{lines.join("\n")}\n\n"
-      puts "#{files} file#{'s' if files > 1} checked, \e[31m#{lines.size} match#{'es' if lines.size > 1} found\e[0m"
-      exit(1)
-    end
-  end
+  class Error < StandardError; end
 end

data/lib/search.rb

@@ -0,0 +1,99 @@
+require "pathname"
+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 { _1.split("/") }.partition { _1.last.include?(":") }
+      @truncate = truncate
+      @search_hidden = search_hidden
+    end
+
+    def run
+      lines, files = [], 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)
+
+        next if File.directory?(path) || File.symlink?(path)
+
+        files += 1
+
+        match = false
+
+        File.foreach(path).with_index do |line, line_num|
+          next unless line.valid_encoding?
+
+          if line.match?(regex) && !excluded_line?(path, line_num)
+            lines << "#{CYAN}#{relative_path_with_line_num(path, line_num)}#{RESET}: #{processed_line(line)}"
+            match = true
+          end
+        end
+
+        print match ? "#{RED}M#{RESET}" : "#{GREEN}.#{RESET}"
+      end
+
+      puts "\n\n" if files.positive?
+
+      if lines.empty?
+        puts "#{number_of_files(files)} checked, #{GREEN}no matches found#{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}"
+        exit(1)
+      end
+    end
+
+    private
+
+    def excluded_path?(path)
+      excluded?(excluded_paths, relative_path(path))
+    end
+
+    def excluded_line?(path, line_num)
+      excluded?(excluded_lines, relative_path_with_line_num(path, line_num))
+    end
+
+    def excluded?(list, path)
+      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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grepfruit
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - enjaku4
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-05 00:00:00.000000000 Z
+date: 2024-12-25 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -24,6 +24,7 @@ files:
 - grepfruit.gemspec
 - lib/grepfruit.rb
 - lib/grepfruit/version.rb
+- lib/search.rb
 homepage: https://github.com/enjaku4/grepfruit
 licenses:
 - MIT
@@ -40,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.2.33
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: A Ruby gem for searching text patterns in files with colorized output