rubydex 0.1.0.beta12-aarch64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cac26cfbab4ecd0c141547cfda39af90b28fbb723274f6499fa3318963a8e60
+  data.tar.gz: 47d8325df6b6797ab0fd3a113f3b94386b9289c929f4d69620851bb98140d8e7
+SHA512:
+  metadata.gz: 233caa506bfa762c33cc0d44ac4fe5c86e851790e5bf519fd1d4eafd57e6b6043e53d9c9f123ee86726a5560356a40e935fab57346b8399cf10e06ba86f808ec
+  data.tar.gz: fcc375aec9c47db0b92944330d47b8a5ebbff4d119c152c39d4cb75081a4e752c55a8d33ee00a3eee2e364d60f47fee3ff79123c192416846f9906bb208bff91

data/LICENSE.txt

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2025-present, Shopify Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+See the generated THIRD_PARTY_LICENSES.html file for third party licenses.

data/README.md

@@ -0,0 +1,125 @@
+# Rubydex
+
+This project is a high performance static analysis toolkit for the Ruby language. The goal is to be a solid
+foundation to power a variety of tools, such as type checkers, linters, language servers and more.
+
+## Usage
+
+Both Ruby and Rust APIs are made available through a gem and a crate, respectively. Here's a simple example
+of using the Ruby API:
+
+```ruby
+# Create a new graph representing the current workspace
+graph = Rubydex::Graph.new
+# Configuring graph LSP encoding
+graph.encoding = "utf16"
+# Index the entire workspace with all dependencies
+graph.index_workspace
+# Or index specific file paths
+graph.index_all(["path/to/file.rb"])
+# Transform the initially collected information into its semantic understanding by running resolution
+graph.resolve
+# Get all diagnostics acquired during the analysis
+graph.diagnostics
+
+# Iterating over graph nodes
+graph.declarations
+graph.documents
+graph.constant_references
+graph.method_references
+
+# Analyzing require paths
+graph.resolve_require_path("rails/engine", load_paths) # => document pointed by `rails/engine`
+graph.require_paths(load_paths) # => array of all indexed require paths
+
+# Querying
+graph["Foo"] # Get declaration by fully qualified name
+graph.search("Foo#b") # Name search
+graph.resolve_constant("Bar", ["Foo", "Baz::Qux"]) # Resolve constant reference based on nesting
+
+# Declarations
+declaration = graph["Foo"]
+
+# All declarations include
+declaration.name
+declaration.unqualified_name
+declaration.definitions
+declaration.owner
+
+# Namespace declarations include
+declaration.member("bar()")
+declaration.member("@ivar")
+declaration.singleton_class
+declaration.ancestors
+declaration.descendants
+
+# Documents
+document = graph.documents.first
+document.uri
+document.definitions # => list of definitions discovered in this document
+
+# Definitions
+definition = declaration.definitions.first
+definition.location
+definition.comments
+definition.name
+definition.deprecated?
+definition.name_location
+
+# Locations
+location = definition.location
+location.path
+
+# Diagnostics
+diagnostic = graph.diagnostics.first
+diagnostic.rule
+diagnostic.message
+diagnostic.location
+```
+
+## MCP Server (Experimental)
+
+Rubydex can run as an MCP (Model Context Protocol) server, enabling AI assistants
+like Claude to semantically query your Ruby codebase.
+
+### Setup
+
+1. Install the binary:
+   ```bash
+   cargo install --path rust/rubydex-mcp
+   ```
+
+2. Add rubydex to the Ruby project you want to index:
+   ```bash
+   claude mcp add --scope project rubydex "\${HOME}/.cargo/bin/rubydex_mcp"
+   ```
+
+   Or manually create a `.mcp.json` in the project root:
+   ```json
+   {
+     "mcpServers": {
+       "rubydex": {
+         "command": "${HOME}/.cargo/bin/rubydex_mcp"
+       }
+     }
+   }
+   ```
+
+3. Start Claude Code from that project directory. The MCP server indexes
+   the project at startup and provides semantic code intelligence tools.
+   Verify with `/mcp` in the session.
+
+### Available MCP Tools
+
+| Tool | Description |
+|------|-------------|
+| `search_declarations` | Fuzzy search for classes, modules, methods, constants |
+| `get_declaration` | Full details by fully qualified name with docs, ancestors, members |
+| `get_descendants` | What classes/modules inherit from or include this one |
+| `find_constant_references` | All precise, resolved constant references across the codebase |
+| `get_file_declarations` | List declarations defined in a specific file |
+| `codebase_stats` | High-level statistics about the indexed codebase |
+
+## Contributing
+
+See [the contributing documentation](CONTRIBUTING.md).