racer-rb 0.1.0

data/lib/racer/rails/railtie.rb

@@ -0,0 +1,38 @@
+module Racer
+  class Railtie < Rails::Railtie
+    initializer "racer.extend_active_support_test_case" do
+      ActiveSupport.on_load(:active_support_test_case) do
+        if defined?(Racer::MinitestPlugin)
+          parallelize_teardown do
+            Racer.flush
+          end
+
+          at_exit do
+            Racer.flush
+          end
+
+          setup do
+            Racer.start(path_regex: %r(\A#{Rails.root.to_s}/(app|lib|test|spec)/), max_generic_depth: 3)
+          end
+
+          teardown do
+            Racer.stop
+          end
+        end
+      end
+    end
+
+    config.before_initialize do
+      if defined?(Racer::MinitestPlugin) || defined?(Racer::RSpecPlugin)
+        Racer.start(path_regex: %r(\A#{Rails.root.to_s}/(app|lib|test|spec)/), max_generic_depth: 3)
+      end
+    end
+
+    config.after_initialize do
+      if defined?(Racer::MinitestPlugin) || defined?(Racer::RSpecPlugin)
+        Racer.stop
+        Racer.flush
+      end
+    end
+  end
+end

data/lib/racer/rb.rb

@@ -0,0 +1,2 @@
+# Entrypoint required by bundler because the gem is called "racer-rb"
+require "racer"

data/lib/racer/rspec.rb

@@ -0,0 +1,19 @@
+# This ensures that racer can inject it's railtie even if rails was not fully required yet
+#
+# This happens if running a test with a path argument because the test:prepare task is not being executed and rails did not fully initialize
+# when requiring racer/minitest.
+#
+# If no path argument was passed the rails:prepare rake task is being executed. In this case racer is being required during the rails boot process
+# and installs the railtie accordingly.
+begin
+  require "rails"
+rescue LoadError
+  # no-op rails not available
+end
+
+require "racer"
+require_relative "rspec_plugin"
+
+Racer::RSpecPlugin.agent_pid = Racer.start_agent(stop_at_exit: false, collectors: [Racer::Collectors::RBSCollector.new(libraries: ["json", "minitest", "tempfile", "base64", "pathname", "logger", "uri", "erb", "date", "ipaddr", "securerandom"])])
+
+puts "Agent started with pid #{Racer::RSpecPlugin.agent_pid}"

data/lib/racer/rspec_plugin.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Racer
+  class RSpecPlugin
+    class << self
+      attr_accessor :agent_pid
+
+      def configure(config)
+        at_exit do
+          Racer.flush
+        end
+
+        config.before do
+          Racer.start(path_regex: %r(\A#{Rails.root.to_s}/(app|lib|test|spec)/), max_generic_depth: 3)
+        end
+
+        config.after do
+          Racer.stop
+        end
+
+        config.after(:suite) do
+          Racer.flush
+          Racer.stop_agent(Racer::RSpecPlugin.agent_pid)
+        end
+      end
+    end
+  end
+end

data/lib/racer/trace.rb

@@ -0,0 +1,121 @@
+class Racer::Trace
+  attr_reader :method_owner, :method_callee, :method_name, :method_kind, :method_visibility, :return_type, :params, :block_param, :constant_updates
+
+  KINDS = [
+    :instance,
+    :singleton
+  ].freeze
+
+  VISIBILITIES = [
+    :public,
+    :private,
+    :protected
+  ].freeze
+
+  def initialize(method_owner:, method_callee:, method_name:, method_kind:, method_visibility:, return_type:, params:, constant_updates: [], block_param: nil)
+    @method_owner = method_owner
+    @method_callee = method_callee
+    @method_name = method_name
+    @method_kind = method_kind
+    @method_visibility = method_visibility
+    @return_type = return_type
+    @params = params
+    @block_param = block_param
+    @constant_updates = constant_updates
+  end
+
+  class Constant
+    attr_reader :name, :anonymous, :type, :superclass, :included_modules, :prepended_modules, :extended_modules
+
+    TYPES = [
+      :module,
+      :class
+    ].freeze
+
+    def initialize(name:, anonymous:, type:, superclass: nil, included_modules: [], prepended_modules: [], extended_modules: [])
+      @name = name
+      @anonymous = anonymous
+      @type = type
+      @superclass = superclass
+      @included_modules = included_modules
+      @prepended_modules = prepended_modules
+      @extended_modules = extended_modules
+    end
+  end
+
+  class ConstantInstance
+    attr_reader :name, :singleton, :generic_arguments
+
+    def initialize(name:, singleton:, generic_arguments:)
+      @name = name
+      @singleton = singleton
+      @generic_arguments = generic_arguments
+    end
+
+    def ==(other)
+      other.name == name && generic_arguments == other.generic_arguments && singleton == other.singleton
+    end
+    alias eql? ==
+
+    def hash
+      [name, singleton, generic_arguments].hash
+    end
+  end
+
+  class Param
+    attr_reader :name, :type_name, :type
+
+    TYPES = [
+      :required,
+      :optional,
+      :rest,
+      :keyword_required,
+      :keyword_optional,
+      :keyword_rest
+    ].freeze
+
+
+    def initialize(name:, type_name:, type:)
+      @name = name
+      @type_name = type_name
+      @type = type
+    end
+
+    def ==(other)
+      other.name == name && other.type_name == type_name && other.type == type
+    end
+    alias eql? ==
+
+    def hash
+      [name, type_name, type].hash
+    end
+  end
+
+  class BlockParam
+    attr_reader :name, :traces
+
+    def initialize(name:, traces:)
+      @name = name
+      @traces = traces
+    end
+
+    def ==(other)
+      other.is_a?(BlockParam) && name == other.name && traces == other.traces
+    end
+  end
+
+  class BlockTrace
+    attr_reader :self_type, :return_type, :params, :block_param
+
+    def initialize(return_type:, params:, self_type: nil, block_param: nil)
+      @return_type = return_type
+      @params = params
+      @block_param = block_param
+      @self_type = self_type
+    end
+
+    def ==(other)
+      return_type == other.return_type && params == other.params && block_param == other.block_param && self_type == other.self_type
+    end
+  end
+end

data/lib/racer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Racer
+  VERSION = "0.1.0"
+end

data/lib/racer.rb

@@ -0,0 +1,40 @@
+require "racer/racer"
+require "racer/trace"
+require "racer/collectors/rbs_collector"
+require "racer/agent"
+
+require "racer/rails/railtie" if defined?(Rails::Railtie)
+
+require "socket"
+
+module Racer
+  SERVER_PATH = "/tmp/racer.sock"
+
+  def self.start_agent(collectors: [Racer::Collectors::RBSCollector.new], stop_at_exit: true)
+    pid = fork(&Racer::Agent.new(SERVER_PATH, collectors).method(:start))
+
+    until File.exist?(SERVER_PATH)
+      sleep 0.1
+    end
+
+    at_exit do
+      flush
+      if stop_at_exit
+        stop_agent(pid)
+      end
+    end
+
+    pid
+  end
+
+  def self.stop_agent(pid)
+    Process.kill("HUP", pid)
+    Process.wait(pid)
+  rescue Errno::ESRCH
+    # Agent already stopped
+  end
+
+  def self.start(path_regex: nil, max_generic_depth: 2)
+    __c_start(path_regex, max_generic_depth)
+  end
+end

data/sig/racer.rbs

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

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: racer-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Böhme
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Runtime type tracer for ruby
+email:
+- richard.boehme1999@gmail.com
+executables: []
+extensions:
+- ext/racer/extconf.rb
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".tool-versions"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/racer/extconf.rb
+- ext/racer/racer.cc
+- ext/racer/racer.hh
+- ext/racer/tiny_queue.cc
+- ext/racer/tiny_queue.hh
+- ext/racer/traces.cc
+- ext/racer/traces.hh
+- ext/racer/worker.cc
+- ext/racer/worker.hh
+- lib/racer.rb
+- lib/racer/agent.rb
+- lib/racer/collectors/rbs_collector.rb
+- lib/racer/minitest.rb
+- lib/racer/minitest_plugin.rb
+- lib/racer/rails/railtie.rb
+- lib/racer/rb.rb
+- lib/racer/rspec.rb
+- lib/racer/rspec_plugin.rb
+- lib/racer/trace.rb
+- lib/racer/version.rb
+- sig/racer.rbs
+homepage: https://github.com/richardboehme/racer-rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/richardboehme/racer-rb
+  source_code_uri: https://github.com/richardboehme/racer-rb
+  changelog_uri: https://github.com/richardboehme/racer-rb/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 4.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Runtime type tracer for ruby
+test_files: []