Class: Rubysmith::Extensions::Tocer

Inherits:

Object

• Object
• Rubysmith::Extensions::Tocer

Defined in:

lib/rubysmith/extensions/tocer.rb

Overview

Ensures project skeleton documentation has table of content.

Instance Method Summary

• #call ⇒ Object
• #initialize(client: ::Tocer::Runner.new(io: StringIO.new)) ⇒ Tocer constructor

  A new instance of Tocer.

Constructor Details

#initialize(client: ::Tocer::Runner.new(io: StringIO.new)) ⇒ Tocer

Returns a new instance of Tocer.

# File 'lib/rubysmith/extensions/tocer.rb', line 15

def initialize(client: ::Tocer::Runner.new(io: StringIO.new), **)
  @client = client
  super(**)
end

Instance Method Details

#call ⇒ Object

# File 'lib/rubysmith/extensions/tocer.rb', line 20

def call
  return false unless settings.build_readme && settings.markdown?

  logger.info { "Adding table of contents..." }
  upsert
  true
end