Merge pull request #53 from github/user-facing

Add some user-facing AST classes

Author: hvitved

.github/workflows/build.yml

@@ -46,8 +46,8 @@ jobs:
       - uses: actions/upload-artifact@v2
         if: ${{ matrix.os == 'ubuntu-latest' }}
         with:
-          name: ruby_ast.qll
-          path: ql/src/codeql_ruby/ast.qll
+          name: Generated.qll
+          path: ql/src/codeql_ruby/Generated.qll
       - uses: actions/upload-artifact@v2
         with:
           name: extractor-${{ matrix.os }}

Cargo.lock

@@ -12,13 +12,13 @@ cargo build --release
 
 ## Generating the database schema and QL library
 
-The generated `ql/src/ruby.dbscheme` and `ql/src/codeql_ruby/ast.qll` files are included in the repository, but they can be re-generated as follows:
+The generated `ql/src/ruby.dbscheme` and `ql/src/codeql_ruby/Generated.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 ql/src/codeql_ruby/ast.qll
+codeql query format -i ql/src/codeql_ruby/Generated.qll
 ```
 
 ## Building a CodeQL database for a Ruby program

README.md

@@ -1,7 +1,7 @@
 cargo build --release
 
 cargo run --release -p ruby-generator
-codeql query format -i ql\src\codeql_ruby\ast.qll
+codeql query format -i ql\src\codeql_ruby\Generated.qll
 
 rm -Recurse -Force extractor-pack
 mkdir extractor-pack | Out-Null

create-extractor-pack.ps1

@@ -13,7 +13,7 @@ fi
 cargo build --release
 
 cargo run --release -p ruby-generator
-codeql query format -i ql/src/codeql_ruby/ast.qll
+codeql query format -i ql/src/codeql_ruby/Generated.qll
 
 rm -rf extractor-pack
 mkdir -p extractor-pack

create-extractor-pack.sh

@@ -10,7 +10,7 @@ edition = "2018"
 flate2 = "1.0"
 node-types = { path = "../node-types" }
 tree-sitter = "0.17"
-tree-sitter-ruby = { git = "https://github.com/tree-sitter/tree-sitter-ruby.git", rev = "93632008c63e0577413bbedf120fb92a96397785" }
+tree-sitter-ruby = { git = "https://github.com/nickrolfe/tree-sitter-ruby.git", branch = "refinements" }
 clap = "2.33"
 tracing = "0.1"
 tracing-subscriber = { version = "0.2", features = ["env-filter"] }

extractor/Cargo.toml

@@ -10,4 +10,4 @@ edition = "2018"
 node-types = { path = "../node-types" }
 tracing = "0.1"
 tracing-subscriber = { version = "0.2", features = ["env-filter"] }
-tree-sitter-ruby = { git = "https://github.com/tree-sitter/tree-sitter-ruby.git", rev = "93632008c63e0577413bbedf120fb92a96397785" }
+tree-sitter-ruby = { git = "https://github.com/nickrolfe/tree-sitter-ruby.git", branch = "refinements" }

generator/Cargo.toml

@@ -574,7 +574,7 @@ fn main() {
         name: "Ruby".to_owned(),
         node_types: tree_sitter_ruby::NODE_TYPES,
         dbscheme_path: PathBuf::from("ql/src/ruby.dbscheme"),
-        ql_library_path: PathBuf::from("ql/src/codeql_ruby/ast.qll"),
+        ql_library_path: PathBuf::from("ql/src/codeql_ruby/Generated.qll"),
     };
     match node_types::read_node_types_str(&ruby.node_types) {
         Err(e) => {

generator/src/main.rs

@@ -214,10 +214,12 @@ pub fn write<'a>(
         " * Automatically generated from the tree-sitter grammar; do not edit\n"
     )?;
     write!(file, " */\n\n")?;
+    write!(file, "module Generated {{\n")?;
 
     for element in elements {
         write!(file, "{}\n\n", &element)?;
     }
 
+    write!(file, "}}")?;
     Ok(())
 }

generator/src/ql.rs

@@ -1,4 +1,4 @@
-import codeql_ruby.Variables
+import codeql_ruby.ast.Variable
 
 query predicate ambiguousVariable(VariableAccess access, Variable variable) {
   access.getVariable() = variable and