gudusoft.gsqlparser.pp.score

Class PrettyScore

Object

gudusoft.gsqlparser.pp.score.PrettyScore

public final class PrettyScore
extends Object

PrettyScore: scores the readability of an already formatted SQL text against a style ScoreProfile and explains every deduction.

   ScoreReport r = new PrettyScore().score(formattedSql, EDbVendor.dbvmssql, ScoreProfile.defaults(), originalSql, null);
   r.getScore();       // 0-100
   r.getAttainable();  // what the formatter could reach on this input
   r.getRatio();       // score / attainable — the closed-loop target
   r.toJson();         // published contract, version "prettyscore/0.1"
 

Read this before quoting a number. While the profile's calibration is heuristic-v0 the weights are engineering guesses: the score is reliable only as a relative measure within one profile on one corpus (before/after a formatter change). It is not an absolute readability verdict and must not be presented as one.

Syntax errors are fine: the lexical facts come from the pp2 pipeline, which never needs a successful parse; only the AST depth is lost, in which case the indent dimension's weight is halved and a note is attached.

Thread-safety: the only configuration is setAstEnabled(boolean), read once at the start of every score call; instances may be shared.

Constructor Summary

Constructors

Constructor and Description
PrettyScore()

Method Summary

Modifier and Type	Method and Description
boolean	isAstEnabled()
ScoreReport	score(String sql, EDbVendor vendor) Score sql with the default profile and no fidelity gate.
ScoreReport	score(String sql, EDbVendor vendor, ScoreProfile profile, String original, Map<String,Object> options)
PrettyScore	setAstEnabled(boolean enabled) Whether a second GSP parse is run to stamp AST depth (default true).
static String	targetFor(String rule) The formatter option / renderer component a rule id maps to (see the improvement list).

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrettyScore

public PrettyScore()

Method Detail

setAstEnabled

public PrettyScore setAstEnabled(boolean enabled)

Whether a second GSP parse is run to stamp AST depth (default true). Disabling it makes scoring O(tokens) with no parser cost, at the price of the indent dimension's weight being halved as if the text had not parsed. Useful for very large scripts or pure lexical regression runs.

isAstEnabled

public boolean isAstEnabled()

score

public ScoreReport score(String sql,
                         EDbVendor vendor)

Score sql with the default profile and no fidelity gate.

score

public ScoreReport score(String sql,
                         EDbVendor vendor,
                         ScoreProfile profile,
                         String original,
                         Map<String,Object> options)

Parameters:

sql - the formatted SQL; must not be null

vendor - dialect; must not be null

profile - style profile; null selects isf-default

original - the un-formatted input; when given the fidelity gate (token / comment / AST preservation) and the comments dimension are evaluated

options - the formatter options the caller claims produced sql (GFmtOpt field names); when given, contradictions surface as OPTION_NOT_HONORED

targetFor

public static String targetFor(String rule)

The formatter option / renderer component a rule id maps to (see the improvement list).