Class: Rokko::Task

Inherits:
Object
  • Object
show all
Includes:
Rake::DSL
Defined in:
lib/rokko/task.rb

Instance Method Summary collapse

Constructor Details

#initialize(task_name = 'rokko', dest = 'docs/', sources = 'lib/**/*.rb', options = {}) ⇒ Task

Returns a new instance of Task.



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/rokko/task.rb', line 29

def initialize(task_name = 'rokko', dest = 'docs/', sources = 'lib/**/*.rb', options = {})
  @name = task_name
  @dest = dest
  @sources = FileList[sources]
  @options = options
  if options[:generate_index] || options[:index].is_a?(TrueClass)
    @options[:generate_index] = true
  end

  define
end

Instance Method Details

#define ⇒ Object

Actually setup the task



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/rokko/task.rb', line 42

def define
  desc "Generate rokko documentation"
  task @name do
    # Find README file for `index.html` and delete it from `sources`
    if @options[:generate_index]
      readme_source = @sources.detect { |f| File.basename(f) =~ /README(\.(md|text|markdown|mdown|mkd|mkdn)$)?/i }
      readme = readme_source ? File.read(@sources.delete(readme_source)) : ''
    end

    # Run each file through Rokko and write output
    @sources.each do |filename|
      rokko = Rokko.new(filename, @sources, @options)
      out_dest = File.join(@dest, filename.sub(Regexp.new("#{File.extname(filename)}$"), ".html"))
      puts "rokko: #{filename} -> #{out_dest}"
      FileUtils.mkdir_p File.dirname(out_dest)
      File.open(out_dest, 'wb') { |fd| fd.write(rokko.to_html) }
    end

    # Generate index.html if needed
    if @options[:generate_index]
      require 'rokko/index_layout'
      out_dest = File.join(@dest, 'index.html')
      puts "rokko: #{out_dest}"
      File.open(out_dest, 'wb') { |fd| fd.write(IndexLayout.new(@sources, readme, @options).render) }
    end

    # Run specified file through rokko and use it as index
    if @options[:index] && source_index = @sources.find{|s| s == @options[:index]}
      rokko = Rokko.new(source_index, @sources, @options.merge(preserve_urls: true))
      out_dest = File.join(@dest, 'index.html')
      puts "rokko: #{source_index} -> index.html"
      File.open(out_dest, 'wb') { |fd| fd.write(rokko.to_html) }
    end

  end
end