Class: YARD::RegistryStore

Inherits:
Object
  • Object
show all
Defined in:
lib/yard/registry_store.rb

Overview

The data store for the Registry.

See Also:

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (RegistryStore) initialize

A new instance of RegistryStore



11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/yard/registry_store.rb', line 11

def initialize
  @file = nil
  @checksums = {}
  @store = {}
  @proxy_types = {}
  @object_types = {:root => [:root]}
  @notfound = {}
  @loaded_objects = 0
  @available_objects = 0
  @store[:root] = CodeObjects::RootObject.allocate
  @store[:root].send(:initialize, nil, :root)
end

Instance Attribute Details

- (Object) checksums (readonly)

Returns the value of attribute checksums



9
10
11
 
# File 'lib/yard/registry_store.rb', line 9

def checksums
  @checksums
end

- (Object) file (readonly)

Returns the value of attribute file



9
10
11
 
# File 'lib/yard/registry_store.rb', line 9

def file
  @file
end

- (Object) proxy_types (readonly)

Returns the value of attribute proxy_types



9
10
11
 
# File 'lib/yard/registry_store.rb', line 9

def proxy_types
  @proxy_types
end

Instance Method Details

- (Object) checksums_path (protected) 



214
215
216
 
# File 'lib/yard/registry_store.rb', line 214

def checksums_path
  @serializer.checksums_path
end

- (void) delete(key)

This method returns an undefined value.

Deletes an object at a given path

Parameters:

  • key (#to_sym) —

    the key to delete



70
 
# File 'lib/yard/registry_store.rb', line 70

def delete(key) @store.delete(key.to_sym) end

- (Boolean) destroy(force = false)

Deletes the .yardoc database on disk

Parameters:

  • force (Boolean) (defaults to: false) —

    if force is not set to true, the file/directory will only be removed if it ends with .yardoc. This helps with cases where the directory might have been named incorrectly.

Returns:

  • (Boolean) —

    true if the .yardoc database was deleted, false otherwise.



190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/yard/registry_store.rb', line 190

def destroy(force = false)
  if (!force && file =~ /\.yardoc$/) || force
    if File.file?(@file)
      # Handle silent upgrade of old .yardoc format
      File.unlink(@file)
    elsif File.directory?(@file)
      FileUtils.rm_rf(@file)
    end
    true
  else
    false
  end
end

- (CodeObjects::Base?) get(key) Also known as: []

Gets a CodeObjects::Base from the store

Parameters:

  • key (String, Symbol) —

    the path name of the object to look for. If it is empty or :root, returns the #root object.

Returns:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/yard/registry_store.rb', line 29

def get(key)
  key = :root if key == ''
  key = key.to_sym
  return @store[key] if @store[key]
  return if @loaded_objects >= @available_objects

  # check disk
  return if @notfound[key]
  if obj = @serializer.deserialize(key)
    @loaded_objects += 1
    put(key, obj)
  else
    @notfound[key] = true
    nil
  end
end

- (Array<Symbol>) keys(reload = false)

Gets all path names from the store. Loads the entire database if reload is true

Parameters:

  • reload (Boolean) (defaults to: false) —

    if false, does not load the entire database before a lookup.

Returns:

  • (Array<Symbol>) —

    the path names of all the code objects



78
 
# File 'lib/yard/registry_store.rb', line 78

def keys(reload = false) load_all if reload; @store.keys end

- (Boolean) load(file = nil)

Whether the database was loaded

Parameters:

  • file (String, nil) (defaults to: nil) —

    the name of the yardoc db to load

Returns:

  • (Boolean) —

    whether the database was loaded



111
112
113
114
115
116
117
118
119
 
# File 'lib/yard/registry_store.rb', line 111

def load(file = nil)
  @file = file
  @store = {}
  @proxy_types = {}
  @object_types = {}
  @notfound = {}
  @serializer = Serializers::YardocSerializer.new(@file)
  load_yardoc
end

- (Boolean) load!(file = nil)

Loads the .yardoc file and loads all cached objects into memory automatically.

Parameters:

  • file (String, nil) (defaults to: nil) —

    the name of the yardoc db to load

Returns:

  • (Boolean) —

    whether the database was loaded

See Also:

Since:

  • 0.5.1



128
129
130
131
132
133
134
135
 
# File 'lib/yard/registry_store.rb', line 128

def load!(file = nil)
  if load(file)
    load_all
    true
  else
    false
  end
end

- (void) load_all

This method returns an undefined value.

Loads all cached objects into memory



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/yard/registry_store.rb', line 139

def load_all
  return unless @file
  return if @loaded_objects >= @available_objects
  log.debug "Loading entire database: #{@file} ..."
  objects = []

  all_disk_objects.sort_by {|x| x.size }.each do |path|
    if obj = @serializer.deserialize(path, true)
      objects << obj
    end
  end
  objects.each do |obj|
    put(obj.path, obj)
  end
  @loaded_objects += objects.size
  log.debug "Loaded database (file='#{@file}' count=#{objects.size} total=#{@available_objects})"
end

- (Object) load_yardoc (protected) 



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/yard/registry_store.rb', line 222

def load_yardoc
  return false unless @file
  if File.directory?(@file) # new format
    @loaded_objects = 0
    @available_objects = all_disk_objects.size
    load_proxy_types
    load_checksums
    load_root
    load_object_types
    true
  elsif File.file?(@file) # old format
    load_yardoc_old
    true
  else
    false
  end
end

- (Object) object_types_path (protected) 



218
219
220
 
# File 'lib/yard/registry_store.rb', line 218

def object_types_path
  @serializer.object_types_path
end

- (Object) objects_path (protected) 



206
207
208
 
# File 'lib/yard/registry_store.rb', line 206

def objects_path
  @serializer.objects_path
end

- (Array<String>) paths_for_type(type, reload = false)

A list of object paths with a given CodeObjects::Base#type

Parameters:

  • type (Symbol) —

    the type to look for

Returns:

Since:

  • 0.8.0



92
93
94
95
 
# File 'lib/yard/registry_store.rb', line 92

def paths_for_type(type, reload = false)
  load_all if reload
  @object_types[type] || []
end

- (Object) proxy_types_path (protected) 



210
211
212
 
# File 'lib/yard/registry_store.rb', line 210

def proxy_types_path
  @serializer.proxy_types_path
end

- (CodeObjects::Base) put(key, value) Also known as: []=

Associates an object with a path

Parameters:

  • key (String, Symbol) —

    the path name (:root or " for root object)

  • value (CodeObjects::Base) —

    the object to store

Returns:



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/yard/registry_store.rb', line 50

def put(key, value)
  if key == ''
    @object_types[:root] = [:root]
    @store[:root] = value
  else
    @notfound.delete(key.to_sym)
    (@object_types[value.type] ||= []) << key.to_s
    if @store[key.to_sym]
      @object_types[@store[key.to_sym].type].delete(key.to_s)
    end
    @store[key.to_sym] = value
  end
end

- (CodeObjects::RootObject) root

The root object

Returns:



107
 
# File 'lib/yard/registry_store.rb', line 107

def root; @store[:root] end

- (Boolean) save(merge = true, file = nil)

Saves the database to disk

Parameters:

  • merge (Boolean) (defaults to: true) —

    if true, merges the data in memory with the data on disk, otherwise the data on disk is deleted.

  • file (String, nil) (defaults to: nil) —

    if supplied, the name of the file to save to

Returns:

  • (Boolean) —

    whether the database was saved



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/yard/registry_store.rb', line 162

def save(merge = true, file = nil)
  if file && file != @file
    @file = file
    @serializer = Serializers::YardocSerializer.new(@file)
  end
  destroy unless merge

  sdb = Registry.single_object_db
  if sdb == true || sdb == nil
    @serializer.serialize(@store)
  else
    values(false).each do |object|
      @serializer.serialize(object)
    end
  end
  write_proxy_types
  write_object_types
  write_checksums
  true
end

- (Array<CodeObjects::Base>) values(reload = false)

Gets all code objects from the store. Loads the entire database if reload is true

Parameters:

  • reload (Boolean) (defaults to: false) —

    if false, does not load the entire database before a lookup.

Returns:



86
 
# File 'lib/yard/registry_store.rb', line 86

def values(reload = false) load_all if reload; @store.values end

- (Array<CodeObjects::Base>) values_for_type(type, reload = false)

A list of objects with a given CodeObjects::Base#type

Parameters:

  • type (Symbol) —

    the type to look for

Returns:

Since:

  • 0.8.0



101
102
103
104
 
# File 'lib/yard/registry_store.rb', line 101

def values_for_type(type, reload = false)
  load_all if reload
  paths_for_type(type).map {|t| @store[t.to_sym] }
end