Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 43 additions & 3 deletions cmd/enola/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ import (
"os"
"path/filepath"

"github.com/enola-labs/enola/internal/config"
"github.com/enola-labs/enola/pkg/bootstrap"
"github.com/enola-labs/enola/pkg/explain"
)

func main() {
Expand All @@ -16,12 +18,24 @@ func main() {
ctx := context.Background()

generateMode := false
explainMode := false
cfgPath := "mcp-arch.yaml"
explainRepo := "" // optional positional repo path for --explain

for _, arg := range os.Args[1:] {
if arg == "--generate" {
switch arg {
case "--generate":
generateMode = true
} else {
cfgPath = arg
case "--explain":
explainMode = true
default:
// In --explain mode the positional argument is the repository path;
// otherwise it is the config file path.
if explainMode {
explainRepo = arg
} else {
cfgPath = arg
}
}
}

Expand All @@ -32,6 +46,11 @@ func main() {
log.Fatalf("failed to create engine: %v", err)
}

if explainMode {
runExplain(ctx, eng, cfg, explainRepo)
os.Exit(0)
}

if generateMode {
repoPath, err := filepath.Abs(cfg.Repo)
if err != nil {
Expand Down Expand Up @@ -68,3 +87,24 @@ func main() {
log.Fatalf("server error: %v", err)
}
}

// runExplain indexes the given repository (defaulting to the configured repo)
// and prints a human-readable statistical summary to stdout.
func runExplain(ctx context.Context, eng *bootstrap.Engine, cfg *config.Config, repoArg string) {
repo := repoArg
if repo == "" {
repo = cfg.Repo
}
repoPath, err := filepath.Abs(repo)
if err != nil {
log.Fatalf("failed to resolve repo path: %v", err)
}

fmt.Fprintf(os.Stderr, "Analyzing %s …\n", repoPath)
if _, err := eng.GenerateSnapshot(ctx, repoPath, false); err != nil {
log.Fatalf("snapshot generation failed: %v", err)
}

report := explain.Compute(eng)
fmt.Print(report.Render())
}
260 changes: 229 additions & 31 deletions internal/explainers/layers/layers.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,147 @@ var (
{Name: "pkg", Patterns: []string{"pkg"}, Level: 0},
{Name: "api", Patterns: []string{"api"}, Level: 2},
}

// Ruby on Rails MVC layout
railsLayers = []layerDef{
{Name: "model", Patterns: []string{"model", "models"}, Level: 0},
{Name: "controller", Patterns: []string{"controller", "controllers"}, Level: 3},
{Name: "view", Patterns: []string{"view", "views"}, Level: 3},
{Name: "helper", Patterns: []string{"helper", "helpers"}, Level: 2},
{Name: "mailer", Patterns: []string{"mailer", "mailers"}, Level: 2},
{Name: "job", Patterns: []string{"job", "jobs", "worker", "workers"}, Level: 1},
{Name: "service", Patterns: []string{"service", "services"}, Level: 1},
}

// Android clean architecture / MVVM layout
androidLayers = []layerDef{
{Name: "domain", Patterns: []string{"domain"}, Level: 0},
{Name: "data", Patterns: []string{"data", "repository", "repositories"}, Level: 1},
{Name: "ui", Patterns: []string{"ui", "presentation", "view", "views", "screen", "screens"}, Level: 3},
{Name: "di", Patterns: []string{"di", "injection"}, Level: 2},
{Name: "designsystem", Patterns: []string{"designsystem"}, Level: 3},
}

// iOS clean architecture / MVVM layout
iosLayers = []layerDef{
{Name: "domain", Patterns: []string{"domain"}, Level: 0},
{Name: "data", Patterns: []string{"data", "repository", "repositories"}, Level: 1},
{Name: "ui", Patterns: []string{"ui", "presentation", "view", "views", "screen", "screens", "components"}, Level: 3},
{Name: "designsystem", Patterns: []string{"designsystem"}, Level: 3},
}

// Spring layered architecture layout
springLayers = []layerDef{
{Name: "controller", Patterns: []string{"controller", "controllers", "rest", "web"}, Level: 3},
{Name: "service", Patterns: []string{"service", "services"}, Level: 1},
{Name: "repository", Patterns: []string{"repository", "repositories", "dao", "daos"}, Level: 1},
{Name: "entity", Patterns: []string{"entity", "entities", "model", "models", "domain"}, Level: 0},
{Name: "dto", Patterns: []string{"dto", "dtos"}, Level: 2},
{Name: "config", Patterns: []string{"config", "configuration"}, Level: 2},
}

// Django layout
djangoLayers = []layerDef{
{Name: "models", Patterns: []string{"model", "models"}, Level: 0},
{Name: "views", Patterns: []string{"view", "views"}, Level: 3},
{Name: "serializers", Patterns: []string{"serializer", "serializers"}, Level: 2},
{Name: "urls", Patterns: []string{"url", "urls"}, Level: 3},
{Name: "admin", Patterns: []string{"admin"}, Level: 3},
{Name: "forms", Patterns: []string{"form", "forms"}, Level: 2},
}
)

// patternDef defines an architecture pattern together with the signals that gate
// its detection. Without gating, generic directory names (api, app, ui, lib,
// model, ...) cause patterns to match repos of the wrong language/framework.
type patternDef struct {
name string
layers []layerDef

// languages, if non-empty, requires the repo's dominant language to be one
// of these for the pattern to be considered.
languages []string
// frameworks, if non-empty, requires at least one of these frameworks to be
// present in the facts for the pattern to be considered.
frameworks []string
// signatureLayers, if non-empty, requires at least minSignatureLayers of the
// matched layers to be distinctive ones from this set (so a pattern built
// only from generic names — or from a single stray directory — does not
// qualify).
signatureLayers []string
minSignatureLayers int
}

// patternDefs lists all known architecture patterns. Order does not affect the
// outcome; bestPattern selects by specificity then confidence.
var patternDefs = []patternDef{
// Framework-gated patterns (most specific).
{name: "nextjs", layers: nextjsLayers, frameworks: []string{"nextjs"}},
{name: "rails-mvc", layers: railsLayers, frameworks: []string{"rails"}},
{name: "android-clean", layers: androidLayers, frameworks: []string{"android"}},
{name: "ios-clean", layers: iosLayers, frameworks: []string{"swiftui", "uikit"}},
{name: "spring-layered", layers: springLayers, frameworks: []string{"spring"}},
{name: "django", layers: djangoLayers, frameworks: []string{"django"}},

// Language-gated patterns.
{name: "go-standard", layers: goStdLayers, languages: []string{"go"}},

// Language-agnostic patterns, gated on distinctive signature layers. Require
// at least two distinct ports-and-adapters layers so a single stray
// directory (e.g. one "infrastructure" test folder) does not trigger it.
{name: "hexagonal", layers: hexagonalLayers, signatureLayers: []string{"application", "port", "adapter"}, minSignatureLayers: 2},
}

// specificity ranks how targeted a pattern's gating is. Higher wins ties: a
// framework-specific pattern is preferred over a language-gated one, which is
// preferred over a generic (signature-only) pattern.
func (d patternDef) specificity() int {
switch {
case len(d.frameworks) > 0:
return 2
case len(d.languages) > 0:
return 1
default:
return 0
}
}

// gateOK reports whether the pattern's language/framework requirements are met.
func (d patternDef) gateOK(lang string, frameworks map[string]bool) bool {
if len(d.languages) > 0 {
matched := false
for _, l := range d.languages {
if l == lang {
matched = true
break
}
}
if !matched {
return false
}
}
if len(d.frameworks) > 0 {
matched := false
for _, f := range d.frameworks {
if frameworks[f] {
matched = true
break
}
}
if !matched {
return false
}
}
return true
}

// archPattern represents a detected architecture pattern with its confidence.
type archPattern struct {
Name string
Confidence float64
Layers map[string]*layerDef
Modules map[string]string // module -> layer name
Name string
Confidence float64
Specificity int // from patternDef.specificity(); used to break ties in bestPattern
Layers map[string]*layerDef
Modules map[string]string // module -> layer name
}

// Explain analyzes the fact store and detects architectural patterns.
Expand All @@ -77,8 +210,12 @@ func (e *LayerExplainer) Explain(ctx context.Context, store *facts.Store) ([]fac
return nil, nil
}

// Derive language/framework signals used to gate pattern detection.
lang := dominantLanguage(modules)
frameworks := presentFrameworks(store)

// Detect which architecture patterns match
patterns := e.detectPatterns(modules)
patterns := e.detectPatterns(modules, lang, frameworks)

var insights []facts.Insight

Expand Down Expand Up @@ -111,21 +248,24 @@ func (e *LayerExplainer) Explain(ctx context.Context, store *facts.Store) ([]fac
return insights, nil
}

func (e *LayerExplainer) detectPatterns(modules []facts.Fact) []*archPattern {
func (e *LayerExplainer) detectPatterns(modules []facts.Fact, lang string, frameworks map[string]bool) []*archPattern {
var patterns []*archPattern

for _, def := range []struct {
name string
layers []layerDef
}{
{"hexagonal", hexagonalLayers},
{"nextjs", nextjsLayers},
{"go-standard", goStdLayers},
} {
for di := range patternDefs {
def := patternDefs[di]

// Skip patterns whose language/framework gate is not satisfied. This is
// what stops e.g. a Python or Ruby repo from matching the generic
// "nextjs" directory names, or a plain OOP repo from matching nextjs.
if !def.gateOK(lang, frameworks) {
continue
}

pattern := &archPattern{
Name: def.name,
Layers: make(map[string]*layerDef),
Modules: make(map[string]string),
Name: def.name,
Specificity: def.specificity(),
Layers: make(map[string]*layerDef),
Modules: make(map[string]string),
}

matchCount := 0
Expand All @@ -140,41 +280,99 @@ func (e *LayerExplainer) detectPatterns(modules []facts.Fact) []*archPattern {
}
}

if matchCount > 0 && len(modules) > 0 {
// Confidence based on how many modules are classified
coverage := float64(matchCount) / float64(len(modules))
// Also factor in how many distinct layers are matched
layerCoverage := float64(len(pattern.Layers)) / float64(len(def.layers))
if matchCount == 0 || len(modules) == 0 {
continue
}

pattern.Confidence = (coverage*0.6 + layerCoverage*0.4)
if pattern.Confidence > 1.0 {
pattern.Confidence = 1.0
}
// Require enough distinctive signature layers when the pattern declares
// them, so a match built only from generic names (e.g. just model + ui)
// or from a single stray directory does not qualify.
if len(def.signatureLayers) > 0 &&
countSignatureLayers(pattern, def.signatureLayers) < def.minSignatureLayers {
continue
}

// Minimum threshold
if pattern.Confidence >= 0.2 && len(pattern.Layers) >= 2 {
patterns = append(patterns, pattern)
}
// Confidence based on how many modules are classified
coverage := float64(matchCount) / float64(len(modules))
// Also factor in how many distinct layers are matched
layerCoverage := float64(len(pattern.Layers)) / float64(len(def.layers))

pattern.Confidence = (coverage*0.6 + layerCoverage*0.4)
if pattern.Confidence > 1.0 {
pattern.Confidence = 1.0
}

// Minimum threshold
if pattern.Confidence >= 0.2 && len(pattern.Layers) >= 2 {
patterns = append(patterns, pattern)
}
}

return patterns
}

// countSignatureLayers returns how many of the given distinctive layer names the
// detected pattern matched.
func countSignatureLayers(pattern *archPattern, signature []string) int {
n := 0
for _, name := range signature {
if _, ok := pattern.Layers[name]; ok {
n++
}
}
return n
}

func (e *LayerExplainer) bestPattern(patterns []*archPattern) *archPattern {
if len(patterns) == 0 {
return nil
}

best := patterns[0]
for _, p := range patterns[1:] {
if p.Confidence > best.Confidence {
// Prefer the more specific pattern (framework > language > generic);
// break ties by confidence.
if p.Specificity > best.Specificity ||
(p.Specificity == best.Specificity && p.Confidence > best.Confidence) {
best = p
}
}
return best
}

// dominantLanguage returns the most common language across module facts, using
// the Props["language"] attribute every extractor sets. Ties break
// alphabetically for deterministic output.
func dominantLanguage(modules []facts.Fact) string {
counts := make(map[string]int)
for _, m := range modules {
if lang, ok := m.Props["language"].(string); ok && lang != "" {
counts[lang]++
}
}
best := ""
bestN := 0
for lang, n := range counts {
if n > bestN || (n == bestN && lang < best) {
best, bestN = lang, n
}
}
return best
}

// presentFrameworks collects the set of frameworks present anywhere in the fact
// store, using the Props["framework"] attribute extractors set on routes,
// symbols and modules (e.g. nextjs, rails, django, android, spring).
func presentFrameworks(store *facts.Store) map[string]bool {
out := make(map[string]bool)
for _, f := range store.All() {
if fw, ok := f.Props["framework"].(string); ok && fw != "" {
out[fw] = true
}
}
return out
}

// detectViolations checks for layer boundary violations (inner layer importing outer layer).
func (e *LayerExplainer) detectViolations(store *facts.Store, pattern *archPattern) []facts.Insight {
var insights []facts.Insight
Expand Down
Loading
Loading