features_cli/
file_scanner.rs

1use anyhow::{Context, Result};
2use git2::Repository;
3use std::collections::HashMap;
4use std::fs;
5use std::path::Path;
6
7use crate::git_helper::get_all_commits_by_path;
8use crate::models::{Change, Feature, Stats};
9use crate::readme_parser::read_readme_info;
10
11fn is_documentation_directory(dir_path: &Path) -> bool {
12    let dir_name = dir_path
13        .file_name()
14        .and_then(|name| name.to_str())
15        .unwrap_or("");
16
17    // Common documentation directory names
18    let doc_dirs = ["docs", "__docs__", ".docs"];
19
20    doc_dirs.contains(&dir_name.to_lowercase().as_str())
21}
22
23fn is_inside_documentation_directory(dir_path: &Path) -> bool {
24    // Check if any parent directory is a documentation directory
25    for ancestor in dir_path.ancestors().skip(1) {
26        if is_documentation_directory(ancestor) {
27            return true;
28        }
29    }
30    false
31}
32
33fn is_direct_subfolder_of_features(dir_path: &Path) -> bool {
34    if let Some(parent) = dir_path.parent()
35        && let Some(parent_name) = parent.file_name().and_then(|name| name.to_str())
36    {
37        return parent_name == "features";
38    }
39    false
40}
41
42fn find_readme_file(dir_path: &Path) -> Option<std::path::PathBuf> {
43    let readme_candidates = ["README.md", "README.mdx"];
44
45    for candidate in &readme_candidates {
46        let readme_path = dir_path.join(candidate);
47        if readme_path.exists() {
48            return Some(readme_path);
49        }
50    }
51
52    None
53}
54
55/// Check if a directory has a README with `feature: true` in front matter
56fn has_feature_flag_in_readme(dir_path: &Path) -> bool {
57    if let Some(readme_path) = find_readme_file(dir_path)
58        && let Ok(content) = fs::read_to_string(&readme_path)
59    {
60        // Check if content starts with YAML front matter (---)
61        if let Some(stripped) = content.strip_prefix("---\n")
62            && let Some(end_pos) = stripped.find("\n---\n")
63        {
64            let yaml_content = &stripped[..end_pos];
65
66            // Parse YAML front matter
67            if let Ok(yaml_value) = serde_yaml::from_str::<serde_yaml::Value>(yaml_content)
68                && let Some(mapping) = yaml_value.as_mapping()
69            {
70                // Check for feature: true
71                if let Some(feature_value) =
72                    mapping.get(serde_yaml::Value::String("feature".to_string()))
73                {
74                    return feature_value.as_bool() == Some(true);
75                }
76            }
77        }
78    }
79    false
80}
81
82/// Check if a directory should be treated as a feature
83fn is_feature_directory(dir_path: &Path) -> bool {
84    // Skip documentation directories
85    if is_documentation_directory(dir_path) || is_inside_documentation_directory(dir_path) {
86        return false;
87    }
88
89    // Check if it's a direct subfolder of "features" (existing behavior)
90    if is_direct_subfolder_of_features(dir_path) {
91        return true;
92    }
93
94    // Check if the directory has a README with feature: true
95    has_feature_flag_in_readme(dir_path)
96}
97
98pub fn list_files_recursive(dir: &Path) -> Result<Vec<Feature>> {
99    list_files_recursive_impl(dir, None)
100}
101
102pub fn list_files_recursive_with_changes(dir: &Path) -> Result<Vec<Feature>> {
103    // Get all commits once at the beginning for efficiency
104    let all_commits = get_all_commits_by_path(dir).unwrap_or_default();
105    list_files_recursive_impl(dir, Some(&all_commits))
106}
107
108fn read_decision_files(feature_path: &Path) -> Result<Vec<String>> {
109    let mut decisions = Vec::new();
110
111    // Check both "decision" and "decisions" folder names
112    let decision_paths = [
113        feature_path.join(".docs").join("decisions"),
114        feature_path.join("__docs__").join("decisions"),
115    ];
116
117    for decisions_dir in &decision_paths {
118        if decisions_dir.exists() && decisions_dir.is_dir() {
119            let entries = fs::read_dir(decisions_dir).with_context(|| {
120                format!(
121                    "could not read decisions directory `{}`",
122                    decisions_dir.display()
123                )
124            })?;
125
126            for entry in entries {
127                let entry = entry?;
128                let path = entry.path();
129
130                // Skip README.md files and only process .md files
131                if path.is_file()
132                    && let Some(file_name) = path.file_name()
133                {
134                    let file_name_str = file_name.to_string_lossy();
135                    if file_name_str.ends_with(".md") && file_name_str != "README.md" {
136                        let content = fs::read_to_string(&path).with_context(|| {
137                            format!("could not read decision file `{}`", path.display())
138                        })?;
139                        decisions.push(content);
140                    }
141                }
142            }
143            break; // If we found one of the directories, don't check the other
144        }
145    }
146
147    Ok(decisions)
148}
149
150/// Compute statistics from changes for a feature
151fn compute_stats_from_changes(changes: &[Change]) -> Option<Stats> {
152    if changes.is_empty() {
153        return None;
154    }
155
156    let mut commits = HashMap::new();
157
158    // Add total commit count
159    commits.insert(
160        "total_commits".to_string(),
161        serde_json::json!(changes.len()),
162    );
163
164    // Count commits by author
165    let mut authors_count: HashMap<String, usize> = HashMap::new();
166    for change in changes {
167        *authors_count.entry(change.author_name.clone()).or_insert(0) += 1;
168    }
169    commits.insert(
170        "authors_count".to_string(),
171        serde_json::json!(authors_count),
172    );
173
174    // Count commits by conventional commit type
175    let mut count_by_type: HashMap<String, usize> = HashMap::new();
176    for change in changes {
177        let commit_type = extract_commit_type(&change.title);
178        *count_by_type.entry(commit_type).or_insert(0) += 1;
179    }
180    commits.insert(
181        "count_by_type".to_string(),
182        serde_json::json!(count_by_type),
183    );
184
185    // Get first and last commit dates
186    if let Some(first) = changes.first() {
187        commits.insert(
188            "first_commit_date".to_string(),
189            serde_json::json!(first.date.clone()),
190        );
191    }
192    if let Some(last) = changes.last() {
193        commits.insert(
194            "last_commit_date".to_string(),
195            serde_json::json!(last.date.clone()),
196        );
197    }
198
199    Some(Stats { commits })
200}
201
202/// Extract the commit type from a conventional commit title
203fn extract_commit_type(title: &str) -> String {
204    // Common conventional commit types
205    let known_types = [
206        "feat", "fix", "docs", "style", "refactor", "perf", "test", "build", "ci", "chore",
207        "revert",
208    ];
209
210    // Check if the title follows conventional commit format (type: description or type(scope): description)
211    if let Some(colon_pos) = title.find(':') {
212        let prefix = &title[..colon_pos];
213
214        // Remove scope if present (e.g., "feat(auth)" -> "feat")
215        let type_part = if let Some(paren_pos) = prefix.find('(') {
216            &prefix[..paren_pos]
217        } else {
218            prefix
219        };
220
221        let type_part = type_part.trim().to_lowercase();
222
223        // Check if it's a known conventional commit type
224        if known_types.contains(&type_part.as_str()) {
225            return type_part;
226        }
227    }
228
229    // If not a conventional commit, return "other"
230    "other".to_string()
231}
232
233fn process_feature_directory(
234    path: &Path,
235    name: &str,
236    changes_map: Option<&HashMap<String, Vec<Change>>>,
237) -> Result<Feature> {
238    // Try to find and read README file, use defaults if not found
239    let mut readme_info = if let Some(readme_path) = find_readme_file(path) {
240        read_readme_info(&readme_path)?
241    } else {
242        use crate::readme_parser::ReadmeInfo;
243        ReadmeInfo {
244            title: None,
245            owner: "Unknown".to_string(),
246            description: "".to_string(),
247            meta: std::collections::HashMap::new(),
248        }
249    };
250
251    // Remove the 'feature' key from meta if it exists (it's redundant since we know it's a feature)
252    readme_info.meta.remove("feature");
253
254    let changes = if let Some(map) = changes_map {
255        // Convert the absolute path to a repo-relative path and look up changes
256        get_changes_for_path(path, map).unwrap_or_default()
257    } else {
258        Vec::new()
259    };
260
261    // Always include decisions regardless of include_changes flag
262    let decisions = read_decision_files(path).unwrap_or_default();
263
264    // Check if this feature has nested features in a 'features' subdirectory
265    let nested_features_path = path.join("features");
266    let mut nested_features = if nested_features_path.exists() && nested_features_path.is_dir() {
267        list_files_recursive_impl(&nested_features_path, changes_map).unwrap_or_default()
268    } else {
269        Vec::new()
270    };
271
272    // Also check for nested features marked with feature: true in subdirectories
273    let entries = fs::read_dir(path)
274        .with_context(|| format!("could not read directory `{}`", path.display()))?;
275
276    let mut entries: Vec<_> = entries.collect::<Result<_, _>>()?;
277    entries.sort_by_key(|entry| entry.path());
278
279    for entry in entries {
280        let entry_path = entry.path();
281        let entry_name = entry_path.file_name().unwrap().to_string_lossy();
282
283        if entry_path.is_dir()
284            && entry_name != "features" // Don't process 'features' folder twice
285            && !is_documentation_directory(&entry_path)
286        {
287            if has_feature_flag_in_readme(&entry_path) {
288                // This directory is a feature itself
289                let nested_feature =
290                    process_feature_directory(&entry_path, &entry_name, changes_map)?;
291                nested_features.push(nested_feature);
292            } else {
293                // This directory is not a feature, but might contain features
294                // Recursively search for features inside it
295                let deeper_features = list_files_recursive_impl(&entry_path, changes_map)?;
296                nested_features.extend(deeper_features);
297            }
298        }
299    }
300
301    // Compute stats from changes if available
302    let stats = compute_stats_from_changes(&changes);
303
304    Ok(Feature {
305        name: readme_info.title.unwrap_or_else(|| name.to_string()),
306        description: readme_info.description,
307        owner: readme_info.owner,
308        path: path.to_string_lossy().to_string(),
309        features: nested_features,
310        meta: readme_info.meta,
311        changes,
312        decisions,
313        stats,
314    })
315}
316
317fn list_files_recursive_impl(
318    dir: &Path,
319    changes_map: Option<&HashMap<String, Vec<Change>>>,
320) -> Result<Vec<Feature>> {
321    let entries = fs::read_dir(dir)
322        .with_context(|| format!("could not read directory `{}`", dir.display()))?;
323
324    let mut entries: Vec<_> = entries.collect::<Result<_, _>>()?;
325    entries.sort_by_key(|entry| entry.path());
326
327    let mut features: Vec<Feature> = Vec::new();
328
329    for entry in entries {
330        let path = entry.path();
331        let name = path.file_name().unwrap().to_string_lossy();
332
333        if path.is_dir() {
334            if is_feature_directory(&path) {
335                let feature = process_feature_directory(&path, &name, changes_map)?;
336                features.push(feature);
337            } else if !is_documentation_directory(&path)
338                && !is_inside_documentation_directory(&path)
339            {
340                // Recursively search for features in non-documentation subdirectories
341                let new_features = list_files_recursive_impl(&path, changes_map)?;
342                features.extend(new_features);
343            }
344        }
345    }
346
347    Ok(features)
348}
349
350/// Get changes for a specific path from the pre-computed changes map
351fn get_changes_for_path(
352    path: &Path,
353    changes_map: &HashMap<String, Vec<Change>>,
354) -> Result<Vec<Change>> {
355    // Canonicalize the path
356    let canonical_path = std::fs::canonicalize(path)?;
357
358    // Find the repository and get the working directory
359    let repo = Repository::discover(path)?;
360    let repo_workdir = repo
361        .workdir()
362        .context("repository has no working directory")?;
363
364    // Convert to relative path from repo root
365    let relative_path = canonical_path
366        .strip_prefix(repo_workdir)
367        .context("path is not within repository")?;
368
369    let relative_path_str = relative_path.to_string_lossy().to_string();
370
371    // Look up the changes in the map
372    Ok(changes_map
373        .get(&relative_path_str)
374        .cloned()
375        .unwrap_or_default())
376}
377
378#[cfg(test)]
379mod tests {
380    use super::*;
381
382    #[test]
383    fn test_extract_commit_type() {
384        // Test standard conventional commit types
385        assert_eq!(extract_commit_type("feat: add new feature"), "feat");
386        assert_eq!(extract_commit_type("fix: resolve bug"), "fix");
387        assert_eq!(extract_commit_type("docs: update README"), "docs");
388        assert_eq!(extract_commit_type("style: format code"), "style");
389        assert_eq!(
390            extract_commit_type("refactor: improve structure"),
391            "refactor"
392        );
393        assert_eq!(extract_commit_type("perf: optimize performance"), "perf");
394        assert_eq!(extract_commit_type("test: add unit tests"), "test");
395        assert_eq!(extract_commit_type("build: update dependencies"), "build");
396        assert_eq!(extract_commit_type("ci: fix CI pipeline"), "ci");
397        assert_eq!(extract_commit_type("chore: update gitignore"), "chore");
398        assert_eq!(
399            extract_commit_type("revert: undo previous commit"),
400            "revert"
401        );
402
403        // Test with scope
404        assert_eq!(extract_commit_type("feat(auth): add login"), "feat");
405        assert_eq!(
406            extract_commit_type("fix(api): resolve endpoint issue"),
407            "fix"
408        );
409        assert_eq!(
410            extract_commit_type("docs(readme): update instructions"),
411            "docs"
412        );
413
414        // Test case insensitivity
415        assert_eq!(extract_commit_type("FEAT: uppercase type"), "feat");
416        assert_eq!(extract_commit_type("Fix: mixed case"), "fix");
417        assert_eq!(extract_commit_type("DOCS: all caps"), "docs");
418
419        // Test non-conventional commits
420        assert_eq!(extract_commit_type("random commit message"), "other");
421        assert_eq!(extract_commit_type("update: not conventional"), "other");
422        assert_eq!(
423            extract_commit_type("feature: close but not standard"),
424            "other"
425        );
426        assert_eq!(extract_commit_type("no colon here"), "other");
427        assert_eq!(extract_commit_type(""), "other");
428
429        // Test edge cases
430        assert_eq!(extract_commit_type("feat:no space after colon"), "feat");
431        assert_eq!(extract_commit_type("feat  : extra spaces"), "feat");
432        assert_eq!(
433            extract_commit_type("feat(scope)(weird): nested parens"),
434            "feat"
435        );
436    }
437}