Base
Implements a serializer that reads from and writes to the filesystem.
Creates a new FileSystemSerializer with options
@option opts [String] :basepath ('doc') the base path to write data to @option opts [String] :extension ('html') the extension of the serialized
path filename. If this is set to the empty string, no extension is used.
# File lib/yard/serializers/file_system_serializer.rb, line 27 def initialize(opts = {}) super @basepath = (options[:basepath] || 'doc').to_s @extension = (options.has_key?(:extension) ? options[:extension] : 'html').to_s end
# File lib/yard/serializers/file_system_serializer.rb, line 9 def basepath=(value) @basepath = options[:basepath] = value end
Checks the disk for an object and returns whether it was serialized.
@param [CodeObjects::Base] object the object to check @return [Boolean] whether an object has been serialized to disk
# File lib/yard/serializers/file_system_serializer.rb, line 87 def exists?(object) File.exist?(File.join(basepath, serialized_path(object))) end
# File lib/yard/serializers/file_system_serializer.rb, line 18 def extension=(value) @extension = options[:extension] = value end
Serializes object with data to its serialized path (prefixed by the #basepath).
@return [String] the written data (for chaining)
# File lib/yard/serializers/file_system_serializer.rb, line 36 def serialize(object, data) path = File.join(basepath, *serialized_path(object)) log.debug "Serializing to #{path}" File.open!(path, "wb") {|f| f.write data } end
Implements the serialized path of a code object.
@param [CodeObjects::Base, CodeObjects::ExtraFileObject, String] object
the object to get a path for. The path of a string is the string itself.
@return [String] if object is a String, returns
object, otherwise the path on disk (without the basepath).
# File lib/yard/serializers/file_system_serializer.rb, line 48 def serialized_path(object) return object if object.is_a?(String) if object.is_a?(CodeObjects::ExtraFileObject) fspath = ['file.' + object.name + (extension.empty? ? '' : ".#{extension}")] else objname = object != YARD::Registry.root ? object.name.to_s : "top-level-namespace" objname += '_' + object.scope.to_s[0,1] if object.is_a?(CodeObjects::MethodObject) fspath = [objname + (extension.empty? ? '' : ".#{extension}")] if object.namespace && object.namespace.path != "" fspath.unshift(*object.namespace.path.split(CodeObjects::NSEP)) end end # Don't change the filenames, it just makes it more complicated # to figure out the original name. #fspath.map! do |p| # p.gsub(/([a-z])([A-Z])/, '\1_\2').downcase #end # Remove special chars from filenames. # Windows disallows \ / : * ? " < > | but we will just remove any # non alphanumeric (plus period, underscore and dash). fspath.map! do |p| p.gsub(/[^\w\.-]/) do |x| encoded = '_' x.each_byte { |b| encoded << ("%X" % b) } encoded end end File.join(fspath) end
Generated with the Darkfish Rdoc Generator 2.