standard 1.27.0 → 1.28.0

data/bin/console

@@ -6,9 +6,5 @@ require "standard"
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
 require "irb"
 IRB.start(__FILE__)

data/bin/run

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "standard"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+Standard::Cli.new(ARGV).run

data/config/base.yml

@@ -1,11 +1,3 @@
-require:
-  - rubocop-performance
-
-AllCops:
-  # Prevent RuboCop from exploding when it finds an older-than-2.6 .ruby-version
-  TargetRubyVersion: 2.6
-  Exclude: []
-
 Bundler/DuplicatedGem:
   Enabled: true
   Include:
@@ -936,156 +928,6 @@ Naming/VariableName:
 Naming/VariableNumber:
   Enabled: false
 
-Performance/AncestorsInclude:
-  Enabled: false
-
-Performance/ArraySemiInfiniteRangeSlice:
-  Enabled: false
-
-Performance/BigDecimalWithNumericArgument:
-  Enabled: true
-
-Performance/BindCall:
-  Enabled: true
-
-Performance/BlockGivenWithExplicitBlock:
-  Enabled: true
-
-Performance/Caller:
-  Enabled: true
-
-Performance/CaseWhenSplat:
-  Enabled: false
-
-Performance/Casecmp:
-  Enabled: false
-
-Performance/ChainArrayAllocation:
-  Enabled: false
-
-Performance/CollectionLiteralInLoop:
-  Enabled: false
-
-Performance/CompareWithBlock:
-  Enabled: true
-
-Performance/ConcurrentMonotonicTime:
-  Enabled: true
-
-Performance/ConstantRegexp:
-  Enabled: true
-
-Performance/Count:
-  Enabled: true
-
-Performance/DeletePrefix:
-  Enabled: false
-
-Performance/DeleteSuffix:
-  Enabled: false
-
-Performance/Detect:
-  Enabled: true
-
-Performance/DoubleStartEndWith:
-  Enabled: true
-  IncludeActiveSupportAliases: false
-
-Performance/EndWith:
-  Enabled: true
-
-Performance/FixedSize:
-  Enabled: true
-
-Performance/FlatMap:
-  Enabled: true
-  EnabledForFlattenWithoutParams: false
-
-Performance/InefficientHashSearch:
-  Enabled: true
-
-Performance/IoReadlines:
-  Enabled: false
-
-Performance/MapCompact:
-  Enabled: false
-
-Performance/MethodObjectAsBlock:
-  Enabled: false
-
-Performance/OpenStruct:
-  Enabled: false
-
-Performance/RangeInclude:
-  Enabled: true
-
-Performance/RedundantBlockCall:
-  Enabled: false
-
-Performance/RedundantEqualityComparisonBlock:
-  Enabled: false
-
-Performance/RedundantMatch:
-  Enabled: true
-
-Performance/RedundantMerge:
-  Enabled: true
-  MaxKeyValuePairs: 2
-
-Performance/RedundantSortBlock:
-  Enabled: true
-
-Performance/RedundantSplitRegexpArgument:
-  Enabled: true
-
-Performance/RedundantStringChars:
-  Enabled: true
-
-Performance/RegexpMatch:
-  Enabled: true
-
-Performance/ReverseEach:
-  Enabled: true
-
-Performance/ReverseFirst:
-  Enabled: true
-
-Performance/SelectMap:
-  Enabled: false
-
-Performance/Size:
-  Enabled: true
-
-Performance/SortReverse:
-  Enabled: true
-
-Performance/Squeeze:
-  Enabled: true
-
-Performance/StartWith:
-  Enabled: true
-
-Performance/StringIdentifierArgument:
-  Enabled: true
-
-Performance/StringInclude:
-  Enabled: false
-
-Performance/StringReplacement:
-  Enabled: true
-
-Performance/Sum:
-  Enabled: false
-
-Performance/TimesMap:
-  Enabled: false
-
-Performance/UnfreezeString:
-  Enabled: true
-
-Performance/UriDefaultParser:
-  Enabled: true
-
 Security/CompoundHash:
   Enabled: true
 
@@ -1107,9 +949,6 @@ Security/Open:
 Security/YAMLLoad:
   Enabled: true
 
-Standard/BlockSingleLineBraces:
-  Enabled: true
-
 Style/AccessModifierDeclarations:
   Enabled: false
 

data/config/default.yml

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

data/config/ruby-2.2.yml

@@ -9,8 +9,5 @@ AllCops:
 Layout/HeredocIndentation:
   Enabled: false
 
-Performance/ConcurrentMonotonicTime:
-  Enabled: false
-
 Style/SafeNavigation:
   Enabled: false

data/docs/ARCHITECTURE.md

@@ -0,0 +1,31 @@
+# Standard Ruby's Architecture
+
+Architecture is not a 4-letter word (but the silly abbreviation 'a10e' is!), so
+as Standard's internal structure has introduced more moving parts, it's
+important to plant a stake in the ground and explain where all the cops are
+buried.
+
+Starting with version 1.28.0, Standard Ruby introduced plugin support and
+refactored how it loads its own rules from one large YAML file into several
+plugins. As a result, what was a single `standard` gem is now spread across 3
+gems.  Here's how it's all organized:
+
+* [standard](https://github.com/standardrb/standard) - The main gem. The one
+people install and think of. Because `standard` has a hard dependency on `rubocop`,
+the base configuration of RuboCop's built-in rules is bundled into the gem, even
+though it's now [defined as a plugin](lib/standard/base/plugin.rb)
+* [standard-performance](https://github.com/standardrb/standard-performance) - A
+plugin that depends on and configures
+[rubocop-performance](https://github.com/rubocop/rubocop-performance)
+* [standard-custom](https://github.com/standardrb/standard-custom) - A plugin
+that implements and configures any custom rules that the Standard team writes
+and maintains itself with the intention that they be part of the default
+Standard Ruby experience (there's only one of these rules so far)
+
+To glue these things together, yet another gem was created (gems are free,
+right?) to define a very simple plugin API. That gem is called
+[lint_roller](https://github.com/standardrb/lint_roller) and it can be used by
+any gem that provides or consumes linting and formatting rules. Because Standard
+Ruby is built on RuboCop's configuration and runner, RuboCop could adopt
+`lint_roller` as its plugin system and plugins could support both `rubocop`
+and `standard` out of the box.

data/lib/standard/base/plugin.rb

@@ -0,0 +1,65 @@
+module Standard::Base
+  class Plugin < LintRoller::Plugin
+    def initialize(config)
+      @config = config
+    end
+
+    def about
+      LintRoller::About.new(
+        name: "standard-base",
+        version: VERSION,
+        homepage: "https://github.com/standardrb/standard",
+        description: "Configuration for RuboCop's built-in rules"
+      )
+    end
+
+    def supported?(context)
+      true
+    end
+
+    def rules(context)
+      LintRoller::Rules.new(
+        type: :path,
+        config_format: :rubocop,
+        value: determine_yaml_path(context.target_ruby_version)
+      )
+    end
+
+    private
+
+    def determine_yaml_path(desired_version)
+      desired_version = Gem::Version.new(desired_version) unless desired_version.is_a?(Gem::Version)
+      default = "base.yml"
+
+      file_name = if !Gem::Version.correct?(desired_version)
+        default
+      elsif desired_version < Gem::Version.new("1.9")
+        "ruby-1.8.yml"
+      elsif desired_version < Gem::Version.new("2.0")
+        "ruby-1.9.yml"
+      elsif desired_version < Gem::Version.new("2.1")
+        "ruby-2.0.yml"
+      elsif desired_version < Gem::Version.new("2.2")
+        "ruby-2.1.yml"
+      elsif desired_version < Gem::Version.new("2.3")
+        "ruby-2.2.yml"
+      elsif desired_version < Gem::Version.new("2.4")
+        "ruby-2.3.yml"
+      elsif desired_version < Gem::Version.new("2.5")
+        "ruby-2.4.yml"
+      elsif desired_version < Gem::Version.new("2.6")
+        "ruby-2.5.yml"
+      elsif desired_version < Gem::Version.new("3.0")
+        "ruby-2.7.yml"
+      elsif desired_version < Gem::Version.new("3.1")
+        "ruby-3.0.yml"
+      elsif desired_version < Gem::Version.new("3.2")
+        "ruby-3.1.yml"
+      else
+        default
+      end
+
+      Pathname.new(__dir__).join("../../../config/#{file_name}")
+    end
+  end
+end

data/lib/standard/base.rb

@@ -0,0 +1,8 @@
+require "lint_roller"
+
+require_relative "base/plugin"
+
+module Standard
+  module Base
+  end
+end

data/lib/standard/creates_config_store/assigns_rubocop_yaml.rb

@@ -3,42 +3,8 @@ require "pathname"
 class Standard::CreatesConfigStore
   class AssignsRubocopYaml
     def call(config_store, standard_config)
-      config_store.options_config = rubocop_yaml_path(standard_config[:ruby_version])
+      config_store.options_config = Pathname.new(__dir__).join("../../../config/default.yml")
       config_store.instance_variable_get(:@options_config)
     end
-
-    private
-
-    def rubocop_yaml_path(desired_version)
-      default = "base.yml"
-
-      file_name = if !Gem::Version.correct?(desired_version)
-        default
-      elsif desired_version < Gem::Version.new("1.9")
-        "ruby-1.8.yml"
-      elsif desired_version < Gem::Version.new("2.0")
-        "ruby-1.9.yml"
-      elsif desired_version < Gem::Version.new("2.1")
-        "ruby-2.0.yml"
-      elsif desired_version < Gem::Version.new("2.2")
-        "ruby-2.1.yml"
-      elsif desired_version < Gem::Version.new("2.3")
-        "ruby-2.2.yml"
-      elsif desired_version < Gem::Version.new("2.4")
-        "ruby-2.3.yml"
-      elsif desired_version < Gem::Version.new("2.5")
-        "ruby-2.4.yml"
-      elsif desired_version < Gem::Version.new("2.6")
-        "ruby-2.5.yml"
-      elsif desired_version < Gem::Version.new("3.0")
-        "ruby-2.7.yml"
-      elsif desired_version < Gem::Version.new("3.1")
-        "ruby-3.0.yml"
-      else
-        default
-      end
-
-      Pathname.new(__dir__).join("../../../config/#{file_name}")
-    end
   end
 end

data/lib/standard/creates_config_store/merges_user_config_extensions.rb

@@ -1,67 +1,37 @@
 require_relative "../file_finder"
+require_relative "../plugin"
 
 class Standard::CreatesConfigStore
   class MergesUserConfigExtensions
-    DISALLOWED_ALLCOPS_KEYS = [
-      "Include",
-      "Exclude",
-      "StyleGuideCopsOnly",
-      "TargetRubyVersion",
-
-      # 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 call(options_config, standard_config)
-      return unless standard_config[:extend_config]&.any?
-
-      extended_config = load_and_merge_extended_rubocop_configs(options_config, standard_config).to_h
-      merge_standard_and_user_all_cops!(options_config, extended_config)
-      merge_extended_rules_into_standard!(options_config, extended_config)
-    end
-
-    private
-
-    def load_and_merge_extended_rubocop_configs(options_config, standard_config)
-      fake_out_rubocop_default_configuration(options_config) do |fake_config|
-        standard_config[:extend_config].reduce(fake_config) do |config, path|
-          RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
-
-          user_rubocop_yaml_path = Standard::FileFinder.new.call(path, Dir.pwd)
-          extension = RuboCop::ConfigLoader.load_file(user_rubocop_yaml_path)
-          RuboCop::ConfigLoader.merge_with_default(extension, path)
-        end
+    class ExtendConfigPlugin < LintRoller::Plugin
+      def initialize(path)
+        @yaml_path = Standard::FileFinder.new.call(path, Dir.pwd)
       end
-    end
 
-    def merge_standard_and_user_all_cops!(options_config, extended_config)
-      options_config["AllCops"].merge!(
-        except(extended_config["AllCops"], DISALLOWED_ALLCOPS_KEYS)
-      )
-    end
+      def about
+        About.new("Pseudo-plugin wrapping the `extend_config' path: #{@yaml_path}")
+      end
 
-    def merge_extended_rules_into_standard!(options_config, extended_config)
-      except(extended_config, options_config.keys).each do |key, value|
-        options_config[key] = value
+      def rules(context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: @yaml_path
+        )
       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
+    def initialize
+      @merges_plugins_into_rubocop_config = Standard::Plugin::MergesPluginsIntoRubocopConfig.new
     end
 
-    # Blank configuration object to merge extensions into, with all known
-    # AllCops keys set to avoid warnings about unknown properties
-    def blank_rubocop_config(example_config)
-      RuboCop::Config.new(example_config.to_h.slice("AllCops"), "")
-    end
+    def call(options_config, standard_config)
+      return unless standard_config[:extend_config]&.any?
 
-    def except(hash_or_config, keys)
-      hash_or_config.to_h.reject { |key, _| keys.include?(key) }.to_h
+      plugins = standard_config[:extend_config].map { |path|
+        ExtendConfigPlugin.new(path)
+      }
+      @merges_plugins_into_rubocop_config.call(options_config, standard_config, plugins, permit_merging: false)
     end
   end
 end

data/lib/standard/creates_config_store.rb

@@ -11,6 +11,7 @@ module Standard
       @assigns_rubocop_yaml = AssignsRubocopYaml.new
       @sets_target_ruby_version = SetsTargetRubyVersion.new
       @configures_ignored_paths = ConfiguresIgnoredPaths.new
+      @combines_plugin_configs = Plugin::CombinesPluginConfigs.new
       @merges_user_config_extensions = MergesUserConfigExtensions.new
     end
 
@@ -19,6 +20,7 @@ module Standard
         options_config = @assigns_rubocop_yaml.call(config_store, standard_config)
         @sets_target_ruby_version.call(options_config, standard_config)
         @configures_ignored_paths.call(options_config, standard_config)
+        @combines_plugin_configs.call(options_config, standard_config)
         @merges_user_config_extensions.call(options_config, standard_config)
       end
     end

data/lib/standard/formatter.rb

@@ -4,7 +4,7 @@ require "rubocop"
 module Standard
   class Formatter < RuboCop::Formatter::BaseFormatter
     STANDARD_GREETING = <<~MSG
-      standard: Use Ruby Standard Style (https://github.com/testdouble/standard)
+      standard: Use Ruby Standard Style (https://github.com/standardrb/standard)
     MSG
 
     def started(_target_files)

data/lib/standard/loads_yaml_config.rb

@@ -33,6 +33,7 @@ module Standard
         config_root: yaml_path ? Pathname.new(yaml_path).dirname.to_s : nil,
         todo_file: todo_path,
         todo_ignore_files: Array(todo_yaml["ignore"]).map { |f| (Hash === f) ? f.keys.first : f },
+        plugins: Array(standard_yaml["plugins"]),
         extend_config: Array(standard_yaml["extend_config"])
       }
     end

data/lib/standard/plugin/combines_plugin_configs.rb

@@ -0,0 +1,15 @@
+module Standard
+  module Plugin
+    class CombinesPluginConfigs
+      def initialize
+        @initializes_plugins = InitializesPlugins.new
+        @merges_plugins_into_rubocop_config = MergesPluginsIntoRubocopConfig.new
+      end
+
+      def call(options_config, standard_config)
+        plugins = @initializes_plugins.call(standard_config[:plugins])
+        @merges_plugins_into_rubocop_config.call(options_config, standard_config, plugins, permit_merging: true)
+      end
+    end
+  end
+end

data/lib/standard/plugin/creates_runner_context.rb

@@ -0,0 +1,15 @@
+module Standard
+  module Plugin
+    class CreatesRunnerContext
+      def call(standard_config)
+        LintRoller::Context.new(
+          runner: :standard,
+          runner_version: Standard::VERSION,
+          engine: :rubocop,
+          engine_version: RuboCop::Version.version,
+          target_ruby_version: standard_config[:ruby_version]
+        )
+      end
+    end
+  end
+end

data/lib/standard/plugin/determines_class_constant.rb

@@ -0,0 +1,56 @@
+module Standard
+  module Plugin
+    class DeterminesClassConstant
+      def call(plugin_name, user_config)
+        require_plugin(user_config["require_path"])
+
+        if (constant_name = user_config["plugin_class_name"])
+          begin
+            Kernel.const_get(constant_name)
+          rescue
+            raise "Failed while configuring plugin `#{plugin_name}': no constant with name `#{constant_name}' was found"
+          end
+        else
+          begin
+            Kernel.const_get(Gem.loaded_specs[plugin_name].metadata["default_lint_roller_plugin"])
+          rescue LoadError, StandardError
+            raise <<~MSG
+              Failed loading plugin `#{plugin_name}' because we couldn't determine
+              the corresponding plugin class to instantiate.
+
+              Standard plugin class names must either be:
+
+                - If the plugin is a gem, defined in the gemspec as `default_lint_roller_plugin'
+
+                  spec.metadata["default_lint_roller_plugin"] = "MyModule::Plugin"
+
+                - Set in YAML as `plugin_class_name'; example:
+
+                  plugins:
+                    - incomplete:
+                        require_path: my_module/plugin
+                        plugin_class_name: "MyModule::Plugin"
+            MSG
+          end
+
+        end
+      end
+
+      private
+
+      def require_plugin(require_path)
+        return if require_path.nil?
+
+        begin
+          require require_path
+        rescue LoadError
+          # If require_path isn't on the load_path (and it may be hard to get it
+          # on there since standardrb is a cli), let's give folks a break and
+          # also try to load it via the current working directory. This is
+          # tested in test/standardrb_test.rb #test_plugins_options
+          require Pathname.new(Dir.pwd).join(require_path)
+        end
+      end
+    end
+  end
+end

data/lib/standard/plugin/initializes_plugins.rb

@@ -0,0 +1,23 @@
+module Standard
+  module Plugin
+    class InitializesPlugins
+      def initialize
+        @standardizes_configured_plugins = StandardizesConfiguredPlugins.new
+        @determines_class_constants = DeterminesClassConstant.new
+      end
+
+      def call(plugins)
+        plugin_configs = @standardizes_configured_plugins.call(plugins)
+        plugin_configs.map { |name_or_class, user_config|
+          if user_config["enabled"]
+            if name_or_class.is_a?(String) || name_or_class.is_a?(Symbol)
+              @determines_class_constants.call(name_or_class, user_config).new(user_config)
+            else
+              name_or_class.new(user_config)
+            end
+          end
+        }
+      end
+    end
+  end
+end