standard 1.22.0 → 1.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0be084d42bce81134fcc2055df53cd9a3b639814b7e64f91e3c2e05faa4675ce
-  data.tar.gz: f4c0f98c8b6597cbd136e2990f50767892ba2797d9b351ec8e3e277ff7d67910
+  metadata.gz: f79913870ce4e07e94a76c49bfdb2bdf671b72cfe28b9c8d23d3dcfe723b9093
+  data.tar.gz: 1fbbe5ecbb1b9b093997cf96f4102c089305ef35f5bf0523406924120cb5906e
 SHA512:
-  metadata.gz: 1e9a9a9912071e338b36f0e4db34a8077c896fa6356d3ffa31a064a5ce7201d31a778895fbf051003640dcd92b837456202487c8b275236457063b451dc5c752
-  data.tar.gz: c4923a5c46669684793406b8dd70ce9b0d8f974fd280f846da920e018613e292ac235137254cb17b8c15ea8eebcf5da0c059602dce83a2b95df99f98760a6626
+  metadata.gz: 19e734ff2ab15102430f2cd927ef9beed5c403b6e7b30804bb8baf23d83978ffdfeec3324482d957daae0bd7efbbc7ebcd9bce9bc9f9a84e81c85839c2f30eb0
+  data.tar.gz: a3135a540a166b292633aa3e2adb11854f09b67fa07dccbc5199de73efa5d289b4612b10917481791563105bdc815a89e7912e054a737428fb55c25c32cfe0bb

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # 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)

data/Gemfile.lock

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

data/README.md

@@ -219,6 +219,7 @@ 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)
@@ -402,18 +403,49 @@ work for older Rubies.
 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:
+`.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
 ```
 
-Which in turn would refer to a RuboCop configuration file:
+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
 
@@ -427,15 +459,20 @@ Betterment/UnscopedFind:
     - SystemConfiguration
 ```
 
-When Standard runs, it will merge your configuration files with Standard's base
-ruleset. To ensure that this feature does not result in Standard's rules being
-modified, any configuration of rules includued in `rubocop` or
-`rubocop-performance` will be ignored. Most settings under `AllCops:` can be
-configured, 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).
+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

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

@@ -6,27 +6,31 @@ class Standard::CreatesConfigStore
       "Include",
       "Exclude",
       "StyleGuideCopsOnly",
-      "TargetRubyVersion"
+      "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(standard_config)
+      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(standard_config)
-      {
-        "AllCops" => {}
-      }.tap do |config|
-        standard_config[:extend_config].each do |path|
-          extension = RuboCop::ConfigLoader.load_file(Standard::FileFinder.new.call(path, Dir.pwd)).to_h
-          config["AllCops"].merge!(extension["AllCops"]) if extension.key?("AllCops")
-          config.merge!(except(extension, ["AllCops"]))
+    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
@@ -43,8 +47,21 @@ class Standard::CreatesConfigStore
       end
     end
 
-    def except(hash, keys)
-      hash.reject { |key, _| keys.include?(key) }.to_h
+    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/version.rb

@@ -1,3 +1,3 @@
 module Standard
-  VERSION = Gem::Version.new("1.22.0")
+  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.22.0
+  version: 1.22.1
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-14 00:00:00.000000000 Z
+date: 2023-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -135,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