-
-
Notifications
You must be signed in to change notification settings - Fork 263
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
241 additions
and
0 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module Rails | ||
# This cop checks rake task definition without `environment` dependency. | ||
# `environment` dependency is important because it loads application code | ||
# for the rake task. The rake task cannot use application code, such as | ||
# models, without `environment` dependency. | ||
# | ||
# You can ignore the offense if the task satisfies at least one of the | ||
# following conditions: | ||
# | ||
# * The task does not need application code. | ||
# * The task invokes :environment task. | ||
# * The task's dependencies invoke :environment task. | ||
# | ||
# @example | ||
# # bad | ||
# task :foo do | ||
# do_something | ||
# end | ||
# | ||
# # good | ||
# task foo: :environment do | ||
# do_something | ||
# end | ||
# | ||
class RakeEnvironment < Cop | ||
MSG = 'Set :environment task as a dependency to all rake task.' | ||
|
||
def_node_matcher :task_definition?, <<-PATTERN | ||
(send nil? :task ...) | ||
PATTERN | ||
|
||
def on_send(node) | ||
return unless task_definition?(node) | ||
return if task_name(node) == :default | ||
|
||
deps = dependencies(node) | ||
return if environment_dependency_will_apply?(deps) | ||
|
||
add_offense(node) | ||
end | ||
|
||
private | ||
|
||
def task_name(node) | ||
first_arg = node.arguments[0] | ||
case first_arg&.type | ||
when :sym, :str | ||
return first_arg.value.to_sym | ||
when :hash | ||
return nil if first_arg.children.size != 1 | ||
|
||
pair = first_arg.children.first | ||
key = pair.children.first | ||
case key.type | ||
when :sym, :str | ||
key.value.to_sym | ||
end | ||
end | ||
end | ||
|
||
def environment_dependency_will_apply?(deps) | ||
return false if deps.empty? | ||
|
||
dep = deps.first | ||
case dep.type | ||
when :str, :sym | ||
dep.value.to_sym == :environment | ||
else | ||
true | ||
end | ||
end | ||
|
||
def dependencies(node) | ||
first_arg = node.arguments[0] | ||
return [] unless first_arg | ||
|
||
return hash_style_dependencies(first_arg) if first_arg.hash_type? | ||
|
||
task_args = node.arguments[1] | ||
return [] unless task_args | ||
return [] unless task_args.hash_type? | ||
|
||
hash_style_dependencies(task_args) | ||
end | ||
|
||
def hash_style_dependencies(hash_node) | ||
deps = hash_node.pairs.first&.value | ||
return [] unless deps | ||
|
||
case deps.type | ||
when :array | ||
deps.children | ||
else | ||
[deps] | ||
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
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,89 @@ | ||
# frozen_string_literal: true | ||
|
||
RSpec.describe RuboCop::Cop::Rails::RakeEnvironment do | ||
subject(:cop) { described_class.new(config) } | ||
|
||
let(:config) { RuboCop::Config.new } | ||
|
||
it 'registers an offense to task without :environment' do | ||
expect_offense(<<~RUBY) | ||
task :foo do | ||
^^^^^^^^^ Set :environment task as a dependency to all rake task. | ||
end | ||
RUBY | ||
end | ||
|
||
it 'registers an offense to task with an dependency' do | ||
expect_offense(<<~RUBY) | ||
task foo: :bar do | ||
^^^^^^^^^^^^^^ Set :environment task as a dependency to all rake task. | ||
end | ||
RUBY | ||
end | ||
|
||
it 'registers an offense to task with dependencies' do | ||
expect_offense(<<~RUBY) | ||
task foo: [:foo, :bar] do | ||
^^^^^^^^^^^^^^^^^^^^^^ Set :environment task as a dependency to all rake task. | ||
end | ||
RUBY | ||
end | ||
|
||
it 'registers an offense to task with :environment ' \ | ||
'but it has other dependency before it' do | ||
expect_offense(<<~RUBY) | ||
task foo: [:bar, :environment] do | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Set :environment task as a dependency to all rake task. | ||
end | ||
RUBY | ||
end | ||
|
||
it 'registers an offense to task with a dependency as a method call' do | ||
expect_offense(<<~RUBY) | ||
task foo: [:bar, dep] | ||
^^^^^^^^^^^^^^^^^^^^^ Set :environment task as a dependency to all rake task. | ||
RUBY | ||
end | ||
|
||
it 'does not register an offense to task with :environment' do | ||
expect_no_offenses(<<~RUBY) | ||
task foo: :environment do | ||
end | ||
RUBY | ||
end | ||
|
||
it 'does not register an offense to task with :environment ' \ | ||
'and other dependencies' do | ||
expect_no_offenses(<<~RUBY) | ||
task foo: [:environment, :bar] do | ||
end | ||
RUBY | ||
end | ||
|
||
it 'does not register an offense to task with :environment and an argument' do | ||
expect_no_offenses(<<~RUBY) | ||
task :foo, [:arg] => :environment do | ||
end | ||
RUBY | ||
end | ||
|
||
it 'does not register an offense to task with a dependency ' \ | ||
'as a method call' do | ||
expect_no_offenses(<<~RUBY) | ||
task foo: dep | ||
RUBY | ||
end | ||
|
||
it 'does not register an offense to task with dependencies ' \ | ||
'as a method call' do | ||
expect_no_offenses(<<~RUBY) | ||
task foo: [dep, :bar] | ||
RUBY | ||
end | ||
|
||
it 'does not register an offense to the default task' do | ||
expect_no_offenses(<<~RUBY) | ||
task default: :spec | ||
RUBY | ||
end | ||
end |