Class: Fdoc::MetaService

Inherits:
Object
  • Object
show all
Defined in:
lib/fdoc/meta_service.rb

Overview

MetaServices are collections of services

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(meta_service_dir) ⇒ MetaService

Returns a new instance of MetaService.



7
8
9
10
11
12
13
14
15
16
 
# File 'lib/fdoc/meta_service.rb', line 7

def initialize(meta_service_dir)
  @meta_service_dir = File.expand_path(meta_service_dir)

  service_path = Dir["#{meta_service_dir}/*.fdoc.meta"].first
  @schema = if service_path
    YAML.load_file(service_path)
  else
    {}
  end
end

Instance Attribute Details

#meta_service_dir ⇒ Object (readonly)

Returns the value of attribute meta_service_dir.



5
6
7
 
# File 'lib/fdoc/meta_service.rb', line 5

def meta_service_dir
  @meta_service_dir
end

Instance Method Details

#description ⇒ Object 



39
40
41
 
# File 'lib/fdoc/meta_service.rb', line 39

def description
  @schema['description']
end

#discussion ⇒ Object 



43
44
45
 
# File 'lib/fdoc/meta_service.rb', line 43

def discussion
  @schema['discussion']
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/fdoc/meta_service.rb', line 18

def empty?
  @schema.empty?
end

#name ⇒ Object 



35
36
37
 
# File 'lib/fdoc/meta_service.rb', line 35

def name
  @schema['name']
end

#services ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/fdoc/meta_service.rb', line 22

def services
  @schema['services'].map do |path|
    service_path = if path.start_with?('/') || path.start_with?('~')
      path
    else
      File.join(meta_service_dir, path)
    end
    serv = Fdoc::Service.new(service_path)
    serv.meta_service = self
    serv
  end
end