rust-analyzer-db 0.2.0__tar.gz

rust_analyzer_db-0.2.0/.github/workflows/workflow.yml

@@ -0,0 +1,45 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write  # Required for PyPI trusted publishing
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

rust_analyzer_db-0.2.0/.gitignore

@@ -0,0 +1,12 @@
+.venv/
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+*.db
+.code-review-graph/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/

rust_analyzer_db-0.2.0/AGENTS.md

@@ -0,0 +1,38 @@
+<!-- code-review-graph MCP tools -->
+## MCP Tools: code-review-graph
+
+**IMPORTANT: This project has a knowledge graph. ALWAYS use the
+code-review-graph MCP tools BEFORE using Grep/Glob/Read to explore
+the codebase.** The graph is faster, cheaper (fewer tokens), and gives
+you structural context (callers, dependents, test coverage) that file
+scanning cannot.
+
+### When to use graph tools FIRST
+
+- **Exploring code**: `semantic_search_nodes_tool` or `query_graph_tool` instead of Grep
+- **Understanding impact**: `get_impact_radius_tool` instead of manually tracing imports
+- **Code review**: `detect_changes_tool` + `get_review_context_tool` instead of reading entire files
+- **Finding relationships**: `query_graph_tool` with callers_of/callees_of/imports_of/tests_for
+- **Architecture questions**: `get_architecture_overview_tool` + `list_communities_tool`
+
+Fall back to Grep/Glob/Read **only** when the graph doesn't cover what you need.
+
+### Key Tools
+
+| Tool | Use when |
+| ------ | ---------- |
+| `detect_changes_tool` | Reviewing code changes — gives risk-scored analysis |
+| `get_review_context_tool` | Need source snippets for review — token-efficient |
+| `get_impact_radius_tool` | Understanding blast radius of a change |
+| `get_affected_flows_tool` | Finding which execution paths are impacted |
+| `query_graph_tool` | Tracing callers, callees, imports, tests, dependencies |
+| `semantic_search_nodes_tool` | Finding functions/classes by name or keyword |
+| `get_architecture_overview_tool` | Understanding high-level codebase structure |
+| `refactor_tool` | Planning renames, finding dead code |
+
+### Workflow
+
+1. The graph auto-updates on file changes (via hooks).
+2. Use `detect_changes_tool` for code review.
+3. Use `get_affected_flows_tool` to understand impact.
+4. Use `query_graph_tool` pattern="tests_for" to check coverage.

rust_analyzer_db-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

rust_analyzer_db-0.2.0/PKG-INFO

@@ -0,0 +1,302 @@
+Metadata-Version: 2.4
+Name: rust-analyzer-db
+Version: 0.2.0
+Summary: Professional Rust code analysis tool using tree-sitter — extracts, indexes, and analyzes Rust source code with call graphs, complexity metrics, and dependency tracking.
+Project-URL: Repository, https://github.com/jihoo12/rustanalyser
+Author: codeanalyser
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: analysis,call-graph,code-analysis,rust,tree-sitter
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Compilers
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: fastapi>=0.100
+Requires-Dist: jinja2>=3.1
+Requires-Dist: mcp<2,>=1.0
+Requires-Dist: python-multipart>=0.0.6
+Requires-Dist: tree-sitter-rust>=0.24
+Requires-Dist: tree-sitter>=0.23
+Requires-Dist: uvicorn>=0.23
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# rust-analyzer-db
+
+A professional Python tool that uses **tree-sitter** to parse Rust source code,
+extracts code entities, computes static metrics, and stores everything in a
+**SQLite** database for query, search, call-graph analysis, and reporting.
+
+## Features
+
+- **Full extraction**: structs, enums, traits, impls, functions/methods, consts,
+  statics, mods, macros, type aliases, unions, `use` declarations, `extern crate`
+- **Static metrics**: cyclomatic complexity, cognitive complexity, nesting depth,
+  branch count, lines of code per function
+- **Generic parameters & lifetimes**: extracted from structs, functions, impls
+- **Call graph**: whole-project or focused subgraph with Graphviz DOT/SVG/PNG/HTML
+  rendering and interactive vis-network visualization
+- **Public API surface**: identify all public items in a project
+- **Dependency tracking**: `use` declarations and `extern crate` declarations
+- **Complexity report**: find the most complex functions in your codebase
+- **Full-text search**: SQLite FTS5 over name, signature, doc, and source
+- **JSON output**: all commands support `--json` for machine-readable output
+- **Incremental scanning**: unchanged files skipped by content hash
+- **Structured logging**: configurable verbosity and format
+- **Web frontend**: master-panel dashboard with interactive call graph, complexity
+  report, API surface, dependency analysis, and search
+- **MCP server**: expose all analysis tools via Model Context Protocol for
+  AI assistants (Claude Code, Claude Desktop, etc.)
+
+## Install
+
+```bash
+pip install -e ".[dev]"
+```
+
+Or with just dependencies:
+
+```bash
+pip install tree-sitter tree-sitter-rust fastapi uvicorn jinja2 python-multipart "mcp>=1.0,<2"
+```
+
+Python 3.10+ required.
+
+## Usage
+
+### 1. Scan a project
+
+```bash
+rust-analyzer-db scan /path/to/rust/project --db rust_code.db
+```
+
+- Recursively finds all `*.rs` files (skips `target/`, `.git/`, `node_modules/`)
+- Works on a single file: `rust-analyzer-db scan src/lib.rs`
+- Re-running is **incremental** (unchanged files skipped)
+- Use `--force` to re-parse everything, `-q` to suppress progress
+
+### 2. List items
+
+```bash
+rust-analyzer-db list --kind struct --db rust_code.db
+rust-analyzer-db list --kind function --name parse --db rust_code.db
+rust-analyzer-db list --json --db rust_code.db
+```
+
+### 3. Show full source
+
+```bash
+rust-analyzer-db show new --db rust_code.db --kind method
+```
+
+### 4. List methods on a type
+
+```bash
+rust-analyzer-db methods Point --db rust_code.db --full
+```
+
+### 5. Full-text search
+
+```bash
+rust-analyzer-db search "distance" --db rust_code.db
+rust-analyzer-db search "parse OR tokenize" --db rust_code.db --full
+```
+
+### 6. Project statistics
+
+```bash
+rust-analyzer-db stats --db rust_code.db
+rust-analyzer-db stats --json --db rust_code.db
+```
+
+### 7. Complexity report
+
+```bash
+rust-analyzer-db complexity --db rust_code.db
+rust-analyzer-db complexity --min 10 --db rust_code.db
+```
+
+Shows cyclomatic complexity, cognitive complexity, nesting depth, and LOC
+for every function/method above the threshold.
+
+### 8. Public API surface
+
+```bash
+rust-analyzer-db api --db rust_code.db
+rust-analyzer-db api --json --db rust_code.db
+```
+
+Lists all `pub` items grouped by kind.
+
+### 9. Dependency analysis
+
+```bash
+rust-analyzer-db deps --db rust_code.db
+rust-analyzer-db deps --full --db rust_code.db  # show all use paths
+```
+
+### 10. Call graph
+
+```bash
+# Whole project
+rust-analyzer-db graph --db rust_code.db -o callgraph.svg
+
+# Focused on one function
+rust-analyzer-db graph --db rust_code.db --root run_demo --depth 3 -o run_demo.svg
+
+# JSON output
+rust-analyzer-db graph --db rust_code.db --json
+```
+
+Flags: `--direction callees|callers|both`, `--no-unresolved`,
+`--format svg|png|pdf|dot|html`.
+
+### 11. Web frontend
+
+```bash
+# Start the web UI (default: http://localhost:8000)
+rust-analyzer-db serve --db rust_code.db
+
+# Custom host/port
+rust-analyzer-db serve --db rust_code.db --host 0.0.0.0 --port 8080
+```
+
+The web frontend provides a master-panel style dashboard with:
+
+- **Dashboard** — project stats, top complex functions, item kind distribution,
+  complexity histogram, largest files
+- **Items** — filterable/sortable/paginated browser for all extracted code
+  entities, with source view modals
+- **Complexity** — ranked complexity report with adjustable threshold and
+  progress-bar indicators
+- **Call graph** — interactive vis-network visualization with root/depth/direction
+  controls
+- **API surface** — public items grouped by kind
+- **Dependencies** — extern crates and `use` declaration tree
+- **Search** — full-text search across names, signatures, docs, and source
+
+All pages also expose JSON endpoints at `/api/stats`, `/api/item/{id}`,
+and `/api/graph-data`.
+
+### 12. MCP server (Model Context Protocol)
+
+```bash
+# Start the MCP server over stdio (for AI assistants)
+rust-analyzer-db mcp --db rust_code.db
+```
+
+Exposes Rust code analysis as **MCP tools** that AI assistants can call
+via the [Model Context Protocol](https://modelcontextprotocol.io).
+
+**Available tools:**
+
+| Tool | Description |
+|------|-------------|
+| `scan_project` | Scan a Rust directory/file into the database |
+| `list_items` | List code items with filters (kind, name, target, file) |
+| `get_item` | Get full source and metadata for an item by ID |
+| `search_code` | Full-text search across names, signatures, docs, source |
+| `get_stats` | Project statistics (files, items, call edges) |
+| `complexity_report` | Find complex functions above a threshold |
+| `api_surface` | List all public API items |
+| `dependencies` | Show extern crates and use declarations |
+| `call_graph_info` | Trace callers/callees for a function, or project stats |
+| `methods_of` | List methods on a type or trait |
+
+**Register with Claude Code:**
+
+```bash
+claude mcp add rust-analyzer-db -- rust-analyzer-db mcp --db /path/to/rust_code.db
+```
+
+**Register with Claude Desktop** — add to `claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "rust-analyzer-db": {
+      "command": "rust-analyzer-db",
+      "args": ["mcp", "--db", "/path/to/rust_code.db"]
+    }
+  }
+}
+```
+
+## What gets captured per item
+
+- `kind`, `name`, `visibility`, `target`, `trait_name`
+- `signature` (functions/methods, without body)
+- `doc` (doc comments), `attributes` (`#[derive(...)]` etc.)
+- `start_line` / `end_line`, `file_path`
+- `source` — exact original source text
+- `is_pub`, `is_const_fn`, `is_async`, `is_unsafe`
+- `cyclomatic_complexity`, `cognitive_complexity`, `nesting_depth`,
+  `num_branches`, `num_function_calls`, `lines_of_code`
+- Generic parameters and lifetime parameters
+- Methods linked to parent impl/trait via `parent_id`
+
+## Database schema
+
+Two main tables (`files`, `items`) plus `calls`, `use_declarations`,
+`extern_crates`, `generic_params`, `lifetime_params`, and `items_fts`
+(FTS5 index). See `rust_analyzer/db.py` for the full schema.
+
+Query directly:
+
+```bash
+sqlite3 rust_code.db "SELECT kind, name, cyclomatic_complexity FROM items WHERE cyclomatic_complexity > 5;"
+```
+
+## Development
+
+```bash
+# Install dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest tests/ -v
+
+# Type checking
+mypy rust_analyzer/
+
+# Linting
+ruff check rust_analyzer/
+```
+
+## Architecture
+
+```
+rust_analyzer/
+  __init__.py       - Package version
+  cli.py            - CLI commands and argument parsing
+  db.py             - SQLite storage layer (schema + queries)
+  extractor.py      - tree-sitter extraction + metrics
+  graph.py          - Call graph construction + rendering
+  web.py            - FastAPI web frontend + JSON API
+  mcp_server.py     - MCP server (Model Context Protocol tools)
+  exceptions.py     - Exception hierarchy
+  logging.py        - Structured logging configuration
+  static/
+    style.css       - Dark master-panel theme
+  templates/
+    base.html       - Shared layout with sidebar navigation
+    dashboard.html  - Stats cards + charts
+    items.html      - Filterable item browser
+    complexity.html - Complexity report
+    graph.html      - Interactive vis-network call graph
+    api_surface.html - Public API grouped by kind
+    deps.html       - Dependencies tree
+    search.html     - Full-text search
+```