tapioca 0.16.8 → 0.16.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9011a32f92aa24ce99e2ae84c523d45b390925a30fe43e49c92036c06bbb33d
-  data.tar.gz: 46e11aa96fc7cb29053f33d2c4a5bc79760d315801f6ba06296e57703bd6d2e6
+  metadata.gz: 9b1ddf8615a19929d81d7662c300a28ee8d49d08d7ba984fdaa7644bf70d5dfb
+  data.tar.gz: 4f2a79db13ce4a0e7614178d14423f5bd0fded127a6c5b6d0503bf7e2d73df7b
 SHA512:
-  metadata.gz: b6d5161d0b4301d62c544cebe5d923867f2530dceb67864a945000998d4eac78737e3ee5eb5ac213b61a7dc00e5e88e92739dcf2fafff900badffdacc8d49315
-  data.tar.gz: 4f8a54219803ed296644fa9e6fb5312ed7dc7ba57c7f9b89b2bb8a6e25a71920834ed5a0d0d905bc8f1fe26dbcd1a1257bb5d6e203d41ee87adc7d44f5726171
+  metadata.gz: a03a8d4866b5faf46af5cea289d4d7087540d58ee5b4eb759cb30cc23c540cc037c03bdd937cdf73e3f955407b2a47865600297fafe6b495e786e64b99f38942
+  data.tar.gz: 3a5bf689b47f198577480420b9ea0c1294a6c2170df0f5ba9a6e170a8f60b3d2de73827053f4b33002f1a6ae9f2501a73b70590c250c8306b86d52b244aa7f36

data/lib/ruby_lsp/tapioca/addon.rb

@@ -1,7 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
-RubyLsp::Addon.depend_on_ruby_lsp!(">= 0.23.1", "< 0.24")
+RubyLsp::Addon.depend_on_ruby_lsp!(">= 0.23.10", "< 0.24")
 
 begin
   # The Tapioca add-on depends on the Rails add-on to add a runtime component to the runtime server. We can allow the
@@ -13,6 +13,7 @@ rescue LoadError
 end
 
 require "zlib"
+require "ruby_lsp/tapioca/run_gem_rbi_check"
 
 module RubyLsp
   module Tapioca
@@ -24,9 +25,10 @@ module RubyLsp
         super
 
         @global_state = T.let(nil, T.nilable(RubyLsp::GlobalState))
-        @rails_runner_client = T.let(nil, T.nilable(RubyLsp::Rails::RunnerClient))
+        @rails_runner_client = T.let(Rails::NullClient.new, RubyLsp::Rails::RunnerClient)
         @index = T.let(nil, T.nilable(RubyIndexer::Index))
         @file_checksums = T.let({}, T::Hash[String, String])
+        @lockfile_diff = T.let(nil, T.nilable(String))
         @outgoing_queue = T.let(nil, T.nilable(Thread::Queue))
       end
 
@@ -41,7 +43,7 @@ module RubyLsp
           # Get a handle to the Rails add-on's runtime client. The call to `rails_runner_client` will block this thread
           # until the server has finished booting, but it will not block the main LSP. This has to happen inside of a
           # thread
-          addon = T.cast(::RubyLsp::Addon.get("Ruby LSP Rails", ">= 0.3.17", "< 0.4"), ::RubyLsp::Rails::Addon)
+          addon = T.cast(::RubyLsp::Addon.get("Ruby LSP Rails", ">= 0.4.0", "< 0.5"), ::RubyLsp::Rails::Addon)
           @rails_runner_client = addon.rails_runner_client
           @outgoing_queue << Notification.window_log_message("Activating Tapioca add-on v#{version}")
           @rails_runner_client.register_server_addon(File.expand_path("server_addon.rb", __dir__))
@@ -50,7 +52,12 @@ module RubyLsp
             request_name: "load_compilers_and_extensions",
             workspace_path: @global_state.workspace_path,
           )
+
+          send_usage_telemetry("activated")
+          run_gem_rbi_check
         rescue IncompatibleApiError
+          send_usage_telemetry("incompatible_api_error")
+
           # The requested version for the Rails add-on no longer matches. We need to upgrade and fix the breaking
           # changes
           @outgoing_queue << Notification.window_log_message(
@@ -71,19 +78,39 @@ module RubyLsp
 
       sig { override.returns(String) }
       def version
-        "0.1.0"
+        "0.1.2"
       end
 
       sig { params(changes: T::Array[{ uri: String, type: Integer }]).void }
       def workspace_did_change_watched_files(changes)
-        return unless T.must(@global_state).enabled_feature?(:tapiocaAddon)
-        return unless @rails_runner_client # Client is not ready
+        return unless @global_state&.enabled_feature?(:tapiocaAddon)
+        return unless @rails_runner_client.connected?
+
+        has_route_change = T.let(false, T::Boolean)
+        has_fixtures_change = T.let(false, T::Boolean)
+        needs_compiler_reload = T.let(false, T::Boolean)
 
         constants = changes.flat_map do |change|
           path = URI(change[:uri]).to_standardized_path
-          next if path.end_with?("_test.rb", "_spec.rb")
           next unless file_updated?(change, path)
 
+          if File.fnmatch("**/fixtures/**/*.yml{,.erb}", path, File::FNM_PATHNAME | File::FNM_EXTGLOB)
+            has_fixtures_change = true
+            next
+          end
+
+          if File.basename(path) == "routes.rb" || File.fnmatch?("**/routes/**/*.rb", path, File::FNM_PATHNAME)
+            has_route_change = true
+            next
+          end
+
+          next if File.fnmatch?("**/{test,spec,features}/**/*", path, File::FNM_PATHNAME | File::FNM_EXTGLOB)
+
+          if File.fnmatch?("**/tapioca/**/compilers/**/*.rb", path, File::FNM_PATHNAME)
+            needs_compiler_reload = true
+            next
+          end
+
           entries = T.must(@index).entries_for(change[:uri])
           next unless entries
 
@@ -92,18 +119,59 @@ module RubyLsp
           end
         end.compact
 
-        return if constants.empty?
+        return if constants.empty? && !has_route_change && !has_fixtures_change && !needs_compiler_reload
 
         @rails_runner_client.trigger_reload
-        @rails_runner_client.delegate_notification(
-          server_addon_name: "Tapioca",
-          request_name: "dsl",
-          constants: constants,
-        )
+
+        if needs_compiler_reload
+          @rails_runner_client.delegate_notification(
+            server_addon_name: "Tapioca",
+            request_name: "reload_workspace_compilers",
+            workspace_path: @global_state.workspace_path,
+          )
+        end
+
+        if has_route_change
+          send_usage_telemetry("route_dsl")
+          @rails_runner_client.delegate_notification(server_addon_name: "Tapioca", request_name: "route_dsl")
+        end
+
+        if has_fixtures_change
+          send_usage_telemetry("fixtures_dsl")
+          @rails_runner_client.delegate_notification(server_addon_name: "Tapioca", request_name: "fixtures_dsl")
+        end
+
+        if constants.any?
+          send_usage_telemetry("dsl")
+          @rails_runner_client.delegate_notification(
+            server_addon_name: "Tapioca",
+            request_name: "dsl",
+            constants: constants,
+          )
+        end
       end
 
       private
 
+      sig { params(feature_name: String).void }
+      def send_usage_telemetry(feature_name)
+        return unless @outgoing_queue && @global_state
+
+        # Telemetry is not captured by default even if events are produced by the server
+        # See https://github.com/Shopify/ruby-lsp/tree/main/vscode#telemetry
+        @outgoing_queue << Notification.telemetry({
+          eventName: "tapioca_addon.feature_usage",
+          type: "data",
+          data: {
+            type: "counter",
+            attributes: {
+              label: feature_name,
+              machineId: @global_state.telemetry_machine_id,
+            },
+          },
+        })
+      end
+
       sig { params(change: T::Hash[Symbol, T.untyped], path: String).returns(T::Boolean) }
       def file_updated?(change, path)
         case change[:type]
@@ -132,6 +200,20 @@ module RubyLsp
 
         false
       end
+
+      sig { void }
+      def run_gem_rbi_check
+        gem_rbi_check = RunGemRbiCheck.new(T.must(@global_state).workspace_path)
+        gem_rbi_check.run
+
+        T.must(@outgoing_queue) << Notification.window_log_message(
+          gem_rbi_check.stdout,
+        ) unless gem_rbi_check.stdout.empty?
+        T.must(@outgoing_queue) << Notification.window_log_message(
+          gem_rbi_check.stderr,
+          type: Constant::MessageType::WARNING,
+        ) unless gem_rbi_check.stderr.empty?
+      end
     end
   end
 end

data/lib/ruby_lsp/tapioca/lockfile_diff_parser.rb

@@ -0,0 +1,49 @@
+# typed: true
+# frozen_string_literal: true
+
+require "bundler"
+
+module RubyLsp
+  module Tapioca
+    class LockfileDiffParser
+      GEM_NAME_PATTERN = /[\w\-]+/
+      DIFF_LINE_PATTERN = /[+-](.*#{GEM_NAME_PATTERN})\s*\(/
+      ADDED_LINE_PATTERN = /^\+.*#{GEM_NAME_PATTERN} \(.*\)/
+      REMOVED_LINE_PATTERN = /^-.*#{GEM_NAME_PATTERN} \(.*\)/
+
+      attr_reader :added_or_modified_gems
+      attr_reader :removed_gems
+
+      def initialize(diff_content, direct_dependencies: nil)
+        @diff_content = diff_content.lines
+        @current_dependencies = direct_dependencies ||
+          Bundler::LockfileParser.new(Bundler.default_lockfile.read).dependencies.keys
+        @added_or_modified_gems = parse_added_or_modified_gems
+        @removed_gems = parse_removed_gems
+      end
+
+      private
+
+      def parse_added_or_modified_gems
+        @diff_content
+          .filter_map { |line| extract_gem(line) if line.match?(ADDED_LINE_PATTERN) }
+          .uniq
+      end
+
+      def parse_removed_gems
+        @diff_content.filter_map do |line|
+          next unless line.match?(REMOVED_LINE_PATTERN)
+
+          gem = extract_gem(line)
+          next if @current_dependencies.include?(gem)
+
+          gem
+        end.uniq
+      end
+
+      def extract_gem(line)
+        line.match(DIFF_LINE_PATTERN)[1].strip
+      end
+    end
+  end
+end

data/lib/ruby_lsp/tapioca/run_gem_rbi_check.rb

@@ -0,0 +1,153 @@
+# typed: true
+# frozen_string_literal: true
+
+require "open3"
+require "ruby_lsp/tapioca/lockfile_diff_parser"
+
+module RubyLsp
+  module Tapioca
+    class RunGemRbiCheck
+      extend T::Sig
+
+      attr_reader :stdout
+      attr_reader :stderr
+      attr_reader :status
+
+      sig { params(project_path: String).void }
+      def initialize(project_path)
+        @project_path = project_path
+        @stdout = T.let("", String)
+        @stderr = T.let("", String)
+        @status = T.let(nil, T.nilable(Process::Status))
+      end
+
+      sig { void }
+      def run
+        return log_message("Not a git repository") unless git_repo?
+
+        cleanup_orphaned_rbis
+
+        if lockfile_changed?
+          generate_gem_rbis
+        end
+      end
+
+      private
+
+      attr_reader :project_path
+
+      sig { returns(T.nilable(T::Boolean)) }
+      def git_repo?
+        _, status = Open3.capture2e("git", "rev-parse", "--is-inside-work-tree", chdir: project_path)
+        status.success?
+      end
+
+      sig { returns(T::Boolean) }
+      def lockfile_changed?
+        !lockfile_diff.empty?
+      end
+
+      sig { returns(Pathname) }
+      def lockfile
+        @lockfile ||= T.let(Pathname(project_path).join("Gemfile.lock"), T.nilable(Pathname))
+      end
+
+      sig { returns(String) }
+      def lockfile_diff
+        @lockfile_diff ||= T.let(read_lockfile_diff, T.nilable(String))
+      end
+
+      sig { returns(String) }
+      def read_lockfile_diff
+        return "" unless lockfile.exist?
+
+        execute_in_project_path("git", "diff", lockfile.to_s).strip
+      end
+
+      sig { void }
+      def generate_gem_rbis
+        parser = Tapioca::LockfileDiffParser.new(@lockfile_diff)
+        removed_gems = parser.removed_gems
+        added_or_modified_gems = parser.added_or_modified_gems
+
+        if added_or_modified_gems.any?
+          log_message("Identified lockfile changes, attempting to generate gem RBIs...")
+          execute_tapioca_gem_command(added_or_modified_gems)
+        elsif removed_gems.any?
+          remove_rbis(removed_gems)
+        end
+      end
+
+      sig { params(gems: T::Array[String]).void }
+      def execute_tapioca_gem_command(gems)
+        Bundler.with_unbundled_env do
+          stdout, stderr, status = T.unsafe(Open3).capture3(
+            "bundle",
+            "exec",
+            "tapioca",
+            "gem",
+            "--lsp_addon",
+            *gems,
+            chdir: project_path,
+          )
+
+          log_message(stdout) unless stdout.empty?
+          @stderr = stderr unless stderr.empty?
+          @status = status
+        end
+      end
+
+      sig { params(gems: T::Array[String]).void }
+      def remove_rbis(gems)
+        files = Dir.glob(
+          "sorbet/rbi/gems/{#{gems.join(",")}}@*.rbi",
+          base: project_path,
+        )
+        delete_files(files, "Removed RBIs for")
+      end
+
+      sig { void }
+      def cleanup_orphaned_rbis
+        untracked_files = git_ls_gem_rbis("--others", "--exclude-standard")
+        deleted_files = git_ls_gem_rbis("--deleted")
+
+        delete_files(untracked_files, "Deleted untracked RBIs")
+        restore_files(deleted_files, "Restored deleted RBIs")
+      end
+
+      sig { params(flags: T.untyped).returns(T::Array[String]) }
+      def git_ls_gem_rbis(*flags)
+        flags = T.unsafe(["git", "ls-files", *flags, "sorbet/rbi/gems/"])
+
+        execute_in_project_path(*flags)
+          .lines
+          .map(&:strip)
+      end
+
+      sig { params(files: T::Array[String], message: String).void }
+      def delete_files(files, message)
+        files_to_remove = files.map { |file| File.join(project_path, file) }
+        FileUtils.rm(files_to_remove)
+        log_message("#{message}: #{files.join(", ")}") unless files.empty?
+      end
+
+      sig { params(files: T::Array[String], message: String).void }
+      def restore_files(files, message)
+        execute_in_project_path("git", "checkout", "--pathspec-from-file=-", stdin: files.join("\n"))
+        log_message("#{message}: #{files.join(", ")}") unless files.empty?
+      end
+
+      sig { params(message: String).void }
+      def log_message(message)
+        @stdout += "#{message}\n"
+      end
+
+      def execute_in_project_path(*parts, stdin: nil)
+        options = { chdir: project_path }
+        options[:stdin_data] = stdin if stdin
+        stdout_and_stderr, _status = T.unsafe(Open3).capture2e(*parts, options)
+        stdout_and_stderr
+      end
+    end
+  end
+end

data/lib/ruby_lsp/tapioca/server_addon.rb

@@ -2,6 +2,8 @@
 # frozen_string_literal: true
 
 require "tapioca/internal"
+require "tapioca/dsl/compilers/url_helpers"
+require "tapioca/dsl/compilers/active_record_fixtures"
 
 module RubyLsp
   module Tapioca
@@ -12,27 +14,64 @@ module RubyLsp
 
       def execute(request, params)
         case request
+        when "reload_workspace_compilers"
+          with_notification_wrapper("reload_workspace_compilers", "Reloading DSL compilers") do
+            @loader&.reload_custom_compilers
+          end
         when "load_compilers_and_extensions"
           # Load DSL extensions and compilers ahead of time, so that we don't have to pay the price of invoking
           # `Gem.find_files` on every execution, which is quite expensive
-          ::Tapioca::Loaders::Dsl.new(
+          @loader = ::Tapioca::Loaders::Dsl.new(
             tapioca_path: ::Tapioca::TAPIOCA_DIR,
             eager_load: false,
             app_root: params[:workspace_path],
             halt_upon_load_error: false,
-          ).load_dsl_extensions_and_compilers
+          )
+          @loader.load_dsl_extensions_and_compilers
         when "dsl"
           fork do
-            dsl(params)
+            with_notification_wrapper("dsl", "Generating DSL RBIs") do
+              dsl(params[:constants])
+            end
+          end
+        when "route_dsl"
+          fork do
+            with_notification_wrapper("route_dsl", "Generating route DSL RBIs") do
+              constants = ::Tapioca::Dsl::Compilers::UrlHelpers.gather_constants
+              dsl(constants.map(&:name), "--only=Tapioca::Dsl::Compilers::UrlHelpers", "ActiveSupportConcern")
+            end
+          end
+        when "fixtures_dsl"
+          fork do
+            with_notification_wrapper("fixture_dsl", "Generating fixture DSL RBIs") do
+              constants = ::Tapioca::Dsl::Compilers::ActiveRecordFixtures.gather_constants
+              dsl(constants.map(&:name), "--only=Tapioca::Dsl::Compilers::ActiveRecordFixtures")
+            end
           end
         end
       end
 
       private
 
-      def dsl(params)
+      def with_notification_wrapper(request_name, title, &block)
+        with_progress(request_name, title) do
+          with_notification_error_handling(request_name, &block)
+        end
+      end
+
+      def dsl(constants, *args)
         load("tapioca/cli.rb") # Reload the CLI to reset thor defaults between requests
-        ::Tapioca::Cli.start(["dsl", "--lsp_addon", "--workers=1"] + params[:constants])
+
+        ::Tapioca::Cli.addon_mode!
+
+        # Order here is important to avoid having Thor confuse arguments. Do not put an array argument at the end before
+        # the list of constants
+        arguments = ["dsl"]
+        arguments.concat(args)
+        arguments.push("--workers=1")
+        arguments.concat(constants)
+
+        ::Tapioca::Cli.start(arguments)
       end
     end
   end

data/lib/tapioca/cli.rb

@@ -143,11 +143,6 @@ module Tapioca
       type: :hash,
       desc: "Options to pass to the DSL compilers",
       default: {}
-    option :lsp_addon,
-      type: :boolean,
-      desc: "Generate DSL RBIs from the LSP add-on. Internal to Tapioca and not intended for end-users",
-      default: false,
-      hide: true
     def dsl(*constant_or_paths)
       set_environment(options)
 
@@ -170,7 +165,7 @@ module Tapioca
         app_root: options[:app_root],
         halt_upon_load_error: options[:halt_upon_load_error],
         compiler_options: options[:compiler_options],
-        lsp_addon: options[:lsp_addon],
+        lsp_addon: self.class.addon_mode,
       }
 
       command = if options[:verify]
@@ -379,9 +374,22 @@ module Tapioca
     end
 
     no_commands do
+      @addon_mode = false
+
       class << self
+        extend T::Sig
+
+        # Indicates that we are running from the LSP, set using the `addon_mode!` method
+        attr_reader :addon_mode
+
+        sig { void }
+        def addon_mode!
+          @addon_mode = true
+        end
+
+        sig { returns(T::Boolean) }
         def exit_on_failure?
-          true
+          !@addon_mode
         end
       end
     end

data/lib/tapioca/dsl/compilers/active_record_relations.rb

@@ -374,7 +374,7 @@ module Tapioca
 
           klass.create_method(
             "size",
-            return_type: "Integer",
+            return_type: "T::Hash[T.untyped, Integer]",
           )
 
           CALCULATION_METHODS.each do |method_name|

data/lib/tapioca/gem/listeners/source_location.rb

@@ -57,7 +57,7 @@ module Tapioca
           # we can clear the gem version if the gem is the same one we are processing
           version = "" if gem == @pipeline.gem
 
-          uri = URI::Source.build(
+          uri = SourceURI.build(
             gem_name: gem.name,
             gem_version: version,
             path: path.to_s,

data/lib/tapioca/helpers/source_uri.rb

@@ -3,8 +3,8 @@
 
 require "uri/file"
 
-module URI
-  class Source < URI::File
+module Tapioca
+  class SourceURI < URI::File
     extend T::Sig
 
     COMPONENT = T.let(
@@ -37,7 +37,7 @@ module URI
           gem_version: T.nilable(String),
           path: String,
           line_number: T.nilable(String),
-        ).returns(URI::Source)
+        ).returns(T.attached_class)
       end
       def build(gem_name:, gem_version:, path:, line_number:)
         super(

data/lib/tapioca/loaders/dsl.rb

@@ -45,6 +45,27 @@ module Tapioca
         load_dsl_compilers
       end
 
+      sig { void }
+      def reload_custom_compilers
+        # Remove all loaded custom compilers
+        ::Tapioca::Dsl::Compiler.descendants.each do |compiler|
+          name = compiler.name
+          next unless name && @custom_compiler_paths.include?(Module.const_source_location(name)&.first)
+
+          *parts, unqualified_name = name.split("::")
+
+          if parts.empty?
+            Object.send(:remove_const, unqualified_name)
+          else
+            parts.join("::").safe_constantize.send(:remove_const, unqualified_name)
+          end
+        end
+
+        # Remove from $LOADED_FEATURES each workspace compiler file and then re-load
+        @custom_compiler_paths.each { |path| $LOADED_FEATURES.delete(path) }
+        load_custom_dsl_compilers
+      end
+
       protected
 
       sig do
@@ -57,6 +78,7 @@ module Tapioca
         @eager_load = eager_load
         @app_root = app_root
         @halt_upon_load_error = halt_upon_load_error
+        @custom_compiler_paths = T.let([], T::Array[String])
       end
 
       sig { void }
@@ -89,12 +111,7 @@ module Tapioca
         end
 
         # Load all custom compilers from the project
-        Dir.glob([
-          "#{@tapioca_path}/generators/**/*.rb", # TODO: Here for backcompat, remove later
-          "#{@tapioca_path}/compilers/**/*.rb",
-        ]).each do |compiler|
-          require File.expand_path(compiler)
-        end
+        load_custom_dsl_compilers
 
         say("Done", :green)
       end
@@ -112,6 +129,17 @@ module Tapioca
 
         say("Done", :green)
       end
+
+      private
+
+      sig { void }
+      def load_custom_dsl_compilers
+        @custom_compiler_paths = Dir.glob([
+          "#{@tapioca_path}/generators/**/*.rb", # TODO: Here for backcompat, remove later
+          "#{@tapioca_path}/compilers/**/*.rb",
+        ])
+        @custom_compiler_paths.each { |compiler| require File.expand_path(compiler) }
+      end
     end
   end
 end

data/lib/tapioca/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Tapioca
-  VERSION = "0.16.8"
+  VERSION = "0.16.10"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tapioca
 version: !ruby/object:Gem::Version
-  version: 0.16.8
+  version: 0.16.10
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -10,7 +10,7 @@ authors:
 - Peter Zhu
 bindir: exe
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark
@@ -149,6 +149,8 @@ files:
 - README.md
 - exe/tapioca
 - lib/ruby_lsp/tapioca/addon.rb
+- lib/ruby_lsp/tapioca/lockfile_diff_parser.rb
+- lib/ruby_lsp/tapioca/run_gem_rbi_check.rb
 - lib/ruby_lsp/tapioca/server_addon.rb
 - lib/tapioca.rb
 - lib/tapioca/bundler_ext/auto_require_hook.rb
@@ -297,7 +299,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A Ruby Interface file generator for gems, core types and the Ruby standard
   library