Module: Alf::Doc

Defined in:
lib/alf/doc.rb,
lib/alf/doc/to_html.rb,
lib/alf/doc/version.rb,
lib/alf/doc/viewpoint.rb,
lib/alf/doc/to_markdown.rb

Defined Under Namespace

Modules: Version, Viewpoint Classes: ToHtml, ToMarkdown

Constant Summary collapse

ROOT = 
Path.dir.parent.parent
DOC_ROOT = 
ROOT/"doc"
DB = 
Alf.connect(Path.dir, viewpoint: Viewpoint[])
VERSION = 
Version.to_s

Class Method Summary collapse

Class Method Details

.all ⇒ Object 



17
18
19
20
21
22
23
24
25
 
# File 'lib/alf/doc.rb', line 17

def self.all
  query{
    extend(Relation::DEE,
      predicates: predicates,
      operators: operators,
      aggregators: aggregators,
      examples: examples)
  }
end

.blog ⇒ Object 



39
40
41
 
# File 'lib/alf/doc.rb', line 39

def self.blog
  (DOC_ROOT/'blog').glob("*.md")
end

.commands ⇒ Object 



35
36
37
 
# File 'lib/alf/doc.rb', line 35

def self.commands
  (DOC_ROOT/'commands').glob("*.md")
end

.each_api ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/alf/doc.rb', line 43

def self.each_api
  [:operators, :predicates, :aggregators].each do |kind|
    Alf::Doc.query(kind).each do |obj|
      yield(kind.to_s[0...-1].to_sym, obj.name, obj)
    end
  end
end

.examples ⇒ Object 



27
28
29
 
# File 'lib/alf/doc.rb', line 27

def self.examples
  query{ examples }
end

.pages ⇒ Object 



31
32
33
 
# File 'lib/alf/doc.rb', line 31

def self.pages
  (DOC_ROOT/'pages').glob("*.md")
end

.query(*args, &bl) ⇒ Object 



13
14
15
 
# File 'lib/alf/doc.rb', line 13

def self.query(*args, &bl)
  DB.query(*args, &bl)
end