Class: RuboCop::Cop::Gemspec::DuplicatedAssignment

Inherits:
Base
  • Object
show all
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/gemspec/duplicated_assignment.rb

Overview

An attribute assignment method calls should be listed only once in a gemspec.

Assigning to an attribute with the same name using `spec.foo =` will be an unintended usage. On the other hand, duplication of methods such as `spec.requirements`, `spec.add_runtime_dependency`, and others are permitted because it is the intended use of appending values.

Examples:

# bad
Gem::Specification.new do |spec|
  spec.name = 'rubocop'
  spec.name = 'rubocop2'
end

# good
Gem::Specification.new do |spec|
  spec.name = 'rubocop'
end

# good
Gem::Specification.new do |spec|
  spec.requirements << 'libmagick, v6.0'
  spec.requirements << 'A good graphics card'
end

# good
Gem::Specification.new do |spec|
  spec.add_runtime_dependency('parallel', '~> 1.10')
  spec.add_runtime_dependency('parser', '>= 2.3.3.1', '< 3.0')
end

Constant Summary collapse

MSG =
'`%<assignment>s` method calls already given on line '\
'%<line_of_first_occurrence>d of the gemspec.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from 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_other_file, #parse, #ready, #relevant_file?, 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?, #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

#assignment_method_declarations(node) ⇒ Object


54
55
56
57
# File 'lib/rubocop/cop/gemspec/duplicated_assignment.rb', line 54

def_node_search :assignment_method_declarations, <<~PATTERN
  (send
    (lvar #match_block_variable_name?) #assignment_method? ...)
PATTERN

#gem_specification(node) ⇒ Object


44
45
46
47
48
49
50
51
# File 'lib/rubocop/cop/gemspec/duplicated_assignment.rb', line 44

def_node_search :gem_specification, <<~PATTERN
  (block
    (send
      (const
        (const {cbase nil?} :Gem) :Specification) :new)
    (args
      (arg $_)) ...)
PATTERN

#on_new_investigationObject


59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/rubocop/cop/gemspec/duplicated_assignment.rb', line 59

def on_new_investigation
  return if processed_source.blank?

  duplicated_assignment_method_nodes.each do |nodes|
    nodes[1..-1].each do |node|
      register_offense(
        node,
        node.method_name,
        nodes.first.first_line
      )
    end
  end
end