grepfruit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64111f942b9dd8e2b1b6957b552e582fc9b7870225dd40e8042de30e06832dca
+  data.tar.gz: 40c9d6fe5cd104aa4deca5c0eadd0299851bcd286b086fd50da2ed02bbf385af
+SHA512:
+  metadata.gz: 0bf856a22a4ab91c636e7b9ab9ae03f947b5344c9fa3266617aa4c8812e7ffd0228a84a88fa0fad9bcd10479b7b40258c85a213a160eb6d740d615111f7fbc04
+  data.tar.gz: 6901c591fc559557064034ffce12a79c7d3f6ca8972bb00134429bed51dfab404fcc93b13b350d10acf1a281c54fe844cbbcf54a337ddb706e5dcf8af4883067

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 enjaku4 (https://github.com/enjaku4)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# Grepfruit
+
+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">
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grepfruit'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+## Usage
+
+You can use Grepfruit from the command line to search for a regex pattern within files in a specified directory.
+
+```shell
+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.
+
+### Examples
+
+Search for the pattern `TODO` in the current directory, excluding the default directories:
+
+```shell
+grepfruit
+```
+
+Search for a custom pattern in another directory, while specifying files and directories to exclude:
+
+```shell
+grepfruit -r 'FIXME|TODO' -e 'bin,log,Rakefile,Gemfile.lock' /path/to/directory
+```
+
+## Problems?
+
+Facing a problem or want to suggest an enhancement?
+
+- **Open a Discussion**: If you have a question, experience difficulties using the gem, or have a suggestion for improvements, feel free to use the Discussions section.
+
+Encountered a bug?
+
+- **Create an Issue**: If you've identified a bug, please create an issue. Be sure to provide detailed information about the problem, including the steps to reproduce it.
+- **Contribute a Solution**: Found a fix for the issue? Feel free to create a pull request with your changes.
+
+## Contributing
+
+Before creating an issue or a pull request, please read the [contributing guidelines](https://github.com/enjaku4/grepfruit/blob/master/CONTRIBUTING.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://github.com/enjaku4/grepfruit/blob/master/LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the Grepfruit project is expected to follow the [code of conduct](https://github.com/enjaku4/grepfruit/blob/master/CODE_OF_CONDUCT.md).

data/exe/grepfruit

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "optparse"
+require "grepfruit"
+
+options = {
+  path: Dir.pwd,
+  regex: /TODO/,
+  exclude: [["log"], ["tmp"], ["vendor"], ["node_modules"], ["assets"]]
+}
+
+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}/
+  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
+end.parse!
+
+options[:path] = ARGV[0] if ARGV[0]
+
+Grepfruit.run(**options)

data/grepfruit.gemspec

@@ -0,0 +1,20 @@
+require_relative "lib/grepfruit/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "grepfruit"
+  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.homepage = "https://github.com/enjaku4/grepfruit"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0", "< 3.4"
+
+  spec.files = [
+    "grepfruit.gemspec", "README.md", "CHANGELOG.md", "LICENSE.txt"
+  ] + `git ls-files | grep -E '^(lib|exe)'`.split("\n")
+
+  spec.bindir = "exe"
+  spec.executables = ["grepfruit"]
+  spec.require_paths = ["lib"]
+end

data/lib/grepfruit/version.rb

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

data/lib/grepfruit.rb

@@ -0,0 +1,46 @@
+require_relative "grepfruit/version"
+require "pathname"
+require "find"
+
+module Grepfruit
+  def self.run(path:, regex:, exclude:)
+    lines = []
+    files = 0
+    dir = path
+
+    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?(".")
+
+      next if File.directory?(pth)
+
+      files += 1
+
+      match = false
+
+      File.foreach(pth).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}"
+          match = true
+        end
+      end
+
+      print match ? "\e[31mF\e[0m" : "\e[32m.\e[0m"
+    end
+
+    puts "\n\n"
+
+    if lines.empty?
+      puts "#{files} files 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
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: grepfruit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- enjaku4
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-28 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+executables:
+- grepfruit
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/grepfruit
+- grepfruit.gemspec
+- lib/grepfruit.rb
+- lib/grepfruit/version.rb
+homepage: https://github.com/enjaku4/grepfruit
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: A tool for searching text patterns in files with colorized output.
+test_files: []