pretty_logs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cdc491297eaf5042da0ed4b0ff4034442a07c4b6652f8512d53bd4efd71bc9f0
+  data.tar.gz: e877065fdd4cb65d9588a49ec5fe500ae5183c8cd3960d4150809f85783baa33
+SHA512:
+  metadata.gz: 07ff6f04a9396dddb22c983e0894cc56bebb6a92e5f322454c0a90e22676b3bc22bacd2b699da094a754fc1885afcd32a41e9d2213427af42831e64aec65e8d4
+  data.tar.gz: 55b7ef4541a3ca8d0e0b41a4eb204b622731fc74610e4f62b3a759f91abee7a8e44157d2b4707f1c442b69de2ae731141f596685d1b8483e74d81439e6f7f216

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to `pretty_logs` 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).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-06-30
+
+### Added
+- Initial release of `pretty_logs`
+- JSON log parsing via `PrettyLogs::Parsers::JsonParser`
+- Plain-text log parsing via `PrettyLogs::Parsers::PlainTextParser` (supports ISO 8601 timestamps with timezone offsets and milliseconds)
+- Colorized output with per-level colors: DEBUG (cyan), INFO (green), WARN (yellow), ERROR (red), FATAL (magenta)
+- Structured multi-line output mode (default) — timestamp/level header + indented fields
+- Simple single-line output mode (`--simple`)
+- Auto-detection of log format (`--format auto`, `json`, or `plain`)
+- `--no-color` flag to disable colorized output
+- CLI tool `log-pretty` for piping log streams
+- Ruby library API (`PrettyLogs::Formatter`, parsers)
+- Full RSpec test suite (14 examples)

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Brijesh S A
+
+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,264 @@
+<div align="center">
+
+# 🌈 log-pretty
+
+**Transform raw logs into beautiful, human-readable output — instantly.**
+
+[![Gem Version](https://badge.fury.io/rb/log_pretty.svg)](https://badge.fury.io/rb/log_pretty)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE.txt)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%202.7.0-red.svg)](https://www.ruby-lang.org)
+[![Tests](https://img.shields.io/badge/tests-14%20passing-brightgreen.svg)](spec/)
+
+</div>
+
+---
+
+```
+# Before — raw JSON log
+{"timestamp":"2026-04-24T22:38:51Z","level":"error","message":"DB timeout","code":503,"retry":true}
+
+# After — log-pretty output
+2026-04-24T22:38:51Z [ERROR]
+  Message: DB timeout
+  Code: 503
+  Retry: true
+```
+
+---
+
+## ✨ Features
+
+| | Feature | Description |
+|---|---------|-------------|
+| 🎨 | **Colorized levels** | `DEBUG`=cyan · `INFO`=green · `WARN`=yellow · `ERROR`=red · `FATAL`=magenta |
+| 📋 | **Structured output** | Indented, field-by-field display — scan logs at a glance |
+| 🔄 | **Auto-detect format** | Parses JSON and plain-text logs automatically |
+| 🔧 | **CLI pipe tool** | `tail -f app.log \| log-pretty` — works anywhere |
+| 📚 | **Ruby library** | Embed directly in your Ruby app or Rack middleware |
+| ⚡ | **Minimal footprint** | Only one runtime dependency: [rainbow](https://github.com/nicholaides/rainbow) |
+
+---
+
+## 📦 Installation
+
+### Via RubyGems (recommended)
+
+```bash
+gem install pretty_logs
+```
+
+### Via Bundler
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'pretty_logs'
+```
+
+Then:
+
+```bash
+bundle install
+```
+
+### From Source
+
+```bash
+git clone https://github.com/brijeshsajeev/log-pretty
+cd log-pretty/log_pretty
+bundle install
+bundle exec rake install
+```
+
+---
+
+## 🚀 CLI Usage
+
+`log-pretty` reads from **stdin** and writes prettified output to **stdout**.
+
+```bash
+# Pipe a file
+log-pretty < app.log
+
+# Tail live logs
+tail -f production.log | log-pretty
+
+# Pipe from a running process
+docker logs -f my-container | log-pretty
+rails server 2>&1 | log-pretty
+```
+
+### Options
+
+| Flag | Description |
+|------|-------------|
+| `-f`, `--format FORMAT` | Force format: `auto` (default), `json`, `plain` |
+| `-s`, `--simple` | Single-line output instead of structured |
+| `-c`, `--[no-]color` | Enable/disable colors (default: enabled) |
+| `-h`, `--help` | Show help |
+
+### Examples
+
+**JSON log:**
+```bash
+echo '{"timestamp":"2026-04-24T22:38:51Z","level":"info","message":"User logged in","user_id":123}' | log-pretty
+# 2026-04-24T22:38:51Z [INFO]
+#   Message: User logged in
+#   User_id: 123
+```
+
+**Plain-text log:**
+```bash
+echo '2026-04-24T22:38:51Z [ERROR] Connection timeout' | log-pretty
+# 2026-04-24T22:38:51Z [ERROR]
+#   Message: Connection timeout
+```
+
+**Simple single-line output:**
+```bash
+tail -f app.log | log-pretty --simple
+# 2026-04-24T22:38:51Z [INFO] Application started
+# 2026-04-24T22:38:52Z [WARN] High memory usage
+```
+
+**No colors (for log files / CI):**
+```bash
+log-pretty --no-color < app.log > cleaned.log
+```
+
+---
+
+## 📚 Ruby Library Usage
+
+```ruby
+require 'pretty_logs'
+
+formatter = PrettyLogs::Formatter.new(structured: true)
+
+# Format a hash directly
+entry = {
+  timestamp: "2026-04-24T22:38:51Z",
+  level: "info",
+  message: "Processing request",
+  request_id: "abc123",
+  duration_ms: 42
+}
+puts formatter.format(entry)
+# 2026-04-24T22:38:51Z [INFO]
+#   Message: Processing request
+#   Request_id: abc123
+#   Duration_ms: 42
+
+# Parse and format a JSON log line
+json_line = '{"level":"error","message":"Database error","code":500}'
+parsed = PrettyLogs::Parsers::JsonParser.parse(json_line)
+puts formatter.format(parsed)
+
+# Parse and format a plain-text log line
+plain_line = "2026-04-24T22:38:51Z [WARN] High memory usage"
+parsed = PrettyLogs::Parsers::PlainTextParser.parse(plain_line)
+puts formatter.format(parsed)
+```
+
+---
+
+## 📋 Supported Log Formats
+
+### JSON Logs
+
+Any valid JSON object. Recognized fields:
+
+| Field | Description |
+|-------|-------------|
+| `timestamp` | ISO 8601 timestamp |
+| `level` | Log level (`debug`, `info`, `warn`, `error`, `fatal`) |
+| `message` | Log message |
+| *any other field* | Displayed as additional structured data |
+
+### Plain-Text Logs
+
+```
+YYYY-MM-DDTHH:MM:SS[.mmm][Z|±HH:MM] [LEVEL] Message text
+```
+
+Examples:
+```
+2026-04-24T22:38:51Z [INFO] Application started
+2026-04-24T22:38:51.123Z [ERROR] Connection failed
+2026-04-24T22:38:51.000+05:30 [DEBUG] Cache miss for key=user:42
+```
+
+---
+
+## 🎨 Log Level Colors
+
+| Level | Color | Example use |
+|-------|-------|-------------|
+| `DEBUG` | Cyan | Low-level diagnostics |
+| `INFO` | Green | Normal operations |
+| `WARN` / `WARNING` | Yellow | Something may need attention |
+| `ERROR` | Red | Something failed |
+| `FATAL` | Magenta | Critical failure |
+
+---
+
+## 🔧 CI / Automation Usage
+
+Disable colors for clean output in CI pipelines:
+
+```bash
+# GitHub Actions, Jenkins, etc.
+cat build.log | log-pretty --no-color
+
+# Or via env (Rainbow respects NO_COLOR)
+NO_COLOR=1 log-pretty < app.log
+```
+
+---
+
+## 🛠 Development
+
+```bash
+git clone https://github.com/brijeshsajeev/log-pretty
+cd log-pretty/log_pretty
+bundle install
+
+bundle exec rspec          # Run test suite
+bundle exec log-pretty     # Test CLI manually
+```
+
+---
+
+## 🧪 Testing
+
+```bash
+bundle exec rspec
+```
+
+```
+14 examples, 0 failures  ✅
+```
+
+---
+
+## 📄 License
+
+[MIT License](LICENSE.txt) © 2026 [Brijesh S A](https://github.com/brijeshsajeev)
+
+---
+
+## 🤝 Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/brijeshsajeev/log-pretty/issues).
+
+1. Fork the repository
+2. Create your branch: `git checkout -b feature/my-feature`
+3. Add tests for your changes
+4. Run `bundle exec rspec` — all tests must pass
+5. Submit a Pull Request
+
+---
+
+<div align="center">
+Made with ❤️ by <a href="https://github.com/brijeshsajeev">Brijesh S A</a>
+</div>

data/bin/log-pretty

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+require_relative "../lib/pretty_logs"
+
+options = {
+  format: :auto,
+  output: :structured,
+  color: true
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: log-pretty [options]"
+
+  opts.on("-f", "--format FORMAT", "Log format: auto, json, plain (default: auto)") do |f|
+    options[:format] = f.to_sym
+  end
+
+  opts.on("-s", "--simple", "Use simple output format") do
+    options[:output] = :simple
+  end
+
+  opts.on("-c", "--[no-]color", "Enable/disable colorized output (default: enabled)") do |c|
+    options[:color] = c
+  end
+
+  opts.on("-h", "--help", "Show this help message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+formatter = PrettyLogs::Formatter.new(structured: options[:output] == :structured)
+
+STDIN.each_line do |line|
+  line.chomp!
+  next if line.empty?
+
+  # Try to parse JSON first, then plain text
+  entry = if options[:format] == :json
+            PrettyLogs::Parsers::JsonParser.parse(line)
+          elsif options[:format] == :plain
+            PrettyLogs::Parsers::PlainTextParser.parse(line)
+          else
+            PrettyLogs::Parsers::JsonParser.parse(line) ||
+              PrettyLogs::Parsers::PlainTextParser.parse(line) ||
+              { message: line }
+          end
+
+  next if entry.nil?
+
+  puts formatter.format(entry)
+end

data/lib/pretty_logs/formatter.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "rainbow"
+
+module PrettyLogs
+  class Formatter
+    LEVEL_COLORS = {
+      debug: :cyan,
+      info: :green,
+      warn: :yellow,
+      error: :red,
+      fatal: :magenta,
+      warning: :yellow,
+      unknown: :white
+    }.freeze
+
+    def initialize(structured: true)
+      @structured = structured
+    end
+
+    def format(log_entry)
+      return format_structured(log_entry) if @structured
+
+      format_simple(log_entry)
+    end
+
+    private
+
+    def format_simple(entry)
+      timestamp = entry[:timestamp] || ""
+      level = entry[:level] || "UNKNOWN"
+      message = entry[:message] || ""
+
+      color = level_color(level)
+      formatted_level = Rainbow(level.upcase).color(color).bright
+
+      "#{timestamp} [#{formatted_level}] #{message}"
+    end
+
+    def format_structured(entry)
+      lines = []
+
+      # Header with timestamp and level
+      timestamp = entry[:timestamp] || ""
+      level = entry[:level] || "UNKNOWN"
+      color = level_color(level)
+      formatted_level = Rainbow(level.upcase).color(color).bright
+      header = "#{timestamp} [#{formatted_level}]"
+      lines << header
+
+      # Message
+      message = entry[:message] || ""
+      lines << "  Message: #{message}" if message.to_s.length > 0
+
+      # Additional fields
+      entry.each do |key, value|
+        next if %i[timestamp level message].include?(key)
+        next if value.nil?
+
+        key_str = Rainbow(key.to_s.capitalize).color(:blue)
+        lines << "  #{key_str}: #{value}"
+      end
+
+      lines.join("\n")
+    end
+
+    def level_color(level)
+      LEVEL_COLORS[level.to_s.downcase.to_sym] || :white
+    end
+  end
+end

data/lib/pretty_logs/parsers/json_parser.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "json"
+
+module PrettyLogs
+  module Parsers
+    class JsonParser
+      def self.parse(line)
+        JSON.parse(line, symbolize_names: true)
+      rescue JSON::ParserError
+        nil
+      end
+
+      def self.parse?(line)
+        !parse(line).nil?
+      end
+    end
+  end
+end

data/lib/pretty_logs/parsers/plain_text_parser.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module PrettyLogs
+  module Parsers
+    class PlainTextParser
+      # Matches standard log format: TIMESTAMP [LEVEL] message
+      LOG_PATTERN = /^(\d{4}-\d{2}-\d{2}[T\s]\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})?)\s*\[(\w+)\]\s+(.*)$/
+
+      def self.parse(line)
+        match = line.match(LOG_PATTERN)
+        return nil unless match
+
+        {
+          timestamp: match[1],
+          level: match[2],
+          message: match[3]
+        }
+      end
+
+      def self.parse?(line)
+        !parse(line).nil?
+      end
+    end
+  end
+end

data/lib/pretty_logs/version.rb

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

data/lib/pretty_logs.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "pretty_logs/version"
+require_relative "pretty_logs/formatter"
+require_relative "pretty_logs/parsers/json_parser"
+require_relative "pretty_logs/parsers/plain_text_parser"
+
+module PrettyLogs
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: pretty_logs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brijesh S A
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: PrettyLogs transforms raw JSON and plain-text logs into beautiful, human-readable,
+  colorized output. Use it as a CLI pipe tool or embed it directly in your Ruby application.
+email:
+- brijesh00300@gmail.com
+executables:
+- log-pretty
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- bin/log-pretty
+- lib/pretty_logs.rb
+- lib/pretty_logs/formatter.rb
+- lib/pretty_logs/parsers/json_parser.rb
+- lib/pretty_logs/parsers/plain_text_parser.rb
+- lib/pretty_logs/version.rb
+homepage: https://github.com/BrijeshSajeev/log_pretty
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BrijeshSajeev/log_pretty
+  source_code_uri: https://github.com/BrijeshSajeev/log_pretty
+  changelog_uri: https://github.com/BrijeshSajeev/log_pretty/blob/main/log_pretty/CHANGELOG.md
+  bug_tracker_uri: https://github.com/BrijeshSajeev/log_pretty/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Prettify logs with colorized output and structured formatting.
+test_files: []