Module: RailsLens::NoteCodes

Defined in:

lib/rails_lens/note_codes.rb

Overview

Compact note codes for LLM-readable annotations Format: “column_name:CODE” or “association:CODE”

Constant Summary

NOT_NULL =

Column constraint codes

'NOT_NULL'

DEFAULT =

'DEFAULT'

LIMIT =

'LIMIT'

INDEX =

Index codes

'INDEX'

POLY_INDEX =

'POLY_INDEX'

COMP_INDEX =

'COMP_INDEX'

REDUND_IDX =

'REDUND_IDX'

USE_DECIMAL =

Type codes

'USE_DECIMAL'

USE_INTEGER =

'USE_INTEGER'

INVERSE_OF =

Association codes

'INVERSE_OF'

N_PLUS_ONE =

'N_PLUS_ONE'

COUNTER_CACHE =

'COUNTER_CACHE'

FK_CONSTRAINT =

'FK_CONSTRAINT'

NO_TIMESTAMPS =

Best practices codes

'NO_TIMESTAMPS'

PARTIAL_TS =

'PARTIAL_TS'

STORAGE =

'STORAGE'

STI_INDEX =

STI codes

'STI_INDEX'

STI_NOT_NULL =

'STI_NOT_NULL'

VIEW_READONLY =

View codes

'VIEW_READONLY'

ADD_READONLY =

'ADD_READONLY'

MATVIEW_STALE =

'MATVIEW_STALE'

ADD_REFRESH =

'ADD_REFRESH'

NESTED_VIEW =

'NESTED_VIEW'

VIEW_PROTECT =

'VIEW_PROTECT'

MISSING =

Structure codes

'MISSING'

DEPTH_CACHE =

'DEPTH_CACHE'

Class Method Summary

• .note(subject, code) ⇒ String

  Build a compact note string.

Class Method Details

.note(subject, code) ⇒ String

Build a compact note string

Parameters:

• subject (String, nil) —

  column/association name (nil for model-level)

• code (String) —

  note code constant

Returns:

• (String) —

  formatted note

# File 'lib/rails_lens/note_codes.rb', line 54

def note(subject, code)
  subject ? "#{subject}:#{code}" : code
end