Class: RuboCop::Cop::Gemspec::DependencyVersion

Inherits:
Base
  • Object
show all
Includes:
ConfigurableEnforcedStyle, RuboCop::Cop::GemspecHelp
Defined in:
lib/rubocop/cop/gemspec/dependency_version.rb

Overview

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

Examples:

EnforcedStyle: required (default)


# bad
Gem::Specification.new do |spec|
  spec.add_dependency 'parser'
end

# bad
Gem::Specification.new do |spec|
  spec.add_development_dependency 'parser'
end

# good
Gem::Specification.new do |spec|
  spec.add_dependency 'parser', '>= 2.3.3.1', '< 3.0'
end

# good
Gem::Specification.new do |spec|
  spec.add_development_dependency 'parser', '>= 2.3.3.1', '< 3.0'
end

EnforcedStyle: forbidden


# bad
Gem::Specification.new do |spec|
  spec.add_dependency 'parser', '>= 2.3.3.1', '< 3.0'
end

# bad
Gem::Specification.new do |spec|
  spec.add_development_dependency 'parser', '>= 2.3.3.1', '< 3.0'
end

# good
Gem::Specification.new do |spec|
  spec.add_dependency 'parser'
end

# good
Gem::Specification.new do |spec|
  spec.add_development_dependency 'parser'
end

Constant Summary collapse

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

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from RuboCop::Cop::GemspecHelp

#gem_specification, #gem_specification?

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 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, 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

#add_dependency_method_declaration?(node) ⇒ Object 



67
68
69
70
 
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 67

def_node_matcher :add_dependency_method_declaration?, <<~PATTERN
  (send
    (lvar #match_block_variable_name?) #add_dependency_method? ...)
PATTERN

#includes_commit_reference?(node) ⇒ Object 



78
79
80
 
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 78

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

#includes_version_specification?(node) ⇒ Object 



73
74
75
 
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 73

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

#on_send(node) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 82

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

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