standard 1.21.1 → 1.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a7fc419962214950950e1f1babe8ea008c878c3309e7066a7a971fea897df23
-  data.tar.gz: b0d510b5788332ebca799de9a665ca8df590cb5679360daca36d67dcddf2e539
+  metadata.gz: f79913870ce4e07e94a76c49bfdb2bdf671b72cfe28b9c8d23d3dcfe723b9093
+  data.tar.gz: 1fbbe5ecbb1b9b093997cf96f4102c089305ef35f5bf0523406924120cb5906e
 SHA512:
-  metadata.gz: 59badefc6eb57920133e0f6440374e60d96211f5496fae8acc1be5b1e90852152c38f44043918818af54a7bfa59489472af47f3b41883b7ab343ee4330d02d84
-  data.tar.gz: 44fcaabf3eeedae4935562e4cc73d90e3b6e0116be4b18a0ae9f5359f21c8bb6cce4df77a69d27f7bd680350be052161eb6d7bcc26e2e71f45a0513078a9d25c
+  metadata.gz: 19e734ff2ab15102430f2cd927ef9beed5c403b6e7b30804bb8baf23d83978ffdfeec3324482d957daae0bd7efbbc7ebcd9bce9bc9f9a84e81c85839c2f30eb0
+  data.tar.gz: a3135a540a166b292633aa3e2adb11854f09b67fa07dccbc5199de73efa5d289b4612b10917481791563105bdc815a89e7912e054a737428fb55c25c32cfe0bb

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 1.22.1
+
+* Improve the behavior of `extend_config` to more accurately reflect how Rubocop
+extensions would behave when loaded via the `rubocop` CLI (by capturing any
+mutations to RuboCop's default configuration)
+[#512](https://github.com/testdouble/standard/pull/512)
+
+## 1.22.0
+
+* Add `extend_config` option [#506](https://github.com/testdouble/standard/pull/506)
+
 ## 1.21.1
 
 * Fix standard comment directives [#498](https://github.com/testdouble/standard/pull/498)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standard (1.21.1)
+    standard (1.22.1)
       language_server-protocol (~> 3.17.0.2)
       rubocop (= 1.42.0)
       rubocop-performance (= 1.15.2)

data/README.md

@@ -215,12 +215,11 @@ inherit_gem:
 
 ## Who uses Ruby Standard Style?
 
-(This section will not [look very
-familiar](https://github.com/standard/standard#who-uses-javascript-standard-style)
-if you've used StandardJS.)
+Here are a few examples of Ruby Standard-compliant teams & projects:
 
 * [Test Double](https://testdouble.com/agency)
 * [Amazon Web Services](https://aws.amazon.com/)
+* [Arrows](https://arrows.to/)
 * [Babylist](https://www.babylist.com/)
 * [Brand New Box](https://brandnewbox.com)
 * [Brave Software](https://github.com/brave-intl/publishers)
@@ -244,9 +243,7 @@ if you've used StandardJS.)
 * [RubyCI](https://ruby.ci)
 * [thoughtbot](https://thoughtbot.com/)
 
-If your team starts using Standard, [send a pull
-request](https://github.com/testdouble/standard/edit/main/README.md) to let us
-know!
+Does your team use Standard? [Add your name to the list](https://github.com/testdouble/standard/edit/main/README.md)!
 
 ## Is there a readme badge?
 
@@ -401,6 +398,87 @@ configurations](https://github.com/testdouble/standard/tree/main/config) and
 consider helping out by submitting a pull request if you find a rule that won't
 work for older Rubies.
 
+## How do I use Standard with RuboCop extensions or custom rules?
+
+If you want to use Standard in conjunction with RuboCop extensions or custom
+cops, you can specify them in your own [RuboCop configuration
+YAML](https://docs.rubocop.org/rubocop/configuration.html) files and
+`.standard.yml` using the "extend_config` setting.
+
+For a simple example, you could include [rubocop-rails](https://github.com/rubocop/rubocop-rails)
+when Standard runs by first specifying a file in `.standard.yml`:
+
+```yaml
+# .standard.yml
+
+extend_config:
+  - .standard_rubocop_extensions.yml
+```
+
+And a minimal RuboCop configuration file:
+
+```yaml
+# .standard_rubocop_extensions.yml
+
+require:
+  - rubocop-rails
+```
+
+That's it! Now, in addition to all of Standard's built-in rules, `standardrb`
+and `rake standard` will also execute the default configuration of the
+`rubocop-rails` gem without needing to invoke `rubocop` separately.
+
+For a slightly more complex example, we could add the
+[https://github.com/Betterment/betterlint] gem from our friends at
+[Betterment](https://www.betterment.com), first by telling Standard where our
+configuration file is:
+
+```yml
+# .standard.yml
+
+extend_config:
+  - .betterlint.yml
+```
+
+But if we only wanted to enable a particular rule, we could configure it more
+narrowly, like this:
+
+```yml
+# .betterlint.yml
+
+require:
+  - rubocop/cop/betterment.rb
+
+AllCops:
+  DisabledByDefault: true
+
+Betterment/UnscopedFind:
+  Enabled: true
+
+  unauthenticated_models:
+    - SystemConfiguration
+```
+
+This same approach works for more than just gems! Just require a Ruby file that
+defines or loads your [custom RuboCop
+implementation](https://docs.rubocop.org/rubocop/development.html) and configure
+it using `extend_config`.
+
+When Standard encounters an `extend_config` property, it will merge your
+configuration files with Standard's base ruleset. To prevent Standard's built-in
+rules from being modified, any configuration of rules includued in the `rubocop`
+or `rubocop-performance` gems will be ignored. Most settings under `AllCops:`
+can be configured, however, unless they'd conflict with a setting used by
+Standard (like `TargetRubyVersion`) or prevent Standard's own rules from running
+(like `StyleGuideCopsOnly`). If you specify multiple YAML files under
+`extend_config`, note that their resulting RuboCop configurations will be merged
+in order (i.e.  last-in-wins).
+
+If you find that Standard's `extend_config` feature doesn't meet your needs,
+Evil Martians also maintains [a regularly updated
+guide](https://evilmartians.com/chronicles/rubocoping-with-legacy-bring-your-ruby-code-up-to-standard)
+on how to configure RuboCop to load and execute Standard's ruleset.
+
 ## How do I change the output?
 
 Standard's built-in formatter is intentionally minimal, printing only unfixed
@@ -492,13 +570,6 @@ either:
   gem to your build, which will automatically ensure that the comment is
   prepended for every applicable file in your project
 
-## How do I use Standard with RuboCop extensions?
-
-This is not officially supported by Standard. However, Evil Martians wrote up [a
-regularly updated
-guide](https://evilmartians.com/chronicles/rubocoping-with-legacy-bring-your-ruby-code-up-to-standard)
-on how to do so.
-
 ## How often is Standard updated?
 
 We aim to update Standard once a month, in the first week of the month. In between releases, we'll be considering RuboCop updates, RuboCop Performance updates, and community contributions.

data/config/base.yml

@@ -1269,6 +1269,7 @@ Style/EmptyCaseCondition:
 
 Style/EmptyElse:
   Enabled: true
+  AllowComments: true
   EnforcedStyle: both
 
 Style/EmptyHeredoc:

data/lib/standard/creates_config_store/merges_user_config_extensions.rb

@@ -0,0 +1,67 @@
+require_relative "../file_finder"
+
+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
+      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 merge_extended_rules_into_standard!(options_config, extended_config)
+      except(extended_config, options_config.keys).each do |key, value|
+        options_config[key] = value
+      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
+
+    # 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 except(hash_or_config, keys)
+      hash_or_config.to_h.reject { |key, _| keys.include?(key) }.to_h
+    end
+  end
+end

data/lib/standard/creates_config_store.rb

@@ -3,6 +3,7 @@ require "rubocop"
 require_relative "creates_config_store/assigns_rubocop_yaml"
 require_relative "creates_config_store/sets_target_ruby_version"
 require_relative "creates_config_store/configures_ignored_paths"
+require_relative "creates_config_store/merges_user_config_extensions"
 
 module Standard
   class CreatesConfigStore
@@ -10,6 +11,7 @@ module Standard
       @assigns_rubocop_yaml = AssignsRubocopYaml.new
       @sets_target_ruby_version = SetsTargetRubyVersion.new
       @configures_ignored_paths = ConfiguresIgnoredPaths.new
+      @merges_user_config_extensions = MergesUserConfigExtensions.new
     end
 
     def call(standard_config)
@@ -17,6 +19,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)
+        @merges_user_config_extensions.call(options_config, standard_config)
       end
     end
   end

data/lib/standard/loads_runner.rb

@@ -1,9 +1,23 @@
+require_relative "runners/rubocop"
+require_relative "runners/version"
+require_relative "runners/verbose_version"
+require_relative "runners/lsp"
+require_relative "runners/genignore"
+require_relative "runners/help"
+
 module Standard
   class LoadsRunner
-    # Warning: clever metaprogramming. 99% of the time this is Runners::Rubocop
+    RUNNERS = {
+      rubocop: ::Standard::Runners::Rubocop,
+      version: ::Standard::Runners::Version,
+      verbose_version: ::Standard::Runners::VerboseVersion,
+      lsp: ::Standard::Runners::Lsp,
+      genignore: ::Standard::Runners::Genignore,
+      help: ::Standard::Runners::Help
+    }.freeze
+
     def call(command)
-      require_relative "runners/#{command}"
-      ::Standard::Runners.const_get(command.to_s.capitalize).new
+      RUNNERS[command].new
     end
   end
 end

data/lib/standard/loads_yaml_config.rb

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

data/lib/standard/merges_settings.rb

@@ -20,7 +20,7 @@ module Standard
 
     def separate_argv(argv)
       argv.partition do |flag|
-        ["--generate-todo", "--fix", "--no-fix", "--version", "-v", "--help", "-h", "--lsp"].include?(flag)
+        ["--generate-todo", "--fix", "--no-fix", "--version", "-v", "--verbose-version", "-V", "--help", "-h", "--lsp"].include?(flag)
       end
     end
 
@@ -39,6 +39,8 @@ module Standard
         :help
       elsif (argv & ["--version", "-v"]).any?
         :version
+      elsif (argv & ["--verbose-version", "-V"]).any?
+        :verbose_version
       elsif (argv & ["--generate-todo"]).any?
         :genignore
       elsif (argv & ["--lsp"]).any?

data/lib/standard/runners/help.rb

@@ -15,6 +15,7 @@ module Standard
             --generate-todo   Create a .standard_todo.yml that lists all the files that contain errors
             --lsp             Start a LSP server listening on STDIN
             -v, --version     Print the version of Standard
+            -V, --verbose-version   Print the version of Standard and its dependencies.
             -h, --help        Print this message
             FILE              Files to lint [default: ./]
 

data/lib/standard/runners/verbose_version.rb

@@ -0,0 +1,14 @@
+require_relative "rubocop"
+
+module Standard
+  module Runners
+    class VerboseVersion
+      def call(config)
+        puts <<-MSG.gsub(/^ {10}/, "")
+          Standard version: #{Standard::VERSION}
+          RuboCop version:  #{RuboCop::Version.version(debug: true)}
+        MSG
+      end
+    end
+  end
+end

data/lib/standard/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard
 version: !ruby/object:Gem::Version
-  version: 1.21.1
+  version: 1.22.1
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-04 00:00:00.000000000 Z
+date: 2023-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -95,6 +95,7 @@ files:
 - lib/standard/creates_config_store.rb
 - lib/standard/creates_config_store/assigns_rubocop_yaml.rb
 - lib/standard/creates_config_store/configures_ignored_paths.rb
+- lib/standard/creates_config_store/merges_user_config_extensions.rb
 - lib/standard/creates_config_store/sets_target_ruby_version.rb
 - lib/standard/detects_fixability.rb
 - lib/standard/file_finder.rb
@@ -112,6 +113,7 @@ files:
 - lib/standard/runners/help.rb
 - lib/standard/runners/lsp.rb
 - lib/standard/runners/rubocop.rb
+- lib/standard/runners/verbose_version.rb
 - lib/standard/runners/version.rb
 - lib/standard/version.rb
 - standard.gemspec
@@ -133,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby Style Guide, with linter & automatic code fixer