log_bench 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6190e59783385726fb1b48af6daf05113619df53ab0f614927e40850fdb69d71
-  data.tar.gz: fb9dad6de4675da021d49f9b2c6bf41e387b8bbbd7ae2637fa3345f7beb19682
+  metadata.gz: a57123bfa08abee40fdc9363b06794efddadd123c8b406fd8b6aea876f409d59
+  data.tar.gz: a0758d01ff5b148520a8d0ef02d6581641159b6065a3a04b61af0a3e15ca6f78
 SHA512:
-  metadata.gz: '02058887b5e6192622b8397d163b53d9be4cf1b73b192a216284e40941b5833e7e485d144fe00c21c76face673e5c67036467ed28eaae95842109b81cce2b7b5'
-  data.tar.gz: 5722c117f9eb0962007d0d21d8c38a3039df687b792cf9899531acfa438c3ac279637e2256bc6a04d5847634d52e386e18e7b1119c6c2278626ca09432660f3f
+  metadata.gz: e12b109df49933594454cf64aa0be3c6e345a1d0cbef3cc26fcd9b727f4c8dc181fefa332ad125f55cd9da2b0628c237315ac42c4fba751ba11e507dc6afa91c
+  data.tar.gz: c7c7d879edd623746f3b6a92ce8dd7a294a6c0c5a501ca985d71dc7b0fbe94c02e37393f543468531faa07122a3bacf1b008bee1a288948da8d1d00ec358721f

data/README.md

@@ -32,61 +32,65 @@ bundle install
 
 ## Configuration
 
-### 1. Configure Rails Logging
+LogBench is **automatically enabled in development environment** for backward compatibility. This gem heavily relies on [lograge](https://github.com/roidrage/lograge) gem for request tracking, we add lograge to your Rails application and configure it automatically, but you can also configure lograge manually if you want.
 
-Add this configuration to your `config/environments/development.rb`:
+### Default Behavior
 
-```ruby
-# config/environments/development.rb
-require "lograge"
+LogBench works out of the box! Just add the gem and restart your Rails server.
 
-Rails.application.configure do
-  # ... other configuration ...
+It automatically configures:
+- Lograge with JSON formatter and custom options
+- Rails logger with LogBench::JsonFormatter
+- Request ID tracking via LogBench::Current
+- Automatic injection of request_id into ApplicationController
 
-  # LogBench: Configure structured logging
-  config.lograge.enabled = true
-  config.lograge.formatter = Lograge::Formatters::Json.new
-  config.log_bench.show_init_message = :full # or :min or :none
-  config.lograge.custom_options = lambda do |event|
-    params = event.payload[:params]&.except("controller", "action")
-    { params: params } if params.present?
-  end
-  config.logger ||= ActiveSupport::Logger.new(config.default_log_file)
-  config.logger.formatter = LogBench::JsonFormatter.new
-end
-```
+No configuration needed in development!
 
-### 2. Set Up Request ID Tracking
+### Custom Configuration (Optional)
 
-Create or update your `Current` model to track request IDs:
+To customize LogBench behavior, create `config/initializers/log_bench.rb`:
 
 ```ruby
-# app/models/current.rb
-# frozen_string_literal: true
+# config/initializers/log_bench.rb
+LogBench.setup do |config|
+  # Enable/disable LogBench (default: true in development, false elsewhere)
+  config.enabled = Rails.env.development? # or any other condition
+
+  # Disable automatic lograge configuration (if you want to configure lograge manually)
+  # config.configure_lograge_automatically = false  # (default: true)
 
-class Current < ActiveSupport::CurrentAttributes
-  attribute :request_id
+  # Customize initialization message
+  # config.show_init_message = :min # :full, :min, or :none (default: :full)
+
+  # Specify which controllers to inject request_id tracking
+  # config.base_controller_classes = %w[CustomBaseController] # (default: %w[ApplicationController, ActionController::Base])
 end
 ```
 
-Add request ID tracking to your ApplicationController:
+### Manual Lograge Configuration
+
+If you already have lograge configured or want to manage it manually:
 
 ```ruby
-# app/controllers/application_controller.rb
-class ApplicationController < ActionController::Base
-  before_action :set_current_request_identifier
+# config/initializers/log_bench.rb
+LogBench.setup do |config|
+  # ... other config ...
+  config.configure_lograge_automatically = false  # Don't touch my lograge config!
+end
 
-  protected
+# Then configure lograge yourself in config/environments/development.rb or an initializer, 
 
-  def set_current_request_identifier
-    Current.request_id = request.request_id
+Rails.application.configure do
+  config.lograge.enabled = true
+  config.lograge.formatter = Lograge::Formatters::Json.new
+  config.lograge.custom_options = lambda do |event|
+    # Your custom lograge configuration
+    params = event.payload[:params]&.except("controller", "action")
+    { params: params } if params.present?
   end
 end
 ```
-
-### 3. Restart Your Rails Server
-
-After configuration, restart your Rails development server:
+For more information about lograge configuration, see [Lograge's documentation](https://github.com/roidrage/lograge).
 
 ## Usage
 

data/exe/log_bench

@@ -18,12 +18,11 @@ def show_help
       log_bench /path/to/app/log/test.log  # View log from another app
 
     Setup (for Rails apps):
-      See README.md for complete configuration instructions:
-      https://github.com/silva96/log_bench#installation
+      LogBench is automatically enabled in development!
+      Just restart your Rails server after installing the gem.
 
-    Requirements:
-      - Lograge gem with JSON formatter
-      - Rails application logs in lograge format
+      To customize or enable in other environments:
+      For complete setup: https://github.com/silva96/log_bench#configuration
 
     For more info: https://github.com/silva96/log_bench
   HELP

data/lib/log_bench/app/main.rb

@@ -21,7 +21,6 @@ module LogBench
         self.log_file_path = find_log_file(log_file_path)
         self.state = State.new
         validate_log_file!
-        validate_configuration!
       end
 
       def run
@@ -57,13 +56,6 @@ module LogBench
         File.basename(log_file_path)
       end
 
-      def validate_configuration!
-        ConfigurationValidator.validate_rails_config!
-      rescue ConfigurationValidator::ConfigurationError => e
-        puts e.message
-        exit 1
-      end
-
       def setup_screen
         self.screen = Screen.new
         screen.setup

data/lib/log_bench/app/renderer/header.rb

@@ -9,7 +9,7 @@ module LogBench
         # Application info
         APP_NAME = "LogBench"
         APP_SUBTITLE = "Rails Log Viewer"
-        DEFAULT_LOG_FILENAME = "development.log"
+        VERSION = "(v#{LogBench::VERSION})"
 
         # Layout constants
         TITLE_X_OFFSET = 2
@@ -41,7 +41,7 @@ module LogBench
         def draw_title
           header_win.setpos(1, TITLE_X_OFFSET)
           header_win.attron(color_pair(HEADER_CYAN) | A_BOLD) { header_win.addstr(APP_NAME) }
-          header_win.addstr(" - #{APP_SUBTITLE}")
+          header_win.addstr(" - #{APP_SUBTITLE} #{VERSION}")
         end
 
         def draw_file_name

data/lib/log_bench/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module LogBench
+  class Configuration
+    attr_accessor :show_init_message, :enabled, :base_controller_classes, :configure_lograge_automatically
+
+    def initialize
+      @show_init_message = :full
+      @enabled = false
+      @base_controller_classes = %w[ApplicationController ActionController::Base]
+      @configure_lograge_automatically = true  # Configure lograge by default
+    end
+  end
+end

data/lib/log_bench/configuration_validator.rb

@@ -7,23 +7,19 @@ module LogBench
     ERROR_CONFIGS = {
       enabled: {
         title: "Lograge is not enabled",
-        description: "LogBench requires lograge to be enabled in your Rails application.",
-        fix: "config.lograge.enabled = true"
+        description: "LogBench requires lograge to be enabled in your Rails application."
       },
       options: {
         title: "Lograge custom_options missing",
-        description: "LogBench needs custom_options to include params fields.",
-        fix: <<~FIX.strip
-          config.lograge.custom_options = lambda do |event|
-            params = event.payload[:params]&.except("controller", "action")
-            { params: params } if params.present?
-          end
-        FIX
+        description: "LogBench needs custom_options to include params fields."
       },
-      formatter: {
+      lograge_formatter: {
         title: "Wrong lograge formatter",
-        description: "LogBench requires LogBench::JsonFormatter for proper log parsing.",
-        fix: "config.lograge.formatter = LogBench::JsonFormatter.new"
+        description: "LogBench requires Lograge::Formatters::Json for lograge formatting."
+      },
+      logger_formatter: {
+        title: "Wrong Rails logger formatter",
+        description: "LogBench requires LogBench::JsonFormatter for Rails logger formatting."
       }
     }.freeze
 
@@ -33,10 +29,12 @@ module LogBench
 
     def validate_rails_config!
       return true unless defined?(Rails) && Rails.application
+      return true unless LogBench.configuration.enabled
 
       validate_lograge_enabled!
       validate_custom_options!
-      validate_json_formatter!
+      validate_lograge_formatter!
+      validate_logger_formatter!
 
       true
     end
@@ -55,10 +53,21 @@ module LogBench
       end
     end
 
-    def validate_json_formatter!
+    def validate_lograge_formatter!
       formatter = lograge_config&.formatter
+      unless formatter.is_a?(Lograge::Formatters::Json)
+        raise ConfigurationError, build_error_message(:lograge_formatter)
+      end
+    end
+
+    def validate_logger_formatter!
+      # Check Rails.logger directly since that's what we set now
+      logger = Rails.logger
+      formatter = logger&.formatter
+      # Allow LogBench::JsonFormatter or any custom JSON formatter
+      # Users might have their own JSON formatters that work with LogBench
       unless formatter.is_a?(LogBench::JsonFormatter)
-        raise ConfigurationError, build_error_message(:formatter)
+        raise ConfigurationError, build_error_message(:logger_formatter)
       end
     end
 
@@ -75,8 +84,7 @@ module LogBench
 
         #{config[:description]}
 
-        Add this to config/environments/development.rb:
-        #{config[:fix]}
+        This should be automatically configured by LogBench, but something went wrong.
 
         For complete setup: https://github.com/silva96/log_bench#configuration
       ERROR

data/lib/log_bench/current.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+if defined?(ActiveSupport::CurrentAttributes)
+  module LogBench
+    class Current < ActiveSupport::CurrentAttributes
+      attribute :request_id
+    end
+  end
+end

data/lib/log_bench/json_formatter.rb

@@ -66,7 +66,9 @@ module LogBench
     def current_request_id
       request_id = nil
 
-      if defined?(Current) && Current.respond_to?(:request_id)
+      if defined?(LogBench::Current) && LogBench::Current.respond_to?(:request_id)
+        request_id = LogBench::Current.request_id
+      elsif defined?(Current) && Current.respond_to?(:request_id)
         request_id = Current.request_id
       elsif defined?(RequestStore) && RequestStore.exist?(:request_id)
         request_id = RequestStore.read(:request_id)

data/lib/log_bench/railtie.rb

@@ -3,79 +3,127 @@ require "rails/railtie"
 module LogBench
   class Railtie < Rails::Railtie
     LINE = "=" * 70
+    HELP_INSTRUCTIONS = "For help: log_bench --help"
+    MIN_INIT_MESSAGE = "✅ LogBench is ready to use!"
+    FULL_INIT_MESSAGE = <<~MSG.chomp
+      #{MIN_INIT_MESSAGE}
+      View your logs: log_bench log/development.log
+    MSG
 
     railtie_name :log_bench
 
     config.log_bench = ActiveSupport::OrderedOptions.new
 
-    # LogBench uses manual configuration (see README.md)
-
     # Provide helpful rake tasks
     rake_tasks do
       load "tasks/log_bench.rake"
     end
 
-    initializer "log_bench.configure" do |app|
+    # Run AFTER user initializers to pick up their configuration
+    initializer "log_bench.configure", after: :load_config_initializers do |app|
       LogBench.setup do |config|
+        # Enable by default in development for backward compatibility
+        config.enabled = if app.config.log_bench.enabled.nil?
+          Rails.env.development?
+        else
+          app.config.log_bench.enabled
+        end
+
         config.show_init_message = app.config.log_bench.show_init_message
         config.show_init_message = :full if config.show_init_message.nil?
+        config.base_controller_classes = app.config.log_bench.base_controller_classes if app.config.log_bench.base_controller_classes
+        config.configure_lograge_automatically = app.config.log_bench.configure_lograge_automatically unless app.config.log_bench.configure_lograge_automatically.nil?
       end
     end
 
-    # Show installation instructions when Rails starts in development
+    # Show success message when Rails starts in development
     initializer "log_bench.show_instructions", after: :load_config_initializers do
-      return unless Rails.env.development?
+      next unless Rails.env.development? && LogBench.configuration.enabled
 
-      # Use configuration validator to check lograge setup
-      begin
-        ConfigurationValidator.validate_rails_config!
-        # Lograge is properly configured
-        if LogBench.configuration.show_init_message.eql? :full
-          print_full_init_message
-          print_help_instructions
-          puts LINE
-          puts LINE
-        elsif LogBench.configuration.show_init_message.eql? :min
-          print_min_init_message
+      print_configured_init_message
+    rescue => e
+      puts LINE
+      puts "⚠️  LogBench setup issue: #{e.message} at: \n#{e.backtrace.join("\n")}"
+      puts HELP_INSTRUCTIONS
+      puts LINE
+    end
+
+    # Single after_initialize for ALL setup that needs to happen after Rails is ready
+    config.after_initialize do |app|
+      if LogBench.configuration.enabled
+        LogBench::Railtie.setup_lograge(app)
+        LogBench::Railtie.setup_current_attributes
+        LogBench::Railtie.setup_rails_logger_final
+        LogBench::Railtie.validate_configuration!
+      end
+    end
+
+    class << self
+      def setup_lograge(app)
+        return unless LogBench.configuration.configure_lograge_automatically
+
+        app.config.lograge.enabled = true
+        app.config.lograge.formatter = Lograge::Formatters::Json.new
+        app.config.lograge.custom_options = lambda do |event|
+          params = event.payload[:params]&.except("controller", "action")
+          {params: params} if params.present?
+        end
+      end
+
+      def setup_current_attributes
+        # Inject Current.request_id into base controllers
+        LogBench.configuration.base_controller_classes.each do |controller_class_name|
+          controller_class = controller_class_name.safe_constantize
+          next unless controller_class
+
+          inject_current_request_id(controller_class)
+        end
+      end
+
+      # Setup Rails logger by re-wrapping with TaggedLogging
+      def setup_rails_logger_final
+        # Get the underlying logger (unwrap TaggedLogging if present)
+        base_logger = Rails.logger.respond_to?(:logger) ? Rails.logger.logger : Rails.logger
+        base_logger.formatter = LogBench::JsonFormatter.new
+        # Re-wrap with TaggedLogging to maintain Rails compatibility
+        Rails.logger = ActiveSupport::TaggedLogging.new(base_logger)
+      end
+
+      def inject_current_request_id(controller_class)
+        return if controller_class.method_defined?(:set_current_request_id)
+
+        controller_class.class_eval do
+          before_action :set_current_request_id
+
+          private
+
+          def set_current_request_id
+            LogBench::Current.request_id = request.request_id if defined?(LogBench::Current)
+          end
         end
+      end
+
+      # Validate that LogBench setup worked correctly
+      def validate_configuration!
+        ConfigurationValidator.validate_rails_config!
       rescue ConfigurationValidator::ConfigurationError => e
-        # Lograge needs configuration
-        print_configuration_instructions
-        puts "⚠️  Configuration issue: #{e.message}"
-        print_help_instructions
         puts LINE
+        puts "❌ LogBench Configuration Error:"
+        puts e.message
+        puts "LogBench will be disabled until this is fixed."
         puts LINE
       end
     end
 
     private
 
-    def print_configuration_instructions
-      puts "🚀 LogBench is ready to configure!"
-      puts LINE
-      puts "To start using LogBench:"
-      puts "  1. See README.md for configuration instructions"
-      puts "  2. Configure lograge in config/environments/development.rb"
-      puts "  3. Restart your Rails server"
-      puts "  4. Make some requests to generate logs"
-      puts "  5. View logs: log_bench log/development.log"
-      puts ""
-    end
-
-    def print_min_init_message
-      puts "✅ LogBench is ready to use!"
-    end
-
-    def print_full_init_message
-      puts "\n" + LINE
-      puts "\n" + LINE
-      puts "✅ LogBench is ready to use!"
-      puts LINE
-      puts "View your logs: log_bench log/development.log"
-    end
-
-    def print_help_instructions
-      puts "For help: log_bench --help"
+    def print_configured_init_message
+      case LogBench.configuration.show_init_message
+      when :full, nil
+        puts LINE, FULL_INIT_MESSAGE, HELP_INSTRUCTIONS, LINE
+      when :min
+        puts LINE, MIN_INIT_MESSAGE, LINE
+      end
     end
   end
 end

data/lib/log_bench/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LogBench
-  VERSION = "0.1.7"
+  VERSION = "0.1.9"
 end

data/lib/log_bench.rb

@@ -4,7 +4,6 @@ require "zeitwerk"
 require "json"
 require "time"
 require "curses"
-require_relative "log_bench/version"
 
 loader = Zeitwerk::Loader.for_gem
 loader.ignore("#{__dir__}/generators")
@@ -13,24 +12,13 @@ loader.setup
 module LogBench
   class Error < StandardError; end
 
-  class Configuration
-    attr_accessor :show_init_message
-  end
-
   class << self
     attr_accessor :configuration
 
-    # Parse log lines and return an array of entries
-    def parse(lines)
-      lines = [lines] if lines.is_a?(String)
-
-      collection = Log::Collection.new(lines)
-      collection.requests
-    end
-
     def setup
       self.configuration ||= Configuration.new
-      yield(configuration)
+      yield(configuration) if block_given?
+      configuration
     end
   end
 end

data/lib/tasks/log_bench.rake

@@ -3,14 +3,11 @@ namespace :log_bench do
   task :install do
     puts "LogBench Configuration Instructions:"
     puts
-    puts "Please see the README.md for complete setup instructions:"
-    puts "https://github.com/silva96/log_bench#configuration"
+    puts "LogBench is automatically enabled in development!"
+    puts "Just restart your Rails server and it will work."
     puts
-    puts "Quick setup:"
-    puts "1. Add 'require \"lograge\"' to config/environments/development.rb"
-    puts "2. Configure lograge and JsonFormatter (see README)"
-    puts "3. Set up Current model and ApplicationController"
-    puts "4. Restart Rails server"
+    puts "For customization or other environments, see:"
+    puts "https://github.com/silva96/log_bench#configuration"
   end
 
   desc "Show LogBench usage instructions"
@@ -25,7 +22,7 @@ namespace :log_bench do
         2. Run bundle install:
            bundle install
            
-        3. Configure lograge (see README.md):
+        3. Optionally configure log_bench (see README.md):
            https://github.com/silva96/log_bench#configuration
            
         4. Restart your Rails server
@@ -46,11 +43,7 @@ namespace :log_bench do
         - Interactive TUI with dual panes
         - Request filtering and sorting
         - SQL query analysis
-        - Color-coded HTTP methods and status codes
-        
-      Requirements:
-        - Lograge gem with JSON formatter
-        - Rails application logs in lograge format
+        - Color-coded HTTP methods and status codess
     HELP
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: log_bench
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Benjamín Silva
 bindir: exe
 cert_chain: []
-date: 2025-06-17 00:00:00.000000000 Z
+date: 2025-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -139,7 +139,9 @@ files:
 - lib/log_bench/app/screen.rb
 - lib/log_bench/app/sort.rb
 - lib/log_bench/app/state.rb
+- lib/log_bench/configuration.rb
 - lib/log_bench/configuration_validator.rb
+- lib/log_bench/current.rb
 - lib/log_bench/json_formatter.rb
 - lib/log_bench/log/cache_entry.rb
 - lib/log_bench/log/call_line_entry.rb