grepfruit 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 793a10b4b4676491d13d45fd598316ce327cfa660962ce37c7e3404a383f1a2e
-  data.tar.gz: 84f8ab7c8ff9350c95182dcc1127e7ec779b8f5a0f0f9567d845680275bda9c3
+  metadata.gz: 4375b6c22cf2b2323abd76e66e35c098a4f681fe24fd63a40df0a4fa90640ea3
+  data.tar.gz: 743a2141c660fa7aa90687f56de16e5d3c9b5172abe4b9d52f7aa7ad322a773c
 SHA512:
-  metadata.gz: d9a329e3105b5ab178180fb415ca72af96c62ab91a47d18669a3ac8514f25a5380e0d5840f457863b3f00b76766d7ddba3ca53951cfa8010e86525bca445ed41
-  data.tar.gz: d94287b1c4f5954920853f9303586803fb918877c7f18146528add86457b53940a4cfcda47ca63794b8caf002a7b6d02b0b3e19b6c39d5b03d5bad32b1d7e8a8
+  metadata.gz: d2a124c7e449b5a098c229f07e2c392ee89c06391f1c75ae5666bb485ac28d10dec33e0f556eda2bd5bbcaf659b052ea013ae4bb2617efcb2a6a2ed7c3a89fa6
+  data.tar.gz: 1e4640be220f8a72b1592e229de4d8bf70bf06e1d6d461f2fd85d663b5bd67bc7d27ea0e513867a32e6a129ab07ad13dbe4b905ef023633c89c7c61fda81cdd8

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 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

data/README.md

@@ -33,8 +33,9 @@ bundle exec grepfruit [options] PATH
 
 ### Options
 
-- `-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.
+- `-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
@@ -43,8 +44,6 @@ Search for the pattern `/TODO/` in the current directory, excluding `log`, `tmp`
 
 ```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:
@@ -53,6 +52,18 @@ Search for the pattern `/FIXME|TODO/` in `dev/grepfruit` directory, excluding `b
 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 -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
+```
+
 Search for the pattern `/FIXME|TODO/` in the current directory, including hidden files and directories:
 
 ```shell

data/exe/grepfruit

@@ -6,9 +6,10 @@ require "optparse"
 require "grepfruit"
 
 options = {
-  path: Dir.pwd,
+  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|
@@ -33,6 +38,6 @@ if options[:regex].nil?
   exit 1
 end
 
-options[:path] = ARGV[0] if ARGV[0]
+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 = "1.0.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) || File.symlink?(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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grepfruit
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - enjaku4
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-30 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -47,8 +47,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+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: []