custom_log_space 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c3499fa8649b5c47d67508aa782bbc432da75450f1853050b1c10f444508112
-  data.tar.gz: 3e680a83be530a4c4ee0b684f113a81b2cfddd0ebf0b817b9131b0553b04cace
+  metadata.gz: bb593f3ada3627f418dfe35b2b55ea90c1a697bea93122ecc2e134df75f3a22e
+  data.tar.gz: 9b67ad5d122d6eb55624342ef20612ac10b92d3d0c6a6177bf85293e513fc9af
 SHA512:
-  metadata.gz: 7167f9dc93e5903cb2c82964b2109b8e58b13a2cc8c084ed47f1ad73877a1ca43d94d20bdec4c676deaba767a0f0ae8c2eb2f07157b34a1090c9309748ccdde6
-  data.tar.gz: 687f7ca2dc683d757fe2f097857676b8818a6a4a675361b9cebdf10930d2dcf5297637c32f39ea763c2df1b517a01293c285fe60c83303acfaddfc067bd343c5
+  metadata.gz: '0738eaf07b4526d6d156874d1f5865e70c247ecdf085cd4bce305a04a80b15943a3431a83859a3cc3a4e9342e1b565b4e40d7b6a3be8457543bf2905e70344bf'
+  data.tar.gz: 945319f56b0e7055791bbcb877d7baa20685199d0f31d67f271e1c485c6cbe3c0de28bbfaf9c7298579814fc2ff288ed8d486eddf99a2e88bc083ab21f5cf833

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.1.5] - 2023-09-18
+### Changed
+Modify so that only 10 files can be created
+
+## [0.1.4] - 2023-09-15
+### Changed
+Simplify the gem description
+
 ## [0.1.3] - 2023-09-15
 ### Changed
 The retention period for logs within the date directory has been changed from 3 days to 2 days.

data/README.md

@@ -1,8 +1,7 @@
 # CustomLogSpace
 
-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.
+The CustomLogSpace gem organizes Rails logs by controller and action. 
+With it, developers no longer need to start the rails server repeatedly just to check logs.
 
 ## Installation
 
@@ -52,8 +51,13 @@ user log % tree
 ```
 
 ## Retention Policy
+To ensure optimal system performance and to prevent excessive disk usage, our logging system implements a strict retention policy:
+
+* Date Directory Limitation: Only up to 2 date directories can be created. Any additional date directory beyond this limit will lead to the automatic deletion of the oldest directory.
+
+* File Limitation: Only up to 10 log files can be created within the date directory. Ensure to manage the number of logs being generated to stay within this limit.
 
-To prevent excessive disk usage, logs within the `date` directory are retained for only 2 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.
+Important: If you require logs to be retained for longer periods or need to keep more extensive records, make sure to archive or backup the necessary log files regularly to prevent any unwanted data loss.
 
 ## Ignoring Logs in Git
 If needed, add `/log/custom_log_space/*` to your `.gitignore` to ensure the logs aren't committed to your repository.

data/custom_log_space.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email = ["tatsunishitatsu@gmail.com"]
 
   spec.summary = "A Rails logger extension that organizes logs by controller and action into dedicated folders."
-  spec.description = "CustomLogSpace refines Rails logs by categorizing them by controller and action. It provides a clearer view."
+  spec.description = "This gem organizes Rails logs by controller and action, eliminating the need to start the server for log checks."
   spec.homepage = "https://github.com/nishikawa1031/custom_log_space.git"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"

data/lib/custom_log_space/base_helper/log_writer.rb

@@ -6,10 +6,15 @@ module CustomLogSpace
   module LogWriter
     private
 
-    def log_message(message)
-      current_controller = Thread.current[:current_controller]
-      current_action = Thread.current[:current_action]
+    def current_controller
+      Thread.current[:current_controller]
+    end
 
+    def current_action
+      Thread.current[:current_action]
+    end
+
+    def log_message(message)
       return unless current_controller && current_action
 
       write_to_custom_log(message) do |file|
@@ -20,88 +25,66 @@ module CustomLogSpace
     end
 
     def cleanup_old_directories
-      return unless Dir.exist?(action_directory)
+      return unless Dir.exist?(base_directory_path)
 
-      # If there are more than 3 date-directories, remove the oldest ones
+      # If there are more than 2 date-directories, remove the oldest ones
       remove_oldest_directory while all_directories.size > 2
     end
 
     def all_directories
-      @all_directories ||= Dir.entries(action_directory).select do |entry|
-        File.directory?(File.join(action_directory, entry)) && entry !~ /^\./
+      @all_directories ||= Dir.entries(base_directory_path).select do |entry|
+        File.directory?(File.join(base_directory_path, 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)
+      path_to_remove = File.join(base_directory_path, 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
+    def base_directory_path
+      File.join(Rails.root, "log", "custom_log_space", current_controller.underscore, current_action)
     end
 
     def write_to_custom_log(message)
-      directory_path = log_directory_based_on_format
+      directory_path = File.join(base_directory_path, Time.now.strftime("%Y-%m-%d"))
       FileUtils.mkdir_p(directory_path) unless Dir.exist?(directory_path)
-      custom_log_path = custom_log_file_path(directory_path)
+      custom_log_path = "#{directory_path}/#{Time.now.strftime("%H:%M")}.log"
 
       File.open(custom_log_path, "a") do |file|
         yield(file) # Header or other info can be passed and written here
         file.puts(message)
       end
+
+      cleanup_old_log_files(directory_path)
     rescue SystemCallError, IOError => e
-      handle_file_error(e)
+      error_prefix = e.is_a?(SystemCallError) ? "Error" : "IO Error"
+      puts "#{error_prefix}: #{e.message}"
     end
 
-    def handle_file_error(error)
-      error_prefix = error.is_a?(SystemCallError) ? "Error" : "IO Error"
-      puts "#{error_prefix}: #{error.message}"
+    def cleanup_old_log_files(directory_path)
+      log_files = Dir.entries(directory_path).select { |entry| entry =~ /\.log$/ }.sort
+      while log_files.size > 10
+        oldest_log_file = log_files.shift
+        path_to_remove = File.join(directory_path, oldest_log_file)
+        File.delete(path_to_remove)
+      end
     end
 
+    # rubocop:disable Metrics/AbcSize
     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 "Started GET \"#{Thread.current[:path]}\" for ::1 at #{Time.now.strftime("%Y-%m-%d %H:%M:%S %z")}"
       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)
+      Thread.current[:header_written] = true
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/custom_log_space/version.rb

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

data/lib/custom_log_space.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "custom_log_space/base_subscriber"
-require "custom_log_space/sql_subscriber"
-require "custom_log_space/view_subscriber"
+require "custom_log_space/subscribers/base_subscriber"
+require "custom_log_space/subscribers/sql_subscriber"
+require "custom_log_space/subscribers/view_subscriber"
 
 CustomLogSpace::BaseSubscriber.attach_to :action_controller
 SQLSubscriber.attach_to :active_record

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: custom_log_space
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - nishikawa1031
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-15 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,8 +30,8 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'
-description: CustomLogSpace refines Rails logs by categorizing them by controller
-  and action. It provides a clearer view.
+description: This gem organizes Rails logs by controller and action, eliminating the
+  need to start the server for log checks.
 email:
 - tatsunishitatsu@gmail.com
 executables: []
@@ -50,10 +50,10 @@ files:
 - lib/custom_log_space/base_helper/log_formatter.rb
 - lib/custom_log_space/base_helper/log_writer.rb
 - lib/custom_log_space/base_helper/thread_manager.rb
-- lib/custom_log_space/base_subscriber.rb
-- lib/custom_log_space/sql_subscriber.rb
+- lib/custom_log_space/subscribers/base_subscriber.rb
+- lib/custom_log_space/subscribers/sql_subscriber.rb
+- lib/custom_log_space/subscribers/view_subscriber.rb
 - lib/custom_log_space/version.rb
-- lib/custom_log_space/view_subscriber.rb
 - sig/custom_log_space.rbs
 homepage: https://github.com/nishikawa1031/custom_log_space.git
 licenses: