logviewer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5af89372bbff4a9d1a87c53c87be966b685532e5734cddaca3d1f338ecca806d
+  data.tar.gz: 04acdaa2c421345747cdfdaf0445aa139252bac918b74df4d41fa34b0a6451b2
+SHA512:
+  metadata.gz: 7d55746ec6dddde8279deb41c50429acb38f6e3c9bd55350388aa8cda585a33c482b64e6d84acd31b45708e9f84aa239b02a6e6494a82d4f65e992b724e5417b
+  data.tar.gz: b895f2d31c99001de43836e96c3dacd092b87c1e16fd761baf93321b2fee5a2300228614281266d07dc90926f79031fa7b2547ad647b7efa645aee01bdea8115

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Justin Bishop
+
+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,128 @@
+# LogViewer
+
+A Ruby gem that converts NDJSON log files into a readable HTML format for easy viewing in your browser.
+
+## Features
+
+- Converts NDJSON log files to HTML tables
+- Filters logs by minimum level (trace, debug, info, warning, error, fatal)
+- Displays key fields: level, text, file, and method
+- Color-coded log levels for easy identification
+- Responsive design that works well in any browser
+- Automatically opens the generated HTML file in your default browser
+
+## Installation
+
+Install the gem from RubyGems:
+
+```bash
+gem install logviewer
+```
+
+## Usage
+
+### Basic Usage
+
+```bash
+logviewer example.ndjson
+```
+
+This will:
+1. Parse the NDJSON file
+2. Include all log levels (debug and above)
+3. Generate an HTML file in `/tmp/`
+4. Open the HTML file in your default browser
+
+### Filter by Log Level
+
+```bash
+logviewer --level info example.ndjson
+```
+
+Only shows log entries with level "info" and above (info, warning, error, fatal).
+
+### Command Line Options
+
+- `-l, --level LEVEL`: Set minimum log level (trace, debug, info, warning, error, fatal)
+- `-v, --version`: Show version
+- `-h, --help`: Show help message
+
+### Examples
+
+```bash
+# Show all logs
+logviewer app.ndjson
+
+# Show only warnings and above
+logviewer --level warning app.ndjson
+
+# Show only errors and fatal logs
+logviewer -l error system.ndjson
+
+# Show version
+logviewer --version
+```
+
+## Expected Log Format
+
+The tool expects NDJSON (newline-delimited JSON) files where each line contains a JSON object with these fields:
+
+- `level`: Log level (trace, debug, info, warning, error, fatal)
+- `text`: The log message
+- `file`: Source file name
+- `method`: Function/method name
+
+Example log entry:
+```json
+{"level":"info","text":"User logged in successfully","file":"auth.rb","method":"login"}
+```
+
+## Output
+
+The generated HTML file will be saved in `/tmp/` with a timestamp and automatically opened in your browser. The HTML includes:
+
+- A responsive table layout
+- Color-coded log levels
+- Sticky header for easy navigation
+- Hover effects for better readability
+- File and method names in monospace font
+
+## Development
+
+After checking out the repo, run the following commands to set up development:
+
+```bash
+# Install dependencies
+bundle install
+
+# Build the gem
+rake build
+
+# Install locally for testing
+rake install
+
+# Clean build artifacts
+rake clean
+```
+
+### Building and Publishing
+
+```bash
+# Build the gem
+rake build
+
+# Install locally
+rake install
+
+# Push to RubyGems (requires authentication)
+rake push
+```
+
+## Requirements
+
+- Ruby 2.5.0 or higher
+- macOS (uses `open` command to launch browser)
+
+## License
+
+MIT

data/bin/logviewer

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'logviewer'
+
+LogViewer::CLI.new.run

data/lib/logviewer/version.rb

@@ -0,0 +1,3 @@
+module LogViewer
+  VERSION = "1.0.0"
+end

data/lib/logviewer.rb

@@ -0,0 +1,282 @@
+require 'json'
+require 'optparse'
+require 'fileutils'
+require_relative 'logviewer/version'
+
+module LogViewer
+  class CLI
+    LOG_LEVELS = {
+      'trace' => 0,
+      'debug' => 1,
+      'info' => 2,
+      'warning' => 3,
+      'error' => 4,
+      'fatal' => 5
+    }
+
+    def initialize(args = ARGV)
+      @args = args
+      @min_level = 'debug'
+      @input_file = nil
+    end
+
+    def parse_options
+      OptionParser.new do |opts|
+        opts.banner = "Usage: logviewer [options] <ndjson_file>"
+        
+        opts.on('-l', '--level LEVEL', 'Minimum log level (trace, debug, info, warning, error, fatal)') do |level|
+          level = level.downcase
+          if LOG_LEVELS.key?(level)
+            @min_level = level
+          else
+            puts "Invalid log level: #{level}"
+            puts "Valid levels: #{LOG_LEVELS.keys.join(', ')}"
+            exit 1
+          end
+        end
+        
+        opts.on('-v', '--version', 'Show version') do
+          puts "logviewer #{LogViewer::VERSION}"
+          exit
+        end
+        
+        opts.on('-h', '--help', 'Show this help message') do
+          puts opts
+          exit
+        end
+      end.parse!(@args)
+      
+      if @args.empty?
+        puts "Error: Please provide an NDJSON file path"
+        puts "Usage: logviewer [options] <ndjson_file>"
+        exit 1
+      end
+      
+      @input_file = @args[0]
+      
+      unless File.exist?(@input_file)
+        puts "Error: File not found: #{@input_file}"
+        exit 1
+      end
+    end
+
+    def should_include_log?(level)
+      return true unless level
+      LOG_LEVELS[level.downcase] >= LOG_LEVELS[@min_level]
+    end
+
+    def parse_logs
+      logs = []
+      
+      File.foreach(@input_file) do |line|
+        begin
+          log_entry = JSON.parse(line.strip)
+          
+          if should_include_log?(log_entry['level'])
+            logs << {
+              level: log_entry['level'] || 'unknown',
+              text: log_entry['text'] || '',
+              file: log_entry['file'] || '',
+              method: log_entry['method'] || ''
+            }
+          end
+        rescue JSON::ParserError => e
+          puts "Warning: Skipping invalid JSON line: #{e.message}"
+        end
+      end
+      
+      logs
+    end
+
+    def level_color(level)
+      case level.downcase
+      when 'trace'
+        '#6c757d'
+      when 'debug'
+        '#6c757d'
+      when 'info'
+        '#0d6efd'
+      when 'warning'
+        '#fd7e14'
+      when 'error'
+        '#dc3545'
+      when 'fatal'
+        '#6f42c1'
+      else
+        '#000000'
+      end
+    end
+
+    def generate_html(logs)
+      html = <<~HTML
+        <!DOCTYPE html>
+        <html lang="en">
+        <head>
+            <meta charset="UTF-8">
+            <meta name="viewport" content="width=device-width, initial-scale=1.0">
+            <title>Log Viewer - #{File.basename(@input_file)}</title>
+            <style>
+                body {
+                    font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
+                    margin: 0;
+                    padding: 20px;
+                    background-color: #f8f9fa;
+                }
+                .container {
+                    max-width: 1400px;
+                    margin: 0 auto;
+                    background: white;
+                    border-radius: 8px;
+                    box-shadow: 0 2px 10px rgba(0,0,0,0.1);
+                    overflow: hidden;
+                }
+                .header {
+                    background: #343a40;
+                    color: white;
+                    padding: 20px;
+                    text-align: center;
+                }
+                .header h1 {
+                    margin: 0;
+                    font-size: 24px;
+                }
+                .header p {
+                    margin: 5px 0 0 0;
+                    opacity: 0.8;
+                }
+                .table-container {
+                    overflow-x: auto;
+                }
+                table {
+                    width: 100%;
+                    border-collapse: collapse;
+                    font-size: 14px;
+                }
+                th {
+                    background: #e9ecef;
+                    padding: 12px;
+                    text-align: left;
+                    font-weight: 600;
+                    border-bottom: 2px solid #dee2e6;
+                    position: sticky;
+                    top: 0;
+                }
+                td {
+                    padding: 10px 12px;
+                    border-bottom: 1px solid #dee2e6;
+                    vertical-align: top;
+                }
+                tr:hover {
+                    background-color: #f8f9fa;
+                }
+                .level {
+                    font-weight: bold;
+                    text-transform: uppercase;
+                    font-size: 12px;
+                    white-space: nowrap;
+                }
+                .text {
+                    max-width: 600px;
+                    word-wrap: break-word;
+                    white-space: pre-wrap;
+                }
+                .file {
+                    font-family: 'Monaco', 'Menlo', monospace;
+                    font-size: 12px;
+                    color: #666;
+                    max-width: 200px;
+                    word-wrap: break-word;
+                }
+                .method {
+                    font-family: 'Monaco', 'Menlo', monospace;
+                    font-size: 12px;
+                    color: #333;
+                    font-weight: 500;
+                }
+                .empty {
+                    color: #999;
+                    font-style: italic;
+                }
+            </style>
+        </head>
+        <body>
+            <div class="container">
+                <div class="header">
+                    <h1>Log Viewer</h1>
+                    <p>#{File.basename(@input_file)} • #{logs.length} entries • Level: #{@min_level.upcase}+</p>
+                </div>
+                <div class="table-container">
+                    <table>
+                        <thead>
+                            <tr>
+                                <th style="width: 80px;">Level</th>
+                                <th>Text</th>
+                                <th style="width: 200px;">File</th>
+                                <th style="width: 150px;">Method</th>
+                            </tr>
+                        </thead>
+                        <tbody>
+      HTML
+
+      logs.each do |log|
+        level_style = "color: #{level_color(log[:level])}"
+        text_content = log[:text].empty? ? '<span class="empty">-</span>' : log[:text]
+        file_content = log[:file].empty? ? '<span class="empty">-</span>' : log[:file]
+        method_content = log[:method].empty? ? '<span class="empty">-</span>' : log[:method]
+        
+        html += <<~HTML
+                                <tr>
+                                    <td class="level" style="#{level_style}">#{log[:level]}</td>
+                                    <td class="text">#{text_content}</td>
+                                    <td class="file">#{file_content}</td>
+                                    <td class="method">#{method_content}</td>
+                                </tr>
+        HTML
+      end
+
+      html += <<~HTML
+                        </tbody>
+                    </table>
+                </div>
+            </div>
+        </body>
+        </html>
+      HTML
+
+      html
+    end
+
+    def run
+      parse_options
+      
+      puts "Parsing log file: #{@input_file}"
+      puts "Minimum log level: #{@min_level}"
+      
+      logs = parse_logs
+      puts "Found #{logs.length} log entries matching criteria"
+      
+      if logs.empty?
+        puts "No log entries found matching the specified criteria."
+        exit 0
+      end
+      
+      html_content = generate_html(logs)
+      
+      # Use /tmp directory for HTML files
+      tmp_dir = '/tmp'
+      
+      # Generate output filename
+      base_name = File.basename(@input_file, '.*')
+      timestamp = Time.now.strftime('%Y%m%d_%H%M%S')
+      output_file = File.join(tmp_dir, "#{base_name}_#{timestamp}.html")
+      
+      # Write HTML file
+      File.write(output_file, html_content)
+      puts "HTML file created: #{output_file}"
+      
+      # Open in browser
+      system('open', output_file)
+      puts "Opening in browser..."
+    end
+  end
+end

data/logviewer.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/logviewer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logviewer"
+  spec.version       = LogViewer::VERSION
+  spec.authors       = ["Justin Bishop"]
+  spec.email         = ["jubishop@gmail.com"]
+
+  spec.summary       = "Convert NDJSON log files to HTML for easy viewing"
+  spec.description   = "A command-line tool that converts NDJSON log files into readable HTML format with filtering capabilities by log level"
+  spec.homepage      = "https://github.com/jubishop/logviewer"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.files         = Dir["lib/**/*", "bin/*", "README.md", "LICENSE", "*.gemspec"]
+  spec.bindir        = "bin"
+  spec.executables   = ["logviewer"]
+  spec.require_paths = ["lib"]
+
+  # No runtime dependencies - using only Ruby stdlib (json, optparse, fileutils)
+
+  # Development dependencies
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: logviewer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Justin Bishop
+bindir: bin
+cert_chain: []
+date: 2025-06-04 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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'
+description: A command-line tool that converts NDJSON log files into readable HTML
+  format with filtering capabilities by log level
+email:
+- jubishop@gmail.com
+executables:
+- logviewer
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/logviewer
+- lib/logviewer.rb
+- lib/logviewer/version.rb
+- logviewer.gemspec
+homepage: https://github.com/jubishop/logviewer
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: Convert NDJSON log files to HTML for easy viewing
+test_files: []