Class: Solargraph::ApiMap::Store

Inherits:
Object
  • Object
show all
Defined in:
lib/solargraph/api_map/store.rb

Overview

Queryable collection of Pins representing a Workspace, gems and the Ruby core.

Constant Summary collapse

BOOLEAN_SUPERCLASS_PIN = 
Pin::Reference::Superclass.new(name: 'Boolean', closure: Pin::ROOT_PIN, source: :solargraph)
OBJECT_SUPERCLASS_PIN = 
Pin::Reference::Superclass.new(name: 'Object', closure: Pin::ROOT_PIN, source: :solargraph)

Instance Method Summary collapse

Constructor Details

#initialize(*pinsets) ⇒ Store

Returns a new instance of Store.

Parameters:



10
11
12
13
 
# File 'lib/solargraph/api_map/store.rb', line 10

def initialize *pinsets
  @pinsets = pinsets
  catalog pinsets
end

Instance Method Details

#block_pins ⇒ Enumerable<Pin::Block>

Returns:



191
192
193
 
# File 'lib/solargraph/api_map/store.rb', line 191

def block_pins
  pins_by_class(Pin::Block)
end

#constants ⇒ Constants

Returns:



265
266
267
 
# File 'lib/solargraph/api_map/store.rb', line 265

def constants
  @constants ||= Constants.new(self)
end

#domains(fqns) ⇒ Array<String>

Parameters:

Returns:



168
169
170
171
172
173
174
 
# File 'lib/solargraph/api_map/store.rb', line 168

def domains(fqns)
  result = []
  fqns_pins(fqns).each do |nspin|
    result.concat nspin.domains
  end
  result
end

#fqns_pins(fqns) ⇒ Array<Solargraph::Pin::Namespace>

Parameters:

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/solargraph/api_map/store.rb', line 204

def fqns_pins fqns
  return [] if fqns.nil?
  if fqns.include?('::')
    parts = fqns.split('::')
    name = parts.pop
    base = parts.join('::')
  else
    base = ''
    name = fqns
  end
  fqns_pins_map[[base, name]]
end

#get_ancestor_references(fqns) ⇒ Array<Solargraph::Pin::Reference>

Parameters:

Returns:



260
261
262
 
# File 'lib/solargraph/api_map/store.rb', line 260

def get_ancestor_references(fqns)
  (get_prepends(fqns) + get_includes(fqns) + [get_superclass(fqns)]).compact
end

#get_ancestors(fqns) ⇒ Array<String>

Get all ancestors (superclasses, includes, prepends, extends) for a namespace

Parameters:

  • The fully qualified namespace

Returns:

  • Array of ancestor namespaces including the original



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/solargraph/api_map/store.rb', line 220

def get_ancestors(fqns)
  return [] if fqns.nil? || fqns.empty?

  ancestors = [fqns]
  visited = Set.new
  queue = [fqns]

  until queue.empty?
    current = queue.shift
    next if current.nil? || current.empty? || visited.include?(current)
    visited.add(current)

    current = current.gsub(/^::/, '')

    # Add superclass

    ref = get_superclass(current)
    superclass = ref && constants.dereference(ref)
    if superclass && !superclass.empty? && !visited.include?(superclass)
      ancestors << superclass
      queue << superclass
    end

    # Add includes, prepends, and extends

    [get_includes(current), get_prepends(current), get_extends(current)].each do |refs|
      next if refs.nil?
      # @param ref [String]

      refs.map(&:type).map(&:to_s).each do |ref|
        next if ref.nil? || ref.empty? || visited.include?(ref)
        ancestors << ref
        queue << ref
      end
    end
  end

  ancestors.compact.uniq
end

#get_class_variables(fqns) ⇒ Enumerable<Solargraph::Pin::ClassVariable>

Parameters:

Returns:



141
142
143
 
# File 'lib/solargraph/api_map/store.rb', line 141

def get_class_variables(fqns)
  namespace_children(fqns).select { |pin| pin.is_a?(Pin::ClassVariable)}
end

#get_constants(fqns, visibility = [:public]) ⇒ Enumerable<Solargraph::Pin::Namespace, Solargraph::Pin::Constant>

Parameters:

  • (defaults to: [:public])

Returns:



61
62
63
64
65
66
 
# File 'lib/solargraph/api_map/store.rb', line 61

def get_constants fqns, visibility = [:public]
  namespace_children(fqns).select { |pin|
    # @sg-ignore flow-sensitive typing not smart enough to handle this case

    !pin.name.empty? && (pin.is_a?(Pin::Namespace) || pin.is_a?(Pin::Constant)) && visibility.include?(pin.visibility)
  }
end

#get_extends(fqns) ⇒ Array<Pin::Reference::Extend>

Parameters:

Returns:



119
120
121
 
# File 'lib/solargraph/api_map/store.rb', line 119

def get_extends fqns
  extend_references[fqns] || []
end

#get_includes(fqns) ⇒ Array<Pin::Reference::Include>

Parameters:

Returns:



107
108
109
 
# File 'lib/solargraph/api_map/store.rb', line 107

def get_includes fqns
  include_references[fqns] || []
end

#get_instance_variables(fqns, scope = :instance) ⇒ Enumerable<Solargraph::Pin::Base>

Parameters:

  • (defaults to: :instance)

    :class or :instance

Returns:



132
133
134
135
136
 
# File 'lib/solargraph/api_map/store.rb', line 132

def get_instance_variables(fqns, scope = :instance)
  all_instance_variables.select { |pin|
    pin.binder.namespace == fqns && pin.binder.scope == scope
  }
end

#get_methods(fqns, scope: :instance, visibility: [:public]) ⇒ Enumerable<Solargraph::Pin::Method>

Parameters:

  • (defaults to: :instance)
  • (defaults to: [:public])

Returns:



72
73
74
75
76
77
78
 
# File 'lib/solargraph/api_map/store.rb', line 72

def get_methods fqns, scope: :instance, visibility: [:public]
  all_pins = namespace_children(fqns).select do |pin|
    # @sg-ignore https://github.com/castwide/solargraph/pull/1114

    pin.is_a?(Pin::Method) && pin.scope == scope && visibility.include?(pin.visibility)
  end
  GemPins.combine_method_pins_by_path(all_pins)
end

#get_path_pins(path) ⇒ Array<Solargraph::Pin::Base>

Parameters:

Returns:



125
126
127
 
# File 'lib/solargraph/api_map/store.rb', line 125

def get_path_pins path
  index.path_pin_hash[path]
end

#get_prepends(fqns) ⇒ Array<Pin::Reference::Prepend>

Parameters:

Returns:



113
114
115
 
# File 'lib/solargraph/api_map/store.rb', line 113

def get_prepends fqns
  prepend_references[fqns] || []
end

#get_superclass(fqns) ⇒ Pin::Reference::Superclass

Parameters:

Returns:



85
86
87
88
89
90
 
# File 'lib/solargraph/api_map/store.rb', line 85

def get_superclass fqns
  return nil if fqns.nil? || fqns.empty?
  return BOOLEAN_SUPERCLASS_PIN if %w[TrueClass FalseClass].include?(fqns)

  superclass_references[fqns].first || try_special_superclasses(fqns)
end

#get_symbols ⇒ Enumerable<Solargraph::Pin::Base>

Returns:



146
147
148
 
# File 'lib/solargraph/api_map/store.rb', line 146

def get_symbols
  symbols.uniq(&:name)
end

#inspect ⇒ Object 



54
55
56
 
# File 'lib/solargraph/api_map/store.rb', line 54

def inspect
  to_s
end

#method_pins ⇒ Enumerable<Solargraph::Pin::Method>

Returns:



162
163
164
 
# File 'lib/solargraph/api_map/store.rb', line 162

def method_pins
  pins_by_class(Solargraph::Pin::Method)
end

#named_macros ⇒ Hash{String => YARD::Tags::MacroDirective}

Returns:



177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/solargraph/api_map/store.rb', line 177

def named_macros
  @named_macros ||= begin
    result = {}
    pins.each do |pin|
      pin.macros.select{|m| m.tag.tag_name == 'macro' && !m.tag.text.empty? }.each do |macro|
        next if macro.tag.name.nil? || macro.tag.name.empty?
        result[macro.tag.name] = macro
      end
    end
    result
  end
end

#namespace_exists?(fqns) ⇒ Boolean

Parameters:

Returns:



152
153
154
 
# File 'lib/solargraph/api_map/store.rb', line 152

def namespace_exists?(fqns)
  fqns_pins(fqns).any?
end

#namespace_pins ⇒ Enumerable<Solargraph::Pin::Namespace>

Returns:



157
158
159
 
# File 'lib/solargraph/api_map/store.rb', line 157

def namespace_pins
  pins_by_class(Solargraph::Pin::Namespace)
end

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

Returns:



16
17
18
 
# File 'lib/solargraph/api_map/store.rb', line 16

def pins
  index.pins
end

#pins_by_class(klass) ⇒ Set<generic<T>>

Parameters:

Returns:



198
199
200
 
# File 'lib/solargraph/api_map/store.rb', line 198

def pins_by_class klass
  index.pins_by_class klass
end

#qualify_superclass(fq_sub_tag) ⇒ String?

Parameters:

Returns:



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/solargraph/api_map/store.rb', line 94

def qualify_superclass fq_sub_tag
  cached_qualify_superclass[fq_sub_tag] || qualify_and_cache_superclass(fq_sub_tag)
  type = ComplexType.try_parse(fq_sub_tag)
  return type.simplify_literals.to_s if type.literal?
  ref = get_superclass(fq_sub_tag)
  return unless ref
  res = constants.dereference(ref)
  return unless res
  res
end

#to_s ⇒ Object 



50
51
52
 
# File 'lib/solargraph/api_map/store.rb', line 50

def to_s
  self.class.to_s
end

#update(*pinsets) ⇒ Boolean

Returns True if the index was updated.

Parameters:

Returns:

  • True if the index was updated



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/solargraph/api_map/store.rb', line 27

def update *pinsets
  return catalog(pinsets) if pinsets.length != @pinsets.length

  changed = pinsets.find_index.with_index { |pinset, idx| @pinsets[idx] != pinset }
  return false unless changed

  # @todo Fix this map

  @fqns_pins_map = nil
  return catalog(pinsets) if changed == 0

  pinsets[changed..].each_with_index do |pins, idx|
    @pinsets[changed + idx] = pins
    @indexes[changed + idx] = if pins.empty?
      @indexes[changed + idx - 1]
    else
      @indexes[changed + idx - 1].merge(pins)
    end
  end
  constants.clear
  cached_qualify_superclass.clear
  true
end