Class: Fastererer::Offense

Inherits:
Object
  • Object
show all
Defined in:
lib/fastererer/offense.rb

Constant Summary collapse

EXPLANATIONS = 
{
  rescue_vs_respond_to:
    'Don\'t rescue NoMethodError, rather check with respond_to?',

  module_eval:
    'Using module_eval is slower than define_method',

  shuffle_first_vs_sample:
    'Array#shuffle.first is slower than Array#sample',

  for_loop_vs_each:
    'For loop is slower than using each',

  each_with_index_vs_while:
    'Using each_with_index is slower than while loop',

  map_flatten_vs_flat_map:
    'Array#map.flatten(1) is slower than Array#flat_map',

  reverse_each_vs_reverse_each:
    'Array#reverse.each is slower than Array#reverse_each',

  select_first_vs_detect:
    'Array#select.first is slower than Array#detect',

  sort_vs_sort_by:
    'Enumerable#sort is slower than Enumerable#sort_by',

  fetch_with_argument_vs_block:
    'Hash#fetch with second argument is slower than Hash#fetch with block',

  keys_each_vs_each_key:
    'Hash#keys.each is slower than Hash#each_key. N.B. Hash#each_key cannot be used if ' \
    'the hash is modified during the each block',

  hash_merge_bang_vs_hash_brackets:
    'Hash#merge! with one argument is slower than Hash#[]',

  block_vs_symbol_to_proc:
    'Calling argumentless methods within blocks is slower than using symbol to proc',

  proc_call_vs_yield:
    'Calling blocks with call is slower than yielding',

  gsub_vs_tr:
    'Using tr is faster than gsub when replacing a single character in a string with ' \
    'another single character',

  select_last_vs_reverse_detect:
    'Array#select.last is slower than Array#reverse.detect',

  getter_vs_attr_reader:
    'Use attr_reader for reading ivars',

  setter_vs_attr_writer:
    'Use attr_writer for writing to ivars',

  include_vs_cover_on_range:
    'Use #cover? instead of #include? on ranges'
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(offense_name, line_number) ⇒ Offense

Returns a new instance of Offense.



10
11
12
13
14
 
# File 'lib/fastererer/offense.rb', line 10

def initialize(offense_name, line_number)
  @offense_name = offense_name
  @line_number  = line_number
  explanation # Set explanation right away.
end

Instance Attribute Details

#line_number ⇒ Object (readonly) Also known as: line

Returns the value of attribute line_number.



5
6
7
 
# File 'lib/fastererer/offense.rb', line 5

def line_number
  @line_number
end

#offense_name ⇒ Object (readonly) Also known as: name

Returns the value of attribute offense_name.



5
6
7
 
# File 'lib/fastererer/offense.rb', line 5

def offense_name
  @offense_name
end

Instance Method Details

#explanation ⇒ Object 



16
17
18
 
# File 'lib/fastererer/offense.rb', line 16

def explanation
  @explanation ||= EXPLANATIONS.fetch(offense_name)
end