File size: 32,488 Bytes
46df5f0 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 |
"""
Report generator for bibliography check results.
"""
import re
from dataclasses import dataclass
from datetime import datetime
from typing import Optional, List
from pathlib import Path
from ..parsers.bib_parser import BibEntry
from ..analyzers.metadata_comparator import ComparisonResult
from ..analyzers.usage_checker import UsageResult
from ..analyzers.llm_evaluator import EvaluationResult
from ..analyzers.duplicate_detector import DuplicateGroup
from ..checkers.base import CheckResult, CheckSeverity
@dataclass
class EntryReport:
"""Complete report for a single bib entry."""
entry: BibEntry
comparison: Optional[ComparisonResult]
usage: Optional[UsageResult]
evaluations: list[EvaluationResult]
class ReportGenerator:
"""Generates formatted markdown reports."""
def __init__(self, minimal_verified: bool = False, check_preprint_ratio: bool = True, preprint_warning_threshold: float = 0.50):
self.entries: list[EntryReport] = []
self.missing_citations: list[str] = []
self.duplicate_groups: list[DuplicateGroup] | None = None # None means check not run
self.bib_files: list[str] = []
self.tex_files: list[str] = []
self.bib_file: str = "" # Keep for backward compatibility/single file
self.tex_file: str = "" # Keep for backward compatibility/single file
self.minimal_verified = minimal_verified # Whether to show minimal info for verified entries
self.submission_results: List[CheckResult] = [] # Submission quality check results
self.template = None # Conference template if used
self.check_preprint_ratio = check_preprint_ratio # Whether to check preprint ratio
self.preprint_warning_threshold = preprint_warning_threshold # Threshold for preprint warning
def add_entry_report(self, report: EntryReport):
"""Add an entry report."""
self.entries.append(report)
def set_metadata(self, bib_files: str | list[str], tex_files: str | list[str]):
"""Set source file information."""
if isinstance(bib_files, str):
self.bib_files = [bib_files]
self.bib_file = bib_files
else:
self.bib_files = bib_files
self.bib_file = bib_files[0] if bib_files else ""
if isinstance(tex_files, str):
self.tex_files = [tex_files]
self.tex_file = tex_files
else:
self.tex_files = tex_files
self.tex_file = tex_files[0] if tex_files else ""
def set_missing_citations(self, missing: list[str]):
"""Set list of citations without bib entries."""
self.missing_citations = missing
def set_duplicate_groups(self, groups: list[DuplicateGroup]):
"""Set list of duplicate entry groups."""
self.duplicate_groups = groups
def set_submission_results(self, results: List[CheckResult], template=None):
"""Set submission quality check results."""
self.submission_results = results
self.template = template
def generate(self) -> str:
"""Generate the full markdown report."""
lines = []
# Header
lines.extend(self._generate_header())
lines.append("")
# Disclaimer
lines.extend(self._generate_disclaimer())
lines.append("")
# Summary statistics
lines.extend(self._generate_summary())
lines.append("")
# β οΈ Critical Issues (Detailed) - Bibliography-related issues
lines.extend(self._generate_issues_section())
lines.append("")
# β
Verified Entries (Clean)
lines.extend(self._generate_verified_section())
lines.append("")
# π Submission Quality Checks (LaTeX quality checks)
if self.submission_results:
lines.extend(self._generate_submission_section())
lines.append("")
# Footer
lines.extend(self._generate_footer())
return "\n".join(lines)
def get_summary_stats(self) -> tuple[dict, dict]:
"""Get summary statistics as dictionaries for console display (Issues only)."""
total = len(self.entries)
# Bibliography issues breakdown
title_mismatches = 0
author_mismatches = 0
year_mismatches = 0
low_relevance = 0
unable_to_verify = 0
for e in self.entries:
# Metadata issues
if e.comparison:
if e.comparison.has_issues:
# Categorize issues
has_title = False
has_author = False
has_year = False
for issue in e.comparison.issues:
if "Title mismatch" in issue: has_title = True
elif "Author mismatch" in issue: has_author = True
elif "Year mismatch" in issue: has_year = True
elif "Unable to find" in issue: unable_to_verify += 1
if has_title: title_mismatches += 1
if has_author: author_mismatches += 1
if has_year: year_mismatches += 1
# Relevance issues
if any(ev.relevance_score <= 2 for ev in e.evaluations):
low_relevance += 1
bib_stats = {}
if title_mismatches > 0: bib_stats["Title Mismatches"] = title_mismatches
if author_mismatches > 0: bib_stats["Author Mismatches"] = author_mismatches
if year_mismatches > 0: bib_stats["Year Mismatches"] = year_mismatches
if low_relevance > 0: bib_stats["Low Relevance"] = low_relevance
if unable_to_verify > 0: bib_stats["Unable to Verify"] = unable_to_verify
if self.duplicate_groups:
bib_stats["Duplicate Groups"] = len(self.duplicate_groups)
if self.missing_citations:
bib_stats["Missing Bib Entries"] = len(self.missing_citations)
unused = [e for e in self.entries if e.usage and not e.usage.is_used]
if unused:
bib_stats["Unused Entries"] = len(unused)
# LaTeX stats - Group by precise Rule Names
latex_stats = {}
# Rule mapping for professional display names
RULE_MAPPING = {
"Very long sentence": "Sentence Length (Critical)",
"Long sentence": "Sentence Length (Warning)",
"Possible Markdown bullet point": "Markdown Bullet Point",
"Possible Markdown numbered list": "Markdown Numbered List",
"Possible Markdown italic": "Markdown Italic",
"Possible Markdown bold": "Markdown Bold",
"Inconsistent hyphenation": "Hyphenation Inconsistency",
"Inconsistent spelling": "Spelling Inconsistency",
"Unreferenced figure": "Unreferenced Figure",
"Unreferenced table": "Unreferenced Table",
"Unreferenced section": "Unreferenced Section",
"Unreferenced label": "Unreferenced Label",
"Multiple blank lines": "Multiple Blank Lines",
"Citation from": "Old Citation (10+ years)",
"Hedging language": "Hedging/Vague Language",
"Redundant phrase": "Redundant Phrasing",
"Weak start with": "Weak Sentence Starter",
"Unescaped &": "Unescaped Special Character",
"Citation without non-breaking space": "Missing Non-breaking Space (~)",
"Mixed citation styles": "Mixed Citation Styles",
"Mixed inline math": "Mixed Math Notation",
"Appendix section": "Unreferenced Appendix",
"Missing space before unit": "Unit Spacing Issue"
}
for r in self.submission_results:
if r.passed:
continue
raw_msg = r.message
rule_name = "Unknown Rule"
# Match against our professional rule names
matched = False
for pattern, official_name in RULE_MAPPING.items():
if pattern in raw_msg:
rule_name = official_name
matched = True
break
if not matched:
# Fallback: Clean the message (remove dynamic parts)
clean_msg = re.sub(r"\(.*?\)", "", raw_msg)
clean_msg = re.sub(r"'.*?'", "", clean_msg)
clean_msg = re.sub(r"\d+", "", clean_msg)
rule_name = clean_msg.split(":")[0].strip()
if rule_name not in latex_stats:
latex_stats[rule_name] = 0
latex_stats[rule_name] += 1
return bib_stats, latex_stats
def generate_console_output(self) -> str:
"""Generate console-friendly output (Summary + Issues only)."""
lines = []
# Summary statistics
lines.extend(self._generate_summary())
lines.append("")
# Critical Issues
lines.extend(self._generate_issues_section())
lines.append("")
return "\n".join(lines)
def _generate_header(self) -> list[str]:
"""Generate report header."""
bib_names = ", ".join([f"`{Path(f).name}`" for f in self.bib_files]) if self.bib_files else "N/A"
tex_names = ", ".join([f"`{Path(f).name}`" for f in self.tex_files]) if self.tex_files else "N/A"
timestamp = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
return [
"# Bibliography Validation Report",
"",
f"**Generated:** {timestamp}",
"",
"| File Type | Filename |",
"|-----------|----------|",
f"| **Bib File(s)** | {bib_names} |",
f"| **TeX File(s)** | {tex_names} |"
]
def _generate_disclaimer(self) -> list[str]:
"""Generate disclaimer section."""
return [
"> **β οΈ Disclaimer:** This report is generated by an automated tool. While BibGuard strives for accuracy, it may produce false positives or miss certain issues. **This tool cannot replace human review.** Please manually verify all reported issues before making changes to your bibliography."
]
def _generate_summary(self) -> list[str]:
"""Generate summary statistics."""
total = len(self.entries)
# Check availability of results
has_metadata = any(e.comparison is not None for e in self.entries)
has_usage = any(e.usage is not None for e in self.entries)
has_eval = any(len(e.evaluations) > 0 for e in self.entries)
# Calculate Verified/Issues
# Note: _is_verified depends on _has_issues.
# If a check wasn't run, it won't contribute to issues.
verified = sum(1 for e in self.entries if self._is_verified(e))
issues = sum(1 for e in self.entries if self._has_issues(e))
# Usage stats
if has_usage:
used = sum(1 for e in self.entries if e.usage and e.usage.is_used)
unused = total - used
used_str = str(used)
unused_str = str(unused)
missing_str = str(len(self.missing_citations))
else:
used_str = "N/A"
unused_str = "N/A"
missing_str = "N/A"
# Duplicate stats - show N/A if check wasn't run (duplicate_groups is None means not checked)
if self.duplicate_groups is None:
dup_str = "N/A"
else:
dup_str = str(len(self.duplicate_groups))
# Preprint detection (only if enabled)
preprint_str = "N/A"
preprint_warning = []
if self.check_preprint_ratio and has_usage:
used_entries = [e for e in self.entries if e.usage and e.usage.is_used]
if used_entries:
preprint_count = sum(1 for e in used_entries if self._is_preprint(e.entry))
preprint_ratio = preprint_count / len(used_entries)
preprint_str = f"{preprint_count} ({preprint_ratio:.1%})"
# Warning if exceeds threshold
if preprint_ratio > self.preprint_warning_threshold:
preprint_warning = [
"",
f"> β οΈ **High Preprint Ratio Warning:** {preprint_ratio:.1%} of your used references are preprints (arXiv, bioRxiv, etc.). Consider replacing some with peer-reviewed publications if available."
]
summary_lines = [
"## π Summary",
"",
"### π Bibliography Statistics",
"",
"| Metric | Count |",
"|--------|-------|",
f"| **Total Entries** | {total} |",
f"| β
**Verified (Clean)** | {verified} |",
f"| β οΈ **With Issues** | {issues} |",
f"| π **Used in TeX** | {used_str} |",
f"| ποΈ **Unused** | {unused_str} |",
f"| π **Duplicate Groups** | {dup_str} |",
f"| β **Missing Bib Entries** | {missing_str} |",
f"| π **Preprints (Used)** | {preprint_str} |",
]
# Add warning if needed
if preprint_warning:
summary_lines.extend(preprint_warning)
summary_lines.extend([
"",
"### π LaTeX Quality Checks",
"",
self._get_submission_summary()
])
return summary_lines
def _is_preprint(self, entry: BibEntry) -> bool:
"""Check if an entry is a preprint."""
# Preprint indicators
preprint_keywords = [
'arxiv', 'biorxiv', 'medrxiv', 'ssrn', 'preprint',
'openreview', 'techreport', 'technical report', 'working paper',
'tech report', 'tech. report'
]
# Check entry type
if entry.entry_type.lower() in ['techreport', 'unpublished', 'misc']:
# Further check if it's actually a preprint
text_to_check = ' '.join([
entry.journal.lower(),
entry.booktitle.lower(),
entry.publisher.lower(),
entry.entry_type.lower()
])
if any(keyword in text_to_check for keyword in preprint_keywords):
return True
# Check if arXiv ID exists
if entry.has_arxiv:
return True
# Check journal/booktitle/publisher fields
venue_text = ' '.join([
entry.journal.lower(),
entry.booktitle.lower(),
entry.publisher.lower()
])
return any(keyword in venue_text for keyword in preprint_keywords)
def _get_submission_summary(self) -> str:
"""Generate submission quality summary table."""
if not self.submission_results:
return "*No quality checks were performed.*"
# Count by severity
error_count = sum(1 for r in self.submission_results if r.severity == CheckSeverity.ERROR)
warning_count = sum(1 for r in self.submission_results if r.severity == CheckSeverity.WARNING)
info_count = sum(1 for r in self.submission_results if r.severity == CheckSeverity.INFO)
lines = [
"| Severity | Count |",
"|----------|-------|",
f"| π΄ **Errors** | {error_count} |",
f"| π‘ **Warnings** | {warning_count} |",
f"| π΅ **Suggestions** | {info_count} |"
]
return "\n".join(lines)
def _is_verified(self, entry: EntryReport) -> bool:
"""Check if entry is clean (no issues)."""
return not self._has_issues(entry)
def _has_issues(self, entry: EntryReport) -> bool:
"""Check if entry has any issues."""
# Metadata issues
if entry.comparison and entry.comparison.has_issues:
return True
# LLM issues (low relevance)
if any(ev.relevance_score <= 2 for ev in entry.evaluations):
return True
# NOTE: We don't include usage issues (unused) here because
# unused entries are already shown in the "Unused Entries" section
return False
def _has_metadata_or_relevance_issues(self, entry: EntryReport) -> bool:
"""Check if entry has metadata or relevance issues (excluding duplicate/unused)."""
# Metadata issues
if entry.comparison and entry.comparison.has_issues:
return True
# LLM issues (low relevance)
if any(ev.relevance_score <= 2 for ev in entry.evaluations):
return True
return False
def _generate_issues_section(self) -> list[str]:
"""Generate detailed section for entries with issues."""
lines = ["## β οΈ Critical Issues Detected", ""]
has_any_issues = False
# 1. Missing Citations
if self.missing_citations:
has_any_issues = True
lines.append("### β Missing Bibliography Entries")
lines.append("The following keys are cited in the TeX file but missing from the .bib file:")
lines.append("")
for key in self.missing_citations:
lines.append(f"- `{key}`")
lines.append("")
# 2. Duplicate Entries
if self.duplicate_groups:
has_any_issues = True
lines.append("### π Duplicate Entries")
for i, group in enumerate(self.duplicate_groups, 1):
lines.append(f"#### Group {i} (Similarity: {group.similarity_score:.0%})")
lines.append(f"**Reason:** {group.reason}")
lines.append("")
lines.append("| Key | Title | Year |")
lines.append("|-----|-------|------|")
for entry in group.entries:
lines.append(f"| `{entry.key}` | {entry.title} | {entry.year} |")
lines.append("")
# 3. Unused Entries
unused = [e for e in self.entries if e.usage and not e.usage.is_used]
if unused:
has_any_issues = True
lines.append("### ποΈ Unused Entries")
lines.append("The following entries are in the .bib file but NOT cited in the TeX file:")
lines.append("")
for e in unused:
lines.append(f"- `{e.entry.key}`: *{e.entry.title}*")
lines.append("")
# 4. Metadata Mismatches & Low Relevance
issue_entries = [e for e in self.entries if self._has_metadata_or_relevance_issues(e)]
if issue_entries:
has_any_issues = True
lines.append("### β οΈ Metadata & Relevance Issues")
for entry_report in issue_entries:
lines.extend(self._format_entry_detail(entry_report, is_verified=False))
if not has_any_issues:
lines.append("π **No critical issues found!**")
return lines
def _generate_verified_section(self) -> list[str]:
"""Generate section for verified entries."""
lines = ["## β
Verified Entries", ""]
verified = [e for e in self.entries if self._is_verified(e)]
if not verified:
lines.append("_No verified entries found._")
return lines
lines.append(f"Found **{len(verified)}** entries with correct metadata.")
lines.append("")
# Use a collapsible details block for clean UI
lines.append("<details>")
lines.append("<summary>Click to view verified entries</summary>")
lines.append("")
for entry_report in verified:
lines.extend(self._format_entry_detail(entry_report, minimal=self.minimal_verified, is_verified=True))
lines.append("</details>")
return lines
def _format_entry_detail(self, report: EntryReport, minimal: bool = False, is_verified: bool = False) -> list[str]:
"""Format a single entry report in Markdown."""
entry = report.entry
comp = report.comparison
lines = []
# Title header - use checkmark for verified entries, warning for issues
icon = "β
" if is_verified else "β οΈ"
lines.append(f"#### {icon} `{entry.key}`")
lines.append(f"**Title:** {entry.title}")
lines.append("")
# Metadata Status
if comp:
status_icon = "β
" if comp.is_match else "β"
lines.append(f"- **Metadata Status:** {status_icon} {comp.source.upper()} (Confidence: {comp.confidence:.1%})")
if comp.has_issues and not minimal:
lines.append(" - **Discrepancies:**")
for issue in comp.issues:
# Format mismatch details nicely
if "Mismatch" in issue or "mismatch" in issue:
lines.append(f" - π΄ {issue}")
if "Title" in issue:
lines.append(f" - **Bib:** `{comp.bib_title}`")
lines.append(f" - **Fetched:** `{comp.fetched_title}`")
elif "Author" in issue:
lines.append(f" - **Bib:** `{', '.join(comp.bib_authors)}`")
lines.append(f" - **Fetched:** `{', '.join(comp.fetched_authors)}`")
else:
lines.append(f" - πΈ {issue}")
# Relevance Status
if report.evaluations and not minimal:
lines.append("- **Relevance Analysis:**")
for eval_res in report.evaluations:
score_icon = "π’" if eval_res.relevance_score >= 4 else ("π‘" if eval_res.relevance_score == 3 else "π΄")
lines.append(f" - {score_icon} **Score {eval_res.relevance_score}/5** ({eval_res.score_label})")
loc = []
if eval_res.file_path:
loc.append(f"File: `{Path(eval_res.file_path).name}`")
if eval_res.line_number:
loc.append(f"Line {eval_res.line_number}")
if loc:
lines.append(f" - {' | '.join(loc)}")
lines.append(f" - *\"{eval_res.explanation}\"*")
lines.append("")
lines.append("---")
lines.append("")
return lines
def _generate_submission_section(self) -> list[str]:
"""Generate section for submission quality check results."""
lines = ["## π Submission Quality Checks", ""]
# Template info
if self.template:
lines.append(f"**Conference Template:** {self.template.name}")
lines.append(f"**Page Limit:** {self.template.page_limit_review} (review) / {self.template.page_limit_camera} (camera-ready)")
if self.template.mandatory_sections:
lines.append(f"**Required Sections:** {', '.join(self.template.mandatory_sections)}")
lines.append("")
# Count by severity
errors = [r for r in self.submission_results if r.severity == CheckSeverity.ERROR and not r.passed]
warnings = [r for r in self.submission_results if r.severity == CheckSeverity.WARNING and not r.passed]
infos = [r for r in self.submission_results if r.severity == CheckSeverity.INFO and not r.passed]
# Summary
if errors or warnings or infos:
lines.append("| Severity | Count |")
lines.append("|----------|-------|")
if errors:
lines.append(f"| π΄ **Errors** | {len(errors)} |")
if warnings:
lines.append(f"| π‘ **Warnings** | {len(warnings)} |")
if infos:
lines.append(f"| π΅ **Suggestions** | {len(infos)} |")
lines.append("")
else:
lines.append("π **No submission issues found!**")
lines.append("")
return lines
# Group by checker
by_checker = {}
for result in self.submission_results:
if result.passed:
continue
if result.checker_name not in by_checker:
by_checker[result.checker_name] = []
by_checker[result.checker_name].append(result)
# Display errors first
if errors:
lines.append("### π΄ Critical Errors")
lines.append("")
for result in errors:
lines.append(f"- **{result.message}**")
loc = []
if result.file_path:
loc.append(f"File: `{Path(result.file_path).name}`")
if result.line_number:
loc.append(f"Line {result.line_number}")
if loc:
lines.append(f" - {' | '.join(loc)}")
if result.line_content:
lines.append(f" - `{result.line_content[:80]}`")
if result.suggestion:
lines.append(f" - π‘ *{result.suggestion}*")
lines.append("")
# Display warnings
if warnings:
lines.append("### π‘ Warnings")
lines.append("")
for result in warnings:
lines.append(f"- {result.message}")
loc = []
if result.file_path:
loc.append(f"File: `{Path(result.file_path).name}`")
if result.line_number:
loc.append(f"Line {result.line_number}")
if loc:
lines.append(f" - {' | '.join(loc)}")
if result.suggestion:
lines.append(f" - π‘ *{result.suggestion}*")
lines.append("")
# Display suggestions (collapsible)
if infos:
lines.append("### π΅ Suggestions")
lines.append("<details>")
lines.append("<summary>Click to view suggestions</summary>")
lines.append("")
for result in infos:
lines.append(f"- {result.message}")
loc = []
if result.file_path:
loc.append(f"File: `{Path(result.file_path).name}`")
if result.line_number:
loc.append(f"Line {result.line_number}")
if loc:
lines.append(f" - {' | '.join(loc)}")
if result.suggestion:
lines.append(f" - π‘ *{result.suggestion}*")
lines.append("")
lines.append("</details>")
lines.append("")
return lines
def _generate_footer(self) -> list[str]:
"""Generate report footer."""
return [
"",
"---",
f"Report generated by **BibGuard** on {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"
]
def save(self, filepath: str):
"""Save report to file."""
content = self.generate()
with open(filepath, 'w', encoding='utf-8') as f:
f.write(content)
def save_bibliography_report(self, filepath: str):
"""Generate and save bibliography-only report (all bib-related checks)."""
lines = []
# Header
lines.append("# Bibliography Validation Report")
lines.append("")
lines.append(f"**Generated:** {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}")
lines.append("")
bib_names = ", ".join([f"`{Path(f).name}`" for f in self.bib_files]) if self.bib_files else "N/A"
tex_names = ", ".join([f"`{Path(f).name}`" for f in self.tex_files]) if self.tex_files else "N/A"
lines.append("| File Type | Filename |")
lines.append("|-----------|----------|")
lines.append(f"| **Bib File(s)** | {bib_names} |")
lines.append(f"| **TeX File(s)** | {tex_names} |")
lines.append("")
# Disclaimer
lines.extend(self._generate_disclaimer())
lines.append("")
# Summary - Bibliography only
total = len(self.entries)
verified = sum(1 for e in self.entries if self._is_verified(e))
issues = sum(1 for e in self.entries if self._has_issues(e))
has_usage = any(e.usage is not None for e in self.entries)
if has_usage:
used = sum(1 for e in self.entries if e.usage and e.usage.is_used)
unused = total - used
used_str = str(used)
unused_str = str(unused)
missing_str = str(len(self.missing_citations))
else:
used_str = "N/A"
unused_str = "N/A"
missing_str = "N/A"
if self.duplicate_groups is None:
dup_str = "N/A"
else:
dup_str = str(len(self.duplicate_groups))
lines.append("## π Summary")
lines.append("")
lines.append("| Metric | Count |")
lines.append("|--------|-------|")
lines.append(f"| **Total Entries** | {total} |")
lines.append(f"| β
**Verified (Clean)** | {verified} |")
lines.append(f"| β οΈ **With Issues** | {issues} |")
lines.append(f"| π **Used in TeX** | {used_str} |")
lines.append(f"| ποΈ **Unused** | {unused_str} |")
lines.append(f"| π **Duplicate Groups** | {dup_str} |")
lines.append(f"| β **Missing Bib Entries** | {missing_str} |")
lines.append("")
# Issues section
lines.extend(self._generate_issues_section())
lines.append("")
# Verified entries
lines.extend(self._generate_verified_section())
lines.append("")
# Footer
lines.extend(self._generate_footer())
content = "\n".join(lines)
with open(filepath, 'w', encoding='utf-8') as f:
f.write(content)
def save_latex_quality_report(self, filepath: str, submission_results: List[CheckResult], template=None):
"""Generate and save LaTeX quality report (all tex-related quality checks)."""
lines = []
# Header
lines.append("# LaTeX Quality Report")
lines.append("")
lines.append(f"**Generated:** {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}")
lines.append("")
tex_names = ", ".join([f"`{Path(f).name}`" for f in self.tex_files]) if self.tex_files else "N/A"
lines.append(f"**TeX File(s):** {tex_names}")
lines.append("")
if template:
lines.append(f"**Template:** {template.name}")
lines.append("")
# Disclaimer
lines.append("> **β οΈ Note:** This report contains automated quality checks for your LaTeX document. Please review all suggestions carefully before making changes.")
lines.append("")
# Summary
error_count = sum(1 for r in submission_results if r.severity == CheckSeverity.ERROR)
warning_count = sum(1 for r in submission_results if r.severity == CheckSeverity.WARNING)
info_count = sum(1 for r in submission_results if r.severity == CheckSeverity.INFO)
lines.append("## π Summary")
lines.append("")
lines.append("| Severity | Count |")
lines.append("|----------|-------|")
lines.append(f"| π΄ **Errors** | {error_count} |")
lines.append(f"| π‘ **Warnings** | {warning_count} |")
lines.append(f"| π΅ **Suggestions** | {info_count} |")
lines.append("")
# Detailed issues
self.submission_results = submission_results
self.template = template
lines.extend(self._generate_submission_section())
lines.append("")
# Footer
lines.append("---")
lines.append("")
lines.append(f"Report generated by **BibGuard** on {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}")
content = "\n".join(lines)
with open(filepath, 'w', encoding='utf-8') as f:
f.write(content)
|