generate cache scaffolding (#6)

* update readme

* update fixture to simple_app

* write failing test for generate_cache

* fix bad reference to fixture

* write comment

* fix test

* create instructions

* Move CLI under packs namespace

* extract string helpers into function

README.md

@@ -3,3 +3,13 @@
 ![Audit](https://github.com/alexevanczuk/pks/actions/workflows/audit.yml/badge.svg)
 
 WIP: Rust implementation of packs for ruby
+
+# Initial Milestone
+
+- [ ] `pks generate_cache`, which can be used to update `tmp/packwerk/cache` for faster `packwerk` output. It should produce the exact same `json` that `packwerk` produces today. Challenges include:
+  - [ ] Parsing ERB
+  - [ ] Parsing Rails associations and rewriting them as constant references using a pluralizer. Initially, non-standard inflections will likely not be supported (although I may support it through hard-coded map in `packwerk.yml`)
+  - [ ] Replicating packwerk's behavior with respect to not recording "local definitions"
+- [ ] `pks check`, which can be used as a drop-in replacement to the VSCode
+- [ ] `pks update`, which can be used to update `deprecated_references.yml`
+- [ ] `pks lsp`, to launch an LSP-server to provide faster feedback

src/main.rs

@@ -1,7 +1,6 @@
-pub mod cli;
-pub mod packs;
-use cli::cli;
+use packs::cli;
 
+pub mod packs;
 fn main() {
-    cli()
+    cli::run()
 }

src/packs.rs

@@ -1,7 +1,9 @@
 use glob::glob;
 use std::path::PathBuf;
 
+pub(crate) mod cli;
 pub mod parser;
+mod string_helpers;
 
 pub fn greet() {
     println!("Hello! This CLI is under construction.")
@@ -62,7 +64,7 @@ mod tests {
     #[test]
     fn test_all() {
         let mut expected_packs: Vec<Pack> = Vec::new();
-        let absolute_root: PathBuf = PathBuf::from("tests/fixtures/simple_dependency_violation");
+        let absolute_root: PathBuf = PathBuf::from("tests/fixtures/simple_app");
 
         let foo_yml = absolute_root.join(PathBuf::from("packs/foo/package.yml"));
         let root_yml = absolute_root.join(PathBuf::from("package.yml"));

src/cli.rs → src/packs/cli.rs

@@ -1,5 +1,12 @@
-use crate::packs;
 use crate::packs::parser;
+use crate::packs::{self, string_helpers};
+
+// Make this import work
+// I'm getting this error:
+// unresolved import `crate::string_helpers`
+// no `string_helpers` in the root
+// use crate::string_helpers;
+
 use clap::{Parser, Subcommand};
 use std::path::PathBuf;
 
@@ -8,6 +15,10 @@ enum Command {
     Greet,
     ListPacks,
     Check,
+    GenerateCache {
+        #[clap(required = true)]
+        files: Vec<String>,
+    },
 }
 
 /// A CLI to interact with packs
@@ -32,7 +43,7 @@ impl Args {
     // }
 }
 
-pub fn cli() {
+pub fn run() {
     let args = Args::parse();
     let absolute_root = args.absolute_project_root().expect("Issue getting absolute_project_root!");
     match args.command {
@@ -43,5 +54,9 @@ pub fn cli() {
         Command::Check => {
             parser::get_references(absolute_root);
         }
+        Command::GenerateCache { files } => {
+            let file_string = string_helpers::to_sentence(files);
+            println!("Cache was generated for files {}", file_string);
+        }
     }
 }

src/packs/parser.rs

@@ -463,3 +463,7 @@ mod tests {
         );
     }
 }
+
+pub fn generate_cache(_absolute_root: PathBuf) {
+    todo!()
+}

src/packs/string_helpers.rs

@@ -0,0 +1,18 @@
+pub(crate) fn to_sentence(list: Vec<String>) -> String {
+    let mut file_string = String::new();
+    // Extract this to src/string_helpers.rs to_sentence function and import it into this
+    // and invoke it.
+    for (i, file) in list.iter().enumerate() {
+        if i == 0 {
+            file_string.push_str(file);
+        } else if i == list.len() - 1 {
+            file_string.push_str(", and ");
+            file_string.push_str(file);
+        } else {
+            file_string.push_str(", ");
+            file_string.push_str(file);
+        }
+    }
+
+    file_string
+}

tests/generate_cache.rs

@@ -0,0 +1,20 @@
+use assert_cmd::prelude::*;
+use predicates::prelude::*;
+use std::{error::Error, process::Command};
+
+#[test]
+fn test_generate_cache() -> Result<(), Box<dyn Error>> {
+    Command::cargo_bin("pks")?
+        .arg("--project-root")
+        .arg("tests/fixtures/simple_app")
+        .arg("generate-cache")
+        .arg("file1.rb")
+        .arg("file2.rb")
+        .arg("file3.rb")
+        .assert()
+        .success()
+        .stdout(predicate::str::contains(
+            "Cache was generated for files file1.rb, file2.rb, and file3.rb\n",
+        ));
+    Ok(())
+}

tests/list_packs_test.rs

@@ -6,7 +6,7 @@ use std::{error::Error, process::Command};
 fn lint_packs() -> Result<(), Box<dyn Error>> {
     Command::cargo_bin("pks")?
         .arg("--project-root")
-        .arg("tests/fixtures/simple_dependency_violation")
+        .arg("tests/fixtures/simple_app")
         .arg("list-packs")
         .assert()
         .success()

tests/simple_dependency_test.rs

@@ -7,7 +7,7 @@ use std::{error::Error, process::Command};
 fn test_check() -> Result<(), Box<dyn Error>> {
     Command::cargo_bin("packs")?
         .arg("--project-root")
-        .arg("tests/fixtures/simple_dependency_violation")
+        .arg("tests/fixtures/simple_app")
         .arg("check")
         .assert()
         .failure()