pretty_logger 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de26eada3a4365d89821cd2097a08193907e4e423396df9ca5f6ed3e5ef513dc
-  data.tar.gz: 0a9c56ace96ab075c1792ef01a4149a50c599eb069b5781669f714026c3678c7
+  metadata.gz: 2dffc0a00043f3c8cdd85dbf8357c14056635577225f2e85d608e4f8cdcd62e0
+  data.tar.gz: ba73d0d550463108a0d0f8d1a049bb6cb8a97a7b708d3569b46be3bd7da9431e
 SHA512:
-  metadata.gz: 30848208db020360ac6612fc0b9410c6d281ba67d6abe41a2c62a06252f3f3f05d46a30aa6d9950507c2936fbed2bb09387a6e8e2b29569f832a1569a2deb405
-  data.tar.gz: 2afefaec6fcabfa73d41e8542aa04eddbce676ebf30d152bdfe413d75e5b4e51ff24ced2218ebd4918895fc0712c574549ef4860c6182efa53716d3f203aa4a3
+  metadata.gz: 746a7712134dc57153a6fa6ddca97a42bb5f2be6aeb79df7340903ef100f584331cc5d0c16127eaeafb75c62ee78392871f98b1278f6cfdf9ff332d42756aa51
+  data.tar.gz: 2cb1701efb5d9c66d44727aed1074c566253902336a4c03c0e921c61b297c20a92d2b785b988fa2c592f5a45a57fb28de5a27c1987356cdacc83b0cd69342c51

data/README.md

@@ -29,6 +29,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 - [ ] Add a config that can be set in an initializer for accessing user and prettifying in logs
 - [ ] Customize location of custom_log file
 - [ ] Don't auto-hijack errors, should need to add that manually?
+- [ ] Don't require Rails- should be able to include in a basic Ruby project just as easily
 
 ## License
 

data/lib/pretty_logger/pretty_logger.rb

@@ -0,0 +1,121 @@
+module PrettyLogger
+  module_function
+
+  def instance
+    @instance ||= ::ActiveSupport::Logger.new("log/custom.log")
+  end
+
+  def timestamp
+    Time.current.in_time_zone("Mountain Time (US & Canada)").strftime("[%b %d, %I:%M:%S%P]")
+  end
+
+  def pretty_message(obj)
+    return obj if obj.is_a?(::String)
+
+    ::CodeRay.scan(obj, :ruby).terminal.gsub(
+      /\e\[36m:(\w+)\e\[0m=>/i, ("\e[36m" + '\1: ' + "\e[0m") # hashrocket(sym) to colon(sym)
+    ).gsub(
+      /\e\[0m=>/, "\e[0m: " # all hashrockets to colons
+    )
+  end
+
+  def debug(*messages)
+    instance.debug("\e[90m#{timestamp}\e[90m[DEBUG]\e[0m " + messages.map { |m| pretty_message(m) }.join("\n"))
+  end
+
+  def info(*messages)
+    instance.info("\e[90m#{timestamp}\e[36m[INFO]\e[0m " + messages.map { |m| pretty_message(m) }.join("\n"))
+  end
+
+  def warn(*messages)
+    instance.warn("\e[90m#{timestamp}\e[38;5;208m[WARN]\e[0m " + messages.map { |m| pretty_message(m) }.join("\n"))
+  end
+
+  def error(*messages)
+    instance.error("\e[90m#{timestamp}\e[31m[ERROR]\e[0m " + messages.map { |m| pretty_message(m) }.join("\n"))
+  end
+
+  def cl
+    "\033[0m"
+  end
+
+  def rgb(r, g, b)
+    "\033[38;2;#{r};#{g};#{b}m"
+  end
+
+  def colorize(name, text)
+    return "" if text.blank?
+    "#{colors[name]}#{text}#{cl}"
+  end
+
+  def colors
+    {
+      black:   rgb(0, 0, 0),
+      white:   rgb(255, 255, 255),
+      lime:    rgb(0, 255, 0),
+      red:     rgb(255, 0, 0),
+      blue:    rgb(0, 0, 255),
+      yellow:  rgb(255, 255, 0),
+      cyan:    rgb(0, 255, 255),
+      magenta: rgb(255, 0, 255),
+      gold:    rgb(218, 165, 32),
+      silver:  rgb(192, 192, 192),
+      grey:    rgb(150, 150, 150),
+      maroon:  rgb(128, 0, 0),
+      olive:   rgb(128, 128, 0),
+      green:   rgb(0, 128, 0),
+      purple:  rgb(128, 0, 128),
+      teal:    rgb(0, 128, 128),
+      navy:    rgb(0, 0, 128),
+      rocco:   rgb(1, 96, 255),
+      orange:  rgb(255, 150, 0),
+      pink:    rgb(255, 150, 150),
+    }
+  end
+
+  def focused_backtrace(trace)
+    return [] unless trace
+    trace.select { |line|
+      line.include?("/app/")
+    }.map { |line|
+      line.gsub(/^.*?#{Rails.root}/, "").gsub(/(app)?\/app\//, "app/").gsub(":in `", " `").gsub(/(:\d+) .*?$/, '\1')
+    }
+  end
+
+  def clean_message(message)
+    message.gsub(/\#\<([\w\:]+)( id: \d+)?.*?\>\n/im) { |found|
+      "#<#{Regexp.last_match(1)}#{Regexp.last_match(2)}>\n"
+    }
+  end
+
+  def truncate(input, max_visible_length=2000, with: "...")
+    full = input.length
+    return input if full <= max_visible_length
+
+    clean = input.gsub(/\e\[[\d;]*[a-z]/i, "").length
+    return input if clean <= max_visible_length
+
+    max_visible_length -= with.gsub(/\e\[[\d;]*[a-z]/i, "").length
+
+    visible_length = 0
+    truncated_string = ""
+
+    input.scan(/(\e\[[\d;]*[a-z]|[^\e]+)/i) do |match|
+      part = match[0]
+      if part.match?(/\e\[[\d;]*[a-z]/i) # Match ANSI escape sequences
+        truncated_string += part # Do not add to the count
+      else
+        part.each_char do |char|
+          if visible_length < max_visible_length
+            truncated_string += char
+            visible_length += 1
+          else
+            break
+          end
+        end
+      end
+    end
+
+    "#{truncated_string}#{with}"
+  end
+end

data/lib/pretty_logger/request_logger.rb

@@ -1,4 +1,5 @@
-class PrettyLogger::RequestLogger < PrettyLogger::BaseLogger
+class PrettyLogger::RequestLogger
+  include PrettyLogger
   attr_accessor :request, :current_user
 
   def initialize(request:nil, current_user:nil)
@@ -7,17 +8,16 @@ class PrettyLogger::RequestLogger < PrettyLogger::BaseLogger
   end
 
   def log_request(extra_text=nil)
-    # Nothing change
-    ::PrettyLogger::BaseLogger.info([
+    info([
       "#{pretty_user} #{request.method.upcase} #{request.path} #{extra_text}",
-      params.blank? ? nil : ::PrettyLogger::BaseLogger.pretty_message(params).truncate(2000),
+      params.blank? ? nil : truncate(pretty_message(params)),
     ].compact.join("\n"))
   end
 
   def log_error(exception)
-    ::PrettyLogger::BaseLogger.error([
+    error([
       "#{pretty_user} #{request.path} #{colorize(:red, exception.class)}",
-      params.blank? ? nil : ::PrettyLogger::BaseLogger.pretty_message(params).truncate(2000),
+      params.blank? ? nil : truncate(pretty_message(params)),
       colorize(:red, focused_backtrace(exception.backtrace).first),
       colorize(:red, clean_message("#{exception.class} #{exception.message}")),
     ].compact.join("\n"))

data/lib/pretty_logger/version.rb

@@ -1,3 +1,3 @@
-module PrettyLogger
-  VERSION = "1.1.4"
+class PrettyLogger
+  VERSION = "1.2.0"
 end

data/lib/pretty_logger.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "pretty_logger/version"
+require_relative "pretty_logger/pretty_logger"
 require_relative "pretty_logger/override_console_colors"
-require_relative "pretty_logger/base_logger"
 require_relative "pretty_logger/request_logger"
 require_relative "pretty_logger/controller_methods"
 require_relative "pretty_logger/railtie" if defined?(Rails)

data/pretty_logger.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/pretty_logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "pretty_logger"
+  spec.version = PrettyLogger::VERSION
+  spec.authors = ["Rocco Nicholls"]
+  spec.email = ["rocco11nicholls@gmail.com"]
+
+  spec.summary = "Quick logger that lets you output to a different log file for more controlled breakdowns of site visits."
+  spec.description = "Quick logger that lets you output to a different log file for more controlled breakdowns of site visits"
+  spec.homepage = "https://github.com/Rockster160/pretty_logger"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Rockster160/pretty_logger"
+  spec.metadata["changelog_uri"] = "https://github.com/Rockster160/pretty_logger/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{\A(?:bin/|test/|spec/|features/|\.git|\.circleci/|appveyor\.yml)})
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "coderay", "~> 1.1.3"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pretty_logger
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Rocco Nicholls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2024-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
@@ -41,12 +41,13 @@ files:
 - README.md
 - Rakefile
 - lib/pretty_logger.rb
-- lib/pretty_logger/base_logger.rb
 - lib/pretty_logger/controller_methods.rb
 - lib/pretty_logger/override_console_colors.rb
+- lib/pretty_logger/pretty_logger.rb
 - lib/pretty_logger/railtie.rb
 - lib/pretty_logger/request_logger.rb
 - lib/pretty_logger/version.rb
+- pretty_logger.gemspec
 - sig/pretty_logger.rbs
 homepage: https://github.com/Rockster160/pretty_logger
 licenses:

data/lib/pretty_logger/base_logger.rb

@@ -1,95 +0,0 @@
-# debug
-# info
-# warn
-# error
-
-class PrettyLogger::BaseLogger < ActiveSupport::Logger
-  class << self
-    def instance
-      @instance ||= new("log/custom.log")
-    end
-
-    def timestamp
-      Time.current.in_time_zone("Mountain Time (US & Canada)").strftime("[%b %d, %I:%M:%S%P]")
-    end
-
-    def pretty_message(obj)
-      return obj if obj.is_a?(::String)
-
-      ::CodeRay.scan(obj, :ruby).terminal.gsub(
-        /\e\[36m:([a-z]+)\e\[0m=>/i, ("\e[36m" + '\1: ')
-      ).gsub(
-        /\e\[0m=>/, "\e[0m: "
-      )
-    end
-
-    def debug(message)
-      instance.debug("\e[90m#{timestamp}\e[90m[DEBUG]\e[0m #{pretty_message(message)}")
-    end
-
-    def info(message)
-      instance.info("\e[90m#{timestamp}\e[36m[INFO]\e[0m #{pretty_message(message)}")
-    end
-
-    def warn(message)
-      instance.warn("\e[90m#{timestamp}\e[38;5;208m[WARN]\e[0m #{pretty_message(message)}")
-    end
-
-    def error(message)
-      instance.error("\e[90m#{timestamp}\e[31m[ERROR]\e[0m #{pretty_message(message)}")
-    end
-  end
-
-  def cl
-    "\033[0m"
-  end
-
-  def rgb(r, g, b)
-    "\033[38;2;#{r};#{g};#{b}m"
-  end
-
-  def colorize(name, text)
-    return "" if text.blank?
-    "#{colors[name]}#{text}#{cl}"
-  end
-
-  def colors
-    {
-      black:   rgb(0, 0, 0),
-      white:   rgb(255, 255, 255),
-      lime:    rgb(0, 255, 0),
-      red:     rgb(255, 0, 0),
-      blue:    rgb(0, 0, 255),
-      yellow:  rgb(255, 255, 0),
-      cyan:    rgb(0, 255, 255),
-      magenta: rgb(255, 0, 255),
-      gold:    rgb(218, 165, 32),
-      silver:  rgb(192, 192, 192),
-      grey:    rgb(150, 150, 150),
-      maroon:  rgb(128, 0, 0),
-      olive:   rgb(128, 128, 0),
-      green:   rgb(0, 128, 0),
-      purple:  rgb(128, 0, 128),
-      teal:    rgb(0, 128, 128),
-      navy:    rgb(0, 0, 128),
-      rocco:   rgb(1, 96, 255),
-      orange:  rgb(255, 150, 0),
-      pink:    rgb(255, 150, 150),
-    }
-  end
-
-  def focused_backtrace(trace)
-    return [] unless trace
-    trace.select { |line|
-      line.include?("/app/")
-    }.map { |line|
-      line.gsub(/^.*?#{Rails.root}/, "").gsub(/(app)?\/app\//, "app/").gsub(":in `", " `").gsub(/(:\d+) .*?$/, '\1')
-    }
-  end
-
-  def clean_message(message)
-    message.gsub(/\#\<([\w\:]+)( id: \d+)?.*?\>\n/im) { |found|
-      "#<#{Regexp.last_match(1)}#{Regexp.last_match(2)}>\n"
-    }
-  end
-end