Module: GemDocs::Header

Defined in:
lib/gem_docs/header.rb

Constant Summary collapse

PROPERTY_RE = 
/^#\+PROPERTY:\s+header-args:ruby/

Class Method Summary collapse

Class Method Details

.org_headers ⇒ Object 



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/gem_docs/header.rb', line 21

def self.org_headers
  repo = Repo.from_gemspec
  GemDocs.config.headers
    .gsub('%n', repo.name)
    .gsub('%h', repo.host)
    .gsub('%u', repo.user)
    .gsub('%r', repo.root)
    .gsub('%b', repo.branch)
    .gsub('%w', repo.workflow)
end

.present? ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
19
 
# File 'lib/gem_docs/header.rb', line 16

def self.present?
  prelim = extract_prelim_body.first
  prelim.any? { |h| h.match?(PROPERTY_RE) }
end

.write_header? ⇒ Boolean

Returns String The overview from README per config.

Returns:

  • (Boolean) —

    String The overview from README per config



8
9
10
11
12
13
14
 
# File 'lib/gem_docs/header.rb', line 8

def self.write_header?
  return false if present?

  prelim, body = extract_prelim_body
  new_org = prelim.join.strip + "\n" + org_headers.strip + "\n\n" + body.join
  File.write(README_ORG, new_org) > 0
end