custom_log_space 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c3499fa8649b5c47d67508aa782bbc432da75450f1853050b1c10f444508112
-  data.tar.gz: 3e680a83be530a4c4ee0b684f113a81b2cfddd0ebf0b817b9131b0553b04cace
+  metadata.gz: 58dddf2fc7026b74b4f4afea69035a4a3c94f6d0b1e356a033c8c7368919d530
+  data.tar.gz: '0826fdfdb8537d4935182fb05bb7155e5de1162a357fcdf333a89ede1c78900b'
 SHA512:
-  metadata.gz: 7167f9dc93e5903cb2c82964b2109b8e58b13a2cc8c084ed47f1ad73877a1ca43d94d20bdec4c676deaba767a0f0ae8c2eb2f07157b34a1090c9309748ccdde6
-  data.tar.gz: 687f7ca2dc683d757fe2f097857676b8818a6a4a675361b9cebdf10930d2dcf5297637c32f39ea763c2df1b517a01293c285fe60c83303acfaddfc067bd343c5
+  metadata.gz: b6a1dcbf9c647fa2402aa11564af5875b0c6718ebf6ee59c8316cddd1a0072e27539ff9e8ea91a5602aced4625d7b098b18778b20b19a8fc2f9e22d977d63a16
+  data.tar.gz: 938eb0064c5156508e350ec591a5bca3be50bb3955ec087753dd78fb8f8e90842dd290301492099272616c80800b00c6c2d665447b4a8b5ade3612857079db94

data/CHANGELOG.md

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

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
 

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,55 @@ 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
     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}"
+      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]
 
-      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.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.3
+  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: []
@@ -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: