custom_log_space 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb593f3ada3627f418dfe35b2b55ea90c1a697bea93122ecc2e134df75f3a22e
-  data.tar.gz: 9b67ad5d122d6eb55624342ef20612ac10b92d3d0c6a6177bf85293e513fc9af
+  metadata.gz: 0e1062675aa1401b1e4b4cfa888586406c375b2b659f70e96e72734a0e770786
+  data.tar.gz: 865838694e1eb10da0caf7f35e9d58f4984591a092380f1ed16355753a76a7a5
 SHA512:
-  metadata.gz: '0738eaf07b4526d6d156874d1f5865e70c247ecdf085cd4bce305a04a80b15943a3431a83859a3cc3a4e9342e1b565b4e40d7b6a3be8457543bf2905e70344bf'
-  data.tar.gz: 945319f56b0e7055791bbcb877d7baa20685199d0f31d67f271e1c485c6cbe3c0de28bbfaf9c7298579814fc2ff288ed8d486eddf99a2e88bc083ab21f5cf833
+  metadata.gz: a7dbddd8b4777adb61b4bff9732fb1859927f51170292036f9cd78f57a083a5f4dee17d23091ca1c20ff138ae055392c7ec8398a2c4b5c7110e1da7ec87e31b5
+  data.tar.gz: 7460fa253f9b52a92748fa458492b1c7f4085badffed04fe4d3f45fe4f462a0610bbf4cc28beafaba7d853d1d44e3b6cae0aa0339cbc8643b235a9cbae6989b2

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 ## [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

data/README.md

@@ -34,30 +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
-To ensure optimal system performance and to prevent excessive disk usage, our logging system implements a strict retention policy:
+## Log Retention Policy
+To maintain system performance and manage disk space:
 
-* 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.
-
-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.
+* 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,8 +49,9 @@ 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|
@@ -63,6 +65,18 @@ module CustomLogSpace
       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

data/lib/custom_log_space/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CustomLogSpace
-  VERSION = "0.1.5"
+  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.5
+  version: 0.1.6
 platform: ruby
 authors:
 - nishikawa1031
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2023-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport