feat: provide disk_file_creation_year for usecases where no git history exist (#185)

Author: Lorilatschki

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [6.1.0] 2025-06-06
+
+New properties:
+
+* `attrs.disk_file_creation_year` can be used to replace not existing git history attrs values like `{{attrs.git_file_created_year if attrs.git_file_created_year else attrs.disk_file_creation_year }}`
+
 ## [6.0.0] 2025-01-28
 
 ### Breaking changes

Cargo.lock

@@ -24,6 +24,7 @@ repository.workspace = true
 
 [dependencies]
 anyhow = { workspace = true }
+chrono = "0.4.41"
 gix = { version = "0.72.1", default-features = false, features = [
   "blob-diff",
   "excludes",

fmt/Cargo.toml

@@ -17,6 +17,8 @@ use std::collections::HashSet;
 use std::path::Path;
 use std::path::PathBuf;
 
+use std::fs;
+
 use anyhow::Context;
 use gix::date::time::CustomFormat;
 
@@ -89,6 +91,13 @@ impl DocumentFactory {
                 .get(filepath)
                 .map(|attrs| attrs.authors.clone())
                 .unwrap_or_default(),
+            disk_file_creation_year: fs::metadata(filepath)
+                .and_then(|meta| meta.created())
+                .ok()
+                .map(|created_time| {
+                    let datetime = chrono::DateTime::<chrono::Utc>::from(created_time);
+                    datetime.format("%Y").to_string()
+                }),
         };
 
         Document::new(

fmt/src/document/factory.rs

@@ -40,6 +40,7 @@ pub struct Attributes {
     pub git_file_created_year: Option<String>,
     pub git_file_modified_year: Option<String>,
     pub git_authors: BTreeSet<String>,
+    pub disk_file_creation_year: Option<String>,
 }
 
 #[derive(Debug)]

fmt/src/document/mod.rs

@@ -0,0 +1 @@
+Copyright {{attrs.git_file_created_year if attrs.git_file_created_year else attrs.disk_file_creation_year }}

tests/disk_file_creation_year/license.txt

@@ -0,0 +1,4 @@
+baseDir = "."
+headerPath = "license.txt"
+
+excludes = ["licenserc.toml", "*.expected"]

tests/disk_file_creation_year/licenserc.toml

@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}

tests/disk_file_creation_year/main.rs

@@ -0,0 +1,5 @@
+// Copyright <CURRENT_YEAR>
+
+fn main() {
+    println!("Hello, world!");
+}

tests/disk_file_creation_year/main.rs.expected

@@ -16,6 +16,9 @@
 from pathlib import Path
 import difflib
 import subprocess
+import os
+import shutil
+import datetime
 
 def diff_files(file1, file2):
     with file1.open("r", encoding="utf8") as f1, file2.open("r", encoding="utf8") as f2:
@@ -33,16 +36,46 @@ def diff_files(file1, file2):
 subprocess.run(["cargo", "build", "--bin", "hawkeye"], cwd=rootdir, check=True)
 hawkeye = rootdir / "target" / "debug" / "hawkeye"
 
-def drive(name, files):
+def drive(name, files, create_temp_copy=False):
+    temp_paths = []
+    expected_files = []
     case_dir = basedir / name
-    subprocess.run([hawkeye, "format", "--fail-if-unknown", "--fail-if-updated=false", "--dry-run"], cwd=case_dir, check=True)
-
-    for file in files:
-        diff_files(case_dir / f"{file}.expected", case_dir / f"{file}.formatted")
+    try:
+        if create_temp_copy:
+            current_year = str(datetime.datetime.now().year)
+            for filepath in files:
+                base, ext = os.path.splitext(filepath)
+                temp_path = f"{base}_temp{ext}"
+                shutil.copy2(case_dir / filepath, case_dir / temp_path)
+                temp_paths.append(temp_path)
+                expected_temp_path = f"{base}_temp{ext}.expected"
+                shutil.copy2(case_dir / f"{filepath}.expected", case_dir / expected_temp_path)
+                expected_files.append(expected_temp_path)
+                with (case_dir / expected_temp_path).open("r", encoding="utf8") as f:
+                    content = f.read()
+                content = content.replace("<CURRENT_YEAR>", current_year)
+                with (case_dir / expected_temp_path).open("w", encoding="utf8") as f:
+                    f.write(content)
+        else:
+            temp_paths = files
+            expected_files = [f"{file}.expected" for file in files]
+        subprocess.run([hawkeye, "format", "--fail-if-unknown", "--fail-if-updated=false", "--dry-run"], cwd=case_dir, check=True)
 
+        for file in temp_paths:
+            diff_files(case_dir / f"{file}.expected", case_dir / f"{file}.formatted")
+    finally:
+        # Remove all temp files at the end
+        if create_temp_copy:
+            for temp_path in temp_paths:
+                if os.path.exists(case_dir / temp_path):
+                    os.remove(case_dir / temp_path)
+            for expected_file in expected_files:
+                if os.path.exists(case_dir / expected_file):
+                    os.remove(case_dir / expected_file)
 
 drive("attrs_and_props", ["main.rs"])
 drive("load_header_path", ["main.rs"])
 drive("bom_issue", ["headless_bom.cs"])
 drive("regression_blank_line", ["main.rs"])
 drive("regression_no_blank_lines", ["repro.py"])
+drive("disk_file_creation_year", ["main.rs"], True)