123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Bundler::DuplicatedGem

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/bundler/duplicated_gem.rb

Overview

A Gem’s requirements should be listed only once in a Gemfile.

Examples:

# bad
gem 'rubocop'
gem 'rubocop'

# bad
group :development do
  gem 'rubocop'
end

group :test do
  gem 'rubocop'
end

# good
group :development, :test do
  gem 'rubocop'
end

# good
gem 'rubocop', groups: [:development, :test]

# good - conditional declaration
if Dir.exist?(local)
  gem 'rubocop', path: local
elsif ENV['RUBOCOP_VERSION'] == 'master'
  gem 'rubocop', git: 'https://github.com/rubocop/rubocop.git'
else
  gem 'rubocop', '~> 0.90.0'
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 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::RangeHelp - Included

#add_range, #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
#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 Method Details

#conditional_declaration?(nodes) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/bundler/duplicated_gem.rb', line 67

def conditional_declaration?(nodes)
  parent = nodes[0].each_ancestor.find { |ancestor| !ancestor.begin_type? }
  return false unless parent&.if_type? || parent&.when_type?

  root_conditional_node = parent.if_type? ? parent : parent.parent
  nodes.all? { |node| within_conditional?(node, root_conditional_node) }
end

#duplicated_gem_nodes (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/bundler/duplicated_gem.rb', line 60

def duplicated_gem_nodes
  gem_declarations(processed_source.ast)
    .group_by(&:first_argument)
    .values
    .select { |nodes| nodes.size > 1 && !conditional_declaration?(nodes) }
end

#gem_declarations(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/bundler/duplicated_gem.rb', line 58

def_node_search :gem_declarations, '(send nil? :gem str ...)'

#on_new_investigation

[ GitHub ]

  
# File 'lib/rubocop/cop/bundler/duplicated_gem.rb', line 45

def on_new_investigation
  return if processed_source.blank?

  duplicated_gem_nodes.each do |nodes|
    nodes[1..].each do |node|
      register_offense(node, node.first_argument.to_a.first, nodes.first.first_line)
    end
  end
end

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

[ GitHub ]

  
# File 'lib/rubocop/cop/bundler/duplicated_gem.rb', line 81

def register_offense(node, gem_name, 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,
    gem_name: gem_name,
    line_of_first_occurrence: line_of_first_occurrence
  )
  add_offense(offense_location, message: message)
end

#within_conditional?(node, conditional_node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/bundler/duplicated_gem.rb', line 75

def within_conditional?(node, conditional_node)
  conditional_node.branches.any? do |branch|
    branch == node || branch.child_nodes.include?(node)
  end
end