Phase 1: warp_engine gem skeleton (path gem, mounted engine)

- libs/ruby/warp_engine: gemspec, WarpEngine::Engine (isolate_namespace with
  empty table_name_prefix), WarpEngine.configure surface (container paths,
  update_secret, image_owners), empty engine routes
- host Gemfile: path gem; host routes: mount WarpEngine::Engine => "/" as
  the last entry so host routes always win
- docker: api build context moved to repo root so libs/ is visible at
  bundle-install time; ./libs:/libs runtime mount; root .dockerignore to keep
  data/ and node_modules out of the build context

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
2026-08-04 18:44:32 +02:00
co-authored by Claude Fable 5
parent bf921c589d
commit 2f6cc4cdc2
13 changed files with 135 additions and 4 deletions
+7
View File
@@ -0,0 +1,7 @@
# A repo-gyökér build contextből kihagyandó (az api image-nek csak apps/api + libs kell)
data/
apps/frontend/node_modules/
apps/frontend/dist/
apps/api/tmp/
apps/api/log/
.git/
+5 -2
View File
@@ -14,10 +14,13 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
WORKDIR /app
COPY Gemfile ./
# A path gemek /libs alá kerülnek, ugyanoda, ahova a compose mountolja őket,
# így a Gemfile "../../libs/..." relatív útvonala build- és futásidőben is stimmel.
COPY libs /libs
COPY apps/api/Gemfile ./
RUN bundle install
COPY . .
COPY apps/api .
EXPOSE 3000
+4
View File
@@ -1,6 +1,10 @@
source "https://rubygems.org"
gem "rails", "~> 8.0"
# Katalógus-engine. A relatív path hoston (apps/api -> repo-gyökér/libs) és a
# konténerben (/app -> /libs mount) is ugyanoda oldódik fel.
gem "warp_engine", path: "../../libs/ruby/warp_engine"
gem "mysql2", "~> 0.5"
gem "puma", ">= 5.0"
gem "rubyzip", "~> 2.3"
+7
View File
@@ -1,3 +1,9 @@
PATH
remote: ../libs/ruby/warp_engine
specs:
warp_engine (0.1.0)
rails (>= 8.0)
GEM
remote: https://rubygems.org/
specs:
@@ -380,6 +386,7 @@ DEPENDENCIES
sassc-rails
shoulda-matchers (~> 6.0)
sprockets-rails
warp_engine!
BUNDLED WITH
2.5.22
+3
View File
@@ -20,4 +20,7 @@ Rails.application.routes.draw do
end
get "update", to: "update#update"
get "file/*path", to: "files#show", format: false
# Utolsó sor: a host route-jai nyernek, minden mást az engine kap el.
mount WarpEngine::Engine => "/"
end
+4 -2
View File
@@ -144,8 +144,9 @@ services:
api:
build:
context: ./apps/api
dockerfile: Dockerfile.development
# Repo-gyökér context: a libs/ alatti path gemeknek látszaniuk kell build közben
context: .
dockerfile: apps/api/Dockerfile.development
container_name: api
environment:
- RAILS_ENV=development
@@ -168,6 +169,7 @@ services:
- ./data/softwares:/softwares
- ./data/images:/images
- ./apps/api:/app
- ./libs:/libs
- api_bundle:/usr/local/bundle
labels:
- "traefik.enable=true"
+34
View File
@@ -0,0 +1,34 @@
# WarpEngine
Mountable Rails engine: retro szoftverkatalógus CI-pipeline-ból hívható release-updaterrel,
publikus read-only JSON API-val és a host adminjába betöltődő ActiveAdmin erőforrásokkal.
## Használat
```ruby
# Gemfile
gem "warp_engine", path: "../../libs/ruby/warp_engine"
# config/routes.rb — utolsó sorként, hogy a host route-jai nyerjenek
mount WarpEngine::Engine => "/"
# config/initializers/warp_engine.rb
WarpEngine.configure do |c|
c.file_container_path = ENV.fetch("FILE_CONTAINER_PATH", "/softwares")
c.image_container_path = ENV.fetch("IMAGE_CONTAINER_PATH", "/images")
c.update_secret = ENV["UPDATE_SECRET"]
# Ha a host modelljei is használnak katalógus-képeket:
c.image_owners << {
label: "member",
image_ids: -> { Member.where.not(image_id: nil).distinct.pluck(:image_id) },
usage_label: ->(image) { "member" if Member.where(image_id: image.id).exists? }
}
end
```
## Megjegyzések
- A modellek soft-delete-et használnak (`default_scope { where(deleted_at: nil) }`);
az updater `.unscoped`-dal "feltámasztja" az újra beküldött, korábban törölt rekordokat.
- A táblanevek prefix nélküliek (`softwares`, `releases`, ...).
- Az admin erőforrások a host ActiveAdmin példányába töltődnek be; auth (Devise) a host dolga.
+2
View File
@@ -0,0 +1,2 @@
WarpEngine::Engine.routes.draw do
end
+21
View File
@@ -0,0 +1,21 @@
require "warp_engine/version"
require "warp_engine/configuration"
module WarpEngine
# A tábláink prefix nélküliek (softwares, releases, ...) — az isolate_namespace
# által generált "warp_engine_" prefixet üresre cseréljük. Az engine.rb require-je
# előtt kell definiálva lennie.
def self.table_name_prefix
""
end
def self.config
@config ||= Configuration.new
end
def self.configure
yield(config)
end
end
require "warp_engine/engine"
@@ -0,0 +1,19 @@
module WarpEngine
class Configuration
# Owner kontraktus az image_owners elemeire:
# label: String
# image_ids: -> { Array<Integer> } — az owner által használt image id-k
# usage_label: ->(image) { String vagy nil } — megjelenítendő címke, ha használja
attr_accessor :file_container_path,
:image_container_path,
:update_secret,
:image_owners
def initialize
@file_container_path = ENV.fetch("FILE_CONTAINER_PATH", "/softwares")
@image_container_path = ENV.fetch("IMAGE_CONTAINER_PATH", "/images")
@update_secret = ENV["UPDATE_SECRET"]
@image_owners = []
end
end
end
@@ -0,0 +1,5 @@
module WarpEngine
class Engine < ::Rails::Engine
isolate_namespace WarpEngine
end
end
@@ -0,0 +1,3 @@
module WarpEngine
VERSION = "0.1.0"
end
+21
View File
@@ -0,0 +1,21 @@
require_relative "lib/warp_engine/version"
Gem::Specification.new do |spec|
spec.name = "warp_engine"
spec.version = WarpEngine::VERSION
spec.authors = [ "Teletype Games" ]
spec.summary = "Retro software catalog engine with a CI-callable release updater"
spec.description = "Mountable Rails engine providing a software catalog (softwares, releases, " \
"release assets, images, platform links), a pipeline-callable update endpoint, " \
"a public read-only JSON API and ActiveAdmin resources for a host-owned admin."
spec.license = "MIT"
spec.homepage = "https://teletypegames.org"
spec.required_ruby_version = ">= 3.2"
spec.metadata["allowed_push_host"] = "https://git.teletypegames.org"
spec.files = Dir["{app,config,db,lib}/**/*", "README.md"]
spec.add_dependency "rails", ">= 8.0"
end