standard 1.37.0 → 1.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2deb844275c075310374ee37f374dfb1ab31ded453dd65744a051c2b4c1139a
-  data.tar.gz: 036bbabc58241f5edf1b18a0da1d47e36262b51c37a196298bc0ef4b5e5ba4e5
+  metadata.gz: f78e04ed9ba26c056a144f8584e28ade38906bf4f0e5078802654cd5d7b99082
+  data.tar.gz: 7d6b129ca13e5cbb8dc9ffed5891edcd81975780873501443f125906846d8a3c
 SHA512:
-  metadata.gz: 2723bef6152debb628fd5f510f527296d30714c5e68bff12489b9af0ce6add2361c44911198dea8f764b5302ec24049f7da3671f15e033543f42427f951abe46
-  data.tar.gz: 3804a98d3c95ae5a040380f2dff8b8aaf15431c95392a42563d1687c513e84d55e14337351d24222d301b89755443527b10b5ea2ed93ad2ee93f323c4188a36b
+  metadata.gz: 8de4b19e062290cbc42f4b9d3f73cc2b1412b9dc683b6499a0d443b32f598e1a7d48e0f46f1e4343f18a6032ba6a3fb74a3b90a00257e4f3777ecbc73d5fd758
+  data.tar.gz: 42bf30e5370ca89431b4c8546320fb3c840c1ce7c7256dae9f516ed88f71f8ad1a1b77ea644c417d3ecab3ce98481aecc29211965b6f1c18903d5eccaa9cfc78

data/.github/workflows/test.yml

@@ -16,7 +16,11 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        ruby-version: [2.7, '3.0', 3.1, 3.2, 3.3]
+        ruby-version:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
 
     runs-on: ${{ matrix.os }}
 

data/.standard.yml

@@ -1,4 +1,4 @@
-ruby_version: 2.6
+ruby_version: 3.0
 ignore:
   - tmp/**/*
   - test/fixture/**/*

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## Unreleased
+
+## 1.38.0
+
+* Update minimum Ruby version to 3.0
+* @koic backported a line column bug in our LSP
+  [#635](https://github.com/standardrb/standard/pull/635)
+* Implement a basic [Ruby LSP
+add-on](https://github.com/Shopify/ruby-lsp/blob/main/ADDONS.md), which means
+users would no longer need to install [our custom VS Code
+extension](https://marketplace.visualstudio.com/items?itemName=testdouble.vscode-standard-ruby)
+[#630](https://github.com/standardrb/standard/pull/630)
+
 ## 1.37.0
 
 * Updates rubocop to [1.64.1](https://github.com/rubocop/rubocop/releases/tag/v1.64.1)

data/Gemfile

@@ -6,6 +6,8 @@ gem "bundler"
 gem "minitest", "~> 5.0"
 gem "rake", "~> 13.0"
 gem "m"
+gem "mutex_m"
+gem "ruby-lsp"
 
 # You may want to run these off path locally:
 # gem "lint_roller", path: "../lint_roller"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standard (1.37.0)
+    standard (1.38.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.64.0)
@@ -21,10 +21,12 @@ GEM
       rake (>= 0.9.2.2)
     method_source (1.0.0)
     minitest (5.20.0)
+    mutex_m (0.2.0)
     parallel (1.23.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
+    prism (0.27.0)
     racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
@@ -46,6 +48,10 @@ GEM
     rubocop-performance (1.21.0)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-lsp (0.16.6)
+      language_server-protocol (~> 3.17.0)
+      prism (>= 0.23.0, < 0.28)
+      sorbet-runtime (>= 0.5.10782)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -53,6 +59,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    sorbet-runtime (0.5.11385)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
@@ -69,7 +76,9 @@ DEPENDENCIES
   bundler
   m
   minitest (~> 5.0)
+  mutex_m
   rake (~> 13.0)
+  ruby-lsp
   simplecov
   standard!
 

data/config/default.yml

@@ -1,6 +1,5 @@
 AllCops:
-  # Prevent RuboCop from exploding when it finds an older-than-2.6 .ruby-version
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
   Exclude: []
   DisabledByDefault: true
   StyleGuideBaseURL: https://github.com/standardrb/standard

data/config/ruby-3.2.yml

@@ -1,4 +1,4 @@
-inherit_from: ./base.yml
+inherit_from: ./ruby-3.3.yml
 
 AllCops:
   TargetRubyVersion: 3.2

data/config/ruby-3.3.yml

@@ -0,0 +1,4 @@
+inherit_from: ./base.yml
+
+AllCops:
+  TargetRubyVersion: 3.3

data/lib/ruby_lsp/standard/addon.rb

@@ -0,0 +1,60 @@
+require "standard"
+require_relative "wraps_built_in_lsp_standardizer"
+
+module RubyLsp
+  module Standard
+    class Addon < ::RubyLsp::Addon
+      def initializer
+        @wraps_built_in_lsp_standardizer = nil
+      end
+
+      def name
+        "Standard Ruby"
+      end
+
+      def activate(global_state, message_queue)
+        warn "Activating Standard Ruby LSP addon v#{::Standard::VERSION}"
+        @wraps_built_in_lsp_standardizer = WrapsBuiltinLspStandardizer.new
+        global_state.register_formatter("standard", @wraps_built_in_lsp_standardizer)
+        register_additional_file_watchers(global_state, message_queue)
+        warn "Initialized Standard Ruby LSP addon #{::Standard::VERSION}"
+      end
+
+      def deactivate
+        @wraps_built_in_lsp_standardizer = nil
+      end
+
+      def register_additional_file_watchers(global_state, message_queue)
+        return unless global_state.supports_watching_files
+
+        message_queue << Request.new(
+          id: "standard-file-watcher",
+          method: "client/registerCapability",
+          params: Interface::RegistrationParams.new(
+            registrations: [
+              Interface::Registration.new(
+                id: "workspace/didChangeWatchedFilesStandard",
+                method: "workspace/didChangeWatchedFiles",
+                register_options: Interface::DidChangeWatchedFilesRegistrationOptions.new(
+                  watchers: [
+                    Interface::FileSystemWatcher.new(
+                      glob_pattern: "**/.standard.yml",
+                      kind: Constant::WatchKind::CREATE | Constant::WatchKind::CHANGE | Constant::WatchKind::DELETE
+                    )
+                  ]
+                )
+              )
+            ]
+          )
+        )
+      end
+
+      def workspace_did_change_watched_files(changes)
+        if changes.any? { |change| change[:uri].end_with?(".standard.yml") }
+          @wraps_built_in_lsp_standardizer.init!
+          warn "Re-initialized Standard Ruby LSP addon #{::Standard::VERSION} due to .standard.yml file change"
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/standard/wraps_built_in_lsp_standardizer.rb

@@ -0,0 +1,98 @@
+module RubyLsp
+  module Standard
+    class WrapsBuiltinLspStandardizer
+      include RubyLsp::Requests::Support::Formatter
+      def initialize
+        init!
+      end
+
+      def init!
+        @config = ::Standard::BuildsConfig.new.call([])
+        @standardizer = ::Standard::Lsp::Standardizer.new(
+          @config,
+          ::Standard::Lsp::Logger.new
+        )
+        @rubocop_config = @config.rubocop_config_store.for_pwd
+        @cop_registry = RuboCop::Cop::Registry.global.to_h
+      end
+
+      def run_formatting(uri, document)
+        @standardizer.format(uri_to_path(uri), document.source)
+      end
+
+      def run_diagnostic(uri, document)
+        offenses = @standardizer.offenses(uri_to_path(uri), document.source)
+
+        offenses.map { |o|
+          cop_name = o[:cop_name]
+
+          msg = o[:message].delete_prefix(cop_name)
+          loc = o[:location]
+
+          severity = case o[:severity]
+          when "error", "fatal"
+            RubyLsp::Constant::DiagnosticSeverity::ERROR
+          when "warning"
+            RubyLsp::Constant::DiagnosticSeverity::WARNING
+          when "convention"
+            RubyLsp::Constant::DiagnosticSeverity::INFORMATION
+          when "refactor", "info"
+            RubyLsp::Constant::DiagnosticSeverity::HINT
+          else # the above cases fully cover what RuboCop sends at this time
+            logger.puts "Unknown severity: #{severity.inspect}"
+            RubyLsp::Constant::DiagnosticSeverity::HINT
+          end
+
+          RubyLsp::Interface::Diagnostic.new(
+            code: cop_name,
+            code_description: code_description(cop_name),
+            message: msg,
+            source: "Standard Ruby",
+            severity: severity,
+            range: RubyLsp::Interface::Range.new(
+              start: RubyLsp::Interface::Position.new(line: loc[:start_line] - 1, character: loc[:start_column] - 1),
+              end: RubyLsp::Interface::Position.new(line: loc[:last_line] - 1, character: loc[:last_column])
+            )
+            # TODO: We need to do something like to support quickfixes thru code actions
+            # See: https://github.com/Shopify/ruby-lsp/blob/4c1906172add4d5c39c35d3396aa29c768bfb898/lib/ruby_lsp/requests/support/rubocop_diagnostic.rb#L62
+            # data: {
+            #   correctable: correctable?(offense),
+            #   code_actions: to_lsp_code_actions
+            # }
+            #
+            # Right now, our offenses are all just JSON parsed from stdout shelling to RuboCop, so
+            # it seems we don't have the corrector available to us.
+            #
+            # Lifted from:
+            # https://github.com/Shopify/ruby-lsp/blob/8d4c17efce4e8ecc8e7c557ab2981db6b22c0b6d/lib/ruby_lsp/requests/support/rubocop_diagnostic.rb#L201
+            # def correctable?(offense)
+            #   !offense.corrector.nil?
+            # end
+          )
+        }
+      end
+
+      private
+
+      # duplicated from: lib/standard/lsp/routes.rb
+      # modified to incorporate Ruby LSP's to_standardized_path method
+      def uri_to_path(uri)
+        if uri.respond_to?(:to_standardized_path) && !(standardized_path = uri.to_standardized_path).nil?
+          standardized_path
+        else
+          uri.to_s.sub(%r{^file://}, "")
+        end
+      end
+
+      # lifted from:
+      # https://github.com/Shopify/ruby-lsp/blob/4c1906172add4d5c39c35d3396aa29c768bfb898/lib/ruby_lsp/requests/support/rubocop_diagnostic.rb#L84
+      def code_description(cop_name)
+        if (cop_class = @cop_registry[cop_name]&.first)
+          if (doc_url = cop_class.documentation_url(@rubocop_config))
+            Interface::CodeDescription.new(href: doc_url)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/standard/base/plugin.rb

@@ -57,6 +57,8 @@ module Standard::Base
         "ruby-3.1.yml"
       elsif desired_version < Gem::Version.new("3.3")
         "ruby-3.2.yml"
+      elsif desired_version < Gem::Version.new("3.4")
+        "ruby-3.3.yml"
       else
         default
       end

data/lib/standard/lsp/routes.rb

@@ -181,7 +181,7 @@ module Standard
             message: msg,
             range: {
               start: {character: loc[:start_column] - 1, line: loc[:start_line] - 1},
-              end: {character: loc[:last_column] - 1, line: loc[:last_line] - 1}
+              end: {character: loc[:last_column], line: loc[:last_line] - 1}
             },
             severity: severity,
             source: "standard"

data/lib/standard/plugin/merges_plugins_into_rubocop_config.rb

@@ -154,7 +154,7 @@ module Standard
       end
 
       def except(hash_or_config, keys)
-        hash_or_config.to_h.reject { |key, _| keys.include?(key) }.to_h
+        hash_or_config.to_h.except(*keys).to_h
       end
 
       # Always deletes nil entries, always overwrites arrays

data/lib/standard/version.rb

@@ -1,3 +1,3 @@
 module Standard
-  VERSION = Gem::Version.new("1.37.0")
+  VERSION = Gem::Version.new("1.38.0")
 end

data/standard.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version = Standard::VERSION
   spec.authors = ["Justin Searls"]
   spec.email = ["searls@gmail.com"]
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.summary = "Ruby Style Guide, with linter & automatic code fixer"
   spec.homepage = "https://github.com/standardrb/standard"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard
 version: !ruby/object:Gem::Version
-  version: 1.37.0
+  version: 1.38.0
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -117,11 +117,14 @@ files:
 - config/ruby-3.0.yml
 - config/ruby-3.1.yml
 - config/ruby-3.2.yml
+- config/ruby-3.3.yml
 - docs/ARCHITECTURE.md
 - docs/NEW_RUBIES.md
 - docs/RELEASE.md
 - docs/UPGRADING.md
 - exe/standardrb
+- lib/ruby_lsp/standard/addon.rb
+- lib/ruby_lsp/standard/wraps_built_in_lsp_standardizer.rb
 - lib/standard.rb
 - lib/standard/base.rb
 - lib/standard/base/plugin.rb
@@ -176,14 +179,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Ruby Style Guide, with linter & automatic code fixer