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 "git+https://github.com/qxbyte/codemap.git#subdirectory=plugins/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.1.0a1.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.1.0a1-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file codemap_ruby-0.1.0a1.tar.gz.

File metadata

  • Download URL: codemap_ruby-0.1.0a1.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for codemap_ruby-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 4c2ce2c70870425c36d2556338df93ec0b5f4a92eef33b99ca99ae12c67465b5
MD5 4ff21f892d293152e9c11b7cfe84755d
BLAKE2b-256 5bf70c4fec2c23dcda71ffb0527a8d11e998d25cde471e7ca7b4ccf049a8bbe3

See more details on using hashes here.

File details

Details for the file codemap_ruby-0.1.0a1-py3-none-any.whl.

File metadata

  • Download URL: codemap_ruby-0.1.0a1-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for codemap_ruby-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 d69fe5c3b86bb84f2f084ac4c4c3ac51129f5a040d4e712e5644e7d53ffc689c
MD5 edb349d552659e960711abd84c13fce5
BLAKE2b-256 9886df865b92b158cbceacb42906faab758f6bd0e1ceb9648ee9e4ae77aec1d3

See more details on using hashes here.

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