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
  @logo = 
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 
  @logo
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

rubocop:enable Metrics/AbcSize



89
90
91
 
# File 'lib/gitlab/project_template.rb', line 89

def all
  localized_templates_table
end

.archive_directory ⇒ Object 



97
98
99
 
# File 'lib/gitlab/project_template.rb', line 97

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

.find(name) ⇒ Object 



93
94
95
 
# File 'lib/gitlab/project_template.rb', line 93

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) rubocop:disable Metrics/AbcSize



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
82
83
84
85
86
 
# File 'lib/gitlab/project_template.rb', line 54

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('bridgetown', 'Pages/Bridgetown', _('Everything you need to create a GitLab Pages site using Bridgetown'), 'https://gitlab.com/gitlab-org/project-templates/bridgetown'),
    ProjectTemplate.new('gatsby', 'Pages/Gatsby', _('Everything you need to create a GitLab Pages site using Gatsby'), 'https://gitlab.com/pages/gatsby', 'illustrations/third-party-logos/gatsby.svg'),
    ProjectTemplate.new('hugo', 'Pages/Hugo', _('Everything you need to create a GitLab Pages site using Hugo'), 'https://gitlab.com/pages/hugo', 'illustrations/logos/hugo.svg'),
    ProjectTemplate.new('pelican', 'Pages/Pelican', _('Everything you need to create a GitLab Pages site using Pelican'), 'https://gitlab.com/pages/pelican', 'illustrations/third-party-logos/pelican.svg'),
    ProjectTemplate.new('jekyll', 'Pages/Jekyll', _('Everything you need to create a GitLab Pages site using Jekyll'), 'https://gitlab.com/pages/jekyll', 'illustrations/logos/jekyll.svg'),
    ProjectTemplate.new('plainhtml', 'Pages/Plain HTML', _('Everything you need to create a GitLab Pages site using plain HTML'), 'https://gitlab.com/pages/plain-html'),
    ProjectTemplate.new('hexo', 'Pages/Hexo', _('Everything you need to create a GitLab Pages site using Hexo'), 'https://gitlab.com/pages/hexo', 'illustrations/logos/hexo.svg'),
    ProjectTemplate.new('middleman', 'Pages/Middleman', _('Everything you need to create a GitLab Pages site using Middleman'), 'https://gitlab.com/gitlab-org/project-templates/middleman', 'illustrations/logos/middleman.svg'),
    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('nfhugo', 'Netlify/Hugo', _('A Hugo site that uses Netlify for CI/CD instead of GitLab, but still with all the other great GitLab features'), 'https://gitlab.com/pages/nfhugo', 'illustrations/logos/netlify.svg'),
    ProjectTemplate.new('nfjekyll', 'Netlify/Jekyll', _('A Jekyll site that uses Netlify for CI/CD instead of GitLab, but still with all the other great GitLab features'), 'https://gitlab.com/pages/nfjekyll', 'illustrations/logos/netlify.svg'),
    ProjectTemplate.new('nfplainhtml', 'Netlify/Plain HTML', _('A plain HTML site that uses Netlify for CI/CD instead of GitLab, but still with all the other great GitLab features'), 'https://gitlab.com/pages/nfplain-html', 'illustrations/logos/netlify.svg'),
    ProjectTemplate.new('nfgitbook', 'Netlify/GitBook', _('A GitBook site that uses Netlify for CI/CD instead of GitLab, but still with all the other great GitLab features'), 'https://gitlab.com/pages/nfgitbook', 'illustrations/logos/netlify.svg'),
    ProjectTemplate.new('nfhexo', 'Netlify/Hexo', _('A Hexo site that uses Netlify for CI/CD instead of GitLab, but still with all the other great GitLab features'), 'https://gitlab.com/pages/nfhexo', 'illustrations/logos/netlify.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')
  ]
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