Layout/AlignHash allow two options #6649

stoivo · 2019-01-09T21:29:03Z

I my company we like to use Hashes in both table and key format. We would like to have rubucop allow both so I make a path an it seams to work for me.
What I want is

# bad
{
  :foo => bar,
   :ba => baz
}

# good
{
  :foo => bar,
  :ba => baz
}
{
  :foo => bar,
  :ba  => baz
}

I wanted to open the PR to check if it would be accepted if I can submitt a nice PR for it. I can add more spec. I wil do so if you think you want this feature

Right now I made it an option not_<any_of_the_setting>. I think it would be nicer if you could spesifi it as a list in .rubocop.yml

Layout/AlignHash:
  EnforcedHashRocketStyle: 
    - table
    - key
  # vs
  EnforcedHashRocketStyle: not_separator

Thoughts? Do you have an example where you do this?
If I can change it to a list the first one can be the format to autofix to.

Edit: after a little more testing is should autofix to the the format how as the least amoint of offences.

Before submitting the PR make sure the following are checked:

Wrote good commit messages.
Commit message starts with [Fix #issue-number] (if the related issue exists).
Feature branch is up-to-date with master (if not - rebase it).
Squashed related commits together.
Added tests.
Added an entry to the Changelog if the new code introduces user-observable changes. See changelog entry format.
The PR relates to only one subject with a clear title
and description in grammatically correct, complete sentences.
Run bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.

stoivo · 2019-01-23T13:07:46Z

I should add some spec to this.
Other thant that I think it's ready

stoivo · 2019-01-25T15:14:35Z

I have written spec. I would very much like some feedback on this.

stoivo · 2019-03-04T18:43:40Z

Hi, @pocke
I see you have merges some other MR here would you review this MR too?

stoivo · 2019-03-12T09:08:11Z

I will rebase after it is review so I don't wast to much time rebasing and force pushing

bbatsov · 2019-03-17T07:00:17Z

Sorry about the slow turnaround on this. I'll take a look a closer look soon. In general I'm wary of adding 3 more styles to this cop, if we probably need just one. From what I gathered most people want something that allows a combination of table or key, right?

stoivo · 2019-03-17T12:44:39Z

Thank you for taking a look at it.
Yes, we want a combination of table or key. I think we kan remove the two others, I added those because it was't too much work. We wnt to enforce one style in one hash, either table or key.

pocke · 2019-03-17T17:38:07Z

Sorry for the late reply.
I have the same concern. If a style is added to the cop in the future, no_* styles behaviour is changed.

How about making EnforcedStyle receiving multiple options?
exmaple:

EnforcedStyle:
  - table
  - key

I think it is easy to use, but it is inconsistent with other cops because other cops do not support multiple options.

If you and many users need to allow table and key, I think adding one option is good. The option allows table and key styles.
And I'd like to rename the option to table_and_key. Because no_* option will be changed the behaviour if an option is added to the cop in the future.

bbatsov · 2019-03-18T09:23:39Z

I think table_or_key might be a better name, unless we come up with a single word to describe this.

How about making EnforcedStyle receiving multiple options?

That's a pretty interesting idea in general - make it possible to accept several styles where it makes sense. It would probably be reasonable simple to do this, and it might be my preference. @rubocop-hq/rubocop-core What do you think about this idea?

stoivo · 2019-03-18T21:20:04Z

I think the idea of supporting either a string or a list would be very cool and flexible. And when you enter all thee formats, any format is valid but only one format in one hash.

I did one attempt at making it a list in the beginning but faced some dificulities. I would be happy diving it a second time, with some mentoring and pointing me where to look.

bbatsov · 2019-03-18T22:15:07Z

The only small problem is which style to suggest in case a hash doesn't match any of them. Probably the one that was specified first.

stoivo · 2019-03-19T13:30:10Z

@bbatsov, yes to the one with leaset offences. But thats allreade fixed
https://github.com/stoivo/rubocop/blob/master/lib/rubocop/cop/layout/align_hash.rb#L213

EDIT: now it is implemented by the one woth least offences. Since if you add one more element to an element to an existing hash correct as least as possible.

stoivo · 2019-03-19T13:57:54Z

I think thats better becuase If you have

{
  ab:    123,
  assdf: 12332,
  asf:   12332,
}

And you add one element

{
  ab:    123,
  assdf: 12332,
  asf:   12332,
  b: true,
}

You probably want to format it to table if you allow both key and table

bbatsov · 2019-04-03T16:42:46Z

So, what are doing here? Do we agree to try the multiple enforced styles approach?

stoivo · 2019-04-03T21:21:59Z

I can use the name table_or_key instead of not_separator.
@bbatsov What do you think of autocorrection to the one with least offences?

CHANGELOG.md

bbatsov · 2019-04-04T06:49:54Z

I actually prefer @pocke's idea and autocorrecting using whatever is first in the EnforcedStyle list. I don't like relying on offenses, because that's non deterministic.

stoivo · 2019-04-04T10:55:48Z

I actually prefer @pocke's idea and autocorrecting using whatever is first in the EnforcedStyle list. I don't like relying on offenses, because that's non deterministic.

Did you se my comment about what happens if you add something to an existing hash but without 100% match?

I think thats better becuase If you have
{
  ab:    123,
  assdf: 12332,
  asf:   12332,
}
And you add one element
{
  ab:    123,
  assdf: 12332,
  asf:   12332,
  b: true,
}
You probably want to format it to table if you allow both key and table

I just want to say, you have more experence maintaining rubocop so I will do just want to say :)
I pushed a commit where I merged the commits and rebased away the merge commits.
It is't working 100% and I dont have time to fix it today. Will do it shortly.

lib/rubocop/cop/layout/align_hash.rb

bbatsov · 2019-04-04T11:20:20Z

I just want to say, you have more experence maintaining rubocop so I will do just want to say :)
I pushed a commit where I merged the commits and rebased away the merge commits.
It is't working 100% and I dont have time to fix it today. Will do it shortly.

Yeah, I did. I don't consider this a problem as in your editor you'd know what to do - you see some warning, but you also know it will disappear once you change it. The auto-correct should just pick the first option:

EnforcedStyle:
  - table
  - key

In this case - table. Just to be clear - I strongly prefer to have a list of options for EnforcedStyle than a dedicated table_or_key style (although I can live with it). I this case I'd default to key i guess.

bbatsov · 2019-04-18T08:44:45Z

@stoivo Ping :-)

stoivo · 2019-04-26T13:27:38Z

@bbatsov, thanks for beein patient with me.

Could to review it now?

I am facing a minor issue with rubocop

$ rubocop                                                                                                                                                    15:09:20
Inspecting 1172 files
..................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................C.................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................

Offenses:

lib/rubocop/config.rb:528:5: C: Metrics/AbcSize: Assignment Branch Condition size for validate_enforced_styles is too high. [20.05/17]
    def validate_enforced_styles(valid_cop_names) ...
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubocop/config.rb:528:5: C: Metrics/MethodLength: Method has too many lines. [16/14]
    def validate_enforced_styles(valid_cop_names) ...
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1172 files inspected, 2 offenses detected

https://github.com/stoivo/rubocop/blob/0306ae96739b4de743ddb3935adc6611e1134b31/lib/rubocop/config.rb#L528-L548

    def validate_enforced_styles(valid_cop_names)
      valid_cop_names.each do |name|
        styles = self[name].select { |key, _| key.start_with?('Enforced') }

        styles.each do |style_name, style|
          supported_key = RuboCop::Cop::Util.to_supported_styles(style_name)
          valid = ConfigLoader.default_configuration[name][supported_key]

          next unless valid
          next if valid.include?(style)
          next if ConfigLoader.default_configuration[name]['AllowListStyles'] &&
                  style.is_a?(Array) &&
                  style.all? { |a_style| valid.include?(a_style) }

          msg = "invalid #{style_name} '#{style}' for #{name} found in " \
            "#{smart_loaded_path}\n" \
            "Valid choices are: #{valid.join(', ')}"
          raise ValidationError, msg
        end
      end
    end

How do you want me to solve this?

jonas054 · 2019-04-30T18:15:36Z

How do you want me to solve this?

I think you should extract either the contents of the inner each loop, or just the complex expression

ConfigLoader.default_configuration[name]['AllowListStyles'] &&
                  style.is_a?(Array) &&
                  style.all? { |a_style| valid.include?(a_style) }

into a new method. Come up with a name for the new method and you're good to go. 🙂

CHANGELOG.md

config/default.yml

lib/rubocop/cop/layout/align_hash.rb

bbatsov · 2019-05-09T07:06:34Z

spec/rubocop/config_spec.rb

@@ -174,6 +174,37 @@
      end
    end

+    context 'when the configuration includes multiple valid EnforcedStyle' do


Should we raise an error if the cop doesn't support multiple style explicitly?

bbatsov · 2019-05-09T07:07:10Z

@stoivo Added a bit of small remarks. Generally the code looks pretty good and we're very close to finally merging this.

bquorning · 2019-05-09T08:19:08Z

Should we consider reverting 807b362 as part of this PR?

bquorning · 2019-05-09T08:19:38Z

This will fix #6410, right?

bbatsov · 2019-05-09T08:47:04Z

Should we consider reverting 807b362 as part of this PR?

Yes.

You can specify table_or_key if you want to allow both table and key When multiple hash formats is accept the hash need to be either one or the other.

You can specify table or key or separator or a combination of any of these. If you allow both table and key any hash might be either.

This reverts commit da8c541.

stoivo · 2019-05-13T15:55:58Z

Ready for an onther review.

I reverted the commit and did some small modifications to resolve conflicts.

bbatsov · 2019-05-13T16:20:38Z

Good job! There are some small things that'd I'd like us to polish down the road and we have to document somewhere the ability to have cops that support multiple styles, but I'll merge the PR in its current state as it's pretty big and you've been wasting a lot of efforts keeping it up to date. Thanks! 🙇

stoivo · 2019-05-13T19:05:38Z

Thank you too. I wm happy to help out a more but I think is is better if you do the polish and add the documentation where it belongs. Very happy with submitting a patch to rubocop. Love the tool ❤️

@bbatsov

Follow up rubocop@8a7ee84. This PR fixes the following CI errors. ```console bundle exec rake (snip) 1) RuboCop Project changelog entry after version 0.14.0 has a link to the contributors at the end Failure/Error: expect(entries).to all(match(/$\[@\S+\]\[\](?:, \[@\S+\]\[\])*$$/)) expected ["* [rubocop#6649](rubocop#6649): `Layout/AlignHash` supports list of opt...552): `RaiseArgs` allows exception constructor calls with more than one 1 argument. ([@bbatsov][])"] to all match /$\[@\S+\]\[\](?:, \[@\S+\]\[\])*$$/ object at index 3 failed to match: expected "* [rubocop#7052](rubocop#7052): Add `AllowComments` option to ` Lint/HandleExceptions`. ([@tejasbubane][]) " to match /$\[@\S+\]\[\](?:, \[@\S+\]\[\])*$$/ # ./spec/project_spec.rb:128:in `block (5 levels) in <top (required)>' (snip) 2) RuboCop Project changelog entry body ends with a punctuation Failure/Error: expect(bodies).to all(match(/[\.\!]$/)) expected ["`` supports list of options.", "Add `` config option to ``.", "Add `` to ``.", "Add `` option to ``...nclosed in braces are not noticed.", "Received malformed format string ArgumentError from rubocop."] to all match /[\.\!]$/ object at index 3 failed to match: expected "Add `` option to ``. ([@tejasbubane][]) " to match /[\.\!]$/ # ./spec/project_spec.rb:187:in `block (5 levels) in <top (required)>' ``` https://circleci.com/gh/rubocop-hq/rubocop/55378

stoivo force-pushed the layout_hash_align branch 2 times, most recently from 751a7a5 to 6473ec8 Compare January 23, 2019 13:00

stoivo changed the title ~~WIP: Layout/AlignHash allow two options~~ Layout/AlignHash allow two options Jan 23, 2019

stoivo force-pushed the layout_hash_align branch from 6473ec8 to 02e11c1 Compare January 25, 2019 15:13

pocke self-requested a review March 5, 2019 06:48

jonas054 reviewed Apr 4, 2019

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

stoivo force-pushed the layout_hash_align branch from 7125db2 to e5dc67c Compare April 4, 2019 10:42

stoivo commented Apr 4, 2019

View reviewed changes

lib/rubocop/cop/layout/align_hash.rb Outdated Show resolved Hide resolved

stoivo force-pushed the layout_hash_align branch 4 times, most recently from 2ae82cb to e0212f4 Compare April 26, 2019 13:00

stoivo force-pushed the layout_hash_align branch from e0212f4 to 0306ae9 Compare April 26, 2019 13:08

stoivo force-pushed the layout_hash_align branch from 0306ae9 to 342cce4 Compare May 1, 2019 06:34

bbatsov reviewed May 9, 2019

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

bbatsov reviewed May 9, 2019

View reviewed changes

config/default.yml Outdated Show resolved Hide resolved

bbatsov reviewed May 9, 2019

View reviewed changes

lib/rubocop/cop/layout/align_hash.rb Outdated Show resolved Hide resolved

bbatsov reviewed May 9, 2019

View reviewed changes

stoivo added 2 commits May 13, 2019 09:46

layout/align_hash: Add option table_or_key

aeb7c90

You can specify table_or_key if you want to allow both table and key When multiple hash formats is accept the hash need to be either one or the other.

Internal: Allow Cops to support a list in Styles

69052b7

stoivo force-pushed the layout_hash_align branch from 342cce4 to efc8dc2 Compare May 13, 2019 08:23

Layout/AlignHash: Add support list of styles

bca03f9

You can specify table or key or separator or a combination of any of these. If you allow both table and key any hash might be either.

stoivo force-pushed the layout_hash_align branch from efc8dc2 to bca03f9 Compare May 13, 2019 09:21

Revert "Autocorrect violations of Layout/AlignHash Cop"

cfaeeb7

This reverts commit da8c541.

stoivo force-pushed the layout_hash_align branch from c89d476 to cfaeeb7 Compare May 13, 2019 11:48

stoivo mentioned this pull request May 13, 2019

Feature request: Layout/AlignHash option to allow for key and table styles to both be permissible #6410

Closed

bbatsov merged commit 971769a into rubocop:master May 13, 2019

AdrienSdy mentioned this pull request Jun 19, 2019

Remove useless Layout/SpaceAfterColon Cop #7157

Closed

koic mentioned this pull request Aug 1, 2020

Add new config arguments_or_slashes to Rails/FilePath rubocop/rubocop-rails#298

Open

9 tasks

koic mentioned this pull request Oct 2, 2020

Default for Style/FormatStringToken #8827

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Layout/AlignHash allow two options #6649

Layout/AlignHash allow two options #6649

stoivo commented Jan 9, 2019 •

edited

stoivo commented Jan 23, 2019 •

edited

stoivo commented Jan 25, 2019

stoivo commented Mar 4, 2019

stoivo commented Mar 12, 2019

bbatsov commented Mar 17, 2019

stoivo commented Mar 17, 2019

pocke commented Mar 17, 2019

bbatsov commented Mar 18, 2019

stoivo commented Mar 18, 2019

bbatsov commented Mar 18, 2019

stoivo commented Mar 19, 2019 •

edited

stoivo commented Mar 19, 2019

bbatsov commented Apr 3, 2019

stoivo commented Apr 3, 2019

bbatsov commented Apr 4, 2019

stoivo commented Apr 4, 2019

bbatsov commented Apr 4, 2019

bbatsov commented Apr 18, 2019

stoivo commented Apr 26, 2019

jonas054 commented Apr 30, 2019

bbatsov May 9, 2019

bbatsov commented May 9, 2019

bquorning commented May 9, 2019

bquorning commented May 9, 2019

bbatsov commented May 9, 2019

stoivo commented May 13, 2019

bbatsov commented May 13, 2019

stoivo commented May 13, 2019

Layout/AlignHash allow two options #6649

Layout/AlignHash allow two options #6649

Conversation

stoivo commented Jan 9, 2019 • edited

stoivo commented Jan 23, 2019 • edited

stoivo commented Jan 25, 2019

stoivo commented Mar 4, 2019

stoivo commented Mar 12, 2019

bbatsov commented Mar 17, 2019

stoivo commented Mar 17, 2019

pocke commented Mar 17, 2019

bbatsov commented Mar 18, 2019

stoivo commented Mar 18, 2019

bbatsov commented Mar 18, 2019

stoivo commented Mar 19, 2019 • edited

stoivo commented Mar 19, 2019

bbatsov commented Apr 3, 2019

stoivo commented Apr 3, 2019

bbatsov commented Apr 4, 2019

stoivo commented Apr 4, 2019

bbatsov commented Apr 4, 2019

bbatsov commented Apr 18, 2019

stoivo commented Apr 26, 2019

jonas054 commented Apr 30, 2019

bbatsov May 9, 2019

Choose a reason for hiding this comment

bbatsov commented May 9, 2019

bquorning commented May 9, 2019

bquorning commented May 9, 2019

bbatsov commented May 9, 2019

stoivo commented May 13, 2019

bbatsov commented May 13, 2019

stoivo commented May 13, 2019

stoivo commented Jan 9, 2019 •

edited

stoivo commented Jan 23, 2019 •

edited

stoivo commented Mar 19, 2019 •

edited