standard 1.5.0 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 981607eacda9cd109ef6934f2aec50efef936e8c2f8c999e0ff2d09a2d71590a
-  data.tar.gz: 45263d2025da0a33aed7a6fb213942601f4b3e4cf542cd0a44de8b1f32df9cc3
+  metadata.gz: cc13abf56075fe1b821e69ca788e40bccf21a01458814c2abe4d3f6a0f8fd404
+  data.tar.gz: 0c4cfe676dc344656459b505ac12fa10aa396c66bf2aa9ebbab03c54e2d92f40
 SHA512:
-  metadata.gz: 40c29eed2f16d6698b779672977ee76ddc895463c92aaedc185e70263a41569e9ab7c1f3fddc5a7f3a84cb1ab4be3ca695939b8a5ed1df9a6bb427459af9d83b
-  data.tar.gz: f43c126937613621c350a47583bd1f3c2c71a79d6bbd9f1524a1bb03abc9318ae23356d4425cfa36610cbb3a1f546c340dbf82b0707ef5f02780c38abd630ac1
+  metadata.gz: 6ae3c11e890df971bb8ad8e268bbf75a5ad42800d3646d7e4f8df22b2edc0e7d586afa7732368061c4f69a02ed083cad94dd3b4466c9fd6e6db88bc6ec05d6b6
+  data.tar.gz: b38cd26460d5f5c094d790e8f6ed0fa3257f64b8ac48a81b632696a17945e53b2daf7b51978ea4ef1a40623a0e4be6fc664e26d87dadbdc37c8107c7ecb13b83

data/.github/workflows/test.yml

@@ -5,6 +5,10 @@ on:
     branches: [ main ]
   pull_request:
     branches: [ main ]
+  workflow_run:
+    workflows: ["Update"]
+    types:
+      - completed
 
 jobs:
   test:
@@ -12,7 +16,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest ]
-        ruby-version: [2.5, 2.6, 2.7, 3.0]
+        ruby-version: [2.6, 2.7, '3.0', 3.1]
 
     runs-on: ${{ matrix.os }}
 

data/.standard.yml

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

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 1.7.2
+
+* Removes Style/RedundantBegin from Ruby versions <= 2.4
+
+## 1.7.1
+
+* Update rubocop from 1.25.0 to [1.25.1](https://github.com/rubocop/rubocop/tag/v1.25.1)
+
+## 1.7.0
+
+* Update rubocop-performance from 1.13.1 to [1.13.2](https://github.com/rubocop/rubocop-performance/tag/v1.13.2)
+* Update rubocop from 1.24.1 to [1.25.0](https://github.com/rubocop/rubocop/tag/v1.25.0)
+
+## 1.6.0
+
+* Update rubocop-performance from 1.12.0 to [1.13.1](https://github.com/rubocop/rubocop-performance/tag/v1.13.1)
+* Update rubocop from 1.23.0 to [1.24.1](https://github.com/rubocop/rubocop/tag/v1.24.1)
+
 ## 1.5.0
 
 * Update rubocop-performance from 1.11.5 to [1.12.0](https://github.com/rubocop/rubocop-performance/tag/v1.12.0)

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    standard (1.5.0)
-      rubocop (= 1.23.0)
-      rubocop-performance (= 1.12.0)
+    standard (1.7.2)
+      rubocop (= 1.25.1)
+      rubocop-performance (= 1.13.2)
 
 GEM
   remote: https://rubygems.org/
@@ -13,29 +13,29 @@ GEM
     docile (1.4.0)
     gimme (0.5.0)
     method_source (1.0.0)
-    minitest (5.14.4)
+    minitest (5.15.0)
     parallel (1.21.0)
-    parser (3.0.3.1)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
-    rubocop (1.23.0)
+    rubocop (1.25.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.13.0)
+    rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
-    rubocop-performance (1.12.0)
+    rubocop-performance (1.13.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
@@ -61,4 +61,4 @@ DEPENDENCIES
   standard!
 
 BUNDLED WITH
-   2.2.22
+   2.3.4

data/README.md

@@ -14,17 +14,16 @@ to save you (and others!) time in the same three ways:
 * **Catch style issues & programmer errors early.** Save precious code review
   time by eliminating back-and-forth between reviewer & contributor.
 
-No decisions to make. It just works. Here's a [⚡ lightning talk ⚡](https://www.youtube.com/watch?v=uLyV5hOqGQ8) about it.
+No decisions to make. It just works. Here's a [⚡ lightning talk
+⚡](https://www.youtube.com/watch?v=uLyV5hOqGQ8) about it.
 
-Install by adding it to your Gemfile:
+Install Standard by adding it to your Gemfile and running `bundle install`:
 
 ```ruby
 gem "standard", group: [:development, :test]
 ```
 
-And running `bundle install`.
-
-Run Standard from the command line with:
+You can then run Standard from the command line with:
 
 ```ruby
 $ bundle exec standardrb
@@ -33,6 +32,14 @@ $ bundle exec standardrb
 And if you'd like, Standard can autocorrect your code by tacking on a `--fix`
 flag.
 
+If your project uses Rake, adding `require "standard/rake"` adds two tasks:
+`standard` and `standard:fix`. In most new projects, we tend to add the fixer
+variant to our default `rake` task after our test command, similar to this:
+
+```ruby
+task default: [:test, "standard:fix"]
+```
+
 ## StandardRB — The Rules
 
 - **2 spaces** – for indentation
@@ -73,8 +80,8 @@ standard: Run `standardrb --fix` to automatically fix some problems.
   /Users/code/cli.rb:31:23: Style/Semicolon: Do not use semicolons to terminate expressions.
 ```
 
-You can optionally pass in a directory (or directories) using the glob pattern. Be
-sure to quote paths containing glob patterns so that they are expanded by
+You can optionally pass in a directory (or directories) using a glob pattern.
+Be sure to quote paths containing glob patterns so that they are expanded by
 `standardrb` instead of your shell:
 
 ```bash
@@ -84,19 +91,20 @@ $ bundle exec standardrb "lib/**/*.rb" test
 **Note:** by default, StandardRB will look for all `*.rb` files (and some other
 files typically associated with Ruby like `*.gemspec` and `Gemfile`)
 
-If you have an existing project but aren't ready to fix all the files yet you can
-generate a todo file:
+If you want to add Standard to an existing project, but don't want to stop all
+development until you've fixed every violation in every file, you can create a
+backlog of to-be-converted files by generating a TODO file:
 
 ```bash
 $ bundle exec standardrb --generate-todo
 ```
 
-This will create a `.standard_todo.yml` that lists all the files that contain errors.
-When you run Standard in the future it will ignore these files as if they lived under the
-`ignore` section in the `.standard.yml` file.
+This will create a `.standard_todo.yml` that lists all the files that contain
+errors. When you run Standard in the future, it will ignore these files as if
+they were listed under the `ignore` section in the `.standard.yml` file.
 
-As you refactor your existing project you can remove files from the list.  You can
-also regenerate the todo file at any time by re-running the above command.
+As you refactor your existing project you can remove files from the list. You
+can also regenerate the TODO file at any time by re-running the above command.
 
 ### Using with Rake
 
@@ -151,9 +159,8 @@ ignore:                 # default: []
 Note: If you're running Standard in a context where your `.standard.yml` file
 cannot be found by ascending the current working directory (i.e., against a
 temporary file buffer in your editor), you can specify the config location with
-`--config path/to/.standard.yml`.
-
-Similarly, for the `.standard_todo.yml` file, you can specify `--todo path/to/.standard_todo.yml`.
+`--config path/to/.standard.yml`. (Similarly, for the `.standard_todo.yml` file,
+you can specify `--todo path/to/.standard_todo.yml`.)
 
 ## What you might do if you're REALLY clever
 
@@ -190,20 +197,17 @@ community conventions higher than personal style. This might not make sense for
 place for newbies. Setting up clear, automated contributor expectations makes a
 project healthier.
 
-## Usage via rubocop
+## Usage via RuboCop
 
-If you only want to use the rules and not the cli (to keep current IDE/tooling/workflow support).
-It needs to repeat `AllCops` because of a [rubocop issue](https://github.com/rubocop/rubocop/issues/10175).
-Change your `.rubocop.yml` to:
+If you only want to use Standard's rules while continuing to use RuboCop's CLI
+(for example, to continue using your favorite IDE/tooling/workflow with RuboCop
+support), you can configure this in your `.rubocop.yml`:
 
 ```yaml
 require: standard
 
 inherit_gem:
   standard: config/base.yml
-
-AllCops:
-  DisabledByDefault: true
 ```
 
 ## Who uses Ruby Standard Style?
@@ -213,27 +217,27 @@ familiar](https://github.com/standard/standard#who-uses-javascript-standard-styl
 if you've used StandardJS.)
 
 * [Test Double](https://testdouble.com/agency)
+* [Amazon Web Services](https://aws.amazon.com/)
+* [Babylist](https://www.babylist.com/)
+* [Brand New Box](https://brandnewbox.com)
+* [Brave Software](https://github.com/brave-intl/publishers)
 * [Collective Idea](https://collectiveidea.com/)
 * [Culture Foundry](https://www.culturefoundry.com/)
+* [Envoy](https://www.envoy.com)
 * [Evil Martians](https://evilmartians.com)
-* [Rebase Interactive](https://www.rebaseinteractive.com/)
 * [Hashrocket](https://hashrocket.com)
-* [Brand New Box](https://brandnewbox.com)
-* [Monterail](https://www.monterail.com)
-* [Level UP Solutions](https://levups.com)
 * [Honeybadger](https://www.honeybadger.io)
-* [Amazon Web Services](https://aws.amazon.com/)
-* [Envoy](https://www.envoy.com)
-* [myRent](https://www.myrent.co.nz)
-* [Renuo](https://www.renuo.ch/)
 * [JetThoughts](https://www.jetthoughts.com/)
+* [Level UP Solutions](https://levups.com)
+* [Monterail](https://www.monterail.com)
+* [myRent](https://www.myrent.co.nz)
 * [Oyster](https://www.oysterhr.com/)
+* [Planet Argon](https://www.planetargon.com/)
 * [Podia](https://www.podia.com/)
+* [Rebase Interactive](https://www.rebaseinteractive.com/)
+* [Renuo](https://www.renuo.ch/)
 * [RubyCI](https://ruby.ci)
 * [thoughtbot](https://thoughtbot.com/)
-* [Planet Argon](https://www.planetargon.com/)
-* [Brave Software](https://github.com/brave-intl/publishers)
-* And that's about it so far!
 
 If your team starts using Standard, [send a pull
 request](https://github.com/testdouble/standard/edit/main/README.md) to let us
@@ -431,15 +435,50 @@ feedback loop. Some editors support asynchronously running linters.
 - [vim (via ALE)](https://github.com/testdouble/standard/wiki/IDE:-vim)
 - [VS Code](https://github.com/testdouble/standard/wiki/IDE:-vscode)
 
-## 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.
+## Why aren't `frozen_string_literal: true` magic comments enforced?
+
+Standard does not take a stance on whether you should plaster a
+[frozen_string_literal magic
+comment](https://docs.ruby-lang.org/en/3.0/doc/syntax/comments_rdoc.html#label-Magic+Comments)
+directive at the top of every file. Enforcing use of the comment became popular
+when it was believed that string literals would be frozen by default in a future
+version of Ruby, but [according to
+Matz](https://bugs.ruby-lang.org/issues/11473#note-53) there are no (longer any)
+such plans.
+
+Aside from one's personal opinion on the degree to which the comment is an
+eyesore, the decision to include the magic comment at the top of every file
+listing ought to be made based on the performance characteristics of each
+project (e.g. whether it defines a significant number of string literals,
+whether the commensurate memory usage is a material constraint, whether the code
+is run as a one-off command or a long-lived server application). These tend to
+indicate whether the magic comment might lead to meaningful reductions in memory
+usage.
+
+Because Standard is intended to be used as a default for every kind of Ruby
+file—from shell scripts to Rails apps—it wouldn't be appropriate for Standard to
+either enforce or preclude the magic comment. Instead, you might consider
+either:
+
+* Measuring memory performance by enabling frozen string literals as
+  the default at runtime (with `RUBYOPT=--enable-frozen-string-literal`)
+* Introducing the
+  [magic_frozen_string_literal](https://github.com/Invoca/magic_frozen_string_literal)
+  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.
 
 ## Does Standard work with [Insert other tool name here]?
 
-Maybe! Start by searching the repository to see if there's an existing issue open for
-the tool you're interested in. That aside, here are other known integrations aside
-from editor plugins:
+Maybe! Start by searching the repository to see if there's an existing issue
+open for the tool you're interested in. That aside, here are other known
+integrations aside from editor plugins:
 
 * [Code Climate](https://github.com/testdouble/standard/wiki/CI:-Code-Climate)
 * [Pronto](https://github.com/julianrubisch/pronto-standardrb)

data/config/base.yml

@@ -801,7 +801,7 @@ Lint/Void:
   CheckForMethodsWithNoSideEffects: false
 
 Lint/IncompatibleIoSelectWithFiberScheduler:
-  Enabled: false
+  Enabled: true
 
 Lint/RequireRelativeSelfPath:
   Enabled: true
@@ -896,6 +896,9 @@ Naming/VariableName:
 Naming/VariableNumber:
   Enabled: false
 
+Naming/BlockForwarding:
+  Enabled: false
+
 Performance/AncestorsInclude:
   Enabled: false
 
@@ -1045,6 +1048,9 @@ Performance/UriDefaultParser:
 Performance/ConcurrentMonotonicTime:
   Enabled: true
 
+Performance/StringIdentifierArgument:
+  Enabled: true
+
 Security/Eval:
   Enabled: true
 
@@ -1307,6 +1313,7 @@ Style/HashLikeCase:
 Style/HashSyntax:
   Enabled: true
   EnforcedStyle: ruby19_no_mixed_keys
+  EnforcedShorthandSyntax: either
 
 Style/HashTransformKeys:
   Enabled: false
@@ -1824,3 +1831,11 @@ Style/SelectByRegexp:
 Style/OpenStructUse:
   Enabled: false
 
+Style/MapToHash:
+  Enabled: false
+
+Style/FileWrite:
+  Enabled: true
+
+Style/FileRead:
+  Enabled: true

data/config/ruby-1.8.yml

@@ -5,3 +5,9 @@ Style/HashSyntax:
 
 Style/Lambda:
   Enabled: false
+
+Style/FileWrite:
+  Enabled: false
+
+Style/FileRead:
+  Enabled: false

data/config/ruby-2.4.yml

@@ -2,3 +2,6 @@ inherit_from: ./ruby-2.5.yml
 
 AllCops:
   TargetRubyVersion: 2.5 # The oldest supported
+
+Style/RedundantBegin:
+  Enabled: false

data/config/ruby-3.0.yml

@@ -0,0 +1,10 @@
+inherit_from: ./base.yml
+
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/HashExcept:
+  Enabled: true
+
+Naming/BlockForwarding:
+  Enabled: false

data/lib/standard/creates_config_store/assigns_rubocop_yaml.rb

@@ -4,7 +4,7 @@ class Standard::CreatesConfigStore
   class AssignsRubocopYaml
     def call(config_store, standard_config)
       config_store.options_config = rubocop_yaml_path(standard_config[:ruby_version])
-      config_store.instance_variable_get("@options_config")
+      config_store.instance_variable_get(:@options_config)
     end
 
     private

data/lib/standard/version.rb

@@ -1,3 +1,3 @@
 module Standard
-  VERSION = Gem::Version.new("1.5.0")
+  VERSION = Gem::Version.new("1.7.2")
 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.5.0"
+  spec.required_ruby_version = ">= 2.6.0"
 
   spec.summary = "Ruby Style Guide, with linter & automatic code fixer"
   spec.homepage = "https://github.com/testdouble/standard"
@@ -19,6 +19,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rubocop", "1.23.0"
-  spec.add_dependency "rubocop-performance", "1.12.0"
+  spec.add_dependency "rubocop", "1.25.1"
+  spec.add_dependency "rubocop-performance", "1.13.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.2
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-02 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: 1.25.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.13.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.13.2
 description:
 email:
 - searls@gmail.com
@@ -68,6 +68,7 @@ files:
 - config/ruby-2.5.yml
 - config/ruby-2.6.yml
 - config/ruby-2.7.yml
+- config/ruby-3.0.yml
 - docs/RELEASE.md
 - exe/standardrb
 - lib/standard.rb
@@ -105,14 +106,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Ruby Style Guide, with linter & automatic code fixer