Class: Solargraph::SourceMap::Region

Inherits:
Object
  • Object
show all
Defined in:
lib/solargraph/source_map/region.rb

Overview

Data used by the NodeProcessor library to track context at various locations in a source.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source: Solargraph::Source.load_string(''), namespace: '', scope: :instance, visibility: :public) ⇒ Region

Returns a new instance of Region.

Parameters:

  • source (Source) (defaults to: Solargraph::Source.load_string(''))
  • namespace (String) (defaults to: '')
  • scope (Symbol) (defaults to: :instance)
  • visibility (Symbol) (defaults to: :public) 


23
24
25
26
27
28
29
 
# File 'lib/solargraph/source_map/region.rb', line 23

def initialize source: Solargraph::Source.load_string(''), namespace: '',
               scope: :instance, visibility: :public
  @source = source
  @namespace = namespace
  @scope = scope
  @visibility = visibility
end

Instance Attribute Details

#namespace ⇒ String (readonly)

Returns:

  • (String) 


8
9
10
 
# File 'lib/solargraph/source_map/region.rb', line 8

def namespace
  @namespace
end

#scope ⇒ Symbol (readonly)

Returns:

  • (Symbol) 


11
12
13
 
# File 'lib/solargraph/source_map/region.rb', line 11

def scope
  @scope
end

#source ⇒ Solargraph::Source (readonly)

Returns:



17
18
19
 
# File 'lib/solargraph/source_map/region.rb', line 17

def source
  @source
end

#visibility ⇒ Symbol (readonly)

Returns:

  • (Symbol) 


14
15
16
 
# File 'lib/solargraph/source_map/region.rb', line 14

def visibility
  @visibility
end

Instance Method Details

#code_for(node) ⇒ String

Parameters:

  • node (Parser::AST::Node)

Returns:

  • (String) 


53
54
55
 
# File 'lib/solargraph/source_map/region.rb', line 53

def code_for node
  source.code_for(node)
end

#filename ⇒ String

Returns:

  • (String) 


32
33
34
 
# File 'lib/solargraph/source_map/region.rb', line 32

def filename
  source.filename
end

#update(namespace: nil, scope: nil, visibility: nil) ⇒ Region

Generate a new Region with the provided attribute changes.

Parameters:

  • namespace (String, nil) (defaults to: nil)
  • scope (Symbol, nil) (defaults to: nil)
  • visibility (Symbol, nil) (defaults to: nil)

Returns:



42
43
44
45
46
47
48
49
 
# File 'lib/solargraph/source_map/region.rb', line 42

def update namespace: nil, scope: nil, visibility: nil
  Region.new(
    source: source,
    namespace: namespace || self.namespace,
    scope: scope || self.scope,
    visibility: visibility || self.visibility
  )
end