123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Gemspec::DeprecatedAttributeAssignment

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/gemspec/deprecated_attribute_assignment.rb

Overview

Checks that deprecated attributes are not set in a gemspec file. Removing deprecated attributes allows the user to receive smaller packed gems.

Examples:

# bad
Gem::Specification.new do |spec|
  spec.name = 'your_cool_gem_name'
  spec.test_files = Dir.glob('test/**/*')
end

# bad
Gem::Specification.new do |spec|
  spec.name = 'your_cool_gem_name'
  spec.test_files += Dir.glob('test/**/*')
end

# good
Gem::Specification.new do |spec|
  spec.name = 'your_cool_gem_name'
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::AutoCorrector - Extended

::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

Alias for 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_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

#format_message_from (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/deprecated_attribute_assignment.rb', line 86

def format_message_from
  format(MSG, attribute: @attribute)
end

#gem_specification(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/deprecated_attribute_assignment.rb', line 35

def_node_matcher :gem_specification, <<~PATTERN
  (block
    (send
      (const
        (const {cbase nil?} :Gem) :Specification) :new)
    ...)
PATTERN

#node_and_method_name(node, attribute) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/deprecated_attribute_assignment.rb', line 63

def node_and_method_name(node, attribute)
  if node.op_asgn_type?
    lhs, _op, _rhs = *node
    [lhs, attribute]
  else
    [node, :"#{attribute}="]
  end
end

#on_block(block_node)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/deprecated_attribute_assignment.rb', line 43

def on_block(block_node)
  return unless gem_specification(block_node)

  block_parameter = block_node.first_argument.source

  assignment = block_node.descendants.detect do |node|
    use_deprecated_attributes?(node, block_parameter)
  end
  return unless assignment

  message = format_message_from
  add_offense(assignment, message: message) do |corrector|
    range = range_by_whole_lines(assignment.source_range, include_final_newline: true)

    corrector.remove(range)
  end
end

#use_deprecated_attributes?(node, block_parameter) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/gemspec/deprecated_attribute_assignment.rb', line 72

def use_deprecated_attributes?(node, block_parameter)
  %i[test_files date specification_version rubygems_version].each do |attribute|
    node, method_name = node_and_method_name(node, attribute)
    unless node.send_type? && node.receiver&.source == block_parameter &&
           node.method?(method_name)
      next
    end

    @attribute = attribute.to_s
    return true
  end
  false
end