emoji_logs 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb2133bfa2ba9c7980ee60b811a8228160b5b40de82377eb3fa20a8aee0b4c6c
+  data.tar.gz: 211042e8557a1771054272223731520160fed36c6faabb9f30b221ff7a333430
+SHA512:
+  metadata.gz: afd9d2e9372fac301c26159789ac4e60bd8b1fd90b7518549ff2f9f378f06dbe6eb5dd3b2f91ec9eff191856dd82b771e18ccfb2e7a2b318184033ed9fbc9905
+  data.tar.gz: 1b5c8ba9785331f5a46339c5eb3d09422bac3c9389f6e348e4a693ef991210e6b906caedad096d3a8f4517f71305dc2e4796f674e7fbcff4b1f9ae1b7490f7b4

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-01-06
+
+### Added
+- Initial release
+- Basic emoji-based logging with 6 log levels (debug, info, success, warn, error, fatal)
+- Support for tagged logs
+- Block syntax for lazy evaluation
+- Configurable log levels
+- Custom output destinations
+- Zero dependencies

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Your Name
+
+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,168 @@
+# 🎨 EmojiLogger
+
+A tiny Ruby logger that makes logs easier (and more fun) to read by adding expressive emojis.
+
+Because logs don't have to be boring.
+
+---
+
+## ✨ Features
+
+- Simple, intuitive API
+- Emoji-based log levels
+- Optional tagged logs
+- No dependencies
+- Works anywhere Ruby runs
+
+## 📦 Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'emoji_logger'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install emoji_logger
+```
+
+## 🚀 Usage
+
+### Basic Logging
+
+```ruby
+require 'emoji_logger'
+
+logger = EmojiLogger.new
+
+logger.debug("Starting application")
+logger.info("Server listening on port 3000")
+logger.success("User authentication successful")
+logger.warn("API rate limit approaching")
+logger.error("Failed to connect to database")
+logger.fatal("System out of memory")
+```
+
+Output:
+```
+🔍  2026-01-06 10:30:15 DEBUG: Starting application
+ℹ️  2026-01-06 10:30:16 INFO: Server listening on port 3000
+✅  2026-01-06 10:30:17 SUCCESS: User authentication successful
+⚠️  2026-01-06 10:30:18 WARN: API rate limit approaching
+❌  2026-01-06 10:30:19 ERROR: Failed to connect to database
+💥  2026-01-06 10:30:20 FATAL: System out of memory
+```
+
+### Tagged Logs
+
+Add context to your logs with tags:
+
+```ruby
+logger.info("Processing payment", tag: "Payment")
+logger.success("Email sent", tag: "Notifications")
+logger.error("Invalid request", tag: "API")
+```
+
+Output:
+```
+ℹ️  2026-01-06 10:30:15 INFO [Payment]: Processing payment
+✅  2026-01-06 10:30:16 SUCCESS [Notifications]: Email sent
+❌  2026-01-06 10:30:17 ERROR [API]: Invalid request
+```
+
+### Block Syntax
+
+Use blocks for lazy evaluation:
+
+```ruby
+logger.debug { "Expensive computation: #{expensive_operation}" }
+```
+
+The block is only evaluated if the log level is enabled.
+
+### Log Levels
+
+Set the minimum log level:
+
+```ruby
+logger = EmojiLogger.new(level: :info)
+
+logger.debug("This won't be logged")
+logger.info("This will be logged")
+```
+
+Available levels (in order):
+- `:debug` 🔍
+- `:info` ℹ️
+- `:success` ✅ (also available as `logger.ok`)
+- `:warn` ⚠️
+- `:error` ❌
+- `:fatal` 💥
+
+### Custom Output
+
+Log to a file or any IO object:
+
+```ruby
+# Log to a file
+File.open("app.log", "a") do |file|
+  logger = EmojiLogger.new(file)
+  logger.info("Logging to file")
+end
+
+# Log to StringIO (useful for testing)
+require 'stringio'
+output = StringIO.new
+logger = EmojiLogger.new(output)
+logger.info("Test message")
+puts output.string
+```
+
+## 🎯 Why EmojiLogger?
+
+Traditional logs can be hard to scan, especially when debugging or monitoring applications. Emojis provide instant visual cues that make it easier to:
+
+- 👀 Quickly spot errors and warnings in long log files
+- 🎨 Differentiate between log levels at a glance
+- 😊 Make development more enjoyable
+- 🚀 Stay compatible with all Ruby environments (no external dependencies)
+
+## 🧪 Development
+
+After checking out the repo, run:
+
+```bash
+bundle install
+rake spec
+```
+
+To install this gem onto your local machine:
+
+```bash
+rake install
+```
+
+To release a new version:
+
+1. Update the version number in `lib/emoji_logger/version.rb`
+2. Run `bundle exec rake release` to create a git tag and push to RubyGems
+
+## 🤝 Contributing
+
+Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration.
+
+## 📄 License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 🙏 Acknowledgments
+
+Inspired by the need for more readable logs and the universal language of emojis.

data/lib/emoji_logger/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class EmojiLogs
+  VERSION = "0.1.1"
+end

data/lib/emoji_logs/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class EmojiLogs
+  VERSION = "0.1.1"
+end

data/lib/emoji_logs.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "emoji_logs/version"
+
+class EmojiLogs
+  LEVELS = {
+    debug: { emoji: "🔍", name: "DEBUG" },
+    info: { emoji: "ℹ️", name: "INFO" },
+    success: { emoji: "✅", name: "SUCCESS" },
+    warn: { emoji: "⚠️", name: "WARN" },
+    error: { emoji: "❌", name: "ERROR" },
+    fatal: { emoji: "💥", name: "FATAL" }
+  }.freeze
+
+  attr_accessor :level, :output
+
+  def initialize(output = $stdout, level: :debug)
+    @output = output
+    @level = level
+  end
+
+  # Log methods for each level
+  def debug(message = nil, tag: nil, &block)
+    log(:debug, message, tag: tag, &block)
+  end
+
+  def info(message = nil, tag: nil, &block)
+    log(:info, message, tag: tag, &block)
+  end
+
+  def success(message = nil, tag: nil, &block)
+    log(:success, message, tag: tag, &block)
+  end
+
+  def warn(message = nil, tag: nil, &block)
+    log(:warn, message, tag: tag, &block)
+  end
+
+  def error(message = nil, tag: nil, &block)
+    log(:error, message, tag: tag, &block)
+  end
+
+  def fatal(message = nil, tag: nil, &block)
+    log(:fatal, message, tag: tag, &block)
+  end
+
+  # Alias for success
+  def ok(message = nil, tag: nil, &block)
+    success(message, tag: tag, &block)
+  end
+
+  private
+
+  def log(severity, message = nil, tag: nil)
+    return if severity_level(severity) < severity_level(@level)
+
+    message = yield if block_given?
+    return unless message
+
+    level_info = LEVELS[severity]
+    timestamp = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+    tag_str = tag ? " [#{tag}]" : ""
+    
+    formatted = "#{level_info[:emoji]}  #{timestamp} #{level_info[:name]}#{tag_str}: #{message}\n"
+    @output.write(formatted)
+    @output.flush if @output.respond_to?(:flush)
+  end
+
+  def severity_level(level)
+    LEVELS.keys.index(level) || 0
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: emoji_logs
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Serhiy Yosypenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: EmojiLogs is a simple, zero-dependency Ruby logger that uses emojis to
+  make log levels instantly recognizable. Perfect for development, debugging, and
+  making logs more enjoyable to read.
+email:
+- serhiy.yosipenko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/emoji_logger/version.rb
+- lib/emoji_logs.rb
+- lib/emoji_logs/version.rb
+homepage: https://github.com/yourusername/emoji_logs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yourusername/emoji_logs
+  source_code_uri: https://github.com/syosypenko/emoji_logger
+  changelog_uri: https://github.com/syosypenko/emoji_logger/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: A tiny Ruby logger that makes logs easier (and more fun) to read by adding
+  expressive emojis.
+test_files: []