Class: Distil::JavascriptDocProduct

Inherits:
Product show all
Defined in:
lib/distil/product/javascript-doc-product.rb

Instance Attribute Summary

Attributes inherited from Product

#assets, #join_string, #target

Attributes inherited from Configurable

#options

Instance Method Summary collapse

Methods inherited from Product

#can_embed_file?, #clean, #external_files, #files, #files=, #handles_file?, #initialize, #relative_path, #up_to_date

Methods included from ErrorReporter

#error, error, #ignore_warnings, #ignore_warnings=, #report, warning, #warning

Methods inherited from Configurable

#get_option, #get_options, #initialize, option

Constructor Details

This class inherits a constructor from Distil::Product

Instance Method Details

#filename ⇒ Object 



14
15
16
 
# File 'lib/distil/product/javascript-doc-product.rb', line 14

def filename
  File.join(doc_folder, 'index.html')
end

#write_output ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/distil/product/javascript-doc-product.rb', line 18

def write_output
  return if up_to_date
  @up_to_date= true
  
  return if (!File.exists?(JSDOC_COMMAND))

  tmp= Tempfile.new("jsdoc.conf")

  template= File.read(jsdoc_conf)
  doc_files= []
  
  files.each { |f|
    next if !handles_file?(f)
    p= f.file_path || f.to_s
    doc_files << "\"#{p}\""
  }

  conf= replace_tokens(template, {
                  "DOC_FILES"=>doc_files.join(",\n"),
                  "DOC_OUTPUT_DIR"=>doc_folder,
                  "DOC_TEMPLATE_DIR"=>jsdoc_template,
                  "DOC_PLUGINS_DIR"=>jsdoc_plugins
              })

  tmp << conf
  tmp.close()

  command= "#{JSDOC_COMMAND} -c=#{tmp.path}"

  stdin, stdout, stderr= Open3.popen3(command)
  stdin.close
  output= stdout.read
  errors= stderr.read

  tmp.delete

  puts errors
  puts output
  
end