rbcat 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cf26b222d1b203aca1a1a0fe57e6888d4c9443c89ed2e9357f094adeb5114f7
-  data.tar.gz: f32f88be4960c79ca91eebf320ff9b010ed47bd4e7bebb939d2e1bf78a4c44f0
+  metadata.gz: dcd92d02b1549d5f321baa2199365b15fbbfc2e5cd62261c27ba41d53cffbbf7
+  data.tar.gz: 75ea1ff2ba8f5ef6b0a2dc2705a361576ef9d6461991bb6e13d77addd6458e83
 SHA512:
-  metadata.gz: aecdbfac200a6845ce384a7c4e1386bf328427c00332914ee54a74e4050b11dc96b77a6bb5bcf1fa1fc2e044af7bdab7af122ad15f9259cb5ea9d2a5a469b11f
-  data.tar.gz: ecc9501e91a5ad25885c140edb90fd1784719135924920b96728b9e0998836780483b59d06c7f9447b200987088dfa22cd71066d5e780aab0507bd906ad24fd5
+  metadata.gz: 47d472e9f8c5c92643c3a7d24eaec225fa78c00ace3997610a008ce98ff07c618867167a9fe947d45812cb0c9366a39cc64db6446a90b1598ee3266413206d35
+  data.tar.gz: 01d8aab7888306963d77999f18fc4003bacdc7e92a2013fa5dd3dc951fcf756c55835166a117803de7b036f5a0c33093917a30f253b5f55feee3e2caf7a0bd8f

data/README.md

@@ -37,17 +37,13 @@ rules = {
 }
 
 require "rbcat"
-colorizer = Rbcat::Colorizer.new(rules: rules)
-puts colorizer.colorize(description)
-
+puts Rbcat.colorize(description, rules: rules)
 ```
 
 ![](https://hsto.org/webt/qp/pp/nb/qpppnbvennx7yp5nxpye5qrgt_c.png)
 
 
-
 **Same using CLI:**
-
 ```yaml
 # rbcat_config.yaml
 ---
@@ -70,25 +66,24 @@ colorizes content by set of regex rules from a config file, and then writes it
 to standard output.
 You can use rbcat in your ruby/ROR projects or as a standalone CLI tool (similar to grcat)." > description.txt
 
-$ cat description.txt | rbcat --rules=rbcat_config.yaml # or
+$ cat description.txt | rbcat --rules=rbcat_config.yaml
+# or
 $ rbcat --rules=rbcat_config.yaml < description.txt
 ```
 
 ![](https://hsto.org/webt/_u/5o/vu/_u5ovumrklgtx-akeqd_lbdpkys.png)
 
 
-
 ### Configuration
-
 ##### Configure
 
 You can configure Rbcat this way:
 
 ```ruby
-require "rbcat"
+require 'rbcat'
+require 'yaml'
 
 Rbcat.configure do |config|
-  require "yaml"
   config.rules = YAML.load_file(File.expand_path("rbcat_config.yaml"))
   config.predefined = [:logger]
 end
@@ -97,14 +92,10 @@ end
 And then everywhere in the ruby code just:
 
 ```ruby
-colorizer = Rbcat::Colorizer.new
-puts colorizer.colorize("String to colorize")
+puts Rbcat.colorize("String to colorize")
 ```
 
-
-
 ##### Regex rules and colors
-
 Config contains rules. Each rule has options. Example:
 
 ```ruby
@@ -117,9 +108,7 @@ config = {
 }
 ```
 
-
-
-##### Predefined color sets
+##### Predefined sets
 
 There are predefined sets of rules: **jsonhash** (colorizes strings that contain _json_ or _ruby hash_) and **logger** (colorizes _DEBUG_, _INFO_, _WARN_ and _ERROR_).
 
@@ -135,16 +124,10 @@ Let's see:
 
 You can use both custom and predefined rules in the same time.
 
-
-
 ##### Colors
-
 To print all available colors: `$ rbcat --print_colors`
 
-
-
 ##### Yaml config
-
 Correct yaml config should be convertible to the Ruby hash. Here is an example of Rbcat config in both Ruby hash and yaml:
 
 ```yaml
@@ -190,27 +173,20 @@ Correct yaml config should be convertible to the Ruby hash. Here is an example o
 }
 ```
 
-
-
 ### Using inside ruby project
-
 It's a good idea to use rbcat with logger, so you can configure logger with colorizer once and then use it to print info to the console everywhere in the ruby code.
 
 What we need to do is to [define formatter](http://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html#class-Logger-label-Format) for the logger, while creating one.
 
-
-
 ##### Using with a default ruby logger
-
-Here is the simple example:
-
+Here is a simple example:
 ```ruby
-require "logger"
-require "rbcat"
+require 'logger'
+require 'rbcat'
+require 'yaml'
 
 # configure rbcat first
 Rbcat.configure do |config|
-  require "yaml"
   config.rules = YAML.load_file(File.expand_path("rbcat_config.yaml"))
 end
 
@@ -218,22 +194,17 @@ end
 formatter = proc do |severity, datetime, progname, msg|
   # default ruby logger layout:
   output = "%s, [%s#%d] %5s -- %s: %s\n".freeze % [severity[0..0], datetime, $$, severity, progname, msg]
-  colorizer = Rbcat::Colorizer.new
-  colorizer.colorize(output)
+  Rbcat.colorize(output)
 end
 
 # logger instance
 logger = ::Logger.new(STDOUT, formatter: formatter)
-
 logger.info "Message to colorize"
 ```
 
-This is a nice example but almost isn't usable.  In the normal ruby project, there are many classes and we need somehow have access to ours colorized logger instance from everywhere.
-
-One of possible solutions is to use logger module and then include it to every class where we need it:
-
+Usually, there are many classes and we need somehow to have access to colorized logger instance from everywhere. For this we can define logger module and then include it to every class where we need it:
 ```ruby
-require "logger"
+require 'logger'
 
 module Log
   def logger
@@ -241,8 +212,7 @@ module Log
       ::Logger.new(STDOUT, formatter: proc { |severity, datetime, progname, msg|
         # default ruby logger layout
         output = "%s, [%s#%d] %5s -- %s: %s\n".freeze % [severity[0..0], datetime, $$, severity, progname, msg]
-        colorizer = Rbcat::Colorizer.new
-        colorizer.colorize(output)
+        Rbcat.colorize(output)
       })
     end
   end
@@ -259,13 +229,11 @@ end
 SomeClass.new.print_message("Colorized message")
 ```
 
-
-
-In the example above, we still need every time include Log module for every class. **There is another more convenient way**, using Log class with class logger methods:
+In the example above, we still need every time to include Log module for every class. **There is another more convenient way**, using Log class with logger class methods:
 
 ```ruby
-require "logger"
-require "forwardable"
+require 'logger'
+require 'forwardable'
 
 class Log
   class << self
@@ -277,8 +245,7 @@ class Log
         ::Logger.new(STDOUT, formatter: proc { |severity, datetime, progname, msg|
           # default ruby logger layout
           output = "%s, [%s#%d] %5s -- %s: %s\n".freeze % [severity[0..0], datetime, $$, severity, progname, msg]
-          colorizer = Rbcat::Colorizer.new(predefined: [:logger])
-          colorizer.colorize(output)
+          Rbcat.colorize(output, predefined: [:logger])
         })
       end
     end
@@ -291,20 +258,17 @@ end
 With this approach, you can use colorized logger everywhere in the code.
 
 
-
 ##### Using with other logger libraries
-
 [Logstash:](https://github.com/dwbutler/logstash-logger)
 
 ```ruby
-require "logstash-logger"
-require "rbcat"
+require 'logstash-logger'
+require 'rbcat'
 
 logger = begin
   formatter = proc { |severity, datetime, progname, msg|
     output = "%s, [%s#%d] %5s -- %s: %s\n".freeze % [severity[0..0], datetime, $$, severity, progname, msg]
-    colorizer = Colorizer.new
-    colorizer.colorize(output)
+    Rbcat.colorize(output)
   }
 
   LogStashLogger.new(type: :stdout, formatter: formatter)
@@ -314,20 +278,17 @@ logger.info "Info message to colorize"
 ```
 
 
-
 ##### Write clear log to the file and print colorized output to the console at the same time
-
 Suddenly, default ruby logger can't output info to the several sources at the same time. But it can do [Logstash](https://github.com/dwbutler/logstash-logger) for example:
 
 ```ruby
-require "logstash-logger"
-require "rbcat"
+require 'logstash-logger'
+require 'rbcat'
 
 logger = begin
   formatter = proc { |severity, datetime, progname, msg|
     output = "%s, [%s#%d] %5s -- %s: %s\n".freeze % [severity[0..0], datetime, $$, severity, progname, msg]
-    colorizer = Colorizer.new
-    colorizer.colorize(output)
+    Rbcat.colorize(output)
   }
 
   outputs = [
@@ -335,16 +296,12 @@ logger = begin
     { type: :file, formatter: ::Logger::Formatter }
   ]
 
-  LogStashLogger.new(type: :multi_logger, formatter: formatter, outputs: outputs)
+  LogStashLogger.new(type: :multi_logger, outputs: outputs)
 end
 ```
 
-
-
 ### Q&A
-
 ##### I have a problem with a printing delay to the console using rbcat CLI
-
 The same problem has [grcat](https://github.com/garabik/grc).
 
 Example:
@@ -353,34 +310,25 @@ Example:
 $ ruby -e "loop { puts 'INFO: This is info message'; sleep 0.1 }" | rbcat --predefined=logger
 ```
 
-This code should print _"INFO: This is info message"_ to the console every 0.1 seconds. But its don't, because of nature of STDOUT buffering. [Here is a great article](https://eklitzke.org/stdout-buffering) about it.
+This code should print _"INFO: This is info message"_ to the console every 0.1 seconds. But its doesn't, because of nature of STDOUT buffering. [Here is a great article](https://eklitzke.org/stdout-buffering) about it.
 
 One of possible solutions is to use **[unbuffer](https://linux.die.net/man/1/unbuffer)** tool (`sudo apt install expect` for ubuntu):
 
 ```bash
 $ unbuffer ruby -e "loop { puts 'INFO: This is info message'; sleep 0.1 }" | rbcat --predefined=logger
 ```
-
 Now message prints to the console every 0.1 seconds without any delay.
 
-
-
 ##### I don't like colors which colorizer prints
-
-Colorizer uses [standard ANSI escape color codes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors), but each terminal can have an individual color palette. You can install additional color schemes, [here](https://github.com/Mayccoll/Gogh) for example [themes](https://github.com/denysdovhan/one-gnome-terminal) for Gnome terminal.
-
+Colorizer uses [standard ANSI escape color codes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors), but each terminal can have an individual color palette. You can install additional color schemes, [here](https://github.com/Mayccoll/Gogh) for example [themes](https://github.com/denysdovhan/one-gnome-terminal) for a Gnome terminal.
 
 
 ##### I want to temporary disable colorizer
-
 Define environment variable `RBCAT_COLORIZER` with value `false`. Or use `RBCAT_COLORIZER=false` as the first parameter of command:
 
 ```bash
 $ RBCAT_COLORIZER=false ruby grcat_example.rb
 ```
 
-
-
 ### License
-
 MIT

data/lib/rbcat.rb

@@ -1,7 +1,12 @@
 require "rbcat/version"
-require "rbcat/configuration_error"
 require "rbcat/configuration"
 require "rbcat/colors"
 require "rbcat/rules"
 require "rbcat/colorizer"
 require "rbcat/cli"
+
+module Rbcat
+  def self.colorize(string, options = {})
+    Colorizer.colorize(string, options)
+  end
+end

data/lib/rbcat/cli.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
-require "optparse"
+require 'optparse'
+require 'yaml'
 
 module Rbcat
   class CLI
     def self.start(args)
       options = parse_options(args)
-      colorizer = create_colorizer(options)
+      colorizer_options = create_colorizer_options(options)
 
       while input = STDIN.gets
         input.each_line do |line|
           begin
-            puts colorizer.colorize(line)
+            puts Rbcat.colorize(line, colorizer_options)
           rescue Errno::EPIPE
             exit(74)
           end
@@ -19,16 +20,13 @@ module Rbcat
       end
     end
 
-    private_class_method
-
-    def self.create_colorizer(options)
+    private_class_method def self.create_colorizer_options(options)
       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
-            require "yaml"
             YAML.load_file(file_path)
           end
         end
@@ -36,10 +34,10 @@ module Rbcat
       predefined = options[:predefined]
       order = options[:order]
 
-      Colorizer.new(predefined: predefined, rules: rules, order: order)
+      { predefined: predefined, rules: rules, order: order }
     end
 
-    def self.parse_options(args)
+    private_class_method def self.parse_options(args)
       options = {}
 
       args.push("-h") if args.empty?

data/lib/rbcat/colorizer.rb

@@ -6,15 +6,13 @@ module Rbcat
       end
     end
 
-    def initialize(predefined: nil, rules: nil, order: nil)
-      @config = create_config(predefined, rules, order)
-    end
-
-    def colorize(string)
+    def self.colorize(string, predefined: nil, rules: nil, order: nil)
       return string if ENV["RBCAT_COLORIZER"] == "false"
 
       colors = Rbcat::Colors::DEFAULT
-      @config.each_value do |settings|
+      config = create_config(predefined, rules, order)
+
+      config.each_value do |settings|
         if settings[:once]
           string.sub!(settings[:regexp]) do |match|
             colors[settings[:color]] + match + colors[:default]
@@ -38,14 +36,12 @@ module Rbcat
       string
     end
 
-    def uncolorize(string)
+    def self.uncolorize(string)
       pattern = /\033\[([0-9]+);([0-9]+)m|\033\[([0-9]+)m/m
       string.gsub(pattern, "")
     end
 
-    private
-
-    def create_config(predefined, rules, order)
+    private_class_method def self.create_config(predefined, rules, order)
       predefined_rules = predefined ? predefined : Rbcat.configuration&.predefined
       rules ||= Rbcat.configuration&.rules
 
@@ -79,7 +75,7 @@ module Rbcat
       end
     end
 
-    def deep_merge(hash, other_hash)
+    private_class_method def self.deep_merge(hash, other_hash)
       other_hash.each_pair do |current_key, other_value|
         this_value = hash[current_key]
         hash[current_key] =

data/lib/rbcat/colors.rb

@@ -19,6 +19,15 @@ module Rbcat
       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_magenta: "\033[1;35m",
+      bold_cyan:    "\033[1;36m",
+      bold_white:   "\033[1;37m",
+
       on_black:   "\033[40m",
       on_red:     "\033[41m",
       on_green:   "\033[42m",

data/lib/rbcat/configuration.rb

@@ -1,4 +1,6 @@
 module Rbcat
+  class ConfigurationError < StandardError; end
+
   class << self
     attr_accessor :configuration
   end

data/lib/rbcat/rules.rb

@@ -29,22 +29,27 @@ module Rbcat
 
     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,
+        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,3 @@
 module Rbcat
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbcat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Victor Afanasev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,7 +60,6 @@ files:
 - lib/rbcat/colorizer.rb
 - lib/rbcat/colors.rb
 - lib/rbcat/configuration.rb
-- lib/rbcat/configuration_error.rb
 - lib/rbcat/rules.rb
 - lib/rbcat/version.rb
 - rbcat.gemspec
@@ -84,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Colorize output by defined set of regex rules

data/lib/rbcat/configuration_error.rb

@@ -1,3 +0,0 @@
-module Rbcat
-  ConfigurationError = Class.new(StandardError)
-end