Class: Apidoco::VersionDocumentation

Inherits:
Object
  • Object
show all
Defined in:
lib/apidoco/version_documentation.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(directory) ⇒ VersionDocumentation

Returns a new instance of VersionDocumentation.



5
6
7
 
# File 'lib/apidoco/version_documentation.rb', line 5

def initialize(directory)
  self.directory = directory
end

Instance Attribute Details

#directory ⇒ Object

Returns the value of attribute directory.



3
4
5
 
# File 'lib/apidoco/version_documentation.rb', line 3

def directory
  @directory
end

Instance Method Details

#as_json ⇒ Object 



14
15
16
17
18
19
20
 
# File 'lib/apidoco/version_documentation.rb', line 14

def as_json
  {
    name: name,
    base_url: '',
    apis: documentations.flat_map(&:as_json)
  }
end

#documentation_directories ⇒ Object 



26
27
28
 
# File 'lib/apidoco/version_documentation.rb', line 26

def documentation_directories
  directory.children.select(&:directory?)
end

#documentations ⇒ Object 



22
23
24
 
# File 'lib/apidoco/version_documentation.rb', line 22

def documentations
  documentation_directories.map { |dir| FolderParser.new(dir) }
end

#name ⇒ Object Also known as: version 



9
10
11
 
# File 'lib/apidoco/version_documentation.rb', line 9

def name
  directory.basename.to_s
end