Merge pull request #208 from github/friendly-getfile

Author: hendrikvanantwerpen

stack-graphs/CHANGELOG.md

@@ -10,12 +10,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - New `Defines` and `Refers` assertions test for the presence of definitions and references, respectively, without resolution.
+- A method `StackGraph::get_file` to look up an existing file.
 
 ### Changed
 
 - The `IncorrectDefinitions` error is renamed to `IncorrectlyDefined`, and `IncorrectDefinitions` is the error used for the `Defines` assertion.
 - The `PartialPaths::find_all_partial_paths_in_file` method has been replaced by `PartialPaths::find_minimal_partial_path_set_in_file`, which computes a smaller set. The `ForwardPartialPathStitcher::find_locally_maximal_partial_path_set` function can be used to compute the set previously returned by `find_all_partial_paths_in_file` from the minimal partial path set.
 
+### Removed
+
+- The method `StackGraph::get_file_unchecked` is removed. Use the new `StackGraph::get_file` instead.
+
 ## v0.10.2 -- 2023-01-10
 
 ### Changed

stack-graphs/src/graph.rs

@@ -359,9 +359,9 @@ impl StackGraph {
 
     /// Returns the file with a particular name.  Panics if there is no file with the requested
     /// name.
-    pub fn get_file_unchecked<S: AsRef<str> + ?Sized>(&self, name: &S) -> Handle<File> {
+    pub fn get_file<S: AsRef<str> + ?Sized>(&self, name: &S) -> Option<Handle<File>> {
         let name = name.as_ref();
-        self.file_handles.get(name).copied().expect("Missing file")
+        self.file_handles.get(name).copied()
     }
 }
 

stack-graphs/tests/it/c/can_find_local_nodes.rs

@@ -29,7 +29,7 @@ use crate::test_graphs;
 
 fn check_local_nodes(graph: &TestGraph, file: &str, expected_local_nodes: &[&str]) {
     let rust_graph = unsafe { &(*graph.graph).inner };
-    let file = rust_graph.get_file_unchecked(file);
+    let file = rust_graph.get_file(file).expect("Missing file");
 
     let partials = sg_partial_path_arena_new();
     let path_list = sg_partial_path_list_new();

stack-graphs/tests/it/c/can_find_partial_paths_in_file.rs

@@ -73,7 +73,7 @@ fn partial_path_edge_list_available_in_both_directions(
 
 fn check_partial_paths_in_file(graph: &TestGraph, file: &str, expected_paths: &[&str]) {
     let rust_graph = unsafe { &(*graph.graph).inner };
-    let file = rust_graph.get_file_unchecked(file);
+    let file = rust_graph.get_file(file).expect("Missing file");
 
     let partials = sg_partial_path_arena_new();
     let path_list = sg_partial_path_list_new();

stack-graphs/tests/it/c/can_jump_to_definition_with_phased_partial_path_stitching.rs

@@ -104,7 +104,7 @@ impl StorageLayer {
 
 fn check_jump_to_definition(graph: &TestGraph, file: &str, expected_partial_paths: &[&str]) {
     let rust_graph = unsafe { &(*graph.graph).inner };
-    let file = rust_graph.get_file_unchecked(file);
+    let file = rust_graph.get_file(file).expect("Missing file");
     let partials = sg_partial_path_arena_new();
     let rust_partials = unsafe { &mut (*partials).inner };
     let db = sg_partial_path_database_new();

stack-graphs/tests/it/c/can_jump_to_definition_with_phased_path_stitching.rs

@@ -107,7 +107,7 @@ impl StorageLayer {
 
 fn check_jump_to_definition(graph: &TestGraph, file: &str, expected_paths: &[&str]) {
     let rust_graph = unsafe { &(*graph.graph).inner };
-    let file = rust_graph.get_file_unchecked(file);
+    let file = rust_graph.get_file(file).expect("Missing file");
     let paths = sg_path_arena_new();
     let rust_paths = unsafe { &mut (*paths).inner };
     let partials = sg_partial_path_arena_new();

stack-graphs/tests/it/can_find_local_nodes.rs

@@ -16,7 +16,7 @@ use stack_graphs::NoCancellation;
 use crate::test_graphs;
 
 fn check_local_nodes(graph: &StackGraph, file: &str, expected_local_nodes: &[&str]) {
-    let file = graph.get_file_unchecked(file);
+    let file = graph.get_file(file).expect("Missing file");
     let mut partials = PartialPaths::new();
     let mut database = Database::new();
     partials

stack-graphs/tests/it/can_find_node_partial_paths_in_database.rs

@@ -23,7 +23,7 @@ fn check_node_partial_paths(
     id: (&str, u32),
     expected_partial_paths: &[&str],
 ) {
-    let file = graph.get_file_unchecked(id.0);
+    let file = graph.get_file(id.0).expect("Missing file");
     let id = NodeID::new_in_file(file, id.1);
     let node = graph.node_for_id(id).expect("Cannot find node");
     let mut partials = PartialPaths::new();

stack-graphs/tests/it/can_find_partial_paths_in_file.rs

@@ -15,7 +15,7 @@ use stack_graphs::NoCancellation;
 use crate::test_graphs;
 
 fn check_partial_paths_in_file(graph: &StackGraph, file: &str, expected_paths: &[&str]) {
-    let file = graph.get_file_unchecked(file);
+    let file = graph.get_file(file).expect("Missing file");
     let mut partials = PartialPaths::new();
     let mut results = BTreeSet::new();
     partials

stack-graphs/tests/it/can_find_root_partial_paths_in_database.rs

@@ -28,7 +28,7 @@ fn check_root_partial_paths(
     precondition: &[&str],
     expected_partial_paths: &[&str],
 ) {
-    let file = graph.get_file_unchecked(file);
+    let file = graph.get_file(file).expect("Missing file");
     let mut paths = Paths::new();
     let mut partials = PartialPaths::new();
     let mut db = Database::new();