pretty-git 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2200709c51eb32592b4fe79a3acea35178fab498dbd781edcc4237ceabfa00c7
-  data.tar.gz: c83bdd9cb01c5b345dfa52f0f1d35a03ed167a78307a6a085819453d96c88293
+  metadata.gz: 7e190585a91de27221e54bc2cbc58b5f6d26a1428c2e5cd5189ff0c18d362e6c
+  data.tar.gz: f8d2bc8f5d6c6a4887a745abd611a038166bcb54e95267a15d4868ee9d530003
 SHA512:
-  metadata.gz: 1d23439b48405024896bec5e173a8573ce0b8fb1b8d1872b98d0201d4cceb85bd07f246f0d2e0a406d1c9f25d40f903280536b32e8dd030dfb04f801bc617d32
-  data.tar.gz: 3137c6d5b19ecbc496f14c9db9395a598d7e7bb8f33f5863db6eb8f3bf9141db141bd2429b8346101a53d79b4a4d687a4b430ad252e1f99bc58f1f2ea0bc6ac4
+  metadata.gz: e11fd51d24ed1e63fd5c773f76a46510bbcedad23c02ace63b25d7d80c366479fd02fe2bfabaa58693389c222bafe4fd9e6fc0b157b7d598e96294a3f888fbef
+  data.tar.gz: 38fc87c6467d72ae6a1cb63a13b06c417e81f714d5b074feae961f121e061cea0733494020e0b8f562f36ea00b2d537a0d6fd5ac36eea942465680376f8eb71e

data/CHANGELOG.md

@@ -7,6 +7,39 @@ The format is based on Keep a Changelog, and this project adheres to Semantic Ve
 ## [Unreleased]
  
 
+## [0.1.4] - 2025-08-17
+### Added
+- Integration tests for new reports exports: CSV/Markdown/YAML/XML for `hotspots`, `churn`, `ownership`.
+- Schema validations: `rake validate:json`, `rake validate:xml` to ensure format compatibility.
+- CI: expanded matrix to include macOS; smoke test for installed binary (`--help`, `--version`).
+
+### Changed
+- Renderers (`MarkdownRenderer`, `YamlRenderer`, `XmlRenderer`): deterministic sorting for all new reports according to `docs/determinism.md`.
+- XML: per-report root elements in XML exports to match XSDs (`hotspotsReport`, `churnReport`, `ownershipReport`, `languagesReport`, etc.).
+- Documentation: `README.md` and `README.ru.md` updated with sections and examples for new reports and all export formats.
+- CLI: keep `--time-bucket` permissive; default `time_bucket=nil`.
+
+### Fixed
+- Time parsing: interpret date-only inputs (`YYYY-MM-DD`) as UTC midnight and normalize to UTC ISO8601.
+- CLI UX: error when `--metric` is used outside `languages` report.
+- Tests/specs: updated XML specs to per-report roots; added timezone edge cases; fixed Open3 `popen3` stubs (`chdir:`) and integration requires.
+
+
+## [0.1.3] - 2025-08-14
+### Added
+- New analytics reports: `hotspots`, `churn`, `ownership` with sorting, scoring, and limits.
+- Exporters: CSV and Markdown support for new reports with dynamic headers via mapping constants.
+- Docs: Detailed sections for new reports in `README.md` and `README.ru.md` with usage and examples (CSV/JSON/YAML/XML).
+
+### Changed
+- Console: dispatching and rendering wired for new reports; consistent theming and width handling.
+- CLI/App: unified analytics dispatch for all reports.
+- Docs: public READMEs cleaned up from internal DR-* mentions; anchors and headings aligned (CSV).
+
+### Fixed
+- Minor documentation inaccuracies and anchor mismatches.
+
+
 ## [0.1.2] - 2025-08-13
 ### Added
 - Languages report: support multiple metrics — `bytes`, `files`, `loc`; dynamic columns in Console/CSV/Markdown; color and percent fields in output.
@@ -15,7 +48,7 @@ The format is based on Keep a Changelog, and this project adheres to Semantic Ve
 ### Changed
 - Languages: JSON language reinstated in the mapping and color scheme; sorting and percent calculations are based on the selected metric; percentages rounded to two decimals.
 - Renderers: updated `csv`, `markdown`, and console renderers to work with dynamic metrics.
-- Internal specs updated: `specs/output_formats.md`, `specs/cli_spec.md`, `specs/languages_map.md`.
+- Internal specs updated: `docs/output_formats.md`, `docs/cli_spec.md`, `docs/languages_map.md`.
 
 ### Fixed
 - Git provider: correct commit counting — emit a new commit when a header is read and remove the record separator from the subject (`lib/pretty_git/git/provider.rb`).

data/README.md

@@ -14,7 +14,7 @@
   <br>
 </p>
 
-Generator of rich reports for a local Git repository: summary, activity, authors, files, heatmap, languages. Output to Console and formats: JSON, CSV, Markdown, YAML, XML.
+Generator of rich reports for a local Git repository: summary, activity, authors, files, heatmap, languages, hotspots, churn, ownership. Output to Console and formats: JSON, CSV, Markdown, YAML, XML.
 
 — License: MIT.
 
@@ -35,10 +35,13 @@ Generator of rich reports for a local Git repository: summary, activity, authors
   - [files — by files](#files--by-files)
   - [heatmap — commit heatmap](#heatmap--commit-heatmap)
   - [languages — languages](#languages--languages)
+  - [hotspots — hotspots (risky files)](#hotspots--hotspots-risky-files)
+  - [churn — code churn by file](#churn--code-churn-by-file)
+  - [ownership — code ownership](#ownership--code-ownership)
 - [Exports](#exports)
   - [Console](#console)
   - [JSON](#json)
-  - [CSV (DR-001)](#csv-dr-001)
+  - [CSV](#csv)
   - [Markdown](#markdown)
   - [YAML](#yaml)
   - [XML](#xml)
@@ -49,17 +52,17 @@ Generator of rich reports for a local Git repository: summary, activity, authors
 - [Development](#development)
 - [License](#license)
 
-## Features
-* **Reports**: `summary`, `activity`, `authors`, `files`, `heatmap`, `languages`.
+## ✨ Features
+* **Reports**: `summary`, `activity`, `authors`, `files`, `heatmap`, `languages`, `hotspots`, `churn`, `ownership`.
 * **Filters**: branches, authors, paths, time period.
 * **Exports**: `console`, `json`, `csv`, `md`, `yaml`, `xml`.
 * **Output**: to stdout or file via `--out`.
 
-## Requirements
+## ⚙️ Requirements
 * **Ruby**: >= 3.4 (recommended 3.4.x)
 * **Git**: installed and available in `PATH`
 
-## Installation
+## 📦 Installation
 
 ### 🍺 Homebrew (recommended)
 ```bash
@@ -101,7 +104,7 @@ bundle install
 bundle exec pretty-git --help
 ```
 
-## Quick Start
+## 🚀 Quick Start
 ```bash
 # Repository summary to console
 bundle exec bin/pretty-git summary .
@@ -114,21 +117,25 @@ bundle exec bin/pretty-git activity . --time-bucket week --since 2025-01-01 \
   --paths app,lib --format csv --out activity.csv
 ```
 
-## CLI and Options
+## 🧰 CLI and Options
 General form:
 
 ```bash
 pretty-git <report> <repo_path> [options]
 ```
 
-Available reports: `summary`, `activity`, `authors`, `files`, `heatmap`, `languages`.
+Notes:
+* `<repo_path>` defaults to `.` if omitted.
+* You can also pass the repository via `--repo PATH` as an alternative to the positional argument.
+
+Available reports: `summary`, `activity`, `authors`, `files`, `heatmap`, `languages`, `hotspots`, `churn`, `ownership`.
 
 Key options:
 * **--format, -f** `console|json|csv|md|yaml|xml` (default `console`)
 * **--out, -o** Path to write output file
 * **--limit, -l** Number of items shown; `all` or `0` — no limit
 * **--time-bucket** `day|week|month` (for `activity`)
-* **--since/--until** Date/time in ISO8601 or `YYYY-MM-DD` (DR-005)
+* **--since/--until** Date/time in ISO8601 or `YYYY-MM-DD`
 * **--branch** Multi-option, can be specified multiple times
 * **--author/--exclude-author** Filter by authors
 * **--path/--exclude-path** Filter by paths (comma-separated or repeated option)
@@ -165,15 +172,15 @@ pretty-git authors . --format csv --out authors.csv
 * `1` — user error (unknown report/format, bad arguments)
 * `2` — system error (git error etc.)
 
-## Reports and Examples
+## 📊 Reports and Examples
 
-### summary — repository summary
+### 🧭 summary — repository summary
 ```bash
 pretty-git summary . --format json
 ```
 Contains totals (commits, authors, additions, deletions) and top authors/files.
 
-### activity — activity (day/week/month)
+### 📆 activity — activity (day/week/month)
 ```bash
 pretty-git activity . --time-bucket week --format csv
 ```
@@ -186,7 +193,7 @@ JSON example:
 ]
 ```
 
-### authors — by authors
+### 👤 authors — by authors
 ```bash
 pretty-git authors . --format md --limit 10
 ```
@@ -199,27 +206,39 @@ Markdown example:
 | Bob   | b@example.com | 1 | 2 | 0 | 2.0 |
 ```
 
-### files — by files
+### 📁 files — by files
 ```bash
 pretty-git files . --paths app,lib --format csv
 ```
 CSV columns: `path,commits,additions,deletions,changes`.
+
 XML example:
 ```xml
-<files>
-  <item path="app/models/user.rb" commits="42" additions="2100" deletions="1400" changes="3500" />
-  <item path="app/services/auth.rb" commits="35" additions="1500" deletions="900" changes="2400" />
+<?xml version="1.0" encoding="UTF-8"?>
+<report>
+  <report>files</report>
   <generated_at>2025-01-31T00:00:00Z</generated_at>
   <repo_path>/abs/path/to/repo</repo_path>
-  <report>files</report>
-  <period>
-    <since/>
-    <until/>
-  </period>
-</files>
+  <items>
+    <item>
+      <path>app/models/user.rb</path>
+      <commits>42</commits>
+      <additions>2100</additions>
+      <deletions>1400</deletions>
+      <changes>3500</changes>
+    </item>
+    <item>
+      <path>app/services/auth.rb</path>
+      <commits>35</commits>
+      <additions>1500</additions>
+      <deletions>900</deletions>
+      <changes>2400</changes>
+    </item>
+  </items>
+</report>
 ```
 
-### heatmap — commit heatmap
+### 🔥 heatmap — commit heatmap
 ```bash
 pretty-git heatmap . --format json
 ```
@@ -231,7 +250,7 @@ dow,hour,commits
 1,11,7
 ```
 
-### languages — languages
+### 🈺 languages — languages
 ```bash
 pretty-git languages . --format md --limit 10
 ```
@@ -264,11 +283,97 @@ Export:
 - CSV/MD: columns are dynamic — `language,<metric>,percent`. Markdown also includes a `color` column.
 - JSON/YAML/XML: full report structure including per-language `color` and metadata (`report`, `generated_at`, `repo_path`).
 
-## Exports
+### ⚠️ hotspots — hotspots (risky files)
+```bash
+pretty-git hotspots . --format csv --limit 20
+```
+Highlights riskier files combining change frequency and magnitude.
+
+CSV columns: `path,score,commits,additions,deletions,changes`.
+
+Example:
+```csv
+path,score,commits,additions,deletions,changes
+lib/a.rb,9.5,12,300,220,520
+app/b.rb,7.1,8,140,60,200
+```
+
+JSON example:
+```json
+{
+  "report": "hotspots",
+  "generated_at": "2025-01-31T00:00:00Z",
+  "repo_path": ".",
+  "items": [
+    {"path": "lib/a.rb", "score": 9.5, "commits": 12, "additions": 300, "deletions": 220, "changes": 520}
+  ]
+}
+```
+
+### 🔄 churn — code churn by file
+```bash
+pretty-git churn . --format md --limit 20
+```
+Measures code churn (amount of code changing frequently).
+
+CSV columns: `path,churn,commits,additions,deletions`.
+
+Markdown example:
+```markdown
+| path | churn | commits | additions | deletions |
+|---|---:|---:|---:|---:|
+| lib/a.rb | 520 | 12 | 300 | 220 |
+```
+
+YAML example:
+```yaml
+report: churn
+generated_at: '2025-01-31T00:00:00Z'
+repo_path: .
+items:
+  - path: lib/a.rb
+    churn: 520
+    commits: 12
+    additions: 300
+    deletions: 220
+```
+
+### 🏷️ ownership — code ownership
+```bash
+pretty-git ownership . --format csv --limit 50
+```
+Shows file ownership concentration per primary owner.
+
+CSV columns: `path,owner,owner_share,authors`.
+
+Notes:
+- `owner`: author identifier (name/email) with the largest share of edits.
+- `owner_share`: percent of edits by the owner (0..100).
+- `authors`: total unique authors who edited the file.
+
+XML example:
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<report>
+  <report>ownership</report>
+  <generated_at>2025-01-31T00:00:00Z</generated_at>
+  <repo_path>.</repo_path>
+  <items>
+    <item>
+      <path>lib/a.rb</path>
+      <owner>Alice &lt;a@example.com&gt;</owner>
+      <owner_share>82.5</owner_share>
+      <authors>2</authors>
+    </item>
+  </items>
+</report>
+```
+
+## 📤 Exports
 
 Below are exact serialization rules for each format to ensure compatibility with common tools (Excel, BI, CI, etc.).
 
-### Console
+### 🖥️ Console
 ![Console output — basic theme](docs/images/PrettyGitConsole.png)
 _Example terminal output (theme: basic)._ 
 * **Colors**: headers and table heads highlighted; totals: `commits` — yellow, `+additions` — green, `-deletions` — red. `--no-color` fully disables coloring.
@@ -279,7 +384,7 @@ _Example terminal output (theme: basic)._
 * **Purpose**: human-readable terminal output.
 * **Layout**: boxed tables, auto-truncation of long values.
 
-### JSON
+### 🧾 JSON
 * **Keys**: `snake_case`.
 * **Numbers**: integers/floats without localization (dot decimal separator).
 * **Boolean**: `true/false`; **null**: `null`.
@@ -311,7 +416,7 @@ _Example terminal output (theme: basic)._
   Bob,b@example.com,1,2,0,2.0
   ```
 
-### Markdown
+### 📝 Markdown
 * **Tables**: GitHub Flavored Markdown.
 * **Alignment**: numeric columns are right-aligned (`---:`).
 * **Encoding/line endings**: UTF‑8, LF.
@@ -324,7 +429,7 @@ _Example terminal output (theme: basic)._
   | app/models/user.rb | 42 | 2100 | 1400 |
   ```
 
-### YAML
+### 📄 YAML
 * **Structure**: full result hierarchy.
 * **Keys**: serialized as strings.
 * **Numbers/boolean/null**: standard YAML (`123`, `true/false`, `null`).
@@ -344,7 +449,7 @@ _Example terminal output (theme: basic)._
       commits: 1
   ```
 
-### XML
+### 🗂️ XML
 * **Structure**: elements correspond to keys; arrays — repeated `<item>` or specialized tags.
 * **Attributes**: for compact rows (e.g., files report) main fields may be attributes.
 * **Text nodes**: used for scalar values when needed.
@@ -362,7 +467,7 @@ _Example terminal output (theme: basic)._
   </authors>
   ```
 
-## Ignored directories and files
+## 🚫 Ignored directories and files
 
 To keep language statistics meaningful, certain directories and file types are skipped by default.
 
@@ -387,16 +492,16 @@ vendor, node_modules, .git, .bundle, dist, build, out, target, coverage,
 
 These lists mirror the implementation in `lib/pretty_git/analytics/languages.rb` and may evolve.
 
-## Determinism and Sorting
+## 🔁 Determinism and Sorting
 Output is deterministic given the same input. Sorting for files/authors: by changes (desc), then by commits (desc), then by path/name (asc). Limits are applied after sorting; `all` or `0` means no limit.
 
-## Windows Notes
+## 🪟 Windows Notes
 Primary targets — macOS/Linux. Windows is supported best‑effort:
 * Running via Git Bash/WSL is OK
 * Colors can be disabled by `--no-color`
 * Carefully quote arguments when working with paths
 
-## Diagnostics and Errors
+## 🩺 Diagnostics and Errors
 Typical issues and solutions:
 
 * **Unknown report/format** — check the first argument and `--format`.
@@ -405,12 +510,12 @@ Typical issues and solutions:
 * **Empty result** — check your filters (`--since/--until`, `--branch`, `--path`); your selection might be too narrow.
 * **CSV encoding issues** — files are saved as UTF‑8; when opening in Excel, pick UTF‑8.
 
-## FAQ
+## ❓ FAQ
 * **Why Ruby 3.4+?** The project uses dependencies aligned with Ruby 3.4+ and targets the current ecosystem.
 * **New formats?** Yes, add a renderer under `lib/pretty_git/render/` and wire it in the app.
 * **Where does data come from?** From system `git` via CLI calls.
 
-## Development
+## 🛠️ Development
 ```bash
 # Install deps
 bin/setup
@@ -422,5 +527,5 @@ bundle exec rubocop
 
 Style — RuboCop clean. Tests cover aggregators, renderers, CLI, and integration scenarios (determinism, format correctness).
 
-## License
+## 📄 License
 MIT © Contributors