spoom 1.7.10 → 1.7.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82dc04cf069a738410f097150bff4d94af38dc6f7eefca31c368596eaf138da0
-  data.tar.gz: ea4046ff175a5c05eb85dc8cc22b6cb88f294d63b378b88a790f6bd4d92bfaff
+  metadata.gz: e5cf816e6ecd86209b75a94d71474288762d94b97da6e6637f2b67bb80c5fcf0
+  data.tar.gz: fafeb36ec7993a9632dfa0e7c1b47b7e671122e2e0a89358b1c1ab86dd611aca
 SHA512:
-  metadata.gz: a6c72f54e3398d0d599b92d5c266bdea3db2ee78b10151bf9a5644f2679d0778ecef4cfce105bb8dd284947e6c737ff194599c2e72ab7894dd0122466034c553
-  data.tar.gz: ed0df1194a93939bbb4117efbc3218d9f18d079cd2dd6b704579ba8e4c78f6f5f8a58b02072dc99bd19870eeaed0bc449ee70ea5c965e152685239b801d97c99
+  metadata.gz: a28c07c9f9ddbd22a754d6f4619696d6a82caa6f8b355dd99fc90b27c42c14b8bbb4377e433ad593b7133fffe8397fa929c75e9d309dd9499a7aa105b2126fcb
+  data.tar.gz: a098d8d9fba5cef4988d5e3e5fdc01493beec8c3ddd3a75e1b78353570872d447ab82f47a83d2cc3192b6f3699a7409f45b848e29d373eee03d273647e0afacf

data/Gemfile

@@ -6,6 +6,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "minitest"
+gem "minitest-mock"
 
 group :development do
   gem "debug"

data/README.md

@@ -375,7 +375,25 @@ $ spoom deadcode remove path/to/file.rb:42:18-47:23
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Don't forget to run `bin/sanity` before pushing your changes.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Releasing
+
+### Bump the gem version
+
+- [ ] Locally, update the version number in [`version.rb`](https://github.com/Shopify/spoom/blob/main/lib/spoom/version.rb)
+- [ ] Run `bundle install` to update the version number in `Gemfile.lock`
+- [ ] Commit this change with the message `Bump version to vx.y.z`
+- [ ] Push this change directly to main or open a PR
+
+### Create a new tag
+
+- [ ] Locally, create a new tag with the new version number: `git tag vx.y.z`
+- [ ] Push this tag up to the remote `git push origin vx.y.z`
+
+### Release workflow will run automatically
+
+We have a [release workflow](https://github.com/Shopify/spoom/actions/workflows/release.yml) that will publish your new gem version to rubygems.org via [Trusted Publishing](https://guides.rubygems.org/trusted-publishing/). This workflow must be approved by a member of the Ruby and Rails Infrastructure team at Shopify before it will run. Once it is approved, it will automatically publish a new gem version to rubygems.org and create a new GitHub release.
 
 ## Contributing
 

data/lib/spoom/bundler_helper.rb

@@ -3,8 +3,6 @@
 
 module Spoom
   module BundlerHelper
-    extend T::Sig
-
     class << self
       # Generate a gem requirement for the given gem name, using that gem's version in the "real" current bundle.
       #

data/lib/spoom/cli/srb/metrics.rb

@@ -59,7 +59,7 @@ module Spoom
             .select { |key, _value| key.start_with?("rbs_") }
             .sort_by { |_key, value| -value }
             .each do |key, value|
-            say(" * #{key}: `#{value}`")
+              say(" * #{key}: `#{value}`")
           end
         end
       end

data/lib/spoom/context/exec.rb

@@ -1,6 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
+require "shellwords"
+
 module Spoom
   class ExecResult < T::Struct
     const :out, String
@@ -30,11 +32,21 @@ module Spoom
         Bundler.with_unbundled_env do
           opts = { chdir: absolute_path } #: Hash[Symbol, untyped]
 
+          # When Ruby is wrapped in another dev environment (e.g. Nix), that environment might set
+          # env variables that cause Sorbet (or other tools) to link to incorrect versions of
+          # dependencies.
+          #
+          # In the case of Sorbet, this can lead to corrupted JSON output.
+          #
+          # Executing the command directly through the shell bypasses any Ruby wrappers and
+          # ensures that we are using the versions of tools that are default on the system.
+          command_with_shell = "/bin/sh -c #{command.shellescape}"
+
           if capture_err
-            out, err, status = Open3.capture3(command, opts)
+            out, err, status = Open3.capture3(command_with_shell, opts)
             ExecResult.new(out: out, err: err, status: T.must(status.success?), exit_code: T.must(status.exitstatus))
           else
-            out, status = Open3.capture2(command, opts)
+            out, status = Open3.capture2(command_with_shell, opts)
             ExecResult.new(out: out, err: nil, status: T.must(status.success?), exit_code: T.must(status.exitstatus))
           end
         end

data/lib/spoom/file_tree.rb

@@ -4,14 +4,14 @@
 module Spoom
   # Build a file hierarchy from a set of file paths.
   class FileTree
-    #: (?T::Enumerable[String] paths) -> void
+    #: (?Enumerable[String] paths) -> void
     def initialize(paths = [])
       @roots = {} #: Hash[String, Node]
       add_paths(paths)
     end
 
     # Add all `paths` to the tree
-    #: (T::Enumerable[String] paths) -> void
+    #: (Enumerable[String] paths) -> void
     def add_paths(paths)
       paths.each { |path| add_path(path) }
     end

data/lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb

@@ -139,6 +139,12 @@ module Spoom
 
             apply_member_annotations(comments.method_annotations, sig)
 
+            # Sorbet runtime doesn't support `sig` on `method_added` or
+            # `singleton_method_added`, so we always use `without_runtime` for them.
+            if def_node.name == :method_added || def_node.name == :singleton_method_added
+              sig.without_runtime = true
+            end
+
             @rewriter << Source::Replace.new(
               signature.location.start_offset,
               signature.location.end_offset,
@@ -202,6 +208,9 @@ module Spoom
           signatures = comments.signatures
           if signatures.any?
             signatures.each do |signature|
+              # Only type param signatures (e.g. `#: [A, B]`) are valid on class/module nodes
+              next unless signature.string.start_with?("[")
+
               type_params = ::RBS::Parser.parse_type_params(signature.string)
               next if type_params.empty?
 

data/lib/spoom/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Spoom
-  VERSION = "1.7.10"
+  VERSION = "1.7.12"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.7.10
+  version: 1.7.12
 platform: ruby
 authors:
 - Alexandre Terrasa
@@ -99,14 +99,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.dev.4
+        version: 4.0.0.dev.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.dev.4
+        version: 4.0.0.dev.5
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
@@ -275,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Useful tools for Sorbet enthusiasts.
 test_files: []