Class: RuboCop::Cop::Bundler::GemFilename

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

Overview

Verifies that a project contains Gemfile or gems.rb file and correct associated lock file based on the configuration.

Examples:

EnforcedStyle: Gemfile (default)

# bad
Project contains gems.rb and gems.locked files

# bad
Project contains Gemfile and gems.locked file

# good
Project contains Gemfile and Gemfile.lock

EnforcedStyle: gems.rb

# bad
Project contains Gemfile and Gemfile.lock files

# bad
Project contains gems.rb and Gemfile.lock file

# good
Project contains gems.rb and gems.locked files

Constant Summary collapse

MSG_GEMFILE_REQUIRED = 
'`gems.rb` file was found but `Gemfile` is required ' \
'(file path: %<file_path>s).'
MSG_GEMS_RB_REQUIRED = 
'`Gemfile` was found but `gems.rb` file is required ' \
'(file path: %<file_path>s).'
MSG_GEMFILE_MISMATCHED = 
'Expected a `Gemfile.lock` with `Gemfile` but found ' \
'`gems.locked` file (file path: %<file_path>s).'
MSG_GEMS_RB_MISMATCHED = 
'Expected a `gems.locked` file with `gems.rb` but found ' \
'`Gemfile.lock` (file path: %<file_path>s).'
GEMFILE_FILES = 
%w[Gemfile Gemfile.lock].freeze
GEMS_RB_FILES = 
%w[gems.rb gems.locked].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 included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

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

#on_new_investigation ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 42

def on_new_investigation
  file_path = processed_source.file_path
  basename = File.basename(file_path)
  return if expected_gemfile?(basename)

  register_offense(file_path, basename)
end