entrygraph 0.1.34__tar.gz → 0.1.36__tar.gz

{entrygraph-0.1.34 → entrygraph-0.1.36}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: entrygraph
-Version: 0.1.34
+Version: 0.1.36
 Summary: Language-agnostic code graph: query symbols, entrypoints, and source-to-sink call paths from a SQLite index
 Project-URL: Repository, https://github.com/brettbergin/entrygraph
 Author-email: Brett Bergin <brettberginbc@yahoo.com>

{entrygraph-0.1.34 → entrygraph-0.1.36}/src/entrygraph/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.1.34'
-__version_tuple__ = version_tuple = (0, 1, 34)
+__version__ = version = '0.1.36'
+__version_tuple__ = version_tuple = (0, 1, 36)
 
 __commit_id__ = commit_id = None

{entrygraph-0.1.34 → entrygraph-0.1.36}/src/entrygraph/detect/entrypoints/php.py

@@ -21,21 +21,49 @@ from entrygraph.extract.ir import EntrypointHint, FileExtraction
 from entrygraph.kinds import EntrypointKind, SymbolKind
 
 _LARAVEL_VERBS = frozenset({"get", "post", "put", "delete", "patch", "any", "match"})
+_LARAVEL_RESOURCE = frozenset({"resource", "apiResource"})
 _SYMFONY_ROUTE = re.compile(r"#\[\s*Route\s*\(")
 _WORDPRESS_HOOKS = frozenset({"add_action", "add_filter"})
 
 
+def _resource_param(name: str) -> str:
+    """The Laravel resource param: singular of the last (dot-nested) segment —
+    `photos` -> `{photo}`, `blog.comments` -> `{comment}`."""
+    seg = name.strip("/").split(".")[-1]
+    singular = seg[:-1] if seg.endswith("s") and not seg.endswith("ss") else seg
+    return "{" + (singular or "id") + "}"
+
+
+def _resource_routes(name: str, is_api: bool) -> list[tuple[str, str]]:
+    """Expand Route::resource/apiResource into its REST (method, path) routes.
+
+    apiResource omits the HTML create/edit forms that resource adds.
+    """
+    base = "/" + name.strip("/").replace(".", "/")
+    param = _resource_param(name)
+    routes = [
+        ("GET", base),  # index
+        ("POST", base),  # store
+        ("GET", f"{base}/{param}"),  # show
+        ("PUT", f"{base}/{param}"),  # update
+        ("DELETE", f"{base}/{param}"),  # destroy
+    ]
+    if not is_api:
+        routes += [
+            ("GET", f"{base}/create"),  # create form
+            ("GET", f"{base}/{param}/edit"),  # edit form
+        ]
+    return routes
+
+
 def _laravel_routes(x: FileExtraction) -> list[EntrypointHint]:
     if not re.search(r"(^|/)routes/[^/]+\.php$", x.path):
         return []
     hints = []
     for ref in x.references:
-        if (
-            ref.kind == "call"
-            and ref.receiver_text == "Route"
-            and ref.callee_name in _LARAVEL_VERBS
-            and ref.arg_preview
-        ):
+        if ref.kind != "call" or ref.receiver_text != "Route" or not ref.arg_preview:
+            continue
+        if ref.callee_name in _LARAVEL_VERBS:
             route = first_string_arg("(" + ref.arg_preview.lstrip("("))
             hints.append(
                 EntrypointHint(
@@ -50,6 +78,24 @@ def _laravel_routes(x: FileExtraction) -> list[EntrypointHint]:
                     metadata={"registration": ref.arg_preview},
                 )
             )
+        elif ref.callee_name in _LARAVEL_RESOURCE:
+            # Route::resource('photos', Ctrl) / apiResource(...) registers a fixed
+            # set of REST routes at once; expand them so they aren't all missed.
+            name = first_string_arg("(" + ref.arg_preview.lstrip("("))
+            if not name:
+                continue
+            for method, route in _resource_routes(name, ref.callee_name == "apiResource"):
+                hints.append(
+                    EntrypointHint(
+                        rule_id="php.laravel.resource",
+                        kind=EntrypointKind.HTTP_ROUTE,
+                        handler_qualified_name=None,
+                        route=route,
+                        http_methods=[method],
+                        framework="laravel",
+                        metadata={"registration": ref.arg_preview},
+                    )
+                )
     return hints
 
 

{entrygraph-0.1.34 → entrygraph-0.1.36}/src/entrygraph/detect/entrypoints/ruby.py

@@ -21,6 +21,13 @@ _SINATRA_VERBS = frozenset({"get", "post", "put", "delete", "patch"})
 _RAILS_VERBS = frozenset({"get", "post", "put", "patch", "delete", "resources", "resource", "root"})
 
 
+def _is_rails_routes_file(path: str) -> bool:
+    """The main `config/routes.rb` plus split route files loaded via `draw(:x)`
+    (`config/routes/api.rb`, `config/routes/admin.rb`, ...). Missing the split
+    files hid most of the route surface on large Rails apps (mastodon/forem)."""
+    return path.endswith("config/routes.rb") or "/config/routes/" in f"/{path}"
+
+
 def _sinatra_routes(x: FileExtraction) -> list[EntrypointHint]:
     hints = []
     for ref in x.references:
@@ -46,7 +53,7 @@ def _sinatra_routes(x: FileExtraction) -> list[EntrypointHint]:
 
 
 def _rails_routes(x: FileExtraction) -> list[EntrypointHint]:
-    if not x.path.endswith("config/routes.rb"):
+    if not _is_rails_routes_file(x.path):
         return []
     hints = []
     for ref in x.references:

{entrygraph-0.1.34 → entrygraph-0.1.36}/tests/test_entrypoint_expansion.py

@@ -402,3 +402,89 @@ def test_nestjs_decorator_routes_with_controller_prefix():
     hints = {h.http_methods[0]: h.route for h in rules["javascript.nestjs.route"].match(x)}
     assert hints["GET"] == "/users/:id"  # controller prefix + method path
     assert hints["POST"] == "/users"
+
+
+def _ruby_ext(references, path):
+    return FileExtraction(
+        path=path,
+        language="ruby",
+        module_path=path.replace("/", ".").removesuffix(".rb"),
+        parse_ok=True,
+        error_count=0,
+        symbols=[],
+        references=list(references),
+    )
+
+
+def _ruby_route_ref(verb, route):
+    return RawReference(
+        kind="call",
+        callee_text=verb,
+        callee_name=verb,
+        receiver_text=None,
+        span=SPAN,
+        caller_qualified_name=None,
+        arg_preview=f"('{route}', to: 'x#y')",
+    )
+
+
+def test_rails_routes_read_from_split_route_files():
+    # Rails apps split routes into config/routes/*.rb loaded via `draw(:api)`; the
+    # rule must read those, not only the top-level config/routes.rb (#37 / F-H22).
+    from entrygraph.detect.entrypoints import rules_for
+
+    rule = {r.id: r for r in rules_for("ruby", {"rails"})}["ruby.rails.routes"]
+    main = rule.match(_ruby_ext([_ruby_route_ref("get", "/health")], "config/routes.rb"))
+    split = rule.match(_ruby_ext([_ruby_route_ref("post", "/users")], "config/routes/api.rb"))
+    unrelated = rule.match(_ruby_ext([_ruby_route_ref("get", "/x")], "app/models/user.rb"))
+    assert [h.route for h in main] == ["/health"]
+    assert [h.route for h in split] == ["/users"]  # the split file is now read
+    assert unrelated == []  # a non-routes file is still ignored
+
+
+def test_laravel_resource_expansion():
+    from entrygraph.detect.entrypoints.php import _resource_routes
+
+    api = _resource_routes("articles", is_api=True)
+    assert set(api) == {
+        ("GET", "/articles"),
+        ("POST", "/articles"),
+        ("GET", "/articles/{article}"),
+        ("PUT", "/articles/{article}"),
+        ("DELETE", "/articles/{article}"),
+    }
+    # resource() adds the HTML create/edit forms that apiResource omits
+    full = dict.fromkeys(r for r in _resource_routes("photos", is_api=False))
+    assert ("GET", "/photos/create") in full
+    assert ("GET", "/photos/{photo}/edit") in full
+    assert len(full) == 7
+    # nested resource: last segment is singularized, dots become path separators
+    nested = _resource_routes("blog.comments", is_api=True)
+    assert ("GET", "/blog/comments/{comment}") in nested
+
+
+def test_laravel_apiresource_rule_emits_rest_routes():
+    from entrygraph.detect.entrypoints import rules_for
+
+    ref = RawReference(
+        kind="call",
+        callee_text="Route::apiResource",
+        callee_name="apiResource",
+        receiver_text="Route",
+        span=SPAN,
+        caller_qualified_name=None,
+        arg_preview="('articles', ArticleController::class)",
+    )
+    x = FileExtraction(
+        path="routes/api.php",
+        language="php",
+        module_path="routes.api",
+        parse_ok=True,
+        error_count=0,
+        symbols=[],
+        references=[ref],
+    )
+    rule = {r.id: r for r in rules_for("php", {"laravel"})}["php.laravel.route"]
+    got = {(h.http_methods[0], h.route) for h in rule.match(x)}
+    assert ("GET", "/articles") in got and ("DELETE", "/articles/{article}") in got
+    assert ("GET", "/articles/create") not in got  # apiResource omits forms