class RuboCop::Cop::Bundler::DuplicatedGroup

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


@example

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

Constants

MSG
SOURCE_BLOCK_NAMES

Public Instance Methods

on_new_investigation() click to toggle source
# 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

Private Instance Methods

duplicated_group_nodes() click to toggle source
# File lib/rubocop/cop/bundler/duplicated_group.rb, line 82
def duplicated_group_nodes
  group_declarations = group_declarations(processed_source.ast)
  group_keys = group_declarations.group_by do |node|
    source_key = find_source_key(node)
    group_attributes = group_attributes(node).sort.join

    "#{source_key}#{group_attributes}"
  end

  group_keys.values.select { |nodes| nodes.size > 1 }
end
find_source_key(node) click to toggle source
# File lib/rubocop/cop/bundler/duplicated_group.rb, line 105
def find_source_key(node)
  source_block = node.each_ancestor(:block).find do |block_node|
    SOURCE_BLOCK_NAMES.include?(block_node.method_name)
  end

  return unless source_block

  "#{source_block.method_name}#{source_block.send_node.first_argument&.source}"
end
group_attributes(node) click to toggle source
# File lib/rubocop/cop/bundler/duplicated_group.rb, line 115
def group_attributes(node)
  node.arguments.map do |argument|
    if argument.hash_type?
      argument.pairs.map(&:source).sort.join(', ')
    else
      argument.respond_to?(:value) ? argument.value.to_s : argument.source
    end
  end
end
register_offense(node, group_name, line_of_first_occurrence) click to toggle source
# File lib/rubocop/cop/bundler/duplicated_group.rb, line 94
def register_offense(node, group_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,
    group_name: group_name,
    line_of_first_occurrence: line_of_first_occurrence
  )
  add_offense(offense_location, message: message)
end