Class: YARD::Server::Adapter

Inherits:

Object

• Object
• YARD::Server::Adapter

show all

Defined in:

lib/yard/server/adapter.rb

Overview

Instance Attribute Summary (collapse)

• - (String) document_root

  The location where static files are located, if any.

• - (Object) libraries

  Returns the value of attribute libraries.

• - (Object) options

  Returns the value of attribute options.

• - (Object) router

  Returns the value of attribute router.

• - (Object) server_options

  Returns the value of attribute server_options.

Class Method Summary (collapse)

• + (Object) setup
• + (Object) shutdown

Instance Method Summary (collapse)

• - (Object) add_library(library)
• - (Adapter) initialize(libs, opts = {}, server_opts = {}) constructor

  A new instance of Adapter.

• - (Object) start

28
29
30
31
32
33
34
35
36
37
38
39

# File 'lib/yard/server/adapter.rb', line 28

def initialize(libs, opts = {}, server_opts = {})
  self.class.setup
  self.libraries = libs
  self.options = opts
  self.server_options = server_opts
  self.document_root = server_options[:DocumentRoot]
  self.router = (options[:router] || Router).new(self)
  options[:adapter] = self
  log.debug "Serving libraries using #{self.class}: #{libraries.keys.join(', ')}"
  log.debug "Caching on" if options[:caching]
  log.debug "Document root: #{document_root}" if document_root
end

8
9
10

# File 'lib/yard/server/adapter.rb', line 8

def document_root
  @document_root
end

10
11
12

# File 'lib/yard/server/adapter.rb', line 10

def libraries
  @libraries
end

12
13
14

# File 'lib/yard/server/adapter.rb', line 12

def options
  @options
end

16
17
18

# File 'lib/yard/server/adapter.rb', line 16

def router
  @router
end

14
15
16

# File 'lib/yard/server/adapter.rb', line 14

def server_options
  @server_options
end

18
19
20
21

# File 'lib/yard/server/adapter.rb', line 18

def self.setup
  Templates::Template.extra_includes |= [YARD::Server::DocServerHelper]
  Templates::Engine.template_paths |= [File.dirname(__FILE__) + '/templates']
end

23
24
25
26

# File 'lib/yard/server/adapter.rb', line 23

def self.shutdown
  Templates::Template.extra_includes -= [YARD::Server::DocServerHelper]
  Templates::Engine.template_paths -= [File.dirname(__FILE__) + '/templates']
end

41
42
43
44

# File 'lib/yard/server/adapter.rb', line 41

def add_library(library)
  libraries[library.name] ||= []
  libraries[library.name] |= [library]
end

46
47
48

# File 'lib/yard/server/adapter.rb', line 46

def start
  raise NotImplementedError
end