class Dbdoc::FolderInitializer

Dbdoc::FolderInitializer class knows how to turn an emtpy folder into a dbdoc folder.

Public Class Methods

new(local_path: Dir.pwd) click to toggle source
# File lib/dbdoc/folder_initializer.rb, line 12
def initialize(local_path: Dir.pwd)
  @config = Dbdoc::Config.new(local_path: local_path).load
end

Public Instance Methods

init() click to toggle source
# File lib/dbdoc/folder_initializer.rb, line 16
def init
  create_schema_folder
  create_doc_folder
  create_config_file
  create_gitignore_file
  create_confluence_config_file
end

Private Instance Methods

create_config_file() click to toggle source
# File lib/dbdoc/folder_initializer.rb, line 49
def create_config_file
  create_file("default.yml", "config.yml")
end
create_confluence_config_file() click to toggle source
# File lib/dbdoc/folder_initializer.rb, line 57
def create_confluence_config_file
  create_file("confluence.yml", "confluence.yml")
end
create_doc_folder() click to toggle source

doc folder stores all the database documentation files

# File lib/dbdoc/folder_initializer.rb, line 34
def create_doc_folder
  doc_folder = File.join(Dir.pwd, "doc")
  Dir.mkdir(doc_folder) unless Dir.exist?(doc_folder)
end
create_file(default_file_name, target_file_name) click to toggle source
# File lib/dbdoc/folder_initializer.rb, line 39
def create_file(default_file_name, target_file_name)
  target_file = File.join(Dir.pwd, target_file_name)

  return if File.exist?(target_file)

  config_file = File.join(File.expand_path(__dir__), "../..", "config", default_file_name)

  FileUtils.cp(config_file, target_file)
end
create_gitignore_file() click to toggle source
# File lib/dbdoc/folder_initializer.rb, line 53
def create_gitignore_file
  create_file("gitignore.template", ".gitignore")
end
create_schema_folder() click to toggle source

schema folder is the one user copies the schema.csv to before updating/generating documentation

# File lib/dbdoc/folder_initializer.rb, line 28
def create_schema_folder
  schema_folder = File.join(Dir.pwd, "schema")
  Dir.mkdir(schema_folder) unless Dir.exist?(schema_folder)
end