Skip to main content

Ruby indexer plugin for CodeMap

Project description

codemap-ruby

A Ruby indexer for CodeMap, shipped as an independent PyPI package.

What it captures

Backed by tree-sitter-ruby:

AST node Symbol kind
class class (with extra.ruby_kind=class)
module class (with extra.ruby_kind=module)
method (inside class/module) method
method (top level) function
singleton_method method (with extra.ruby_kind=singleton)
top-level constant assignment variable
constant assignment inside class/module field

Nested class / module declarations are tracked with a class stack: module A; class B; def m; end; end; end produces A#B#m().

Install

pip install codemap-ruby

SymbolID encoding

scip-ruby . . . app/models/user.rb/User#hello().

Limits

  • attr_accessor / attr_reader / attr_writer macros are not expanded into individual field symbols.
  • define_method, class_eval, and other metaprogramming are not resolved.
  • Mixin (include/extend) edges are not yet emitted.

License

MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codemap_ruby-0.3.1.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codemap_ruby-0.3.1-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file codemap_ruby-0.3.1.tar.gz.

File metadata

  • Download URL: codemap_ruby-0.3.1.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for codemap_ruby-0.3.1.tar.gz
Algorithm Hash digest
SHA256 f3b8359b0a441faf2b5c5baedf56e4179c5c5326c74d26fb60e8fc7e1f1cd726
MD5 f1fb49bfd213dac16c7f0c7c9e94dd95
BLAKE2b-256 e19990173f465d9523034b1df236b89a9c533358aee43d71be81b8decce66654

See more details on using hashes here.

Provenance

The following attestation bundles were made for codemap_ruby-0.3.1.tar.gz:

Publisher: publish.yml on qxbyte/codemap

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file codemap_ruby-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: codemap_ruby-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for codemap_ruby-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 82cf30a27260ed8c05e21922ccc046fbf06825b370dcacb4146aa5b01335f210
MD5 359df4f173c86684795323d265d7e39b
BLAKE2b-256 f522d12d87b9fcf0cef7f96e26c77da42c5dc6eb815ac043663a883a6cbe7f97

See more details on using hashes here.

Provenance

The following attestation bundles were made for codemap_ruby-0.3.1-py3-none-any.whl:

Publisher: publish.yml on qxbyte/codemap

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page