commit 4a35bf675854eb7e3b14ea785614c38a44b9b851 Author: Dan Milne Date: Wed Oct 29 15:58:40 2025 +1100 First commit diff --git a/.claude/rails-architect.md b/.claude/rails-architect.md new file mode 100644 index 0000000..cf06fce --- /dev/null +++ b/.claude/rails-architect.md @@ -0,0 +1,398 @@ +--- +name: rails-architect +description: Rails Architecture & System Design Expert - guides architectural decisions, maintains consistency, and ensures applications follow Rails conventions and modern best practices +model: sonnet +tools: Read,Glob,Grep,Bash +--- + +# Rails Architect Agent + +You are a specialized Rails architecture and system design expert. Your role is to guide architectural decisions, maintain consistency, and ensure applications follow Rails conventions and modern best practices. + +## Your First Task: Analyze the Codebase + +**CRITICAL**: On your first invocation in a new codebase, you MUST: + +1. **Analyze the existing patterns**: + - Read `Gemfile` to understand tech stack + - Check `config/routes.rb` for routing patterns + - Review 2-3 representative models in `app/models/` + - Review 2-3 representative controllers in `app/controllers/` + - Check `app/models/concerns/` and `app/controllers/concerns/` for organization patterns + - Look at `config/database.yml` for database choice + - Check for background job systems (Sidekiq, Resque, etc.) + +2. **Document the patterns you observe**: + - Database (PostgreSQL, MySQL, SQLite) + - Background jobs (Sidekiq, Resque, Solid Queue) + - Real-time (ActionCable, Hotwire) + - Frontend approach (Hotwire, React, Vue, traditional) + - Testing framework (RSpec, Minitest) + - Code organization (concerns, service objects, etc.) + +3. **Match the existing style**: + - Follow the patterns you observed + - Maintain consistency with existing code + - Don't introduce new patterns without discussing + +## Core Architectural Principles + +### 1. Rails Conventions First +- Follow Rails conventions strictly (Convention over Configuration) +- Use Active Record patterns and associations appropriately +- Leverage Rails generators and defaults when possible +- Respect the "Rails Way" unless there's a compelling reason not to + +### 2. Common Rails Patterns + +**Concern-Based Organization**: +```ruby +# Extract shared behavior into concerns +# app/models/concerns/nameable.rb +module Nameable + extend ActiveSupport::Concern + + included do + validates :name, presence: true + end + + def display_name + name.titleize + end +end +``` + +**Service Objects** (for complex business logic): +```ruby +# app/services/user_registration_service.rb +class UserRegistrationService + def initialize(user_params) + @user_params = user_params + end + + def call + ActiveRecord::Base.transaction do + create_user + send_welcome_email + notify_admin + end + end + + private + def create_user + @user = User.create!(@user_params) + end +end +``` + +**Background Jobs** (for async work): +```ruby +# app/jobs/email_notification_job.rb +class EmailNotificationJob < ApplicationJob + queue_as :default + + def perform(user_id, notification_type) + user = User.find(user_id) + NotificationMailer.send(notification_type, user).deliver_now + end +end +``` + +### 3. Database Design Principles + +**Always Use**: +- Foreign key constraints for data integrity +- Indexes on foreign keys and frequently queried columns +- `null: false` for required fields +- Proper cascade deletion (`dependent: :destroy` or `:delete_all`) + +**Schema Best Practices**: +```ruby +class CreatePosts < ActiveRecord::Migration[7.1] + def change + create_table :posts do |t| + t.references :user, null: false, foreign_key: true, index: true + t.string :title, null: false + t.text :body + t.integer :status, default: 0, null: false + + t.timestamps + end + + add_index :posts, :status + add_index :posts, [:user_id, :created_at] + end +end +``` + +### 4. Current Context Pattern + +Use `ActiveSupport::CurrentAttributes` for request-scoped data: + +```ruby +# app/models/current.rb +class Current < ActiveSupport::CurrentAttributes + attribute :user, :request_id, :user_agent +end + +# Set in ApplicationController +class ApplicationController < ActionController::Base + before_action :set_current_user + + private + def set_current_user + Current.user = authenticated_user + end +end +``` + +### 5. Authorization Patterns + +**Model-Level Permissions**: +```ruby +class Post < ApplicationRecord + belongs_to :author, class_name: 'User' + + def editable_by?(user) + author == user || user.admin? + end +end +``` + +**Controller-Level Guards**: +```ruby +class PostsController < ApplicationController + before_action :set_post, only: [:edit, :update, :destroy] + before_action :authorize_post, only: [:edit, :update, :destroy] + + private + def authorize_post + head :forbidden unless @post.editable_by?(current_user) + end +end +``` + +## Decision Framework + +When making architectural decisions, evaluate: + +1. **Rails Way**: Does it follow Rails conventions? +2. **Consistency**: Does it match existing patterns in this codebase? +3. **Simplicity**: Is it the simplest solution that works? +4. **Testability**: Can it be easily tested? +5. **Performance**: What are the performance implications? +6. **Maintainability**: Will future developers understand it? +7. **Scalability**: Will it work as the app grows? + +## Code Organization Guidelines + +### Models +```ruby +class User < ApplicationRecord + # 1. Includes/concerns + include Nameable, Authenticatable + + # 2. Enums + enum role: { member: 0, admin: 1 } + + # 3. Associations + belongs_to :organization + has_many :posts, dependent: :destroy + + # 4. Validations + validates :email, presence: true, uniqueness: true + + # 5. Callbacks (use sparingly) + before_save :normalize_email + + # 6. Scopes + scope :active, -> { where(active: true) } + + # 7. Class methods + def self.find_by_credentials(email, password) + # ... + end + + # 8. Instance methods + def full_name + "#{first_name} #{last_name}" + end + + # 9. Private methods + private + def normalize_email + self.email = email.downcase.strip + end +end +``` + +### Controllers +```ruby +class PostsController < ApplicationController + # 1. Includes/concerns + include Authenticatable + + # 2. Before actions + before_action :authenticate_user! + before_action :set_post, only: [:show, :edit, :update, :destroy] + + # 3. Actions (REST order) + def index + def show + def new + def create + def edit + def update + def destroy + + # 4. Private methods + private + def set_post + @post = Post.find(params[:id]) + end + + def post_params + params.require(:post).permit(:title, :body, :status) + end +end +``` + +## Common Architectural Patterns + +### 1. Single Table Inheritance (STI) +```ruby +class User < ApplicationRecord + # Base class +end + +class Admin < User + # Admin-specific behavior +end + +class Member < User + # Member-specific behavior +end + +# Scopes for querying +scope :admins, -> { where(type: 'Admin') } +``` + +### 2. Polymorphic Associations +```ruby +class Comment < ApplicationRecord + belongs_to :commentable, polymorphic: true +end + +class Post < ApplicationRecord + has_many :comments, as: :commentable +end + +class Photo < ApplicationRecord + has_many :comments, as: :commentable +end +``` + +### 3. Association Extensions +```ruby +class User < ApplicationRecord + has_many :posts do + def published + where(published: true) + end + + def by_date + order(published_at: :desc) + end + end +end +``` + +### 4. Delegations +```ruby +class Post < ApplicationRecord + belongs_to :author, class_name: 'User' + + delegate :name, :email, to: :author, prefix: true + # post.author_name, post.author_email +end +``` + +## Integration with Agent OS + +When working with Agent OS: +- Reference product context from `.agent-os/product/` if available +- Follow roadmap priorities from `.agent-os/product/roadmap.md` +- Align with tech stack decisions in `.agent-os/product/tech-stack.md` +- Document significant architectural decisions + +## Anti-Patterns to Avoid + +❌ **Don't:** +- Put business logic in controllers (use service objects/models) +- Create "fat" models (extract concerns and service objects) +- Skip database constraints and indexes +- Use callbacks for cross-model operations (use service objects) +- Create inconsistent patterns across the codebase +- Skip authorization checks +- Introduce new architectural patterns without team discussion + +✅ **Do:** +- Keep controllers thin (orchestration only) +- Use concerns for shared behavior +- Add database constraints and indexes +- Use service objects for complex orchestration +- Follow established patterns in the codebase +- Always check authorization +- Match the existing codebase style + +## Collaboration with Other Agents + +You are the **technical lead** for architectural decisions. You: +- **Guide** other agents on where code should live +- **Review** design approaches before implementation +- **Ensure** consistency across the codebase +- **Delegate** implementation to specialized agents + +**Workflow**: +1. User asks architectural question → You provide design +2. You specify which agent should implement → Delegate to specialist +3. Specialist implements → You can review if needed + +## Response Format + +When providing architectural guidance: + +```markdown +## Analysis +[Understand the current state and requirements] + +## Recommendation +[Provide clear architectural recommendation] + +## Rationale +[Explain why this follows Rails best practices and fits the codebase] + +## Code Organization +- Models: `app/models/[name].rb` +- Services: `app/services/[name]_service.rb` +- Jobs: `app/jobs/[name]_job.rb` +- Concerns: `app/models/concerns/[name].rb` + +## Similar Patterns +[Point to similar existing code in the codebase, if any] + +## Implementation Plan +1. [Step 1] +2. [Step 2] +3. [Step 3] + +## Agent Delegation +- @rails-model-engineer: [Model implementation tasks] +- @rails-controller-engineer: [Controller implementation tasks] +- @rails-hotwire-engineer: [Frontend tasks] +- @rails-testing-expert: [Testing tasks] +``` + +## Remember + +You are **architecture-focused**. You design and guide, but delegate implementation to specialist agents. Your goal is to ensure the application is well-architected, maintainable, and follows Rails best practices while **matching the existing codebase patterns**. \ No newline at end of file diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..325bfc0 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,51 @@ +# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files. + +# Ignore git directory. +/.git/ +/.gitignore + +# Ignore bundler config. +/.bundle + +# Ignore all environment files. +/.env* + +# Ignore all default key files. +/config/master.key +/config/credentials/*.key + +# Ignore all logfiles and tempfiles. +/log/* +/tmp/* +!/log/.keep +!/tmp/.keep + +# Ignore pidfiles, but keep the directory. +/tmp/pids/* +!/tmp/pids/.keep + +# Ignore storage (uploaded files in development and any SQLite databases). +/storage/* +!/storage/.keep +/tmp/storage/* +!/tmp/storage/.keep + +# Ignore assets. +/node_modules/ +/app/assets/builds/* +!/app/assets/builds/.keep +/public/assets + +# Ignore CI service files. +/.github + +# Ignore Kamal files. +/config/deploy*.yml +/.kamal + +# Ignore development files +/.devcontainer + +# Ignore Docker-related files +/.dockerignore +/Dockerfile* diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..8dc4323 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,9 @@ +# See https://git-scm.com/docs/gitattributes for more about git attribute files. + +# Mark the database schema as having been generated. +db/schema.rb linguist-generated + +# Mark any vendored files as having been vendored. +vendor/* linguist-vendored +config/credentials/*.yml.enc diff=rails_credentials +config/credentials.yml.enc diff=rails_credentials diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..83610cf --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +version: 2 +updates: +- package-ecosystem: bundler + directory: "/" + schedule: + interval: weekly + open-pull-requests-limit: 10 +- package-ecosystem: github-actions + directory: "/" + schedule: + interval: weekly + open-pull-requests-limit: 10 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..4adf8d4 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,124 @@ +name: CI + +on: + pull_request: + push: + branches: [ main ] + +jobs: + scan_ruby: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v5 + + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + bundler-cache: true + + - name: Scan for common Rails security vulnerabilities using static analysis + run: bin/brakeman --no-pager + + - name: Scan for known security vulnerabilities in gems used + run: bin/bundler-audit + + scan_js: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v5 + + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + bundler-cache: true + + - name: Scan for security vulnerabilities in JavaScript dependencies + run: bin/importmap audit + + lint: + runs-on: ubuntu-latest + env: + RUBOCOP_CACHE_ROOT: tmp/rubocop + steps: + - name: Checkout code + uses: actions/checkout@v5 + + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + bundler-cache: true + + - name: Prepare RuboCop cache + uses: actions/cache@v4 + env: + DEPENDENCIES_HASH: ${{ hashFiles('.ruby-version', '**/.rubocop.yml', '**/.rubocop_todo.yml', 'Gemfile.lock') }} + with: + path: ${{ env.RUBOCOP_CACHE_ROOT }} + key: rubocop-${{ runner.os }}-${{ env.DEPENDENCIES_HASH }}-${{ github.ref_name == github.event.repository.default_branch && github.run_id || 'default' }} + restore-keys: | + rubocop-${{ runner.os }}-${{ env.DEPENDENCIES_HASH }}- + + - name: Lint code for consistent style + run: bin/rubocop -f github + + test: + runs-on: ubuntu-latest + + # services: + # redis: + # image: valkey/valkey:8 + # ports: + # - 6379:6379 + # options: --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5 + steps: + - name: Checkout code + uses: actions/checkout@v5 + + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + bundler-cache: true + + - name: Run tests + env: + RAILS_ENV: test + # RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }} + # REDIS_URL: redis://localhost:6379/0 + run: bin/rails db:test:prepare test + + system-test: + runs-on: ubuntu-latest + + # services: + # redis: + # image: valkey/valkey:8 + # ports: + # - 6379:6379 + # options: --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5 + steps: + - name: Checkout code + uses: actions/checkout@v5 + + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + bundler-cache: true + + - name: Run System Tests + env: + RAILS_ENV: test + # RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }} + # REDIS_URL: redis://localhost:6379/0 + run: bin/rails db:test:prepare test:system + + - name: Keep screenshots from failed system tests + uses: actions/upload-artifact@v4 + if: failure() + with: + name: screenshots + path: ${{ github.workspace }}/tmp/screenshots + if-no-files-found: ignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e953825 --- /dev/null +++ b/.gitignore @@ -0,0 +1,38 @@ +# See https://help.github.com/articles/ignoring-files for more about ignoring files. +# +# Temporary files generated by your text editor or operating system +# belong in git's global ignore instead: +# `$XDG_CONFIG_HOME/git/ignore` or `~/.config/git/ignore` + +# Ignore bundler config. +/.bundle + +# Ignore all environment files. +/.env* + +# Ignore all logfiles and tempfiles. +/log/* +/tmp/* +!/log/.keep +!/tmp/.keep + +# Ignore pidfiles, but keep the directory. +/tmp/pids/* +!/tmp/pids/ +!/tmp/pids/.keep + +# Ignore storage (uploaded files in development and any SQLite databases). +/storage/* +!/storage/.keep +/tmp/storage/* +!/tmp/storage/ +!/tmp/storage/.keep + +/public/assets + +# Ignore key files for decrypting credentials and more. +/config/*.key + + +/app/assets/builds/* +!/app/assets/builds/.keep diff --git a/.kamal/hooks/docker-setup.sample b/.kamal/hooks/docker-setup.sample new file mode 100755 index 0000000..2fb07d7 --- /dev/null +++ b/.kamal/hooks/docker-setup.sample @@ -0,0 +1,3 @@ +#!/bin/sh + +echo "Docker set up on $KAMAL_HOSTS..." diff --git a/.kamal/hooks/post-app-boot.sample b/.kamal/hooks/post-app-boot.sample new file mode 100755 index 0000000..70f9c4b --- /dev/null +++ b/.kamal/hooks/post-app-boot.sample @@ -0,0 +1,3 @@ +#!/bin/sh + +echo "Booted app version $KAMAL_VERSION on $KAMAL_HOSTS..." diff --git a/.kamal/hooks/post-deploy.sample b/.kamal/hooks/post-deploy.sample new file mode 100755 index 0000000..fd364c2 --- /dev/null +++ b/.kamal/hooks/post-deploy.sample @@ -0,0 +1,14 @@ +#!/bin/sh + +# A sample post-deploy hook +# +# These environment variables are available: +# KAMAL_RECORDED_AT +# KAMAL_PERFORMER +# KAMAL_VERSION +# KAMAL_HOSTS +# KAMAL_ROLES (if set) +# KAMAL_DESTINATION (if set) +# KAMAL_RUNTIME + +echo "$KAMAL_PERFORMER deployed $KAMAL_VERSION to $KAMAL_DESTINATION in $KAMAL_RUNTIME seconds" diff --git a/.kamal/hooks/post-proxy-reboot.sample b/.kamal/hooks/post-proxy-reboot.sample new file mode 100755 index 0000000..1435a67 --- /dev/null +++ b/.kamal/hooks/post-proxy-reboot.sample @@ -0,0 +1,3 @@ +#!/bin/sh + +echo "Rebooted kamal-proxy on $KAMAL_HOSTS" diff --git a/.kamal/hooks/pre-app-boot.sample b/.kamal/hooks/pre-app-boot.sample new file mode 100755 index 0000000..45f7355 --- /dev/null +++ b/.kamal/hooks/pre-app-boot.sample @@ -0,0 +1,3 @@ +#!/bin/sh + +echo "Booting app version $KAMAL_VERSION on $KAMAL_HOSTS..." diff --git a/.kamal/hooks/pre-build.sample b/.kamal/hooks/pre-build.sample new file mode 100755 index 0000000..c5a5567 --- /dev/null +++ b/.kamal/hooks/pre-build.sample @@ -0,0 +1,51 @@ +#!/bin/sh + +# A sample pre-build hook +# +# Checks: +# 1. We have a clean checkout +# 2. A remote is configured +# 3. The branch has been pushed to the remote +# 4. The version we are deploying matches the remote +# +# These environment variables are available: +# KAMAL_RECORDED_AT +# KAMAL_PERFORMER +# KAMAL_VERSION +# KAMAL_HOSTS +# KAMAL_ROLES (if set) +# KAMAL_DESTINATION (if set) + +if [ -n "$(git status --porcelain)" ]; then + echo "Git checkout is not clean, aborting..." >&2 + git status --porcelain >&2 + exit 1 +fi + +first_remote=$(git remote) + +if [ -z "$first_remote" ]; then + echo "No git remote set, aborting..." >&2 + exit 1 +fi + +current_branch=$(git branch --show-current) + +if [ -z "$current_branch" ]; then + echo "Not on a git branch, aborting..." >&2 + exit 1 +fi + +remote_head=$(git ls-remote $first_remote --tags $current_branch | cut -f1) + +if [ -z "$remote_head" ]; then + echo "Branch not pushed to remote, aborting..." >&2 + exit 1 +fi + +if [ "$KAMAL_VERSION" != "$remote_head" ]; then + echo "Version ($KAMAL_VERSION) does not match remote HEAD ($remote_head), aborting..." >&2 + exit 1 +fi + +exit 0 diff --git a/.kamal/hooks/pre-connect.sample b/.kamal/hooks/pre-connect.sample new file mode 100755 index 0000000..77744bd --- /dev/null +++ b/.kamal/hooks/pre-connect.sample @@ -0,0 +1,47 @@ +#!/usr/bin/env ruby + +# A sample pre-connect check +# +# Warms DNS before connecting to hosts in parallel +# +# These environment variables are available: +# KAMAL_RECORDED_AT +# KAMAL_PERFORMER +# KAMAL_VERSION +# KAMAL_HOSTS +# KAMAL_ROLES (if set) +# KAMAL_DESTINATION (if set) +# KAMAL_RUNTIME + +hosts = ENV["KAMAL_HOSTS"].split(",") +results = nil +max = 3 + +elapsed = Benchmark.realtime do + results = hosts.map do |host| + Thread.new do + tries = 1 + + begin + Socket.getaddrinfo(host, 0, Socket::AF_UNSPEC, Socket::SOCK_STREAM, nil, Socket::AI_CANONNAME) + rescue SocketError + if tries < max + puts "Retrying DNS warmup: #{host}" + tries += 1 + sleep rand + retry + else + puts "DNS warmup failed: #{host}" + host + end + end + + tries + end + end.map(&:value) +end + +retries = results.sum - hosts.size +nopes = results.count { |r| r == max } + +puts "Prewarmed %d DNS lookups in %.2f sec: %d retries, %d failures" % [ hosts.size, elapsed, retries, nopes ] diff --git a/.kamal/hooks/pre-deploy.sample b/.kamal/hooks/pre-deploy.sample new file mode 100755 index 0000000..05b3055 --- /dev/null +++ b/.kamal/hooks/pre-deploy.sample @@ -0,0 +1,122 @@ +#!/usr/bin/env ruby + +# A sample pre-deploy hook +# +# Checks the Github status of the build, waiting for a pending build to complete for up to 720 seconds. +# +# Fails unless the combined status is "success" +# +# These environment variables are available: +# KAMAL_RECORDED_AT +# KAMAL_PERFORMER +# KAMAL_VERSION +# KAMAL_HOSTS +# KAMAL_COMMAND +# KAMAL_SUBCOMMAND +# KAMAL_ROLES (if set) +# KAMAL_DESTINATION (if set) + +# Only check the build status for production deployments +if ENV["KAMAL_COMMAND"] == "rollback" || ENV["KAMAL_DESTINATION"] != "production" + exit 0 +end + +require "bundler/inline" + +# true = install gems so this is fast on repeat invocations +gemfile(true, quiet: true) do + source "https://rubygems.org" + + gem "octokit" + gem "faraday-retry" +end + +MAX_ATTEMPTS = 72 +ATTEMPTS_GAP = 10 + +def exit_with_error(message) + $stderr.puts message + exit 1 +end + +class GithubStatusChecks + attr_reader :remote_url, :git_sha, :github_client, :combined_status + + def initialize + @remote_url = github_repo_from_remote_url + @git_sha = `git rev-parse HEAD`.strip + @github_client = Octokit::Client.new(access_token: ENV["GITHUB_TOKEN"]) + refresh! + end + + def refresh! + @combined_status = github_client.combined_status(remote_url, git_sha) + end + + def state + combined_status[:state] + end + + def first_status_url + first_status = combined_status[:statuses].find { |status| status[:state] == state } + first_status && first_status[:target_url] + end + + def complete_count + combined_status[:statuses].count { |status| status[:state] != "pending"} + end + + def total_count + combined_status[:statuses].count + end + + def current_status + if total_count > 0 + "Completed #{complete_count}/#{total_count} checks, see #{first_status_url} ..." + else + "Build not started..." + end + end + + private + def github_repo_from_remote_url + url = `git config --get remote.origin.url`.strip.delete_suffix(".git") + if url.start_with?("https://github.com/") + url.delete_prefix("https://github.com/") + elsif url.start_with?("git@github.com:") + url.delete_prefix("git@github.com:") + else + url + end + end +end + + +$stdout.sync = true + +begin + puts "Checking build status..." + + attempts = 0 + checks = GithubStatusChecks.new + + loop do + case checks.state + when "success" + puts "Checks passed, see #{checks.first_status_url}" + exit 0 + when "failure" + exit_with_error "Checks failed, see #{checks.first_status_url}" + when "pending" + attempts += 1 + end + + exit_with_error "Checks are still pending, gave up after #{MAX_ATTEMPTS * ATTEMPTS_GAP} seconds" if attempts == MAX_ATTEMPTS + + puts checks.current_status + sleep(ATTEMPTS_GAP) + checks.refresh! + end +rescue Octokit::NotFound + exit_with_error "Build status could not be found" +end diff --git a/.kamal/hooks/pre-proxy-reboot.sample b/.kamal/hooks/pre-proxy-reboot.sample new file mode 100755 index 0000000..061f805 --- /dev/null +++ b/.kamal/hooks/pre-proxy-reboot.sample @@ -0,0 +1,3 @@ +#!/bin/sh + +echo "Rebooting kamal-proxy on $KAMAL_HOSTS..." diff --git a/.kamal/secrets b/.kamal/secrets new file mode 100644 index 0000000..b3089d6 --- /dev/null +++ b/.kamal/secrets @@ -0,0 +1,20 @@ +# Secrets defined here are available for reference under registry/password, env/secret, builder/secrets, +# and accessories/*/env/secret in config/deploy.yml. All secrets should be pulled from either +# password manager, ENV, or a file. DO NOT ENTER RAW CREDENTIALS HERE! This file needs to be safe for git. + +# Example of extracting secrets from 1password (or another compatible pw manager) +# SECRETS=$(kamal secrets fetch --adapter 1password --account your-account --from Vault/Item KAMAL_REGISTRY_PASSWORD RAILS_MASTER_KEY) +# KAMAL_REGISTRY_PASSWORD=$(kamal secrets extract KAMAL_REGISTRY_PASSWORD ${SECRETS}) +# RAILS_MASTER_KEY=$(kamal secrets extract RAILS_MASTER_KEY ${SECRETS}) + +# Example of extracting secrets from Rails credentials +# KAMAL_REGISTRY_PASSWORD=$(rails credentials:fetch kamal.registry_password) + +# Use a GITHUB_TOKEN if private repositories are needed for the image +# GITHUB_TOKEN=$(gh config get -h github.com oauth_token) + +# Grab the registry password from ENV +# KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD + +# Improve security by using a password manager. Never check config/master.key into git! +RAILS_MASTER_KEY=$(cat config/master.key) diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 0000000..f9d86d4 --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,8 @@ +# Omakase Ruby styling for Rails +inherit_gem: { rubocop-rails-omakase: rubocop.yml } + +# Overwrite or add rules to create your own house style +# +# # Use `[a, [b, c]]` not `[ a, [ b, c ] ]` +# Layout/SpaceInsideArrayLiteralBrackets: +# Enabled: false diff --git a/.ruby-version b/.ruby-version new file mode 100644 index 0000000..1cf8253 --- /dev/null +++ b/.ruby-version @@ -0,0 +1 @@ +3.4.6 diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..46c192e --- /dev/null +++ b/Dockerfile @@ -0,0 +1,76 @@ +# syntax=docker/dockerfile:1 +# check=error=true + +# This Dockerfile is designed for production, not development. Use with Kamal or build'n'run by hand: +# docker build -t velour . +# docker run -d -p 80:80 -e RAILS_MASTER_KEY= --name velour velour + +# For a containerized dev environment, see Dev Containers: https://guides.rubyonrails.org/getting_started_with_devcontainer.html + +# Make sure RUBY_VERSION matches the Ruby version in .ruby-version +ARG RUBY_VERSION=3.4.6 +FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base + +# Rails app lives here +WORKDIR /rails + +# Install base packages +RUN apt-get update -qq && \ + apt-get install --no-install-recommends -y curl libjemalloc2 libvips sqlite3 && \ + ln -s /usr/lib/$(uname -m)-linux-gnu/libjemalloc.so.2 /usr/local/lib/libjemalloc.so && \ + rm -rf /var/lib/apt/lists /var/cache/apt/archives + +# Set production environment variables and enable jemalloc for reduced memory usage and latency. +ENV RAILS_ENV="production" \ + BUNDLE_DEPLOYMENT="1" \ + BUNDLE_PATH="/usr/local/bundle" \ + BUNDLE_WITHOUT="development" \ + LD_PRELOAD="/usr/local/lib/libjemalloc.so" + +# Throw-away build stage to reduce size of final image +FROM base AS build + +# Install packages needed to build gems +RUN apt-get update -qq && \ + apt-get install --no-install-recommends -y build-essential git libyaml-dev pkg-config && \ + rm -rf /var/lib/apt/lists /var/cache/apt/archives + +# Install application gems +COPY Gemfile Gemfile.lock vendor ./ + +RUN bundle install && \ + rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \ + # -j 1 disable parallel compilation to avoid a QEMU bug: https://github.com/rails/bootsnap/issues/495 + bundle exec bootsnap precompile -j 1 --gemfile + +# Copy application code +COPY . . + +# Precompile bootsnap code for faster boot times. +# -j 1 disable parallel compilation to avoid a QEMU bug: https://github.com/rails/bootsnap/issues/495 +RUN bundle exec bootsnap precompile -j 1 app/ lib/ + +# Precompiling assets for production without requiring secret RAILS_MASTER_KEY +RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile + + + + +# Final stage for app image +FROM base + +# Run and own only the runtime files as a non-root user for security +RUN groupadd --system --gid 1000 rails && \ + useradd rails --uid 1000 --gid 1000 --create-home --shell /bin/bash +USER 1000:1000 + +# Copy built artifacts: gems, application +COPY --chown=rails:rails --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}" +COPY --chown=rails:rails --from=build /rails /rails + +# Entrypoint prepares the database. +ENTRYPOINT ["/rails/bin/docker-entrypoint"] + +# Start server via Thruster by default, this can be overwritten at runtime +EXPOSE 80 +CMD ["./bin/thrust", "./bin/rails", "server"] diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..d2334c4 --- /dev/null +++ b/Gemfile @@ -0,0 +1,68 @@ +source "https://rubygems.org" + +# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main" +gem "rails", "~> 8.1.1" +# The modern asset pipeline for Rails [https://github.com/rails/propshaft] +gem "propshaft" +# Use sqlite3 as the database for Active Record +gem "sqlite3", ">= 2.1" +# Use the Puma web server [https://github.com/puma/puma] +gem "puma", ">= 5.0" +# Use JavaScript with ESM import maps [https://github.com/rails/importmap-rails] +gem "importmap-rails" +# Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev] +gem "turbo-rails" +# Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev] +gem "stimulus-rails" +# Use Tailwind CSS [https://github.com/rails/tailwindcss-rails] +gem "tailwindcss-rails" +# Build JSON APIs with ease [https://github.com/rails/jbuilder] +gem "jbuilder" + +# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword] +# gem "bcrypt", "~> 3.1.7" + +# Windows does not include zoneinfo files, so bundle the tzinfo-data gem +gem "tzinfo-data", platforms: %i[ windows jruby ] + +# Use the database-backed adapters for Rails.cache, Active Job, and Action Cable +gem "solid_cache" +gem "solid_queue" +gem "solid_cable" + +# Reduces boot times through caching; required in config/boot.rb +gem "bootsnap", require: false + +# Deploy this application anywhere as a Docker container [https://kamal-deploy.org] +gem "kamal", require: false + +# Add HTTP asset caching/compression and X-Sendfile acceleration to Puma [https://github.com/basecamp/thruster/] +gem "thruster", require: false + +# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images] +gem "image_processing", "~> 1.2" + +group :development, :test do + # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem + gem "debug", platforms: %i[ mri windows ], require: "debug/prelude" + + # Audits gems for known security defects (use config/bundler-audit.yml to ignore issues) + gem "bundler-audit", require: false + + # Static analysis for security vulnerabilities [https://brakemanscanner.org/] + gem "brakeman", require: false + + # Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/] + gem "rubocop-rails-omakase", require: false +end + +group :development do + # Use console on exceptions pages [https://github.com/rails/web-console] + gem "web-console" +end + +group :test do + # Use system testing [https://guides.rubyonrails.org/testing.html#system-testing] + gem "capybara" + gem "selenium-webdriver" +end diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..a8ac1ae --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,425 @@ +GEM + remote: https://rubygems.org/ + specs: + action_text-trix (2.1.15) + railties + actioncable (8.1.1) + actionpack (= 8.1.1) + activesupport (= 8.1.1) + nio4r (~> 2.0) + websocket-driver (>= 0.6.1) + zeitwerk (~> 2.6) + actionmailbox (8.1.1) + actionpack (= 8.1.1) + activejob (= 8.1.1) + activerecord (= 8.1.1) + activestorage (= 8.1.1) + activesupport (= 8.1.1) + mail (>= 2.8.0) + actionmailer (8.1.1) + actionpack (= 8.1.1) + actionview (= 8.1.1) + activejob (= 8.1.1) + activesupport (= 8.1.1) + mail (>= 2.8.0) + rails-dom-testing (~> 2.2) + actionpack (8.1.1) + actionview (= 8.1.1) + activesupport (= 8.1.1) + nokogiri (>= 1.8.5) + rack (>= 2.2.4) + rack-session (>= 1.0.1) + rack-test (>= 0.6.3) + rails-dom-testing (~> 2.2) + rails-html-sanitizer (~> 1.6) + useragent (~> 0.16) + actiontext (8.1.1) + action_text-trix (~> 2.1.15) + actionpack (= 8.1.1) + activerecord (= 8.1.1) + activestorage (= 8.1.1) + activesupport (= 8.1.1) + globalid (>= 0.6.0) + nokogiri (>= 1.8.5) + actionview (8.1.1) + activesupport (= 8.1.1) + builder (~> 3.1) + erubi (~> 1.11) + rails-dom-testing (~> 2.2) + rails-html-sanitizer (~> 1.6) + activejob (8.1.1) + activesupport (= 8.1.1) + globalid (>= 0.3.6) + activemodel (8.1.1) + activesupport (= 8.1.1) + activerecord (8.1.1) + activemodel (= 8.1.1) + activesupport (= 8.1.1) + timeout (>= 0.4.0) + activestorage (8.1.1) + actionpack (= 8.1.1) + activejob (= 8.1.1) + activerecord (= 8.1.1) + activesupport (= 8.1.1) + marcel (~> 1.0) + activesupport (8.1.1) + base64 + bigdecimal + concurrent-ruby (~> 1.0, >= 1.3.1) + connection_pool (>= 2.2.5) + drb + i18n (>= 1.6, < 2) + json + logger (>= 1.4.2) + minitest (>= 5.1) + securerandom (>= 0.3) + tzinfo (~> 2.0, >= 2.0.5) + uri (>= 0.13.1) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + ast (2.4.3) + base64 (0.3.0) + bcrypt_pbkdf (1.1.1) + bigdecimal (3.3.1) + bindex (0.8.1) + bootsnap (1.18.6) + msgpack (~> 1.2) + brakeman (7.1.0) + racc + builder (3.3.0) + bundler-audit (0.9.2) + bundler (>= 1.2.0, < 3) + thor (~> 1.0) + capybara (3.40.0) + addressable + matrix + mini_mime (>= 0.1.3) + nokogiri (~> 1.11) + rack (>= 1.6.0) + rack-test (>= 0.6.3) + regexp_parser (>= 1.5, < 3.0) + xpath (~> 3.2) + concurrent-ruby (1.3.5) + connection_pool (2.5.4) + crass (1.0.6) + date (3.4.1) + debug (1.11.0) + irb (~> 1.10) + reline (>= 0.3.8) + dotenv (3.1.8) + drb (2.2.3) + ed25519 (1.4.0) + erb (5.1.3) + erubi (1.13.1) + et-orbi (1.4.0) + tzinfo + ffi (1.17.2-aarch64-linux-gnu) + ffi (1.17.2-aarch64-linux-musl) + ffi (1.17.2-arm-linux-gnu) + ffi (1.17.2-arm-linux-musl) + ffi (1.17.2-arm64-darwin) + ffi (1.17.2-x86_64-linux-gnu) + ffi (1.17.2-x86_64-linux-musl) + fugit (1.12.1) + et-orbi (~> 1.4) + raabro (~> 1.4) + globalid (1.3.0) + activesupport (>= 6.1) + i18n (1.14.7) + concurrent-ruby (~> 1.0) + image_processing (1.14.0) + mini_magick (>= 4.9.5, < 6) + ruby-vips (>= 2.0.17, < 3) + importmap-rails (2.2.2) + actionpack (>= 6.0.0) + activesupport (>= 6.0.0) + railties (>= 6.0.0) + io-console (0.8.1) + irb (1.15.2) + pp (>= 0.6.0) + rdoc (>= 4.0.0) + reline (>= 0.4.2) + jbuilder (2.14.1) + actionview (>= 7.0.0) + activesupport (>= 7.0.0) + json (2.15.2) + kamal (2.8.2) + activesupport (>= 7.0) + base64 (~> 0.2) + bcrypt_pbkdf (~> 1.0) + concurrent-ruby (~> 1.2) + dotenv (~> 3.1) + ed25519 (~> 1.4) + net-ssh (~> 7.3) + sshkit (>= 1.23.0, < 2.0) + thor (~> 1.3) + zeitwerk (>= 2.6.18, < 3.0) + language_server-protocol (3.17.0.5) + lint_roller (1.1.0) + logger (1.7.0) + loofah (2.24.1) + crass (~> 1.0.2) + nokogiri (>= 1.12.0) + mail (2.9.0) + logger + mini_mime (>= 0.1.1) + net-imap + net-pop + net-smtp + marcel (1.1.0) + matrix (0.4.3) + mini_magick (5.3.1) + logger + mini_mime (1.1.5) + minitest (5.26.0) + msgpack (1.8.0) + net-imap (0.5.12) + date + net-protocol + net-pop (0.1.2) + net-protocol + net-protocol (0.2.2) + timeout + net-scp (4.1.0) + net-ssh (>= 2.6.5, < 8.0.0) + net-sftp (4.0.0) + net-ssh (>= 5.0.0, < 8.0.0) + net-smtp (0.5.1) + net-protocol + net-ssh (7.3.0) + nio4r (2.7.4) + nokogiri (1.18.10-aarch64-linux-gnu) + racc (~> 1.4) + nokogiri (1.18.10-aarch64-linux-musl) + racc (~> 1.4) + nokogiri (1.18.10-arm-linux-gnu) + racc (~> 1.4) + nokogiri (1.18.10-arm-linux-musl) + racc (~> 1.4) + nokogiri (1.18.10-arm64-darwin) + racc (~> 1.4) + nokogiri (1.18.10-x86_64-linux-gnu) + racc (~> 1.4) + nokogiri (1.18.10-x86_64-linux-musl) + racc (~> 1.4) + ostruct (0.6.3) + parallel (1.27.0) + parser (3.3.10.0) + ast (~> 2.4.1) + racc + pp (0.6.3) + prettyprint + prettyprint (0.2.0) + prism (1.6.0) + propshaft (1.3.1) + actionpack (>= 7.0.0) + activesupport (>= 7.0.0) + rack + psych (5.2.6) + date + stringio + public_suffix (6.0.2) + puma (7.1.0) + nio4r (~> 2.0) + raabro (1.4.0) + racc (1.8.1) + rack (3.2.3) + rack-session (2.1.1) + base64 (>= 0.1.0) + rack (>= 3.0.0) + rack-test (2.2.0) + rack (>= 1.3) + rackup (2.2.1) + rack (>= 3) + rails (8.1.1) + actioncable (= 8.1.1) + actionmailbox (= 8.1.1) + actionmailer (= 8.1.1) + actionpack (= 8.1.1) + actiontext (= 8.1.1) + actionview (= 8.1.1) + activejob (= 8.1.1) + activemodel (= 8.1.1) + activerecord (= 8.1.1) + activestorage (= 8.1.1) + activesupport (= 8.1.1) + bundler (>= 1.15.0) + railties (= 8.1.1) + rails-dom-testing (2.3.0) + activesupport (>= 5.0.0) + minitest + nokogiri (>= 1.6) + rails-html-sanitizer (1.6.2) + loofah (~> 2.21) + nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0) + railties (8.1.1) + actionpack (= 8.1.1) + activesupport (= 8.1.1) + irb (~> 1.13) + rackup (>= 1.0.0) + rake (>= 12.2) + thor (~> 1.0, >= 1.2.2) + tsort (>= 0.2) + zeitwerk (~> 2.6) + rainbow (3.1.1) + rake (13.3.0) + rdoc (6.15.0) + erb + psych (>= 4.0.0) + tsort + regexp_parser (2.11.3) + reline (0.6.2) + io-console (~> 0.5) + rexml (3.4.4) + rubocop (1.81.6) + json (~> 2.3) + language_server-protocol (~> 3.17.0.2) + lint_roller (~> 1.1.0) + parallel (~> 1.10) + parser (>= 3.3.0.2) + rainbow (>= 2.2.2, < 4.0) + regexp_parser (>= 2.9.3, < 3.0) + rubocop-ast (>= 1.47.1, < 2.0) + ruby-progressbar (~> 1.7) + unicode-display_width (>= 2.4.0, < 4.0) + rubocop-ast (1.47.1) + parser (>= 3.3.7.2) + prism (~> 1.4) + rubocop-performance (1.26.1) + lint_roller (~> 1.1) + rubocop (>= 1.75.0, < 2.0) + rubocop-ast (>= 1.47.1, < 2.0) + rubocop-rails (2.33.4) + activesupport (>= 4.2.0) + lint_roller (~> 1.1) + rack (>= 1.1) + rubocop (>= 1.75.0, < 2.0) + rubocop-ast (>= 1.44.0, < 2.0) + rubocop-rails-omakase (1.1.0) + rubocop (>= 1.72) + rubocop-performance (>= 1.24) + rubocop-rails (>= 2.30) + ruby-progressbar (1.13.0) + ruby-vips (2.2.5) + ffi (~> 1.12) + logger + rubyzip (3.2.1) + securerandom (0.4.1) + selenium-webdriver (4.38.0) + base64 (~> 0.2) + logger (~> 1.4) + rexml (~> 3.2, >= 3.2.5) + rubyzip (>= 1.2.2, < 4.0) + websocket (~> 1.0) + solid_cable (3.0.12) + actioncable (>= 7.2) + activejob (>= 7.2) + activerecord (>= 7.2) + railties (>= 7.2) + solid_cache (1.0.8) + activejob (>= 7.2) + activerecord (>= 7.2) + railties (>= 7.2) + solid_queue (1.2.3) + activejob (>= 7.1) + activerecord (>= 7.1) + concurrent-ruby (>= 1.3.1) + fugit (~> 1.11) + railties (>= 7.1) + thor (>= 1.3.1) + sqlite3 (2.7.4-aarch64-linux-gnu) + sqlite3 (2.7.4-aarch64-linux-musl) + sqlite3 (2.7.4-arm-linux-gnu) + sqlite3 (2.7.4-arm-linux-musl) + sqlite3 (2.7.4-arm64-darwin) + sqlite3 (2.7.4-x86_64-linux-gnu) + sqlite3 (2.7.4-x86_64-linux-musl) + sshkit (1.24.0) + base64 + logger + net-scp (>= 1.1.2) + net-sftp (>= 2.1.2) + net-ssh (>= 2.8.0) + ostruct + stimulus-rails (1.3.4) + railties (>= 6.0.0) + stringio (3.1.7) + tailwindcss-rails (4.4.0) + railties (>= 7.0.0) + tailwindcss-ruby (~> 4.0) + tailwindcss-ruby (4.1.16) + tailwindcss-ruby (4.1.16-aarch64-linux-gnu) + tailwindcss-ruby (4.1.16-aarch64-linux-musl) + tailwindcss-ruby (4.1.16-arm64-darwin) + tailwindcss-ruby (4.1.16-x86_64-linux-gnu) + tailwindcss-ruby (4.1.16-x86_64-linux-musl) + thor (1.4.0) + thruster (0.1.16) + thruster (0.1.16-aarch64-linux) + thruster (0.1.16-arm64-darwin) + thruster (0.1.16-x86_64-linux) + timeout (0.4.3) + tsort (0.2.0) + turbo-rails (2.0.20) + actionpack (>= 7.1.0) + railties (>= 7.1.0) + tzinfo (2.0.6) + concurrent-ruby (~> 1.0) + unicode-display_width (3.2.0) + unicode-emoji (~> 4.1) + unicode-emoji (4.1.0) + uri (1.0.4) + useragent (0.16.11) + web-console (4.2.1) + actionview (>= 6.0.0) + activemodel (>= 6.0.0) + bindex (>= 0.4.0) + railties (>= 6.0.0) + websocket (1.2.11) + websocket-driver (0.8.0) + base64 + websocket-extensions (>= 0.1.0) + websocket-extensions (0.1.5) + xpath (3.2.0) + nokogiri (~> 1.8) + zeitwerk (2.7.3) + +PLATFORMS + aarch64-linux + aarch64-linux-gnu + aarch64-linux-musl + arm-linux-gnu + arm-linux-musl + arm64-darwin-24 + x86_64-linux + x86_64-linux-gnu + x86_64-linux-musl + +DEPENDENCIES + bootsnap + brakeman + bundler-audit + capybara + debug + image_processing (~> 1.2) + importmap-rails + jbuilder + kamal + propshaft + puma (>= 5.0) + rails (~> 8.1.1) + rubocop-rails-omakase + selenium-webdriver + solid_cable + solid_cache + solid_queue + sqlite3 (>= 2.1) + stimulus-rails + tailwindcss-rails + thruster + turbo-rails + tzinfo-data + web-console + +BUNDLED WITH + 2.7.2 diff --git a/Procfile.dev b/Procfile.dev new file mode 100644 index 0000000..da151fe --- /dev/null +++ b/Procfile.dev @@ -0,0 +1,2 @@ +web: bin/rails server +css: bin/rails tailwindcss:watch diff --git a/README.md b/README.md new file mode 100644 index 0000000..7db80e4 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# README + +This README would normally document whatever steps are necessary to get the +application up and running. + +Things you may want to cover: + +* Ruby version + +* System dependencies + +* Configuration + +* Database creation + +* Database initialization + +* How to run the test suite + +* Services (job queues, cache servers, search engines, etc.) + +* Deployment instructions + +* ... diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..9a5ea73 --- /dev/null +++ b/Rakefile @@ -0,0 +1,6 @@ +# Add your own tasks in files placed in lib/tasks ending in .rake, +# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake. + +require_relative "config/application" + +Rails.application.load_tasks diff --git a/app/assets/builds/.keep b/app/assets/builds/.keep new file mode 100644 index 0000000..e69de29 diff --git a/app/assets/images/.keep b/app/assets/images/.keep new file mode 100644 index 0000000..e69de29 diff --git a/app/assets/stylesheets/application.css b/app/assets/stylesheets/application.css new file mode 100644 index 0000000..fe93333 --- /dev/null +++ b/app/assets/stylesheets/application.css @@ -0,0 +1,10 @@ +/* + * This is a manifest file that'll be compiled into application.css. + * + * With Propshaft, assets are served efficiently without preprocessing steps. You can still include + * application-wide styles in this file, but keep in mind that CSS precedence will follow the standard + * cascading order, meaning styles declared later in the document or manifest will override earlier ones, + * depending on specificity. + * + * Consider organizing styles into separate files for maintainability. + */ diff --git a/app/assets/tailwind/application.css b/app/assets/tailwind/application.css new file mode 100644 index 0000000..f1d8c73 --- /dev/null +++ b/app/assets/tailwind/application.css @@ -0,0 +1 @@ +@import "tailwindcss"; diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb new file mode 100644 index 0000000..c353756 --- /dev/null +++ b/app/controllers/application_controller.rb @@ -0,0 +1,7 @@ +class ApplicationController < ActionController::Base + # Only allow modern browsers supporting webp images, web push, badges, import maps, CSS nesting, and CSS :has. + allow_browser versions: :modern + + # Changes to the importmap will invalidate the etag for HTML responses + stale_when_importmap_changes +end diff --git a/app/controllers/concerns/.keep b/app/controllers/concerns/.keep new file mode 100644 index 0000000..e69de29 diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb new file mode 100644 index 0000000..de6be79 --- /dev/null +++ b/app/helpers/application_helper.rb @@ -0,0 +1,2 @@ +module ApplicationHelper +end diff --git a/app/javascript/application.js b/app/javascript/application.js new file mode 100644 index 0000000..0d7b494 --- /dev/null +++ b/app/javascript/application.js @@ -0,0 +1,3 @@ +// Configure your import map in config/importmap.rb. Read more: https://github.com/rails/importmap-rails +import "@hotwired/turbo-rails" +import "controllers" diff --git a/app/javascript/controllers/application.js b/app/javascript/controllers/application.js new file mode 100644 index 0000000..1213e85 --- /dev/null +++ b/app/javascript/controllers/application.js @@ -0,0 +1,9 @@ +import { Application } from "@hotwired/stimulus" + +const application = Application.start() + +// Configure Stimulus development experience +application.debug = false +window.Stimulus = application + +export { application } diff --git a/app/javascript/controllers/hello_controller.js b/app/javascript/controllers/hello_controller.js new file mode 100644 index 0000000..5975c07 --- /dev/null +++ b/app/javascript/controllers/hello_controller.js @@ -0,0 +1,7 @@ +import { Controller } from "@hotwired/stimulus" + +export default class extends Controller { + connect() { + this.element.textContent = "Hello World!" + } +} diff --git a/app/javascript/controllers/index.js b/app/javascript/controllers/index.js new file mode 100644 index 0000000..1156bf8 --- /dev/null +++ b/app/javascript/controllers/index.js @@ -0,0 +1,4 @@ +// Import and register all your controllers from the importmap via controllers/**/*_controller +import { application } from "controllers/application" +import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading" +eagerLoadControllersFrom("controllers", application) diff --git a/app/jobs/application_job.rb b/app/jobs/application_job.rb new file mode 100644 index 0000000..d394c3d --- /dev/null +++ b/app/jobs/application_job.rb @@ -0,0 +1,7 @@ +class ApplicationJob < ActiveJob::Base + # Automatically retry jobs that encountered a deadlock + # retry_on ActiveRecord::Deadlocked + + # Most jobs are safe to ignore if the underlying records are no longer available + # discard_on ActiveJob::DeserializationError +end diff --git a/app/mailers/application_mailer.rb b/app/mailers/application_mailer.rb new file mode 100644 index 0000000..3c34c81 --- /dev/null +++ b/app/mailers/application_mailer.rb @@ -0,0 +1,4 @@ +class ApplicationMailer < ActionMailer::Base + default from: "from@example.com" + layout "mailer" +end diff --git a/app/models/application_record.rb b/app/models/application_record.rb new file mode 100644 index 0000000..b63caeb --- /dev/null +++ b/app/models/application_record.rb @@ -0,0 +1,3 @@ +class ApplicationRecord < ActiveRecord::Base + primary_abstract_class +end diff --git a/app/models/concerns/.keep b/app/models/concerns/.keep new file mode 100644 index 0000000..e69de29 diff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erb new file mode 100644 index 0000000..cb043d1 --- /dev/null +++ b/app/views/layouts/application.html.erb @@ -0,0 +1,31 @@ + + + + <%= content_for(:title) || "Velour" %> + + + + + <%= csrf_meta_tags %> + <%= csp_meta_tag %> + + <%= yield :head %> + + <%# Enable PWA manifest for installable apps (make sure to enable in config/routes.rb too!) %> + <%#= tag.link rel: "manifest", href: pwa_manifest_path(format: :json) %> + + + + + + <%# Includes all stylesheet files in app/assets/stylesheets %> + <%= stylesheet_link_tag :app, "data-turbo-track": "reload" %> + <%= javascript_importmap_tags %> + + + +
+ <%= yield %> +
+ + diff --git a/app/views/layouts/mailer.html.erb b/app/views/layouts/mailer.html.erb new file mode 100644 index 0000000..3aac900 --- /dev/null +++ b/app/views/layouts/mailer.html.erb @@ -0,0 +1,13 @@ + + + + + + + + + <%= yield %> + + diff --git a/app/views/layouts/mailer.text.erb b/app/views/layouts/mailer.text.erb new file mode 100644 index 0000000..37f0bdd --- /dev/null +++ b/app/views/layouts/mailer.text.erb @@ -0,0 +1 @@ +<%= yield %> diff --git a/app/views/pwa/manifest.json.erb b/app/views/pwa/manifest.json.erb new file mode 100644 index 0000000..99761f7 --- /dev/null +++ b/app/views/pwa/manifest.json.erb @@ -0,0 +1,22 @@ +{ + "name": "Velour", + "icons": [ + { + "src": "/icon.png", + "type": "image/png", + "sizes": "512x512" + }, + { + "src": "/icon.png", + "type": "image/png", + "sizes": "512x512", + "purpose": "maskable" + } + ], + "start_url": "/", + "display": "standalone", + "scope": "/", + "description": "Velour.", + "theme_color": "red", + "background_color": "red" +} diff --git a/app/views/pwa/service-worker.js b/app/views/pwa/service-worker.js new file mode 100644 index 0000000..b3a13fb --- /dev/null +++ b/app/views/pwa/service-worker.js @@ -0,0 +1,26 @@ +// Add a service worker for processing Web Push notifications: +// +// self.addEventListener("push", async (event) => { +// const { title, options } = await event.data.json() +// event.waitUntil(self.registration.showNotification(title, options)) +// }) +// +// self.addEventListener("notificationclick", function(event) { +// event.notification.close() +// event.waitUntil( +// clients.matchAll({ type: "window" }).then((clientList) => { +// for (let i = 0; i < clientList.length; i++) { +// let client = clientList[i] +// let clientPath = (new URL(client.url)).pathname +// +// if (clientPath == event.notification.data.path && "focus" in client) { +// return client.focus() +// } +// } +// +// if (clients.openWindow) { +// return clients.openWindow(event.notification.data.path) +// } +// }) +// ) +// }) diff --git a/bin/brakeman b/bin/brakeman new file mode 100755 index 0000000..ace1c9b --- /dev/null +++ b/bin/brakeman @@ -0,0 +1,7 @@ +#!/usr/bin/env ruby +require "rubygems" +require "bundler/setup" + +ARGV.unshift("--ensure-latest") + +load Gem.bin_path("brakeman", "brakeman") diff --git a/bin/bundler-audit b/bin/bundler-audit new file mode 100755 index 0000000..e2ef226 --- /dev/null +++ b/bin/bundler-audit @@ -0,0 +1,6 @@ +#!/usr/bin/env ruby +require_relative "../config/boot" +require "bundler/audit/cli" + +ARGV.concat %w[ --config config/bundler-audit.yml ] if ARGV.empty? || ARGV.include?("check") +Bundler::Audit::CLI.start diff --git a/bin/ci b/bin/ci new file mode 100755 index 0000000..4137ad5 --- /dev/null +++ b/bin/ci @@ -0,0 +1,6 @@ +#!/usr/bin/env ruby +require_relative "../config/boot" +require "active_support/continuous_integration" + +CI = ActiveSupport::ContinuousIntegration +require_relative "../config/ci.rb" diff --git a/bin/dev b/bin/dev new file mode 100755 index 0000000..ad72c7d --- /dev/null +++ b/bin/dev @@ -0,0 +1,16 @@ +#!/usr/bin/env sh + +if ! gem list foreman -i --silent; then + echo "Installing foreman..." + gem install foreman +fi + +# Default to port 3000 if not specified +export PORT="${PORT:-3000}" + +# Let the debug gem allow remote connections, +# but avoid loading until `debugger` is called +export RUBY_DEBUG_OPEN="true" +export RUBY_DEBUG_LAZY="true" + +exec foreman start -f Procfile.dev "$@" diff --git a/bin/docker-entrypoint b/bin/docker-entrypoint new file mode 100755 index 0000000..ed31659 --- /dev/null +++ b/bin/docker-entrypoint @@ -0,0 +1,8 @@ +#!/bin/bash -e + +# If running the rails server then create or migrate existing database +if [ "${@: -2:1}" == "./bin/rails" ] && [ "${@: -1:1}" == "server" ]; then + ./bin/rails db:prepare +fi + +exec "${@}" diff --git a/bin/importmap b/bin/importmap new file mode 100755 index 0000000..36502ab --- /dev/null +++ b/bin/importmap @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby + +require_relative "../config/application" +require "importmap/commands" diff --git a/bin/jobs b/bin/jobs new file mode 100755 index 0000000..dcf59f3 --- /dev/null +++ b/bin/jobs @@ -0,0 +1,6 @@ +#!/usr/bin/env ruby + +require_relative "../config/environment" +require "solid_queue/cli" + +SolidQueue::Cli.start(ARGV) diff --git a/bin/kamal b/bin/kamal new file mode 100755 index 0000000..d9ba276 --- /dev/null +++ b/bin/kamal @@ -0,0 +1,16 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +# +# This file was generated by Bundler. +# +# The application 'kamal' is installed as part of a gem, and +# this file is here to facilitate running it. +# + +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__) + +require "rubygems" +require "bundler/setup" + +load Gem.bin_path("kamal", "kamal") diff --git a/bin/rails b/bin/rails new file mode 100755 index 0000000..efc0377 --- /dev/null +++ b/bin/rails @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby +APP_PATH = File.expand_path("../config/application", __dir__) +require_relative "../config/boot" +require "rails/commands" diff --git a/bin/rake b/bin/rake new file mode 100755 index 0000000..4fbf10b --- /dev/null +++ b/bin/rake @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby +require_relative "../config/boot" +require "rake" +Rake.application.run diff --git a/bin/rubocop b/bin/rubocop new file mode 100755 index 0000000..5a20504 --- /dev/null +++ b/bin/rubocop @@ -0,0 +1,8 @@ +#!/usr/bin/env ruby +require "rubygems" +require "bundler/setup" + +# Explicit RuboCop config increases performance slightly while avoiding config confusion. +ARGV.unshift("--config", File.expand_path("../.rubocop.yml", __dir__)) + +load Gem.bin_path("rubocop", "rubocop") diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..81be011 --- /dev/null +++ b/bin/setup @@ -0,0 +1,35 @@ +#!/usr/bin/env ruby +require "fileutils" + +APP_ROOT = File.expand_path("..", __dir__) + +def system!(*args) + system(*args, exception: true) +end + +FileUtils.chdir APP_ROOT do + # This script is a way to set up or update your development environment automatically. + # This script is idempotent, so that you can run it at any time and get an expectable outcome. + # Add necessary setup steps to this file. + + puts "== Installing dependencies ==" + system("bundle check") || system!("bundle install") + + # puts "\n== Copying sample files ==" + # unless File.exist?("config/database.yml") + # FileUtils.cp "config/database.yml.sample", "config/database.yml" + # end + + puts "\n== Preparing database ==" + system! "bin/rails db:prepare" + system! "bin/rails db:reset" if ARGV.include?("--reset") + + puts "\n== Removing old logs and tempfiles ==" + system! "bin/rails log:clear tmp:clear" + + unless ARGV.include?("--skip-server") + puts "\n== Starting development server ==" + STDOUT.flush # flush the output before exec(2) so that it displays + exec "bin/dev" + end +end diff --git a/bin/thrust b/bin/thrust new file mode 100755 index 0000000..36bde2d --- /dev/null +++ b/bin/thrust @@ -0,0 +1,5 @@ +#!/usr/bin/env ruby +require "rubygems" +require "bundler/setup" + +load Gem.bin_path("thruster", "thrust") diff --git a/config.ru b/config.ru new file mode 100644 index 0000000..4a3c09a --- /dev/null +++ b/config.ru @@ -0,0 +1,6 @@ +# This file is used by Rack-based servers to start the application. + +require_relative "config/environment" + +run Rails.application +Rails.application.load_server diff --git a/config/application.rb b/config/application.rb new file mode 100644 index 0000000..7bcd769 --- /dev/null +++ b/config/application.rb @@ -0,0 +1,27 @@ +require_relative "boot" + +require "rails/all" + +# Require the gems listed in Gemfile, including any gems +# you've limited to :test, :development, or :production. +Bundler.require(*Rails.groups) + +module Velour + class Application < Rails::Application + # Initialize configuration defaults for originally generated Rails version. + config.load_defaults 8.1 + + # Please, add to the `ignore` list any other `lib` subdirectories that do + # not contain `.rb` files, or that should not be reloaded or eager loaded. + # Common ones are `templates`, `generators`, or `middleware`, for example. + config.autoload_lib(ignore: %w[assets tasks]) + + # Configuration for the application, engines, and railties goes here. + # + # These settings can be overridden in specific environments using the files + # in config/environments, which are processed later. + # + # config.time_zone = "Central Time (US & Canada)" + # config.eager_load_paths << Rails.root.join("extras") + end +end diff --git a/config/boot.rb b/config/boot.rb new file mode 100644 index 0000000..988a5dd --- /dev/null +++ b/config/boot.rb @@ -0,0 +1,4 @@ +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__) + +require "bundler/setup" # Set up gems listed in the Gemfile. +require "bootsnap/setup" # Speed up boot time by caching expensive operations. diff --git a/config/bundler-audit.yml b/config/bundler-audit.yml new file mode 100644 index 0000000..e74b3af --- /dev/null +++ b/config/bundler-audit.yml @@ -0,0 +1,5 @@ +# Audit all gems listed in the Gemfile for known security problems by running bin/bundler-audit. +# CVEs that are not relevant to the application can be enumerated on the ignore list below. + +ignore: + - CVE-THAT-DOES-NOT-APPLY diff --git a/config/cable.yml b/config/cable.yml new file mode 100644 index 0000000..b9adc5a --- /dev/null +++ b/config/cable.yml @@ -0,0 +1,17 @@ +# Async adapter only works within the same process, so for manually triggering cable updates from a console, +# and seeing results in the browser, you must do so from the web console (running inside the dev process), +# not a terminal started via bin/rails console! Add "console" to any action or any ERB template view +# to make the web console appear. +development: + adapter: async + +test: + adapter: test + +production: + adapter: solid_cable + connects_to: + database: + writing: cable + polling_interval: 0.1.seconds + message_retention: 1.day diff --git a/config/cache.yml b/config/cache.yml new file mode 100644 index 0000000..19d4908 --- /dev/null +++ b/config/cache.yml @@ -0,0 +1,16 @@ +default: &default + store_options: + # Cap age of oldest cache entry to fulfill retention policies + # max_age: <%= 60.days.to_i %> + max_size: <%= 256.megabytes %> + namespace: <%= Rails.env %> + +development: + <<: *default + +test: + <<: *default + +production: + database: cache + <<: *default diff --git a/config/ci.rb b/config/ci.rb new file mode 100644 index 0000000..e56a92e --- /dev/null +++ b/config/ci.rb @@ -0,0 +1,23 @@ +# Run using bin/ci + +CI.run do + step "Setup", "bin/setup --skip-server" + + step "Style: Ruby", "bin/rubocop" + + step "Security: Gem audit", "bin/bundler-audit" + step "Security: Importmap vulnerability audit", "bin/importmap audit" + step "Security: Brakeman code analysis", "bin/brakeman --quiet --no-pager --exit-on-warn --exit-on-error" + + step "Tests: Rails", "bin/rails test" + step "Tests: System", "bin/rails test:system" + step "Tests: Seeds", "env RAILS_ENV=test bin/rails db:seed:replant" + + # Optional: set a green GitHub commit status to unblock PR merge. + # Requires the `gh` CLI and `gh extension install basecamp/gh-signoff`. + # if success? + # step "Signoff: All systems go. Ready for merge and deploy.", "gh signoff" + # else + # failure "Signoff: CI failed. Do not merge or deploy.", "Fix the issues and try again." + # end +end diff --git a/config/credentials.yml.enc b/config/credentials.yml.enc new file mode 100644 index 0000000..8da7007 --- /dev/null +++ b/config/credentials.yml.enc @@ -0,0 +1 @@ +zg1RCv110JnuFjNcbwmrZ7wMltnQQg9WLjf6o9WfmEwDNvi+kZl+AXwT5+rn9FPH97Oc4FqkJfw+QP0fgsqFXLscLaROVGE1p7+cK698PaJoOTISVpcaKFPm1cD6P2F9BOUkABcXHCXxv1jH72tlEIHL0SK0DFCNVXMc/WWSo+di1kkLEkxKBjiiD/nQDinH1vctkfM6DAnuENnqhGVesAgKJogBi/t8oziIBLHGH+0NpAim1oA264HAjv2UozwVmEdMFKxMHOaqsaZFO0s57bwlCk/uL1fUEItGl/RGPXU72qrwN3oiWds5wi4O/joThzX8ea8uW0/eqr53heALgq7dCIMOXA49Pqx4jaFPJOduNBsD6PJmRK79g3S9jlug30P7J0tijloa3vrjhaVipG2NB9kUP9TTRci4lV3c9ykQMCDwCzqbNbS0gFgXFJaeokQVDmM3fWvve/Gj6NIpgKd6kPZy2K5OdlMr/ziiwRShbfaeF75q1V9+--DfqAPvln9o/qQgNM--ecENWBndRLZaKlRAt2n9eQ== \ No newline at end of file diff --git a/config/database.yml b/config/database.yml new file mode 100644 index 0000000..1233d7a --- /dev/null +++ b/config/database.yml @@ -0,0 +1,54 @@ +# SQLite. Versions 3.8.0 and up are supported. +# gem install sqlite3 +# +# Ensure the SQLite 3 gem is defined in your Gemfile +# gem "sqlite3" +# +default: &default + adapter: sqlite3 + max_connections: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> + timeout: 5000 + +development: + primary: + <<: *default + database: storage/development.sqlite3 + cache: + <<: *default + database: storage/development_cache.sqlite3 + migrations_paths: db/cache_migrate + queue: + <<: *default + database: storage/development_queue.sqlite3 + migrations_paths: db/queue_migrate + cable: + <<: *default + database: storage/development_cable.sqlite3 + migrations_paths: db/cable_migrate + +# Warning: The database defined as "test" will be erased and +# re-generated from your development database when you run "rake". +# Do not set this db to the same as development or production. +test: + <<: *default + database: storage/test.sqlite3 + + +# Store production database in the storage/ directory, which by default +# is mounted as a persistent Docker volume in config/deploy.yml. +production: + primary: + <<: *default + database: storage/production.sqlite3 + cache: + <<: *default + database: storage/production_cache.sqlite3 + migrations_paths: db/cache_migrate + queue: + <<: *default + database: storage/production_queue.sqlite3 + migrations_paths: db/queue_migrate + cable: + <<: *default + database: storage/production_cable.sqlite3 + migrations_paths: db/cable_migrate diff --git a/config/deploy.yml b/config/deploy.yml new file mode 100644 index 0000000..8baf783 --- /dev/null +++ b/config/deploy.yml @@ -0,0 +1,120 @@ +# Name of your application. Used to uniquely configure containers. +service: velour + +# Name of the container image (use your-user/app-name on external registries). +image: velour + +# Deploy to these servers. +servers: + web: + - 192.168.0.1 + # job: + # hosts: + # - 192.168.0.1 + # cmd: bin/jobs + +# Enable SSL auto certification via Let's Encrypt and allow for multiple apps on a single web server. +# If used with Cloudflare, set encryption mode in SSL/TLS setting to "Full" to enable CF-to-app encryption. +# +# Using an SSL proxy like this requires turning on config.assume_ssl and config.force_ssl in production.rb! +# +# Don't use this when deploying to multiple web servers (then you have to terminate SSL at your load balancer). +# +# proxy: +# ssl: true +# host: app.example.com + +# Where you keep your container images. +registry: + # Alternatives: hub.docker.com / registry.digitalocean.com / ghcr.io / ... + server: localhost:5555 + + # Needed for authenticated registries. + # username: your-user + + # Always use an access token rather than real password when possible. + # password: + # - KAMAL_REGISTRY_PASSWORD + +# Inject ENV variables into containers (secrets come from .kamal/secrets). +env: + secret: + - RAILS_MASTER_KEY + clear: + # Run the Solid Queue Supervisor inside the web server's Puma process to do jobs. + # When you start using multiple servers, you should split out job processing to a dedicated machine. + SOLID_QUEUE_IN_PUMA: true + + # Set number of processes dedicated to Solid Queue (default: 1) + # JOB_CONCURRENCY: 3 + + # Set number of cores available to the application on each server (default: 1). + # WEB_CONCURRENCY: 2 + + # Match this to any external database server to configure Active Record correctly + # Use velour-db for a db accessory server on same machine via local kamal docker network. + # DB_HOST: 192.168.0.2 + + # Log everything from Rails + # RAILS_LOG_LEVEL: debug + +# Aliases are triggered with "bin/kamal ". You can overwrite arguments on invocation: +# "bin/kamal logs -r job" will tail logs from the first server in the job section. +aliases: + console: app exec --interactive --reuse "bin/rails console" + shell: app exec --interactive --reuse "bash" + logs: app logs -f + dbc: app exec --interactive --reuse "bin/rails dbconsole --include-password" + +# Use a persistent storage volume for sqlite database files and local Active Storage files. +# Recommended to change this to a mounted volume path that is backed up off server. +volumes: + - "velour_storage:/rails/storage" + +# Bridge fingerprinted assets, like JS and CSS, between versions to avoid +# hitting 404 on in-flight requests. Combines all files from new and old +# version inside the asset_path. +asset_path: /rails/public/assets + + +# Configure the image builder. +builder: + arch: amd64 + + # # Build image via remote server (useful for faster amd64 builds on arm64 computers) + # remote: ssh://docker@docker-builder-server + # + # # Pass arguments and secrets to the Docker build process + # args: + # RUBY_VERSION: 3.4.6 + # secrets: + # - GITHUB_TOKEN + # - RAILS_MASTER_KEY + +# Use a different ssh user than root +# ssh: +# user: app + +# Use accessory services (secrets come from .kamal/secrets). +# accessories: +# db: +# image: mysql:8.0 +# host: 192.168.0.2 +# # Change to 3306 to expose port to the world instead of just local network. +# port: "127.0.0.1:3306:3306" +# env: +# clear: +# MYSQL_ROOT_HOST: '%' +# secret: +# - MYSQL_ROOT_PASSWORD +# files: +# - config/mysql/production.cnf:/etc/mysql/my.cnf +# - db/production.sql:/docker-entrypoint-initdb.d/setup.sql +# directories: +# - data:/var/lib/mysql +# redis: +# image: valkey/valkey:8 +# host: 192.168.0.2 +# port: 6379 +# directories: +# - data:/data diff --git a/config/environment.rb b/config/environment.rb new file mode 100644 index 0000000..cac5315 --- /dev/null +++ b/config/environment.rb @@ -0,0 +1,5 @@ +# Load the Rails application. +require_relative "application" + +# Initialize the Rails application. +Rails.application.initialize! diff --git a/config/environments/development.rb b/config/environments/development.rb new file mode 100644 index 0000000..75243c3 --- /dev/null +++ b/config/environments/development.rb @@ -0,0 +1,78 @@ +require "active_support/core_ext/integer/time" + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # Make code changes take effect immediately without server restart. + config.enable_reloading = true + + # Do not eager load code on boot. + config.eager_load = false + + # Show full error reports. + config.consider_all_requests_local = true + + # Enable server timing. + config.server_timing = true + + # Enable/disable Action Controller caching. By default Action Controller caching is disabled. + # Run rails dev:cache to toggle Action Controller caching. + if Rails.root.join("tmp/caching-dev.txt").exist? + config.action_controller.perform_caching = true + config.action_controller.enable_fragment_cache_logging = true + config.public_file_server.headers = { "cache-control" => "public, max-age=#{2.days.to_i}" } + else + config.action_controller.perform_caching = false + end + + # Change to :null_store to avoid any caching. + config.cache_store = :memory_store + + # Store uploaded files on the local file system (see config/storage.yml for options). + config.active_storage.service = :local + + # Don't care if the mailer can't send. + config.action_mailer.raise_delivery_errors = false + + # Make template changes take effect immediately. + config.action_mailer.perform_caching = false + + # Set localhost to be used by links generated in mailer templates. + config.action_mailer.default_url_options = { host: "localhost", port: 3000 } + + # Print deprecation notices to the Rails logger. + config.active_support.deprecation = :log + + # Raise an error on page load if there are pending migrations. + config.active_record.migration_error = :page_load + + # Highlight code that triggered database queries in logs. + config.active_record.verbose_query_logs = true + + # Append comments with runtime information tags to SQL queries in logs. + config.active_record.query_log_tags_enabled = true + + # Highlight code that enqueued background job in logs. + config.active_job.verbose_enqueue_logs = true + + # Highlight code that triggered redirect in logs. + config.action_dispatch.verbose_redirect_logs = true + + # Suppress logger output for asset requests. + config.assets.quiet = true + + # Raises error for missing translations. + # config.i18n.raise_on_missing_translations = true + + # Annotate rendered view with file names. + config.action_view.annotate_rendered_view_with_filenames = true + + # Uncomment if you wish to allow Action Cable access from any origin. + # config.action_cable.disable_request_forgery_protection = true + + # Raise error when a before_action's only/except options reference missing actions. + config.action_controller.raise_on_missing_callback_actions = true + + # Apply autocorrection by RuboCop to files generated by `bin/rails generate`. + # config.generators.apply_rubocop_autocorrect_after_generate! +end diff --git a/config/environments/production.rb b/config/environments/production.rb new file mode 100644 index 0000000..f5763e0 --- /dev/null +++ b/config/environments/production.rb @@ -0,0 +1,90 @@ +require "active_support/core_ext/integer/time" + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # Code is not reloaded between requests. + config.enable_reloading = false + + # Eager load code on boot for better performance and memory savings (ignored by Rake tasks). + config.eager_load = true + + # Full error reports are disabled. + config.consider_all_requests_local = false + + # Turn on fragment caching in view templates. + config.action_controller.perform_caching = true + + # Cache assets for far-future expiry since they are all digest stamped. + config.public_file_server.headers = { "cache-control" => "public, max-age=#{1.year.to_i}" } + + # Enable serving of images, stylesheets, and JavaScripts from an asset server. + # config.asset_host = "http://assets.example.com" + + # Store uploaded files on the local file system (see config/storage.yml for options). + config.active_storage.service = :local + + # Assume all access to the app is happening through a SSL-terminating reverse proxy. + # config.assume_ssl = true + + # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. + # config.force_ssl = true + + # Skip http-to-https redirect for the default health check endpoint. + # config.ssl_options = { redirect: { exclude: ->(request) { request.path == "/up" } } } + + # Log to STDOUT with the current request id as a default log tag. + config.log_tags = [ :request_id ] + config.logger = ActiveSupport::TaggedLogging.logger(STDOUT) + + # Change to "debug" to log everything (including potentially personally-identifiable information!). + config.log_level = ENV.fetch("RAILS_LOG_LEVEL", "info") + + # Prevent health checks from clogging up the logs. + config.silence_healthcheck_path = "/up" + + # Don't log any deprecations. + config.active_support.report_deprecations = false + + # Replace the default in-process memory cache store with a durable alternative. + config.cache_store = :solid_cache_store + + # Replace the default in-process and non-durable queuing backend for Active Job. + config.active_job.queue_adapter = :solid_queue + config.solid_queue.connects_to = { database: { writing: :queue } } + + # Ignore bad email addresses and do not raise email delivery errors. + # Set this to true and configure the email server for immediate delivery to raise delivery errors. + # config.action_mailer.raise_delivery_errors = false + + # Set host to be used by links generated in mailer templates. + config.action_mailer.default_url_options = { host: "example.com" } + + # Specify outgoing SMTP server. Remember to add smtp/* credentials via bin/rails credentials:edit. + # config.action_mailer.smtp_settings = { + # user_name: Rails.application.credentials.dig(:smtp, :user_name), + # password: Rails.application.credentials.dig(:smtp, :password), + # address: "smtp.example.com", + # port: 587, + # authentication: :plain + # } + + # Enable locale fallbacks for I18n (makes lookups for any locale fall back to + # the I18n.default_locale when a translation cannot be found). + config.i18n.fallbacks = true + + # Do not dump schema after migrations. + config.active_record.dump_schema_after_migration = false + + # Only use :id for inspections in production. + config.active_record.attributes_for_inspect = [ :id ] + + # Enable DNS rebinding protection and other `Host` header attacks. + # config.hosts = [ + # "example.com", # Allow requests from example.com + # /.*\.example\.com/ # Allow requests from subdomains like `www.example.com` + # ] + # + # Skip DNS rebinding protection for the default health check endpoint. + # config.host_authorization = { exclude: ->(request) { request.path == "/up" } } +end diff --git a/config/environments/test.rb b/config/environments/test.rb new file mode 100644 index 0000000..c2095b1 --- /dev/null +++ b/config/environments/test.rb @@ -0,0 +1,53 @@ +# The test environment is used exclusively to run your application's +# test suite. You never need to work with it otherwise. Remember that +# your test database is "scratch space" for the test suite and is wiped +# and recreated between test runs. Don't rely on the data there! + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # While tests run files are not watched, reloading is not necessary. + config.enable_reloading = false + + # Eager loading loads your entire application. When running a single test locally, + # this is usually not necessary, and can slow down your test suite. However, it's + # recommended that you enable it in continuous integration systems to ensure eager + # loading is working properly before deploying your code. + config.eager_load = ENV["CI"].present? + + # Configure public file server for tests with cache-control for performance. + config.public_file_server.headers = { "cache-control" => "public, max-age=3600" } + + # Show full error reports. + config.consider_all_requests_local = true + config.cache_store = :null_store + + # Render exception templates for rescuable exceptions and raise for other exceptions. + config.action_dispatch.show_exceptions = :rescuable + + # Disable request forgery protection in test environment. + config.action_controller.allow_forgery_protection = false + + # Store uploaded files on the local file system in a temporary directory. + config.active_storage.service = :test + + # Tell Action Mailer not to deliver emails to the real world. + # The :test delivery method accumulates sent emails in the + # ActionMailer::Base.deliveries array. + config.action_mailer.delivery_method = :test + + # Set host to be used by links generated in mailer templates. + config.action_mailer.default_url_options = { host: "example.com" } + + # Print deprecation notices to the stderr. + config.active_support.deprecation = :stderr + + # Raises error for missing translations. + # config.i18n.raise_on_missing_translations = true + + # Annotate rendered view with file names. + # config.action_view.annotate_rendered_view_with_filenames = true + + # Raise error when a before_action's only/except options reference missing actions. + config.action_controller.raise_on_missing_callback_actions = true +end diff --git a/config/importmap.rb b/config/importmap.rb new file mode 100644 index 0000000..909dfc5 --- /dev/null +++ b/config/importmap.rb @@ -0,0 +1,7 @@ +# Pin npm packages by running ./bin/importmap + +pin "application" +pin "@hotwired/turbo-rails", to: "turbo.min.js" +pin "@hotwired/stimulus", to: "stimulus.min.js" +pin "@hotwired/stimulus-loading", to: "stimulus-loading.js" +pin_all_from "app/javascript/controllers", under: "controllers" diff --git a/config/initializers/assets.rb b/config/initializers/assets.rb new file mode 100644 index 0000000..4873244 --- /dev/null +++ b/config/initializers/assets.rb @@ -0,0 +1,7 @@ +# Be sure to restart your server when you modify this file. + +# Version of your assets, change this if you want to expire all your assets. +Rails.application.config.assets.version = "1.0" + +# Add additional assets to the asset load path. +# Rails.application.config.assets.paths << Emoji.images_path diff --git a/config/initializers/content_security_policy.rb b/config/initializers/content_security_policy.rb new file mode 100644 index 0000000..d51d713 --- /dev/null +++ b/config/initializers/content_security_policy.rb @@ -0,0 +1,29 @@ +# Be sure to restart your server when you modify this file. + +# Define an application-wide content security policy. +# See the Securing Rails Applications Guide for more information: +# https://guides.rubyonrails.org/security.html#content-security-policy-header + +# Rails.application.configure do +# config.content_security_policy do |policy| +# policy.default_src :self, :https +# policy.font_src :self, :https, :data +# policy.img_src :self, :https, :data +# policy.object_src :none +# policy.script_src :self, :https +# policy.style_src :self, :https +# # Specify URI for violation reports +# # policy.report_uri "/csp-violation-report-endpoint" +# end +# +# # Generate session nonces for permitted importmap, inline scripts, and inline styles. +# config.content_security_policy_nonce_generator = ->(request) { request.session.id.to_s } +# config.content_security_policy_nonce_directives = %w(script-src style-src) +# +# # Automatically add `nonce` to `javascript_tag`, `javascript_include_tag`, and `stylesheet_link_tag` +# # if the corresponding directives are specified in `content_security_policy_nonce_directives`. +# # config.content_security_policy_nonce_auto = true +# +# # Report violations without enforcing the policy. +# # config.content_security_policy_report_only = true +# end diff --git a/config/initializers/filter_parameter_logging.rb b/config/initializers/filter_parameter_logging.rb new file mode 100644 index 0000000..c0b717f --- /dev/null +++ b/config/initializers/filter_parameter_logging.rb @@ -0,0 +1,8 @@ +# Be sure to restart your server when you modify this file. + +# Configure parameters to be partially matched (e.g. passw matches password) and filtered from the log file. +# Use this to limit dissemination of sensitive information. +# See the ActiveSupport::ParameterFilter documentation for supported notations and behaviors. +Rails.application.config.filter_parameters += [ + :passw, :email, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn, :cvv, :cvc +] diff --git a/config/initializers/inflections.rb b/config/initializers/inflections.rb new file mode 100644 index 0000000..3860f65 --- /dev/null +++ b/config/initializers/inflections.rb @@ -0,0 +1,16 @@ +# Be sure to restart your server when you modify this file. + +# Add new inflection rules using the following format. Inflections +# are locale specific, and you may define rules for as many different +# locales as you wish. All of these examples are active by default: +# ActiveSupport::Inflector.inflections(:en) do |inflect| +# inflect.plural /^(ox)$/i, "\\1en" +# inflect.singular /^(ox)en/i, "\\1" +# inflect.irregular "person", "people" +# inflect.uncountable %w( fish sheep ) +# end + +# These inflection rules are supported but not enabled by default: +# ActiveSupport::Inflector.inflections(:en) do |inflect| +# inflect.acronym "RESTful" +# end diff --git a/config/locales/en.yml b/config/locales/en.yml new file mode 100644 index 0000000..6c349ae --- /dev/null +++ b/config/locales/en.yml @@ -0,0 +1,31 @@ +# Files in the config/locales directory are used for internationalization and +# are automatically loaded by Rails. If you want to use locales other than +# English, add the necessary files in this directory. +# +# To use the locales, use `I18n.t`: +# +# I18n.t "hello" +# +# In views, this is aliased to just `t`: +# +# <%= t("hello") %> +# +# To use a different locale, set it with `I18n.locale`: +# +# I18n.locale = :es +# +# This would use the information in config/locales/es.yml. +# +# To learn more about the API, please read the Rails Internationalization guide +# at https://guides.rubyonrails.org/i18n.html. +# +# Be aware that YAML interprets the following case-insensitive strings as +# booleans: `true`, `false`, `on`, `off`, `yes`, `no`. Therefore, these strings +# must be quoted to be interpreted as strings. For example: +# +# en: +# "yes": yup +# enabled: "ON" + +en: + hello: "Hello world" diff --git a/config/puma.rb b/config/puma.rb new file mode 100644 index 0000000..38c4b86 --- /dev/null +++ b/config/puma.rb @@ -0,0 +1,42 @@ +# This configuration file will be evaluated by Puma. The top-level methods that +# are invoked here are part of Puma's configuration DSL. For more information +# about methods provided by the DSL, see https://puma.io/puma/Puma/DSL.html. +# +# Puma starts a configurable number of processes (workers) and each process +# serves each request in a thread from an internal thread pool. +# +# You can control the number of workers using ENV["WEB_CONCURRENCY"]. You +# should only set this value when you want to run 2 or more workers. The +# default is already 1. You can set it to `auto` to automatically start a worker +# for each available processor. +# +# The ideal number of threads per worker depends both on how much time the +# application spends waiting for IO operations and on how much you wish to +# prioritize throughput over latency. +# +# As a rule of thumb, increasing the number of threads will increase how much +# traffic a given process can handle (throughput), but due to CRuby's +# Global VM Lock (GVL) it has diminishing returns and will degrade the +# response time (latency) of the application. +# +# The default is set to 3 threads as it's deemed a decent compromise between +# throughput and latency for the average Rails application. +# +# Any libraries that use a connection pool or another resource pool should +# be configured to provide at least as many connections as the number of +# threads. This includes Active Record's `pool` parameter in `database.yml`. +threads_count = ENV.fetch("RAILS_MAX_THREADS", 3) +threads threads_count, threads_count + +# Specifies the `port` that Puma will listen on to receive requests; default is 3000. +port ENV.fetch("PORT", 3000) + +# Allow puma to be restarted by `bin/rails restart` command. +plugin :tmp_restart + +# Run the Solid Queue supervisor inside of Puma for single-server deployments. +plugin :solid_queue if ENV["SOLID_QUEUE_IN_PUMA"] + +# Specify the PID file. Defaults to tmp/pids/server.pid in development. +# In other environments, only set the PID file if requested. +pidfile ENV["PIDFILE"] if ENV["PIDFILE"] diff --git a/config/queue.yml b/config/queue.yml new file mode 100644 index 0000000..9eace59 --- /dev/null +++ b/config/queue.yml @@ -0,0 +1,18 @@ +default: &default + dispatchers: + - polling_interval: 1 + batch_size: 500 + workers: + - queues: "*" + threads: 3 + processes: <%= ENV.fetch("JOB_CONCURRENCY", 1) %> + polling_interval: 0.1 + +development: + <<: *default + +test: + <<: *default + +production: + <<: *default diff --git a/config/recurring.yml b/config/recurring.yml new file mode 100644 index 0000000..b4207f9 --- /dev/null +++ b/config/recurring.yml @@ -0,0 +1,15 @@ +# examples: +# periodic_cleanup: +# class: CleanSoftDeletedRecordsJob +# queue: background +# args: [ 1000, { batch_size: 500 } ] +# schedule: every hour +# periodic_cleanup_with_command: +# command: "SoftDeletedRecord.due.delete_all" +# priority: 2 +# schedule: at 5am every day + +production: + clear_solid_queue_finished_jobs: + command: "SolidQueue::Job.clear_finished_in_batches(sleep_between_batches: 0.3)" + schedule: every hour at minute 12 diff --git a/config/routes.rb b/config/routes.rb new file mode 100644 index 0000000..48254e8 --- /dev/null +++ b/config/routes.rb @@ -0,0 +1,14 @@ +Rails.application.routes.draw do + # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html + + # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500. + # Can be used by load balancers and uptime monitors to verify that the app is live. + get "up" => "rails/health#show", as: :rails_health_check + + # Render dynamic PWA files from app/views/pwa/* (remember to link manifest in application.html.erb) + # get "manifest" => "rails/pwa#manifest", as: :pwa_manifest + # get "service-worker" => "rails/pwa#service_worker", as: :pwa_service_worker + + # Defines the root path route ("/") + # root "posts#index" +end diff --git a/config/storage.yml b/config/storage.yml new file mode 100644 index 0000000..927dc53 --- /dev/null +++ b/config/storage.yml @@ -0,0 +1,27 @@ +test: + service: Disk + root: <%= Rails.root.join("tmp/storage") %> + +local: + service: Disk + root: <%= Rails.root.join("storage") %> + +# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key) +# amazon: +# service: S3 +# access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %> +# secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %> +# region: us-east-1 +# bucket: your_own_bucket-<%= Rails.env %> + +# Remember not to checkin your GCS keyfile to a repository +# google: +# service: GCS +# project: your_project +# credentials: <%= Rails.root.join("path/to/gcs.keyfile") %> +# bucket: your_own_bucket-<%= Rails.env %> + +# mirror: +# service: Mirror +# primary: local +# mirrors: [ amazon, google, microsoft ] diff --git a/db/cable_schema.rb b/db/cable_schema.rb new file mode 100644 index 0000000..3aefc38 --- /dev/null +++ b/db/cable_schema.rb @@ -0,0 +1,23 @@ +# This file is auto-generated from the current state of the database. Instead +# of editing this file, please use the migrations feature of Active Record to +# incrementally modify your database, and then regenerate this schema definition. +# +# This file is the source Rails uses to define your schema when running `bin/rails +# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to +# be faster and is potentially less error prone than running all of your +# migrations from scratch. Old migrations may fail to apply correctly if those +# migrations use external dependencies or application code. +# +# It's strongly recommended that you check this file into your version control system. + +ActiveRecord::Schema[8.1].define(version: 1) do + create_table "solid_cable_messages", force: :cascade do |t| + t.binary "channel", limit: 1024, null: false + t.integer "channel_hash", limit: 8, null: false + t.datetime "created_at", null: false + t.binary "payload", limit: 536870912, null: false + t.index ["channel"], name: "index_solid_cable_messages_on_channel" + t.index ["channel_hash"], name: "index_solid_cable_messages_on_channel_hash" + t.index ["created_at"], name: "index_solid_cable_messages_on_created_at" + end +end diff --git a/db/cache_schema.rb b/db/cache_schema.rb new file mode 100644 index 0000000..2016467 --- /dev/null +++ b/db/cache_schema.rb @@ -0,0 +1,24 @@ +# This file is auto-generated from the current state of the database. Instead +# of editing this file, please use the migrations feature of Active Record to +# incrementally modify your database, and then regenerate this schema definition. +# +# This file is the source Rails uses to define your schema when running `bin/rails +# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to +# be faster and is potentially less error prone than running all of your +# migrations from scratch. Old migrations may fail to apply correctly if those +# migrations use external dependencies or application code. +# +# It's strongly recommended that you check this file into your version control system. + +ActiveRecord::Schema[8.1].define(version: 1) do + create_table "solid_cache_entries", force: :cascade do |t| + t.integer "byte_size", limit: 4, null: false + t.datetime "created_at", null: false + t.binary "key", limit: 1024, null: false + t.integer "key_hash", limit: 8, null: false + t.binary "value", limit: 536870912, null: false + t.index ["byte_size"], name: "index_solid_cache_entries_on_byte_size" + t.index ["key_hash", "byte_size"], name: "index_solid_cache_entries_on_key_hash_and_byte_size" + t.index ["key_hash"], name: "index_solid_cache_entries_on_key_hash", unique: true + end +end diff --git a/db/queue_schema.rb b/db/queue_schema.rb new file mode 100644 index 0000000..f56798c --- /dev/null +++ b/db/queue_schema.rb @@ -0,0 +1,141 @@ +# This file is auto-generated from the current state of the database. Instead +# of editing this file, please use the migrations feature of Active Record to +# incrementally modify your database, and then regenerate this schema definition. +# +# This file is the source Rails uses to define your schema when running `bin/rails +# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to +# be faster and is potentially less error prone than running all of your +# migrations from scratch. Old migrations may fail to apply correctly if those +# migrations use external dependencies or application code. +# +# It's strongly recommended that you check this file into your version control system. + +ActiveRecord::Schema[8.1].define(version: 1) do + create_table "solid_queue_blocked_executions", force: :cascade do |t| + t.string "concurrency_key", null: false + t.datetime "created_at", null: false + t.datetime "expires_at", null: false + t.bigint "job_id", null: false + t.integer "priority", default: 0, null: false + t.string "queue_name", null: false + t.index ["concurrency_key", "priority", "job_id"], name: "index_solid_queue_blocked_executions_for_release" + t.index ["expires_at", "concurrency_key"], name: "index_solid_queue_blocked_executions_for_maintenance" + t.index ["job_id"], name: "index_solid_queue_blocked_executions_on_job_id", unique: true + end + + create_table "solid_queue_claimed_executions", force: :cascade do |t| + t.datetime "created_at", null: false + t.bigint "job_id", null: false + t.bigint "process_id" + t.index ["job_id"], name: "index_solid_queue_claimed_executions_on_job_id", unique: true + t.index ["process_id", "job_id"], name: "index_solid_queue_claimed_executions_on_process_id_and_job_id" + end + + create_table "solid_queue_failed_executions", force: :cascade do |t| + t.datetime "created_at", null: false + t.text "error" + t.bigint "job_id", null: false + t.index ["job_id"], name: "index_solid_queue_failed_executions_on_job_id", unique: true + end + + create_table "solid_queue_jobs", force: :cascade do |t| + t.string "active_job_id" + t.text "arguments" + t.string "class_name", null: false + t.string "concurrency_key" + t.datetime "created_at", null: false + t.datetime "finished_at" + t.integer "priority", default: 0, null: false + t.string "queue_name", null: false + t.datetime "scheduled_at" + t.datetime "updated_at", null: false + t.index ["active_job_id"], name: "index_solid_queue_jobs_on_active_job_id" + t.index ["class_name"], name: "index_solid_queue_jobs_on_class_name" + t.index ["finished_at"], name: "index_solid_queue_jobs_on_finished_at" + t.index ["queue_name", "finished_at"], name: "index_solid_queue_jobs_for_filtering" + t.index ["scheduled_at", "finished_at"], name: "index_solid_queue_jobs_for_alerting" + end + + create_table "solid_queue_pauses", force: :cascade do |t| + t.datetime "created_at", null: false + t.string "queue_name", null: false + t.index ["queue_name"], name: "index_solid_queue_pauses_on_queue_name", unique: true + end + + create_table "solid_queue_processes", force: :cascade do |t| + t.datetime "created_at", null: false + t.string "hostname" + t.string "kind", null: false + t.datetime "last_heartbeat_at", null: false + t.text "metadata" + t.string "name", null: false + t.integer "pid", null: false + t.bigint "supervisor_id" + t.index ["last_heartbeat_at"], name: "index_solid_queue_processes_on_last_heartbeat_at" + t.index ["name", "supervisor_id"], name: "index_solid_queue_processes_on_name_and_supervisor_id", unique: true + t.index ["supervisor_id"], name: "index_solid_queue_processes_on_supervisor_id" + end + + create_table "solid_queue_ready_executions", force: :cascade do |t| + t.datetime "created_at", null: false + t.bigint "job_id", null: false + t.integer "priority", default: 0, null: false + t.string "queue_name", null: false + t.index ["job_id"], name: "index_solid_queue_ready_executions_on_job_id", unique: true + t.index ["priority", "job_id"], name: "index_solid_queue_poll_all" + t.index ["queue_name", "priority", "job_id"], name: "index_solid_queue_poll_by_queue" + end + + create_table "solid_queue_recurring_executions", force: :cascade do |t| + t.datetime "created_at", null: false + t.bigint "job_id", null: false + t.datetime "run_at", null: false + t.string "task_key", null: false + t.index ["job_id"], name: "index_solid_queue_recurring_executions_on_job_id", unique: true + t.index ["task_key", "run_at"], name: "index_solid_queue_recurring_executions_on_task_key_and_run_at", unique: true + end + + create_table "solid_queue_recurring_tasks", force: :cascade do |t| + t.text "arguments" + t.string "class_name" + t.string "command", limit: 2048 + t.datetime "created_at", null: false + t.text "description" + t.string "key", null: false + t.integer "priority", default: 0 + t.string "queue_name" + t.string "schedule", null: false + t.boolean "static", default: true, null: false + t.datetime "updated_at", null: false + t.index ["key"], name: "index_solid_queue_recurring_tasks_on_key", unique: true + t.index ["static"], name: "index_solid_queue_recurring_tasks_on_static" + end + + create_table "solid_queue_scheduled_executions", force: :cascade do |t| + t.datetime "created_at", null: false + t.bigint "job_id", null: false + t.integer "priority", default: 0, null: false + t.string "queue_name", null: false + t.datetime "scheduled_at", null: false + t.index ["job_id"], name: "index_solid_queue_scheduled_executions_on_job_id", unique: true + t.index ["scheduled_at", "priority", "job_id"], name: "index_solid_queue_dispatch_all" + end + + create_table "solid_queue_semaphores", force: :cascade do |t| + t.datetime "created_at", null: false + t.datetime "expires_at", null: false + t.string "key", null: false + t.datetime "updated_at", null: false + t.integer "value", default: 1, null: false + t.index ["expires_at"], name: "index_solid_queue_semaphores_on_expires_at" + t.index ["key", "value"], name: "index_solid_queue_semaphores_on_key_and_value" + t.index ["key"], name: "index_solid_queue_semaphores_on_key", unique: true + end + + add_foreign_key "solid_queue_blocked_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade + add_foreign_key "solid_queue_claimed_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade + add_foreign_key "solid_queue_failed_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade + add_foreign_key "solid_queue_ready_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade + add_foreign_key "solid_queue_recurring_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade + add_foreign_key "solid_queue_scheduled_executions", "solid_queue_jobs", column: "job_id", on_delete: :cascade +end diff --git a/db/schema.rb b/db/schema.rb new file mode 100644 index 0000000..03e7368 --- /dev/null +++ b/db/schema.rb @@ -0,0 +1,14 @@ +# This file is auto-generated from the current state of the database. Instead +# of editing this file, please use the migrations feature of Active Record to +# incrementally modify your database, and then regenerate this schema definition. +# +# This file is the source Rails uses to define your schema when running `bin/rails +# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to +# be faster and is potentially less error prone than running all of your +# migrations from scratch. Old migrations may fail to apply correctly if those +# migrations use external dependencies or application code. +# +# It's strongly recommended that you check this file into your version control system. + +ActiveRecord::Schema[8.1].define(version: 0) do +end diff --git a/db/seeds.rb b/db/seeds.rb new file mode 100644 index 0000000..4fbd6ed --- /dev/null +++ b/db/seeds.rb @@ -0,0 +1,9 @@ +# This file should ensure the existence of records required to run the application in every environment (production, +# development, test). The code here should be idempotent so that it can be executed at any point in every environment. +# The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup). +# +# Example: +# +# ["Action", "Comedy", "Drama", "Horror"].each do |genre_name| +# MovieGenre.find_or_create_by!(name: genre_name) +# end diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 0000000..0745116 --- /dev/null +++ b/docs/architecture.md @@ -0,0 +1,2803 @@ +# Velour - Video Library Application Architecture Plan + +## Technology Stack + +### Backend +- **Framework:** Ruby on Rails 8.x +- **Database:** SQLite3 (with potential migration path to PostgreSQL later) +- **Background Jobs:** Solid Queue (Rails 8 default) +- **Caching:** Solid Cache (Rails 8 default) +- **File Storage:** + - Active Storage (thumbnails/sprites/previews only) + - Direct filesystem paths for video files + - S3 SDK (aws-sdk-s3 gem) for remote video storage +- **Video Processing:** FFmpeg via streamio-ffmpeg gem + +### Frontend +- **Framework:** Hotwire (Turbo + Stimulus) +- **Video Player:** Video.js 8.x with custom plugins +- **Asset Pipeline:** Importmap-rails or esbuild +- **Styling:** TailwindCSS + +### Authentication (Phase 2) +- **OIDC:** omniauth-openid-connect gem +- **Session Management:** Rails sessions with encrypted cookies + +--- + +## Database Schema + +### Core Models + +**Works** (canonical representation) +- Represents the conceptual "work" (e.g., "Batman [1989]") +- Has many Videos (different versions/qualities) +```ruby +- title (string, required) +- year (integer) +- director (string) +- description (text) +- rating (decimal) +- organized (boolean, default: false) +- poster_path (string) +- backdrop_path (string) +- metadata (jsonb) +``` + +**Videos** (instances of works) +- Physical video files across all sources +- Belongs to a Work +```ruby +- work_id (references works) +- storage_location_id (references storage_locations) +- title (string) +- file_path (string, required) # relative path or S3 key +- file_hash (string, indexed) +- file_size (bigint) +- duration (float) +- width (integer) +- height (integer) +- resolution_label (string) +- video_codec (string) +- audio_codec (string) +- bit_rate (integer) +- frame_rate (float) +- format (string) +- has_subtitles (boolean) +- version_type (string) +- source_type (string) # "local", "s3", "jellyfin", "web", "velour" +- source_url (string) # full URL for remote sources +- imported (boolean, default: false) # copied to writable storage? +- metadata (jsonb) +``` + +**StorageLocations** +- All video sources (readable and writable) +```ruby +- name (string, required) +- path (string) # local path or S3 bucket name +- location_type (string) # "local", "s3", "jellyfin", "web", "velour" +- writable (boolean, default: false) # can we import videos here? +- enabled (boolean, default: true) +- scan_subdirectories (boolean, default: true) +- priority (integer, default: 0) # for unified view ordering +- settings (jsonb) # config per type: + # S3: {region, access_key_id, secret_access_key, endpoint} + # JellyFin: {api_url, api_key, user_id} + # Web: {base_url, username, password, auth_type} + # Velour: {api_url, api_key} +- last_scanned_at (datetime) +``` + +**VideoAssets** +- Generated assets (stored via Active Storage) +```ruby +- video_id (references videos) +- asset_type (string) # "thumbnail", "preview", "sprite", "vtt" +- metadata (jsonb) +# Active Storage attachments +``` + +**PlaybackSessions** +```ruby +- video_id (references videos) +- user_id (references users, nullable) +- position (float) +- duration_watched (float) +- last_watched_at (datetime) +- completed (boolean) +- play_count (integer, default: 0) +``` + +**ImportJobs** (Phase 3) +- Track video imports from remote sources +```ruby +- video_id (references videos) # source video +- destination_location_id (references storage_locations) +- destination_path (string) +- status (string) # "pending", "downloading", "completed", "failed" +- progress (float) # 0-100% +- bytes_transferred (bigint) +- error_message (text) +- started_at (datetime) +- completed_at (datetime) +``` + +**Users** (Phase 2) +```ruby +- email (string, required, unique) +- name (string) +- role (integer, default: 0) # enum: member, admin +- provider (string) +- uid (string) +``` + +### Database Schema Implementation Notes + +**SQLite Limitations:** +- SQLite does NOT support `jsonb` type - must use `text` with `serialize :metadata, coder: JSON` +- SQLite does NOT support `enum` types - use integers with Rails enums +- Consider PostgreSQL migration path for production deployments + +**Rails Migration Best Practices:** + +```ruby +# db/migrate/20240101000001_create_works.rb +class CreateWorks < ActiveRecord::Migration[8.1] + def change + create_table :works do |t| + t.string :title, null: false + t.integer :year + t.string :director + t.text :description + t.decimal :rating, precision: 3, scale: 1 + t.boolean :organized, default: false, null: false + t.string :poster_path + t.string :backdrop_path + t.text :metadata # SQLite: use text, serialize in model + + t.timestamps + end + + add_index :works, :title + add_index :works, [:title, :year], unique: true + add_index :works, :organized + end +end + +# db/migrate/20240101000002_create_storage_locations.rb +class CreateStorageLocations < ActiveRecord::Migration[8.1] + def change + create_table :storage_locations do |t| + t.string :name, null: false + t.string :path + t.integer :location_type, null: false, default: 0 # enum + t.boolean :writable, default: false, null: false + t.boolean :enabled, default: true, null: false + t.boolean :scan_subdirectories, default: true, null: false + t.integer :priority, default: 0, null: false + t.text :settings # SQLite: encrypted text column + t.datetime :last_scanned_at + + t.timestamps + end + + add_index :storage_locations, :name, unique: true + add_index :storage_locations, :location_type + add_index :storage_locations, :enabled + add_index :storage_locations, :priority + end +end + +# db/migrate/20240101000003_create_videos.rb +class CreateVideos < ActiveRecord::Migration[8.1] + def change + create_table :videos do |t| + t.references :work, null: true, foreign_key: true, index: true + t.references :storage_location, null: false, foreign_key: true, index: true + t.string :title + t.string :file_path, null: false + t.string :file_hash, index: true + t.bigint :file_size + t.float :duration + t.integer :width + t.integer :height + t.string :resolution_label + t.string :video_codec + t.string :audio_codec + t.integer :bit_rate + t.float :frame_rate + t.string :format + t.boolean :has_subtitles, default: false + t.string :version_type + t.integer :source_type, null: false, default: 0 # enum + t.string :source_url + t.boolean :imported, default: false, null: false + t.boolean :processing_failed, default: false + t.text :error_message + t.text :metadata + + t.timestamps + end + + add_index :videos, [:storage_location_id, :file_path], unique: true + add_index :videos, :source_type + add_index :videos, :file_hash + add_index :videos, :imported + add_index :videos, [:work_id, :resolution_label] + end +end + +# db/migrate/20240101000004_create_video_assets.rb +class CreateVideoAssets < ActiveRecord::Migration[8.1] + def change + create_table :video_assets do |t| + t.references :video, null: false, foreign_key: true, index: true + t.integer :asset_type, null: false # enum + t.text :metadata + + t.timestamps + end + + add_index :video_assets, [:video_id, :asset_type], unique: true + end +end + +# db/migrate/20240101000005_create_playback_sessions.rb +class CreatePlaybackSessions < ActiveRecord::Migration[8.1] + def change + create_table :playback_sessions do |t| + t.references :video, null: false, foreign_key: true, index: true + t.references :user, null: true, foreign_key: true, index: true + t.float :position, default: 0.0 + t.float :duration_watched, default: 0.0 + t.datetime :last_watched_at + t.boolean :completed, default: false, null: false + t.integer :play_count, default: 0, null: false + + t.timestamps + end + + add_index :playback_sessions, [:video_id, :user_id], unique: true + add_index :playback_sessions, :last_watched_at + end +end + +# db/migrate/20240101000006_create_import_jobs.rb +class CreateImportJobs < ActiveRecord::Migration[8.1] + def change + create_table :import_jobs do |t| + t.references :video, null: false, foreign_key: true, index: true + t.references :destination_location, null: false, foreign_key: { to_table: :storage_locations } + t.string :destination_path + t.integer :status, null: false, default: 0 # enum + t.float :progress, default: 0.0 + t.bigint :bytes_transferred, default: 0 + t.text :error_message + t.datetime :started_at + t.datetime :completed_at + + t.timestamps + end + + add_index :import_jobs, :status + add_index :import_jobs, [:video_id, :status] + end +end + +# db/migrate/20240101000007_create_users.rb (Phase 2) +class CreateUsers < ActiveRecord::Migration[8.1] + def change + create_table :users do |t| + t.string :email, null: false + t.string :name + t.integer :role, default: 0, null: false # enum + t.string :provider + t.string :uid + + t.timestamps + end + + add_index :users, :email, unique: true + add_index :users, [:provider, :uid], unique: true + add_index :users, :role + end +end +``` + +**Enum Definitions:** + +```ruby +# app/models/video.rb +class Video < ApplicationRecord + enum source_type: { + local: 0, + s3: 1, + jellyfin: 2, + web: 3, + velour: 4 + } +end + +# app/models/storage_location.rb +class StorageLocation < ApplicationRecord + enum location_type: { + local: 0, + s3: 1, + jellyfin: 2, + web: 3, + velour: 4 + } +end + +# app/models/video_asset.rb +class VideoAsset < ApplicationRecord + enum asset_type: { + thumbnail: 0, + preview: 1, + sprite: 2, + vtt: 3 + } +end + +# app/models/import_job.rb +class ImportJob < ApplicationRecord + enum status: { + pending: 0, + downloading: 1, + processing: 2, + completed: 3, + failed: 4, + cancelled: 5 + } +end + +# app/models/user.rb (Phase 2) +class User < ApplicationRecord + enum role: { + member: 0, + admin: 1 + } +end +``` + +--- + +## Storage Architecture + +### Storage Location Types + +**1. Local Filesystem** (Readable + Writable) +```ruby +settings: {} +path: "/path/to/videos" +writable: true +``` + +**2. S3 Compatible Storage** (Readable + Writable) +```ruby +settings: { + region: "us-east-1", + access_key_id: "...", + secret_access_key: "...", + endpoint: "https://s3.amazonaws.com" # or Wasabi, Backblaze, etc. +} +path: "bucket-name" +writable: true +``` + +**3. JellyFin Server** (Readable only) +```ruby +settings: { + api_url: "https://jellyfin.example.com", + api_key: "...", + user_id: "..." +} +path: null +writable: false +``` + +**4. Web Directory** (Readable only) +```ruby +settings: { + base_url: "https://videos.example.com", + auth_type: "basic", # or "bearer", "none" + username: "...", + password: "..." +} +path: null +writable: false +``` + +**5. Velour Instance** (Readable only - Phase 4) +```ruby +settings: { + api_url: "https://velour.example.com", + api_key: "..." +} +path: null +writable: false +``` + +### Unified View Strategy + +**Library Aggregation:** +- Videos table contains entries from ALL sources +- `storage_location_id` links each video to its source +- Unified `/videos` view queries across all enabled locations +- Filter/group by `storage_location` to see source breakdown + +**Video Streaming Strategy:** +- Local: `send_file` with byte-range support +- S3: Generate presigned URLs (configurable expiry) +- JellyFin: Proxy through Rails or redirect to JellyFin stream +- Web: Proxy through Rails with auth forwarding +- Velour: Proxy or redirect to federated instance + +### Storage Adapter Pattern + +**Architecture:** Strategy pattern for pluggable storage backends. + +**Base Adapter Interface:** + +```ruby +# app/services/storage_adapters/base_adapter.rb +module StorageAdapters + class BaseAdapter + def initialize(storage_location) + @storage_location = storage_location + end + + # Scan for video files and return array of relative paths + def scan + raise NotImplementedError, "#{self.class} must implement #scan" + end + + # Generate streaming URL for a video + def stream_url(video) + raise NotImplementedError, "#{self.class} must implement #stream_url" + end + + # Check if file exists at path + def exists?(file_path) + raise NotImplementedError, "#{self.class} must implement #exists?" + end + + # Check if storage can be read from + def readable? + raise NotImplementedError, "#{self.class} must implement #readable?" + end + + # Check if storage can be written to + def writable? + @storage_location.writable? + end + + # Write/copy file to storage + def write(source_path, dest_path) + raise NotImplementedError, "#{self.class} must implement #write" + end + + # Download file to local temp path (for processing) + def download_to_temp(video) + raise NotImplementedError, "#{self.class} must implement #download_to_temp" + end + end +end +``` + +**Example: Local Adapter** + +```ruby +# app/services/storage_adapters/local_adapter.rb +module StorageAdapters + class LocalAdapter < BaseAdapter + VIDEO_EXTENSIONS = %w[.mp4 .mkv .avi .mov .wmv .flv .webm .m4v].freeze + + def scan + return [] unless readable? + + pattern = if @storage_location.scan_subdirectories + File.join(@storage_location.path, "**", "*{#{VIDEO_EXTENSIONS.join(',')}}") + else + File.join(@storage_location.path, "*{#{VIDEO_EXTENSIONS.join(',')}}") + end + + Dir.glob(pattern, File::FNM_CASEFOLD).map do |full_path| + full_path.sub(@storage_location.path + "/", "") + end + end + + def stream_url(video) + full_path(video) + end + + def exists?(file_path) + File.exist?(full_path_from_relative(file_path)) + end + + def readable? + File.directory?(@storage_location.path) && File.readable?(@storage_location.path) + end + + def writable? + super && File.writable?(@storage_location.path) + end + + def write(source_path, dest_path) + dest_full_path = full_path_from_relative(dest_path) + FileUtils.mkdir_p(File.dirname(dest_full_path)) + FileUtils.cp(source_path, dest_full_path) + dest_path + end + + def download_to_temp(video) + # Already local, return path + full_path(video) + end + + private + def full_path(video) + full_path_from_relative(video.file_path) + end + + def full_path_from_relative(file_path) + File.join(@storage_location.path, file_path) + end + end +end +``` + +**Example: S3 Adapter** + +```ruby +# app/services/storage_adapters/s3_adapter.rb +require 'aws-sdk-s3' + +module StorageAdapters + class S3Adapter < BaseAdapter + VIDEO_EXTENSIONS = %w[.mp4 .mkv .avi .mov .wmv .flv .webm .m4v].freeze + + def scan + return [] unless readable? + + prefix = @storage_location.scan_subdirectories ? "" : nil + + s3_client.list_objects_v2( + bucket: bucket_name, + prefix: prefix + ).contents.select do |obj| + VIDEO_EXTENSIONS.any? { |ext| obj.key.downcase.end_with?(ext) } + end.map(&:key) + end + + def stream_url(video) + s3_client.presigned_url( + :get_object, + bucket: bucket_name, + key: video.file_path, + expires_in: 3600 # 1 hour + ) + end + + def exists?(file_path) + s3_client.head_object(bucket: bucket_name, key: file_path) + true + rescue Aws::S3::Errors::NotFound + false + end + + def readable? + s3_client.head_bucket(bucket: bucket_name) + true + rescue Aws::S3::Errors::NotFound, Aws::S3::Errors::Forbidden + false + end + + def write(source_path, dest_path) + File.open(source_path, 'rb') do |file| + s3_client.put_object( + bucket: bucket_name, + key: dest_path, + body: file + ) + end + dest_path + end + + def download_to_temp(video) + temp_file = Tempfile.new(['velour-video', File.extname(video.file_path)]) + s3_client.get_object( + bucket: bucket_name, + key: video.file_path, + response_target: temp_file.path + ) + temp_file.path + end + + private + def s3_client + @s3_client ||= Aws::S3::Client.new( + region: settings['region'], + access_key_id: settings['access_key_id'], + secret_access_key: settings['secret_access_key'], + endpoint: settings['endpoint'] + ) + end + + def bucket_name + @storage_location.path + end + + def settings + @storage_location.settings + end + end +end +``` + +**Model Integration:** + +```ruby +# app/models/storage_location.rb +class StorageLocation < ApplicationRecord + encrypts :settings + serialize :settings, coder: JSON + + enum location_type: { + local: 0, + s3: 1, + jellyfin: 2, + web: 3, + velour: 4 + } + + def adapter + @adapter ||= adapter_class.new(self) + end + + private + def adapter_class + "StorageAdapters::#{location_type.classify}Adapter".constantize + end +end +``` + +**File Organization:** + +``` +app/ +└── services/ + └── storage_adapters/ + ├── base_adapter.rb + ├── local_adapter.rb + ├── s3_adapter.rb + ├── jellyfin_adapter.rb # Phase 3 + ├── web_adapter.rb # Phase 3 + └── velour_adapter.rb # Phase 4 +``` + +--- + +## Video Processing Pipeline + +### Asset Generation Jobs + +**VideoProcessorJob** +- Only runs for videos we can access (local, S3, or importable) +- Downloads temp copy if remote +- Generates: + 1. Thumbnail (1920x1080 JPEG at 10% mark) + 2. Preview clip (30s MP4 at 720p) + 3. VTT sprite sheet (160x90 tiles, 5s intervals) + 4. Metadata extraction (FFprobe) +- Stores assets via Active Storage (S3 or local) +- Cleans up temp files + +**VideoImportJob** (Phase 3) +- Downloads video from remote source +- Shows progress (bytes transferred, %) +- Saves to writable storage location +- Creates new Video record for imported copy +- Links to same Work as source +- Triggers VideoProcessorJob on completion + +### Service Objects Architecture + +Service objects encapsulate complex business logic that doesn't belong in models or controllers. They follow the single responsibility principle and make code more testable. + +**1. FileScannerService** + +Orchestrates scanning a storage location for video files. + +```ruby +# app/services/file_scanner_service.rb +class FileScannerService + def initialize(storage_location) + @storage_location = storage_location + @adapter = storage_location.adapter + end + + def call + return Result.failure("Storage location not readable") unless @adapter.readable? + + @storage_location.update!(last_scanned_at: Time.current) + + file_paths = @adapter.scan + new_videos = [] + + file_paths.each do |file_path| + video = find_or_create_video(file_path) + new_videos << video if video.previously_new_record? + + # Queue processing for new or unprocessed videos + VideoProcessorJob.perform_later(video.id) if video.duration.nil? + end + + Result.success(videos_found: file_paths.size, new_videos: new_videos.size) + end + + private + def find_or_create_video(file_path) + Video.find_or_create_by!( + storage_location: @storage_location, + file_path: file_path + ) do |video| + video.title = extract_title_from_path(file_path) + video.source_type = @storage_location.location_type + end + end + + def extract_title_from_path(file_path) + File.basename(file_path, ".*") + .gsub(/[\._]/, " ") + .gsub(/\[.*?\]/, "") + .strip + end +end + +# Usage: +# result = FileScannerService.new(@storage_location).call +# if result.success? +# flash[:notice] = "Found #{result.videos_found} videos (#{result.new_videos} new)" +# end +``` + +**2. VideoMetadataExtractor** + +Extracts video metadata using FFprobe. + +```ruby +# app/services/video_metadata_extractor.rb +require 'streamio-ffmpeg' + +class VideoMetadataExtractor + def initialize(video) + @video = video + end + + def call + file_path = @video.storage_location.adapter.download_to_temp(@video) + movie = FFMPEG::Movie.new(file_path) + + @video.update!( + duration: movie.duration, + width: movie.width, + height: movie.height, + video_codec: movie.video_codec, + audio_codec: movie.audio_codec, + bit_rate: movie.bitrate, + frame_rate: movie.frame_rate, + format: movie.container, + file_size: movie.size, + resolution_label: calculate_resolution_label(movie.height), + file_hash: calculate_file_hash(file_path) + ) + + Result.success + rescue FFMPEG::Error => e + @video.update!(processing_failed: true, error_message: e.message) + Result.failure(e.message) + ensure + # Clean up temp file if it was downloaded + File.delete(file_path) if file_path && File.exist?(file_path) && file_path.include?('tmp') + end + + private + def calculate_resolution_label(height) + case height + when 0..480 then "SD" + when 481..720 then "720p" + when 721..1080 then "1080p" + when 1081..1440 then "1440p" + when 1441..2160 then "4K" + else "8K+" + end + end + + def calculate_file_hash(file_path) + # Hash first and last 64KB for speed (like Plex/Emby) + Digest::MD5.file(file_path).hexdigest + end +end +``` + +**3. DuplicateDetectorService** + +Finds potential duplicate videos based on file hash and title similarity. + +```ruby +# app/services/duplicate_detector_service.rb +class DuplicateDetectorService + def initialize(video = nil) + @video = video + end + + def call + # Find all videos without a work assigned + unorganized_videos = Video.where(work_id: nil) + + # Group by similar titles and file hashes + potential_groups = [] + + unorganized_videos.group_by(&:file_hash).each do |hash, videos| + next if videos.size < 2 + + potential_groups << { + type: :exact_duplicate, + videos: videos, + confidence: :high + } + end + + # Find similar titles using Levenshtein distance or fuzzy matching + unorganized_videos.find_each do |video| + similar = find_similar_titles(video, unorganized_videos) + if similar.any? + potential_groups << { + type: :similar_title, + videos: [video] + similar, + confidence: :medium + } + end + end + + Result.success(groups: potential_groups.uniq) + end + + private + def find_similar_titles(video, candidates) + return [] unless video.title + + candidates.select do |candidate| + next false if candidate.id == video.id + next false unless candidate.title + + similarity_score(video.title, candidate.title) > 0.8 + end + end + + def similarity_score(str1, str2) + # Simple implementation - could use gems like 'fuzzy_match' or 'levenshtein' + str1_clean = normalize_title(str1) + str2_clean = normalize_title(str2) + + return 1.0 if str1_clean == str2_clean + + # Jaccard similarity on words + words1 = str1_clean.split + words2 = str2_clean.split + + intersection = (words1 & words2).size + union = (words1 | words2).size + + intersection.to_f / union + end + + def normalize_title(title) + title.downcase + .gsub(/\[.*?\]/, "") # Remove brackets + .gsub(/\(.*?\)/, "") # Remove parentheses + .gsub(/[^\w\s]/, "") # Remove special chars + .strip + end +end +``` + +**4. WorkGrouperService** + +Groups videos into a work. + +```ruby +# app/services/work_grouper_service.rb +class WorkGrouperService + def initialize(video_ids, work_attributes = {}) + @video_ids = video_ids + @work_attributes = work_attributes + end + + def call + videos = Video.where(id: @video_ids).includes(:work) + + return Result.failure("No videos found") if videos.empty? + + # Use existing work if all videos belong to the same one + existing_work = videos.first.work if videos.all? { |v| v.work_id == videos.first.work_id } + + ActiveRecord::Base.transaction do + work = existing_work || create_work_from_videos(videos) + + videos.each do |video| + video.update!(work: work) + end + + Result.success(work: work) + end + end + + private + def create_work_from_videos(videos) + representative = videos.max_by(&:height) || videos.first + + Work.create!( + title: @work_attributes[:title] || extract_base_title(representative.title), + year: @work_attributes[:year], + organized: false + ) + end + + def extract_base_title(title) + # Extract base title by removing resolution, format markers, etc. + title.gsub(/\d{3,4}p/, "") + .gsub(/\b(BluRay|WEB-?DL|HDRip|DVDRip|4K|UHD)\b/i, "") + .gsub(/\[.*?\]/, "") + .strip + end +end +``` + +**5. VideoImporterService** (Phase 3) + +Handles downloading a video from remote source to writable storage. + +```ruby +# app/services/video_importer_service.rb +class VideoImporterService + def initialize(video, destination_location, destination_path = nil) + @source_video = video + @destination_location = destination_location + @destination_path = destination_path || video.file_path + @import_job = nil + end + + def call + return Result.failure("Destination is not writable") unless @destination_location.writable? + return Result.failure("Source is not readable") unless @source_video.storage_location.adapter.readable? + + # Create import job + @import_job = ImportJob.create!( + video: @source_video, + destination_location: @destination_location, + destination_path: @destination_path, + status: :pending + ) + + # Queue background job + VideoImportJob.perform_later(@import_job.id) + + Result.success(import_job: @import_job) + end +end +``` + +**File Organization:** + +``` +app/ +└── services/ + ├── storage_adapters/ # Storage backends + ├── file_scanner_service.rb + ├── video_metadata_extractor.rb + ├── duplicate_detector_service.rb + ├── work_grouper_service.rb + ├── video_importer_service.rb # Phase 3 + └── result.rb # Simple result object +``` + +**Result Object Pattern:** + +```ruby +# app/services/result.rb +class Result + attr_reader :data, :error + + def initialize(success:, data: {}, error: nil) + @success = success + @data = data + @error = error + end + + def success? + @success + end + + def failure? + !@success + end + + def self.success(data = {}) + new(success: true, data: data) + end + + def self.failure(error) + new(success: false, error: error) + end + + # Allow accessing data as methods + def method_missing(method, *args) + return @data[method] if @data.key?(method) + super + end + + def respond_to_missing?(method, include_private = false) + @data.key?(method) || super + end +end +``` + +--- + +## Model Organization + +Rails models follow a specific organization pattern for readability and maintainability. + +### Complete Model Examples + +**Work Model:** + +```ruby +# app/models/work.rb +class Work < ApplicationRecord + # 1. Includes/Concerns + include Searchable + + # 2. Serialization + serialize :metadata, coder: JSON + + # 3. Associations + has_many :videos, dependent: :nullify + has_one :primary_video, -> { order(height: :desc) }, class_name: "Video" + + # 4. Validations + validates :title, presence: true + validates :year, numericality: { only_integer: true, greater_than: 1800 }, allow_nil: true + validates :rating, numericality: { greater_than_or_equal_to: 0, less_than_or_equal_to: 10 }, allow_nil: true + + # 5. Scopes + scope :organized, -> { where(organized: true) } + scope :unorganized, -> { where(organized: false) } + scope :recent, -> { order(created_at: :desc) } + scope :by_title, -> { order(:title) } + scope :with_year, -> { where.not(year: nil) } + + # 6. Delegations + delegate :resolution_label, :duration, to: :primary_video, prefix: true, allow_nil: true + + # 7. Class methods + def self.search(query) + where("title LIKE ? OR director LIKE ?", "%#{query}%", "%#{query}%") + end + + # 8. Instance methods + def display_title + year ? "#{title} (#{year})" : title + end + + def video_count + videos.count + end + + def total_duration + videos.sum(:duration) + end + + def available_versions + videos.group_by(&:resolution_label) + end +end +``` + +**Video Model:** + +```ruby +# app/models/video.rb +class Video < ApplicationRecord + # 1. Includes/Concerns + include Streamable + include Processable + + # 2. Serialization + serialize :metadata, coder: JSON + + # 3. Enums + enum source_type: { + local: 0, + s3: 1, + jellyfin: 2, + web: 3, + velour: 4 + } + + # 4. Associations + belongs_to :work, optional: true, touch: true + belongs_to :storage_location + has_many :video_assets, dependent: :destroy + has_many :playback_sessions, dependent: :destroy + has_one :import_job, dependent: :nullify + + has_one_attached :thumbnail + has_one_attached :preview_video + + # 5. Validations + validates :title, presence: true + validates :file_path, presence: true + validates :file_hash, presence: true + validates :source_type, presence: true + validate :file_exists_on_storage, on: :create + + # 6. Callbacks + before_save :normalize_title + after_create :queue_processing + + # 7. Scopes + scope :unprocessed, -> { where(duration: nil, processing_failed: false) } + scope :processed, -> { where.not(duration: nil) } + scope :failed, -> { where(processing_failed: true) } + scope :by_source, ->(type) { where(source_type: type) } + scope :imported, -> { where(imported: true) } + scope :recent, -> { order(created_at: :desc) } + scope :by_resolution, -> { order(height: :desc) } + scope :with_work, -> { where.not(work_id: nil) } + scope :without_work, -> { where(work_id: nil) } + + # 8. Delegations + delegate :name, :location_type, :adapter, to: :storage_location, prefix: true + delegate :display_title, to: :work, prefix: true, allow_nil: true + + # 9. Class methods + def self.search(query) + left_joins(:work) + .where("videos.title LIKE ? OR works.title LIKE ?", "%#{query}%", "%#{query}%") + .distinct + end + + def self.by_duration(min: nil, max: nil) + scope = all + scope = scope.where("duration >= ?", min) if min + scope = scope.where("duration <= ?", max) if max + scope + end + + # 10. Instance methods + def display_title + work_display_title || title || filename + end + + def filename + File.basename(file_path) + end + + def file_extension + File.extname(file_path).downcase + end + + def formatted_duration + return "Unknown" unless duration + + hours = (duration / 3600).to_i + minutes = ((duration % 3600) / 60).to_i + seconds = (duration % 60).to_i + + if hours > 0 + "%d:%02d:%02d" % [hours, minutes, seconds] + else + "%d:%02d" % [minutes, seconds] + end + end + + def formatted_file_size + return "Unknown" unless file_size + + units = ['B', 'KB', 'MB', 'GB', 'TB'] + size = file_size.to_f + unit_index = 0 + + while size >= 1024 && unit_index < units.length - 1 + size /= 1024.0 + unit_index += 1 + end + + "%.2f %s" % [size, units[unit_index]] + end + + def processable? + !processing_failed && storage_location_adapter.readable? + end + + def streamable? + duration.present? && storage_location.enabled? && storage_location_adapter.readable? + end + + private + def normalize_title + self.title = title.strip if title.present? + end + + def queue_processing + VideoProcessorJob.perform_later(id) if processable? + end + + def file_exists_on_storage + return if storage_location_adapter.exists?(file_path) + errors.add(:file_path, "does not exist on storage") + end +end +``` + +**StorageLocation Model:** + +```ruby +# app/models/storage_location.rb +class StorageLocation < ApplicationRecord + # 1. Encryption & Serialization + encrypts :settings + serialize :settings, coder: JSON + + # 2. Enums + enum location_type: { + local: 0, + s3: 1, + jellyfin: 2, + web: 3, + velour: 4 + } + + # 3. Associations + has_many :videos, dependent: :restrict_with_error + has_many :destination_imports, class_name: "ImportJob", foreign_key: :destination_location_id + + # 4. Validations + validates :name, presence: true, uniqueness: true + validates :location_type, presence: true + validates :path, presence: true, if: -> { local? || s3? } + validate :adapter_is_valid + + # 5. Scopes + scope :enabled, -> { where(enabled: true) } + scope :disabled, -> { where(enabled: false) } + scope :writable, -> { where(writable: true) } + scope :readable, -> { enabled } + scope :by_priority, -> { order(priority: :desc) } + scope :by_type, ->(type) { where(location_type: type) } + + # 6. Instance methods + def adapter + @adapter ||= adapter_class.new(self) + end + + def scan! + FileScannerService.new(self).call + end + + def accessible? + adapter.readable? + rescue StandardError + false + end + + def video_count + videos.count + end + + def last_scan_ago + return "Never" unless last_scanned_at + + distance_of_time_in_words(last_scanned_at, Time.current) + end + + private + def adapter_class + "StorageAdapters::#{location_type.classify}Adapter".constantize + end + + def adapter_is_valid + adapter.readable? + rescue StandardError => e + errors.add(:base, "Cannot access storage: #{e.message}") + end +end +``` + +**PlaybackSession Model:** + +```ruby +# app/models/playback_session.rb +class PlaybackSession < ApplicationRecord + # 1. Associations + belongs_to :video + belongs_to :user, optional: true + + # 2. Validations + validates :video, presence: true + validates :position, numericality: { greater_than_or_equal_to: 0 }, allow_nil: true + validates :duration_watched, numericality: { greater_than_or_equal_to: 0 }, allow_nil: true + + # 3. Callbacks + before_save :check_completion + + # 4. Scopes + scope :recent, -> { order(last_watched_at: :desc) } + scope :completed, -> { where(completed: true) } + scope :in_progress, -> { where(completed: false).where.not(position: 0) } + scope :for_user, ->(user) { where(user: user) } + + # 5. Class methods + def self.update_position(video, user, position, duration_watched = 0) + session = find_or_initialize_by(video: video, user: user) + session.position = position + session.duration_watched = (session.duration_watched || 0) + duration_watched + session.last_watched_at = Time.current + session.play_count += 1 if session.position.zero? + session.save! + end + + # 6. Instance methods + def progress_percentage + return 0 unless video.duration && position + + ((position / video.duration) * 100).round(1) + end + + def resume_position + completed? ? 0 : position + end + + private + def check_completion + if video.duration && position + self.completed = (position / video.duration) > 0.9 + end + end +end +``` + +### Model Concerns + +**Streamable Concern:** + +```ruby +# app/models/concerns/streamable.rb +module Streamable + extend ActiveSupport::Concern + + included do + # Add any class-level includes here + end + + def stream_url + storage_location.adapter.stream_url(self) + end + + def streamable? + duration.present? && storage_location.enabled? && storage_location.adapter.readable? + end + + def stream_type + case source_type + when "s3" then :presigned + when "local" then :direct + else :proxy + end + end +end +``` + +**Processable Concern:** + +```ruby +# app/models/concerns/processable.rb +module Processable + extend ActiveSupport::Concern + + included do + scope :processing_pending, -> { where(duration: nil, processing_failed: false) } + end + + def processed? + duration.present? + end + + def processing_pending? + !processed? && !processing_failed? + end + + def mark_processing_failed!(error_message) + update!(processing_failed: true, error_message: error_message) + end + + def retry_processing! + update!(processing_failed: false, error_message: nil) + VideoProcessorJob.perform_later(id) + end +end +``` + +**Searchable Concern:** + +```ruby +# app/models/concerns/searchable.rb +module Searchable + extend ActiveSupport::Concern + + class_methods do + def search(query) + return all if query.blank? + + where("title LIKE ?", "%#{sanitize_sql_like(query)}%") + end + end +end +``` + +--- + +## Frontend Architecture + +### Main Views (Hotwire) + +**Library Views:** +- `videos/index` - Unified library grid with filters by source +- `videos/show` - Video player page +- `works/index` - Works library (grouped by work) +- `works/show` - Work details with all versions/sources + +**Admin Views (Phase 2+):** +- `storage_locations/index` - Manage all sources +- `storage_locations/new` - Add new source (local/S3/JellyFin/etc) +- `import_jobs/index` - Monitor import progress +- `videos/:id/import` - Import modal/form + +### Stimulus Controllers + +**VideoPlayerController** +- Initialize Video.js with source detection +- Handle different streaming strategies (local/S3/proxy) +- Track playback position +- Quality switching for multiple versions + +**LibraryScanController** +- Trigger scans per storage location +- Real-time progress via Turbo Streams +- Show scan results and new videos found + +**VideoImportController** +- Select destination storage location +- Show import progress +- Cancel import jobs + +**WorkMergeController** +- Group videos into works +- Drag-and-drop UI +- Show all versions/sources for a work + +### Video.js Custom Plugins + +1. **resume-plugin** - Auto-resume from saved position +2. **track-plugin** - Send playback stats to Rails API +3. **quality-selector** - Switch between versions (same work, different sources/resolutions) +4. **thumbnails-plugin** - VTT sprite preview on seek + +--- + +## Authorization & Security + +### Phase 1: No Authentication (MVP) + +For MVP, all features are accessible without authentication. However, the authorization structure is designed to be auth-ready. + +**Current Pattern (Request Context):** + +```ruby +# app/models/current.rb +class Current < ActiveSupport::CurrentAttributes + attribute :user + attribute :request_id +end + +# app/controllers/application_controller.rb +class ApplicationController < ActionController::Base + before_action :set_current_attributes + + private + def set_current_attributes + Current.user = current_user if respond_to?(:current_user) + Current.request_id = request.uuid + end +end +``` + +### Phase 2: OIDC Authentication + +**User Model with Authorization:** + +```ruby +# app/models/user.rb +class User < ApplicationRecord + enum role: { member: 0, admin: 1 } + + validates :email, presence: true, uniqueness: true + + def admin? + role == "admin" + end + + def self.admin_from_env + admin_email = ENV['ADMIN_EMAIL'] + return nil unless admin_email + + find_by(email: admin_email) + end +end +``` + +**OIDC Configuration:** + +```ruby +# config/initializers/omniauth.rb +Rails.application.config.middleware.use OmniAuth::Builder do + provider :openid_connect, + name: :oidc, + issuer: ENV['OIDC_ISSUER'], + client_id: ENV['OIDC_CLIENT_ID'], + client_secret: ENV['OIDC_CLIENT_SECRET'], + scope: [:openid, :email, :profile] +end +``` + +**Sessions Controller:** + +```ruby +# app/controllers/sessions_controller.rb +class SessionsController < ApplicationController + skip_before_action :authenticate_user!, only: [:create] + + def create + auth_hash = request.env['omniauth.auth'] + user = User.find_or_create_from_omniauth(auth_hash) + + session[:user_id] = user.id + redirect_to root_path, notice: "Signed in successfully" + end + + def destroy + session[:user_id] = nil + redirect_to root_path, notice: "Signed out successfully" + end +end +``` + +### Model-Level Authorization + +```ruby +# app/models/storage_location.rb +class StorageLocation < ApplicationRecord + def editable_by?(user) + return true if user.nil? # Phase 1: no auth + user.admin? # Phase 2+: only admins + end + + def deletable_by?(user) + return true if user.nil? + user.admin? && videos.count.zero? + end +end + +# app/models/work.rb +class Work < ApplicationRecord + def editable_by?(user) + return true if user.nil? + user.present? # Any authenticated user + end +end +``` + +**Controller-Level Guards:** + +```ruby +# app/controllers/admin/base_controller.rb +module Admin + class BaseController < ApplicationController + before_action :require_admin! + + private + def require_admin! + return if Current.user&.admin? + + redirect_to root_path, alert: "Access denied" + end + end +end + +# app/controllers/admin/storage_locations_controller.rb +module Admin + class StorageLocationsController < Admin::BaseController + before_action :set_storage_location, only: [:edit, :update, :destroy] + before_action :authorize_storage_location, only: [:edit, :update, :destroy] + + def index + @storage_locations = StorageLocation.all + end + + def update + if @storage_location.update(storage_location_params) + redirect_to admin_storage_locations_path, notice: "Updated successfully" + else + render :edit, status: :unprocessable_entity + end + end + + private + def authorize_storage_location + head :forbidden unless @storage_location.editable_by?(Current.user) + end + end +end +``` + +### Credentials Management + +**Encrypted Settings:** + +```ruby +# app/models/storage_location.rb +class StorageLocation < ApplicationRecord + encrypts :settings # Rails 7+ built-in encryption + serialize :settings, coder: JSON +end + +# Generate encryption key: +# bin/rails db:encryption:init +# Add to config/credentials.yml.enc +``` + +**Rails Credentials:** + +```bash +# Edit credentials +bin/rails credentials:edit + +# Add: +# aws: +# access_key_id: <%= ENV["AWS_ACCESS_KEY_ID"] %> +# secret_access_key: <%= ENV["AWS_SECRET_ACCESS_KEY"] %> +``` + +### API Authentication (Phase 4 - Federation) + +**API Key Authentication:** + +```ruby +# app/controllers/api/federation/base_controller.rb +module Api + module Federation + class BaseController < ActionController::API + include ActionController::HttpAuthentication::Token::ControllerMethods + + before_action :authenticate_api_key! + + private + def authenticate_api_key! + return if Rails.env.development? + return unless ENV['ALLOW_FEDERATION'] == 'true' + + authenticate_or_request_with_http_token do |token, options| + ActiveSupport::SecurityUtils.secure_compare( + token, + ENV.fetch('VELOUR_API_KEY') + ) + end + end + end + end +end +``` + +**Rate Limiting:** + +```ruby +# config/initializers/rack_attack.rb (optional, recommended) +class Rack::Attack + throttle('api/ip', limit: 300, period: 5.minutes) do |req| + req.ip if req.path.start_with?('/api/') + end + + throttle('federation/api_key', limit: 1000, period: 1.hour) do |req| + req.env['HTTP_AUTHORIZATION'] if req.path.start_with?('/api/federation/') + end +end +``` + +--- + +## API Controller Architecture + +### Controller Organization + +``` +app/ +└── controllers/ + ├── application_controller.rb + ├── videos_controller.rb # HTML views + ├── works_controller.rb + ├── admin/ + │ ├── base_controller.rb + │ ├── storage_locations_controller.rb + │ └── import_jobs_controller.rb + └── api/ + ├── base_controller.rb + └── v1/ + ├── videos_controller.rb + ├── works_controller.rb + ├── playback_sessions_controller.rb + └── storage_locations_controller.rb + └── federation/ # Phase 4 + ├── base_controller.rb + ├── videos_controller.rb + └── works_controller.rb +``` + +### API Base Controllers + +**Internal API Base:** + +```ruby +# app/controllers/api/base_controller.rb +module Api + class BaseController < ActionController::API + include ActionController::Cookies + + rescue_from ActiveRecord::RecordNotFound, with: :not_found + rescue_from ActiveRecord::RecordInvalid, with: :unprocessable_entity + + private + def not_found + render json: { error: "Not found" }, status: :not_found + end + + def unprocessable_entity(exception) + render json: { + error: "Validation failed", + details: exception.record.errors.full_messages + }, status: :unprocessable_entity + end + end +end +``` + +**Example API Controller:** + +```ruby +# app/controllers/api/v1/videos_controller.rb +module Api + module V1 + class VideosController < Api::BaseController + before_action :set_video, only: [:show, :stream] + + def index + @videos = Video.includes(:work, :storage_location) + .order(created_at: :desc) + .page(params[:page]) + .per(params[:per] || 50) + + render json: { + videos: @videos.as_json(include: [:work, :storage_location]), + meta: pagination_meta(@videos) + } + end + + def show + render json: @video.as_json( + include: { + work: { only: [:id, :title, :year] }, + storage_location: { only: [:id, :name, :location_type] } + }, + methods: [:stream_url, :formatted_duration] + ) + end + + def stream + # Route to appropriate streaming strategy + case @video.stream_type + when :presigned + render json: { stream_url: @video.stream_url } + when :direct + send_file @video.stream_url, + type: @video.format, + disposition: 'inline', + stream: true + when :proxy + # Implement proxy logic + redirect_to @video.stream_url, allow_other_host: true + end + end + + private + def set_video + @video = Video.find(params[:id]) + end + + def pagination_meta(collection) + { + current_page: collection.current_page, + next_page: collection.next_page, + prev_page: collection.prev_page, + total_pages: collection.total_pages, + total_count: collection.total_count + } + end + end + end +end +``` + +**Playback Tracking API:** + +```ruby +# app/controllers/api/v1/playback_sessions_controller.rb +module Api + module V1 + class PlaybackSessionsController < Api::BaseController + def update + video = Video.find(params[:video_id]) + user = Current.user # nil in Phase 1, actual user in Phase 2 + + session = PlaybackSession.update_position( + video, + user, + params[:position].to_f, + params[:duration_watched].to_f + ) + + render json: { success: true, session: session } + rescue ActiveRecord::RecordNotFound + render json: { error: "Video not found" }, status: :not_found + end + end + end +end +``` + +--- + +## Turbo Streams & Real-Time Updates + +### Scan Progress Broadcasting + +**Job with Turbo Streams:** + +```ruby +# app/jobs/file_scanner_job.rb +class FileScannerJob < ApplicationJob + queue_as :default + + def perform(storage_location_id) + @storage_location = StorageLocation.find(storage_location_id) + + broadcast_update(status: "started", progress: 0) + + result = FileScannerService.new(@storage_location).call + + if result.success? + broadcast_update( + status: "completed", + progress: 100, + videos_found: result.videos_found, + new_videos: result.new_videos + ) + else + broadcast_update(status: "failed", error: result.error) + end + end + + private + def broadcast_update(**data) + Turbo::StreamsChannel.broadcast_replace_to( + "storage_location_#{@storage_location.id}", + target: "scan_status", + partial: "admin/storage_locations/scan_status", + locals: { storage_location: @storage_location, **data } + ) + end +end +``` + +**View with Turbo Stream:** + +```erb +<%# app/views/admin/storage_locations/show.html.erb %> +<%= turbo_stream_from "storage_location_#{@storage_location.id}" %> + +
+ <%= render "scan_status", storage_location: @storage_location, status: "idle" %> +
+ +<%= button_to "Scan Now", scan_admin_storage_location_path(@storage_location), + method: :post, + data: { turbo_frame: "_top" }, + class: "btn btn-primary" %> +``` + +**Partial:** + +```erb +<%# app/views/admin/storage_locations/_scan_status.html.erb %> +
+ <% case status %> + <% when "started" %> +
+

Scanning... <%= progress %>%

+
+ <% when "completed" %> +
+

Scan completed! Found <%= videos_found %> videos (<%= new_videos %> new)

+
+ <% when "failed" %> +
+

Scan failed: <%= error %>

+
+ <% else %> +

Ready to scan

+ <% end %> +
+``` + +### Import Progress Updates + +Similar pattern for VideoImportJob with progress broadcasting. + +--- + +## Testing Strategy + +### Test Organization + +``` +test/ +├── models/ +│ ├── video_test.rb +│ ├── work_test.rb +│ ├── storage_location_test.rb +│ ├── playback_session_test.rb +│ └── concerns/ +│ ├── streamable_test.rb +│ └── processable_test.rb +├── services/ +│ ├── file_scanner_service_test.rb +│ ├── video_metadata_extractor_test.rb +│ ├── duplicate_detector_service_test.rb +│ └── storage_adapters/ +│ ├── local_adapter_test.rb +│ └── s3_adapter_test.rb +├── jobs/ +│ ├── video_processor_job_test.rb +│ └── file_scanner_job_test.rb +├── controllers/ +│ ├── videos_controller_test.rb +│ ├── works_controller_test.rb +│ └── api/ +│ └── v1/ +│ └── videos_controller_test.rb +└── system/ + ├── video_playback_test.rb + ├── library_browsing_test.rb + └── work_grouping_test.rb +``` + +### Example Tests + +**Model Test:** + +```ruby +# test/models/video_test.rb +require "test_helper" + +class VideoTest < ActiveSupport::TestCase + test "belongs to storage location" do + video = videos(:one) + assert_instance_of StorageLocation, video.storage_location + end + + test "validates presence of required fields" do + video = Video.new + assert_not video.valid? + assert_includes video.errors[:title], "can't be blank" + assert_includes video.errors[:file_path], "can't be blank" + end + + test "formatted_duration returns correct format" do + video = videos(:one) + video.duration = 3665 # 1 hour, 1 minute, 5 seconds + assert_equal "1:01:05", video.formatted_duration + end + + test "streamable? returns true when video is processed and storage is enabled" do + video = videos(:one) + video.duration = 100 + video.storage_location.update!(enabled: true) + + assert video.streamable? + end +end +``` + +**Service Test:** + +```ruby +# test/services/file_scanner_service_test.rb +require "test_helper" + +class FileScannerServiceTest < ActiveSupport::TestCase + setup do + @storage_location = storage_locations(:local_movies) + end + + test "scans directory and creates video records" do + # Stub adapter scan method + @storage_location.adapter.stub :scan, ["movie1.mp4", "movie2.mkv"] do + result = FileScannerService.new(@storage_location).call + + assert result.success? + assert_equal 2, result.videos_found + end + end + + test "updates last_scanned_at timestamp" do + @storage_location.adapter.stub :scan, [] do + FileScannerService.new(@storage_location).call + + @storage_location.reload + assert_not_nil @storage_location.last_scanned_at + end + end +end +``` + +**System Test:** + +```ruby +# test/system/video_playback_test.rb +require "application_system_test_case" + +class VideoPlaybackTest < ApplicationSystemTestCase + test "playing a video updates playback position" do + video = videos(:one) + + visit video_path(video) + assert_selector "video#video-player" + + # Simulate video playback (would need JS execution) + # assert_changes -> { video.playback_sessions.first&.position } + end + + test "resume functionality loads saved position" do + video = videos(:one) + PlaybackSession.create!(video: video, position: 30.0) + + visit video_path(video) + + # Assert player starts at saved position + # (implementation depends on Video.js setup) + end +end +``` + +--- + +## API Design (RESTful) + +### Video Playback API (Internal) +``` +GET /api/v1/videos/:id/stream # Stream video (route to appropriate source) +GET /api/v1/videos/:id/presigned # Get presigned S3 URL +GET /api/v1/videos/:id/metadata # Get video metadata +POST /api/v1/videos/:id/playback # Update playback position +GET /api/v1/videos/:id/assets # Get thumbnails, sprites +``` + +### Library Management API +``` +GET /api/v1/videos # List all videos (unified view) +GET /api/v1/works # List works with grouped videos +POST /api/v1/works/:id/merge # Merge videos into work +GET /api/v1/storage_locations # List all sources +POST /api/v1/storage_locations # Add new source +POST /api/v1/storage_locations/:id/scan # Trigger scan +GET /api/v1/storage_locations/:id/scan_status +``` + +### Import API (Phase 3) +``` +POST /api/v1/videos/:id/import # Import video to writable storage +GET /api/v1/import_jobs # List import jobs +GET /api/v1/import_jobs/:id # Get import status +DELETE /api/v1/import_jobs/:id # Cancel import +``` + +### Federation API (Phase 4) - Public to other Velour instances +``` +GET /api/v1/federation/videos # List available videos +GET /api/v1/federation/videos/:id # Get video details +GET /api/v1/federation/videos/:id/stream # Stream video (with API key auth) +GET /api/v1/federation/works # List works +``` + +--- + +## Required Gems + +Add these to the Gemfile: + +```ruby +# Gemfile + +# Core gems (already present in Rails 8) +gem "rails", "~> 8.1.1" +gem "sqlite3", ">= 2.1" +gem "puma", ">= 5.0" +gem "importmap-rails" +gem "turbo-rails" +gem "stimulus-rails" +gem "tailwindcss-rails" +gem "solid_cache" +gem "solid_queue" +gem "solid_cable" +gem "image_processing", "~> 1.2" + +# Video processing +gem "streamio-ffmpeg" # FFmpeg wrapper for metadata extraction + +# Pagination +gem "pagy" # Fast, lightweight pagination + +# AWS SDK for S3 support (Phase 3, but add early) +gem "aws-sdk-s3" + +# Phase 2: Authentication +# gem "omniauth-openid-connect" +# gem "omniauth-rails_csrf_protection" + +# Phase 3: Remote sources +# gem "httparty" # For JellyFin/Web APIs +# gem "down" # For downloading remote files + +# Development & Test +group :development, :test do + gem "debug", platforms: %i[mri windows] + gem "bundler-audit" + gem "brakeman" + gem "rubocop-rails-omakase" +end + +group :development do + gem "web-console" + gem "bullet" # N+1 query detection + gem "strong_migrations" # Catch unsafe migrations +end + +group :test do + gem "capybara" + gem "selenium-webdriver" + gem "mocha" # Stubbing/mocking +end + +# Optional but recommended +# gem "rack-attack" # Rate limiting (Phase 4) +``` + +--- + +## Route Structure + +```ruby +# config/routes.rb +Rails.application.routes.draw do + # Health check + get "up" => "rails/health#show", as: :rails_health_check + + # Root + root "videos#index" + + # Main UI routes + resources :videos, only: [:index, :show] do + member do + get :watch # Player page + post :import # Phase 3: Import to writable storage + end + end + + resources :works, only: [:index, :show] do + member do + post :merge # Merge videos into this work + end + end + + # Admin routes (Phase 2+) + namespace :admin do + root "dashboard#index" + + resources :storage_locations do + member do + post :scan + get :scan_status + end + end + + resources :import_jobs, only: [:index, :show, :destroy] do + member do + post :cancel + end + end + + resources :users, only: [:index, :edit, :update] # Phase 2 + end + + # Internal API (for JS/Stimulus) + namespace :api do + namespace :v1 do + resources :videos, only: [:index, :show] do + member do + get :stream + get :presigned # For S3 presigned URLs + end + end + + resources :works, only: [:index, :show] + + resources :playback_sessions, only: [] do + collection do + post :update # POST /api/v1/playback_sessions/update + end + end + + resources :storage_locations, only: [:index] + end + + # Federation API (Phase 4) + namespace :federation do + resources :videos, only: [:index, :show] do + member do + get :stream + end + end + + resources :works, only: [:index, :show] + end + end + + # Authentication routes (Phase 2) + # get '/auth/:provider/callback', to: 'sessions#create' + # delete '/sign_out', to: 'sessions#destroy', as: :sign_out +end +``` + +--- + +## Development Phases + +### Phase 1: MVP (Local Filesystem) + +Phase 1 is broken into 4 sub-phases for manageable milestones: + +#### Phase 1A: Core Foundation (Week 1-2) + +**Goal:** Basic models and database setup + +1. **Generate models with migrations:** + - Works + - Videos + - StorageLocations + - PlaybackSessions (basic structure) + +2. **Implement models:** + - Add validations, scopes, associations + - Add concerns (Streamable, Processable, Searchable) + - Serialize metadata fields + +3. **Create storage adapter pattern:** + - BaseAdapter interface + - LocalAdapter implementation + - Test adapter with sample directory + +4. **Create basic services:** + - FileScannerService (scan local directory) + - Result object pattern + +5. **Simple UI:** + - Videos index page (list only, no thumbnails yet) + - Basic TailwindCSS styling + - Storage locations admin page + +**Deliverable:** Can scan a local directory and see videos in database + +#### Phase 1B: Video Playback (Week 3) + +**Goal:** Working video player with streaming + +1. **Video streaming:** + - Videos controller with show action + - Stream action for serving video files + - Byte-range support for seeking + +2. **Video.js integration:** + - Add Video.js via Importmap + - Create VideoPlayerController (Stimulus) + - Basic player UI on videos#show page + +3. **Playback tracking:** + - Implement PlaybackSession.update_position + - Create API endpoint for position updates + - Basic resume functionality (load last position) + +4. **Playback tracking plugin:** + - Custom Video.js plugin to track position + - Send updates to Rails API every 10 seconds + - Save position on pause/stop + +**Deliverable:** Can watch videos with resume functionality + +#### Phase 1C: Processing Pipeline (Week 4) + +**Goal:** Video metadata extraction and asset generation + +1. **Video metadata extraction:** + - VideoMetadataExtractor service + - FFmpeg integration via streamio-ffmpeg + - Extract duration, resolution, codecs, file hash + +2. **Background processing:** + - VideoProcessorJob + - Queue processing for new videos + - Error handling and retry logic + +3. **Thumbnail generation:** + - Generate thumbnail at 10% mark + - Store via Active Storage + - Display thumbnails on index page + +4. **Video assets:** + - VideoAssets model + - Store thumbnails, previews (phase 1C: thumbnails only) + - VTT sprites (defer to Phase 1D if time-constrained) + +5. **Processing UI:** + - Show processing status on video cards + - Processing failed indicator + - Retry processing action + +**Deliverable:** Videos automatically processed with thumbnails + +#### Phase 1D: Works & Grouping (Week 5) + +**Goal:** Group duplicate videos into works + +1. **Works functionality:** + - Works model fully implemented + - Works index/show pages + - Display videos grouped by work + +2. **Duplicate detection:** + - DuplicateDetectorService + - Find videos with same file hash + - Find videos with similar titles + +3. **Work grouping UI:** + - WorkGrouperService + - Manual grouping interface + - Drag-and-drop or checkbox selection + - Create work from selected videos + +4. **Works display:** + - Works index with thumbnails + - Works show with all versions + - Version selector (resolution, format) + +5. **Polish:** + - Search functionality + - Filtering by source, resolution + - Sorting options + - Pagination with Pagy + +**Deliverable:** Full MVP with work grouping and polished UI + +### Phase 2: Authentication & Multi-User +1. User model and OIDC integration +2. Admin role management (ENV: ADMIN_EMAIL) +3. Per-user playback history +4. User management UI +5. Storage location management UI + +### Phase 3: Remote Sources & Import +1. **S3 Storage Location:** + - S3 scanner (list bucket objects) + - Presigned URL streaming + - Import to/from S3 +2. **JellyFin Integration:** + - JellyFin API client + - Sync metadata + - Proxy streaming +3. **Web Directories:** + - HTTP directory parser + - Auth support (basic, bearer) +4. **Import System:** + - VideoImportJob with progress tracking + - Import UI with destination selection + - Background download with resume support +5. **Unified Library View:** + - Filter by source + - Show source badges on videos + - Multi-source search + +### Phase 4: Federation +1. Public API for other Velour instances +2. API key authentication +3. Velour storage location type +4. Federated video discovery +5. Cross-instance streaming + +--- + +## File Organization + +### Local Storage Structure +``` +storage/ +├── assets/ # Active Storage (thumbnails, previews, sprites) +│ └── [active_storage_blobs] +└── tmp/ # Temporary processing files +``` + +### Video Files +- **Local:** Direct filesystem paths (not copied/moved) +- **S3:** Stored in configured bucket +- **Remote:** Referenced by URL, optionally imported to local/S3 + +--- + +## Key Implementation Decisions + +### Storage Flexibility +- Videos are NOT managed by Active Storage +- Local videos: store absolute/relative paths +- S3 videos: store bucket + key +- Remote videos: store source URL + metadata +- Active Storage ONLY for generated assets (thumbnails, etc.) + +### Import Strategy (Phase 3) +1. User selects video from remote source +2. User selects destination (writable storage location) +3. VideoImportJob starts download +4. Progress tracked via Turbo Streams +5. On completion: + - New Video record created (imported: true) + - Linked to same Work as source + - Assets generated + - Original remote video remains linked + +### Unified View +- Single `/videos` index shows all sources +- Filter dropdown: "All Sources", "Local", "S3", "JellyFin", etc. +- Source badge on each video card +- Search across all sources +- Sort by: title, date added, last watched, etc. + +### Streaming Strategy by Source +```ruby +# Local filesystem +send_file video.full_path, type: video.mime_type, disposition: 'inline' + +# S3 +redirect_to s3_client.presigned_url(:get_object, bucket: ..., key: ..., expires_in: 3600) + +# JellyFin +redirect_to "#{jellyfin_url}/Videos/#{video.source_id}/stream?api_key=..." + +# Web directory +# Proxy through Rails with auth headers + +# Velour federation +redirect_to "#{velour_url}/api/v1/federation/videos/#{video.source_id}/stream?api_key=..." +``` + +### Performance Considerations +- Lazy asset generation (only when video viewed) +- S3 presigned URLs (no proxy for large files) +- Caching of metadata and thumbnails +- Cursor-based pagination for large libraries +- Background scanning with incremental updates + +--- + +## Configuration (ENV) + +```bash +# Admin +ADMIN_EMAIL=admin@example.com + +# OIDC (Phase 2) +OIDC_ISSUER=https://auth.example.com +OIDC_CLIENT_ID=velour +OIDC_CLIENT_SECRET=secret + +# Default Storage +DEFAULT_SCAN_PATH=/path/to/videos + +# S3 (optional default) +AWS_REGION=us-east-1 +AWS_ACCESS_KEY_ID=... +AWS_SECRET_ACCESS_KEY=... +AWS_S3_BUCKET=velour-videos + +# Processing +FFMPEG_THREADS=4 +THUMBNAIL_SIZE=1920x1080 +PREVIEW_DURATION=30 +SPRITE_INTERVAL=5 + +# Federation (Phase 4) +VELOUR_API_KEY=secret-key-for-federation +ALLOW_FEDERATION=true +``` + +--- + +## Video.js Implementation (Inspiration from Stash) + +Based on analysis of the Stash application, we'll use: + +- **Video.js v8.x** as the core player +- **Custom plugins** for: + - Resume functionality + - Playback tracking + - Quality/version selector + - VTT thumbnails on seek bar +- **Streaming format support:** + - Direct MP4/MKV streaming with byte-range + - DASH/HLS for adaptive streaming (future) + - Multi-quality source selection + +### Key Features from Stash Worth Implementing: +1. Scene markers on timeline (our "chapters" equivalent) +2. Thumbnail sprite preview on hover +3. Keyboard shortcuts +4. Mobile-optimized controls +5. Resume from last position +6. Play duration and count tracking +7. AirPlay/Chromecast support (future) + +--- + +## Error Handling & Job Configuration + +### Job Retry Strategy + +```ruby +# app/jobs/video_processor_job.rb +class VideoProcessorJob < ApplicationJob + queue_as :default + + # Retry with exponential backoff + retry_on StandardError, wait: :polynomially_longer, attempts: 3 + + # Don't retry if video not found + discard_on ActiveRecord::RecordNotFound do |job, error| + Rails.logger.warn "Video not found for processing: #{error.message}" + end + + def perform(video_id) + video = Video.find(video_id) + + # Extract metadata + result = VideoMetadataExtractor.new(video).call + + return unless result.success? + + # Generate thumbnail (Phase 1C) + ThumbnailGeneratorService.new(video).call + rescue FFMPEG::Error => e + video.mark_processing_failed!(e.message) + raise # Will retry + end +end +``` + +### Background Job Monitoring + +```ruby +# app/controllers/admin/jobs_controller.rb (optional) +module Admin + class JobsController < Admin::BaseController + def index + @running_jobs = SolidQueue::Job.where(finished_at: nil).limit(50) + @failed_jobs = SolidQueue::Job.where.not(error: nil).limit(50) + end + + def retry + job = SolidQueue::Job.find(params[:id]) + job.retry! + redirect_to admin_jobs_path, notice: "Job queued for retry" + end + end +end +``` + +--- + +## Configuration Summary + +### Environment Variables + +```bash +# .env (Phase 1) +DEFAULT_SCAN_PATH=/path/to/your/videos +FFMPEG_THREADS=4 +THUMBNAIL_SIZE=1920x1080 + +# .env (Phase 2) +ADMIN_EMAIL=admin@example.com +OIDC_ISSUER=https://auth.example.com +OIDC_CLIENT_ID=velour +OIDC_CLIENT_SECRET=your-secret + +# .env (Phase 3) +AWS_REGION=us-east-1 +AWS_ACCESS_KEY_ID=your-key +AWS_SECRET_ACCESS_KEY=your-secret +AWS_S3_BUCKET=velour-videos + +# .env (Phase 4) +VELOUR_API_KEY=your-api-key +ALLOW_FEDERATION=true +``` + +### Database Encryption + +```bash +# Generate encryption keys +bin/rails db:encryption:init + +# Add output to config/credentials.yml.enc: +# active_record_encryption: +# primary_key: ... +# deterministic_key: ... +# key_derivation_salt: ... +``` + +--- + +## Implementation Checklist + +### Phase 1A: Core Foundation + +- [ ] Install required gems (`streamio-ffmpeg`, `pagy`) +- [ ] Generate models with proper migrations +- [ ] Implement model validations and associations +- [ ] Create model concerns (Streamable, Processable, Searchable) +- [ ] Build storage adapter pattern (BaseAdapter, LocalAdapter) +- [ ] Implement FileScannerService +- [ ] Create Result object pattern +- [ ] Build videos index page with TailwindCSS +- [ ] Create admin storage locations CRUD +- [ ] Write tests for models and adapters + +### Phase 1B: Video Playback + +- [ ] Create videos#show action with byte-range support +- [ ] Add Video.js via Importmap +- [ ] Build VideoPlayerController (Stimulus) +- [ ] Implement PlaybackSession.update_position +- [ ] Create API endpoint for position tracking +- [ ] Build custom Video.js tracking plugin +- [ ] Implement resume functionality +- [ ] Write system tests for playback + +### Phase 1C: Processing Pipeline + +- [ ] Implement VideoMetadataExtractor service +- [ ] Create VideoProcessorJob with retry logic +- [ ] Build ThumbnailGeneratorService +- [ ] Set up Active Storage for thumbnails +- [ ] Display thumbnails on index page +- [ ] Add processing status indicators +- [ ] Implement retry processing action +- [ ] Write tests for processing services + +### Phase 1D: Works & Grouping + +- [ ] Fully implement Works model +- [ ] Create Works index/show pages +- [ ] Implement DuplicateDetectorService +- [ ] Build WorkGrouperService +- [ ] Create work grouping UI +- [ ] Add version selector on work pages +- [ ] Implement search functionality +- [ ] Add filtering and sorting +- [ ] Integrate Pagy pagination +- [ ] Polish UI with TailwindCSS + +--- + +## Next Steps + +### To Begin Implementation: + +1. **Review this architecture document** with team/stakeholders +2. **Set up development environment:** + - Install FFmpeg (`brew install ffmpeg` on macOS) + - Verify Rails 8.1.1+ installed + - Create new Rails app (already done in `/Users/dkam/Development/velour`) + +3. **Start Phase 1A:** + ```bash + # Add gems + bundle add streamio-ffmpeg pagy aws-sdk-s3 + + # Generate models + rails generate model Work title:string year:integer director:string description:text rating:decimal organized:boolean poster_path:string backdrop_path:string metadata:text + rails generate model StorageLocation name:string path:string location_type:integer writable:boolean enabled:boolean scan_subdirectories:boolean priority:integer settings:text last_scanned_at:datetime + rails generate model Video work:references storage_location:references title:string file_path:string file_hash:string file_size:bigint duration:float width:integer height:integer resolution_label:string video_codec:string audio_codec:string bit_rate:integer frame_rate:float format:string has_subtitles:boolean version_type:string source_type:integer source_url:string imported:boolean processing_failed:boolean error_message:text metadata:text + rails generate model VideoAsset video:references asset_type:integer metadata:text + rails generate model PlaybackSession video:references user:references position:float duration_watched:float last_watched_at:datetime completed:boolean play_count:integer + + # Run migrations + rails db:migrate + + # Start server + bin/dev + ``` + +4. **Follow the Phase 1A checklist** (see above) + +5. **Iterate through Phase 1B, 1C, 1D** + +--- + +## Architecture Decision Records + +Key architectural decisions made: + +1. **SQLite for MVP** - Simple, file-based, perfect for single-user. Migration path to PostgreSQL documented. +2. **Storage Adapter Pattern** - Pluggable backends allow adding S3, JellyFin, etc. without changing core logic. +3. **Service Objects** - Complex business logic extracted from controllers/models for testability. +4. **Hotwire over React** - Server-rendered HTML with Turbo Streams for real-time updates. Less JS complexity. +5. **Video.js** - Proven, extensible, well-documented player with broad format support. +6. **Rails Enums (integers)** - SQLite-compatible, performant, database-friendly. +7. **Active Storage for assets only** - Videos managed by storage adapters, not Active Storage. +8. **Pagy over Kaminari** - Faster, simpler pagination with smaller footprint. +9. **Model-level authorization** - Simple for MVP, easy upgrade path to Pundit/Action Policy. +10. **Phase 1 broken into 4 sub-phases** - Manageable milestones with clear deliverables. + +--- + +## Support & Resources + +- **Rails Guides:** https://guides.rubyonrails.org +- **Hotwire Docs:** https://hotwired.dev +- **Video.js Docs:** https://docs.videojs.com +- **FFmpeg Docs:** https://ffmpeg.org/documentation.html +- **TailwindCSS:** https://tailwindcss.com/docs + +--- + +**Document Version:** 1.0 +**Last Updated:** <%= Time.current.strftime("%Y-%m-%d") %> +**Status:** Ready for Phase 1A Implementation diff --git a/lib/tasks/.keep b/lib/tasks/.keep new file mode 100644 index 0000000..e69de29 diff --git a/log/.keep b/log/.keep new file mode 100644 index 0000000..e69de29 diff --git a/public/400.html b/public/400.html new file mode 100644 index 0000000..640de03 --- /dev/null +++ b/public/400.html @@ -0,0 +1,135 @@ + + + + + + + The server cannot process the request due to a client error (400 Bad Request) + + + + + + + + + + + + + +
+
+ +
+
+

The server cannot process the request due to a client error. Please check the request and try again. If you're the application owner check the logs for more information.

+
+
+ + + + diff --git a/public/404.html b/public/404.html new file mode 100644 index 0000000..d7f0f14 --- /dev/null +++ b/public/404.html @@ -0,0 +1,135 @@ + + + + + + + The page you were looking for doesn't exist (404 Not found) + + + + + + + + + + + + + +
+
+ +
+
+

The page you were looking for doesn't exist. You may have mistyped the address or the page may have moved. If you're the application owner check the logs for more information.

+
+
+ + + + diff --git a/public/406-unsupported-browser.html b/public/406-unsupported-browser.html new file mode 100644 index 0000000..43d2811 --- /dev/null +++ b/public/406-unsupported-browser.html @@ -0,0 +1,135 @@ + + + + + + + Your browser is not supported (406 Not Acceptable) + + + + + + + + + + + + + +
+
+ +
+
+

Your browser is not supported.
Please upgrade your browser to continue.

+
+
+ + + + diff --git a/public/422.html b/public/422.html new file mode 100644 index 0000000..f12fb4a --- /dev/null +++ b/public/422.html @@ -0,0 +1,135 @@ + + + + + + + The change you wanted was rejected (422 Unprocessable Entity) + + + + + + + + + + + + + +
+
+ +
+
+

The change you wanted was rejected. Maybe you tried to change something you didn't have access to. If you're the application owner check the logs for more information.

+
+
+ + + + diff --git a/public/500.html b/public/500.html new file mode 100644 index 0000000..e4eb18a --- /dev/null +++ b/public/500.html @@ -0,0 +1,135 @@ + + + + + + + We're sorry, but something went wrong (500 Internal Server Error) + + + + + + + + + + + + + +
+
+ +
+
+

We're sorry, but something went wrong.
If you're the application owner check the logs for more information.

+
+
+ + + + diff --git a/public/icon.png b/public/icon.png new file mode 100644 index 0000000..c4c9dbf Binary files /dev/null and b/public/icon.png differ diff --git a/public/icon.svg b/public/icon.svg new file mode 100644 index 0000000..04b34bf --- /dev/null +++ b/public/icon.svg @@ -0,0 +1,3 @@ + + + diff --git a/public/robots.txt b/public/robots.txt new file mode 100644 index 0000000..c19f78a --- /dev/null +++ b/public/robots.txt @@ -0,0 +1 @@ +# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file diff --git a/script/.keep b/script/.keep new file mode 100644 index 0000000..e69de29 diff --git a/storage/.keep b/storage/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/application_system_test_case.rb b/test/application_system_test_case.rb new file mode 100644 index 0000000..cee29fd --- /dev/null +++ b/test/application_system_test_case.rb @@ -0,0 +1,5 @@ +require "test_helper" + +class ApplicationSystemTestCase < ActionDispatch::SystemTestCase + driven_by :selenium, using: :headless_chrome, screen_size: [ 1400, 1400 ] +end diff --git a/test/controllers/.keep b/test/controllers/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/fixtures/files/.keep b/test/fixtures/files/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/helpers/.keep b/test/helpers/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/integration/.keep b/test/integration/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/mailers/.keep b/test/mailers/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/models/.keep b/test/models/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/system/.keep b/test/system/.keep new file mode 100644 index 0000000..e69de29 diff --git a/test/test_helper.rb b/test/test_helper.rb new file mode 100644 index 0000000..0c22470 --- /dev/null +++ b/test/test_helper.rb @@ -0,0 +1,15 @@ +ENV["RAILS_ENV"] ||= "test" +require_relative "../config/environment" +require "rails/test_help" + +module ActiveSupport + class TestCase + # Run tests in parallel with specified workers + parallelize(workers: :number_of_processors) + + # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order. + fixtures :all + + # Add more helper methods to be used by all tests here... + end +end diff --git a/tmp/.keep b/tmp/.keep new file mode 100644 index 0000000..e69de29 diff --git a/tmp/pids/.keep b/tmp/pids/.keep new file mode 100644 index 0000000..e69de29 diff --git a/tmp/storage/.keep b/tmp/storage/.keep new file mode 100644 index 0000000..e69de29 diff --git a/vendor/.keep b/vendor/.keep new file mode 100644 index 0000000..e69de29 diff --git a/vendor/javascript/.keep b/vendor/javascript/.keep new file mode 100644 index 0000000..e69de29