Class: YARD::Serializers::YardocSerializer

Inherits:
FileSystemSerializer show all
Defined in:
lib/yard/serializers/yardoc_serializer.rb

Instance Method Summary collapse

Constructor Details

#initialize(yfile) ⇒ YardocSerializer

Returns a new instance of YardocSerializer.



30
31
32
 
# File 'lib/yard/serializers/yardoc_serializer.rb', line 30

def initialize(yfile)
  super(:basepath => yfile, :extension => 'dat')
end

Instance Method Details

#checksums_path ⇒ Object 



37
 
# File 'lib/yard/serializers/yardoc_serializer.rb', line 37

def checksums_path; File.join(basepath, 'checksums') end

#complete? ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/yard/serializers/yardoc_serializer.rb', line 42

def complete?
  File.exist?(complete_lock_path) && !locked_for_writing?
end

#complete_lock_path ⇒ Object 



39
 
# File 'lib/yard/serializers/yardoc_serializer.rb', line 39

def complete_lock_path; File.join(basepath, 'complete') end

#deserialize(path, is_path = false) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
 
# File 'lib/yard/serializers/yardoc_serializer.rb', line 96

def deserialize(path, is_path = false)
  path = File.join(basepath, serialized_path(path)) unless is_path
  if File.file?(path)
    log.debug "Deserializing #{path}..."
    Marshal.load(File.read_binary(path))
  else
    log.debug "Could not find #{path}"
    nil
  end
end

#lock_for_writing(&block) ⇒ Object

Creates a pessmistic transactional lock on the database for writing. Use with YARD.parse to ensure the database is not written multiple times.

See Also:



51
52
53
54
55
56
 
# File 'lib/yard/serializers/yardoc_serializer.rb', line 51

def lock_for_writing(&block)
  File.open!(processing_path, 'w') {}
  yield
ensure
  File.unlink(processing_path) if File.exist?(processing_path)
end

#locked_for_writing? ⇒ Boolean

Returns whether the database is currently locked for writing.

Returns:

  • (Boolean) —

    whether the database is currently locked for writing



59
60
61
 
# File 'lib/yard/serializers/yardoc_serializer.rb', line 59

def locked_for_writing?
  File.exist?(processing_path)
end

#object_types_path ⇒ Object 



38
 
# File 'lib/yard/serializers/yardoc_serializer.rb', line 38

def object_types_path; File.join(basepath, 'object_types') end

#objects_path ⇒ Object 



34
 
# File 'lib/yard/serializers/yardoc_serializer.rb', line 34

def objects_path; File.join(basepath, 'objects') end

#processing_path ⇒ Object 



40
 
# File 'lib/yard/serializers/yardoc_serializer.rb', line 40

def processing_path; File.join(basepath, 'processing') end

#proxy_types_path ⇒ Object

Deprecated.

The registry no longer tracks proxy types



36
 
# File 'lib/yard/serializers/yardoc_serializer.rb', line 36

def proxy_types_path; File.join(basepath, 'proxy_types') end

#serialize(object) ⇒ Object 



88
89
90
91
92
93
94
 
# File 'lib/yard/serializers/yardoc_serializer.rb', line 88

def serialize(object)
  if Hash === object
    super(object[:root], dump(object)) if object[:root]
  else
    super(object, dump(object))
  end
end

#serialized_path(object) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/yard/serializers/yardoc_serializer.rb', line 63

def serialized_path(object)
  path = case object
  when String, Symbol
    object = object.to_s
    if object =~ /#/
      object += '_i'
    elsif object =~ /\./
      object += '_c'
    end
    object.split(/::|\.|#/).map do |p|
      p.gsub(/[^\w\.-]/) do |x|
        encoded = '_'

        x.each_byte { |b| encoded << ("%X" % b) }
        encoded
      end
    end.join('/') + '.' + extension
  when YARD::CodeObjects::RootObject
    'root.dat'
  else
    super(object)
  end
  File.join('objects', path)
end