custom_log_space 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98b901d882ede4d8684e25e13741a5e65eb6f61cbbae5b4e8bb597c15781d23e
-  data.tar.gz: bf6f8ccf000f73f92d4b94853847d7f04cfb575b6460bbb791702a1f4ed8514d
+  metadata.gz: 1d0e3ad542c322fac2dae3da5cb1777a9ca18f6e60725e7886bf1bc21df9dce9
+  data.tar.gz: 6b97fca2a8072335da8a712fc9884a7b7665a211d811dd51eb2e829126e8e6b6
 SHA512:
-  metadata.gz: dc4463dfe438bf6d25b200177211506c5e34c3011199caf737013083f121ceb0004d633901d3bf859a89037137b99e9bef5907e1ccdc35ee4e096a8b6e9da096
-  data.tar.gz: 173effc0824a52f8cf383d91c15c027157b03c2c0ffbf46b99368cb0b9a841a05eba2f37131083f61e880bc95ffb5c1fc4b9fa9183f46f1358c08d910ff3d852
+  metadata.gz: a7a9bb6be97c059b281c76d58dda57f495125b05aa2cb406d5a1d348ed06b28299a77f4b8e24ce4c98b832745c932caef0fcfb5858a268e9013594e0414004eb
+  data.tar.gz: 3311eff79f825be74b425a762ce1cd130c3ba4e20859cf08d46b21d2e5990edc51c1240a50233491c283317b75282e227a9e195ce87a55dc87fbcad245accc2a

data/.rubocop.yml

@@ -12,6 +12,9 @@ Style/StringLiteralsInInterpolation:
 Layout/LineLength:
   Max: 150
 
+Metrics/MethodLength:
+  Max: 15
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
-## [0.1.0] - 2023-09-12
+## [0.1.2] - 2023-09-15
+### Changed
+Modified the file path structure for logs. New structure: log/custom_log_space/#{controller_name}/#{action_name}/#{date}/#{time}.log.
+
+## [0.1.1] - 2023-09-13
+### Added
+- Added `cleanup_old_directories` method to manage and delete old directories, ensuring only the two most recent date-directories remain.
 
+## [0.1.0] - 2023-09-12
 - Initial release

data/README.md

@@ -2,6 +2,8 @@
 
 The CustomLogSpace gem allows Rails developers to direct Rails logs to files, organized by each controller and action. This organization simplifies debugging and analysis.
 
+Thanks to this gem, developers are freed from the hassle of constantly starting the rails server to check logs every time an action in a controller is executed.
+
 ## Installation
 
 To begin, add the gem to your application's Gemfile:
@@ -25,10 +27,39 @@ $ gem install custom_log_space
 ```
 
 ## Usage
-Logs are saved in the `log/custom_log_space/[date]/[time]/[controller_name]/` directory. The filenames follow the pattern: "[action_name].log".
+Logs are saved in the `log/custom_log_space/#{controller_name}/#{action_name}/#{date}/#{time}.log`.
+
+```
+user log % tree
+.
+├── custom_log_space
+│   └── articles_controller
+│       ├── index
+│       │   ├── 2023-09-14
+│       │   │   ├── 08:45.log
+│       │   │   └── 08:46.log
+│       │   └── 2023-09-15
+│       │       ├── 02:10.log
+│       │       ├── 08:10.log
+│       │       └── 08:11.log
+│       ├── new
+│       │   └── 2023-09-14
+│       │       └── 08:45.log
+│       └── show
+│           └── 2023-09-15
+│               └── 02:10.log
+└── development.log
+```
 
-<img width="492" alt="スクリーンショット 2023-09-12 8 37 43" src="https://github.com/nishikawa1031/custom_log_space/assets/53680568/95cf44c8-e256-44d0-b0cb-9d6367601985">
+## Retention Policy
 
+To prevent excessive disk usage, logs within the `date` directory are retained for only 3 days. Any logs older than this retention period will be automatically deleted, starting with the oldest. Ensure that you archive or backup logs if you need them for longer periods.
+
+## Ignoring Logs in Git
+If needed, add `/log/custom_log_space/*` to your `.gitignore` to ensure the logs aren't committed to your repository.
+```
+/log/custom_log_space/*
+```
 
 ## Supported environments
 - Rails 7

data/lib/custom_log_space/base_subscriber.rb

@@ -1,114 +1,25 @@
 # frozen_string_literal: true
 
+require "custom_log_space/log_formatter"
+require "custom_log_space/thread_manager"
+require "custom_log_space/log_writer"
+
 module CustomLogSpace
   # CustomLogSpace::Subscriber is a class for handling custom logging in Rails applications.
   # It provides methods for processing different types of log events and organizing log messages.
+  # https://github.com/rails/rails/blob/7-0-stable/activesupport/lib/active_support/log_subscriber.rb
   class BaseSubscriber < ActiveSupport::LogSubscriber
+    include CustomLogSpace::LogWriter
+    include CustomLogSpace::LogFormatter
+
     def start_processing(event)
-      setup_thread_variables(event.payload)
+      ThreadManager.setup(event.payload)
     end
 
     def process_action(event)
-      payload = event.payload
-      status = payload[:status]
-      duration = event.duration.round(2)
-      view_runtime = payload[:view_runtime]&.round(2)
-      db_runtime = payload[:db_runtime]&.round(2)
-      allocations = event.allocations
-
-      message = "Completed #{status} #{Rack::Utils::HTTP_STATUS_CODES[status]} in #{duration}ms " \
-          "(Views: #{view_runtime}ms | ActiveRecord: #{db_runtime}ms | Allocations: #{allocations})"
-
+      message = format_message(event)
       log_message(message)
-      clear_thread_variables
-    end
-
-    private
-
-    def setup_thread_variables(payload)
-      Thread.current[:current_controller] = payload[:controller]
-      Thread.current[:current_action] = payload[:action]
-      Thread.current[:path] = payload[:path]
-      Thread.current[:params] = payload[:params].except(:controller, :action)
-      Thread.current[:header_written] = false
-    end
-
-    def clear_thread_variables
-      Thread.current[:current_controller] = nil
-      Thread.current[:current_action] = nil
-      Thread.current[:path] = nil
-      Thread.current[:params] = nil
-      Thread.current[:header_written] = nil
-    end
-
-    def log_message(message)
-      current_controller = Thread.current[:current_controller]
-      current_action = Thread.current[:current_action]
-
-      return unless current_controller && current_action
-
-      FileUtils.mkdir_p(controller_log_directory) unless Dir.exist?(controller_log_directory)
-      write_to_custom_log(message)
-    end
-
-    def custom_log_directory
-      today = Time.now.strftime("%Y%m%d")
-      time = Time.now.strftime("%H%M")
-      File.join(Rails.root, "log", "custom_log_space", today, time)
-    end
-
-    def controller_log_directory
-      controller_name = Thread.current[:current_controller].underscore
-      File.join(custom_log_directory, controller_name)
-    end
-
-    def custom_log_file_path
-      action_name = Thread.current[:current_action]
-      log_file_name = "#{action_name}.log"
-      File.join(controller_log_directory, log_file_name)
-    end
-
-    def write_to_custom_log(message)
-      custom_log_path = custom_log_file_path
-
-      File.open(custom_log_path, "a") do |file|
-        write_header_information(file)
-        file.puts(message)
-      end
-    rescue SystemCallError, IOError => e
-      handle_file_error(e)
-    end
-
-    def handle_file_error(error)
-      error_prefix = error.is_a?(SystemCallError) ? "Error" : "IO Error"
-      puts "#{error_prefix}: #{error.message}"
-    end
-
-    def write_header_information(file)
-      return if Thread.current[:header_written]
-
-      current_controller = Thread.current[:current_controller]
-      current_action = Thread.current[:current_action]
-
-      file.puts("") # Add a blank line for better readability.
-      write_request_info(file)
-      write_processing_info(file, current_controller, current_action)
-      write_parameters_info(file)
-      Thread.current[:header_written] = true
-    end
-
-    def write_request_info(file)
-      formatted_time = Time.now.strftime("%Y-%m-%d %H:%M:%S %z")
-      file.puts "Started GET \"#{Thread.current[:path]}\" for ::1 at #{formatted_time}"
-    end
-
-    def write_processing_info(file, current_controller, current_action)
-      file.puts "Processing by #{current_controller}##{current_action} as HTML"
-    end
-
-    def write_parameters_info(file)
-      params = Thread.current[:params] || {}
-      file.puts "Parameters: #{params.inspect}" unless params.empty?
+      ThreadManager.clear
     end
   end
 end

data/lib/custom_log_space/log_formatter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CustomLogSpace
+  # The LogFormatter module is responsible for formatting log messages.
+  module LogFormatter
+    private
+
+    def format_message(event)
+      payload = event.payload
+      status = payload[:status]
+      duration = event.duration.round(2)
+      view_runtime = payload[:view_runtime]&.round(2)
+      db_runtime = payload[:db_runtime]&.round(2)
+      allocations = event.allocations
+
+      "Completed #{status} #{Rack::Utils::HTTP_STATUS_CODES[status]} in #{duration}ms " \
+          "(Views: #{view_runtime}ms | ActiveRecord: #{db_runtime}ms | Allocations: #{allocations})"
+    end
+  end
+end

data/lib/custom_log_space/log_writer.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module CustomLogSpace
+  # The LogWriter module provides methods for writing log messages to custom log files.
+  # It allows the creation of log directories, handling file errors, and appending messages to log files.
+  module LogWriter
+    private
+
+    def log_message(message)
+      current_controller = Thread.current[:current_controller]
+      current_action = Thread.current[:current_action]
+
+      return unless current_controller && current_action
+
+      write_to_custom_log(message) do |file|
+        write_header_information(file)
+      end
+
+      cleanup_old_directories
+    end
+
+    def cleanup_old_directories
+      return unless Dir.exist?(action_directory)
+
+      # If there are more than 3 date-directories, remove the oldest ones
+      remove_oldest_directory while all_directories.size > 3
+    end
+
+    def all_directories
+      @all_directories ||= Dir.entries(action_directory).select do |entry|
+        File.directory?(File.join(action_directory, entry)) && entry !~ /^\./
+      end.sort
+    end
+
+    def remove_oldest_directory
+      directory_to_remove = all_directories.shift
+      path_to_remove = File.join(action_directory, directory_to_remove)
+      FileUtils.rm_rf(path_to_remove)
+    end
+
+    def action_directory
+      @action_directory ||= begin
+        controller_name = Thread.current[:current_controller].underscore
+        action_name = Thread.current[:current_action]
+        File.join(Rails.root, "log", "custom_log_space", controller_name, action_name)
+      end
+    end
+
+    def write_to_custom_log(message)
+      directory_path = log_directory_based_on_format
+      FileUtils.mkdir_p(directory_path) unless Dir.exist?(directory_path)
+      custom_log_path = custom_log_file_path(directory_path)
+
+      File.open(custom_log_path, "a") do |file|
+        yield(file) # Header or other info can be passed and written here
+        file.puts(message)
+      end
+    rescue SystemCallError, IOError => e
+      handle_file_error(e)
+    end
+
+    def handle_file_error(error)
+      error_prefix = error.is_a?(SystemCallError) ? "Error" : "IO Error"
+      puts "#{error_prefix}: #{error.message}"
+    end
+
+    def write_header_information(file)
+      return if Thread.current[:header_written]
+
+      current_controller = Thread.current[:current_controller]
+      current_action = Thread.current[:current_action]
+
+      file.puts("") # Add a blank line for better readability.
+      write_request_info(file)
+      write_processing_info(file, current_controller, current_action)
+      write_parameters_info(file)
+      Thread.current[:header_written] = true
+    end
+
+    def write_request_info(file)
+      formatted_time = Time.now.strftime("%Y-%m-%d %H:%M:%S %z")
+      file.puts "Started GET \"#{Thread.current[:path]}\" for ::1 at #{formatted_time}"
+    end
+
+    def write_processing_info(file, current_controller, current_action)
+      file.puts "Processing by #{current_controller}##{current_action} as HTML"
+    end
+
+    def write_parameters_info(file)
+      params = Thread.current[:params] || {}
+      file.puts "Parameters: #{params.inspect}" unless params.empty?
+    end
+
+    def custom_log_file_path(directory_path)
+      time = Time.now.strftime("%H:%M")
+      "#{directory_path}/#{time}.log"
+    end
+
+    def log_directory_based_on_format
+      controller_name = Thread.current[:current_controller].underscore
+      action_name = Thread.current[:current_action]
+      date = Time.now.strftime("%Y-%m-%d")
+
+      File.join(Rails.root, "log", "custom_log_space", controller_name, action_name, date)
+    end
+  end
+end

data/lib/custom_log_space/thread_manager.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module CustomLogSpace
+  # The ThreadManager class provides methods for managing thread-local variables related to logging in a Rails application.
+  # It is responsible for setting up and clearing thread-local variables such as controller, action, path, params, and header_written.
+  class ThreadManager
+    # https://railsguides.jp/v6.1/active_support_instrumentation.html#start-processing-action-controller
+    # Sets up thread-local variables based on the provided payload.
+    #
+    # @param payload [Hash] The payload containing information about the current request.
+    #
+    # Example:
+    #
+    #   payload = {
+    #     controller: 'HomeController',
+    #     action: 'index',
+    #     path: '/home',
+    #     params: { id: 1, page: 2 }
+    #   }
+    #
+    #   CustomLogSpace::ThreadManager.setup(payload)
+    #
+    def self.setup(payload)
+      Thread.current[:current_controller] = payload[:controller]
+      Thread.current[:current_action] = payload[:action]
+      Thread.current[:path] = payload[:path]
+      Thread.current[:params] = payload[:params].except(:controller, :action)
+      Thread.current[:header_written] = false
+    end
+
+    def self.clear
+      Thread.current[:current_controller] = nil
+      Thread.current[:current_action] = nil
+      Thread.current[:path] = nil
+      Thread.current[:params] = nil
+      Thread.current[:header_written] = nil
+    end
+  end
+end

data/lib/custom_log_space/version.rb

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

data/lib/custom_log_space/view_subscriber.rb

@@ -2,6 +2,7 @@
 
 # ViewSubscriber logs view rendering events for CustomLogSpace.
 # It tracks events like template rendering, partial rendering, and collection rendering.
+# https://github.com/rails/rails/blob/7-0-stable/actionview/lib/action_view/log_subscriber.rb
 class ViewSubscriber < CustomLogSpace::BaseSubscriber
   def render_template(event)
     identifier = event.payload[:identifier]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: custom_log_space
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - nishikawa1031
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-11 00:00:00.000000000 Z
+date: 2023-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -48,10 +48,12 @@ files:
 - custom_log_space.gemspec
 - lib/custom_log_space.rb
 - lib/custom_log_space/base_subscriber.rb
+- lib/custom_log_space/log_formatter.rb
+- lib/custom_log_space/log_writer.rb
 - lib/custom_log_space/sql_subscriber.rb
+- lib/custom_log_space/thread_manager.rb
 - lib/custom_log_space/version.rb
 - lib/custom_log_space/view_subscriber.rb
-- sig/change_rails_log_path.rbs
 - sig/custom_log_space.rbs
 homepage: https://github.com/nishikawa1031/custom_log_space.git
 licenses:

data/sig/change_rails_log_path.rbs

@@ -1,4 +0,0 @@
-module CustomLogSpace
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end