Merge pull request #11 from github/ql_gen

Generate QL classes

Author: nickrolfe

.github/workflows/build.yml

@@ -28,12 +28,17 @@ jobs:
         run: cargo build --release
       - name: Generate dbscheme
         if: ${{ matrix.os == 'ubuntu-latest' }}
-        run: target/release/generator
+        run: target/release/ruby-generator
       - uses: actions/upload-artifact@v2
         if: ${{ matrix.os == 'ubuntu-latest' }}
         with:
           name: ruby.dbscheme
           path: ruby.dbscheme
+      - uses: actions/upload-artifact@v2
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        with:
+          name: ruby_ast.qll
+          path: ruby_ast.qll
       - uses: actions/upload-artifact@v2
         with:
           name: extractor-${{ matrix.os }}

Cargo.lock

@@ -1,3 +1,22 @@
 # Ruby analysis support for CodeQL
 
-Under development.
+Under development.
+
+## Building the tools from source
+
+[Install Rust](https://www.rust-lang.org/tools/install), then run:
+
+```bash
+cargo build --release
+```
+
+## Generating the database schema and QL library
+
+The generated `ruby.dbscheme` and `ruby_ast.qll` files are included in the repository, but they can be re-generated as follows:
+
+```bash
+# Run the generator
+cargo run --release -p ruby-generator
+# Then auto-format the QL library
+codeql query format -i ruby_ast.qll
+```

README.md

@@ -225,10 +225,7 @@ impl Visitor<'_> {
                                 "too many values"
                             },
                             node.kind(),
-                            match field.name.as_ref() {
-                                Some(x) => x,
-                                None => "child",
-                            }
+                            &field.get_name()
                         )
                     }
                 }
@@ -237,10 +234,7 @@ impl Visitor<'_> {
                         self.trap_output.push(TrapEntry::ChildOf(
                             node_type_name(&field.parent.kind, field.parent.named),
                             parent_id,
-                            match &field.name {
-                                Some(name) => name.to_owned(),
-                                None => "child".to_owned(),
-                            },
+                            field.get_name(),
                             Index(index),
                             *child_id,
                         ));

extractor/src/extractor.rs

@@ -1,5 +1,5 @@
 [package]
-name = "generator"
+name = "ruby-generator"
 version = "0.1.0"
 authors = ["GitHub"]
 edition = "2018"

generator/Cargo.toml

@@ -1,3 +1,4 @@
+use crate::ql;
 use std::fmt;
 
 /// Represents a distinct entry in the database schema.
@@ -27,7 +28,7 @@ pub struct Column {
     pub db_type: DbColumnType,
     pub name: String,
     pub unique: bool,
-    pub ql_type: QlColumnType,
+    pub ql_type: ql::Type,
     pub ql_type_is_ref: bool,
 }
 
@@ -37,18 +38,6 @@ pub enum DbColumnType {
     String,
 }
 
-// The QL type of a column.
-pub enum QlColumnType {
-    /// Primitive `int` type.
-    Int,
-
-    /// Primitive `string` type.
-    String,
-
-    /// A custom type, defined elsewhere by a table or union.
-    Custom(String),
-}
-
 impl fmt::Display for Table {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         if let Some(keyset) = &self.keysets {
@@ -76,12 +65,7 @@ impl fmt::Display for Table {
                     DbColumnType::String => "string",
                 }
             )?;
-            write!(f, "{}: ", column.name)?;
-            match &column.ql_type {
-                QlColumnType::Int => write!(f, "int")?,
-                QlColumnType::String => write!(f, "string")?,
-                QlColumnType::Custom(name) => write!(f, "@{}", name)?,
-            }
+            write!(f, "{}: {}", column.name, column.ql_type)?;
             if column.ql_type_is_ref {
                 write!(f, " ref")?;
             }

generator/src/dbscheme.rs

@@ -4,4 +4,5 @@ pub struct Language {
     pub name: String,
     pub node_types: &'static str,
     pub dbscheme_path: PathBuf,
+    pub ql_library_path: PathBuf,
 }