colorize_logs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 24e8012a066cd6081ce2a0592902ad8151fb91c0a185dd7a49ff1e4e0d3bec05
+  data.tar.gz: 4099845270390945e81efffe62a91d03956bf0b31718e3b55fb84f49f40098ae
+SHA512:
+  metadata.gz: f3aae37ae8779812e3df956b908578f5fc622284cec397f2d532e22338f6310005d87dcd26241bf918b92f6b2f56fb4e55224b0d36d444ec2738ff21380e6157
+  data.tar.gz: ca5a5a6226022f9907bef2830c4262af3ddce93b65812cb3ca92c6bd844d52b10fe9cfb0414112dc215bb464d1c1d68c03ee25aa7e3c5ba031dfe18e09a8cb54

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Santosh Wadghule
+
+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,83 @@
+# ColorizeLogs
+
+As developers, we often deal with current controller's action, its main view page and the layout associated with it. To
+trace and debug these logs information, we check the logs through our console.
+
+However, by default, the logs are all in the same color, which makes it difficult to find the ones which we're working
+on. To simplify our lives and speed up the debugging process, we want to assign different colors to these logs.
+This will make it much easier for us to spot the right information and save time when we're fixing issues and improving
+our software.
+
+To ease our development time, we can use this gem. It will colorize the logs for controller's action, view, layout,
+and etc.
+
+![colorize_logs](https://user-images.githubusercontent.com/77895/270565495-a75fc46d-b574-4fbe-9976-998abbf0b7b7.png)
+
+[![Build Status](https://github.com/mechanicles/colorize_logs/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/mechanicles/colorize_logs/actions)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+group :development do
+  gem "colorize_logs"
+end
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install colorize_logs
+
+## Usage
+
+Create an initializer file `config/initializers/colorize_logs.rb` and add the following code:
+
+```ruby
+# frozen_string_literal: true
+
+colorize_logs_formatter = ColorizeLogs::Formatter.new
+
+colorize_logs_formatter.configure do
+  match(/Processing by/) do |msg|
+    msg.red
+  end
+
+  match(/Rendering layout/) do |msg|
+    msg.green
+  end
+
+  match(/Rendering.*within layouts/) do |msg|
+    msg.green
+  end
+end
+
+::Rails.logger.formatter = colorize_logs_formatter
+```
+
+That's it. Restart your server and you should see the logs in different colors.
+
+
+## Credits
+
+This gem is inspired by [Shog](https://github.com/phallguy/shog) gem. All the credits goes to the author of Shog gem.
+I had to create this one as original gem is not maintained anymore and I wanted minimal stuff from it.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the 
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, 
+push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mechanicles/colorize_logs. This project is 
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 
+[code of conduct](https://github.com/mechanicles/colorize_logs/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/colorize_logs/formatter.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "active_support/tagged_logging"
+require "colorize"
+
+module ColorizeLogs
+  # Custom formatter for Rails logger
+  class Formatter < ActiveSupport::Logger::SimpleFormatter
+    include ActiveSupport::TaggedLogging::Formatter
+
+    def initialize
+      super
+
+      @matchers = {}
+    end
+
+    def configure(&block)
+      instance_eval(&block)
+      self
+    end
+
+    def call(severity, time, progname, msg)
+      return if msg.blank?
+
+      msg = colorize_message(msg)
+
+      super(severity, time, progname, msg)
+    end
+
+    private
+
+    def colorize_message(msg)
+      msg = msg.is_a?(String) ? msg : msg.inspect
+
+      proc = find_matching_pattern(msg)
+
+      proc ? proc.call(msg) : msg
+    end
+
+    def find_matching_pattern(msg)
+      matcher = @matchers.find { |pattern, _| pattern.match(msg) }
+
+      matcher&.last
+    end
+
+    def match(pattern, proc = nil, &block)
+      proc ||= block
+      @matchers[pattern] = proc
+      self
+    end
+  end
+end

data/lib/colorize_logs/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ColorizeLogs
+  VERSION = "0.1.0"
+end

data/lib/colorize_logs.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "colorize_logs/version"
+require_relative "colorize_logs/formatter"
+
+module ColorizeLogs
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: colorize_logs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Santosh Wadghule
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- santosh.wadghule@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/colorize_logs.rb
+- lib/colorize_logs/formatter.rb
+- lib/colorize_logs/version.rb
+homepage: https://github.com/mechanicles/colorize_logs
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Colorize your Rails logs
+test_files: []