rubydex 0.0.1 → 0.1.0.beta1

data/exe/rdx

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+require "optparse"
+
+OptionParser.new do |parser|
+  parser.banner = "Usage: [path1, path2]"
+
+  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
+end.parse!
+
+require "rubydex"
+
+workspace_path = ARGV.first
+
+# If a workspace path is passed, we need to ensure that Bundler is setup in that context so that we find the
+# dependencies for that project
+if workspace_path
+  gemfile_path = File.join(workspace_path, "Gemfile")
+
+  if File.exist?(gemfile_path)
+    ENV["BUNDLE_GEMFILE"] = gemfile_path
+
+    begin
+      Bundler.setup
+    rescue Bundler::BundlerError => e
+      $stderr.puts(<<~MESSAGE)
+        Bundle setup failed for #{gemfile_path}. Indexing of dependencies may be partial
+        Error:
+          #{e.message}
+      MESSAGE
+    end
+  end
+end
+
+graph = Rubydex::Graph.new(workspace_path: workspace_path)
+graph.index_workspace

data/ext/rubydex/extconf.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "mkmf"
+require "pathname"
+
+release = ENV["RELEASE"]
+gem_dir = Pathname.new("../..").expand_path(__dir__)
+root_dir = gem_dir.join("rust")
+target_dir = root_dir.join("target")
+target_dir = target_dir.join("x86_64-pc-windows-gnu") if Gem.win_platform?
+target_dir = target_dir.join(release ? "release" : "debug")
+
+bindings_path = root_dir.join("rubydex-sys").join("rustbindings.h")
+
+cargo_args = ["--manifest-path #{root_dir.join("Cargo.toml")}"]
+cargo_args << "--release" if release
+
+if Gem.win_platform?
+  cargo_args << "--target x86_64-pc-windows-gnu"
+  ENV["RUSTFLAGS"] = "-C target-feature=+crt-static"
+end
+
+append_cflags("-Werror=unused-but-set-variable")
+append_cflags("-Werror=implicit-function-declaration")
+
+if Gem.win_platform?
+  $LDFLAGS << " #{target_dir.join("librubydex_sys.a")}"
+
+  # On Windows, statically link system libraries to avoid having to distribute and load DLLs
+  #
+  # These libraries are the ones informed by `cargo rustc -- --print native-static-libs`, which displays the
+  # libraries necessary for statically linking the Rust code on the current platform
+  ["kernel32", "ntdll", "userenv", "ws2_32", "dbghelp", "msvcrt"].each do |lib|
+    $LDFLAGS << " -l#{lib}"
+  end
+else
+  append_ldflags("-Wl,-rpath,#{target_dir}")
+  # We cannot use append_ldflags here because the Rust code is only compiled later. If it's not compiled yet, this will
+  # fail and the flag will not be added
+  $LDFLAGS << " -L#{target_dir} -lrubydex_sys"
+end
+
+create_makefile("rubydex/rubydex")
+
+cargo_command = if ENV["SANITIZER"]
+  ENV["RUSTFLAGS"] = "-Zsanitizer=#{ENV["SANITIZER"]}"
+  "cargo +nightly build -Zbuild-std #{cargo_args.join(" ")}".strip
+else
+  "cargo build #{cargo_args.join(" ")}".strip
+end
+
+rust_srcs = Dir.glob("#{root_dir}/**/*.rs")
+
+makefile = File.read("Makefile")
+new_makefile = makefile.gsub("$(OBJS): $(HDRS) $(ruby_headers)", <<~MAKEFILE.chomp)
+  .PHONY: compile_rust
+  RUST_SRCS = #{File.expand_path("Cargo.toml", root_dir)} #{File.expand_path("Cargo.lock", root_dir)} #{rust_srcs.join(" ")}
+
+  .rust_built: $(RUST_SRCS)
+  \t#{cargo_command} || (echo "Compiling Rust failed" && exit 1)
+  \t$(COPY) #{bindings_path} #{__dir__}
+  \ttouch $@
+
+  compile_rust: .rust_built
+
+  $(OBJS): $(HDRS) $(ruby_headers) .rust_built
+MAKEFILE
+
+new_makefile.gsub!("$(Q) $(POSTLINK)", <<~MAKEFILE.chomp)
+  $(Q) $(POSTLINK)
+  \t$(Q)$(RM) .rust_built
+MAKEFILE
+
+# Bundle all dependency licenses when building a release version of the gem
+if release
+  unless system("cargo about --version > /dev/null 2>&1")
+    abort <<~MESSAGE
+      ERROR: cargo-about is not installed and required to build the release version of the gem.
+      Please install it by running:
+        cargo install cargo-about
+    MESSAGE
+  end
+
+  licenses_file = root_dir.join("THIRD_PARTY_LICENSES.html")
+  about_config = root_dir.join("about.toml")
+  about_template = root_dir.join("about.hbs")
+
+  new_makefile.gsub!(".rust_built: $(RUST_SRCS)", <<~MAKEFILE.chomp)
+    #{licenses_file}: #{about_config} #{about_template}
+    \t$(Q)$(RM) #{licenses_file}
+    \tcargo about generate #{about_template} --manifest-path #{root_dir.join("Cargo.toml")} --workspace > #{licenses_file}
+    \t$(COPY) #{licenses_file} #{gem_dir}
+
+    .rust_built: $(RUST_SRCS) #{licenses_file}
+  MAKEFILE
+end
+
+File.write("Makefile", new_makefile)
+
+begin
+  require "extconf_compile_commands_json"
+
+  ExtconfCompileCommandsJson.generate!
+  ExtconfCompileCommandsJson.symlink!
+rescue LoadError # rubocop:disable Lint/SuppressedException
+end

data/lib/rubydex/comment.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Rubydex
+  class Comment
+    #: String
+    attr_reader :string
+
+    #: Location
+    attr_reader :location
+
+    #: (?string: String, ?location: Location) -> void
+    def initialize(string:, location:)
+      @string = string
+      @location = location
+    end
+  end
+end

data/lib/rubydex/diagnostic.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Rubydex
+  class Diagnostic
+    #: Symbol
+    attr_reader :rule
+
+    #: String
+    attr_reader :message
+
+    #: Location
+    attr_reader :location
+
+    #: (rule: Symbol, message: String, location: Location) -> void
+    def initialize(rule:, message:, location:)
+      @rule = rule
+      @message = message
+      @location = location
+    end
+  end
+end

data/lib/rubydex/graph.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Rubydex
+  # The global graph representing all declarations and their relationships for the workspace
+  #
+  # Note: this class is partially defined in C to integrate with the Rust backend
+  class Graph
+    #: (?workspace_path: String) -> void
+    def initialize(workspace_path: Dir.pwd)
+      @workspace_path = workspace_path
+    end
+
+    # Index all files and dependencies of the workspace that exists in `@workspace_path`
+    #: -> String?
+    def index_workspace
+      paths = Dir.glob("#{@workspace_path}/**/*.rb")
+      paths.concat(
+        workspace_dependency_paths.flat_map do |path|
+          Dir.glob("#{path}/**/*.rb")
+        end,
+      )
+      index_all(paths)
+    end
+
+    private
+
+    # Gathers the paths we have to index for all workspace dependencies
+    def workspace_dependency_paths
+      specs = Bundler.locked_gems&.specs
+      return [] unless specs
+
+      paths = specs.filter_map do |lazy_spec|
+        spec = Gem::Specification.find_by_name(lazy_spec.name)
+        spec.require_paths.map { |path| File.join(spec.full_gem_path, path) }
+      rescue Gem::MissingSpecError
+        nil
+      end
+
+      paths.flatten!
+      paths.uniq!
+      paths
+    end
+  end
+end

data/lib/rubydex/location.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Rubydex
+  class Location
+    include Comparable
+
+    #: String
+    attr_reader :uri
+
+    #: Integer
+    attr_reader :start_line, :end_line, :start_column, :end_column
+
+    #: (?uri: String, ?start_line: Integer, ?end_line: Integer, ?start_column: Integer, ?end_column: Integer) -> void
+    def initialize(uri:, start_line:, end_line:, start_column:, end_column:)
+      @uri = uri
+      @start_line = start_line
+      @end_line = end_line
+      @start_column = start_column
+      @end_column = end_column
+    end
+
+    #: () -> String
+    def path
+      uri = URI(@uri)
+      raise Rubydex::Error, "URI is not a file:// URI: #{@uri}" unless uri.scheme == "file"
+
+      path = uri.path
+      # TODO: This has to go away once we have a proper URI abstraction
+      path.delete_prefix!("/") if Gem.win_platform?
+      path
+    end
+
+    #: (other: BasicObject) -> Integer
+    def <=>(other)
+      return -1 unless other.is_a?(Location)
+
+      a = [@uri, @start_line, @start_column, @end_line, @end_column]
+      b = [other.uri, other.start_line, other.start_column, other.end_line, other.end_column]
+      a <=> b
+    end
+
+    #: -> String
+    def to_s
+      "#{path}:#{@start_line}:#{@start_column}-#{@end_line}:#{@end_column}"
+    end
+  end
+end

data/lib/rubydex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubydex
-  VERSION = "0.0.1"
+  VERSION = "0.1.0.beta1"
 end

data/lib/rubydex.rb

@@ -1,8 +1,24 @@
 # frozen_string_literal: true
 
-require_relative "rubydex/version"
+require "bundler"
+require "uri"
 
 module Rubydex
   class Error < StandardError; end
-  # Your code goes here...
 end
+
+require "rubydex/version"
+
+begin
+  # Load the precompiled version of the library
+  ruby_version = /(\d+\.\d+)/.match(RUBY_VERSION)
+  require "rubydex/#{ruby_version}/rubydex"
+rescue LoadError
+  # It's important to leave for users that can not or don't want to use the gem with precompiled binaries.
+  require "rubydex/rubydex"
+end
+
+require "rubydex/location"
+require "rubydex/comment"
+require "rubydex/diagnostic"
+require "rubydex/graph"

metadata

@@ -1,35 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: rubydex
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0.beta1
 platform: ruby
 authors:
-- Ufuk Kayserilioglu
+- Shopify
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-01-21 00:00:00.000000000 Z
 dependencies: []
-description: A rolodex for Ruby
+description: A high performance static analysis suite for Ruby, built in Rust with
+  Ruby APIs
 email:
-- ufuk@paralaus.com
-executables: []
-extensions: []
+- ruby@shopify.com
+executables:
+- rdx
+extensions:
+- ext/rubydex/extconf.rb
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
-- CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
-- Rakefile
+- THIRD_PARTY_LICENSES.html
+- exe/rdx
+- ext/rubydex/extconf.rb
 - lib/rubydex.rb
+- lib/rubydex/comment.rb
+- lib/rubydex/diagnostic.rb
+- lib/rubydex/graph.rb
+- lib/rubydex/location.rb
 - lib/rubydex/version.rb
-- sig/rubydex.rbs
-homepage: https://github.com/paracycle/rubydex
+homepage: https://github.com/Shopify/rubydex
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/paracycle/rubydex
+  homepage_uri: https://github.com/Shopify/rubydex
+  source_code_uri: https://github.com/Shopify/rubydex
+  changelog_uri: https://github.com/Shopify/rubydex/releases
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -37,14 +47,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.3.11
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.4.19
+signing_key: 
 specification_version: 4
-summary: A rolodex for Ruby
+summary: A high performance static analysis suite for Ruby
 test_files: []

data/.rubocop.yml

@@ -1,8 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.1
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes

data/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official email address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "minitest/test_task"
-
-Minitest::TestTask.create
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]

data/sig/rubydex.rbs

@@ -1,4 +0,0 @@
-module Rubydex
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end