hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-18 05:24:01 +02:00
Code Issues Packages Projects Releases Wiki Activity

Ruby: Update docs to reflect that import ruby is no longer used

Browse Source
This commit is contained in:
Tom Hvitved
2022-09-13 19:59:27 +02:00
parent b477a4cc81
commit fe7d01ecbe
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/codeql/codeql-language-guides/basic-query-for-ruby-code.rst
View File

@@ -36,7 +36,7 @@ Running the query
.. code-block:: ql
import ruby
import codeql.ruby.AST
from IfExpr ifexpr
where
@@ -80,7 +80,7 @@ After the initial ``import`` statement, this simple query comprises three parts
+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| Query part | Purpose | Details |
+===============================================================+===================================================================================================================+========================================================================================================================+
| ``import ruby`` | Imports the standard CodeQL libraries for Ruby. | Every query begins with one or more ``import`` statements. |
| ``import codeql.ruby.AST`` | Imports the standard CodeQL AST libraries for Ruby. | Every query begins with one or more ``import`` statements. |
+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| ``from IfExpr ifexpr`` | Defines the variables for the query. | We use: an ``IfExpr`` variable for ``if`` expressions. |
| | Declarations are of the form: | |

18
docs/codeql/codeql-language-guides/codeql-library-for-ruby.rst
View File

@@ -18,7 +18,7 @@ library by beginning your query with:
.. code-block:: ql
import ruby
import codeql.ruby.AST
The CodeQL libraries model various aspects of Ruby code, depending on the type of query you want to write.
For example the abstract syntax tree (AST) library is used for locating program elements, to match syntactic
@@ -138,7 +138,7 @@ The following example lists all methods in the class `ApiController`:
.. code-block:: ql
import ruby
import codeql.ruby.AST
from ClassDeclaration m
where m.getName() = "ApiController"
@@ -223,7 +223,7 @@ Example
.. code-block:: ql
import ruby
import codeql.ruby.AST
from Method m
where m.getName() = "show"
@@ -274,7 +274,7 @@ The following example finds all literals that are returned by a `return` stateme
.. code-block:: ql
import ruby
import codeql.ruby.AST
from ReturnStmt return, Literal lit
where lit.getParent() = return
@@ -421,7 +421,7 @@ The following example finds "chained assignments" (of the form ``A=B=C``):
.. code-block:: ql
import ruby
import codeql.ruby.AST
from Assignment op
where op.getRightOperand() instanceof Assignment
@@ -460,7 +460,7 @@ The following example finds all method calls to a method called `delete`.
.. code-block:: ql
import ruby
import codeql.ruby.AST
from MethodCall call
where call.getMethodName() = "delete"
@@ -517,7 +517,7 @@ The following example finds `if`-expressions that are missing a `then` branch.
.. code-block:: ql
import ruby
import codeql.ruby.AST
from IfExpr expr
where not exists(expr.getThen())
@@ -559,7 +559,7 @@ The following example finds all class variables in the class `StaticController`:
.. code-block:: ql
import ruby
import codeql.ruby.AST
from ClassDeclaration cd, ClassVariable v
where
@@ -612,7 +612,7 @@ The following example finds writes to class variables in the class `StaticContro
.. code-block:: ql
import ruby
import codeql.ruby.AST
from ClassVariableWriteAccess write, ClassDeclaration cd, ClassVariable v
where