Merge pull request #212 from spk/rails-stack

Rails stack
platformsh · Jul 18, 2024 · 2ddf43f · 2ddf43f
2 parents 1aa87e2 + 206e47c
commit 2ddf43f
Show file tree

Hide file tree

Showing 15 changed files with 119 additions and 7 deletions.
diff --git a/internal/question/build_steps.go b/internal/question/build_steps.go
@@ -89,6 +89,11 @@ func (q *BuildSteps) Ask(ctx context.Context) error {
 				answers.BuildSteps,
 				"composer --no-ansi --no-interaction install --no-progress --prefer-dist --optimize-autoloader --no-dev",
 			)
+		case models.Bundler:
+			answers.BuildSteps = append(
+				answers.BuildSteps,
+				"bundle install",
+			)
 		}
 	}
 
@@ -125,6 +130,13 @@ func (q *BuildSteps) Ask(ctx context.Context) error {
 			}
 			answers.BuildSteps = append(answers.BuildSteps, cmd)
 		}
+	case models.Rails:
+		answers.Environment["RAILS_ENV"] = "production"
+		answers.Environment["PIDFILE"] = "tmp/server.pid"
+		answers.BuildSteps = append(
+			answers.BuildSteps,
+			"bundle exec rails assets:precompile",
+		)
 	}
 
 	return nil

diff --git a/internal/question/build_steps_test.go b/internal/question/build_steps_test.go
@@ -45,6 +45,32 @@ func TestBuildSteps_Ask(t *testing.T) {
 			buildSteps: []string{"npm i", "npm exec next build"},
 			wantErr:    false,
 		},
+		{
+			name: "Bundler",
+			q:    &BuildSteps{},
+			args: args{models.Answers{
+				Stack:              models.GenericStack,
+				Type:               models.RuntimeType{Runtime: models.Ruby, Version: "3.3"},
+				Dependencies:       map[string]map[string]string{},
+				DependencyManagers: []models.DepManager{models.Bundler},
+				Environment:        map[string]string{},
+			}},
+			buildSteps: []string{"bundle install"},
+			wantErr:    false,
+		},
+		{
+			name: "Bundler with Rails",
+			q:    &BuildSteps{},
+			args: args{models.Answers{
+				Stack:              models.Rails,
+				Type:               models.RuntimeType{Runtime: models.Ruby, Version: "3.3"},
+				Dependencies:       map[string]map[string]string{},
+				DependencyManagers: []models.DepManager{models.Bundler},
+				Environment:        map[string]string{},
+			}},
+			buildSteps: []string{"bundle install", "bundle exec rails assets:precompile"},
+			wantErr:    false,
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {

diff --git a/internal/question/dependency_manager.go b/internal/question/dependency_manager.go
@@ -16,6 +16,7 @@ const (
 	pipenvLockFile   = "Pipfile.lock"
 	pipLockFile      = "requirements.txt"
 	composerLockFile = "composer.lock"
+	bundlerLockFile  = "Gemfile.lock"
 )
 
 type DependencyManager struct{}
@@ -77,5 +78,9 @@ func (q *DependencyManager) Ask(ctx context.Context) error {
 		answers.DependencyManagers = append(answers.DependencyManagers, models.Npm)
 	}
 
+	if exists := utils.FileExists(answers.WorkingDirectory, bundlerLockFile); exists {
+		answers.DependencyManagers = append(answers.DependencyManagers, models.Bundler)
+	}
+
 	return nil
 }
diff --git a/internal/question/deploy_command.go b/internal/question/deploy_command.go
@@ -42,6 +42,10 @@ func (q *DeployCommand) Ask(ctx context.Context) error {
 			"php artisan migrate --force",
 			"php artisan optimize:clear",
 		)
+	case models.Rails:
+		answers.DeployCommand = append(answers.DeployCommand,
+			"bundle exec rake db:migrate",
+		)
 	}
 
 	return nil

diff --git a/internal/question/models/answer.go b/internal/question/models/answer.go
@@ -141,6 +141,8 @@ func getStack(answersStack Stack) platformifier.Stack {
 		return platformifier.Django
 	case Laravel:
 		return platformifier.Laravel
+	case Rails:
+		return platformifier.Rails
 	case NextJS:
 		return platformifier.NextJS
 	case Strapi:

diff --git a/internal/question/models/dependency_manager.go b/internal/question/models/dependency_manager.go
@@ -8,6 +8,7 @@ const (
 	Composer          DepManager = "composer"
 	Yarn              DepManager = "yarn"
 	Npm               DepManager = "npm"
+	Bundler           DepManager = "bundler"
 )
 
 type DepManager string
@@ -32,6 +33,8 @@ func (m DepManager) Title() string {
 		return "Yarn"
 	case Npm:
 		return "Npm"
+	case Bundler:
+		return "Bundler"
 	default:
 		return ""
 	}

diff --git a/internal/question/models/stack.go b/internal/question/models/stack.go
@@ -14,6 +14,7 @@ const (
 	Strapi
 	Flask
 	Express
+	Rails
 )
 
 var (
@@ -25,6 +26,7 @@ var (
 		Strapi,
 		Flask,
 		Express,
+		Rails,
 	}
 )
 
@@ -36,6 +38,8 @@ func (s Stack) Title() string {
 		return "Other"
 	case Django:
 		return "Django"
+	case Rails:
+		return "Rails"
 	case Laravel:
 		return "Laravel"
 	case NextJS:
@@ -88,6 +92,8 @@ func RuntimeForStack(stack Stack) Runtime {
 	switch stack {
 	case Django, Flask:
 		return Python
+	case Rails:
+		return Ruby
 	case Laravel:
 		return PHP
 	case NextJS, Strapi, Express:

diff --git a/internal/question/mounts.go b/internal/question/mounts.go
@@ -15,6 +15,22 @@ func (q *Mounts) Ask(ctx context.Context) error {
 	}
 
 	switch answers.Stack {
+	case models.Rails:
+		answers.Disk = "2048" // in MB
+		answers.Mounts = map[string]map[string]string{
+			"storage": {
+				"source":      "local",
+				"source_path": "storage",
+			},
+			"tmp": {
+				"source":      "tmp",
+				"source_path": "tmp",
+			},
+			"log": {
+				"source":      "tmp",
+				"source_path": "tmp",
+			},
+		}
 	case models.Laravel:
 		answers.Disk = "2048" // in MB
 		answers.Mounts = map[string]map[string]string{

diff --git a/internal/question/stack.go b/internal/question/stack.go
@@ -22,6 +22,7 @@ const (
 	composerJSONFile = "composer.json"
 	packageJSONFile  = "package.json"
 	symfonyLockFile  = "symfony.lock"
+	rackFile         = "config.ru"
 )
 
 type Stack struct{}
@@ -59,6 +60,18 @@ func (q *Stack) Ask(ctx context.Context) error {
 		return nil
 	}
 
+	rackPath := utils.FindFile(answers.WorkingDirectory, rackFile)
+	if rackPath != "" {
+		f, err := os.Open(rackPath)
+		if err == nil {
+			defer f.Close()
+			if ok, _ := utils.ContainsStringInFile(f, "Rails.application.load_server", true); ok {
+				answers.Stack = models.Rails
+				return nil
+			}
+		}
+	}
+
 	requirementsPath := utils.FindFile(answers.WorkingDirectory, "requirements.txt")
 	if requirementsPath != "" {
 		f, err := os.Open(requirementsPath)

diff --git a/internal/question/web_command.go b/internal/question/web_command.go
@@ -81,6 +81,14 @@ func (q *WebCommand) Ask(ctx context.Context) error {
 
 		answers.WebCommand = fmt.Sprintf("%sgunicorn %s -b unix:$SOCKET %s --log-file -", prefix, pythonPath, wsgi)
 		return nil
+	case models.Rails:
+		if answers.SocketFamily == models.TCP {
+			answers.WebCommand = "bundle exec rails server"
+			return nil
+		}
+
+		answers.WebCommand = "bundle exec puma -b unix://$SOCKET"
+		return nil
 	case models.NextJS:
 		answers.WebCommand = "npx next start -p $PORT"
 		return nil

diff --git a/platformifier/models.go b/platformifier/models.go
@@ -26,6 +26,7 @@ const (
 	Strapi
 	Flask
 	Express
+	Rails
 )
 
 type Stack int
@@ -36,6 +37,8 @@ func (s Stack) Name() string {
 		return "generic"
 	case Django:
 		return "django"
+	case Rails:
+		return "rails"
 	case Laravel:
 		return "laravel"
 	case NextJS:

diff --git a/platformifier/templates/generic/.environment b/platformifier/templates/generic/.environment
@@ -4,12 +4,20 @@ export RELATIONSHIPS_JSON="$(echo ${{ .Assets.EnvPrefix }}_RELATIONSHIPS | base6
 # Set database environment variables
 export DB_HOST="$(echo $RELATIONSHIPS_JSON | jq -r '.{{ .Database }}[0].host')"
 export DB_PORT="$(echo $RELATIONSHIPS_JSON | jq -r '.{{ .Database }}[0].port')"
-export DB_DATABASE="$(echo $RELATIONSHIPS_JSON | jq -r '.{{ .Database }}[0].path')"
+export DB_PATH="$(echo $RELATIONSHIPS_JSON | jq -r '.{{ .Database }}[0].path')"
+export DB_DATABASE="$DB_PATH"
 export DB_USERNAME="$(echo $RELATIONSHIPS_JSON | jq -r '.{{ .Database }}[0].username')"
 export DB_PASSWORD="$(echo $RELATIONSHIPS_JSON | jq -r '.{{ .Database }}[0].password')"
-{{ if eq .Database "postgresql" }}export DB_CONNECTION="postgresql"{{ else }}export DB_CONNECTION="$(echo $RELATIONSHIPS_JSON | jq -r '.{{ .Database }}[0].scheme')"{{ end }}
-export DATABASE_URL="${DB_CONNECTION}://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_DATABASE}"
+{{ if eq .Database "postgresql" }}export DB_SCHEME="postgresql"
+{{- else if and (eq .Stack.Name "rails") (or (eq .Database "mariadb") (eq .Database "mysql")) }}export DB_SCHEME="mysql2" # mysql/mariadb rails adapter
+{{- else }}export DB_SCHEME="$(echo $RELATIONSHIPS_JSON | jq -r '.{{ .Database }}[0].scheme')"{{ end }}
 {{- end -}}
+{{- if eq .Stack.Name "laravel" }}
+
+# Set Laravel-specific environment variables
+export DB_CONNECTION="$DB_SCHEME"
+{{- end }}
+export DATABASE_URL="${DB_SCHEME}://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_PATH}"
 {{- if .Cache }}
 
 # Set Cache environment variables

diff --git a/platformifier/templates/generic/.platform.app.yaml b/platformifier/templates/generic/.platform.app.yaml
@@ -141,6 +141,8 @@ variables:
 #     XDEBUG_MODE: off
 {{- else if eq "nodejs" .Runtime }}
 #     NODE_ENV: development
+{{- else if eq "ruby" .Runtime }}
+#     RACK_ENV: production
 {{- else }}
 #     ENV_VARIABLE_NAME: "value"
 {{- end }}

diff --git a/platformifier/templates/upsun/.environment b/platformifier/templates/upsun/.environment
@@ -2,17 +2,19 @@
 export DB_HOST="${{ .DatabaseUpper }}_HOST"
 export DB_PORT="${{ .DatabaseUpper }}_PORT"
 export DB_PATH="${{ .DatabaseUpper }}_PATH"
+export DB_DATABASE="$DB_PATH"
 export DB_USERNAME="${{ .DatabaseUpper }}_USERNAME"
 export DB_PASSWORD="${{ .DatabaseUpper }}_PASSWORD"
-{{ if eq .Database "postgresql" }}export DB_SCHEME="postgresql"{{ else }}export DB_SCHEME="${{ .DatabaseUpper }}_SCHEME"{{ end }}
-export DATABASE_URL="${DB_SCHEME}://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_PATH}"
+{{ if eq .Database "postgresql" }}export DB_SCHEME="postgresql"
+{{- else if and (eq .Stack.Name "rails") (or (eq .Database "mariadb") (eq .Database "mysql")) }}export DB_SCHEME="mysql2" # mysql/mariadb rails adapter
+{{- else }}export DB_SCHEME="${{ .DatabaseUpper }}_SCHEME"{{ end }}
 {{- end -}}
 {{- if eq .Stack.Name "laravel" }}
 
 # Set Laravel-specific environment variables
 export DB_CONNECTION="$DB_SCHEME"
-export DB_DATABASE="$DB_PATH"
-{{- end -}}
+{{- end }}
+export DATABASE_URL="${DB_SCHEME}://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_PATH}"
 {{- if .Cache }}
 
 # Set Cache environment variables

diff --git a/platformifier/templates/upsun/.upsun/config.yaml b/platformifier/templates/upsun/.upsun/config.yaml
@@ -136,6 +136,8 @@ applications:
     #     XDEBUG_MODE: off
     {{- else if eq "nodejs" .Runtime }}
     #     NODE_ENV: development
+    {{- else if eq "ruby" .Runtime }}
+    #     RACK_ENV: production
     {{- else }}
     #     ENV_VARIABLE_NAME: "value"
     {{- end }}