clickable_logger 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5aab30a3ed08fd243495a540006b36829dfb64ef625de5b8f354e9d8ba6c9a16
+  data.tar.gz: 2d0b246a1f3b7547bdb90b37f3ce7cd6684456565e2560380321cecf96c87189
+SHA512:
+  metadata.gz: fb611085d3f5d501fe75ee16b07abbaf17f518c461b4f6251594d6628640ed7964dc74d96cb6540d226ddfd051eacc2abc820315bef33257e34be7ed124c8fc2
+  data.tar.gz: d764f5923b31c64ff49263005b24b059ea8e3dff05b723ceb081defa74fb475eac44f6f9f951b12b188508c2a75b20d04d52b05ad7bfebc4f45eb90f635e1e37

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Kasvit
+
+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,65 @@
+# ClickableLogger
+
+Increase your productivity in 30 seconds.
+
+ClickableLogger is a Rails logger formatter that makes it easy to navigate to the code from the logs.
+
+And now you can click "Cmd+Click" on the log message to open the file in your editor.
+
+## Before & After
+
+Before:
+
+![Before](./docs/before.png)
+
+After:
+
+![After](./docs/after.png)
+
+## Usage
+
+30 seconds to get started:
+
+1. Install the gem
+2. Generate the initializer
+3. Start the server
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "clickable_logger", group: :development
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Configuration
+
+```bash
+rails g clickable_logger:install
+```
+
+This will create a `config/initializers/clickable_logger.rb` file.
+
+## Testing
+
+Run tests with:
+```bash
+bin/test
+```
+
+## Contributing
+
+You are welcome to contribute to the project.
+
+Some ideas:
+
+- more matchers
+- more tests
+
+## License
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/clickable_logger/formatter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ClickableLogger
+  module Formatter
+    OSC_LINK_PREFIX = "\e]8;;"
+
+    def call(severity, timestamp, progname, msg)
+      text = super(severity, timestamp, progname, msg)
+
+      # Skip if already hyperlinked
+      return text if text.include?(OSC_LINK_PREFIX)
+
+      # Apply matchers
+      ClickableLogger.matchers.reduce(text) do |curr, matcher|
+        matcher.match?(curr) ? matcher.process(curr) : curr
+      end
+    end
+  end
+end

data/lib/clickable_logger/matcher.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ClickableLogger
+  class Matcher
+    def match?(_msg)
+      false
+    end
+
+    def process(msg, _config)
+      msg
+    end
+  end
+end

data/lib/clickable_logger/matchers/view_matcher.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ClickableLogger
+  module Matchers
+    class ViewMatcher < Matcher
+      VIEW_REGEX = /(?:Rendering|Rendered)\s+(?:layout\s+)?(?<file>\S+?\.[^\s]+)/.freeze
+
+      def match?(msg)
+        msg =~ VIEW_REGEX
+      end
+
+      def process(msg)
+        msg.gsub(VIEW_REGEX) do |match|
+          file = Regexp.last_match[:file]
+          # all views are in <controller>/<action>.html.erb
+          full_path = file.include?("/") ? ClickableLogger.code_path.find { |path| path.end_with?(file) } : nil
+          full_path ? match.sub(file, full_path) : match
+        end
+      end
+    end
+  end
+end

data/lib/clickable_logger/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ClickableLogger
+  class Railtie < ::Rails::Railtie
+    initializer "clickable_logger.configure_logger" do |app|
+      ClickableLogger.code_path = Dir.glob("#{Rails.root}/app/**/*.*").map { |p| p.gsub("#{Rails.root}/", "") }
+    end
+  end
+end

data/lib/clickable_logger/version.rb

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

data/lib/clickable_logger.rb

@@ -0,0 +1,20 @@
+require "clickable_logger/version"
+require "clickable_logger/railtie"
+require "clickable_logger/matcher"
+require "clickable_logger/matchers/view_matcher"
+require "clickable_logger/formatter"
+
+module ClickableLogger
+  # this will be set by the railtie
+  mattr_accessor :code_path # Rails.root/app/**/*.*
+
+  mattr_accessor :matchers
+  @@matchers = [
+    Matchers::ViewMatcher.new
+  ]
+
+  # for the future
+  def self.configure
+    yield self
+  end
+end

data/lib/generators/clickable_logger/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ClickableLogger
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_initializer
+        template "clickable_logger.rb", "config/initializers/clickable_logger.rb"
+      end
+    end
+  end
+end

data/lib/generators/clickable_logger/templates/clickable_logger.rb

@@ -0,0 +1,5 @@
+# extend the logger formatter to add clickable links to the log messages
+
+if defined?(ClickableLogger)
+  Rails.logger.formatter.class.send(:prepend, ClickableLogger::Formatter)
+end

data/lib/tasks/clickable_logger_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :clickable_logger do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: clickable_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kasvit
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Clickable logger for Rails logs in your editor
+email:
+- kasvit93@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/clickable_logger.rb
+- lib/clickable_logger/formatter.rb
+- lib/clickable_logger/matcher.rb
+- lib/clickable_logger/matchers/view_matcher.rb
+- lib/clickable_logger/railtie.rb
+- lib/clickable_logger/version.rb
+- lib/generators/clickable_logger/install_generator.rb
+- lib/generators/clickable_logger/templates/clickable_logger.rb
+- lib/tasks/clickable_logger_tasks.rake
+homepage: https://github.com/kasvit/clickable_logger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kasvit/clickable_logger
+  source_code_uri: https://github.com/kasvit/clickable_logger
+  changelog_uri: https://github.com/kasvit/clickable_logger/blob/main/CHANGELOG.md
+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.1.6
+signing_key:
+specification_version: 4
+summary: Clickable logger for Rails
+test_files: []