New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add mixins folder #942
Closed
Closed
Add mixins folder #942
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module RSpec | ||
# Helps determine the offending location if there is not an empty line | ||
# following the node. Allows comments to follow directly after. | ||
module EmptyLineSeparation | ||
include FinalEndLocation | ||
include RangeHelp | ||
|
||
def missing_separating_line_offense(node) | ||
return if last_child?(node) | ||
|
||
missing_separating_line(node) do |location| | ||
msg = yield(node.method_name) | ||
add_offense(location, message: msg) do |corrector| | ||
corrector.insert_after(location.end, "\n") | ||
end | ||
end | ||
end | ||
|
||
def missing_separating_line(node) | ||
line = final_end_location(node).line | ||
|
||
line += 1 while comment_line?(processed_source[line]) | ||
|
||
return if processed_source[line].blank? | ||
|
||
yield offending_loc(line) | ||
end | ||
|
||
def offending_loc(last_line) | ||
offending_line = processed_source[last_line - 1] | ||
|
||
content_length = offending_line.lstrip.length | ||
start = offending_line.length - content_length | ||
|
||
source_range(processed_source.buffer, | ||
last_line, start, content_length) | ||
end | ||
|
||
def last_child?(node) | ||
return true unless node.parent&.begin_type? | ||
|
||
node.equal?(node.parent.children.last) | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module RSpec | ||
# Helps find the true end location of nodes which might contain heredocs. | ||
module FinalEndLocation | ||
def final_end_location(start_node) | ||
heredoc_endings = | ||
start_node.each_node(:str, :dstr, :xstr) | ||
.select(&:heredoc?) | ||
.map { |node| node.loc.heredoc_end } | ||
|
||
[start_node.loc.end, *heredoc_endings].max_by(&:line) | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module RSpec | ||
# Helper methods for top level describe cops | ||
module TopLevelDescribe | ||
extend NodePattern::Macros | ||
|
||
def on_send(node) | ||
return unless respond_to?(:on_top_level_describe) | ||
return unless top_level_describe?(node) | ||
|
||
on_top_level_describe(node, node.arguments) | ||
end | ||
|
||
private | ||
|
||
def top_level_describe?(node) | ||
return false unless node.method_name == :describe | ||
|
||
top_level_nodes.include?(node) | ||
end | ||
|
||
def top_level_nodes | ||
nodes = describe_statement_children(root_node) | ||
# If we have no top level describe statements, we need to check any | ||
# blocks on the top level (e.g. after a require). | ||
if nodes.empty? | ||
nodes = root_node.each_child_node(:block).flat_map do |child| | ||
describe_statement_children(child) | ||
end | ||
end | ||
|
||
nodes | ||
end | ||
|
||
def root_node | ||
processed_source.ast | ||
end | ||
|
||
def single_top_level_describe? | ||
top_level_nodes.one? | ||
end | ||
|
||
def describe_statement_children(node) | ||
node.each_child_node(:send).select do |element| | ||
element.method_name == :describe | ||
end | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module RSpec | ||
# Helper methods for top level example group cops | ||
module TopLevelGroup | ||
extend RuboCop::NodePattern::Macros | ||
include RuboCop::RSpec::Language | ||
|
||
def_node_matcher :example_or_shared_group?, | ||
(ExampleGroups::ALL + SharedGroups::ALL).block_pattern | ||
|
||
def on_block(node) | ||
return unless respond_to?(:on_top_level_group) | ||
return unless top_level_group?(node) | ||
|
||
on_top_level_group(node) | ||
end | ||
|
||
private | ||
|
||
def top_level_group?(node) | ||
top_level_groups.include?(node) | ||
end | ||
|
||
def top_level_groups | ||
@top_level_groups ||= | ||
top_level_nodes.select { |n| example_or_shared_group?(n) } | ||
end | ||
|
||
def top_level_nodes | ||
if root_node.begin_type? | ||
root_node.children | ||
else | ||
[root_node] | ||
end | ||
end | ||
|
||
def root_node | ||
processed_source.ast | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module RSpec | ||
# Helps check offenses with variable definitions | ||
module Variable | ||
include RuboCop::RSpec::Language | ||
extend RuboCop::NodePattern::Macros | ||
|
||
def_node_matcher :variable_definition?, <<~PATTERN | ||
(send #{RSPEC} #{(Helpers::ALL + Subject::ALL).node_pattern_union} | ||
$({sym str dsym dstr} ...) ...) | ||
PATTERN | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When we change the folder like this, shouldn’t we also change the namespace? E.g.
RuboCop::RSpec::TopLevelDescribe
->RuboCop::Cop::RSpec::TopLevelDescribe
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree.
@mockdeep We've just renamed
RuboCop::Cop::RSpec::Cop
toRuboCop::Cop::RSpec::Base
following RuboCop core's naming.If we happen to move classes/modules around namespaces, and if it happens those are used by custom cops, we'll break them with a minor version update.
So for
Base
, we've decided to keep the old class,Cop
as well until 2.0.I don't see how it would be possible to release this change with namespace before we release 2.0 without similar breakage risks.
AFAI understand #863 depends on this pull request. But if this is going to be released in 2.0, that means that #863 will only be released as
enabled
in 3.0, until then it will bepending
.So I propose two options for #863:
Please let me know what you think.