rbcat 0.2.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1da445294f5b958c26e1638e96e8076161a1a91fcf5bcfa2cf20dcdc717d85ff
-  data.tar.gz: b644015fba8ccf3dd9dbf7b4d215441105f1db67edbea303bf8bb16cfb6f81bf
+  metadata.gz: b5047d5b1235afddfca723cbfaa21bfbd27ac847c37dd218fad5c1d31ff89969
+  data.tar.gz: 28dd22890a5979f2105bd7f2d0892a122a2dbfc2ddd0f23a4de6c72c85784d7e
 SHA512:
-  metadata.gz: 170fe343f258e2dd8f88a2c875749800bf36cfff21f18d75e13360f3a0569bd587bd188a2d7813e88a23429478897415239c96c619ea4d0320fa7dffc72ed4cb
-  data.tar.gz: f45f23373293e37a55e1c0ce29d0cf99d3397571db02a6963f92a45b5b629cdef61c6b320af22d5dc933e6bbf55354805b951321cc56441110e92d9acf7ac40a
+  metadata.gz: 241fef38e6c7a2266bda38588d33a19af7330658fd5a9b800e7352257d1e41f701972b96e63e22df2ce3a1afa17c9d3477b84d750dff4b5f5b3e8173b7185b0f
+  data.tar.gz: 1072933a0abd952a0bb376dc24780b2e7b8fa05a0b9bea262fd1ce0792a8ffa427e26b8fb49cb34af011a3a34c84770efbfa6733679b9ed2b88a73d8e12bcdff

data/.rubocop.yml

@@ -1,2 +1,2 @@
 AllCops:
-  TargetRubyVersion: 2.3.0
+  TargetRubyVersion: 3.1.0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.0.0
+* Rubocop updates
+* Bump min required Ruby version to 3.1.0
+
 ## 0.2.3
 * Bump Bundler to >= 2.2.33
 * Bump Rake to >= 12.3.3

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Victor Afanasev
+Copyright (c) 2025 Victor Afanasev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -5,7 +5,7 @@
 Rbcat it's a CLI tool written in ruby which reads from standard input (STDIN), colorizes content by set of regex rules from a config file, and then writes it to standard output. Inspired by [grcat](https://github.com/garabik/grc).
 You can use rbcat in your ruby/ROR projects or as a standalone CLI tool (similar to grcat).
 
-**Install rbcat first:** `gem install rbcat`
+**Install rbcat first:** `gem install rbcat` _(supported Ruby version 3.1.0 and up)_
 
 ```ruby
 # rbcat_example.rb
@@ -84,7 +84,7 @@ require 'rbcat'
 require 'yaml'
 
 Rbcat.configure do |config|
-  config.rules = YAML.load_file(File.expand_path("rbcat_config.yaml"))
+  config.rules = YAML.load_file(File.expand_path("rbcat_config.yaml"), permitted_classes: [Regexp, Symbol])
   config.predefined = [:logger]
 end
 ```
@@ -187,7 +187,7 @@ require 'yaml'
 
 # configure rbcat first
 Rbcat.configure do |config|
-  config.rules = YAML.load_file(File.expand_path("rbcat_config.yaml"))
+  config.rules = YAML.load_file(File.expand_path("rbcat_config.yaml"), permitted_classes: [Regexp, Symbol])
 end
 
 # define formatter

data/Rakefile

@@ -1,2 +1,4 @@
-require "bundler/gem_tasks"
-task :default => :spec
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rbcat"
+require 'bundler/setup'
+require 'rbcat'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "rbcat"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/exe/rbcat

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "rbcat"
+require 'rbcat'
 Rbcat::CLI.start(ARGV)

data/lib/rbcat/cli.rb

@@ -9,13 +9,11 @@ module Rbcat
       options = parse_options(args)
       colorizer_options = create_colorizer_options(options)
 
-      while input = STDIN.gets
+      while (input = $stdin.gets)
         input.each_line do |line|
-          begin
-            puts Rbcat.colorize(line, colorizer_options)
-          rescue Errno::EPIPE
-            exit(74)
-          end
+          puts Rbcat.colorize(line, colorizer_options)
+        rescue Errno::EPIPE
+          exit(74)
         end
       end
     end
@@ -24,11 +22,9 @@ module Rbcat
       rules =
         if options[:rules]
           file_path = File.expand_path(options[:rules])
-          unless File.exist? file_path
-            raise ConfigurationError, "Config file not found: #{file_path}."
-          else
-            YAML.load_file(file_path)
-          end
+          raise ConfigurationError, "Config file not found: #{file_path}." unless File.exist?(file_path)
+
+          YAML.load_file(file_path, permitted_classes: [Regexp, Symbol])
         end
 
       predefined = options[:predefined]
@@ -40,7 +36,7 @@ module Rbcat
     private_class_method def self.parse_options(args)
       options = {}
 
-      args.push("-h") if args.empty?
+      args.push('-h') if args.empty?
 
       OptionParser.new do |opts|
         opts.banner = <<~HEREDOC
@@ -48,32 +44,32 @@ module Rbcat
           colorizes content by set of regex rules from a config file,
           and then writes it to standard output.
         HEREDOC
-        opts.separator ""
+        opts.separator ''
 
-        predefined_desc = "Colorize input by set of predefined rules. " \
+        predefined_desc = 'Colorize input by set of predefined rules. ' \
           "Currently there are json/hash 'jsonhash' and ruby's logger 'logger'. " \
-          "Example: --predefined=jsonhash,logger"
-        opts.on("-p", "--predefined GROUPS", Array, predefined_desc) do |arg|
+          'Example: --predefined=jsonhash,logger'
+        opts.on('-p', '--predefined GROUPS', Array, predefined_desc) do |arg|
           options[:predefined] = arg
         end
 
-        rules_desc = "Path to the custom yaml config for rbcat."
-        opts.on("-r", "--rules PATH", rules_desc) do |arg|
+        rules_desc = 'Path to the custom yaml config for rbcat.'
+        opts.on('-r', '--rules PATH', rules_desc) do |arg|
           options[:rules] = arg
         end
 
-        order_desc = "Specify order for predefined and custom rules." \
+        order_desc = 'Specify order for predefined and custom rules.' \
           "Avaiable options: 'predefined_first' (default) or 'predefined_last'."
-        opts.on("-o", "--order ORDER", order_desc) do |arg|
+        opts.on('-o', '--order ORDER', order_desc) do |arg|
           options[:order] = arg
         end
 
-        opts.on("-c", "--print_colors", "Print all avaiable colors.") do
+        opts.on('-c', '--print_colors', 'Print all avaiable colors.') do
           Rbcat::Colorizer.print_colors
           exit
         end
 
-        opts.on_tail("-v", "--version", "Show version") do
+        opts.on_tail('-v', '--version', 'Show version') do
           puts Rbcat::VERSION
           exit
         end

data/lib/rbcat/colorizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rbcat
   class Colorizer
     def self.print_colors
@@ -7,7 +9,7 @@ module Rbcat
     end
 
     def self.colorize(string, predefined: nil, rules: nil, order: nil)
-      return string if ENV["RBCAT_COLORIZER"] == "false"
+      return string if ENV['RBCAT_COLORIZER'] == 'false'
 
       colors = Rbcat::Colors::DEFAULT
       config = create_config(predefined, rules, order)
@@ -19,7 +21,7 @@ module Rbcat
           end
         elsif settings[:colors]
           string.gsub!(settings[:regexp]) do
-            str = ""
+            str = ''
             Regexp.last_match.captures.each_with_index do |match, i|
               str << colors[settings[:colors][i]] + match + colors[:default]
             end
@@ -38,16 +40,17 @@ module Rbcat
 
     def self.uncolorize(string)
       pattern = /\033\[([0-9]+);([0-9]+)m|\033\[([0-9]+)m/m
-      string.gsub(pattern, "")
+      string.gsub(pattern, '')
     end
 
     private_class_method def self.create_config(predefined, rules, order)
-      predefined_rules = predefined ? predefined : Rbcat.configuration&.predefined
+      predefined_rules = predefined || Rbcat.configuration&.predefined
       rules ||= Rbcat.configuration&.rules
 
-      raise ConfigurationError, "No config defined." unless predefined_rules || rules
+      raise ConfigurationError, 'No config defined.' unless predefined_rules || rules
+
       if rules && rules.class != Hash
-        raise ConfigurationError, "Incorrect configuration. " \
+        raise ConfigurationError, 'Incorrect configuration. ' \
           "There is error while converting yaml config into Ruby's hash of rules."
       end
 
@@ -57,7 +60,7 @@ module Rbcat
       case order
       when :predefined_first
         predefined_rules&.each do |group|
-          config.merge!(Object.const_get "Rbcat::Rules::#{group.to_s.upcase}")
+          config.merge!(Object.const_get("Rbcat::Rules::#{group.to_s.upcase}"))
         end
 
         rules ? deep_merge(config, rules) : config
@@ -65,13 +68,13 @@ module Rbcat
         config.merge!(rules) if rules
 
         predefined_rules&.each do |group|
-          config.merge!(Object.const_get "Rbcat::Rules::#{group.to_s.upcase}")
+          config.merge!(Object.const_get("Rbcat::Rules::#{group.to_s.upcase}"))
         end
 
         config
       else
         raise ConfigurationError, "Wrong type of order: #{order}. " \
-          "Define :predefined_first (default) or :predefined_last"
+          'Define :predefined_first (default) or :predefined_last'
       end
     end
 

data/lib/rbcat/colors.rb

@@ -3,57 +3,57 @@
 module Rbcat
   module Colors
     DEFAULT = {
-      default:    "\033[0m",
-      bold:       "\033[1m",
-      underline:  "\033[4m",
-      blink:      "\033[5m",
-      reverse:    "\033[7m",
-      concealed:  "\033[8m",
+      default: "\033[0m",
+      bold: "\033[1m",
+      underline: "\033[4m",
+      blink: "\033[5m",
+      reverse: "\033[7m",
+      concealed: "\033[8m",
 
-      black:      "\033[30m",
-      red:        "\033[31m",
-      green:      "\033[32m",
-      yellow:     "\033[33m",
-      blue:       "\033[34m",
-      magenta:    "\033[35m",
-      cyan:       "\033[36m",
-      white:      "\033[37m",
+      black: "\033[30m",
+      red: "\033[31m",
+      green: "\033[32m",
+      yellow: "\033[33m",
+      blue: "\033[34m",
+      magenta: "\033[35m",
+      cyan: "\033[36m",
+      white: "\033[37m",
 
-      bold_black:   "\033[1;30m",
-      bold_red:     "\033[1;31m",
-      bold_green:   "\033[1;32m",
-      bold_yellow:  "\033[1;33m",
-      bold_blue:    "\033[1;34m",
+      bold_black: "\033[1;30m",
+      bold_red: "\033[1;31m",
+      bold_green: "\033[1;32m",
+      bold_yellow: "\033[1;33m",
+      bold_blue: "\033[1;34m",
       bold_magenta: "\033[1;35m",
-      bold_cyan:    "\033[1;36m",
-      bold_white:   "\033[1;37m",
+      bold_cyan: "\033[1;36m",
+      bold_white: "\033[1;37m",
 
-      on_black:   "\033[40m",
-      on_red:     "\033[41m",
-      on_green:   "\033[42m",
-      on_yellow:  "\033[43m",
-      on_blue:    "\033[44m",
+      on_black: "\033[40m",
+      on_red: "\033[41m",
+      on_green: "\033[42m",
+      on_yellow: "\033[43m",
+      on_blue: "\033[44m",
       on_magenta: "\033[45m",
-      on_cyan:    "\033[46m",
-      on_white:   "\033[47m",
+      on_cyan: "\033[46m",
+      on_white: "\033[47m",
 
-      bright_black:      "\033[30;90m",
-      bright_red:        "\033[31;91m",
-      bright_green:      "\033[32;92m",
-      bright_yellow:     "\033[33;93m",
-      bright_blue:       "\033[34;94m",
-      bright_magenta:    "\033[35;95m",
-      bright_cyan:       "\033[36;96m",
-      bright_white:      "\033[37;97m",
+      bright_black: "\033[30;90m",
+      bright_red: "\033[31;91m",
+      bright_green: "\033[32;92m",
+      bright_yellow: "\033[33;93m",
+      bright_blue: "\033[34;94m",
+      bright_magenta: "\033[35;95m",
+      bright_cyan: "\033[36;96m",
+      bright_white: "\033[37;97m",
 
-      on_bright_black:   "\033[40;100m",
-      on_bright_red:     "\033[41;101m",
-      on_bright_green:   "\033[42;102m",
-      on_bright_yellow:  "\033[43;103m",
-      on_bright_blue:    "\033[44;104m",
+      on_bright_black: "\033[40;100m",
+      on_bright_red: "\033[41;101m",
+      on_bright_green: "\033[42;102m",
+      on_bright_yellow: "\033[43;103m",
+      on_bright_blue: "\033[44;104m",
       on_bright_magenta: "\033[45;105m",
-      on_bright_cyan:    "\033[46;106m",
-      on_bright_white:   "\033[47;107m"
+      on_bright_cyan: "\033[46;106m",
+      on_bright_white: "\033[47;107m"
     }.freeze
   end
 end

data/lib/rbcat/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rbcat
   class ConfigurationError < StandardError; end
 

data/lib/rbcat/rules.rb

@@ -1,55 +1,57 @@
+# frozen_string_literal: true
+
 module Rbcat
   module Rules
     JSONHASH = {
       value_integer: {
-        regexp: /(?<=\"\:)\d+|(?<=\=\>)\d+/m,
+        regexp: /(?<=":)\d+|(?<==>)\d+/m,
         color: :cyan
       },
       key_string: {
-        regexp: /\"[^\"]*\"(?=\:)/m,
+        regexp: /"[^"]*"(?=:)/m,
         color: :green
       },
       key_symbol: {
-        regexp: /\:[\p{L}\_\d]*(?=\=\>)|\:\"[^\"]*\"(?=\=\>)/m,
+        regexp: /:[\p{L}_\d]*(?==>)|:"[^"]*"(?==>)/m,
         color: :magenta
       },
       value_string: {
-        regexp: /\"(?:[^"\\]|\\.)*\"(?=[\,\n\}\]])/m,
+        regexp: /"(?:[^"\\]|\\.)*"(?=[,\n}\]])/m,
         color: :yellow
       },
       value_null_nil: {
-        regexp: /(?<=\:)null|(?<=\=\>)nil/m,
+        regexp: /(?<=:)null|(?<==>)nil/m,
         color: :magenta
       },
       value_true_false: {
-        regexp: /(?<=\:)(false|true)|(?<=\=\>)(false|true)/m,
+        regexp: /(?<=:)(false|true)|(?<==>)(false|true)/m,
         color: :magenta
       }
     }.freeze
 
     LOGGER = {
       info_logger: {
-        regexp: /INFO(\s--\s.*?\:|)/m,
+        regexp: /INFO(\s--\s.*?:|)/m,
         color: :cyan,
         once: true
       },
       error_logger: {
-        regexp: /ERROR(\s--\s.*?\:|)/m,
+        regexp: /ERROR(\s--\s.*?:|)/m,
         color: :red,
         once: true
       },
       fatal_logger: {
-        regexp: /FATAL(\s--\s.*?\:|)/m,
+        regexp: /FATAL(\s--\s.*?:|)/m,
         color: :bold_red,
         once: true
       },
       warn_logger: {
-        regexp: /WARN(\s--\s.*?\:|)/m,
+        regexp: /WARN(\s--\s.*?:|)/m,
         color: :yellow,
         once: true
       },
       debug_logger: {
-        regexp: /DEBUG(\s--\s.*?\:|)/m,
+        regexp: /DEBUG(\s--\s.*?:|)/m,
         color: :green,
         once: true
       }

data/lib/rbcat/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rbcat
-  VERSION = "0.2.3"
+  VERSION = '1.0.0'
 end

data/lib/rbcat.rb

@@ -1,9 +1,11 @@
-require "rbcat/version"
-require "rbcat/configuration"
-require "rbcat/colors"
-require "rbcat/rules"
-require "rbcat/colorizer"
-require "rbcat/cli"
+# frozen_string_literal: true
+
+require 'rbcat/version'
+require 'rbcat/configuration'
+require 'rbcat/colors'
+require 'rbcat/rules'
+require 'rbcat/colorizer'
+require 'rbcat/cli'
 
 module Rbcat
   def self.colorize(string, options = {})

data/rbcat.gemspec

@@ -1,29 +1,27 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rbcat/version"
+require 'rbcat/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rbcat"
+  spec.name          = 'rbcat'
   spec.version       = Rbcat::VERSION
 
-  spec.authors       = ["Victor Afanasev"]
-  spec.email         = ["vicfreefly@gmail.com"]
+  spec.authors       = ['Victor Afanasev']
+  spec.email         = ['vicfreefly@gmail.com']
 
-  spec.summary       = "Colorize output by defined set of regex rules"
-  spec.description   = "Colorize output by defined set of regex rules"
-  spec.homepage      = "https://github.com/vifreefly/rbcat"
-  spec.license       = "MIT"
+  spec.summary       = 'Colorize output by defined set of regex rules'
+  spec.description   = 'Colorize output by defined set of regex rules'
+  spec.homepage      = 'https://github.com/vifreefly/rbcat'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = "rbcat"
-  spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.3.0"
+  spec.bindir        = 'exe'
+  spec.executables   = 'rbcat'
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", ">= 2.2.33"
-  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.required_ruby_version = '>= 3.1.0'
 end

metadata

@@ -1,42 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbcat
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Victor Afanasev
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.33
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.33
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
+dependencies: []
 description: Colorize output by defined set of regex rules
 email:
 - vicfreefly@gmail.com
@@ -74,14 +46,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.1
 specification_version: 4
 summary: Colorize output by defined set of regex rules
 test_files: []