Class: Gitlab::ProjectTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/gitlab/project_template.rb

Direct Known Subclasses

SampleDataTemplate

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, title, description, preview, logo = 'illustrations/gitlab_logo.svg') ⇒ ProjectTemplate

Returns a new instance of ProjectTemplate.



7
8
9
10
11
12
13
 
# File 'lib/gitlab/project_template.rb', line 7

def initialize(name, title, description, preview,  = 'illustrations/gitlab_logo.svg')
  @name = name
  @title = title
  @description = description
  @preview = preview
   = 
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



5
6
7
 
# File 'lib/gitlab/project_template.rb', line 5

def description
  @description
end

#logo ⇒ Object (readonly)

Returns the value of attribute logo.



5
6
7
 
# File 'lib/gitlab/project_template.rb', line 5

def 
  
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



5
6
7
 
# File 'lib/gitlab/project_template.rb', line 5

def name
  @name
end

#preview ⇒ Object (readonly)

Returns the value of attribute preview.



5
6
7
 
# File 'lib/gitlab/project_template.rb', line 5

def preview
  @preview
end

#title ⇒ Object (readonly)

Returns the value of attribute title.



5
6
7
 
# File 'lib/gitlab/project_template.rb', line 5

def title
  @title
end

Class Method Details

.all ⇒ Object 



83
84
85
 
# File 'lib/gitlab/project_template.rb', line 83

def all
  localized_templates_table
end

.archive_directory ⇒ Object 



91
92
93
 
# File 'lib/gitlab/project_template.rb', line 91

def archive_directory
  Rails.root.join("vendor/project_templates")
end

.find(name) ⇒ Object 



87
88
89
 
# File 'lib/gitlab/project_template.rb', line 87

def find(name)
  all.find { |template| template.name == name.to_s }
end

.localized_templates_table ⇒ Object

TODO: Review child inheritance of this table (see: gitlab.com/gitlab-org/gitlab/-/merge_requests/41699#note_430928221)



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
78
79
80
81
 
# File 'lib/gitlab/project_template.rb', line 53

def localized_templates_table
  [
    ProjectTemplate.new('rails', 'Ruby on Rails', _('Includes an MVC structure, Gemfile, Rakefile, along with many others, to help you get started'), 'https://gitlab.com/gitlab-org/project-templates/rails', 'illustrations/logos/rails.svg'),
    ProjectTemplate.new('spring', 'Spring', _('Includes an MVC structure, mvnw and pom.xml to help you get started'), 'https://gitlab.com/gitlab-org/project-templates/spring', 'illustrations/logos/spring.svg'),
    ProjectTemplate.new('express', 'NodeJS Express', _('Includes an MVC structure to help you get started'), 'https://gitlab.com/gitlab-org/project-templates/express', 'illustrations/logos/express.svg'),
    ProjectTemplate.new('iosswift', 'iOS (Swift)', _('A ready-to-go template for use with iOS Swift apps'), 'https://gitlab.com/gitlab-org/project-templates/iosswift', 'illustrations/logos/swift.svg'),
    ProjectTemplate.new('dotnetcore', '.NET Core', _('A .NET Core console application template, customizable for any .NET Core project'), 'https://gitlab.com/gitlab-org/project-templates/dotnetcore', 'illustrations/third-party-logos/dotnet.svg'),
    ProjectTemplate.new('android', 'Android', _('A ready-to-go template for use with Android apps'), 'https://gitlab.com/gitlab-org/project-templates/android', 'illustrations/logos/android.svg'),
    ProjectTemplate.new('gomicro', 'Go Micro', _('Go Micro is a framework for micro service development'), 'https://gitlab.com/gitlab-org/project-templates/go-micro', 'illustrations/logos/gomicro.svg'),
    ProjectTemplate.new('astro', 'Pages/Astro', _('Template for GitLab Pages and Astro. Astro is a static site generator written in JavaScript.'), 'https://gitlab.com/pages/astro', 'illustrations/third-party-logos/astro.svg'),
    ProjectTemplate.new('docusaurus', 'Pages/Docusaurus', _('Template for GitLab Pages and Docusaurus. Docusaurus is a static site generator written in React.'), 'https://gitlab.com/pages/docusaurus'),
    ProjectTemplate.new('hugo', 'Pages/Hugo', _('Template for GitLab Pages and Hugo. Hugo is a static site generator written in Go.'), 'https://gitlab.com/pages/hugo', 'illustrations/logos/hugo.svg'),
    ProjectTemplate.new('jekyll', 'Pages/Jekyll', _('Template for GitLab Pages and Jekyll. Jekyll is a static site generator written in Ruby.'), 'https://gitlab.com/pages/jekyll', 'illustrations/logos/jekyll.svg'),
    ProjectTemplate.new('nextjs', 'Pages/Next.js', _('Template for GitLab Pages and Next.js. Next.js is a React framework for building web applications.'), 'https://gitlab.com/pages/nextjs'),
    ProjectTemplate.new('nuxt', 'Pages/Nuxt', _('Template for GitLab Pages and Nuxt. Nuxt is a Vue framework for building web applications.'), 'https://gitlab.com/pages/nuxt', 'illustrations/third-party-logos/nuxt.svg'),
    ProjectTemplate.new('plainhtml', 'Pages/Plain HTML', _('Template for GitLab Pages using plain HTML, CSS, and JavaScript.'), 'https://gitlab.com/pages/plain-html'),
    ProjectTemplate.new('gitpod_spring_petclinic', 'Gitpod/Spring Petclinic', _('A Gitpod configured Webapplication in Spring and Java'), 'https://gitlab.com/gitlab-org/project-templates/gitpod-spring-petclinic', 'illustrations/logos/gitpod.svg'),
    ProjectTemplate.new('salesforcedx', 'SalesforceDX', _('A project boilerplate for Salesforce App development with Salesforce Developer tools'), 'https://gitlab.com/gitlab-org/project-templates/salesforcedx'),
    ProjectTemplate.new('serverless_framework', 'Serverless Framework/JS', _('A basic page and serverless function that uses AWS Lambda, AWS API Gateway, and GitLab Pages'), 'https://gitlab.com/gitlab-org/project-templates/serverless-framework', 'illustrations/logos/serverless_framework.svg'),
    ProjectTemplate.new('tencent_serverless_framework', 'Tencent Serverless Framework/NextjsSSR', _('A project boilerplate for Tencent Serverless Framework that uses Next.js SSR'), 'https://gitlab.com/gitlab-org/project-templates/nextjsssr_demo', 'illustrations/logos/tencent_serverless_framework.svg'),
    ProjectTemplate.new('jsonnet', 'Jsonnet for Dynamic Child Pipelines', _('An example showing how to use Jsonnet with GitLab dynamic child pipelines'), 'https://gitlab.com/gitlab-org/project-templates/jsonnet'),
    ProjectTemplate.new('cluster_management', 'GitLab Cluster Management', _('An example project for managing Kubernetes clusters integrated with GitLab'), 'https://gitlab.com/gitlab-org/project-templates/cluster-management'),
    ProjectTemplate.new('kotlin_native_linux', 'Kotlin Native Linux', _('A basic template for developing Linux programs using Kotlin Native'), 'https://gitlab.com/gitlab-org/project-templates/kotlin-native-linux'),
    ProjectTemplate.new('typo3_distribution', 'TYPO3 Distribution', _('A template for starting a new TYPO3 project'), 'https://gitlab.com/gitlab-org/project-templates/typo3-distribution', 'illustrations/logos/typo3.svg'),
    ProjectTemplate.new('laravel', 'Laravel Framework', _('A basic folder structure of a Laravel application, to help you get started.'), 'https://gitlab.com/gitlab-org/project-templates/laravel', 'illustrations/logos/laravel.svg'),
    ProjectTemplate.new('nist_80053r5', 'NIST 800-53r5', _('A project containing issues for security and privacy controls published by the U.S. National Institute of Standards and Technology'), 'https://gitlab.com/gitlab-org/project-templates/nist_80053r5'),
    ProjectTemplate.new('gitlab_components', 'GitLab CI/CD components', _('A basic folder structure and sample files for a CI/CD components project.'), 'https://gitlab.com/gitlab-org/project-templates/gitlab-component-template')
  ]
end

Instance Method Details

#==(other) ⇒ Object 



47
48
49
 
# File 'lib/gitlab/project_template.rb', line 47

def ==(other)
  name == other.name && title == other.title
end

#archive_filename ⇒ Object 



23
24
25
 
# File 'lib/gitlab/project_template.rb', line 23

def archive_filename
  "#{name}.tar.gz"
end

#archive_path ⇒ Object 



19
20
21
 
# File 'lib/gitlab/project_template.rb', line 19

def archive_path
  self.class.archive_directory.join(archive_filename)
end

#clone_url ⇒ Object 



27
28
29
 
# File 'lib/gitlab/project_template.rb', line 27

def clone_url
  "#{preview}.git"
end

#file ⇒ Object 



15
16
17
 
# File 'lib/gitlab/project_template.rb', line 15

def file
  archive_path.open
end

#project_host ⇒ Object 



31
32
33
34
35
36
37
 
# File 'lib/gitlab/project_template.rb', line 31

def project_host
  return unless preview

  uri = URI.parse(preview)
  uri.path = ""
  uri.to_s
end

#project_path ⇒ Object 



39
40
41
 
# File 'lib/gitlab/project_template.rb', line 39

def project_path
  URI.parse(preview).path.delete_prefix('/')
end

#uri_encoded_project_path ⇒ Object 



43
44
45
 
# File 'lib/gitlab/project_template.rb', line 43

def uri_encoded_project_path
  ERB::Util.url_encode(project_path)
end