Class: SleepingKingStudios::Docs::Commands::Generators::ReferenceGenerator

Inherits:

Base

• Object
• Cuprum::Command
• Base
• SleepingKingStudios::Docs::Commands::Generators::ReferenceGenerator

Defined in:

lib/sleeping_king_studios/docs/commands/generators/reference_generator.rb

Overview

Generator for writing reference files.

Instance Attribute Summary

Attributes inherited from Base

#docs_path, #options

Instance Method Summary

• #file_path(data_object: ) ⇒ String

  Determines the generated file path for the given data object.

Methods inherited from Base

#dry_run?, #force?, #initialize, #template_path, #verbose?, #version

Constructor Details

This class inherits a constructor from SleepingKingStudios::Docs::Commands::Generators::Base

Instance Method Details

#file_path(data_object: ) ⇒ String

Determines the generated file path for the given data object.

Parameters:

• data_object (SleepingKingStudios::Docs::Data::Base) (defaults to: ) —

  the data object for which the file is generated.

Returns:

• (String) —

  the qualified path to the generated file.

# File 'lib/sleeping_king_studios/docs/commands/generators/reference_generator.rb', line 16

def file_path(data_object:, data_type: nil) # rubocop:disable Lint/UnusedMethodArgument
  File.join(dir_path, "#{data_object.data_path}.md")
end