Class: RuboCop::Cop::Bundler::GemVersion

Inherits:
RuboCop::Cop::Base show all
Includes:
ConfigurableEnforcedStyle, GemDeclaration
Defined in:
lib/rubocop/cop/bundler/gem_version.rb

Overview

Enforce that Gem version specifications or a commit reference (branch, ref, or tag) are either required or forbidden.

Examples:

EnforcedStyle: required (default)

# bad
gem 'rubocop'

# good
gem 'rubocop', '~> 1.12'

# good
gem 'rubocop', '>= 1.10.0'

# good
gem 'rubocop', '>= 1.5.0', '< 1.10.0'

# good
gem 'rubocop', branch: 'feature-branch'

# good
gem 'rubocop', ref: '74b5bfbb2c4b6fd6cdbbc7254bd7084b36e0c85b'

# good
gem 'rubocop', tag: 'v1.17.0'

EnforcedStyle: forbidden

# good
gem 'rubocop'

# bad
gem 'rubocop', '~> 1.12'

# bad
gem 'rubocop', '>= 1.10.0'

# bad
gem 'rubocop', '>= 1.5.0', '< 1.10.0'

# bad
gem 'rubocop', branch: 'feature-branch'

# bad
gem 'rubocop', ref: '74b5bfbb2c4b6fd6cdbbc7254bd7084b36e0c85b'

# bad
gem 'rubocop', tag: 'v1.17.0'

Constant Summary collapse

REQUIRED_MSG = 
'Gem version specification is required.'
FORBIDDEN_MSG = 
'Gem version specification is forbidden.'
RESTRICT_ON_SEND = 
%i[gem].freeze
VERSION_SPECIFICATION_REGEX = 
/^\s*[~<>=]*\s*[0-9.]+/.freeze

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::Base

#config, #processed_source

Instance Method Summary collapse

Methods included from GemDeclaration

#gem_declaration?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from RuboCop::Cop::Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#includes_commit_reference?(node) ⇒ Object 



68
69
70
 
# File 'lib/rubocop/cop/bundler/gem_version.rb', line 68

def_node_matcher :includes_commit_reference?, <<~PATTERN
  (send nil? :gem <(hash <(pair (sym {:branch :ref :tag}) (str _)) ...>) ...>)
PATTERN

#includes_version_specification?(node) ⇒ Object 



63
64
65
 
# File 'lib/rubocop/cop/bundler/gem_version.rb', line 63

def_node_matcher :includes_version_specification?, <<~PATTERN
  (send nil? :gem <(str #version_specification?) ...>)
PATTERN

#on_send(node) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/rubocop/cop/bundler/gem_version.rb', line 72

def on_send(node)
  return unless gem_declaration?(node)
  return if allowed_gem?(node)

  if offense?(node)
    add_offense(node)
    opposite_style_detected
  else
    correct_style_detected
  end
end