Class: Solargraph::SourceMap::Clip

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

Overview

A static analysis tool for obtaining definitions, Completions, signatures, and type inferences from a Cursor.

Instance Method Summary collapse

Constructor Details

#initialize(api_map, cursor) ⇒ Clip

Returns a new instance of Clip.

Parameters:



11
12
13
14
15
16
17
 
# File 'lib/solargraph/source_map/clip.rb', line 11

def initialize api_map, cursor
  @api_map = api_map
  @cursor = cursor
  block_pin = block
  block_pin.rebind(api_map) if block_pin.is_a?(Pin::Block) && !Solargraph::Range.from_node(block_pin.receiver).contain?(cursor.range.start)
  @in_block = nil
end

Instance Method Details

#complete ⇒ Completion

Returns:



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/solargraph/source_map/clip.rb', line 34

def complete
  return package_completions([]) if !source_map.source.parsed? || cursor.string?
  return package_completions(api_map.get_symbols) if cursor.chain.literal? && cursor.chain.links.last.word == '<Symbol>'
  return Completion.new([], cursor.range) if cursor.chain.literal?
  if cursor.comment?
    tag_complete
  else
    code_complete
  end
end

#define ⇒ Array<Pin::Base>

Returns Relevant pins for infering the type of the Cursor’s position.

Returns:

  • (Array<Pin::Base>) —

    Relevant pins for infering the type of the Cursor’s position



20
21
22
23
24
25
26
 
# File 'lib/solargraph/source_map/clip.rb', line 20

def define
  return [] if cursor.comment? || cursor.chain.literal?
  result = cursor.chain.define(api_map, block, locals)
  result.concat file_global_methods
  result.concat((source_map.pins + source_map.locals).select{ |p| p.name == cursor.word && p.location.range.contain?(cursor.position) }) if result.empty?
  result
end

#gates ⇒ ::Array<String>

Returns:

  • (::Array<String>) 


74
75
76
 
# File 'lib/solargraph/source_map/clip.rb', line 74

def gates
  block.gates
end

#in_block? ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
81
82
83
84
 
# File 'lib/solargraph/source_map/clip.rb', line 78

def in_block?
  return @in_block unless @in_block.nil?
  @in_block = begin
    tree = cursor.source.tree_at(cursor.position.line, cursor.position.column)
    Parser.is_ast_node?(tree[1]) && [:block, :ITER].include?(tree[1].type)
  end
end

#infer ⇒ ComplexType

Returns:



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/solargraph/source_map/clip.rb', line 53

def infer
  result = cursor.chain.infer(api_map, block, locals)
  if result.tag == 'Class'
    # HACK: Exception to return BasicObject from Class#new
    dfn = cursor.chain.define(api_map, block, locals).first
    return ComplexType.try_parse('::BasicObject') if dfn && dfn.path == 'Class#new'
  end
  return result unless result.tag == 'self'
  cursor.chain.base.infer(api_map, block, locals)
end

#locals ⇒ ::Array<Solargraph::Pin::Base>

Get an array of all the locals that are visible from the cursors’s position. Locals can be local variables, method parameters, or block parameters. The array starts with the nearest local pin.

Returns:



69
70
71
 
# File 'lib/solargraph/source_map/clip.rb', line 69

def locals
  @locals ||= source_map.locals_at(location)
end

#signify ⇒ Array<Pin::Method>

Returns:



46
47
48
49
50
 
# File 'lib/solargraph/source_map/clip.rb', line 46

def signify
  return [] unless cursor.argument?
  chain = Parser.chain(cursor.recipient_node, cursor.filename)
  chain.define(api_map, context_pin, locals).select { |pin| pin.is_a?(Pin::Method) }
end

#translate(phrase) ⇒ Array<Solargraph::Pin::Base>

Parameters:

  • phrase (String)

Returns:



88
89
90
91
 
# File 'lib/solargraph/source_map/clip.rb', line 88

def translate phrase
  chain = Parser.chain(Parser.parse(phrase))
  chain.define(api_map, block, locals)
end

#types ⇒ Array<Pin::Base>

Returns:



29
30
31
 
# File 'lib/solargraph/source_map/clip.rb', line 29

def types
  infer.namespaces.map { |namespace| api_map.get_path_pins(namespace) }.flatten
end