Module: RailsAutoloading

Included in:
RuboCop::Cop::Airbnb::ClassOrModuleDeclaredInWrongFile, RuboCop::Cop::Airbnb::ConstAssignedInWrongFile, RuboCop::Cop::Airbnb::ModuleMethodInWrongFile
Defined in:
lib/rubocop/airbnb/rails_autoloading.rb

Overview

These methods are useful for Rubocop rules related to Rails autoloading.

Instance Method Summary collapse

Instance Method Details

#allowable_paths_for(expected_dir, options = {}) ⇒ Object

Given “foo/bar/baz”, return: [

%r{/foo.rb$},
%r{/foo/bar.rb$},
%r{/foo/bar/baz.rb$},
%r{/foo/bar/baz/}, # <= only if allow_dir = true

]



20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/rubocop/airbnb/rails_autoloading.rb', line 20

def allowable_paths_for(expected_dir, options = {})
  options = { allow_dir: false }.merge(options)
  allowable_paths = []
  next_slash = expected_dir.index("/")
  while next_slash
    allowable_paths << %r{/#{expected_dir[0...next_slash]}.rb$}
    next_slash = expected_dir.index("/", next_slash + 1)
  end
  allowable_paths << %r{#{expected_dir}.rb$}
  allowable_paths << %r{/#{expected_dir}/} if options[:allow_dir]
  allowable_paths
end

#full_const_name(parent_module_name, const_name) ⇒ Object 



48
49
50
51
52
53
54
 
# File 'lib/rubocop/airbnb/rails_autoloading.rb', line 48

def full_const_name(parent_module_name, const_name)
  if parent_module_name == "".freeze
    "#{const_name}"
  else
    "#{parent_module_name}::#{const_name}"
  end
end

#normalize_module_name(module_name) ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/rubocop/airbnb/rails_autoloading.rb', line 33

def normalize_module_name(module_name)
  return '' if module_name.nil?
  normalized_name = module_name.gsub(/#<Class:|>/, "")
  normalized_name = "" if normalized_name == "Object"
  normalized_name
end

#run_rails_autoloading_cops?(path) ⇒ Boolean

Returns:

  • (Boolean) 


3
4
5
6
7
8
9
10
11
 
# File 'lib/rubocop/airbnb/rails_autoloading.rb', line 3

def run_rails_autoloading_cops?(path)
  return false unless config["Rails".freeze]
  return false unless config["Rails".freeze]["Enabled".freeze]

  # Ignore rake tasks
  return false unless path.end_with?(".rb")

  true
end

#split_modules(module_name) ⇒ Object

module_name looks like one of these:

Foo::Bar for an instance method
#<Class:Foo::Bar> for a class method.

For either case we return [“Foo”, “Bar”]



44
45
46
 
# File 'lib/rubocop/airbnb/rails_autoloading.rb', line 44

def split_modules(module_name)
  normalize_module_name(module_name).split("::")
end