Class: RuboCop::Cop::Bundler::GemComment

Inherits:
RuboCop::Cop::Base show all
Includes:
DefNode
Defined in:
lib/rubocop/cop/bundler/gem_comment.rb

Overview

Add a comment describing each gem in your Gemfile.

Optionally, the “OnlyFor” configuration can be used to only register offenses when the gems use certain options or have version specifiers. Add “version_specifiers” and/or the gem option names you want to check.

A useful use-case is to enforce a comment when using options that change the source of a gem:

  • `bitbucket`

  • `gist`

  • `git`

  • `github`

  • `source`

For a full list of options supported by bundler, you can check the bundler.io/man/gemfile.5.html[official documentation].

Examples:

OnlyFor: [] (default)

# bad

gem 'foo'

# good

# Helpers for the foo things.
gem 'foo'

OnlyFor: ['version_specifiers']

# bad

gem 'foo', '< 2.1'

# good

# Version 2.1 introduces breaking change baz
gem 'foo', '< 2.1'

OnlyFor: ['version_specifiers', 'github']

# bad

gem 'foo', github: 'some_account/some_fork_of_foo'

gem 'bar', '< 2.1'

# good

# Using this fork because baz
gem 'foo', github: 'some_account/some_fork_of_foo'

# Version 2.1 introduces breaking change baz
gem 'bar', '< 2.1'

Constant Summary collapse

MSG =
'Missing gem description comment.'
CHECKED_OPTIONS_CONFIG =
'OnlyFor'
VERSION_SPECIFIERS_OPTION =
'version_specifiers'
RESTRICT_ON_SEND =
%i[gem].freeze

Constants included from DefNode

DefNode::NON_PUBLIC_MODIFIERS

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from RuboCop::Cop::Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, indent, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#on_send(node) ⇒ Object


71
72
73
74
75
76
77
78
# File 'lib/rubocop/cop/bundler/gem_comment.rb', line 71

def on_send(node)
  return unless gem_declaration?(node)
  return if ignored_gem?(node)
  return if commented_any_descendant?(node)
  return if cop_config[CHECKED_OPTIONS_CONFIG].any? && !checked_options_present?(node)

  add_offense(node)
end