custom_log_space 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d0e3ad542c322fac2dae3da5cb1777a9ca18f6e60725e7886bf1bc21df9dce9
-  data.tar.gz: 6b97fca2a8072335da8a712fc9884a7b7665a211d811dd51eb2e829126e8e6b6
+  metadata.gz: 58dddf2fc7026b74b4f4afea69035a4a3c94f6d0b1e356a033c8c7368919d530
+  data.tar.gz: '0826fdfdb8537d4935182fb05bb7155e5de1162a357fcdf333a89ede1c78900b'
 SHA512:
-  metadata.gz: a7a9bb6be97c059b281c76d58dda57f495125b05aa2cb406d5a1d348ed06b28299a77f4b8e24ce4c98b832745c932caef0fcfb5858a268e9013594e0414004eb
-  data.tar.gz: 3311eff79f825be74b425a762ce1cd130c3ba4e20859cf08d46b21d2e5990edc51c1240a50233491c283317b75282e227a9e195ce87a55dc87fbcad245accc2a
+  metadata.gz: b6a1dcbf9c647fa2402aa11564af5875b0c6718ebf6ee59c8316cddd1a0072e27539ff9e8ea91a5602aced4625d7b098b18778b20b19a8fc2f9e22d977d63a16
+  data.tar.gz: 938eb0064c5156508e350ec591a5bca3be50bb3955ec087753dd78fb8f8e90842dd290301492099272616c80800b00c6c2d665447b4a8b5ade3612857079db94

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [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.
+
 ## [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.

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
 
@@ -53,7 +52,7 @@ user log % tree
 
 ## 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.
+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.
 
 ## 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

@@ -0,0 +1,79 @@
+# 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 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|
+        write_header_information(file)
+      end
+
+      cleanup_old_directories
+    end
+
+    def cleanup_old_directories
+      return unless Dir.exist?(base_directory_path)
+
+      # 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(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(base_directory_path, directory_to_remove)
+      FileUtils.rm_rf(path_to_remove)
+    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 = File.join(base_directory_path, Time.now.strftime("%Y-%m-%d"))
+      FileUtils.mkdir_p(directory_path) unless Dir.exist?(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
+    rescue SystemCallError, IOError => e
+      error_prefix = e.is_a?(SystemCallError) ? "Error" : "IO Error"
+      puts "#{error_prefix}: #{e.message}"
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def write_header_information(file)
+      return if Thread.current[:header_written]
+
+      file.puts("") # Add a blank line for better readability.
+      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"
+
+      params = Thread.current[:params] || {}
+      file.puts "Parameters: #{params.inspect}" unless params.empty?
+
+      Thread.current[:header_written] = true
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/custom_log_space/{base_subscriber.rb → subscribers/base_subscriber.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "custom_log_space/log_formatter"
-require "custom_log_space/thread_manager"
-require "custom_log_space/log_writer"
+require "custom_log_space/base_helper/log_formatter"
+require "custom_log_space/base_helper/thread_manager"
+require "custom_log_space/base_helper/log_writer"
 
 module CustomLogSpace
   # CustomLogSpace::Subscriber is a class for handling custom logging in Rails applications.

data/lib/custom_log_space/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CustomLogSpace
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: custom_log_space
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - nishikawa1031
@@ -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: []
@@ -47,13 +47,13 @@ files:
 - Rakefile
 - 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/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/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:

data/lib/custom_log_space/log_writer.rb

@@ -1,107 +0,0 @@
-# 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