rubydex 0.2.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73a4ef87ec062ac40a438143ac91edf1388543ff336a45bc875582886dc5259b
-  data.tar.gz: 5ba4364ae655fe44edd6897e6c53d95aaff4b970316076f9b538dbd52a6c936b
+  metadata.gz: c097d20f2e7fbb252e1a0a9e802986b51c951caec785d9a8a22e41779928f2ce
+  data.tar.gz: 8d987121c97c13ffcf3258830c612d5447a7c5efd4a572f6a9ce37de3669e881
 SHA512:
-  metadata.gz: c4575cfb038c95e6e86460f5dd832a79224428e05d7f39b9431b50ec4c10029e719862be06acf4fc974a15e210a6a6272de1e5d1193aeb4a0e5a390e7c48d5af
-  data.tar.gz: d44dce9ff4da7f9332ce1c340087a87fc2655c3bc35ba33f76ad78fbe13774973b99c287aca0b92a65492b77b5b7425147144b1edbd0708f6047c19859ef71a7
+  metadata.gz: b978a10b5fe6fe5f76dc916abda86c019bee6b7d36d4b9aa1af4bdb6da88053dc8bceb60d271c559230c16fb2661361bb73f4cbd8dffb4f4fd317b210683c466
+  data.tar.gz: c90b49725da1efb7597eb15855f829e7a897feb3d7be4cfb5c59543b346965e3485c06fb7358620b4c36674a453ccc9c66f7182c959508c21324eba4af14d354

data/README.md

@@ -3,6 +3,8 @@
 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.
 
+[Ruby API Documentation](https://shopify.github.io/rubydex/)
+
 ## Usage
 
 Both Ruby and Rust APIs are made available through a gem and a crate, respectively. Here's a simple example
@@ -73,16 +75,110 @@ location.path
 # Diagnostics
 diagnostic = graph.diagnostics.first
 diagnostic.rule
+diagnostic.rule.default_severity
 diagnostic.message
 diagnostic.location
+diagnostic.related_information
+```
+
+## Ractor Safety
+
+A resolved `Rubydex::Graph` can be shared across Ractors without copying:
+
+```ruby
+graph = Rubydex::Graph.new
+graph.index_workspace
+graph.resolve
+Ractor.make_shareable(graph)
+
+# Worker Ractors can now read the graph in parallel
+ractor = Ractor.new(graph) { |g| g["Foo"]&.name }
+ractor.value
+```
+
+Thread safety comes from an `RwLock` on the Rust side, **not** from Ruby's
+`freeze`. This is a deliberate, but potentially surprising, choice:
+
+- A frozen (or `make_shareable`'d) graph **can still be mutated** — methods like
+  `index_source`, `resolve`, `exclude_patterns`, and `encoding=` work on a frozen
+  graph. This supports interactive use cases (LSP/MCP) that need incremental
+  edits while worker Ractors read concurrently.
+- Because the same underlying allocation is shared, callers are responsible for
+  ordering concurrent writes and reads, as with any shared mutable state across
+  Ractors.
+- Graphs cannot be `dup`'d or `clone`'d; both raise `RuntimeError` to avoid
+  aliasing the Rust allocation (which would double-free on GC) or ballooning
+  memory with a deep copy.
+
+## Tools
+
+All built-in tools are experimental. These tools can change without deprecation warnings.
+
+### `rdx query`
+
+Rubydex exposes the indexed graph through a read-only subset of the
+[Cypher](https://opencypher.org/) query language. Only read clauses (`MATCH`,
+`WHERE`, `RETURN`, ...) are supported; there is no way to mutate the graph.
+
+From the command line:
+
+```bash
+# Run a query against the current workspace
+bundle exec rdx query "MATCH (c:Class)-[:DEFINES]->(m:Method) RETURN c.name, m.name"
+
+# Render results as JSON instead of a table
+bundle exec rdx query "MATCH (c:Class) RETURN c.name" --format json
+
+# Describe the queryable schema (node labels and relationship types) without indexing
+bundle exec rdx query --schema
+```
+
+From Ruby:
+
+```ruby
+graph = Rubydex::Graph.new
+graph.index_workspace
+graph.resolve
+
+# Parse once, then run against a graph. `run` executes the query and returns the result set.
+query = Rubydex::Query.parse("MATCH (c:Class) RETURN c.name")
+result = query.run(graph)
+
+# Read the rows as Ruby objects, or render the same result set as a table or JSON string
+result.rows.each { |row| puts row["c.name"] }
+puts result.render("table")
+puts result.render("json")
+
+# Describe the schema
+puts Rubydex::Query.schema("table")
+```
+
+### `rdx lint`
+
+Put rule files under `rubydex_linter/rules`. Each rule must inherit from `Rubydex::Linter::CustomRule`.
+
+Run the linter:
+
+```bash
+bundle exec rdx lint
 ```
 
-## MCP Server (Experimental)
+Rubydex uses the bundle root, or the current directory when no bundle is available.
+
+Configure a rule in `rubydex.toml`:
+
+```toml
+[linter.rules.<Rule name>]
+enabled = true
+exclude = ["path_to_skip/**"]
+```
+
+### `rdx mcp`
 
 Rubydex can run as an MCP (Model Context Protocol) server, enabling AI assistants
 like Claude to semantically query your Ruby codebase.
 
-### Setup
+#### Setup
 
 1. Add Rubydex to the Ruby project you want to index:
    ```ruby
@@ -94,23 +190,23 @@ like Claude to semantically query your Ruby codebase.
    bundle install
    ```
 
-3. Configure your MCP client to run `bundle exec rdx --mcp`.
+3. Configure your MCP client to run `bundle exec rdx mcp`.
 
    Using Claude Code as an example:
    ```bash
-   claude mcp add --scope project rubydex -- bundle exec rdx --mcp
+   claude mcp add --scope project rubydex -- bundle exec rdx mcp
    ```
 
    Using Codex as an example:
    ```bash
-   codex mcp add rubydex -- bundle exec rdx --mcp
+   codex mcp add rubydex -- bundle exec rdx mcp
    ```
 
    Start your MCP client from that project directory. The MCP server indexes
    the project at startup and provides semantic code intelligence tools through
    the tools below.
 
-### Available MCP Tools
+#### Available MCP Tools
 
 | Tool | Description |
 |------|-------------|
@@ -121,6 +217,14 @@ like Claude to semantically query your Ruby codebase.
 | `get_file_declarations` | List declarations defined in a specific file |
 | `codebase_stats` | High-level statistics about the indexed codebase |
 
+## Skill Library (Experimental)
+
+Rubydex ships with a built in skill library. These skills are referenced by id by Rubydex tools (for example: `send-private-method` maps to `skills/send-private-method/SKILL.md`).
+
+The intention is for Rubydex to provide deterministic skill loading for agents. If a rule returns a skill id, the agent can then fetch the skill with `rdx skill <id>`.
+
+This removes the need for agents to load a large number of possibly unrelated skill descriptions when they may or may not be necessary. The information only surfaces if there is a verified violation to fix, and it only needs to be loaded once, rather than inlining it on every violation in every run of the tool (the common pattern for linters and analyzers).
+
 ## Contributing
 
 See [the contributing documentation](CONTRIBUTING.md).

data/THIRD_PARTY_LICENSES.html

@@ -50,9 +50,9 @@
 
         <h2>Overview of licenses:</h2>
         <ul class="licenses-overview">
-            <li><a href="#Apache-2.0">Apache License 2.0</a> (116)</li>
+            <li><a href="#Apache-2.0">Apache License 2.0</a> (119)</li>
             <li><a href="#Unicode-3.0">Unicode License v3</a> (19)</li>
-            <li><a href="#MIT">MIT License</a> (16)</li>
+            <li><a href="#MIT">MIT License</a> (17)</li>
             <li><a href="#BSD-2-Clause">BSD 2-Clause &quot;Simplified&quot; License</a> (2)</li>
             <li><a href="#BSD-3-Clause">BSD 3-Clause &quot;New&quot; or &quot;Revised&quot; License</a> (1)</li>
             <li><a href="#BSL-1.0">Boost Software License 1.0</a> (1)</li>
@@ -277,6 +277,242 @@
    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.
+</pre>
+            </li>
+            <li class="license">
+                <h3 id="Apache-2.0">Apache License 2.0</h3>
+                <h4>Used by:</h4>
+                <ul class="license-used-by">
+                    <li><a
+                            href=" https://github.com/sunfishcode/linux-raw-sys ">linux-raw-sys
+                            0.9.4</a></li>
+                    <li><a
+                            href=" https://github.com/bytecodealliance/rustix ">rustix
+                            1.0.8</a></li>
+                    <li><a
+                            href=" https://github.com/bytecodealliance/wasi-rs ">wasi
+                            0.14.2+wasi-0.2.4</a></li>
+                </ul>
+                <pre class="license-text">
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      &quot;License&quot; shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      &quot;Licensor&quot; shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      &quot;Legal Entity&quot; 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,
+      &quot;control&quot; 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.
+
+      &quot;You&quot; (or &quot;Your&quot;) shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      &quot;Source&quot; form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      &quot;Object&quot; 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.
+
+      &quot;Work&quot; 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).
+
+      &quot;Derivative Works&quot; 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.
+
+      &quot;Contribution&quot; 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, &quot;submitted&quot;
+      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 &quot;Not a Contribution.&quot;
+
+      &quot;Contributor&quot; 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 &quot;NOTICE&quot; 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 &quot;AS IS&quot; 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 &quot;[]&quot;
+      replaced with your own identifying information. (Don&#x27;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 &quot;printed page&quot; 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 &quot;License&quot;);
+   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 &quot;AS IS&quot; 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.
+
+
+--- LLVM Exceptions to the Apache 2.0 License ----
+
+As an exception, if, as a result of your compiling your source code, portions
+of this Software are embedded into an Object form of such source code, you
+may redistribute such embedded portions in such Object form without complying
+with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
+
+In addition, if you combine or link compiled forms of this Software with
+software that is licensed under the GPLv2 (&quot;Combined Software&quot;) and if a
+court of competent jurisdiction determines that the patent provision (Section
+3), the indemnity provision (Section 9) or other Section of the License
+conflicts with the conditions of the GPLv2, you may retroactively and
+prospectively choose to deem waived or otherwise exclude such Section(s) of
+the License, but only in their entirety and only with respect to the Combined
+Software.
+
 </pre>
             </li>
             <li class="license">
@@ -2802,6 +3038,39 @@ 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.
+</pre>
+            </li>
+            <li class="license">
+                <h3 id="MIT">MIT License</h3>
+                <h4>Used by:</h4>
+                <ul class="license-used-by">
+                    <li><a
+                            href=" https://github.com/Shopify/cypher-parser ">cypher-parser
+                            0.8.1</a></li>
+                </ul>
+                <pre class="license-text">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 &quot;Software&quot;), 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 &quot;AS IS&quot;, 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.
 </pre>
             </li>
             <li class="license">

data/exe/rdx

@@ -3,77 +3,6 @@
 
 $LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
 
-require "optparse"
+require "rubydex/cli"
 
-options = {}
-
-option_parser = OptionParser.new do |parser|
-  parser.on("--version", "Print the gem's version") do
-    require "rubydex/version"
-    puts "v#{Rubydex::VERSION}"
-    exit
-  end
-
-  parser.on("-h", "--help", "Prints this help") do
-    puts parser
-    exit
-  end
-
-  parser.on("-i", "--interactive", "Open an interactive session with a populated graph for the current workspace") do
-    options[:interactive] = true
-  end
-
-  parser.on("--mcp", "Run the MCP server for AI assistants") do
-    options[:mcp] = true
-  end
-end
-
-begin
-  arguments = option_parser.parse(ARGV)
-rescue OptionParser::ParseError => e
-  warn("error: #{e.message}")
-  warn
-  warn(option_parser)
-  exit(2)
-end
-
-require "rubydex"
-
-if options[:mcp]
-  if arguments.length > 1
-    warn("error: unexpected argument '#{arguments[1]}' found")
-    warn
-    warn(option_parser)
-    exit(2)
-  end
-
-  require "rubydex/mcp_server"
-  Rubydex::MCPServer.run(arguments.fetch(0, Dir.pwd))
-  exit
-end
-
-def __with_timer(message, &block)
-  print(message)
-  start = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond)
-  block.call
-  duration = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond) - start
-  puts " finished in #{duration.round(2)}ms"
-end
-
-graph = Rubydex::Graph.new
-graph.load_config
-
-__with_timer("Indexing workspace...") { graph.index_workspace }
-__with_timer("Resolving graph...") { graph.resolve }
-
-if options[:interactive]
-  begin
-    require "irb"
-    IRB.setup(nil)
-    IRB.conf[:IRB_NAME] = "rubydex"
-    workspace = IRB::WorkSpace.new(binding)
-    IRB::Irb.new(workspace).run(IRB.conf)
-  rescue LoadError
-    abort("Interactive mode requires `irb` to be in the bundle")
-  end
-end
+Rubydex::CLI.start