Class: Rubyzen::Declarations::FileDeclaration

Inherits:
Object
  • Object
show all
Includes:
Providers::BlocksProvider, Providers::CallSiteProvider, Providers::ConstantsProvider, Providers::FilePathProvider, Providers::LineNumberProvider, Providers::LinesOfCodeProvider, Providers::RequiresProvider
Defined in:
lib/rubyzen/declarations/file_declaration.rb

Overview

Represents a parsed Ruby source file. This is the root of the declaration hierarchy — all other declarations are accessed through a FileDeclaration.

Examples:

project = Rubyzen::Project.new("/app/src")
file = project.files.first
file.name      #=> "user.rb"
file.classes   #=> [ClassDeclaration, ...]

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Providers::BlocksProvider

#blocks

Methods included from Providers::CallSiteProvider

#call_sites

Methods included from Providers::RequiresProvider

#requires

Methods included from Providers::ConstantsProvider

#constants

Methods included from Providers::LinesOfCodeProvider

#lines_of_code

Methods included from Providers::LineNumberProvider

#line

Methods included from Providers::FilePathProvider

#file_path

Constructor Details

#initialize(path, ast) ⇒ FileDeclaration

Returns a new instance of FileDeclaration.

Parameters:

  • path (String) —

    absolute file path

  • ast (RuboCop::AST::Node) —

    parsed AST root node



31
32
33
34
 
# File 'lib/rubyzen/declarations/file_declaration.rb', line 31

def initialize(path, ast)
  @path = path
  @node = ast
end

Instance Attribute Details

#node ⇒ RuboCop::AST::Node (readonly) Also known as: ast

Returns the root AST node.

Returns:

  • (RuboCop::AST::Node) —

    the root AST node



26
27
28
 
# File 'lib/rubyzen/declarations/file_declaration.rb', line 26

def node
  @node
end

#path ⇒ String (readonly)

Returns absolute path to the source file.

Returns:

  • (String) —

    absolute path to the source file



23
24
25
 
# File 'lib/rubyzen/declarations/file_declaration.rb', line 23

def path
  @path
end

Instance Method Details

#classes ⇒ Array<ClassDeclaration>

Returns all classes defined in this file.

Returns:



46
47
48
49
50
 
# File 'lib/rubyzen/declarations/file_declaration.rb', line 46

def classes
  node.each_node(:class).map do |class_node|
    ClassDeclaration.new(class_node, self)
  end
end

#modules ⇒ Array<ModuleDeclaration>

Returns all modules defined in this file.

Returns:



63
64
65
66
67
 
# File 'lib/rubyzen/declarations/file_declaration.rb', line 63

def modules
  node.each_node(:module).map do |module_node|
    Rubyzen::Declarations::ModuleDeclaration.new(module_node, self)
  end
end

#name ⇒ String

Returns the basename of the file.

Returns:

  • (String) —

    e.g. “user.rb”



39
40
41
 
# File 'lib/rubyzen/declarations/file_declaration.rb', line 39

def name
  File.basename(path)
end

#top_level_module_name ⇒ String?

Returns the name of the first module in the file, used to determine the top-level namespace.

Returns:

  • (String, nil) 


56
57
58
 
# File 'lib/rubyzen/declarations/file_declaration.rb', line 56

def top_level_module_name
  modules.first&.name_without_modules
end