From a7a18b8b0f659c60b3986cd6f5d245871727bbd3 Mon Sep 17 00:00:00 2001
From: Nick Rolfe <nickrolfe@github.com>
Date: Wed, 21 Oct 2020 11:29:25 +0100
Subject: [PATCH] Gather all hard-coded Ruby-specific names/paths in one
 struct.

---
 generator/src/dbscheme.rs |  8 ++++++--
 generator/src/language.rs |  7 +++++++
 generator/src/main.rs     | 38 ++++++++++++++++++++++----------------
 3 files changed, 35 insertions(+), 18 deletions(-)
 create mode 100644 generator/src/language.rs

diff --git a/generator/src/dbscheme.rs b/generator/src/dbscheme.rs
index 0edbfcb2b74..e6503707986 100644
--- a/generator/src/dbscheme.rs
+++ b/generator/src/dbscheme.rs
@@ -102,8 +102,12 @@ pub fn escape_name(name: &str) -> String {
 }
 
 /// Generates the dbscheme by writing the given dbscheme `entries` to the `file`.
-pub fn write(file: &mut dyn std::io::Write, entries: &[Entry]) -> std::io::Result<()> {
-    write!(file, "// CodeQL database schema for Ruby\n")?;
+pub fn write(
+    language_name: &str,
+    file: &mut dyn std::io::Write,
+    entries: &[Entry],
+) -> std::io::Result<()> {
+    write!(file, "// CodeQL database schema for {}\n", language_name)?;
     write!(
         file,
         "// Automatically generated from the tree-sitter grammar; do not edit\n\n"
diff --git a/generator/src/language.rs b/generator/src/language.rs
new file mode 100644
index 00000000000..7f289c27de2
--- /dev/null
+++ b/generator/src/language.rs
@@ -0,0 +1,7 @@
+use std::path::PathBuf;
+
+pub struct Language {
+    pub name: String,
+    pub node_types_path: PathBuf,
+    pub dbscheme_path: PathBuf,
+}
diff --git a/generator/src/main.rs b/generator/src/main.rs
index d7c28142c23..06fc7f250c6 100644
--- a/generator/src/main.rs
+++ b/generator/src/main.rs
@@ -1,14 +1,15 @@
+mod dbscheme;
+mod language;
+mod node_types;
+
+use language::Language;
+use node_types::{FieldInfo, NodeInfo};
 use std::fs::File;
 use std::io::LineWriter;
-use std::path::Path;
+use std::path::PathBuf;
 
-mod dbscheme;
-mod node_types;
-use node_types::{FieldInfo, NodeInfo};
-
-fn read_node_types() -> Option<Vec<NodeInfo>> {
-    let json_data = match std::fs::read_to_string(Path::new("tree-sitter-ruby/src/node-types.json"))
-    {
+fn read_node_types(language: &Language) -> Option<Vec<NodeInfo>> {
+    let json_data = match std::fs::read_to_string(&language.node_types_path) {
         Ok(s) => s,
         Err(_) => return None,
     };
@@ -214,19 +215,17 @@ fn convert_nodes(nodes: &[NodeInfo]) -> Vec<dbscheme::Entry> {
     entries
 }
 
-fn write_dbscheme(entries: &[dbscheme::Entry]) -> std::io::Result<()> {
-    // TODO: figure out proper output path and/or take it from the command line.
-    let path = Path::new("ruby.dbscheme");
+fn write_dbscheme(language: &Language, entries: &[dbscheme::Entry]) -> std::io::Result<()> {
     println!(
         "Writing to '{}'",
-        match path.to_str() {
+        match language.dbscheme_path.to_str() {
             None => "<undisplayable>",
             Some(p) => p,
         }
     );
-    let file = File::create(path)?;
+    let file = File::create(&language.dbscheme_path)?;
     let mut file = LineWriter::new(file);
-    dbscheme::write(&mut file, &entries)
+    dbscheme::write(&language.name, &mut file, &entries)
 }
 
 fn create_location_entry() -> dbscheme::Entry {
@@ -295,7 +294,14 @@ fn create_source_location_prefix_entry() -> dbscheme::Entry {
 }
 
 fn main() {
-    match read_node_types() {
+    // TODO: figure out proper dbscheme output path and/or take it from the
+    // command line.
+    let ruby = Language {
+        name: "Ruby".to_string(),
+        node_types_path: PathBuf::from("tree-sitter-ruby/src/node-types.json"),
+        dbscheme_path: PathBuf::from("ruby.dbscheme"),
+    };
+    match read_node_types(&ruby) {
         None => {
             println!("Failed to read node types");
             std::process::exit(1);
@@ -304,7 +310,7 @@ fn main() {
             let mut dbscheme_entries = convert_nodes(&nodes);
             dbscheme_entries.push(create_location_entry());
             dbscheme_entries.push(create_source_location_prefix_entry());
-            match write_dbscheme(&dbscheme_entries) {
+            match write_dbscheme(&ruby, &dbscheme_entries) {
                 Err(e) => {
                     println!("Failed to write dbscheme: {}", e);
                     std::process::exit(2);