standard 1.7.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd2d4eaef4d46d84e027738a55cc6734883fb098ddbd5ea4911fb871578097b5
-  data.tar.gz: 8098c55b94370d7c977cf9d592a9e4285c62b9378d96ffb3daa57513acd04299
+  metadata.gz: a9d7e41be999895d2ccd72d50fd5023792af89a2e0456ebadf233d1bab9769e2
+  data.tar.gz: 1a5387cefbf33539d46001b751ea9a7ad800d6dcc940f422421097e561dcba00
 SHA512:
-  metadata.gz: '0495bf123db9cd15aab84de44efd8b5b4dcbfc68c5cd52fffcd94c5f417606245290cfb17f776a110b88c4f70b2fd974ee9a176ae9f8f07a4906311ef1a7d27c'
-  data.tar.gz: fa8bba48d7c55b3a10fd317783b8d9f62855d1d0c38f6a83b40449f69076bfb19559b5c2add7129bd96a3ab73f3c1477f4acac8ebb68091595b1803770f9fda8
+  metadata.gz: 9174f67d57161c8b3cd8942f67399a3260e8c86e232c7e82c7d865ae147bc50eec2eece52bec727dddf336ac64e24311ba0d933c5432491da364fda3ad4cc70a
+  data.tar.gz: 84d4bb6c00601685030464d0d89c432ce4ae15d6f7b3d43a592b424b86b950efd0a43236957de51cb7fd52049491b3f3fda0db09985d51a9e09adad3b82579b5

data/.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest ]
-        ruby-version: [2.5, 2.6, 2.7, '3.0', 3.1]
+        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,9 @@
 # Changelog
 
+## 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)

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    standard (1.7.0)
-      rubocop (= 1.25.0)
+    standard (1.7.1)
+      rubocop (= 1.25.1)
       rubocop-performance (= 1.13.2)
 
 GEM
@@ -24,7 +24,7 @@ GEM
     rake (13.0.6)
     regexp_parser (2.2.0)
     rexml (3.2.5)
-    rubocop (1.25.0)
+    rubocop (1.25.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)

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,10 +197,11 @@ 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).
-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
@@ -230,7 +238,6 @@ if you've used StandardJS.)
 * [Renuo](https://www.renuo.ch/)
 * [RubyCI](https://ruby.ci)
 * [thoughtbot](https://thoughtbot.com/)
-* 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
@@ -428,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/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.7.0")
+  VERSION = Gem::Version.new("1.7.1")
 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.25.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.7.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.25.0
+        version: 1.25.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.25.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -106,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