mongo_beautiful_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ffe8310478e9f97b296a0b367d4bdc69354e3fe22b549c0f7776695bcc449bd
+  data.tar.gz: 739e2a0047a1743ed4545a819437dcb4a71cbdda1a3d44e9cb3b9529dc934ae1
+SHA512:
+  metadata.gz: 5ff6bd925008f5b36d431029f021e5f68dc4a0cfe980872aa9f674c640c2e6ecc4770881f17818b42371599520ca6999990ce6fa46c3bdd6a9ac808c6c67153d
+  data.tar.gz: 21cbb10c42f10f9d96470d44d7afb60ce3d5518a939a08fe47c2bd1be58d8ada24a795c13c08891db1c6e6dfe7c2d851070142c42f02f58e073a52d72605cbeb

data/lib/mongo_beautiful_logger.rb

@@ -0,0 +1,57 @@
+require "mongo_beautiful_logger/colors"
+require "mongo_beautiful_logger/mongo_actions"
+require "logger"
+
+class MongoBeautifulLogger
+  include MongoActions
+  include Colors
+
+  def initialize(logger = Logger.new($stdout))
+    @logger = format_logger(logger)
+  end
+
+  private
+
+  # filters out default logger prompt of:
+  # +d, [2020-06-20 14:02:29#17329] INFO -- MONGODB:+
+  def format_logger(logger)
+    logger.formatter = proc { |severity, datetime, progname, msg| "#{msg}" }
+    logger
+  end
+
+  # define custom logger methods
+  # call formatting methods, and then send message string back to the logger instance
+  %w(debug info warn error fatal unknown).each do |level|
+    class_eval <<-RUBY
+      def #{level}(msg = nil, &block)
+        msg = colorize_log(msg)
+        msg = filter_unnecessary(msg)
+        @logger.#{level}(msg, &block)
+      end
+    RUBY
+  end
+
+  # colorize messages that are specified in ACTIONS constant
+  def colorize_log(msg)
+    ACTIONS.each { |a| msg = color(msg, a[:color]) if msg.downcase.include?(a[:match]) }
+    msg
+  end
+
+  # filter out any unnecessary messages
+  def filter_unnecessary(msg)
+    UNNECESSARY.any? { |s| msg.downcase.include? s } ? "" : "#{msg.sub(PREFIX_REGEX, "|")}\n"
+  end
+
+  # send all other methods back to logger instance
+  def method_missing(method, *args, &block)
+    @logger.send(method, *args, &block)
+  end
+
+  # set color based one the defined constants. 
+  # If a third option is set to +true+, the string will be made bold. 
+  # CLEAR to the is automatically appended to the string for reset
+  def color(text, color, bold = false)
+    bold = bold ? BOLD : ""
+    "#{bold}#{color}#{text}#{CLEAR}"
+  end
+end

data/lib/mongo_beautiful_logger/colors.rb

@@ -0,0 +1,13 @@
+module Colors
+  # ANSI escape sequences for outputting colored logs
+  WHITE     = "\e[37m"
+  CYAN      = "\e[36m"
+  MAGENTA   = "\e[35m"
+  BLUE      = "\e[34m"
+  YELLOW    = "\e[33m"
+  GREEN     = "\e[32m"
+  RED       = "\e[31m"
+  BLACK     = "\e[30m"
+  BOLD      = "\e[1m"
+  CLEAR     = "\e[0m"
+end

data/lib/mongo_beautiful_logger/mongo_actions.rb

@@ -0,0 +1,27 @@
+require "mongo_beautiful_logger/colors"
+
+module MongoActions
+  include Colors
+
+  # substring matches and the corresponding colors for mongodb actions
+  FIND         = { match: "\"find\"=>",        color: BLUE }
+  UPDATE       = { match: "\"update\"=>",      color: YELLOW }
+  INSERT       = { match: "\"insert\"=>",      color: GREEN }
+  DELETE       = { match: "\"delete\"=>",      color: RED }
+  AGGREGATE    = { match: "\"aggregate\"=>",   color: MAGENTA }
+  SUCCEEDED    = { match: "succeeded",         color: GREEN }
+  FAILED       = { match: "failed",            color: RED }
+  ERROR        = { match: "error",             color: RED }
+  ENDSESSION   = { match: "\"endsessions\"=>", color: YELLOW }
+  ACTIONS      = [ FIND, UPDATE, INSERT, DELETE, AGGREGATE, 
+                   SUCCEEDED, FAILED, ERROR, ENDSESSION ]
+  
+  # substring matches for unnecessary log messages that will be filtered out
+  UNNECESSARY  = ["opology", "server description"]
+
+  # regex for for the log prefix that will be filtered out
+  # matches: +| localhost:27017 | app_test.update | STARTED |+
+  # note: +| STARTED |+ and +| SUCCEEDED |+ will be filtered due to redundancy
+  # but +| FAILED |+ and others will not
+  PREFIX_REGEX = /\|.*?\|.*?\|( (SUCCEEDED|STARTED) \|)?/
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: mongo_beautiful_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ibraheem Ahmed
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description:
+email:
+- ibrah1440@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mongo_beautiful_logger.rb
+- lib/mongo_beautiful_logger/colors.rb
+- lib/mongo_beautiful_logger/mongo_actions.rb
+homepage: https://github.com/redline-gh/mongo_beautiful_logger
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: A simple and beautiful logger for MongoDB/Mongoid in you Ruby/Rails app.
+test_files: []