Class: RuboCop::Cop::Bundler::DuplicatedGroup

Inherits:
RuboCop::Cop::Base show all
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/bundler/duplicated_group.rb

Overview

A Gem group, or a set of groups, should be listed only once in a Gemfile.

For example, if the values of ‘source`, `git`, `platforms`, or `path` surrounding `group` are different, no offense will be registered:

source,ruby

platforms :ruby do

group :default do
  gem 'openssl'
end

end

platforms :jruby do

group :default do
  gem 'jruby-openssl'
end

end

Examples:

# bad
group :development do
  gem 'rubocop'
end

group :development do
  gem 'rubocop-rails'
end

# bad (same set of groups declared twice)
group :development, :test do
  gem 'rubocop'
end

group :test, :development do
  gem 'rspec'
end

# good
group :development do
  gem 'rubocop'
end

group :development, :test do
  gem 'rspec'
end

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

Constant Summary collapse

MSG = 
'Gem group `%<group_name>s` already defined on line ' \
'%<line_of_first_occurrence>d of the Gemfile.'
SOURCE_BLOCK_NAMES = 
%i[source git platforms path].freeze

Constants inherited from RuboCop::Cop::Base

RuboCop::Cop::Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from RuboCop::Cop::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?, #message, #offenses, #on_investigation_end, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, 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

#group_declarations(node) ⇒ Object 



66
 
# File 'lib/rubocop/cop/bundler/duplicated_group.rb', line 66

def_node_search :group_declarations, '(send nil? :group ...)'

#on_new_investigation ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/rubocop/cop/bundler/duplicated_group.rb', line 68

def on_new_investigation
  return if processed_source.blank?

  duplicated_group_nodes.each do |nodes|
    nodes[1..].each do |node|
      group_name = node.arguments.map(&:source).join(', ')

      register_offense(node, group_name, nodes.first.first_line)
    end
  end
end