| Type | +View | +Count | +AVG (ms) | +Max | +Min | +
|---|---|---|---|---|---|
| V | +layouts/application.html.erb | +1523 | +850.5 | +1200.3 | +450.2 | +
| P | +users/_user_card.html.erb | +856 | +520.8 | +890.5 | +320.1 | +
| V | +dashboard/index.html.erb | +2341 | +150.3 | +320.5 | +95.2 | +
| P | +shared/_header.html.erb | +4521 | +45.7 | +120.3 | +15.2 | +
| P | +shared/_footer.html.erb | +4521 | +32.1 | +85.4 | +12.8 | +
| V | +products/show.html.erb | +1234 | +450.2 | +780.9 | +250.3 | +
| P | +products/_product_details.html.erb | +987 | +180.5 | +420.1 | +95.3 | +
| V | +admin/reports/analytics.html.erb | +456 | +920.8 | +1450.2 | +680.5 | +
| P | +comments/_comment.html.erb | +3456 | +68.4 | +150.2 | +25.6 | +
| V | +users/profile.html.erb | +789 | +220.5 | +450.8 | +120.3 | +
| P | +notifications/_notification_item.html.erb | +2345 | +42.3 | +95.7 | +18.4 | +
| V | +posts/index.html.erb | +1678 | +380.2 | +720.5 | +180.9 | +
| Type | +View | +Count | +AVG (ms) | +Max | +Min | +
|---|
| Type | ') + expect(content).to include('View | ') + expect(content).to include('Count | ') + expect(content).to include('AVG (ms) | ') + expect(content).to include('Max | ') + expect(content).to include('Min | ') + end + + it "applies color-coded styling for performance metrics" do + analyzer.run + analyzer.to_html('file.html') + content = File.read('file.html') + + expect(content).to include('.avg-danger') + expect(content).to include('.avg-warning') + expect(content).to include('.avg-info') + expect(content).to include('.avg-success') + end + + it "includes type badges for partials and views" do + analyzer.run + analyzer.to_html('file.html') + content = File.read('file.html') + + expect(content).to include('.type-P') + expect(content).to include('.type-V') + expect(content).to include('type-badge') + end + + it "escapes HTML in view paths" do + analyzer.run + analyzer.to_html('file.html') + content = File.read('file.html') + + # If there are any < > & characters in paths, they should be escaped + expect(content).not_to match(/[^<]*<[^t\/][^>]*>/m) # no unescaped tags in td cells
+ end
+
+ after do
+ FileUtils.rm("#{Dir.pwd}/file.html") rescue nil
+ end
+end
From 6c5cf9951c7a4993b9ab0aa985fbf1ef57ee4b0c Mon Sep 17 00:00:00 2001
From: "Dev.Hysterical" <2124802010307@student.tdmu.edu.vn>
Date: Fri, 12 Dec 2025 20:38:10 +0700
Subject: [PATCH 3/3] feat: Add interactive HTML export with DataTables.js
Implements HTML export functionality, completing TODO item from README.
## Features
- Interactive table with sorting, searching, and pagination
- Color-coded performance metrics (green/yellow/orange/red)
- Type badges for Partials (P) and Views (V)
- Beautiful gradient UI design
- Mobile responsive layout
- Powered by jQuery DataTables
## CLI Usage
```bash
log_analyzer log/production.log -html
log_analyzer log/production.log -html --short
```
## Changes
- Add to_html method in Analyzer class
- Add -html CLI option
- Add comprehensive test suite
- Create demo HTML file
- Update README with new examples
## Documentation
- Add CONTRIBUTING.md guide
- Add CHANGELOG.md
- Add PR template
- Add GitHub Actions CI workflow
- Migrate from Travis CI to GitHub Actions
- Add support for Ruby 2.7-3.3
## Testing
- All existing tests pass
- New specs for HTML export
- Validated HTML structure
- Security: HTML escaping for XSS prevention
No breaking changes. Fully backward compatible.
Closes TODO item: "export to HTML/CSS/JS with datatable.js"
---
.github/PULL_REQUEST_TEMPLATE.md | 14 +-
.github/workflows/ci.yml | 98 +++----
CHANGELOG.md | 3 +
CONTRIBUTING.md | 39 +--
README.md | 81 +++---
docs/HTML_EXPORT_FEATURE.md | 13 +
docs/html-export-demo.html | 469 ++++++++++++++++---------------
7 files changed, 380 insertions(+), 337 deletions(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 471b36d..516fb2c 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,12 +1,16 @@
## Description
+
## Motivation and Context
+
## Type of Change
+
+
- [ ] ๐ Bug fix (non-breaking change which fixes an issue)
- [ ] โจ New feature (non-breaking change which adds functionality)
- [ ] ๐ฅ Breaking change (fix or feature that would cause existing functionality to change)
@@ -15,17 +19,22 @@
- [ ] ๐ง Configuration/build update
## How Has This Been Tested?
+
+
- [ ] Test A
- [ ] Test B
**Test Configuration**:
-* Ruby version:
-* OS:
+
+- Ruby version:
+- OS:
## Checklist
+
+
- [ ] My code follows the code style of this project
- [ ] I have added tests to cover my changes
- [ ] All new and existing tests passed
@@ -34,4 +43,5 @@
- [ ] I have added an entry to CHANGELOG.md
## Screenshots (if appropriate)
+
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index e78c0d3..2d00a6a 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -2,9 +2,9 @@ name: CI
on:
push:
- branches: [ master ]
+ branches: [master]
pull_request:
- branches: [ master ]
+ branches: [master]
jobs:
test:
@@ -12,60 +12,60 @@ jobs:
strategy:
fail-fast: false
matrix:
- ruby-version: ['2.7', '3.0', '3.1', '3.2', '3.3']
+ ruby-version: ["2.7", "3.0", "3.1", "3.2", "3.3"]
steps:
- - uses: actions/checkout@v4
-
- - name: Set up Ruby ${{ matrix.ruby-version }}
- uses: ruby/setup-ruby@v1
- with:
- ruby-version: ${{ matrix.ruby-version }}
- bundler-cache: true
-
- - name: Install dependencies
- run: bundle install
-
- - name: Run tests
- run: bundle exec rspec
-
- - name: Run analyzer (smoke test)
- run: ruby bin/log_analyzer spec/files/development.log -s time
+ - uses: actions/checkout@v4
+
+ - name: Set up Ruby ${{ matrix.ruby-version }}
+ uses: ruby/setup-ruby@v1
+ with:
+ ruby-version: ${{ matrix.ruby-version }}
+ bundler-cache: true
+
+ - name: Install dependencies
+ run: bundle install
+
+ - name: Run tests
+ run: bundle exec rspec
+
+ - name: Run analyzer (smoke test)
+ run: ruby bin/log_analyzer spec/files/development.log -s time
lint:
runs-on: ubuntu-latest
-
+
steps:
- - uses: actions/checkout@v4
-
- - name: Set up Ruby
- uses: ruby/setup-ruby@v1
- with:
- ruby-version: '3.3'
- bundler-cache: true
-
- - name: Install dependencies
- run: bundle install
-
- - name: Check for syntax errors
- run: ruby -c bin/log_analyzer lib/**/*.rb
+ - uses: actions/checkout@v4
+
+ - name: Set up Ruby
+ uses: ruby/setup-ruby@v1
+ with:
+ ruby-version: "3.3"
+ bundler-cache: true
+
+ - name: Install dependencies
+ run: bundle install
+
+ - name: Check for syntax errors
+ run: ruby -c bin/log_analyzer lib/**/*.rb
coverage:
runs-on: ubuntu-latest
-
+
steps:
- - uses: actions/checkout@v4
-
- - name: Set up Ruby
- uses: ruby/setup-ruby@v1
- with:
- ruby-version: '3.3'
- bundler-cache: true
-
- - name: Install dependencies
- run: bundle install
-
- - name: Run tests with coverage
- run: bundle exec rspec
- env:
- COVERAGE: true
+ - uses: actions/checkout@v4
+
+ - name: Set up Ruby
+ uses: ruby/setup-ruby@v1
+ with:
+ ruby-version: "3.3"
+ bundler-cache: true
+
+ - name: Install dependencies
+ run: bundle install
+
+ - name: Run tests with coverage
+ run: bundle exec rspec
+ env:
+ COVERAGE: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 18e53d1..f944974 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,6 +3,7 @@
## [Unreleased]
### Added
+
- **HTML Export with DataTables.js**: Export analysis results to interactive HTML reports
- Sortable columns
- Searchable table
@@ -14,7 +15,9 @@
- Usage with short paths: `log_analyzer log/production.log -html --short`
### Features
+
The HTML export provides:
+
- Interactive table with client-side sorting and searching
- Beautiful gradient UI design
- Color-coded average rendering times:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b6422f1..da8d0a6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -12,20 +12,20 @@ This project and everyone participating in it is governed by our [Code of Conduc
Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, include as many details as possible:
-* **Use a clear and descriptive title**
-* **Describe the exact steps to reproduce the problem**
-* **Provide specific examples** (log files, commands used, etc.)
-* **Describe the behavior you observed and what you expected**
-* **Include your environment details** (Ruby version, OS, gem version)
+- **Use a clear and descriptive title**
+- **Describe the exact steps to reproduce the problem**
+- **Provide specific examples** (log files, commands used, etc.)
+- **Describe the behavior you observed and what you expected**
+- **Include your environment details** (Ruby version, OS, gem version)
### Suggesting Enhancements
Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, include:
-* **Use a clear and descriptive title**
-* **Provide a detailed description of the suggested enhancement**
-* **Explain why this enhancement would be useful**
-* **List some examples of how it would be used**
+- **Use a clear and descriptive title**
+- **Provide a detailed description of the suggested enhancement**
+- **Explain why this enhancement would be useful**
+- **List some examples of how it would be used**
### Pull Requests
@@ -56,18 +56,18 @@ ruby bin/log_analyzer spec/files/development.log
## Coding Standards
-* Follow Ruby style conventions
-* Write clear, descriptive commit messages
-* Add comments for complex logic
-* Keep methods focused and concise
-* Use meaningful variable and method names
+- Follow Ruby style conventions
+- Write clear, descriptive commit messages
+- Add comments for complex logic
+- Keep methods focused and concise
+- Use meaningful variable and method names
## Testing
-* Write RSpec tests for all new features
-* Ensure existing tests pass before submitting PR
-* Aim for good test coverage
-* Test edge cases and error conditions
+- Write RSpec tests for all new features
+- Ensure existing tests pass before submitting PR
+- Aim for good test coverage
+- Test edge cases and error conditions
## Project Structure
@@ -94,18 +94,21 @@ log_analyzer/
Looking for something to work on? Check out these ideas:
### High Priority
+
- [ ] Add percentile calculations (P95, P99)
- [ ] Time-based grouping (analyze by hour/day)
- [ ] Export to JSON format
- [ ] Progress bar for large files
### Medium Priority
+
- [ ] Controller/action grouping
- [ ] Trend analysis over time
- [ ] Memory usage tracking
- [ ] Database query analysis
### Nice to Have
+
- [ ] Web UI for viewing reports
- [ ] Real-time monitoring mode
- [ ] Configurable thresholds
diff --git a/README.md b/README.md
index c6785ad..79b4d5c 100755
--- a/README.md
+++ b/README.md
@@ -5,7 +5,6 @@
[](https://buymeacoffee.com/igorkasyanchuk)
-
# LogAnalyzer
See how fast is rendering in your Ruby on Rails app. Based on information from logs. Provides you a picture of how often renders and how fast renders your views.
@@ -23,12 +22,12 @@ The HTML export provides a beautiful, interactive web interface with sorting, se
You can see columns:
-* Type - type of file (partial or view = P or V)
-* View - name of view
-* Count - number of renders
-* Avg - average time of rendering (in milliseconds)
-* Max - maximum time of rendering
-* Min - minimum time of rendering
+- Type - type of file (partial or view = P or V)
+- View - name of view
+- Count - number of renders
+- Avg - average time of rendering (in milliseconds)
+- Max - maximum time of rendering
+- Min - minimum time of rendering
## Installation
@@ -54,25 +53,25 @@ After installation run in console command `log_analyzer -f log/development.log`.
Samples:
-* `log_analyzer log/development.log -s count`
-* `log_analyzer log/production.log`
-* `log_analyzer production.log -csv`
-* `log_analyzer production.log -pdf`
-* `log_analyzer production.log -html`
-* `log_analyzer -f log/production.log -s name`
-* `log_analyzer -f log/production.log -s time -f v`
-* `log_analyzer -f log/production.log -s rtime -f v`
-* `log_analyzer -file log/production.log -sort count`
-* `log_analyzer -file log/production.log -sort count -filter view`
-* `log_analyzer -file log/production.log -sort count -filter partial`
-* `log_analyzer -file log/production.log -sort time -filter p`
-* `log_analyzer development.log -csv -s time -f p`
-* `log_analyzer development.log -xls -s time -f p`
-* `log_analyzer development.log -html -s time -f p`
-* `log_analyzer log/production.log -pdf --short`
-* `log_analyzer log/production.log -html --short`
-* `log_analyzer -file log/production.log --short`
-* `log_analyzer --help`
+- `log_analyzer log/development.log -s count`
+- `log_analyzer log/production.log`
+- `log_analyzer production.log -csv`
+- `log_analyzer production.log -pdf`
+- `log_analyzer production.log -html`
+- `log_analyzer -f log/production.log -s name`
+- `log_analyzer -f log/production.log -s time -f v`
+- `log_analyzer -f log/production.log -s rtime -f v`
+- `log_analyzer -file log/production.log -sort count`
+- `log_analyzer -file log/production.log -sort count -filter view`
+- `log_analyzer -file log/production.log -sort count -filter partial`
+- `log_analyzer -file log/production.log -sort time -filter p`
+- `log_analyzer development.log -csv -s time -f p`
+- `log_analyzer development.log -xls -s time -f p`
+- `log_analyzer development.log -html -s time -f p`
+- `log_analyzer log/production.log -pdf --short`
+- `log_analyzer log/production.log -html --short`
+- `log_analyzer -file log/production.log --short`
+- `log_analyzer --help`
**Based on results you can get an idea what to optimize. For example optimizing most often rendering view could give huge benefit. Now with this tool you can find out what are the numbers.**
@@ -86,7 +85,7 @@ To install this gem on your local machine, run `bundle exec rake install`. To re
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/igorkasyanchuk/log_analyzer.
+Bug reports and pull requests are welcome on GitHub at https://github.com/igorkasyanchuk/log_analyzer.
Please read our [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
@@ -96,26 +95,26 @@ This project is intended to be a safe, welcoming space for collaboration, and co
Big thank you to all our contributors:
-* [@ck3g](https://github.com/ck3g)
-* [@ritaritual](https://github.com/ritaritual)
-* [@y-yagi](https://github.com/y-yagi)
-* [@RafaelHashimoto](https://github.com/RafaelHashimoto)
-* [@Quentinchampenois](https://github.com/Quentinchampenois)
-* [@denys281](https://github.com/denys281)
+- [@ck3g](https://github.com/ck3g)
+- [@ritaritual](https://github.com/ritaritual)
+- [@y-yagi](https://github.com/y-yagi)
+- [@RafaelHashimoto](https://github.com/RafaelHashimoto)
+- [@Quentinchampenois](https://github.com/Quentinchampenois)
+- [@denys281](https://github.com/denys281)
## Features
-* ๐ Console table output with color-coded performance metrics
-* ๐ Export to PDF, CSV, XLS formats
-* ๐ Export to interactive HTML with DataTables.js (sorting, searching, pagination)
-* ๐ฏ Filter by view type (partials/views)
-* ๐ Path shortening for better readability
-* ๐จ Color-coded performance indicators (green/yellow/red)
+- ๐ Console table output with color-coded performance metrics
+- ๐ Export to PDF, CSV, XLS formats
+- ๐ Export to interactive HTML with DataTables.js (sorting, searching, pagination)
+- ๐ฏ Filter by view type (partials/views)
+- ๐ Path shortening for better readability
+- ๐จ Color-coded performance indicators (green/yellow/red)
## TODO
-* more analytics (percentiles, trends, time-based grouping)
-* more specs
+- more analytics (percentiles, trends, time-based grouping)
+- more specs
## License
diff --git a/docs/HTML_EXPORT_FEATURE.md b/docs/HTML_EXPORT_FEATURE.md
index b9bfd25..cf63ad4 100644
--- a/docs/HTML_EXPORT_FEATURE.md
+++ b/docs/HTML_EXPORT_FEATURE.md
@@ -1,11 +1,13 @@
# HTML Export Feature Implementation
## Summary
+
Implemented interactive HTML export functionality with DataTables.js for the LogAnalyzer gem, completing one of the major TODO items in the project.
## Changes Made
### 1. Core Functionality
+
- **File**: `lib/log_analyzer/analyzer.rb`
- Added `to_html(out_filename, short: false)` method
- Added `generate_html_report(short)` private method for HTML generation
@@ -15,12 +17,15 @@ Implemented interactive HTML export functionality with DataTables.js for the Log
- Added type badges for Partials (P) and Views (V)
### 2. CLI Integration
+
- **File**: `bin/log_analyzer`
- Added `-html` flag for HTML export
- Integrated HTML generation into the export workflow
### 3. Features
+
The HTML export includes:
+
- **Interactive Table**: Powered by jQuery DataTables
- Client-side sorting on all columns
- Search/filter functionality
@@ -41,6 +46,7 @@ The HTML export includes:
- Yellow badge for Views (V)
### 4. Testing
+
- **File**: `spec/lib/html_export_spec.rb`
- Comprehensive test suite for HTML export
- Tests for HTML structure validation
@@ -48,6 +54,7 @@ The HTML export includes:
- Tests for styling and security (HTML escaping)
### 5. Documentation
+
- **Updated**: `README.md`
- Added HTML export examples
- Updated features section
@@ -69,6 +76,7 @@ The HTML export includes:
- Standardized PR template for contributions
### 6. Demo
+
- **File**: `docs/html-export-demo.html`
- Interactive demo with sample data
- Can be opened directly in browser
@@ -93,17 +101,22 @@ log_analyzer log/production.log -html -s count
## Technical Details
### Dependencies
+
No new dependencies added! Uses CDN-hosted libraries:
+
- jQuery 3.7.1 (from code.jquery.com)
- DataTables 1.13.7 (from cdn.datatables.net)
### File Size
+
Generated HTML files are lightweight:
+
- Base template: ~8KB
- Each row adds: ~150-200 bytes
- 1000 views โ 200KB HTML file
### Browser Compatibility
+
- Modern browsers (Chrome, Firefox, Safari, Edge)
- IE11+ (with polyfills from CDN)
- Mobile responsive
diff --git a/docs/html-export-demo.html b/docs/html-export-demo.html
index db3da43..b17ac72 100644
--- a/docs/html-export-demo.html
+++ b/docs/html-export-demo.html
@@ -1,234 +1,249 @@
-
-
-
-
- ๐ LogAnalyzer Report-Generated on December 12, 2025 at 03:30PM - Demo Version
-
-
+
-
-
-
+
+
-
+
+
๐ LogAnalyzer Report+
+ Generated on December 12, 2025 at 03:30PM - Demo Version
+
-
- |
|---|