google-style 0.3.1 → 1.25.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3766fcaa700233899393457f859fd5c4f185a1e50913738e22e9d37415613ca4
-  data.tar.gz: 224221a70e56e52846c158e9417d9bbe944fe5fcb2ca3d564e2c56a8ecf62bf1
+  metadata.gz: 642e8669ef6ba1abaf3f85c254735d0282f39dbdc3b09335a3bfdb0d8112909e
+  data.tar.gz: f9bec1c16dda8668e61e272f8d1e9c3137bfa843bc4ccedd3d0cb5c24c69338a
 SHA512:
-  metadata.gz: 9b9be7e30cdaa4a52728bef817b3957a43c2912b60c1627a35a94cf1ed4504891d4bde133c4a7b17a15df64c1a44b77013a38dfc00528b6024fe561700de6d55
-  data.tar.gz: 9324def8ed182cada27e08a0fd98a7766bda0f0ace71dba848d6857cde9d2a2bdd0a697080f80caa3f633a88a56505e06eaae3adbea410ac445969e8ec6b9c58
+  metadata.gz: dfcfe24caf4cf56e27f5368cc7054f8ca63a8073ca8eb3f8f8e916496bafb6e52a479b8458c607e3ee03ec2e246bf19eadd582ad6bd03824550994252da89ca7
+  data.tar.gz: ef48b6b27a48bf78501f0d9dee7a771943a1dfadb98c9916aaa158ca6846e735c5446f0a194b2f7ad2eaa87907ce109dd16b38d90a093c977380e5c96bdba35a

data/README.md

@@ -31,17 +31,27 @@ And run:
 bundle exec rubocop
 ```
 
+## Versioning
+
+For all `1.x.x` gem versions:
+
+- The target and required Ruby version will match the minor gem version. `1.24.0` targets Ruby 2.4. When `1.25.0` is released, it will target Ruby 2.5, and `1.30.0` will target Ruby 3.0.
+
+- During a minor version bump, the rubocop dependency will be updated to the latest version.
+
+- For these reasons, it is highly recommended that dependencies specify at least a specific minor version of this gem.
+
 ## Contributing
 
 Contributions to this library are always welcome and highly encouraged.
 
-See the [Contributing
-Guide](CONTRIBUTING.md)
+See the {file:CONTRIBUTING.md Contributing
+Guide}
 for more information on how to get started.
 
 Please note that this project is released with a Contributor Code of Conduct. By
-participating in this project you agree to abide by its terms. See the [Code of
-Conduct](CODE_OF_CONDUCT.md)
+participating in this project you agree to abide by its terms. See the {file:CODE_OF_CONDUCT.md Code of
+Conduct}
 for more information.
 
 ## License
@@ -51,11 +61,12 @@ This library is licensed under Apache 2.0. Full license text is available in
 
 ## Supported Ruby Versions
 
-These libraries are currently supported on Ruby 2.3+.
+These libraries are currently supported on Ruby 2.4+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.3
-and later. Older versions of Ruby _may_ still work, but are unsupported and not
-recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
-about the Ruby support schedule.
+in security maintenance, and not end of life. Currently, this means Ruby 2.4
+and later. Starting with Ruby 2.4, minor releases of the google-style gem under
+`1.x.x` will correspond with the required Ruby version, with `1.24.x` requiring
+Ruby 2.4.
+See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.

data/google-style.yml

@@ -1,11 +1,11 @@
 # Copyright 2019 Google LLC
-
+#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-
+#
 #     https://www.apache.org/licenses/LICENSE-2.0
-
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -13,47 +13,225 @@
 # limitations under the License.
 
 AllCops:
-  TargetRubyVersion: 2.3
-Layout/AlignHash:
-  EnforcedHashRocketStyle: table
-  EnforcedColonStyle: table
+  NewCops: disable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.5
+
+# Enforcing a blank line often worsens vertical layout.
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
-Layout/EmptyLines: # for the extra line between copyright and code
+
+# For the extra line between copyright and code.
+Layout/EmptyLines:
+  Enabled: false
+
+# This tends to be problematic, especially for nested hashes. In many cases,
+# our code adheres to the "table" style, but we do not want to enforce it.
+Layout/HashAlignment:
   Enabled: false
+
+# Our current preferred line length.
+Layout/LineLength:
+  Max: 120
+
+# Added in Rubocop 1.7
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+
+# Added in Rubocop 1.7
+Lint/AmbiguousAssignment:
+  Enabled: true
+
+# Added in Rubocop 1.8
+Lint/DeprecatedConstants:
+  Enabled: true
+
+# Added in Rubocop 1.3
+Lint/DuplicateBranch:
+  Enabled: true
+
+# Added in Rubocop 1.1
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+
+# Added in Rubocop 1.1
+Lint/EmptyBlock:
+  Enabled: true
+
+# Added in Rubocop 1.3
+Lint/EmptyClass:
+  Enabled: true
+
+# Added in Rubocop 1.8
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+
+# Added in Rubocop 1.2
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+
+# Added in Rubocop 1.9
+Lint/NumberedParameterAssignment:
+  Enabled: true
+
+# Added in Rubocop 1.9
+Lint/OrAssignmentToConstant:
+  Enabled: true
+
+# Added in Rubocop 1.8
+Lint/RedundantDirGlobSort:
+  Enabled: true
+
+# Added in Rubocop 1.9
+Lint/SymbolConversion:
+  Enabled: true
+
+# Added in Rubocop 1.1
+Lint/ToEnumArguments:
+  Enabled: true
+
+# Added in Rubocop 1.9
+Lint/TripleQuotes:
+  Enabled: true
+
+# Added in Rubocop 1.5
+Lint/UnexpectedBlockArity:
+  Enabled: true
+
+# Added in Rubocop 1.1
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+
 Metrics/AbcSize:
   Max: 30
+
 Metrics/CyclomaticComplexity:
   Max: 10
-Metrics/LineLength:
-  Max: 120
+
 Metrics/MethodLength:
   Max: 25
+
+# Sometimes problematic for API calls which might have a lot of parameters,
+# and for generated code.
 Metrics/ParameterLists:
   Enabled: false
+
 Metrics/PerceivedComplexity:
   Max: 10
+
+# Does not allow distinguishing verbs (e.g. is vs has). Also causes problems
+# for generated code that might have generated method names.
+Naming/PredicateName:
+  Enabled: false
+
+# Numbers are occasionally semantically useful in names, and also occasionally
+# appear in generated code.
 Naming/VariableNumber:
   Enabled: false
+
+# Better to separate accessors for yardoc and type declarations.
+Style/AccessorGrouping:
+  EnforcedStyle: separated
+
+# Added in Rubocop 1.1
+Style/ArgumentsForwarding:
+  Enabled: true
+
+# Problematic for generated code which might include unicode in comments.
+Style/AsciiComments:
+  Enabled: false
+
+# There are cases where we use the === operator as a general interface, e.g.
+# when specifying type checker objects.
+Style/CaseEquality:
+  Enabled: false
+
+# Added in Rubocop 1.2
+Style/CollectionCompact:
+  Enabled: true
+
+# Added in Rubocop 1.1
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+
+# We prefer consistent method indentation.
 Style/EmptyMethod:
   EnforcedStyle: expanded
+
+# Added in Rubocop 1.8
+Style/EndlessMethod:
+  Enabled: true
+
+# Frozen string literals are no more as of Ruby 3.
 Style/FrozenStringLiteralComment:
   Enabled: false
-Style/MethodCallWithArgsParentheses:
+
+# Added in Rubocop 1.7
+Style/HashExcept:
   Enabled: true
-  EnforcedStyle: omit_parentheses
-  AllowParenthesesInMultilineCall: true
+
+# It is sometimes preferable to use the non-modifier form even for single-line
+# expressions, for readability.
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Added in Rubocop 1.9
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+
+# We adopt Seattle-style paren usage
+Style/MethodCallWithArgsParentheses:
   AllowParenthesesInCamelCaseMethod: true
   AllowParenthesesInChaining: true
+  AllowParenthesesInMultilineCall: true
+  Enabled: true
+  EnforcedStyle: omit_parentheses
+
+# We adopt Seattle-style paren usage
 Style/MethodDefParentheses:
   EnforcedStyle: require_no_parentheses
+
+# Enable use of the different semantics of module_function and extend self.
+Style/ModuleFunction:
+  Enabled: false
+
+# Added in Rubocop 1.2
+Style/NegatedIfElseCondition:
+  Enabled: true
+
+# Added in Rubocop 1.3
+Style/NilLambda:
+  Enabled: true
+
+# Added in Rubocop 1.4
+Style/RedundantArgument:
+  Enabled: true
+
+# Disabled because we prefer to keep begin-end blocks in memoization for
+# readability (see https://github.com/rubocop/rubocop/pull/9602).
+Style/RedundantBegin:
+  Enabled: false
+
+# The idiom is useful in a variety of cases. We prefer to allow it.
 Style/RescueModifier:
   Enabled: false
+
+# We prefer standardizing on double-quoted strings for readability.
 Style/StringLiterals:
   EnforcedStyle: double_quotes
+
+# Added in Rubocop 1.1
+Style/SwapValues:
+  Enabled: true
+
+# We prefer traditional bracket style for all arrays.
 Style/SymbolArray:
   EnforcedStyle: brackets
+
+# There are some cases where a full method shows intent better than an attr.
 Style/TrivialAccessors:
   Enabled: false
+
+# We prefer traditional bracket style for all arrays.
 Style/WordArray:
   EnforcedStyle: brackets

data/lib/google/style/version.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Style
+    VERSION = "1.25.2"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-style
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.25.2
 platform: ruby
 authors:
 - Graham Paye
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.64.0
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.64.0
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -64,7 +64,8 @@ files:
 - LICENSE
 - README.md
 - google-style.yml
-homepage: https://github.com/googleapis/ruby-style/tree/master/
+- lib/google/style/version.rb
+homepage: https://github.com/googleapis/ruby-style/
 licenses:
 - Apache-2.0
 metadata: {}
@@ -76,15 +77,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: Collection of rubocop rules