Rename new SupportedShorthandSyntax from consistent_either to either_consistent

pawelma · bbatsov · commit aee64e2d5d66 · 2024-05-21T23:18:27.000+03:00
This will indicate that it works like `either` option which contains a consistency within a single hash definition. Suggested in #12904 (comment) PR comment
diff --git a/changelog/new_add_new_consistent_either.md b/changelog/new_add_new_consistent_either.md
@@ -1 +1 @@
-* [#12904](https://github.com/rubocop/rubocop/pull/12904): Add new `consistent_either` `SupportedShorthandSyntax` to `Style/HashSyntax`. ([@pawelma][])
+* [#12904](https://github.com/rubocop/rubocop/pull/12904): Add new `either_consistent` `SupportedShorthandSyntax` to `Style/HashSyntax`. ([@pawelma][])
diff --git a/config/default.yml b/config/default.yml
@@ -4070,7 +4070,7 @@ Style/HashSyntax:
     # forces use of the 3.1 syntax only if all values can be omitted in the hash.
     - consistent
     # allow either (implicit or explicit) syntax but enforce consistency within a single hash
-    - consistent_either
+    - either_consistent
   # Force hashes that have a symbol value to use hash rockets
   UseHashRocketsWithSymbolValues: false
   # Do not suggest { a?: 1 } over { :a? => 1 } in ruby19 style
diff --git a/lib/rubocop/cop/mixin/hash_shorthand_syntax.rb b/lib/rubocop/cop/mixin/hash_shorthand_syntax.rb
@@ -68,13 +68,13 @@ def register_offense(node, message, replacement) # rubocop:disable Metrics/AbcSi
 
       def ignore_mixed_hash_shorthand_syntax?(hash_node)
         target_ruby_version <= 3.0 ||
-          !%w[consistent consistent_either].include?(enforced_shorthand_syntax) ||
+          !%w[consistent either_consistent].include?(enforced_shorthand_syntax) ||
           !hash_node.hash_type?
       end
 
       def ignore_hash_shorthand_syntax?(pair_node)
         target_ruby_version <= 3.0 || enforced_shorthand_syntax == 'either' ||
-          %w[consistent consistent_either].include?(enforced_shorthand_syntax) ||
+          %w[consistent either_consistent].include?(enforced_shorthand_syntax) ||
           !pair_node.parent.hash_type?
       end
 
@@ -175,7 +175,7 @@ def hash_with_values_that_cant_be_omitted?(hash_value_type_breakdown)
 
       def ignore_explicit_omissible_hash_shorthand_syntax?(hash_value_type_breakdown)
         hash_value_type_breakdown.keys == [:value_omittable] &&
-          enforced_shorthand_syntax == 'consistent_either'
+          enforced_shorthand_syntax == 'either_consistent'
       end
 
       def each_omitted_value_pair(hash_value_type_breakdown, &block)
diff --git a/lib/rubocop/cop/style/hash_syntax.rb b/lib/rubocop/cop/style/hash_syntax.rb
@@ -29,7 +29,7 @@ module Style
       # * never - forces use of explicit hash literal value
       # * either - accepts both shorthand and explicit use of hash literal value
       # * consistent - forces use of the 3.1 syntax only if all values can be omitted in the hash
-      # * consistent_either - accepts both shorthand and explicit use of hash literal value,
+      # * either_consistent - accepts both shorthand and explicit use of hash literal value,
       #                       but they must be consistent
       #
       # @example EnforcedStyle: ruby19 (default)
@@ -112,7 +112,7 @@ module Style
       #   # good - can't omit `baz`
       #   {foo: foo, bar: baz}
       #
-      # @example EnforcedShorthandSyntax: consistent_either
+      # @example EnforcedShorthandSyntax: either_consistent
       #
       #   # good - `foo` and `bar` values can be omitted, but they are consistent, so it's accepted
       #   {foo: foo, bar: bar}
diff --git a/spec/rubocop/cli/auto_gen_config_spec.rb b/spec/rubocop/cli/auto_gen_config_spec.rb
@@ -1500,7 +1500,7 @@ def function(arg1, arg2, arg3, arg4, arg5, arg6, arg7)
           .to eq(<<~YAML)
             # Configuration parameters: EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
             # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
-            # SupportedShorthandSyntax: always, never, either, consistent, consistent_either
+            # SupportedShorthandSyntax: always, never, either, consistent, either_consistent
             Style/HashSyntax:
               EnforcedStyle: hash_rockets
           YAML
@@ -1514,7 +1514,7 @@ def function(arg1, arg2, arg3, arg4, arg5, arg6, arg7)
           .to eq(<<~YAML)
             # Configuration parameters: EnforcedStyle, EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
             # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
-            # SupportedShorthandSyntax: always, never, either, consistent, consistent_either
+            # SupportedShorthandSyntax: always, never, either, consistent, either_consistent
             Style/HashSyntax:
               Exclude:
                 - 'example1.rb'
@@ -1531,7 +1531,7 @@ def function(arg1, arg2, arg3, arg4, arg5, arg6, arg7)
           .to eq(<<~YAML)
             # Configuration parameters: EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
             # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
-            # SupportedShorthandSyntax: always, never, either, consistent, consistent_either
+            # SupportedShorthandSyntax: always, never, either, consistent, either_consistent
             Style/HashSyntax:
               Exclude:
                 - 'example1.rb'
@@ -1546,7 +1546,7 @@ def function(arg1, arg2, arg3, arg4, arg5, arg6, arg7)
           .to eq(<<~YAML)
             # Configuration parameters: EnforcedStyle, EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
             # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
-            # SupportedShorthandSyntax: always, never, either, consistent, consistent_either
+            # SupportedShorthandSyntax: always, never, either, consistent, either_consistent
             Style/HashSyntax:
               Exclude:
                 - 'example1.rb'
@@ -1583,7 +1583,7 @@ def function(arg1, arg2, arg3, arg4, arg5, arg6, arg7)
           .to eq(<<~YAML)
             # Configuration parameters: EnforcedStyle, EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
             # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
-            # SupportedShorthandSyntax: always, never, either, consistent, consistent_either
+            # SupportedShorthandSyntax: always, never, either, consistent, either_consistent
             Style/HashSyntax:
               Exclude:
                 - 'example1.rb'
diff --git a/spec/rubocop/cop/style/hash_syntax_spec.rb b/spec/rubocop/cop/style/hash_syntax_spec.rb
@@ -1683,7 +1683,7 @@ def buz(foo:, bar:); end
       {
         'EnforcedStyle' => 'ruby19',
         'SupportedStyles' => %w[ruby19 hash_rockets],
-        'EnforcedShorthandSyntax' => 'consistent_either'
+        'EnforcedShorthandSyntax' => 'either_consistent'
       }
     end
 

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-* [#12904](https://github.com/rubocop/rubocop/pull/12904): Add new `consistent_either` `SupportedShorthandSyntax` to `Style/HashSyntax`. ([@pawelma][])
	`1`	+* [#12904](https://github.com/rubocop/rubocop/pull/12904): Add new `either_consistent` `SupportedShorthandSyntax` to `Style/HashSyntax`. ([@pawelma][])
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ module Style`
`29`	`29`	`# * never - forces use of explicit hash literal value`
`30`	`30`	`# * either - accepts both shorthand and explicit use of hash literal value`
`31`	`31`	`# * consistent - forces use of the 3.1 syntax only if all values can be omitted in the hash`
`32`		`- # * consistent_either - accepts both shorthand and explicit use of hash literal value,`
	`32`	`+ # * either_consistent - accepts both shorthand and explicit use of hash literal value,`
`33`	`33`	`# but they must be consistent`
`34`	`34`	`#`
`35`	`35`	`# @example EnforcedStyle: ruby19 (default)`
`@@ -112,7 +112,7 @@ module Style`
`112`	`112`	# # good - can't omit `baz`
`113`	`113`	`# {foo: foo, bar: baz}`
`114`	`114`	`#`
`115`		`- # @example EnforcedShorthandSyntax: consistent_either`
	`115`	`+ # @example EnforcedShorthandSyntax: either_consistent`
`116`	`116`	`#`
`117`	`117`	# # good - `foo` and `bar` values can be omitted, but they are consistent, so it's accepted
`118`	`118`	`# {foo: foo, bar: bar}`
Original file line number	Diff line number	Diff line change
`@@ -1683,7 +1683,7 @@ def buz(foo:, bar:); end`
`1683`	`1683`	`{`
`1684`	`1684`	`'EnforcedStyle' => 'ruby19',`
`1685`	`1685`	`'SupportedStyles' => %w[ruby19 hash_rockets],`
`1686`		`- 'EnforcedShorthandSyntax' => 'consistent_either'`
	`1686`	`+ 'EnforcedShorthandSyntax' => 'either_consistent'`
`1687`	`1687`	`}`
`1688`	`1688`	`end`
`1689`	`1689`