versalog 1.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1985cdbce1b4b3bb3dda6573700f12da050ac8b31f5a350be72bc66d1fe9fff5
+  data.tar.gz: d6b091088bb69c9f85c31da76bd1a3e474aa6b75c7952ef0ab6198f66fd9764d
+SHA512:
+  metadata.gz: 709fb02663f87fc5154b3c00784e3eda4ad0ee112bc88c78a469ac16ed9d7b98fbe3cf56c567783eed0d0188cb87951149c2f1be74d971ce6bed175929fefabc
+  data.tar.gz: 6e2510c7dd6658813b26e2dce0c8157eb14c5388e668c2773945722bd2fc4272538f081ee9433381bf43b7bd4b7f8991cf111db767b79230f261a4ab088ea708

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-10-06
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2025 VersaLog
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# What is VersaLog.rb?
+
+What is VersaLog.rb?
+VersaLog is a powerful and flexible logging library for Ruby.
+It supports everything from simple usage to advanced, highly customizable configurations to meet a wide range of needs.
+
+## Installation
+
+```
+
+```
+
+### Enum
+
+| Enum       | Description                                                                  |
+| ---------- | ---------------------------------------------------------------------------- |
+| `detailed` | Logs including execution time and log levels                                 |
+| `file`     | Logs with filename and line number                                           |
+| `simple`   | Simple and easy-to-read logs                                                 |
+| `simple2`  | Simple and easy-to-read log format. The timestamp is automatically included. |
+
+### Options
+
+| Options            | Description                                                                                                                                                                     |
+| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `show_file`        | True : Display filename and line number (for simple and detailed modes)                                                                                                         |
+| `show_tag`         | True : Show self.tag if no explicit tag is provided                                                                                                                             |
+| `tag`              | Default tag to use when show_tag is enabled                                                                                                                                     |
+| `enable_all`       | Shortcut to enable both show_file and show_tag                                                                                                                                  |
+| `notice`           | True : When an error or critical level log is output, a desktop notification (using plyer.notification) will be displayed. The notification includes the log level and message. |
+| `all_save`         | True : When an error or critical level log is output, the log will be saved to a file.                                                                                          |
+| `save_levels`      | A list of log levels to save. Defaults to ["INFO", "ERROR", "WARNING", "DEBUG", "CRITICAL"].                                                                                    |
+| `silent`           | True : Suppress standard output (print)                                                                                                                                         |
+| `catch_exceptions` | True : Automatically catch unhandled exceptions and log them as critical                                                                                                        |
+
+## Log save
+
+```
+[2025-08-06 04:10:36][INFO] : ok
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/versalog/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Versalog
+  VERSION = "1.6.0"
+end

data/lib/versalog.rb

@@ -0,0 +1,272 @@
+# frozen_string_literal: true
+
+require "time"
+require "caller"
+require "ENV"
+require "ARGV"
+require "thread"
+require "win32/notification"
+require "date"
+require "fileutils"
+
+require_relative "versalog/version"
+
+module Versalog
+  class VersaLog
+    COLOURS = {
+      "INFO": "\033[32m",
+      "ERROR": "\033[31m",
+      "WARNING": "\033[33m",
+      "DEBUG": "\033[36m",
+      "CRITICAL": "\033[35m",
+  }.freeze
+
+  SYMBOLS = {
+    "INFO": "[+]",
+    "ERROR": "[-]",
+    "WARNING": "[!]",
+    "DEBUG": "[D]",
+    "CRITICAL": "[C]",
+  }.freeze
+
+  RESET = "\033[0m"
+
+  VALID_MODES = ["simple", "simple2", "detailed", "file"].freeze
+  VALID_SAVE_LEVELS = ["INFO", "ERROR", "WARNING", "DEBUG", "CRITICAL"].freeze
+  
+  def initialize(
+    enum: "simple",
+    tag: nil,
+    show_file: false,
+    show_tag: false,
+    enable_all: false,
+    notice: false,
+    all_save: false,
+    save_levels: nil,
+    silent: false,
+    catch_exceptions: false)
+
+    if enable_all
+      show_file = true
+      show_tag  = true
+      notice    = true
+      all_save  = true
+    end
+
+    @enum = enum.downcase
+    @tag = tag
+    @show_file = show_file
+    @show_tag = show_tag
+    @enable_all = enable_all
+    @notice = notice
+    @all_save = all_save
+    @save_levels = save_levels
+    @silent = silent
+    @catch_exceptions = catch_exceptions
+
+    @log_queue = Queue.new
+    @worker_thread = Thread.new { _worker }
+    @last_cleanup_date = nil
+
+    unless VALID_MODES.include?(@enum)
+      raise ArgumentError, "Invalid enum: #{@enum}"
+    end
+
+    if @all_save
+      if @save_levels.nil?
+        @save_levels = VALID_SAVE_LEVELS.dup
+      elsif !@save_levels.is_a?(Array)
+        raise ArgumentError, "save_levels must be an Array. Example: ['ERROR']"
+      elsif !@save_levels.all? { |level| VALID_SAVE_LEVELS.include?(level) }
+        raise ArgumentError, "Invalid save_levels specified. Valid levels are: #{VALID_SAVE_LEVELS.join(', ')}"
+      end
+    end
+
+    if @catch_exceptions
+      at_exit do
+        exception = $!
+        _handle_exception(exception) if exception && exception.is_a?(Exception)
+      end
+    end
+  end
+  
+  private
+
+  def _handle_exception(exception)
+    tb_str = exception.backtrace.join("\n")
+    critical("Unhandled exception:\n#{exception.class}: #{exception.message}\n#{tb_str}")
+  end
+  
+  def _worker
+    loop do
+      job = @log_queue.pop
+      break if job.nil?
+      
+      case job[:type]
+      when :log
+        _save_log_sync(job[:log_text], job[:level])
+      when :exception
+        _handle_exception(job[:exception])
+      end
+    end
+  end
+
+  def _GetTime
+    return Time.now.strftime("%Y-%m-%d %H:%M:%S")
+  end
+
+  def _GetCaller
+    frame = caller(3, 1).first
+    return nil if frame.nil?
+    
+    match = frame.match(/^(.+):(\d+):/)
+    return nil unless match
+    
+    filename = File.basename(match[1])
+    lineno = match[2]
+    return "#{filename}:#{lineno}"
+  end
+
+  def _Cleanup_old_logs(days: 7)
+    log_dir = File.join(Dir.pwd, 'log')
+    return unless Dir.exist?(log_dir)
+
+    now = Time.now
+    Dir.entries(log_dir).each do |filename|
+      next unless filename.end_with?('.log')
+      next if filename == '.' || filename == '..'
+      
+      filepath = File.join(log_dir, filename)
+
+      begin
+        date_str = filename.gsub('.log', '')
+        file_date = Date.strptime(date_str, '%Y-%m-%d').to_time
+      rescue ArgumentError
+        file_date = File.mtime(filepath)
+      end
+
+      if (now - file_date) / (24 * 60 * 60) >= days
+        begin
+          File.delete(filepath)
+          info("[LOG CLEANUP] removed: #{filepath}") unless @silent
+        rescue => e
+          warning("[LOG CLEANUP WARNING] #{filepath} cannot be removed: #{e}") unless @silent
+        end
+      end
+    end
+  end
+
+  def _save_log_sync(log_text, level)
+    return unless @all_save
+    return unless @save_levels.include?(level)
+    
+    log_dir = File.join(Dir.pwd, 'log')
+    FileUtils.mkdir_p(log_dir)
+    log_file = File.join(log_dir, Time.now.strftime('%Y-%m-%d') + '.log')
+    
+    File.open(log_file, 'a', encoding: 'utf-8') do |f|
+      f.write(log_text + "\n")
+    end
+
+    today = Date.today
+    if @last_cleanup_date != today
+      _Cleanup_old_logs(days: 7)
+      @last_cleanup_date = today
+    end
+  end
+
+  def _save_log(log_text, level)
+    return unless @save_levels.include?(level)
+    
+    log_dir = File.join(Dir.pwd, 'log')
+    FileUtils.mkdir_p(log_dir) unless Dir.exist?(log_dir)
+    log_file = File.join(log_dir, Time.now.strftime('%Y-%m-%d') + '.log')
+    
+    File.open(log_file, 'a', encoding: 'utf-8') do |f|
+      f.write(log_text + "\n")
+    end
+  end
+
+  def _Log(msg, tye, tag = nil)
+    colors = COLOURS[tye.to_sym] || ""
+    types = tye.upcase
+
+    final_tag = tag || (@show_tag ? @tag : nil)
+    tag_str = final_tag || ""
+
+    caller_info = (@show_file || @enum == "file") ? _GetCaller() : ""
+
+    if @notice && ["ERROR", "CRITICAL"].include?(types)
+      Win32::Notification.new(
+        title: "#{types} Log notice",
+        message: msg,
+        app_name: "VersaLog"
+      ).show
+    end
+
+    case @enum
+    when "simple"
+      symbol = SYMBOLS[tye.to_sym] || "[?]"
+      if @show_file
+        formatted = "[#{caller_info}][#{tag_str}]#{colors}#{symbol}#{RESET} #{msg}"
+        plain = "[#{caller_info}][#{tag_str}]#{symbol} #{msg}"
+      else
+        formatted = "#{colors}#{symbol}#{RESET} #{msg}"
+        plain = "#{symbol} #{msg}"
+      end
+
+    when "simple2"
+      symbol = SYMBOLS[tye.to_sym] || "[?]"
+      time = _GetTime()
+      if @show_file
+        formatted = "[#{time}] [#{caller_info}][#{tag_str}]#{colors}#{symbol}#{RESET} #{msg}"
+        plain = "[#{time}] [#{caller_info}][#{tag_str}]#{symbol} #{msg}"
+      else
+        formatted = "[#{time}] #{colors}#{symbol}#{RESET} #{msg}"
+        plain = "[#{time}] #{symbol} #{msg}"
+      end
+
+    when "file"
+      formatted = "[#{caller_info}]#{colors}[#{types}]#{RESET} #{msg}"
+      plain = "[#{caller_info}][#{types}] #{msg}"
+
+    else
+      time = _GetTime()
+      formatted = "[#{time}]#{colors}[#{types}]#{RESET}"
+      plain = "[#{time}][#{types}]"
+      if final_tag
+        formatted += "[#{final_tag}]"
+        plain += "[#{final_tag}]"
+      end
+      if @show_file
+        formatted += "[#{caller_info}]"
+        plain += "[#{caller_info}]"
+      end
+      formatted += " : #{msg}"
+      plain += " : #{msg}"
+    end
+
+    puts(formatted) unless @silent
+
+    @log_queue << { type: :log, log_text: plain, level: types }
+  end
+
+  def info(msg, tag = nil)
+    _Log(msg, "INFO", tag)
+  end
+
+  def error(msg, tag = nil)
+    _Log(msg, "ERROR", tag)
+  end
+
+  def warning(msg, tag = nil)
+    _Log(msg, "WARNING", tag)
+  end
+
+  def debug(msg, tag = nil)
+    _Log(msg, "DEBUG", tag)
+  end
+
+  def critical(msg, tag = nil)
+    _Log(msg, "CRITICAL", tag)
+  end

data/sig/versalog.rbs

@@ -0,0 +1,4 @@
+module Versalog
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: versalog
+version: !ruby/object:Gem::Version
+  version: 1.6.0
+platform: ruby
+authors:
+- kaedeek
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: VersaLog is a logging library for Ruby.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/versalog.rb
+- lib/versalog/version.rb
+- sig/versalog.rbs
+homepage: https://github.com/VersaLog/VersaLog.rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/VersaLog/VersaLog.rb
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: VersaLog is a logging library for Ruby.
+test_files: []