rspec/rules/S2517/plsql/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

74 lines
1.1 KiB
Plaintext

== Why is this an issue?
Shared coding conventions allow teams to collaborate efficiently. This rule checks that all cursor names match the provided regular expression.
=== Noncompliant code example
With the default regular expression, ``++[a-zA-Z]([a-zA-Z0-9_]*[a-zA-Z0-9])?++``:
[source,sql]
----
CREATE TABLE employee(
name VARCHAR2(42)
);
DECLARE
CURSOR myCursor_ RETURN employee%ROWTYPE; -- Noncompliant
CURSOR myCursor_ RETURN employee%ROWTYPE IS SELECT * FROM employee; -- Noncompliant
BEGIN
NULL;
END;
/
DROP TABLE employee;
----
=== Compliant solution
[source,sql]
----
CREATE TABLE employee(
name VARCHAR2(42)
);
DECLARE
CURSOR myCursor RETURN employee%ROWTYPE;
CURSOR myCursor RETURN employee%ROWTYPE IS SELECT * FROM employee;
BEGIN
NULL;
END;
/
DROP TABLE employee;
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Rename this cursor to match the provided regular expression: xxx
=== Parameters
.regexp
****
----
[a-zA-Z]([a-zA-Z0-9_]*[a-zA-Z0-9])?
----
The regular expression the name should match.
****
endif::env-github,rspecator-view[]