rubocop-factory_bot 2.24.0 → 2.25.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -1
- data/config/default.yml +17 -5
- data/lib/rubocop/cop/factory_bot/attribute_defined_statically.rb +1 -1
- data/lib/rubocop/cop/factory_bot/consistent_parentheses_style.rb +12 -0
- data/lib/rubocop/cop/factory_bot/create_list.rb +3 -3
- data/lib/rubocop/cop/factory_bot/excessive_create_list.rb +52 -0
- data/lib/rubocop/cop/factory_bot/factory_name_style.rb +8 -1
- data/lib/rubocop/cop/factory_bot/id_sequence.rb +4 -1
- data/lib/rubocop/cop/factory_bot_cops.rb +1 -0
- data/lib/rubocop/factory_bot/version.rb +1 -1
- metadata +6 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7993f668b5e14662f3d5d7a7c5252d1bdbc019320d5a364f9ab8645b3ca022ef
|
4
|
+
data.tar.gz: a69f938e6e63b6b12c76f64e3d62cda12b33f2a58fec11af1df2e321e8f19e32
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e74eab6cd66daf17505e8452b5e422084ecf14d3ffe73fd6321197c4134fac3d0d8d9f1a34c67e92be5f2beae7e81bbfcd68c4bb5e1a39b69d778d7915c22118
|
7
|
+
data.tar.gz: 2410c754ae9bb83837d5c924ff2c4cfb022ec00e36c9768b9b6b60ad4ff5efa8fee51aa94f3f0ad48e7083910b70fb189613f6488c8551e44737f9e0e5cdc25c
|
data/CHANGELOG.md
CHANGED
@@ -2,6 +2,17 @@
|
|
2
2
|
|
3
3
|
## Master (Unreleased)
|
4
4
|
|
5
|
+
## 2.25.1 (2024-01-08)
|
6
|
+
|
7
|
+
- Fix a false positive for `FactoryBot/CreateList` when create call does have method calls and repeat multiple times with other argument. ([@ydah])
|
8
|
+
- Fix an error occurred for `FactoryBot/IdSequence` when `sequence` with non-symbol argument or without argument. ([@ydah])
|
9
|
+
|
10
|
+
## 2.25.0 (2024-01-04)
|
11
|
+
|
12
|
+
- Fix a false positive for `FactoryBot/FactoryNameStyle` when namespaced models. ([@ydah])
|
13
|
+
- Add new `FactoryBot/ExcessiveCreateList` cop. ([@ddieulivol])
|
14
|
+
- Fix a false positive for `FactoryBot/ConsistentParenthesesStyle` when hash pinning. ([@ydah])
|
15
|
+
|
5
16
|
## 2.24.0 (2023-09-18)
|
6
17
|
|
7
18
|
- Fix `FactoryBot/AssociationStyle` cop to ignore explicit associations with `strategy: :build`. ([@pirj])
|
@@ -31,7 +42,7 @@
|
|
31
42
|
|
32
43
|
## Previously (see [rubocop-rspec's changelist](https://github.com/rubocop/rubocop-rspec/blob/70a97b1895ce4b9bcd6ff336d5d343ddc6175fe6/CHANGELOG.md) for details)
|
33
44
|
|
34
|
-
- Fix a false positive for `RSpec/FactoryBot/ConsistentParenthesesStyle` inside `&&`, `||` and `:?` when `omit_parentheses` is on ([@dmitrytsepelev])
|
45
|
+
- Fix a false positive for `RSpec/FactoryBot/ConsistentParenthesesStyle` inside `&&`, `||` and `:?` when `omit_parentheses` is on. ([@dmitrytsepelev])
|
35
46
|
- Add new `RSpec/FactoryBot/FactoryNameStyle` cop. ([@ydah])
|
36
47
|
- Fix wrong autocorrection in `n_times` style on `RSpec/FactoryBot/CreateList`. ([@r7kamura])
|
37
48
|
- Fix a false positive for `RSpec/FactoryBot/ConsistentParenthesesStyle` when using `generate` with multiple arguments. ([@ydah])
|
@@ -74,6 +85,7 @@
|
|
74
85
|
[@bquorning]: https://github.com/bquorning
|
75
86
|
[@composerinteralia]: https://github.com/composerinteralia
|
76
87
|
[@darhazer]: https://github.com/Darhazer
|
88
|
+
[@ddieulivol]: https://github.com/ddieulivol
|
77
89
|
[@dmitrytsepelev]: https://github.com/dmitrytsepelev
|
78
90
|
[@harrylewis]: https://github.com/harrylewis
|
79
91
|
[@jfragoulis]: https://github.com/jfragoulis
|
data/config/default.yml
CHANGED
@@ -14,7 +14,7 @@ FactoryBot/AssociationStyle:
|
|
14
14
|
Enabled: pending
|
15
15
|
Safe: false
|
16
16
|
VersionAdded: '2.23'
|
17
|
-
VersionChanged:
|
17
|
+
VersionChanged: '2.24'
|
18
18
|
EnforcedStyle: implicit
|
19
19
|
SupportedStyles:
|
20
20
|
- explicit
|
@@ -26,7 +26,7 @@ FactoryBot/AttributeDefinedStatically:
|
|
26
26
|
Description: Always declare attribute values as blocks.
|
27
27
|
Enabled: true
|
28
28
|
VersionAdded: '1.28'
|
29
|
-
VersionChanged:
|
29
|
+
VersionChanged: '2.24'
|
30
30
|
Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/AttributeDefinedStatically
|
31
31
|
|
32
32
|
FactoryBot/ConsistentParenthesesStyle:
|
@@ -61,9 +61,21 @@ FactoryBot/CreateList:
|
|
61
61
|
ExplicitOnly: false
|
62
62
|
SafeAutoCorrect: false
|
63
63
|
VersionAdded: '1.25'
|
64
|
-
VersionChanged:
|
64
|
+
VersionChanged: '2.24'
|
65
65
|
Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/CreateList
|
66
66
|
|
67
|
+
FactoryBot/ExcessiveCreateList:
|
68
|
+
Description: Check for excessive model creation in a list.
|
69
|
+
Enabled: pending
|
70
|
+
Include:
|
71
|
+
- "**/*_spec.rb"
|
72
|
+
- "**/spec/**/*"
|
73
|
+
- "**/test/**/*"
|
74
|
+
- "**/features/support/factories/**/*.rb"
|
75
|
+
MaxAmount: 10
|
76
|
+
VersionAdded: '2.25'
|
77
|
+
Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/ExcessiveCreateList
|
78
|
+
|
67
79
|
FactoryBot/FactoryAssociationWithStrategy:
|
68
80
|
Description: Use definition in factory association instead of hard coding a strategy.
|
69
81
|
Enabled: pending
|
@@ -80,7 +92,7 @@ FactoryBot/FactoryClassName:
|
|
80
92
|
Description: Use string value when setting the class attribute explicitly.
|
81
93
|
Enabled: true
|
82
94
|
VersionAdded: '1.37'
|
83
|
-
VersionChanged:
|
95
|
+
VersionChanged: '2.24'
|
84
96
|
Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/FactoryClassName
|
85
97
|
|
86
98
|
FactoryBot/FactoryNameStyle:
|
@@ -103,7 +115,7 @@ FactoryBot/FactoryNameStyle:
|
|
103
115
|
FactoryBot/IdSequence:
|
104
116
|
Description: Do not create a FactoryBot sequence for an id column.
|
105
117
|
Enabled: pending
|
106
|
-
VersionAdded:
|
118
|
+
VersionAdded: '2.24'
|
107
119
|
Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/IdSequence
|
108
120
|
|
109
121
|
FactoryBot/RedundantFactoryOption:
|
@@ -75,6 +75,17 @@ module RuboCop
|
|
75
75
|
)
|
76
76
|
PATTERN
|
77
77
|
|
78
|
+
# @!method omit_hash_value?(node)
|
79
|
+
def_node_matcher :omit_hash_value?, <<~PATTERN
|
80
|
+
(send
|
81
|
+
#factory_call? %FACTORY_CALLS
|
82
|
+
{sym str send lvar}
|
83
|
+
(hash
|
84
|
+
<value_omission? ...>
|
85
|
+
)
|
86
|
+
)
|
87
|
+
PATTERN
|
88
|
+
|
78
89
|
def self.autocorrect_incompatible_with
|
79
90
|
[Style::MethodCallWithArgsParentheses]
|
80
91
|
end
|
@@ -97,6 +108,7 @@ module RuboCop
|
|
97
108
|
def register_offense_with_parentheses(node)
|
98
109
|
return if style == :require_parentheses || !node.parenthesized?
|
99
110
|
return unless same_line?(node, node.first_argument)
|
111
|
+
return if omit_hash_value?(node)
|
100
112
|
|
101
113
|
add_offense(node.loc.selector,
|
102
114
|
message: MSG_OMIT_PARENS) do |corrector|
|
@@ -69,7 +69,7 @@ module RuboCop
|
|
69
69
|
RESTRICT_ON_SEND = %i[create_list].freeze
|
70
70
|
|
71
71
|
# @!method repeat_count(node)
|
72
|
-
def_node_matcher :repeat_count,
|
72
|
+
def_node_matcher :repeat_count, <<~PATTERN
|
73
73
|
(block
|
74
74
|
{
|
75
75
|
(send (const {nil? cbase} :Array) :new (int $_)) # Array.new(3) { create(:user) }
|
@@ -90,7 +90,7 @@ module RuboCop
|
|
90
90
|
|
91
91
|
# @!method arguments_include_method_call?(node)
|
92
92
|
def_node_matcher :arguments_include_method_call?, <<~PATTERN
|
93
|
-
(send #factory_call? :create sym `(send ...))
|
93
|
+
(send #factory_call? :create sym ... `(send ...))
|
94
94
|
PATTERN
|
95
95
|
|
96
96
|
# @!method factory_call(node)
|
@@ -104,7 +104,7 @@ module RuboCop
|
|
104
104
|
PATTERN
|
105
105
|
|
106
106
|
# @!method factory_calls_in_array?(node)
|
107
|
-
def_node_search :factory_calls_in_array?,
|
107
|
+
def_node_search :factory_calls_in_array?, <<~PATTERN
|
108
108
|
(array #factory_call+)
|
109
109
|
PATTERN
|
110
110
|
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module RuboCop
|
4
|
+
module Cop
|
5
|
+
module FactoryBot
|
6
|
+
# Check for excessive model creation in a list.
|
7
|
+
#
|
8
|
+
# @example MaxAmount: 10 (default)
|
9
|
+
# # We do not allow more than 10 items to be created
|
10
|
+
#
|
11
|
+
# # bad
|
12
|
+
# create_list(:merge_request, 1000, state: :opened)
|
13
|
+
#
|
14
|
+
# # good
|
15
|
+
# create_list(:merge_request, 10, state: :opened)
|
16
|
+
#
|
17
|
+
# @example MaxAmount: 20
|
18
|
+
# # We do not allow more than 20 items to be created
|
19
|
+
#
|
20
|
+
# # bad
|
21
|
+
# create_list(:merge_request, 1000, state: :opened)
|
22
|
+
#
|
23
|
+
# # good
|
24
|
+
# create_list(:merge_request, 15, state: :opened)
|
25
|
+
#
|
26
|
+
class ExcessiveCreateList < ::RuboCop::Cop::Base
|
27
|
+
include ConfigurableExplicitOnly
|
28
|
+
|
29
|
+
MESSAGE =
|
30
|
+
'Avoid using `create_list` with more than %<max_amount>s items.'
|
31
|
+
|
32
|
+
# @!method create_list?(node)
|
33
|
+
def_node_matcher :create_list?, <<~PATTERN
|
34
|
+
(send #factory_call? :create_list {sym str} $(int _) ...)
|
35
|
+
PATTERN
|
36
|
+
|
37
|
+
RESTRICT_ON_SEND = %i[create_list].freeze
|
38
|
+
|
39
|
+
def on_send(node)
|
40
|
+
number_node = create_list?(node)
|
41
|
+
return unless number_node
|
42
|
+
|
43
|
+
max_amount = cop_config['MaxAmount']
|
44
|
+
return if number_node.value <= max_amount
|
45
|
+
|
46
|
+
add_offense(number_node, message:
|
47
|
+
format(MESSAGE, max_amount: max_amount))
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
@@ -14,6 +14,9 @@ module RuboCop
|
|
14
14
|
# create(:user)
|
15
15
|
# build :user, username: "NAME"
|
16
16
|
#
|
17
|
+
# # good - namespaced models
|
18
|
+
# create('users/internal')
|
19
|
+
#
|
17
20
|
# @example EnforcedStyle: string
|
18
21
|
# # bad
|
19
22
|
# create(:user)
|
@@ -76,13 +79,17 @@ module RuboCop
|
|
76
79
|
private
|
77
80
|
|
78
81
|
def offense_for_symbol_style?(name)
|
79
|
-
name.str_type? && style == :symbol
|
82
|
+
name.str_type? && style == :symbol && !namespaced?(name)
|
80
83
|
end
|
81
84
|
|
82
85
|
def offense_for_string_style?(name)
|
83
86
|
name.sym_type? && style == :string
|
84
87
|
end
|
85
88
|
|
89
|
+
def namespaced?(name)
|
90
|
+
name.value.include?('/')
|
91
|
+
end
|
92
|
+
|
86
93
|
def register_offense(name, prefer)
|
87
94
|
add_offense(name,
|
88
95
|
message: format(MSG, prefer: style.to_s)) do |corrector|
|
@@ -19,12 +19,15 @@ module RuboCop
|
|
19
19
|
class IdSequence < ::RuboCop::Cop::Base
|
20
20
|
extend AutoCorrector
|
21
21
|
include RangeHelp
|
22
|
+
include RuboCop::FactoryBot::Language
|
22
23
|
|
23
24
|
MSG = 'Do not create a sequence for an id attribute'
|
24
25
|
RESTRICT_ON_SEND = %i[sequence].freeze
|
25
26
|
|
26
27
|
def on_send(node)
|
27
|
-
return unless node.
|
28
|
+
return unless node.receiver.nil? || factory_bot?(node.receiver)
|
29
|
+
return unless node.first_argument&.sym_type? &&
|
30
|
+
node.first_argument.value == :id
|
28
31
|
|
29
32
|
add_offense(node) do |corrector|
|
30
33
|
range_to_remove = range_by_whole_lines(
|
@@ -4,6 +4,7 @@ require_relative 'factory_bot/association_style'
|
|
4
4
|
require_relative 'factory_bot/attribute_defined_statically'
|
5
5
|
require_relative 'factory_bot/consistent_parentheses_style'
|
6
6
|
require_relative 'factory_bot/create_list'
|
7
|
+
require_relative 'factory_bot/excessive_create_list'
|
7
8
|
require_relative 'factory_bot/factory_association_with_strategy'
|
8
9
|
require_relative 'factory_bot/factory_class_name'
|
9
10
|
require_relative 'factory_bot/factory_name_style'
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rubocop-factory_bot
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.
|
4
|
+
version: 2.25.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- John Backus
|
@@ -12,7 +12,7 @@ authors:
|
|
12
12
|
autorequire:
|
13
13
|
bindir: bin
|
14
14
|
cert_chain: []
|
15
|
-
date:
|
15
|
+
date: 2024-01-08 00:00:00.000000000 Z
|
16
16
|
dependencies:
|
17
17
|
- !ruby/object:Gem::Dependency
|
18
18
|
name: rubocop
|
@@ -20,14 +20,14 @@ dependencies:
|
|
20
20
|
requirements:
|
21
21
|
- - "~>"
|
22
22
|
- !ruby/object:Gem::Version
|
23
|
-
version: '1.
|
23
|
+
version: '1.41'
|
24
24
|
type: :runtime
|
25
25
|
prerelease: false
|
26
26
|
version_requirements: !ruby/object:Gem::Requirement
|
27
27
|
requirements:
|
28
28
|
- - "~>"
|
29
29
|
- !ruby/object:Gem::Version
|
30
|
-
version: '1.
|
30
|
+
version: '1.41'
|
31
31
|
description: |
|
32
32
|
Code style checking for factory_bot files.
|
33
33
|
A plugin for the RuboCop code style enforcing & linting tool.
|
@@ -48,6 +48,7 @@ files:
|
|
48
48
|
- lib/rubocop/cop/factory_bot/attribute_defined_statically.rb
|
49
49
|
- lib/rubocop/cop/factory_bot/consistent_parentheses_style.rb
|
50
50
|
- lib/rubocop/cop/factory_bot/create_list.rb
|
51
|
+
- lib/rubocop/cop/factory_bot/excessive_create_list.rb
|
51
52
|
- lib/rubocop/cop/factory_bot/factory_association_with_strategy.rb
|
52
53
|
- lib/rubocop/cop/factory_bot/factory_class_name.rb
|
53
54
|
- lib/rubocop/cop/factory_bot/factory_name_style.rb
|
@@ -83,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
83
84
|
- !ruby/object:Gem::Version
|
84
85
|
version: '0'
|
85
86
|
requirements: []
|
86
|
-
rubygems_version: 3.
|
87
|
+
rubygems_version: 3.4.22
|
87
88
|
signing_key:
|
88
89
|
specification_version: 4
|
89
90
|
summary: Code style checking for factory_bot files
|