123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
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

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

Class Attribute Summary

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.

.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.

.badge

Naming.

.callbacks_needed, .cop_name, .department,
.documentation_url

Returns an url to view this cops documentation online.

.exclude_from_registry

Call for abstract Cop classes.

.inherited,
.joining_forces

Override and return the Force class(es) you need to join.

.match?

Returns true if the cop name or the cop namespace matches any of the given names.

.new,
.requires_gem

Register a version requirement for the given gem name.

.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::GemspecHelp - Included

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.

#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.

#begin_investigation

Called before any investigation.

#callbacks_needed,
#cop_config

Configuration Helpers.

#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:

#inspect
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#name

Alias for Base#cop_name.

#offenses,
#on_investigation_end

Called after all on_…​

#on_new_investigation

Called before all on_…​

#on_other_file

Called instead of all on_…​

#parse

There should be very limited reasons for a Cop to do it’s own parsing.

#parser_engine,
#ready

Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Attribute Details

#forbidden_style?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 138

def forbidden_style?
  style == :forbidden
end

#required_style?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 142

def required_style?
  style == :required
end

Instance Method Details

#add_dependency_method?(method_name) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 118

def add_dependency_method?(method_name)
  ADD_DEPENDENCY_METHODS.include?(method_name)
end

#add_dependency_method_declaration?(node)

[ GitHub ]

  
# 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

#allowed_gem?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 96

def allowed_gem?(node)
  allowed_gems.include?(node.first_argument.str_content)
end

#allowed_gems (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 100

def allowed_gems
  Array(cop_config['AllowedGems'])
end

#forbidden_offense?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 132

def forbidden_offense?(node)
  return false unless forbidden_style?

  includes_version_specification?(node) || includes_commit_reference?(node)
end

#includes_commit_reference?(node)

[ GitHub ]

  
# 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)

[ GitHub ]

  
# 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

#match_block_variable_name?(receiver_name) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 112

def match_block_variable_name?(receiver_name)
  gem_specification(processed_source.ast) do |block_variable_name|
    return block_variable_name == receiver_name
  end
end

#message(_range) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 104

def message(_range)
  if required_style?
    REQUIRED_MSG
  elsif forbidden_style?
    FORBIDDEN_MSG
  end
end

#offense?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 122

def offense?(node)
  required_offense?(node) || forbidden_offense?(node)
end

#on_send(node)

[ GitHub ]

  
# 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

#required_offense?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 126

def required_offense?(node)
  return false unless required_style?

  !includes_version_specification?(node) && !includes_commit_reference?(node)
end

#version_specification?(expression) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/dependency_version.rb', line 146

def version_specification?(expression)
  expression.match?(VERSION_SPECIFICATION_REGEX)
end