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

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::ConfigurableEnforcedStyle`, `::RuboCop::Cop::Base`, `::RuboCop::Cop::AutocorrectLogic`, `::RuboCop::Cop::IgnoredNode`, `::RuboCop::Util`, RuboCop::AST::Sexp
Inherits:	RuboCop::Cop::Base Object RuboCop::Cop::Base RuboCop::Cop::Bundler::GemFilename
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

GEMFILE_FILES =
# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 39
```
%w[Gemfile Gemfile.lock].freeze
```
GEMS_RB_FILES =
# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 40
```
%w[gems.rb gems.locked].freeze
```

MSG_GEMFILE_MISMATCHED =
# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 35

'Expected a `Gemfile.lock` with `Gemfile` but found ' \
'`gems.locked` file (file path: %<file_path>s).'

MSG_GEMFILE_REQUIRED =
# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 31

'`gems.rb` file was found but `Gemfile` is required ' \
'(file path: %<file_path>s).'

MSG_GEMS_RB_MISMATCHED =
# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 37

'Expected a `gems.locked` file with `gems.rb` but found ' \
'`Gemfile.lock` (file path: %<file_path>s).'

MSG_GEMS_RB_REQUIRED =
# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 33

'`Gemfile` was found but `gems.rb` file is required ' \
'(file path: %<file_path>s).'

`::RuboCop::Cop::Base` - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

SYMBOL_TO_STRING_CACHE

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

#gemfile_required? ⇒ Boolean readonly private
#gems_rb_required? ⇒ Boolean readonly private

Instance Method Summary

#on_new_investigation
#expected_gemfile?(basename) ⇒ Boolean private
#gemfile_offense?(basename) ⇒ Boolean private
#gems_rb_offense?(basename) ⇒ Boolean private
#register_gemfile_offense(file_path, basename) private
#register_gems_rb_offense(file_path, basename) private
#register_offense(file_path, basename) private

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

#alternative_style, #alternative_styles, #ambiguous_style_detected,
#conflicting_styles_detected	Alias for ConfigurableEnforcedStyle#no_acceptable_style!.
#correct_style_detected, #no_acceptable_style!, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected,
#unrecognized_style_detected	Alias for ConfigurableEnforcedStyle#no_acceptable_style!.

`::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 RuboCop::Cop::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, #heredoc_range, #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, #range_overlaps_offense?, #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 Attribute Details

#gemfile_required? ⇒ `Boolean` (readonly, private)

[ GitHub ]

# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 92


def gemfile_required?
  style == :Gemfile
end

#gems_rb_required? ⇒ `Boolean` (readonly, private)

[ GitHub ]

# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 96


def gems_rb_required?
  style == :'gems.rb'
end

Instance Method Details

#expected_gemfile?(basename) ⇒ `Boolean` (private)

[ GitHub ]

# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 87


def expected_gemfile?(basename)
  (gemfile_required? && GEMFILE_FILES.include?(basename)) ||
    (gems_rb_required? && GEMS_RB_FILES.include?(basename))
end

#gemfile_offense?(basename) ⇒ `Boolean` (private)

[ GitHub ]

# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 79


def gemfile_offense?(basename)
  gemfile_required? && GEMS_RB_FILES.include?(basename)
end

#gems_rb_offense?(basename) ⇒ `Boolean` (private)

[ GitHub ]

# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 83


def gems_rb_offense?(basename)
  gems_rb_required? && GEMFILE_FILES.include?(basename)
end

#on_new_investigation

[ GitHub ]

# 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

#register_gemfile_offense(file_path, basename) (private)

[ GitHub ]

# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 57


def register_gemfile_offense(file_path, basename)
  message = case basename
            when 'gems.rb'
              MSG_GEMFILE_REQUIRED
            when 'gems.locked'
              MSG_GEMFILE_MISMATCHED
            end

  add_global_offense(format(message, file_path: file_path))
end

#register_gems_rb_offense(file_path, basename) (private)

[ GitHub ]

# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 68


def register_gems_rb_offense(file_path, basename)
  message = case basename
            when 'Gemfile'
              MSG_GEMS_RB_REQUIRED
            when 'Gemfile.lock'
              MSG_GEMS_RB_MISMATCHED
            end

  add_global_offense(format(message, file_path: file_path))
end

#register_offense(file_path, basename) (private)

[ GitHub ]

# File 'lib/rubocop/cop/bundler/gem_filename.rb', line 52


def register_offense(file_path, basename)
  register_gemfile_offense(file_path, basename) if gemfile_offense?(basename)
  register_gems_rb_offense(file_path, basename) if gems_rb_offense?(basename)
end

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

Overview

Constant Summary

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

Class Attribute Summary

::RuboCop::Cop::Base - Inherited

Class Method Summary

::RuboCop::Cop::Base - Inherited

::RuboCop::ExcludeLimit - Extended

Instance Attribute Summary

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

Instance Method Summary

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

Instance Attribute Details

#gemfile_required? ⇒ Boolean (readonly, private)

#gems_rb_required? ⇒ Boolean (readonly, private)

Instance Method Details

#expected_gemfile?(basename) ⇒ Boolean (private)

#gemfile_offense?(basename) ⇒ Boolean (private)

#gems_rb_offense?(basename) ⇒ Boolean (private)

#on_new_investigation

#register_gemfile_offense(file_path, basename) (private)

#register_gems_rb_offense(file_path, basename) (private)

#register_offense(file_path, basename) (private)

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::ExcludeLimit` - Extended

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::AutocorrectLogic` - Included

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::AutocorrectLogic` - Included

`::RuboCop::Cop::IgnoredNode` - Included

#gemfile_required? ⇒ `Boolean` (readonly, private)

#gems_rb_required? ⇒ `Boolean` (readonly, private)

#expected_gemfile?(basename) ⇒ `Boolean` (private)

#gemfile_offense?(basename) ⇒ `Boolean` (private)

#gems_rb_offense?(basename) ⇒ `Boolean` (private)