123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
self, ::RuboCop::Cop::GemspecHelp, ::RuboCop::Cop::RangeHelp, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
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 = or spec.attribute#[]= 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_dependency('parallel', '~> 1.10')
  spec.add_dependency('parser', '>= 2.3.3.1', '< 3.0')
end

# bad
Gem::Specification.new do |spec|
  spec.metadata["key"] = "value"
  spec.metadata["key"] = "value"
end

# good
Gem::Specification.new do |spec|
  spec.metadata["key"] = "value"
end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

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

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

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

Instance Method Summary

::RuboCop::Cop::GemspecHelp - Included

#gem_specification, #gem_specification?

::RuboCop::Cop::RangeHelp - Included

#add_range,
#arguments_range

A range containing the first to the last argument of a method call or method definition.
#column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.
#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::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_gem_version

Returns a gems locked versions (i.e.
#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

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #eol_comment, #eol_comment_would_be_inside_literal?, #heredoc_range, #line_with_eol_comment_too_long?, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Method Details

#assignment_method_declarations(node)

[ GitHub ] 

  


# File 'lib/rubocop/cop/gemspec/duplicated_assignment.rb', line 58



def_node_search :assignment_method_declarations, <<~PATTERN
  (send
    (lvar {#match_block_variable_name? :_1 :it}) _ ...)
PATTERN


  








  

    #duplicated_assignment_method_nodes   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/gemspec/duplicated_assignment.rb', line 105



def duplicated_assignment_method_nodes
  assignment_method_declarations(processed_source.ast)
    .select(&:assignment_method?)
    .group_by(&:method_name)
    .values
    .select { |nodes| nodes.size > 1 }
end


  








  

    #duplicated_indexed_assignment_method_nodes   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/gemspec/duplicated_assignment.rb', line 113



def duplicated_indexed_assignment_method_nodes
  indexed_assignment_method_declarations(processed_source.ast)
    .group_by { |node| [node.children.first.method_name, node.first_argument] }
    .values
    .select { |nodes| nodes.size > 1 }
end


  








  

    #indexed_assignment_method_declarations(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/gemspec/duplicated_assignment.rb', line 64



def_node_search :indexed_assignment_method_declarations, <<~PATTERN
  (send
    (send (lvar {#match_block_variable_name? :_1 :it}) _)
    :[]=
    literal?
    _
  )
PATTERN


  








  

    #match_block_variable_name?(receiver_name)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/gemspec/duplicated_assignment.rb', line 99



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


  








  

    #on_new_investigation  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/gemspec/duplicated_assignment.rb', line 73



def on_new_investigation
  return if processed_source.blank?

  process_assignment_method_nodes
  process_indexed_assignment_method_nodes
end


  








  

    #process_assignment_method_nodes   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/gemspec/duplicated_assignment.rb', line 82



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


  








  

    #process_indexed_assignment_method_nodes   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/gemspec/duplicated_assignment.rb', line 90



def process_indexed_assignment_method_nodes
  duplicated_indexed_assignment_method_nodes.each do |nodes|
    nodes[1..].each do |node|
      assignment = "#{node.children.first.method_name}[#{node.first_argument.source}]="
      register_offense(node, assignment, nodes.first.first_line)
    end
  end
end


  








  

    #register_offense(node, assignment, line_of_first_occurrence)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/gemspec/duplicated_assignment.rb', line 120



def register_offense(node, assignment, line_of_first_occurrence)
  line_range = node.loc.column...node.loc.last_column
  offense_location = source_range(processed_source.buffer, node.first_line, line_range)
  message = format(
    MSG,
    assignment: assignment,
    line_of_first_occurrence: line_of_first_occurrence
  )
  add_offense(offense_location, message: message)
end