standard 1.27.0 → 1.28.0

data/lib/standard/plugin/merges_plugins_into_rubocop_config.rb

@@ -0,0 +1,158 @@
+module Standard
+  module Plugin
+    class MergesPluginsIntoRubocopConfig
+      # Blank configuration object to merge plugins into, with only the following spared:
+      #   - AllCops keys set to avoid warnings about unknown properties
+      #   - Lint/Syntax must be set to avoid a nil error when verifying inherited configs
+      MANDATORY_RUBOCOP_CONFIG_KEYS = ["AllCops", "Lint/Syntax"].freeze
+
+      # AllCops keys that standard does not allow to be set by plugins
+      DISALLOWED_ALLCOPS_KEYS = [
+        "Include",
+        "Exclude",
+        "StyleGuideBaseURL",
+        "StyleGuideCopsOnly",
+        "TargetRubyVersion",
+        "EnabledByDefault",
+        "DisabledByDefault",
+
+        # The AllCops[Enabled] key is an unused artifact of #merge_with_default.
+        # See: https://github.com/rubocop/rubocop/blob/master/lib/rubocop/config_loader_resolver.rb#L81-L85
+        "Enabled"
+      ].freeze
+
+      def initialize
+        @creates_runner_context = Standard::Plugin::CreatesRunnerContext.new
+      end
+
+      def call(options_config, standard_config, plugins, permit_merging:)
+        runner_context = @creates_runner_context.call(standard_config)
+        plugin_config = combine_rubocop_configs(options_config, runner_context, plugins).to_h
+        merge_config_into_all_cops!(options_config, plugin_config)
+        merge_config_into_standard!(options_config, plugin_config, permit_merging: permit_merging)
+      end
+
+      private
+
+      def combine_rubocop_configs(options_config, runner_context, plugins)
+        fake_out_rubocop_default_configuration(options_config) do |fake_config|
+          all_cop_keys_configured_by_plugins = []
+
+          plugins.reduce(fake_config) do |combined_config, plugin|
+            RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, combined_config)
+            next_config, path = config_for_plugin(plugin, runner_context)
+
+            next_config["AllCops"], all_cop_keys_configured_by_plugins = merge_all_cop_settings(
+              combined_config["AllCops"],
+              next_config["AllCops"],
+              all_cop_keys_configured_by_plugins
+            )
+            delete_already_configured_keys!(combined_config.keys, next_config, dont_delete_keys: ["AllCops"])
+
+            RuboCop::ConfigLoader.merge_with_default(next_config, path)
+          end
+        end
+      end
+
+      def config_for_plugin(plugin, runner_context)
+        rules = plugin.rules(runner_context)
+
+        if rules.type == :path
+          [RuboCop::ConfigLoader.load_file(rules.value), rules.value]
+        elsif rules.type == :object
+          [RuboCop::Config.new(rules.value), nil]
+        elsif rules.type == :error
+          raise "Plugin `#{plugin.about&.name || plugin.inspect}' failed to load with error: #{rules.value.respond_to?(:message) ? rules.value.message : rules.value}"
+        end
+      end
+
+      # This is how we ensure "first-in wins": plugins can override AllCops settings that are
+      # set by RuboCop's default configuration, but once a plugin sets an AllCop setting, they
+      # have exclusive first-in-wins rights to that setting.
+      #
+      # The one exception to this are array fields, because we don't want to
+      # overwrite the AllCops defaults but rather munge the arrays (`existing |
+      # new`) to allow plugins to add to the array, for example Include and
+      # Exclude paths and patterns.
+      def merge_all_cop_settings(existing_all_cops, new_all_cops, already_configured_keys)
+        return [existing_all_cops, already_configured_keys] unless new_all_cops.is_a?(Hash)
+
+        combined_all_cops = existing_all_cops.dup
+        combined_configured_keys = already_configured_keys.dup
+
+        new_all_cops.each do |key, value|
+          if combined_all_cops[key].is_a?(Array) && value.is_a?(Array)
+            combined_all_cops[key] |= value
+            combined_configured_keys |= [key]
+          elsif !combined_configured_keys.include?(key)
+            combined_all_cops[key] = value
+            combined_configured_keys << key
+          end
+        end
+
+        [combined_all_cops, combined_configured_keys]
+      end
+
+      def delete_already_configured_keys!(configured_keys, next_config, dont_delete_keys: [])
+        duplicate_keys = configured_keys & Array(next_config&.keys)
+
+        (duplicate_keys - dont_delete_keys).each do |key|
+          next_config.delete(key)
+        end
+      end
+
+      def merge_config_into_all_cops!(options_config, plugin_config)
+        options_config["AllCops"].merge!(
+          except(plugin_config["AllCops"], DISALLOWED_ALLCOPS_KEYS)
+        )
+      end
+
+      def merge_config_into_standard!(options_config, plugin_config, permit_merging:)
+        if permit_merging
+          plugin_config.each do |key, value|
+            options_config[key] = if options_config[key].is_a?(Hash)
+              merge(options_config[key], value)
+            else
+              value
+            end
+          end
+        else
+          except(plugin_config, options_config.keys).each do |key, value|
+            options_config[key] = value
+          end
+        end
+      end
+
+      def fake_out_rubocop_default_configuration(options_config)
+        og_default_config = RuboCop::ConfigLoader.instance_variable_get(:@default_configuration)
+        result = yield blank_rubocop_config(options_config)
+        RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, og_default_config)
+        result
+      end
+
+      def blank_rubocop_config(example_config)
+        RuboCop::Config.new(example_config.to_h.slice(*MANDATORY_RUBOCOP_CONFIG_KEYS), "")
+      end
+
+      def except(hash_or_config, keys)
+        hash_or_config.to_h.reject { |key, _| keys.include?(key) }.to_h
+      end
+
+      # Always deletes nil entries, always overwrites arrays
+      # This is a simplified version of rubocop's ConfigLoader#merge:
+      # https://github.com/rubocop/rubocop/blob/v1.48.1/lib/rubocop/config_loader_resolver.rb#L98
+      def merge(old_hash, new_hash)
+        result = old_hash.merge(new_hash)
+        keys_appearing_in_both = old_hash.keys & new_hash.keys
+        keys_appearing_in_both.each do |key|
+          if new_hash[key].nil?
+            result.delete(key)
+          elsif old_hash[key].is_a?(Hash) && new_hash[key].is_a?(Hash)
+            result[key] = merge(old_hash[key], new_hash[key])
+          end
+        end
+        result
+      end
+    end
+  end
+end

data/lib/standard/plugin/standardizes_configured_plugins.rb

@@ -0,0 +1,37 @@
+module Standard
+  module Plugin
+    class StandardizesConfiguredPlugins
+      DEFAULT_PLUGIN_CONFIG = {
+        "enabled" => true,
+        "require_path" => nil, # If not set, will be set to the plugin name
+        "plugin_class_name" => nil # If not set, looks for gemspec `spec.metadata["default_lint_roller_plugin"]`
+      }.freeze
+
+      BUILT_INS = [
+        {"standard-base" => {
+          "require_path" => "standard/base",
+          "plugin_class_name" => "Standard::Base::Plugin"
+        }},
+        "standard-custom",
+        "standard-performance"
+      ].freeze
+
+      def call(plugins)
+        normalize_config_shape(BUILT_INS + plugins)
+      end
+
+      private
+
+      def normalize_config_shape(plugins)
+        plugins.map { |plugin|
+          if plugin.is_a?(Hash)
+            plugin_name = plugin.keys.first
+            [plugin_name, DEFAULT_PLUGIN_CONFIG.merge({"require_path" => plugin_name}, plugin.values.first)]
+          else
+            [plugin, DEFAULT_PLUGIN_CONFIG.merge("require_path" => plugin)]
+          end
+        }.to_h
+      end
+    end
+  end
+end

data/lib/standard/plugin.rb

@@ -0,0 +1,11 @@
+module Standard
+  module Plugin
+  end
+end
+
+require_relative "plugin/creates_runner_context"
+require_relative "plugin/combines_plugin_configs"
+require_relative "plugin/merges_plugins_into_rubocop_config"
+require_relative "plugin/standardizes_configured_plugins"
+require_relative "plugin/determines_class_constant"
+require_relative "plugin/initializes_plugins"

data/lib/standard/railtie.rb

@@ -1,7 +1,7 @@
 require "pathname"
 
 module Standard
-  class Railtie < Rails::Railtie
+  class Railtie < ::Rails::Railtie
     railtie_name :standard
 
     rake_tasks do

data/lib/standard/runners/help.rb

@@ -27,7 +27,7 @@ module Standard
           While Standard only offers a few configuration options, most can be set in
           a `.standard.yml` file. For full documentation, please visit:
 
-            https://github.com/testdouble/standard
+            https://github.com/standardrb/standard
 
           Having trouble? Here's some diagnostic information:
 
@@ -39,7 +39,7 @@ module Standard
 
           Please report any problems (and include the above information) at the URL below:
 
-            https://github.com/testdouble/standard/issues/new
+            https://github.com/standardrb/standard/issues/new
 
         MESSAGE
       end

data/lib/standard/runners/rubocop.rb

@@ -19,7 +19,7 @@ module Standard
 
       # This is a workaround for an issue with how `parallel` and `stdin`
       # interact when invoked in this way. See:
-      #   https://github.com/testdouble/standard/issues/536
+      #   https://github.com/standardrb/standard/issues/536
       def without_parallelizing_in_stdin_mode(options)
         if options[:stdin]
           options.delete(:parallel)

data/lib/standard/version.rb

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

data/lib/standard.rb

@@ -1,4 +1,8 @@
 require "rubocop"
+require "lint_roller"
+
+module Standard
+end
 
 require "standard/rubocop/ext"
 
@@ -9,5 +13,4 @@ require "standard/railtie" if defined?(Rails) && defined?(Rails::Railtie)
 require "standard/formatter"
 require "standard/cop/block_single_line_braces"
 
-module Standard
-end
+require "standard/plugin"

data/standard.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.6.0"
 
   spec.summary = "Ruby Style Guide, with linter & automatic code fixer"
-  spec.homepage = "https://github.com/testdouble/standard"
+  spec.homepage = "https://github.com/standardrb/standard"
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
@@ -24,7 +24,10 @@ Gem::Specification.new do |spec|
   spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.add_dependency "rubocop", "~> 1.50.2"
-  spec.add_dependency "rubocop-performance", "~> 1.16.0"
+
+  spec.add_dependency "lint_roller", "~> 1.0"
+  spec.add_dependency "standard-custom", "~> 1.0.0"
+  spec.add_dependency "standard-performance", "~> 1.0.1"
 
   # not semver: first three are lsp protocol version, last is patch
   spec.add_dependency "language_server-protocol", "~> 3.17.0.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard
 version: !ruby/object:Gem::Version
-  version: 1.27.0
+  version: 1.28.0
 platform: ruby
 authors:
 - Justin Searls
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-19 00:00:00.000000000 Z
+date: 2023-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -25,19 +25,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.50.2
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: lint_roller
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: standard-custom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: standard-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.17.0.2
-description: 
+description:
 email:
 - searls@gmail.com
 executables:
@@ -72,8 +100,10 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/run
 - bin/setup
 - config/base.yml
+- config/default.yml
 - config/ruby-1.8.yml
 - config/ruby-1.9.yml
 - config/ruby-2.0.yml
@@ -86,13 +116,15 @@ files:
 - config/ruby-2.7.yml
 - config/ruby-3.0.yml
 - config/ruby-3.1.yml
+- docs/ARCHITECTURE.md
 - docs/NEW_RUBIES.md
 - docs/RELEASE.md
 - exe/standardrb
 - lib/standard.rb
+- lib/standard/base.rb
+- lib/standard/base/plugin.rb
 - lib/standard/builds_config.rb
 - lib/standard/cli.rb
-- lib/standard/cop/block_single_line_braces.rb
 - lib/standard/creates_config_store.rb
 - lib/standard/creates_config_store/assigns_rubocop_yaml.rb
 - lib/standard/creates_config_store/configures_ignored_paths.rb
@@ -108,6 +140,13 @@ files:
 - lib/standard/lsp/server.rb
 - lib/standard/lsp/standardizer.rb
 - lib/standard/merges_settings.rb
+- lib/standard/plugin.rb
+- lib/standard/plugin/combines_plugin_configs.rb
+- lib/standard/plugin/creates_runner_context.rb
+- lib/standard/plugin/determines_class_constant.rb
+- lib/standard/plugin/initializes_plugins.rb
+- lib/standard/plugin/merges_plugins_into_rubocop_config.rb
+- lib/standard/plugin/standardizes_configured_plugins.rb
 - lib/standard/railtie.rb
 - lib/standard/rake.rb
 - lib/standard/resolves_yaml_option.rb
@@ -120,14 +159,14 @@ files:
 - lib/standard/runners/version.rb
 - lib/standard/version.rb
 - standard.gemspec
-homepage: https://github.com/testdouble/standard
+homepage: https://github.com/standardrb/standard
 licenses: []
 metadata:
-  homepage_uri: https://github.com/testdouble/standard
-  source_code_uri: https://github.com/testdouble/standard
-  changelog_uri: https://github.com/testdouble/standard/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/standardrb/standard
+  source_code_uri: https://github.com/standardrb/standard
+  changelog_uri: https://github.com/standardrb/standard/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,8 +181,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Ruby Style Guide, with linter & automatic code fixer
 test_files: []

data/lib/standard/cop/block_single_line_braces.rb

@@ -1,96 +0,0 @@
-module RuboCop::Cop
-  module Standard
-    # Check for uses of braces around single line blocks, but allows either
-    # braces or do/end for multi-line blocks.
-    #
-    # @example
-    #   # bad - single line block
-    #   items.each do |item| item / 5 end
-    #
-    #   # good - single line block
-    #   items.each { |item| item / 5 }
-    #
-    class BlockSingleLineBraces < RuboCop::Cop::Base
-      extend RuboCop::Cop::AutoCorrector
-
-      def on_send(node)
-        return unless node.arguments?
-        return if node.parenthesized?
-        return if node.operator_method? || node.assignment_method?
-
-        node.arguments.each do |arg|
-          get_blocks(arg) do |block|
-            # If there are no parentheses around the arguments, then braces
-            # and do-end have different meaning due to how they bind, so we
-            # allow either.
-            ignore_node(block)
-          end
-        end
-      end
-
-      def on_block(node)
-        return if ignored_node?(node)
-        return if proper_block_style?(node)
-
-        message = message(node)
-        add_offense(node.loc.begin, message: message) do |corrector|
-          autocorrect(corrector, node)
-        end
-      end
-
-      private
-
-      def get_blocks(node, &block)
-        case node.type
-        when :block
-          yield node
-        when :send
-          get_blocks(node.receiver, &block) if node.receiver
-        when :hash
-          # A hash which is passed as method argument may have no braces
-          # In that case, one of the K/V pairs could contain a block node
-          # which could change in meaning if do...end replaced {...}
-          return if node.braces?
-
-          node.each_child_node { |child| get_blocks(child, &block) }
-        when :pair
-          node.each_child_node { |child| get_blocks(child, &block) }
-        end
-      end
-
-      def proper_block_style?(node)
-        node.multiline? || node.braces?
-      end
-
-      def message(node)
-        "Prefer `{...}` over `do...end` for single-line blocks."
-      end
-
-      def autocorrect(corrector, node)
-        return if correction_would_break_code?(node)
-
-        replace_do_end_with_braces(corrector, node.loc)
-      end
-
-      def correction_would_break_code?(node)
-        return unless node.keywords?
-
-        node.send_node.arguments? && !node.send_node.parenthesized?
-      end
-
-      def replace_do_end_with_braces(corrector, loc)
-        b = loc.begin
-        e = loc.end
-
-        corrector.insert_after(b, " ") unless whitespace_after?(b, 2)
-
-        corrector.replace(b, "{")
-        corrector.replace(e, "}")
-      end
-
-      def whitespace_after?(range, length = 1)
-        /\s/.match?(range.source_buffer.source[range.begin_pos + length, 1])
-      end
-    end
-  end
-end