gitlab-org--gitlab-foss/lib/gitlab/template/base_template.rb

112 lines
3.1 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
2016-05-27 05:00:56 -04:00
module Gitlab
module Template
class BaseTemplate
attr_accessor :category
def initialize(path, project = nil, category: nil)
2016-05-27 05:00:56 -04:00
@path = path
@category = category
@finder = self.class.finder(project)
2016-05-27 05:00:56 -04:00
end
def name
File.basename(@path, self.class.extension)
end
2018-10-02 19:00:38 -04:00
alias_method :key, :name
2016-05-27 05:00:56 -04:00
def full_name
Pathname.new(@path)
.relative_path_from(self.class.base_dir)
.to_s
end
2016-05-27 05:00:56 -04:00
def content
@finder.read(@path)
end
2018-10-02 19:00:38 -04:00
# Present for compatibility with license templates, which can replace text
# like `[fullname]` with a user-specified string. This is a no-op for
# other templates
def resolve!(_placeholders = {})
self
end
def to_json
2018-10-02 19:00:38 -04:00
{ key: key, name: name, content: content }
end
def <=>(other)
name <=> other.name
end
2016-05-27 05:00:56 -04:00
class << self
def all(project = nil)
if categories.any?
categories.keys.flat_map { |cat| by_category(cat, project) }
else
by_category("", project)
end
2016-05-27 05:00:56 -04:00
end
def find(key, project = nil)
path = self.finder(project).find(key)
path.present? ? new(path, project) : nil
2016-05-27 05:00:56 -04:00
end
# Set categories as sub directories
# Example: { "category_name_1" => "directory_path_1", "category_name_2" => "directory_name_2" }
# Default is no category with all files in base dir of each class
2016-06-17 02:37:19 -04:00
def categories
{}
2016-06-17 02:37:19 -04:00
end
def extension
raise NotImplementedError
end
def base_dir
raise NotImplementedError
end
# Defines which strategy will be used to get templates files
# RepoTemplateFinder - Finds templates on project repository, templates are filtered perproject
# GlobalTemplateFinder - Finds templates on gitlab installation source, templates can be used in all projects
def finder(project = nil)
raise NotImplementedError
2016-05-27 05:00:56 -04:00
end
def by_category(category, project = nil)
directory = category_directory(category)
files = finder(project).list_files_for(directory)
files.map { |f| new(f, project, category: category) }.sort
2016-05-27 05:00:56 -04:00
end
def category_directory(category)
return base_dir unless category.present?
2016-05-27 05:00:56 -04:00
File.join(base_dir, categories[category])
2016-05-27 05:00:56 -04:00
end
# If template is organized by category it returns { category_name: [{ name: template_name }, { name: template2_name }] }
# If no category is present returns [{ name: template_name }, { name: template2_name}]
def dropdown_names(project = nil)
return [] if project && !project.repository.exists?
2016-05-27 05:00:56 -04:00
if categories.any?
categories.keys.map do |category|
files = self.by_category(category, project)
[category, files.map { |t| { name: t.name } }]
end.to_h
else
files = self.all(project)
files.map { |t| { name: t.name } }
end
2016-05-27 05:00:56 -04:00
end
end
end
end
end