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 new Gemspec/DateAssignment
cop
#9496
Merged
bbatsov
merged 1 commit into
rubocop:master
from
koic:new_add_new_gemspec_date_assignment_cop
Feb 12, 2021
Merged
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* [#9496](https://github.com/rubocop-hq/rubocop/pull/9496): Add new `Gemspec/DateAssignment` cop. ([@koic][]) |
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,56 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module Gemspec | ||
# This cop checks that `date =` is not used in gemspec file. | ||
# It is set automatically when the gem is packaged. | ||
# | ||
# @example | ||
# | ||
# # bad | ||
# Gem::Specification.new do |spec| | ||
# s.name = 'your_cool_gem_name' | ||
# spec.date = Time.now.strftime('%Y-%m-%d') | ||
# end | ||
# | ||
# # good | ||
# Gem::Specification.new do |spec| | ||
# s.name = 'your_cool_gem_name' | ||
# end | ||
# | ||
class DateAssignment < Base | ||
include RangeHelp | ||
extend AutoCorrector | ||
|
||
MSG = 'Do not use `date =` in gemspec, it is set automatically when the gem is packaged.' | ||
|
||
def_node_matcher :gem_specification, <<~PATTERN | ||
(block | ||
(send | ||
(const | ||
(const {cbase nil?} :Gem) :Specification) :new) | ||
...) | ||
PATTERN | ||
|
||
def on_block(block_node) | ||
return unless gem_specification(block_node) | ||
|
||
block_parameter = block_node.arguments.first.source | ||
|
||
date_assignment = block_node.descendants.detect do |node| | ||
node.send_type? && node.receiver&.source == block_parameter && node.method?(:date=) | ||
end | ||
|
||
return unless date_assignment | ||
|
||
add_offense(date_assignment) do |corrector| | ||
range = range_by_whole_lines(date_assignment.source_range, include_final_newline: true) | ||
|
||
corrector.remove(range) | ||
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# frozen_string_literal: true | ||
|
||
RSpec.describe RuboCop::Cop::Gemspec::DateAssignment, :config do | ||
it 'registers and corrects an offense when using `s.date =`' do | ||
expect_offense(<<~RUBY) | ||
Gem::Specification.new do |s| | ||
s.name = 'your_cool_gem_name' | ||
s.date = Time.now.strftime('%Y-%m-%d') | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not use `date =` in gemspec, it is set automatically when the gem is packaged. | ||
s.bindir = 'exe' | ||
end | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
Gem::Specification.new do |s| | ||
s.name = 'your_cool_gem_name' | ||
s.bindir = 'exe' | ||
end | ||
RUBY | ||
end | ||
|
||
it 'registers and corrects an offense when using `spec.date =`' do | ||
expect_offense(<<~RUBY) | ||
Gem::Specification.new do |spec| | ||
spec.name = 'your_cool_gem_name' | ||
spec.date = Time.now.strftime('%Y-%m-%d') | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not use `date =` in gemspec, it is set automatically when the gem is packaged. | ||
spec.bindir = 'exe' | ||
end | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
Gem::Specification.new do |spec| | ||
spec.name = 'your_cool_gem_name' | ||
spec.bindir = 'exe' | ||
end | ||
RUBY | ||
end | ||
|
||
it 'does not register an offense when using `s.date =` outside `Gem::Specification.new`' do | ||
expect_no_offenses(<<~RUBY) | ||
s.date = Time.now.strftime('%Y-%m-%d') | ||
RUBY | ||
end | ||
|
||
it 'does not register an offense when using `date =` and receiver is not `Gem::Specification.new` block variable' do | ||
expect_no_offenses(<<~RUBY) | ||
Gem::Specification.new do |spec| | ||
s.date = Time.now.strftime('%Y-%m-%d') | ||
end | ||
RUBY | ||
end | ||
end |
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.
This will include gemspecs in vendored gems, which may have the date set but be out of the control of the developer.
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.
Good point. However this setting is the same as other Gemspec department's cops. These cops hasn't received feedback on that issue, so I think we see reactions with this setting.