Sha256: 86fc8ba8d0a8bf2d5922ec5f63f76bfb0b0546e38e108457258cbab92d339cf0
Contents?: true
Size: 1.55 KB
Versions: 36
Compression:
Stored size: 1.55 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Bundler
# Add a comment describing each gem in your Gemfile.
#
# @example
# # bad
#
# gem 'foo'
#
# # good
#
# # Helpers for the foo things.
# gem 'foo'
#
class GemComment < Cop
include DefNode
MSG = 'Missing gem description comment.'
def_node_matcher :gem_declaration?, '(send nil? :gem str ...)'
def on_send(node)
return unless gem_declaration?(node)
return if whitelisted_gem?(node)
return if commented?(node)
add_offense(node)
end
private
def commented?(node)
preceding_lines = preceding_lines(node)
preceding_comment?(node, preceding_lines.last)
end
# The args node1 & node2 may represent a RuboCop::AST::Node
# or a Parser::Source::Comment. Both respond to #loc.
def precede?(node1, node2)
node2.loc.line - node1.loc.line == 1
end
def preceding_lines(node)
processed_source.ast_with_comments[node].select do |line|
line.loc.line < node.loc.line
end
end
def preceding_comment?(node1, node2)
node1 && node2 && precede?(node2, node1) &&
comment_line?(node2.loc.expression.source)
end
def whitelisted_gem?(node)
whitelist = Array(cop_config['Whitelist'])
whitelist.include?(node.first_argument.value)
end
end
end
end
end
Version data entries
36 entries across 19 versions & 2 rubygems