Module: CrapiDocs

Defined in:
lib/crapidocs.rb,
lib/crapidocs/session.rb,
lib/crapidocs/formatter.rb

Defined Under Namespace

Classes: Formatter, Session

Constant Summary collapse

VERSION = 
[0, 2, 0]
TEMPLATE_DIR = 
File.expand_path('../..', __FILE__) + '/templates'
PARALLEL = 
ENV['PARALLEL_TEST_GROUPS'] && defined?(ParallelTests)
SESSION_FILE_PREFIX = 
'crapi-session.'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.session ⇒ Object (readonly)

Returns the value of attribute session.



25
26
27
 
# File 'lib/crapidocs.rb', line 25

def session
  @session
end

Class Method Details

.done ⇒ Object 



45
46
47
48
49
 
# File 'lib/crapidocs.rb', line 45

def done
  handle_parallel if CrapiDocs::PARALLEL
  formatter = Formatter.new(@session)
  write_docs(formatter.to_md)
end

.on? ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/crapidocs.rb', line 41

def on?
  @session.present?
end

.purge ⇒ Object 



37
38
39
 
# File 'lib/crapidocs.rb', line 37

def purge
  @session = nil
end

.start(pattern, target = './doc/api.md', tmp = './tmp') ⇒ Object 



31
32
33
34
35
 
# File 'lib/crapidocs.rb', line 31

def start(pattern, target = './doc/api.md', tmp = './tmp')
  @session = Session.new(pattern)
  @target = target
  @tmp = tmp
end

.version ⇒ Object 



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

def version
  VERSION.join('.')
end