custom_log_space 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58dddf2fc7026b74b4f4afea69035a4a3c94f6d0b1e356a033c8c7368919d530
-  data.tar.gz: '0826fdfdb8537d4935182fb05bb7155e5de1162a357fcdf333a89ede1c78900b'
+  metadata.gz: 0e1062675aa1401b1e4b4cfa888586406c375b2b659f70e96e72734a0e770786
+  data.tar.gz: 865838694e1eb10da0caf7f35e9d58f4984591a092380f1ed16355753a76a7a5
 SHA512:
-  metadata.gz: b6a1dcbf9c647fa2402aa11564af5875b0c6718ebf6ee59c8316cddd1a0072e27539ff9e8ea91a5602aced4625d7b098b18778b20b19a8fc2f9e22d977d63a16
-  data.tar.gz: 938eb0064c5156508e350ec591a5bca3be50bb3955ec087753dd78fb8f8e90842dd290301492099272616c80800b00c6c2d665447b4a8b5ade3612857079db94
+  metadata.gz: a7dbddd8b4777adb61b4bff9732fb1859927f51170292036f9cd78f57a083a5f4dee17d23091ca1c20ff138ae055392c7ec8398a2c4b5c7110e1da7ec87e31b5
+  data.tar.gz: 7460fa253f9b52a92748fa458492b1c7f4085badffed04fe4d3f45fe4f462a0610bbf4cc28beafaba7d853d1d44e3b6cae0aa0339cbc8643b235a9cbae6989b2

data/CHANGELOG.md

@@ -1,4 +1,12 @@
 ## [Unreleased]
+## [0.1.6] - 2023-09-19
+### Changed
+I have modified the implementation to create a 'saved' folder.
+`log/custom_log_space/#{controller_name}/#{action_name}/saved/`
+
+## [0.1.5] - 2023-09-18
+### Changed
+Modify so that only 10 files can be created
 
 ## [0.1.4] - 2023-09-15
 ### Changed

data/README.md

@@ -34,25 +34,28 @@ 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
+│       │   ├── 2023-09-19
+│       │   │   ├── 09:13.log
+│       │   │   └── 20:00.log
+│       │   └── saved
 │       └── show
-│           └── 2023-09-15
-│               └── 02:10.log
+│           ├── 2023-09-18
+│           │   ├── 21:29.log
+│           │   └── 22:02.log
+│           ├── 2023-09-19
+│           │   └── 20:00.log
+│           └── saved
 └── development.log
 ```
 
-## Retention Policy
+## Log Retention Policy
+To maintain system performance and manage disk space:
 
-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.
+* Date Directory: Max of 2 date-folders, excluding 'saved'. A third will remove the oldest.
+* File Limit: Up to 10 log files per date folder. Monitor your logs to stay within this.
+* Extended Retention: Need logs longer? Archive or back up them. Accidental losses are avoided this way.
+Remember: Files in the 'saved' directory won't be deleted. To keep a log, move it there:
+`log/custom_log_space/#{controller_name}/#{action_name}/saved/`
 
 ## 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/lib/custom_log_space/base_helper/log_writer.rb

@@ -27,13 +27,14 @@ module CustomLogSpace
     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
+      # If there are more than 2 date-directories(except saved directory), remove the oldest ones
+      remove_oldest_directory while all_directories.size > 3
     end
 
     def all_directories
       @all_directories ||= Dir.entries(base_directory_path).select do |entry|
-        File.directory?(File.join(base_directory_path, entry)) && entry !~ /^\./
+        path = File.join(base_directory_path, entry)
+        File.directory?(path) && entry !~ /^\./ && entry != "saved"
       end.sort
     end
 
@@ -48,19 +49,43 @@ module CustomLogSpace
     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)
+      create_saved_directory
+      directory_path = create_log_directory
+
       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
       error_prefix = e.is_a?(SystemCallError) ? "Error" : "IO Error"
       puts "#{error_prefix}: #{e.message}"
     end
 
+    # Create the 'saved' directory (but don't place logs in it)
+    def create_saved_directory
+      saved_directory_path = File.join(base_directory_path, "saved")
+      FileUtils.mkdir_p(saved_directory_path) unless Dir.exist?(saved_directory_path)
+    end
+
+    def create_log_directory
+      directory_path = File.join(base_directory_path, Time.now.strftime("%Y-%m-%d"))
+      FileUtils.mkdir_p(directory_path) unless Dir.exist?(directory_path)
+      directory_path
+    end
+
+    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]

data/lib/custom_log_space/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: custom_log_space
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - nishikawa1031
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-15 00:00:00.000000000 Z
+date: 2023-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport