From d6dc3d3a3fde1a00d9617cb76e93a47166baa936 Mon Sep 17 00:00:00 2001 From: DaviHVL Date: Sun, 16 Nov 2025 18:29:03 -0300 Subject: [PATCH 1/3] =?UTF-8?q?:sparkles:=20feat:=20adi=C3=A7=C3=A3o=20da?= =?UTF-8?q?=20estrutura=20inicial=20do=20projeto=20rails?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- app/.dockerignore | 51 ++ app/.gitattributes | 9 + app/.github/dependabot.yml | 12 + app/.github/workflows/ci.yml | 124 +++++ app/.gitignore | 38 ++ app/.kamal/hooks/docker-setup.sample | 3 + app/.kamal/hooks/post-app-boot.sample | 3 + app/.kamal/hooks/post-deploy.sample | 14 + app/.kamal/hooks/post-proxy-reboot.sample | 3 + app/.kamal/hooks/pre-app-boot.sample | 3 + app/.kamal/hooks/pre-build.sample | 51 ++ app/.kamal/hooks/pre-connect.sample | 47 ++ app/.kamal/hooks/pre-deploy.sample | 122 +++++ app/.kamal/hooks/pre-proxy-reboot.sample | 3 + app/.kamal/secrets | 20 + app/.rubocop.yml | 8 + app/.ruby-version | 1 + app/Dockerfile | 76 +++ app/Gemfile | 68 +++ app/Gemfile.lock | 434 ++++++++++++++++++ app/Procfile.dev | 2 + app/README.md | 24 + app/Rakefile | 6 + app/app/assets/builds/.keep | 0 app/app/assets/images/.keep | 0 app/app/assets/stylesheets/application.css | 10 + app/app/assets/tailwind/application.css | 1 + app/app/controllers/application_controller.rb | 7 + app/app/controllers/concerns/.keep | 0 app/app/helpers/application_helper.rb | 2 + app/app/javascript/application.js | 3 + app/app/javascript/controllers/application.js | 9 + .../controllers/hello_controller.js | 7 + app/app/javascript/controllers/index.js | 4 + app/app/jobs/application_job.rb | 7 + app/app/mailers/application_mailer.rb | 4 + app/app/models/application_record.rb | 3 + app/app/models/concerns/.keep | 0 app/app/views/layouts/application.html.erb | 31 ++ app/app/views/layouts/mailer.html.erb | 13 + app/app/views/layouts/mailer.text.erb | 1 + app/app/views/pwa/manifest.json.erb | 22 + app/app/views/pwa/service-worker.js | 26 ++ app/bin/brakeman | 7 + app/bin/bundler-audit | 6 + app/bin/ci | 6 + app/bin/dev | 16 + app/bin/docker-entrypoint | 8 + app/bin/importmap | 4 + app/bin/jobs | 6 + app/bin/kamal | 27 ++ app/bin/rails | 4 + app/bin/rake | 4 + app/bin/rubocop | 8 + app/bin/setup | 35 ++ app/bin/thrust | 5 + app/config.ru | 6 + app/config/application.rb | 27 ++ app/config/boot.rb | 4 + app/config/bundler-audit.yml | 5 + app/config/cable.yml | 17 + app/config/cache.yml | 16 + app/config/ci.rb | 23 + app/config/credentials.yml.enc | 1 + app/config/database.yml | 41 ++ app/config/deploy.yml | 120 +++++ app/config/environment.rb | 5 + app/config/environments/development.rb | 78 ++++ app/config/environments/production.rb | 90 ++++ app/config/environments/test.rb | 53 +++ app/config/importmap.rb | 7 + app/config/initializers/assets.rb | 7 + .../initializers/content_security_policy.rb | 29 ++ .../initializers/filter_parameter_logging.rb | 8 + app/config/initializers/inflections.rb | 16 + app/config/locales/en.yml | 31 ++ app/config/puma.rb | 42 ++ app/config/queue.yml | 18 + app/config/recurring.yml | 15 + app/config/routes.rb | 14 + app/config/storage.yml | 27 ++ app/db/cable_schema.rb | 11 + app/db/cache_schema.rb | 12 + app/db/queue_schema.rb | 129 ++++++ app/db/seeds.rb | 9 + app/lib/tasks/.keep | 0 app/log/.keep | 0 app/public/400.html | 135 ++++++ app/public/404.html | 135 ++++++ app/public/406-unsupported-browser.html | 135 ++++++ app/public/422.html | 135 ++++++ app/public/500.html | 135 ++++++ app/public/icon.png | Bin 0 -> 4166 bytes app/public/icon.svg | 3 + app/public/robots.txt | 1 + app/script/.keep | 0 app/storage/.keep | 0 app/test/application_system_test_case.rb | 5 + app/test/controllers/.keep | 0 app/test/fixtures/files/.keep | 0 app/test/helpers/.keep | 0 app/test/integration/.keep | 0 app/test/mailers/.keep | 0 app/test/models/.keep | 0 app/test/system/.keep | 0 app/test/test_helper.rb | 15 + app/tmp/.keep | 0 app/tmp/pids/.keep | 0 app/tmp/storage/.keep | 0 app/vendor/.keep | 0 app/vendor/javascript/.keep | 0 111 files changed, 2968 insertions(+) create mode 100644 app/.dockerignore create mode 100644 app/.gitattributes create mode 100644 app/.github/dependabot.yml create mode 100644 app/.github/workflows/ci.yml create mode 100644 app/.gitignore create mode 100644 app/.kamal/hooks/docker-setup.sample create mode 100644 app/.kamal/hooks/post-app-boot.sample create mode 100644 app/.kamal/hooks/post-deploy.sample create mode 100644 app/.kamal/hooks/post-proxy-reboot.sample create mode 100644 app/.kamal/hooks/pre-app-boot.sample create mode 100644 app/.kamal/hooks/pre-build.sample create mode 100644 app/.kamal/hooks/pre-connect.sample create mode 100644 app/.kamal/hooks/pre-deploy.sample create mode 100644 app/.kamal/hooks/pre-proxy-reboot.sample create mode 100644 app/.kamal/secrets create mode 100644 app/.rubocop.yml create mode 100644 app/.ruby-version create mode 100644 app/Dockerfile create mode 100644 app/Gemfile create mode 100644 app/Gemfile.lock create mode 100644 app/Procfile.dev create mode 100644 app/README.md create mode 100644 app/Rakefile create mode 100644 app/app/assets/builds/.keep create mode 100644 app/app/assets/images/.keep create mode 100644 app/app/assets/stylesheets/application.css create mode 100644 app/app/assets/tailwind/application.css create mode 100644 app/app/controllers/application_controller.rb create mode 100644 app/app/controllers/concerns/.keep create mode 100644 app/app/helpers/application_helper.rb create mode 100644 app/app/javascript/application.js create mode 100644 app/app/javascript/controllers/application.js create mode 100644 app/app/javascript/controllers/hello_controller.js create mode 100644 app/app/javascript/controllers/index.js create mode 100644 app/app/jobs/application_job.rb create mode 100644 app/app/mailers/application_mailer.rb create mode 100644 app/app/models/application_record.rb create mode 100644 app/app/models/concerns/.keep create mode 100644 app/app/views/layouts/application.html.erb create mode 100644 app/app/views/layouts/mailer.html.erb create mode 100644 app/app/views/layouts/mailer.text.erb create mode 100644 app/app/views/pwa/manifest.json.erb create mode 100644 app/app/views/pwa/service-worker.js create mode 100644 app/bin/brakeman create mode 100644 app/bin/bundler-audit create mode 100644 app/bin/ci create mode 100644 app/bin/dev create mode 100644 app/bin/docker-entrypoint create mode 100644 app/bin/importmap create mode 100644 app/bin/jobs create mode 100644 app/bin/kamal create mode 100644 app/bin/rails create mode 100644 app/bin/rake create mode 100644 app/bin/rubocop create mode 100644 app/bin/setup create mode 100644 app/bin/thrust create mode 100644 app/config.ru create mode 100644 app/config/application.rb create mode 100644 app/config/boot.rb create mode 100644 app/config/bundler-audit.yml create mode 100644 app/config/cable.yml create mode 100644 app/config/cache.yml create mode 100644 app/config/ci.rb create mode 100644 app/config/credentials.yml.enc create mode 100644 app/config/database.yml create mode 100644 app/config/deploy.yml create mode 100644 app/config/environment.rb create mode 100644 app/config/environments/development.rb create mode 100644 app/config/environments/production.rb create mode 100644 app/config/environments/test.rb create mode 100644 app/config/importmap.rb create mode 100644 app/config/initializers/assets.rb create mode 100644 app/config/initializers/content_security_policy.rb create mode 100644 app/config/initializers/filter_parameter_logging.rb create mode 100644 app/config/initializers/inflections.rb create mode 100644 app/config/locales/en.yml create mode 100644 app/config/puma.rb create mode 100644 app/config/queue.yml create mode 100644 app/config/recurring.yml create mode 100644 app/config/routes.rb create mode 100644 app/config/storage.yml create mode 100644 app/db/cable_schema.rb create mode 100644 app/db/cache_schema.rb create mode 100644 app/db/queue_schema.rb create mode 100644 app/db/seeds.rb create mode 100644 app/lib/tasks/.keep create mode 100644 app/log/.keep create mode 100644 app/public/400.html create mode 100644 app/public/404.html create mode 100644 app/public/406-unsupported-browser.html create mode 100644 app/public/422.html create mode 100644 app/public/500.html create mode 100644 app/public/icon.png create mode 100644 app/public/icon.svg create mode 100644 app/public/robots.txt create mode 100644 app/script/.keep create mode 100644 app/storage/.keep create mode 100644 app/test/application_system_test_case.rb create mode 100644 app/test/controllers/.keep create mode 100644 app/test/fixtures/files/.keep create mode 100644 app/test/helpers/.keep create mode 100644 app/test/integration/.keep create mode 100644 app/test/mailers/.keep create mode 100644 app/test/models/.keep create mode 100644 app/test/system/.keep create mode 100644 app/test/test_helper.rb create mode 100644 app/tmp/.keep create mode 100644 app/tmp/pids/.keep create mode 100644 app/tmp/storage/.keep create mode 100644 app/vendor/.keep create mode 100644 app/vendor/javascript/.keep diff --git a/app/.dockerignore b/app/.dockerignore new file mode 100644 index 0000000000..325bfc036d --- /dev/null +++ b/app/.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/app/.gitattributes b/app/.gitattributes new file mode 100644 index 0000000000..8dc4323435 --- /dev/null +++ b/app/.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/app/.github/dependabot.yml b/app/.github/dependabot.yml new file mode 100644 index 0000000000..83610cfa4c --- /dev/null +++ b/app/.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/app/.github/workflows/ci.yml b/app/.github/workflows/ci.yml new file mode 100644 index 0000000000..4adf8d4f8b --- /dev/null +++ b/app/.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/app/.gitignore b/app/.gitignore new file mode 100644 index 0000000000..e953825f71 --- /dev/null +++ b/app/.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/app/.kamal/hooks/docker-setup.sample b/app/.kamal/hooks/docker-setup.sample new file mode 100644 index 0000000000..2fb07d7d7a --- /dev/null +++ b/app/.kamal/hooks/docker-setup.sample @@ -0,0 +1,3 @@ +#!/bin/sh + +echo "Docker set up on $KAMAL_HOSTS..." diff --git a/app/.kamal/hooks/post-app-boot.sample b/app/.kamal/hooks/post-app-boot.sample new file mode 100644 index 0000000000..70f9c4bc95 --- /dev/null +++ b/app/.kamal/hooks/post-app-boot.sample @@ -0,0 +1,3 @@ +#!/bin/sh + +echo "Booted app version $KAMAL_VERSION on $KAMAL_HOSTS..." diff --git a/app/.kamal/hooks/post-deploy.sample b/app/.kamal/hooks/post-deploy.sample new file mode 100644 index 0000000000..fd364c2a77 --- /dev/null +++ b/app/.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/app/.kamal/hooks/post-proxy-reboot.sample b/app/.kamal/hooks/post-proxy-reboot.sample new file mode 100644 index 0000000000..1435a677f2 --- /dev/null +++ b/app/.kamal/hooks/post-proxy-reboot.sample @@ -0,0 +1,3 @@ +#!/bin/sh + +echo "Rebooted kamal-proxy on $KAMAL_HOSTS" diff --git a/app/.kamal/hooks/pre-app-boot.sample b/app/.kamal/hooks/pre-app-boot.sample new file mode 100644 index 0000000000..45f7355045 --- /dev/null +++ b/app/.kamal/hooks/pre-app-boot.sample @@ -0,0 +1,3 @@ +#!/bin/sh + +echo "Booting app version $KAMAL_VERSION on $KAMAL_HOSTS..." diff --git a/app/.kamal/hooks/pre-build.sample b/app/.kamal/hooks/pre-build.sample new file mode 100644 index 0000000000..c5a55678b2 --- /dev/null +++ b/app/.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/app/.kamal/hooks/pre-connect.sample b/app/.kamal/hooks/pre-connect.sample new file mode 100644 index 0000000000..77744bdca8 --- /dev/null +++ b/app/.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/app/.kamal/hooks/pre-deploy.sample b/app/.kamal/hooks/pre-deploy.sample new file mode 100644 index 0000000000..05b3055b72 --- /dev/null +++ b/app/.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/app/.kamal/hooks/pre-proxy-reboot.sample b/app/.kamal/hooks/pre-proxy-reboot.sample new file mode 100644 index 0000000000..061f8059e6 --- /dev/null +++ b/app/.kamal/hooks/pre-proxy-reboot.sample @@ -0,0 +1,3 @@ +#!/bin/sh + +echo "Rebooting kamal-proxy on $KAMAL_HOSTS..." diff --git a/app/.kamal/secrets b/app/.kamal/secrets new file mode 100644 index 0000000000..b3089d6f5a --- /dev/null +++ b/app/.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/app/.rubocop.yml b/app/.rubocop.yml new file mode 100644 index 0000000000..f9d86d4a54 --- /dev/null +++ b/app/.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/app/.ruby-version b/app/.ruby-version new file mode 100644 index 0000000000..5f6fc5edc2 --- /dev/null +++ b/app/.ruby-version @@ -0,0 +1 @@ +3.3.10 diff --git a/app/Dockerfile b/app/Dockerfile new file mode 100644 index 0000000000..cb471caad7 --- /dev/null +++ b/app/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 app . +# docker run -d -p 80:80 -e RAILS_MASTER_KEY= --name app app + +# 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.3.10 +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/app/Gemfile b/app/Gemfile new file mode 100644 index 0000000000..d2334c4cc0 --- /dev/null +++ b/app/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/app/Gemfile.lock b/app/Gemfile.lock new file mode 100644 index 0000000000..15e51e6b0c --- /dev/null +++ b/app/Gemfile.lock @@ -0,0 +1,434 @@ +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) + bcrypt_pbkdf (1.1.1-arm64-darwin) + bcrypt_pbkdf (1.1.1-x86_64-darwin) + bigdecimal (3.3.1) + bindex (0.8.1) + bootsnap (1.19.0) + msgpack (~> 1.2) + brakeman (7.1.1) + 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.5.0) + debug (1.11.0) + irb (~> 1.10) + reline (>= 0.3.8) + dotenv (3.1.8) + drb (2.2.3) + ed25519 (1.4.0) + erb (6.0.0) + 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-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.3) + 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.16.0) + 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.1) + 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.5) + 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-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.4) + 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.1) + rdoc (6.15.1) + erb + psych (>= 4.0.0) + tsort + regexp_parser (2.11.3) + reline (0.6.3) + io-console (~> 0.5) + rexml (3.4.4) + rubocop (1.81.7) + 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.48.0) + 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.34.0) + 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.2) + 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.10) + activejob (>= 7.2) + activerecord (>= 7.2) + railties (>= 7.2) + solid_queue (1.2.4) + activejob (>= 7.1) + activerecord (>= 7.1) + concurrent-ruby (>= 1.3.1) + fugit (~> 1.11) + railties (>= 7.1) + thor (>= 1.3.1) + sqlite3 (2.8.0-aarch64-linux-gnu) + sqlite3 (2.8.0-aarch64-linux-musl) + sqlite3 (2.8.0-arm-linux-gnu) + sqlite3 (2.8.0-arm-linux-musl) + sqlite3 (2.8.0-arm64-darwin) + sqlite3 (2.8.0-x86_64-darwin) + sqlite3 (2.8.0-x86_64-linux-gnu) + sqlite3 (2.8.0-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.8) + 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-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-darwin) + thruster (0.1.16-x86_64-linux) + timeout (0.4.4) + 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.1.1) + 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 + x86_64-darwin + 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.5.22 diff --git a/app/Procfile.dev b/app/Procfile.dev new file mode 100644 index 0000000000..da151fee94 --- /dev/null +++ b/app/Procfile.dev @@ -0,0 +1,2 @@ +web: bin/rails server +css: bin/rails tailwindcss:watch diff --git a/app/README.md b/app/README.md new file mode 100644 index 0000000000..7db80e4ca1 --- /dev/null +++ b/app/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/app/Rakefile b/app/Rakefile new file mode 100644 index 0000000000..9a5ea7383a --- /dev/null +++ b/app/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/app/assets/builds/.keep b/app/app/assets/builds/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/app/assets/images/.keep b/app/app/assets/images/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/app/assets/stylesheets/application.css b/app/app/assets/stylesheets/application.css new file mode 100644 index 0000000000..fe93333c0f --- /dev/null +++ b/app/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/app/assets/tailwind/application.css b/app/app/assets/tailwind/application.css new file mode 100644 index 0000000000..f1d8c73cdc --- /dev/null +++ b/app/app/assets/tailwind/application.css @@ -0,0 +1 @@ +@import "tailwindcss"; diff --git a/app/app/controllers/application_controller.rb b/app/app/controllers/application_controller.rb new file mode 100644 index 0000000000..c3537563da --- /dev/null +++ b/app/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/app/controllers/concerns/.keep b/app/app/controllers/concerns/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/app/helpers/application_helper.rb b/app/app/helpers/application_helper.rb new file mode 100644 index 0000000000..de6be7945c --- /dev/null +++ b/app/app/helpers/application_helper.rb @@ -0,0 +1,2 @@ +module ApplicationHelper +end diff --git a/app/app/javascript/application.js b/app/app/javascript/application.js new file mode 100644 index 0000000000..0d7b49404c --- /dev/null +++ b/app/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/app/javascript/controllers/application.js b/app/app/javascript/controllers/application.js new file mode 100644 index 0000000000..1213e85c7a --- /dev/null +++ b/app/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/app/javascript/controllers/hello_controller.js b/app/app/javascript/controllers/hello_controller.js new file mode 100644 index 0000000000..5975c0789d --- /dev/null +++ b/app/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/app/javascript/controllers/index.js b/app/app/javascript/controllers/index.js new file mode 100644 index 0000000000..1156bf8362 --- /dev/null +++ b/app/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/app/jobs/application_job.rb b/app/app/jobs/application_job.rb new file mode 100644 index 0000000000..d394c3d106 --- /dev/null +++ b/app/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/app/mailers/application_mailer.rb b/app/app/mailers/application_mailer.rb new file mode 100644 index 0000000000..3c34c8148f --- /dev/null +++ b/app/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/app/models/application_record.rb b/app/app/models/application_record.rb new file mode 100644 index 0000000000..b63caeb8a5 --- /dev/null +++ b/app/app/models/application_record.rb @@ -0,0 +1,3 @@ +class ApplicationRecord < ActiveRecord::Base + primary_abstract_class +end diff --git a/app/app/models/concerns/.keep b/app/app/models/concerns/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/app/views/layouts/application.html.erb b/app/app/views/layouts/application.html.erb new file mode 100644 index 0000000000..f3e935a25c --- /dev/null +++ b/app/app/views/layouts/application.html.erb @@ -0,0 +1,31 @@ + + + + <%= content_for(:title) || "App" %> + + + + + <%= 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/app/views/layouts/mailer.html.erb b/app/app/views/layouts/mailer.html.erb new file mode 100644 index 0000000000..3aac9002ed --- /dev/null +++ b/app/app/views/layouts/mailer.html.erb @@ -0,0 +1,13 @@ + + + + + + + + + <%= yield %> + + diff --git a/app/app/views/layouts/mailer.text.erb b/app/app/views/layouts/mailer.text.erb new file mode 100644 index 0000000000..37f0bddbd7 --- /dev/null +++ b/app/app/views/layouts/mailer.text.erb @@ -0,0 +1 @@ +<%= yield %> diff --git a/app/app/views/pwa/manifest.json.erb b/app/app/views/pwa/manifest.json.erb new file mode 100644 index 0000000000..c295730cd4 --- /dev/null +++ b/app/app/views/pwa/manifest.json.erb @@ -0,0 +1,22 @@ +{ + "name": "App", + "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": "App.", + "theme_color": "red", + "background_color": "red" +} diff --git a/app/app/views/pwa/service-worker.js b/app/app/views/pwa/service-worker.js new file mode 100644 index 0000000000..b3a13fb7bb --- /dev/null +++ b/app/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/app/bin/brakeman b/app/bin/brakeman new file mode 100644 index 0000000000..ace1c9ba08 --- /dev/null +++ b/app/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/app/bin/bundler-audit b/app/bin/bundler-audit new file mode 100644 index 0000000000..e2ef22690c --- /dev/null +++ b/app/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/app/bin/ci b/app/bin/ci new file mode 100644 index 0000000000..4137ad5bb0 --- /dev/null +++ b/app/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/app/bin/dev b/app/bin/dev new file mode 100644 index 0000000000..ad72c7d53c --- /dev/null +++ b/app/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/app/bin/docker-entrypoint b/app/bin/docker-entrypoint new file mode 100644 index 0000000000..ed31659f40 --- /dev/null +++ b/app/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/app/bin/importmap b/app/bin/importmap new file mode 100644 index 0000000000..36502ab16c --- /dev/null +++ b/app/bin/importmap @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby + +require_relative "../config/application" +require "importmap/commands" diff --git a/app/bin/jobs b/app/bin/jobs new file mode 100644 index 0000000000..dcf59f309a --- /dev/null +++ b/app/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/app/bin/kamal b/app/bin/kamal new file mode 100644 index 0000000000..cbe59b95ed --- /dev/null +++ b/app/bin/kamal @@ -0,0 +1,27 @@ +#!/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__) + +bundle_binstub = File.expand_path("bundle", __dir__) + +if File.file?(bundle_binstub) + if File.read(bundle_binstub, 300).include?("This file was generated by Bundler") + load(bundle_binstub) + else + abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run. +Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.") + end +end + +require "rubygems" +require "bundler/setup" + +load Gem.bin_path("kamal", "kamal") diff --git a/app/bin/rails b/app/bin/rails new file mode 100644 index 0000000000..efc0377492 --- /dev/null +++ b/app/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/app/bin/rake b/app/bin/rake new file mode 100644 index 0000000000..4fbf10b960 --- /dev/null +++ b/app/bin/rake @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby +require_relative "../config/boot" +require "rake" +Rake.application.run diff --git a/app/bin/rubocop b/app/bin/rubocop new file mode 100644 index 0000000000..5a20504716 --- /dev/null +++ b/app/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/app/bin/setup b/app/bin/setup new file mode 100644 index 0000000000..81be011e87 --- /dev/null +++ b/app/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/app/bin/thrust b/app/bin/thrust new file mode 100644 index 0000000000..36bde2d832 --- /dev/null +++ b/app/bin/thrust @@ -0,0 +1,5 @@ +#!/usr/bin/env ruby +require "rubygems" +require "bundler/setup" + +load Gem.bin_path("thruster", "thrust") diff --git a/app/config.ru b/app/config.ru new file mode 100644 index 0000000000..4a3c09a688 --- /dev/null +++ b/app/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/app/config/application.rb b/app/config/application.rb new file mode 100644 index 0000000000..a7c0e56c69 --- /dev/null +++ b/app/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 App + 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/app/config/boot.rb b/app/config/boot.rb new file mode 100644 index 0000000000..988a5ddc46 --- /dev/null +++ b/app/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/app/config/bundler-audit.yml b/app/config/bundler-audit.yml new file mode 100644 index 0000000000..e74b3af949 --- /dev/null +++ b/app/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/app/config/cable.yml b/app/config/cable.yml new file mode 100644 index 0000000000..b9adc5aa3a --- /dev/null +++ b/app/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/app/config/cache.yml b/app/config/cache.yml new file mode 100644 index 0000000000..19d490843b --- /dev/null +++ b/app/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/app/config/ci.rb b/app/config/ci.rb new file mode 100644 index 0000000000..e56a92e418 --- /dev/null +++ b/app/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/app/config/credentials.yml.enc b/app/config/credentials.yml.enc new file mode 100644 index 0000000000..0c92eb88c7 --- /dev/null +++ b/app/config/credentials.yml.enc @@ -0,0 +1 @@ +MTfpXCotsLi/o4SRIqzhTAZKU0CzJ326fPWJIFdlP60Ci2l2b7e/WmPANbuEsdop4Y/KfCY+mbPVEEY/zc9DkxopxAlRBxO5q0LTvr4fZZRP5+jwUBlY0eJBeSVWYnCMu8TR4C5A0I2iH9BSgKHPCExrPlTtkcb9tLZfWOOXJGkyg+ppdDaDh40uy9thds80CLBy0hybd3VYuoipsIH69kfnZ92kY2DoDrPdFbA0/eIUIGRZYjRRzO+O49VpU1hm1/K7v30tsUvVk/Mw79HSvtqJphR7+nx2AaaaZb9wGZg2kba7xlI8Ub1yqQPJRdAVrwKQcpWnEjtZKKt8D8Z6SFnvkfy3zlDE7NXGf3wGtIxuvCf8w+KA4D9dzscKO4KotsrRBZjY3iXSMtw7s0Uen1DVfTcX76ihPijxjgj+tTPIPsmBGEn3a3yl4j4Itvhm0/fSwVOLkKcCsN2/DUVojzYhSTNUjF+YTBENoO6EQ4uln0V1Hzzptr0V--qk9HAtHwYlFpp7nz--nceolNR7jFvtesZLazdbLg== \ No newline at end of file diff --git a/app/config/database.yml b/app/config/database.yml new file mode 100644 index 0000000000..693252b7c3 --- /dev/null +++ b/app/config/database.yml @@ -0,0 +1,41 @@ +# 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: + <<: *default + database: storage/development.sqlite3 + +# 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/app/config/deploy.yml b/app/config/deploy.yml new file mode 100644 index 0000000000..92e0aacd7f --- /dev/null +++ b/app/config/deploy.yml @@ -0,0 +1,120 @@ +# Name of your application. Used to uniquely configure containers. +service: app + +# Name of the container image (use your-user/app-name on external registries). +image: app + +# 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 app-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: + - "app_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.3.10 + # 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/app/config/environment.rb b/app/config/environment.rb new file mode 100644 index 0000000000..cac5315775 --- /dev/null +++ b/app/config/environment.rb @@ -0,0 +1,5 @@ +# Load the Rails application. +require_relative "application" + +# Initialize the Rails application. +Rails.application.initialize! diff --git a/app/config/environments/development.rb b/app/config/environments/development.rb new file mode 100644 index 0000000000..75243c3d0f --- /dev/null +++ b/app/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/app/config/environments/production.rb b/app/config/environments/production.rb new file mode 100644 index 0000000000..f5763e04e5 --- /dev/null +++ b/app/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/app/config/environments/test.rb b/app/config/environments/test.rb new file mode 100644 index 0000000000..c2095b1174 --- /dev/null +++ b/app/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/app/config/importmap.rb b/app/config/importmap.rb new file mode 100644 index 0000000000..909dfc542d --- /dev/null +++ b/app/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/app/config/initializers/assets.rb b/app/config/initializers/assets.rb new file mode 100644 index 0000000000..487324424f --- /dev/null +++ b/app/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/app/config/initializers/content_security_policy.rb b/app/config/initializers/content_security_policy.rb new file mode 100644 index 0000000000..d51d713979 --- /dev/null +++ b/app/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/app/config/initializers/filter_parameter_logging.rb b/app/config/initializers/filter_parameter_logging.rb new file mode 100644 index 0000000000..c0b717f7ec --- /dev/null +++ b/app/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/app/config/initializers/inflections.rb b/app/config/initializers/inflections.rb new file mode 100644 index 0000000000..3860f659ea --- /dev/null +++ b/app/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/app/config/locales/en.yml b/app/config/locales/en.yml new file mode 100644 index 0000000000..6c349ae5e3 --- /dev/null +++ b/app/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/app/config/puma.rb b/app/config/puma.rb new file mode 100644 index 0000000000..38c4b86596 --- /dev/null +++ b/app/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/app/config/queue.yml b/app/config/queue.yml new file mode 100644 index 0000000000..9eace59c41 --- /dev/null +++ b/app/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/app/config/recurring.yml b/app/config/recurring.yml new file mode 100644 index 0000000000..b4207f9b07 --- /dev/null +++ b/app/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/app/config/routes.rb b/app/config/routes.rb new file mode 100644 index 0000000000..48254e88ed --- /dev/null +++ b/app/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/app/config/storage.yml b/app/config/storage.yml new file mode 100644 index 0000000000..927dc537c8 --- /dev/null +++ b/app/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/app/db/cable_schema.rb b/app/db/cable_schema.rb new file mode 100644 index 0000000000..23666604a5 --- /dev/null +++ b/app/db/cable_schema.rb @@ -0,0 +1,11 @@ +ActiveRecord::Schema[7.1].define(version: 1) do + create_table "solid_cable_messages", force: :cascade do |t| + t.binary "channel", limit: 1024, null: false + t.binary "payload", limit: 536870912, null: false + t.datetime "created_at", null: false + t.integer "channel_hash", limit: 8, 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/app/db/cache_schema.rb b/app/db/cache_schema.rb new file mode 100644 index 0000000000..81a410d188 --- /dev/null +++ b/app/db/cache_schema.rb @@ -0,0 +1,12 @@ +ActiveRecord::Schema[7.2].define(version: 1) do + create_table "solid_cache_entries", force: :cascade do |t| + t.binary "key", limit: 1024, null: false + t.binary "value", limit: 536870912, null: false + t.datetime "created_at", null: false + t.integer "key_hash", limit: 8, null: false + t.integer "byte_size", limit: 4, 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/app/db/queue_schema.rb b/app/db/queue_schema.rb new file mode 100644 index 0000000000..85194b6a88 --- /dev/null +++ b/app/db/queue_schema.rb @@ -0,0 +1,129 @@ +ActiveRecord::Schema[7.1].define(version: 1) do + create_table "solid_queue_blocked_executions", force: :cascade do |t| + t.bigint "job_id", null: false + t.string "queue_name", null: false + t.integer "priority", default: 0, null: false + t.string "concurrency_key", null: false + t.datetime "expires_at", null: false + t.datetime "created_at", 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.bigint "job_id", null: false + t.bigint "process_id" + t.datetime "created_at", null: false + 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.bigint "job_id", null: false + t.text "error" + t.datetime "created_at", 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 "queue_name", null: false + t.string "class_name", null: false + t.text "arguments" + t.integer "priority", default: 0, null: false + t.string "active_job_id" + t.datetime "scheduled_at" + t.datetime "finished_at" + t.string "concurrency_key" + t.datetime "created_at", null: false + 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.string "queue_name", null: false + t.datetime "created_at", 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.string "kind", null: false + t.datetime "last_heartbeat_at", null: false + t.bigint "supervisor_id" + t.integer "pid", null: false + t.string "hostname" + t.text "metadata" + t.datetime "created_at", null: false + t.string "name", null: false + 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.bigint "job_id", null: false + t.string "queue_name", null: false + t.integer "priority", default: 0, null: false + t.datetime "created_at", 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.bigint "job_id", null: false + t.string "task_key", null: false + t.datetime "run_at", null: false + t.datetime "created_at", 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.string "key", null: false + t.string "schedule", null: false + t.string "command", limit: 2048 + t.string "class_name" + t.text "arguments" + t.string "queue_name" + t.integer "priority", default: 0 + t.boolean "static", default: true, null: false + t.text "description" + t.datetime "created_at", 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.bigint "job_id", null: false + t.string "queue_name", null: false + t.integer "priority", default: 0, null: false + t.datetime "scheduled_at", null: false + t.datetime "created_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.string "key", null: false + t.integer "value", default: 1, null: false + t.datetime "expires_at", null: false + t.datetime "created_at", null: false + t.datetime "updated_at", 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/app/db/seeds.rb b/app/db/seeds.rb new file mode 100644 index 0000000000..4fbd6ed970 --- /dev/null +++ b/app/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/app/lib/tasks/.keep b/app/lib/tasks/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/log/.keep b/app/log/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/public/400.html b/app/public/400.html new file mode 100644 index 0000000000..640de03397 --- /dev/null +++ b/app/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/app/public/404.html b/app/public/404.html new file mode 100644 index 0000000000..d7f0f14222 --- /dev/null +++ b/app/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/app/public/406-unsupported-browser.html b/app/public/406-unsupported-browser.html new file mode 100644 index 0000000000..43d2811e8c --- /dev/null +++ b/app/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/app/public/422.html b/app/public/422.html new file mode 100644 index 0000000000..f12fb4aa17 --- /dev/null +++ b/app/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/app/public/500.html b/app/public/500.html new file mode 100644 index 0000000000..e4eb18a759 --- /dev/null +++ b/app/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/app/public/icon.png b/app/public/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..c4c9dbfbbd2f7c1421ffd5727188146213abbcef GIT binary patch literal 4166 zcmd6qU;WFw?|v@m)Sk^&NvB8tcujdV-r1b=i(NJxn&7{KTb zX$3(M+3TP2o^#KAo{#tIjl&t~(8D-k004kqPglzn0HFG(Q~(I*AKsD#M*g7!XK0T7 zN6P7j>HcT8rZgKl$v!xr806dyN19Bd4C0x_R*I-a?#zsTvb_89cyhuC&T**i|Rc zq5b8M;+{8KvoJ~uj9`u~d_f6`V&3+&ZX9x5pc8s)d175;@pjm(?dapmBcm0&vl9+W zx1ZD2o^nuyUHWj|^A8r>lUorO`wFF;>9XL-Jy!P}UXC{(z!FO%SH~8k`#|9;Q|eue zqWL0^Bp(fg_+Pkm!fDKRSY;+^@BF?AJE zCUWpXPst~hi_~u)SzYBDZroR+Z4xeHIlm_3Yc_9nZ(o_gg!jDgVa=E}Y8uDgem9`b zf=mfJ_@(BXSkW53B)F2s!&?_R4ptb1fYXlF++@vPhd=marQgEGRZS@B4g1Mu?euknL= z67P~tZ?*>-Hmi7GwlisNHHJDku-dSm7g@!=a}9cSL6Pa^w^2?&?$Oi8ibrr>w)xqx zOH_EMU@m05)9kuNR>>4@H%|){U$^yvVQ(YgOlh;5oU_-vivG-p4=LrN-k7D?*?u1u zsWly%tfAzKd6Fb=`eU2un_uaTXmcT#tlOL+aRS=kZZf}A7qT8lvcTx~7j` z*b>=z)mwg7%B2_!D0!1IZ?Nq{^Y$uI4Qx*6T!E2Col&2{k?ImCO=dD~A&9f9diXy^$x{6CwkBimn|1E09 zAMSezYtiL?O6hS37KpvDM?22&d{l)7h-!F)C-d3j8Z`c@($?mfd{R82)H>Qe`h{~G z!I}(2j(|49{LR?w4Jspl_i!(4T{31|dqCOpI52r5NhxYV+cDAu(xp*4iqZ2e-$YP= zoFOPmm|u*7C?S{Fp43y+V;>~@FFR76bCl@pTtyB93vNWy5yf;HKr8^0d7&GVIslYm zo3Tgt@M!`8B6IW&lK{Xk>%zp41G%`(DR&^u z5^pwD4>E6-w<8Kl2DzJ%a@~QDE$(e87lNhy?-Qgep!$b?5f7+&EM7$e>|WrX+=zCb z=!f5P>MxFyy;mIRxjc(H*}mceXw5a*IpC0PEYJ8Y3{JdoIW)@t97{wcUB@u+$FCCO z;s2Qe(d~oJC^`m$7DE-dsha`glrtu&v&93IZadvl_yjp!c89>zo;Krk+d&DEG4?x$ zufC1n+c1XD7dolX1q|7}uelR$`pT0Z)1jun<39$Sn2V5g&|(j~Z!wOddfYiZo7)A< z!dK`aBHOOk+-E_xbWCA3VR-+o$i5eO9`rMI#p_0xQ}rjEpGW;U!&&PKnivOcG(|m9 z!C8?WC6nCXw25WVa*eew)zQ=h45k8jSIPbq&?VE{oG%?4>9rwEeB4&qe#?-y_es4c|7ufw%+H5EY#oCgv!Lzv291#-oNlX~X+Jl5(riC~r z=0M|wMOP)Tt8@hNg&%V@Z9@J|Q#K*hE>sr6@oguas9&6^-=~$*2Gs%h#GF@h)i=Im z^iKk~ipWJg1VrvKS;_2lgs3n1zvNvxb27nGM=NXE!D4C!U`f*K2B@^^&ij9y}DTLB*FI zEnBL6y{jc?JqXWbkIZd7I16hA>(f9T!iwbIxJj~bKPfrO;>%*5nk&Lf?G@c2wvGrY&41$W{7HM9+b@&XY@>NZM5s|EK_Dp zQX60CBuantx>|d#DsaZ*8MW(we|#KTYZ=vNa#d*DJQe6hr~J6{_rI#?wi@s|&O}FR zG$kfPxheXh1?IZ{bDT-CWB4FTvO-k5scW^mi8?iY5Q`f8JcnnCxiy@m@D-%lO;y0pTLhh6i6l@x52j=#^$5_U^os}OFg zzdHbo(QI`%9#o*r8GCW~T3UdV`szO#~)^&X_(VW>o~umY9-ns9-V4lf~j z`QBD~pJ4a#b`*6bJ^3RS5y?RAgF7K5$ll97Y8#WZduZ`j?IEY~H(s^doZg>7-tk*t z4_QE1%%bb^p~4F5SB$t2i1>DBG1cIo;2(xTaj*Y~hlM{tSDHojL-QPg%Mo%6^7FrpB*{ z4G0@T{-77Por4DCMF zB_5Y~Phv%EQ64W8^GS6h?x6xh;w2{z3$rhC;m+;uD&pR74j+i22P5DS-tE8ABvH(U~indEbBUTAAAXfHZg5QpB@TgV9eI<)JrAkOI z8!TSOgfAJiWAXeM&vR4Glh;VxH}WG&V$bVb`a`g}GSpwggti*&)taV1@Ak|{WrV|5 zmNYx)Ans=S{c52qv@+jmGQ&vd6>6yX6IKq9O$3r&0xUTdZ!m1!irzn`SY+F23Rl6# zFRxws&gV-kM1NX(3(gnKpGi0Q)Dxi~#?nyzOR9!en;Ij>YJZVFAL*=R%7y%Mz9hU% zs>+ZB?qRmZ)nISx7wxY)y#cd$iaC~{k0avD>BjyF1q^mNQ1QcwsxiTySe<6C&cC6P zE`vwO9^k-d`9hZ!+r@Jnr+MF*2;2l8WjZ}DrwDUHzSF{WoG zucbSWguA!3KgB3MU%HH`R;XqVv0CcaGq?+;v_A5A2kpmk5V%qZE3yzQ7R5XWhq=eR zyUezH=@V)y>L9T-M-?tW(PQYTRBKZSVb_!$^H-Pn%ea;!vS_?M<~Tm>_rWIW43sPW z=!lY&fWc1g7+r?R)0p8(%zp&vl+FK4HRkns%BW+Up&wK8!lQ2~bja|9bD12WrKn#M zK)Yl9*8$SI7MAwSK$%)dMd>o+1UD<2&aQMhyjS5R{-vV+M;Q4bzl~Z~=4HFj_#2V9 zB)Gfzx3ncy@uzx?yzi}6>d%-?WE}h7v*w)Jr_gBl!2P&F3DX>j_1#--yjpL%<;JMR z*b70Gr)MMIBWDo~#<5F^Q0$VKI;SBIRneuR7)yVsN~A9I@gZTXe)E?iVII+X5h0~H zx^c(fP&4>!*q>fb6dAOC?MI>Cz3kld#J*;uik+Ps49cwm1B4 zZc1|ZxYyTv;{Z!?qS=D)sgRKx^1AYf%;y_V&VgZglfU>d+Ufk5&LV$sKv}Hoj+s; xK3FZRYdhbXT_@RW*ff3@`D1#ps#~H)p+y&j#(J|vk^lW{fF9OJt5(B-_&*Xgn9~3N literal 0 HcmV?d00001 diff --git a/app/public/icon.svg b/app/public/icon.svg new file mode 100644 index 0000000000..04b34bf83f --- /dev/null +++ b/app/public/icon.svg @@ -0,0 +1,3 @@ + + + diff --git a/app/public/robots.txt b/app/public/robots.txt new file mode 100644 index 0000000000..c19f78ab68 --- /dev/null +++ b/app/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/app/script/.keep b/app/script/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/storage/.keep b/app/storage/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/test/application_system_test_case.rb b/app/test/application_system_test_case.rb new file mode 100644 index 0000000000..cee29fd214 --- /dev/null +++ b/app/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/app/test/controllers/.keep b/app/test/controllers/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/test/fixtures/files/.keep b/app/test/fixtures/files/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/test/helpers/.keep b/app/test/helpers/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/test/integration/.keep b/app/test/integration/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/test/mailers/.keep b/app/test/mailers/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/test/models/.keep b/app/test/models/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/test/system/.keep b/app/test/system/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/test/test_helper.rb b/app/test/test_helper.rb new file mode 100644 index 0000000000..0c22470ec1 --- /dev/null +++ b/app/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/app/tmp/.keep b/app/tmp/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/tmp/pids/.keep b/app/tmp/pids/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/tmp/storage/.keep b/app/tmp/storage/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/vendor/.keep b/app/vendor/.keep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/app/vendor/javascript/.keep b/app/vendor/javascript/.keep new file mode 100644 index 0000000000..e69de29bb2 From a80bf514c376bd636df463a903abec80f7a03c8c Mon Sep 17 00:00:00 2001 From: DaviHVL Date: Mon, 17 Nov 2025 20:27:40 -0300 Subject: [PATCH 2/3] =?UTF-8?q?:memo:=20docs:=20adi=C3=A7=C3=A3o=20do=20.t?= =?UTF-8?q?xt=20e=20do=20wiki?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- sprint1.txt | 7 ++++ wiki.md | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 112 insertions(+) create mode 100644 sprint1.txt create mode 100644 wiki.md diff --git a/sprint1.txt b/sprint1.txt new file mode 100644 index 0000000000..3ff4192ca8 --- /dev/null +++ b/sprint1.txt @@ -0,0 +1,7 @@ +Grupo composto por: +- Caio Medeiros Balaniuk - 231025190 +- Davi Henrique Vieira Lima - 231013529 +- Lucca Schoen de Almeida - 231018900 + +Link para o repositório do GitHub: +https://github.com/DaviHVL/CAMAAR.git diff --git a/wiki.md b/wiki.md new file mode 100644 index 0000000000..ca094af35a --- /dev/null +++ b/wiki.md @@ -0,0 +1,105 @@ +# Wiki da Sprint 1 - CAMAAR + +## 1. Informações Gerais + +### Resumo +A aplicação **CAMAAR** consiste em um sistema desenvolvido com o framework *Ruby on Rails* para fins acadêmicos. Essa aplicação facilita a gestão, coleta e análise de formulários de avaliação acerca de disciplinas ofertadas pela Universidade de Brasília (UnB), que podem ser respondidos tanto por alunos quanto por professores + +### Integrantes + +| Nome Completo | Matrícula | +|---------------|-----------| +| Caio Medeiros Balaniuk | 231025190 | +| Davi Henrique Vieira Lima | 231013529 | +| Lucca Schoen de Almeida | 231018900 | + +## 2. Papéis da Equipe (Scrum) + +**Product Owner (PO):** Davi Henrique Vieira Lima +**Scrum Master (SM):** Lucca Schoen de Almeida + +## 3. Funcionalidades Desenvolvidas (Histórias de Usuário) + +As funcionalidades desenvolvidas foram estabelecidas com base nas histórias de usuário apresentadas nas issues. Desse modo, a seguir temos as funcionalidades com suas respectivas pontuações e regras de negócio: + +| Issue | Funcionalidade | Descrição / Regras de Negócio (Resumo) | Responsável | Pontos | +|:---:|---|---|---|:---:| +| **098** | Importar dados do SIGAA | Deve ler CSV/JSON do SIGAA e popular o banco. Validar duplicidade. | Lucca | 5 | +| **099** | Responder formulário | Permitir que usuário logado envie respostas. | Caio | 3 | +| **100** | Cadastrar usuários do sistema | CRUD de usuários. Deve exigir email válido. | Davi | 3 | +| **101** | Gerar relatório do administrador | Compilar dados de avaliações em formato visual/exportável para o Admin. | Davi | 5 | +| **102** | Criar template de formulário | Permitir criação de perguntas para avaliações. | Caio | 8 | +| **103** | Criar formulário de avaliação | Instanciar um formulário a partir de um template para uma disciplina. | Lucca | 5 | +| **104** | Sistema de login | Autenticação via email/senha. Bloquear acesso sem login. | Davi | 5 | +| **105** | Sistema de definição de senha | Fluxo de criação ou recuperação de senha segura. | Caio | 3 | +| **108** | Atualizar base com dados do SIGAA | Sincronização de dados existentes. Não deve sobrescrever dados manuais. | Lucca | 3 | +| **109** | Visualização de forms (Responder) | Listagem de formulários pendentes disponíveis para o usuário atual. | Davi | 3 | +| **110** | Visualização de resultados | Exibição gráfica ou tabular das respostas coletadas (apenas Admin/Prof). | Caio | 5 | +| **111** | Visualização dos templates criados | Listagem de todos os templates com opções de gestão. | Davi | 2 | +| **112** | Edição e deleção de templates | Alterar perguntas de templates. A deleção não deve alterar formulários já instanciados. | Lucca | 5 | + +## 4. Política de Branching + +Para garantir a rastreabilidade do código e a organização durante os ciclos de desenvolvimento, estabelecemos as seguintes diretrizes técnicas para commits, nomeação de branches e fluxo de trabalho. + +## 4.1. Convenções de Commits +Tanto as mensagens de commit quanto os nomes das branches compartilham os seguintes prefixos: +* `feat`: Para novas funcionalidades. + +* `fix`: Para correção de bugs. + +* `refactor`: Para refatoração de código + +* `test`: Para criação ou alteração de testes + +* `docs`: Para documentação + +Os commits devem ser atômicos e descritivos, seguindo o formato: + + `{prefixo}: {mensagem com verbo na 3ª pessoa do presente}` + +As branches devem ser nomeadas em **kebab-case**, sempre categorizadas pelo prefixo da tarefa: + + `{prefixo}/{nome-da-branch}` + +## 4.2. Estratégia de Branching (Fluxo de Trabalho) + +Adotamos um modelo híbrido focado em Sprints, garantindo que a branch principal (`main`) permaneça estável. Contendo, assim, as seguintes características: +- **`main`**: A fonte da verdade e versão estável do projeto +- **Branch da Sprint** (ex: `sprint-1`, `sprint-2`): Uma branch intermediária, criada a cada ciclo, para inserir os arquivos obrigatórios da entrega. +- **Branches de Tarefa** (Features/Fixes): Branches individuais criadas pelos desenvolvedores para modificações específicas + +Com base nisso, o ciclo de desenvolvimento é dado por: + +1. **Criação**: Cada membro cria uma branch para sua tarefa específica (ex: `feat/form-creation`), partindo da branch correta (geralmente a branch da Sprint atual ou `main`, conforme o início do ciclo) + +2. **Desenvolvimento e Merge**: Ao concluir a tarefa, o desenvolvedor não faz o merge direto na `main`. O código deve ser fundido na Branch da Sprint vigente + +3. **Quality Assurance**: Para que o merge seja aceito na branch da Sprint, é obrigatório: + - Abrir um Pull Request + - Passar nos testes automáticos + - Obter a aprovação de pelo menos 1 revisor + +4. **Finalização**: Apenas ao encerrar a sprint, a "Branch da Sprint" (com todas as features acumuladas e testadas) será fundida via Pull Request na branch `main` + +## 5. Pontuação (Velocity) + +A equipe atribuiu pontos (Story Points) para cada história de usuário especificada nesta sprint, para o cálculo da métrica velocity. + +| História de Usuário (Feature) | Pontos (Story Points) | +|-------------------------------|----------------------:| +| Importar dados do SIGAA | 5 | +| Responder formulário | 3 | +| Cadastrar usuários do sistema | 3 | +| Gerar relatório do administrador | 5 | +| Criar template de formulário | 8 | +| Criar formulário de avaliação | 5 | +| Sistema de login | 5 | +| Sistema de definição de senha | 3 | +| Atualizar base de dados com os dados do SIGAA | 3 | +| Visualização de formulários para responder | 3 | +| Visualização de resultados dos formulários | 5 | +| Visualização dos templates criados | 2 | +| Edição e deleção de templates | 5 | + +**Velocity Total Planejada (Sprint 1):** 55 \ No newline at end of file From b9763738949bd2481b4ddae690490925c9e6613f Mon Sep 17 00:00:00 2001 From: Caio Balaniuk Date: Tue, 18 Nov 2025 21:50:08 -0300 Subject: [PATCH 3/3] feat: adicionando BDDs --- features/atualizar_base_de_dados.feature | 27 +++++++++ features/autenticacao_usuario.feature | 58 +++++++++++++++++++ features/criacao_de_template.feature | 45 ++++++++++++++ ...iar_formulario_baseado_em_template.feature | 44 ++++++++++++++ features/criar_formulario_para_turma.feature | 40 +++++++++++++ .../definir_senha_primeiro_acesso.feature | 39 +++++++++++++ features/download_resultados_csv.feature | 32 ++++++++++ features/editar_deletar_template.feature | 31 ++++++++++ .../gerenciar_turmas_do_departamento.feature | 37 ++++++++++++ features/importar_dados_sigaa.feature | 41 +++++++++++++ features/importar_participantes_sigaa.feature | 40 +++++++++++++ features/redefinir_senha.feature | 50 ++++++++++++++++ features/responder_questionario_turma.feature | 42 ++++++++++++++ features/visualizar_formularios.feature | 31 ++++++++++ ...alizar_formularios_nao_respondidos.feature | 32 ++++++++++ features/visualizar_templates.feature | 32 ++++++++++ 16 files changed, 621 insertions(+) create mode 100644 features/atualizar_base_de_dados.feature create mode 100644 features/autenticacao_usuario.feature create mode 100644 features/criacao_de_template.feature create mode 100644 features/criar_formulario_baseado_em_template.feature create mode 100644 features/criar_formulario_para_turma.feature create mode 100644 features/definir_senha_primeiro_acesso.feature create mode 100644 features/download_resultados_csv.feature create mode 100644 features/editar_deletar_template.feature create mode 100644 features/gerenciar_turmas_do_departamento.feature create mode 100644 features/importar_dados_sigaa.feature create mode 100644 features/importar_participantes_sigaa.feature create mode 100644 features/redefinir_senha.feature create mode 100644 features/responder_questionario_turma.feature create mode 100644 features/visualizar_formularios.feature create mode 100644 features/visualizar_formularios_nao_respondidos.feature create mode 100644 features/visualizar_templates.feature diff --git a/features/atualizar_base_de_dados.feature b/features/atualizar_base_de_dados.feature new file mode 100644 index 0000000000..d172afd66f --- /dev/null +++ b/features/atualizar_base_de_dados.feature @@ -0,0 +1,27 @@ +Feature: Atualização da base de dados com informações do SIGAA + Como Administrador + Quero atualizar a base de dados já existente com os dados atuais do SIGAA + A fim de corrigir a base de dados do sistema + + Background: + Given que existe um administrador autenticado + + Scenario: Atualizar base de dados com sucesso + Given que o sistema está conectado à integração com o SIGAA + When o administrador acessa a funcionalidade de atualização de dados + And solicita a atualização da base + Then o sistema deve buscar os dados atuais no SIGAA + And atualizar a base de dados local com as informações recebidas + And exibir uma mensagem de sucesso informando que a atualização foi concluída + + Scenario: Falha na comunicação com o SIGAA + Given que o sistema não consegue acessar o SIGAA + When o administrador solicita a atualização da base + Then o sistema deve informar que não foi possível se conectar ao SIGAA + And exibir uma mensagem orientando a tentar novamente mais tarde + + Scenario: Dados recebidos estão incompletos ou inconsistentes + Given que o SIGAA retorna dados inconsistentes ou incompletos + When o administrador solicita a atualização da base + Then o sistema deve impedir a atualização + And exibir uma mensagem indicando o problema nos dados recebidos \ No newline at end of file diff --git a/features/autenticacao_usuario.feature b/features/autenticacao_usuario.feature new file mode 100644 index 0000000000..81a33390d3 --- /dev/null +++ b/features/autenticacao_usuario.feature @@ -0,0 +1,58 @@ +Feature: Autenticação de usuário no sistema + Como Usuário do sistema + Quero acessar o sistema utilizando um e-mail ou matrícula e uma senha já cadastrada + A fim de responder formulários ou gerenciar o sistema + + Background: + Given que existem usuários cadastrados no sistema + And que alguns usuários possuem perfil de administrador + And que outros usuários possuem perfil de participante + + Scenario: Login com e-mail válido e senha correta + When o usuário acessa a página de login + And informa um e-mail válido cadastrado no sistema + And informa a senha correta correspondente + Then o sistema deve autenticar o usuário + And deve redirecioná-lo para a página inicial do sistema + + Scenario: Login com matrícula válida e senha correta + When o usuário acessa a página de login + And informa uma matrícula válida cadastrada no sistema + And informa a senha correta correspondente + Then o sistema deve autenticar o usuário + And deve redirecioná-lo para a página inicial do sistema + + Scenario: Exibir opção de gerenciamento para administrador + Given que o usuário autenticado possui perfil de administrador + When o usuário acessa o sistema após o login + Then o sistema deve exibir no menu lateral a opção de gerenciamento + + Scenario: Não exibir opção de gerenciamento para usuário comum + Given que o usuário autenticado não é administrador + When o usuário acessa o sistema após o login + Then o sistema não deve exibir a opção de gerenciamento no menu lateral + + Scenario: Login com senha incorreta + When o usuário acessa a página de login + And informa um e-mail ou matrícula válida + And informa uma senha incorreta + Then o sistema deve negar o acesso + And exibir uma mensagem informando que a senha está incorreta + + Scenario: Login com usuário inexistente + When o usuário acessa a página de login + And informa um e-mail ou matrícula que não está cadastrada + Then o sistema deve negar o acesso + And exibir uma mensagem informando que o usuário não foi encontrado + + Scenario: Tentativa de login com campos vazios + When o usuário tenta realizar login sem preencher e-mail/matrícula ou senha + Then o sistema deve impedir o login + And exibir uma mensagem informando que os campos são obrigatórios + + Scenario: Erro inesperado ao tentar autenticar + When o usuário tenta fazer login + And ocorre um erro interno inesperado + Then o sistema deve exibir uma mensagem genérica de erro + And instruir o usuário a tentar novamente mais tarde + diff --git a/features/criacao_de_template.feature b/features/criacao_de_template.feature new file mode 100644 index 0000000000..c32142d1a3 --- /dev/null +++ b/features/criacao_de_template.feature @@ -0,0 +1,45 @@ +Feature: Criação de template de formulário + Como Administrador + Quero criar um template de formulário contendo as questões do formulário + A fim de gerar formulários de avaliações para avaliar o desempenho das turmas + + Background: + Given que o administrador está autenticado no sistema + And que o administrador possui permissão para gerenciar templates + + Scenario: Criar template com título e questões válidas + When o administrador acessa a página de criação de templates + And informa um título válido para o template + And adiciona uma ou mais questões válidas + And confirma a criação do template + Then o sistema deve salvar o template + And deve exibir uma mensagem confirmando a criação com sucesso + + Scenario: Criar template sem informar título + When o administrador acessa a página de criação de templates + And não informa um título + And tenta confirmar a criação + Then o sistema deve impedir a criação do template + And deve exibir uma mensagem informando que o título é obrigatório + + Scenario: Criar template sem adicionar questões + When o administrador acessa a página de criação de templates + And informa um título válido + And não adiciona nenhuma questão + And tenta confirmar a criação + Then o sistema deve impedir a criação do template + And deve exibir uma mensagem informando que é necessário adicionar ao menos uma questão + + Scenario: Criar template com questões inválidas ou duplicadas + When o administrador acessa a página de criação de templates + And informa um título válido + And adiciona questões inválidas ou duplicadas + And tenta confirmar a criação + Then o sistema deve impedir a criação + And deve exibir uma mensagem informando que existem questões inválidas ou duplicadas + + Scenario: Erro inesperado ao criar template + When o administrador tenta confirmar a criação do template + And ocorre um erro interno inesperado + Then o sistema deve exibir uma mensagem genérica de erro + And instruir o administrador a tentar novamente mais tarde diff --git a/features/criar_formulario_baseado_em_template.feature b/features/criar_formulario_baseado_em_template.feature new file mode 100644 index 0000000000..aebee914b7 --- /dev/null +++ b/features/criar_formulario_baseado_em_template.feature @@ -0,0 +1,44 @@ +Feature: Criação de formulário a partir de um template + Como Administrador + Quero criar um formulário baseado em um template para as turmas que eu escolher + A fim de avaliar o desempenho das turmas no semestre atual + + Background: + Given que existem templates cadastrados no sistema + And que existem turmas disponíveis para o administrador + And que o administrador está autenticado no sistema + + Scenario: Criar formulário com um template válido para múltiplas turmas + When o administrador acessa a página de criação de formulários + And seleciona um template válido da lista de templates disponíveis + And seleciona uma ou mais turmas válidas + And confirma a criação do formulário + Then o sistema deve criar um formulário para cada turma selecionada + And deve exibir uma mensagem confirmando a criação com sucesso + + Scenario: Criar formulário sem selecionar template + When o administrador acessa a página de criação de formulários + And não seleciona nenhum template + And tenta confirmar a criação do formulário + Then o sistema deve impedir a criação + And deve exibir uma mensagem informando que a seleção de template é obrigatória + + Scenario: Criar formulário sem selecionar turmas + When o administrador acessa a página de criação de formulários + And seleciona um template válido + And não seleciona nenhuma turma + And tenta confirmar a criação + Then o sistema deve impedir a criação + And deve exibir uma mensagem informando que é necessário selecionar ao menos uma turma + + Scenario: Criar formulário com template inexistente + When o administrador tenta criar um formulário + And seleciona um template que não existe mais ou foi removido + Then o sistema deve impedir a criação + And deve exibir uma mensagem informando que o template selecionado é inválido + + Scenario: Erro inesperado ao criar formulário + When o administrador tenta confirmar a criação do formulário + And ocorre um erro interno inesperado + Then o sistema deve exibir uma mensagem genérica de erro + And instruir o administrador a tentar novamente mais tarde diff --git a/features/criar_formulario_para_turma.feature b/features/criar_formulario_para_turma.feature new file mode 100644 index 0000000000..eda2ab043a --- /dev/null +++ b/features/criar_formulario_para_turma.feature @@ -0,0 +1,40 @@ +Feature: Criação de formulário para docentes ou discentes + Como Administrador + Quero escolher criar um formulário para os docentes ou os discentes de uma turma + A fim de avaliar o desempenho de uma matéria + + Background: + Given que existe um administrador autenticado + And que existe ao menos uma turma cadastrada no sistema + + Scenario: Criar formulário para docentes de uma turma + When o administrador acessa a página de criação de formulário + And seleciona um template + And seleciona a turma desejada + And escolhe criar um formulário destinado aos docentes + And confirma a criação do formulário + Then o sistema deve registrar o formulário associado aos docentes da turma selecionada + And exibir uma mensagem de sucesso + + Scenario: Criar formulário para discentes de uma turma + When o administrador acessa a página de criação de formulário + And seleciona um template + And seleciona a turma desejada + And escolhe criar um formulário destinado aos discentes + And confirma a criação do formulário + Then o sistema deve registrar o formulário associado aos discentes da turma selecionada + And exibir uma mensagem de sucesso + + Scenario: Criar formulário sem selecionar uma turma + When o administrador acessa a página de criação de formulário + And não seleciona nenhuma turma + And tenta prosseguir com a criação + Then o sistema deve impedir a criação do formulário + And exibir uma mensagem informando que a turma é obrigatória + + Scenario: Criar formulário sem definir template + When o administrador seleciona a turma desejada + And escolhe criar um formulário para docentes ou discentes + And não define um template + And tenta finalizar a criação + Then o sistema deve exibir uma mensagem indicando que o formulário precisa ter conteúdo diff --git a/features/definir_senha_primeiro_acesso.feature b/features/definir_senha_primeiro_acesso.feature new file mode 100644 index 0000000000..857e2e694f --- /dev/null +++ b/features/definir_senha_primeiro_acesso.feature @@ -0,0 +1,39 @@ +Feature: Definição de senha para o usuário a partir do e-mail do sistema de solicitação de cadastro + Como Usuário + Quero definir uma senha para o meu usuário a partir do e-mail do sistema de solicitação de cadastro + A fim de acessar o sistema + + Background: + Given que o usuário possui um cadastro pendente de ativação + And que o sistema enviou um e-mail contendo um link para definição de senha + + Scenario: Acessar link de definição de senha com sucesso + When o usuário clica no link recebido por e-mail + Then o sistema deve exibir a página para criação da senha inicial + And o link deve ser validado como autêntico e dentro do prazo de validade + + Scenario: Definir senha inicial com sucesso + Given que o usuário está na página de criação de senha + When o usuário informa uma senha válida + And confirma a senha corretamente + Then o sistema deve registrar a nova senha + And ativar o cadastro do usuário + And exibir uma mensagem informando que o acesso foi liberado + + Scenario: Senhas não coincidem + Given que o usuário está na página de criação de senha + When o usuário informa uma senha e uma confirmação que não coincidem + Then o sistema deve impedir a criação da senha + And exibir uma mensagem informando que as senhas devem ser iguais + + Scenario: Senha não atende aos critérios mínimos + Given que o usuário está na página de criação de senha + When o usuário informa uma senha que não atende às regras + Then o sistema deve impedir a criação da senha + And exibir uma mensagem explicando os critérios obrigatórios + + Scenario: Usuário já definiu a senha anteriormente + Given que o usuário já ativou sua conta e definiu uma senha previamente + When tenta acessar novamente o link de definição de senha + Then o sistema deve bloquear a ação + And exibir uma mensagem informando que a conta já foi ativada \ No newline at end of file diff --git a/features/download_resultados_csv.feature b/features/download_resultados_csv.feature new file mode 100644 index 0000000000..ae19a73817 --- /dev/null +++ b/features/download_resultados_csv.feature @@ -0,0 +1,32 @@ +Feature: Download dos resultados de um formulário em CSV + Como Administrador + Quero baixar um arquivo CSV contendo os resultados de um formulário + A fim de avaliar o desempenho das turmas + + Background: + Given que o administrador está autenticado no sistema + And que existem formulários já respondidos pelas turmas + And que o administrador possui permissão para visualizar os resultados + + Scenario: Download bem-sucedido do arquivo CSV + When o administrador acessa a página de resultados de um formulário + And solicita o download do arquivo CSV + Then o sistema deve gerar o arquivo CSV contendo todas as respostas do formulário + And deve iniciar automaticamente o download do arquivo + + Scenario: Tentar baixar CSV de formulário sem respostas + Given que o formulário selecionado não possui respostas registradas + When o administrador solicita o download do arquivo CSV + Then o sistema deve impedir a geração do arquivo + And deve exibir uma mensagem informando que o formulário não possui respostas + + Scenario: Tentar baixar CSV de um formulário inexistente + When o administrador tenta acessar os resultados de um formulário que não existe mais + And solicita o download do arquivo CSV + Then o sistema deve exibir uma mensagem informando que o formulário é inválido ou não encontrado + + Scenario: Erro inesperado ao gerar o CSV + When o administrador solicita o download do arquivo CSV + And ocorre um erro interno inesperado durante a geração do arquivo + Then o sistema deve exibir uma mensagem genérica de erro + And instruir o administrador a tentar novamente mais tarde diff --git a/features/editar_deletar_template.feature b/features/editar_deletar_template.feature new file mode 100644 index 0000000000..a131b77f82 --- /dev/null +++ b/features/editar_deletar_template.feature @@ -0,0 +1,31 @@ +Feature: Edição e exclusão de templates + Como Administrador + Quero editar e/ou deletar um template que eu criei sem afetar os formulários já criados + A fim de organizar os templates existentes + + Background: + Given que existe um administrador autenticado + And que existe um template previamente criado pelo administrador + + Scenario: Editar um template com sucesso + When o administrador acessa a lista de templates + And seleciona a opção de editar um template existente + And realiza alterações válidas no template + And confirma a edição + Then o sistema deve salvar o template atualizado + And os formulários já criados a partir desse template não devem ser alterados + And o sistema deve exibir uma mensagem de sucesso + + Scenario: Editar um template com dados inválidos + When o administrador tenta editar um template + And insere informações inválidas ou incompletas + Then o sistema deve impedir a edição + And exibir uma mensagem de erro indicando o problema + + Scenario: Deletar um template com sucesso + When o administrador acessa a lista de templates + And seleciona a opção de deletar um template existente + And confirma a exclusão do template + Then o sistema deve remover o template da lista + And os formulários já criados a partir do template removido devem permanecer intactos + And o sistema deve exibir uma mensagem de sucesso diff --git a/features/gerenciar_turmas_do_departamento.feature b/features/gerenciar_turmas_do_departamento.feature new file mode 100644 index 0000000000..71f5efc3e1 --- /dev/null +++ b/features/gerenciar_turmas_do_departamento.feature @@ -0,0 +1,37 @@ +Feature: Gerenciamento de turmas por departamento + Como Administrador + Quero gerenciar somente as turmas do departamento ao qual eu pertenço + A fim de avaliar o desempenho das turmas no semestre atual + + Background: + Given que existe um administrador autenticado + And que o administrador pertence a um departamento específico + And que existem turmas cadastradas em vários departamentos + + Scenario: Visualizar apenas as turmas do próprio departamento + When o administrador acessa a página de gerenciamento de turmas + Then o sistema deve exibir somente as turmas pertencentes ao departamento do administrador + And não deve exibir turmas de outros departamentos + + Scenario: Tentar acessar turma de outro departamento + Given que existe uma turma de outro departamento + When o administrador tenta acessar os detalhes dessa turma + Then o sistema deve negar o acesso + And deve exibir uma mensagem informando permissão insuficiente + + Scenario: Gerenciar turmas do próprio departamento + Given que existem turmas vinculadas ao departamento do administrador + When o administrador seleciona uma turma da lista + Then o sistema deve permitir visualizar dados da turma + And deve permitir ações como gerar relatórios, visualizar formulários ou acompanhar desempenho + + Scenario: Não há turmas no departamento do administrador + Given que o departamento do administrador não possui turmas cadastradas para o semestre atual + When o administrador acessa a página de gerenciamento de turmas + Then o sistema deve informar que não existem turmas disponíveis para o departamento + + Scenario: Usuário não autenticado tenta acessar gerenciamento de turmas + Given que o usuário não está autenticado + When tenta acessar a página de gerenciamento de turmas + Then o sistema deve negar o acesso + And exibir uma mensagem informando que a autenticação é necessária diff --git a/features/importar_dados_sigaa.feature b/features/importar_dados_sigaa.feature new file mode 100644 index 0000000000..4a92bfb2d9 --- /dev/null +++ b/features/importar_dados_sigaa.feature @@ -0,0 +1,41 @@ +Feature: Importação de dados do SIGAA + Como Administrador + Quero importar dados de turmas, matérias e participantes do SIGAA (caso não existam na base de dados atual) + A fim de alimentar a base de dados do sistema + + Background: + Given que o administrador está autenticado no sistema + And que o administrador possui permissão para importar dados do SIGAA + And que os arquivos seguem o formato esperado pelo sistema + + Scenario: Importar dados válidos de turmas, matérias e participantes + When o administrador acessa a página de importação de dados do SIGAA + And seleciona os arquivos válidos presentes no repositório + And confirma a importação + Then o sistema deve importar as turmas que ainda não existem na base + And deve importar as matérias que ainda não existem na base + And deve importar os participantes que ainda não existem na base + And deve exibir uma mensagem confirmando a importação com sucesso + + Scenario: Importar dados onde alguns itens já existem na base + Given que algumas turmas, matérias ou participantes já estão cadastrados no sistema + When o administrador realiza a importação dos arquivos + Then o sistema deve ignorar os itens duplicados + And deve cadastrar apenas os dados novos + And deve exibir uma mensagem informando que alguns dados já existiam na base + + Scenario: Tentar importar arquivos inválidos + When o administrador tenta importar arquivos que não seguem o formato esperado + Then o sistema deve impedir a importação + And deve exibir uma mensagem informando que o arquivo é inválido + + Scenario: Tentar importar arquivos vazios + When o administrador seleciona vazios para importação + Then o sistema deve impedir a importação + And deve exibir uma mensagem informando que os arquivos não contêm dados + + Scenario: Erro inesperado durante a importação + When o administrador confirma a importação dos arquivos + And ocorre um erro interno inesperado + Then o sistema deve exibir uma mensagem genérica de erro + And instruir o administrador a tentar novamente mais tarde diff --git a/features/importar_participantes_sigaa.feature b/features/importar_participantes_sigaa.feature new file mode 100644 index 0000000000..8e3385a832 --- /dev/null +++ b/features/importar_participantes_sigaa.feature @@ -0,0 +1,40 @@ +Feature: Importação de participantes de turmas do SIGAA + Como Administrador + Quero cadastrar participantes de turmas do SIGAA ao importar dados de usuários novos para o sistema + A fim de que eles acessem o sistema CAMAAR + + Background: + Given que o administrador está autenticado no sistema + And que o administrador possui permissão para importar dados do SIGAA + And que o sistema possui integração com os dados exportados do SIGAA + + Scenario: Importar arquivo válido com novos participantes + When o administrador acessa a página de importação de usuários + And seleciona um arquivo válido exportado do SIGAA + And confirma a importação + Then o sistema deve cadastrar os novos participantes + And deve associá-los corretamente às suas respectivas turmas + And deve exibir uma mensagem confirmando a importação com sucesso + + Scenario: Importar arquivo contendo usuários já cadastrados + Given que alguns usuários presentes no arquivo já existem no sistema + When o administrador realiza a importação do arquivo + Then o sistema deve ignorar os usuários duplicados + And deve cadastrar somente os usuários novos + And deve exibir uma mensagem informando que alguns usuários já estavam cadastrados + + Scenario: Tentar importar arquivo com formato inválido + When o administrador tenta importar um arquivo que não segue o formato esperado do SIGAA + Then o sistema deve impedir a importação + And deve exibir uma mensagem informando que o arquivo é inválido + + Scenario: Tentar importar arquivo vazio + When o administrador seleciona um arquivo vazio para importação + Then o sistema deve impedir a importação + And deve exibir uma mensagem informando que o arquivo não contém dados + + Scenario: Erro inesperado durante a importação + When o administrador confirma a importação de um arquivo + And ocorre um erro interno inesperado + Then o sistema deve exibir uma mensagem genérica de erro + And instruir o administrador a tentar novamente mais tarde diff --git a/features/redefinir_senha.feature b/features/redefinir_senha.feature new file mode 100644 index 0000000000..933d0270a3 --- /dev/null +++ b/features/redefinir_senha.feature @@ -0,0 +1,50 @@ +Feature: Redefinição de senha via e-mail + Como Usuário + Quero redefinir minha senha a partir do e-mail recebido após a solicitação + A fim de recuperar meu acesso ao sistema + + Background: + Given que o usuário possui um cadastro válido no sistema + + Scenario: Solicitar redefinição de senha com sucesso + When o usuário acessa a página de recuperação de senha + And informa um e-mail válido associado à sua conta + Then o sistema deve enviar um e-mail contendo um link para redefinição de senha + And deve exibir uma mensagem informando que o e-mail foi enviado + + Scenario: Solicitar redefinição com e-mail não cadastrado + When o usuário acessa a página de recuperação de senha + And informa um e-mail que não está cadastrado no sistema + Then o sistema deve exibir uma mensagem informando que o e-mail não foi encontrado + And não deve enviar nenhum link de redefinição + + Scenario: Acessar link de redefinição válido + Given que o usuário recebeu o e-mail de recuperação com um link válido + When o usuário clica no link de redefinição dentro do prazo de validade + Then o sistema deve exibir a página de criação de nova senha + + Scenario: Redefinir senha com sucesso + Given que o usuário está na página de redefinição de senha + When o usuário informa uma nova senha válida + And confirma a nova senha corretamente + Then o sistema deve atualizar a senha do usuário + And deve exibir uma mensagem de sucesso + And o usuário deve poder acessar o sistema com a nova senha + + Scenario: Link de redefinição expirado + Given que o usuário recebeu o e-mail, mas o link já expirou + When o usuário tenta acessar o link de redefinição + Then o sistema deve informar que o link não é mais válido + And deve instruir o usuário a solicitar um novo link + + Scenario: Erro ao redefinir devido a senhas não coincidentes + Given que o usuário está na página de redefinição de senha + When o usuário informa uma senha e uma confirmação que não coincidem + Then o sistema deve impedir a atualização + And exibir uma mensagem informando que as senhas devem ser iguais + + Scenario: Usuário tenta redefinir senha com critérios inválidos + Given que o usuário está na página de redefinição de senha + When o usuário informa uma senha que não atende aos requisitos mínimos + Then o sistema deve impedir a redefinição + And exibir uma mensagem explicando as regras de senha diff --git a/features/responder_questionario_turma.feature b/features/responder_questionario_turma.feature new file mode 100644 index 0000000000..f96dde6f5e --- /dev/null +++ b/features/responder_questionario_turma.feature @@ -0,0 +1,42 @@ +Feature: Responder questionário da turma + Como Participante de uma turma + Quero responder o questionário sobre a turma em que estou matriculado + A fim de submeter minha avaliação da turma + + Background: + Given que o participante está autenticado no sistema + And que o participante está matriculado em uma ou mais turmas + + Scenario: Responder questionário com todas as respostas válidas + Given que existem formulários pendentes de resposta para as turmas do participante + When o participante acessa a lista de formulários pendentes + And seleciona um formulário de uma turma + And responde todas as questões obrigatórias com respostas válidas + And envia o questionário + Then o sistema deve registrar as respostas + And deve exibir uma mensagem confirmando o envio com sucesso + + Scenario: Tentar enviar o questionário com questões obrigatórias em branco + Given que existe um formulário pendente + When o participante o acessa + And deixa uma ou mais questões obrigatórias sem resposta + And tenta enviar o questionário + Then o sistema deve impedir o envio + And deve exibir uma mensagem informando que todas as questões obrigatórias devem ser respondidas + + Scenario: Tentar responder um formulário já respondido + Given que o participante já respondeu o formulário da turma + When o participante tenta acessá-lo novamente + Then o sistema deve impedir o acesso + And deve exibir uma mensagem informando que o formulário já foi respondido + + Scenario: Tentar responder um formulário de turma não matriculada + When o participante tenta acessar um formulário que não pertence às suas turmas + Then o sistema deve negar o acesso + And deve exibir uma mensagem informando que o formulário não está disponível + + Scenario: Erro inesperado ao enviar respostas + Given que existe um problema interno inesperado no sistema + When o participante tenta enviar o formulário + Then o sistema deve exibir uma mensagem genérica de erro + And instruir o participante a tentar novamente mais tarde diff --git a/features/visualizar_formularios.feature b/features/visualizar_formularios.feature new file mode 100644 index 0000000000..2d9e3a00fc --- /dev/null +++ b/features/visualizar_formularios.feature @@ -0,0 +1,31 @@ +Feature: Visualização de formulários criados + Como Administrador + Quero visualizar os formulários criados + A fim de poder gerar um relatório a partir das respostas + + Background: + Given que existe um administrador autenticado + + Scenario: Visualizar lista de formulários com sucesso + Given que existem formulários cadastrados no sistema + When o administrador acessa a página de formulários + Then o sistema deve exibir a lista de formulários existentes + And cada formulário deve exibir informações como nome, turma e data de criação + And cada formulário deve apresentar uma opção para gerar relatório + + Scenario: Visualizar lista de formulários vazia + Given que não existem formulários cadastrados no sistema + When o administrador acessa a página de formulários + Then o sistema deve informar que não há formulários disponíveis + + Scenario: Acessar detalhes de um formulário específico + Given que existe ao menos um formulário cadastrado + When o administrador seleciona um formulário na lista + Then o sistema deve exibir as informações completas do formulário + And deve disponibilizar uma opção para gerar o relatório a partir das respostas + + Scenario: Tentar acessar lista de formulários sem estar autenticado + Given que o usuário não está autenticado como administrador + When ele tenta acessar a página de formulários + Then o sistema deve negar o acesso + And exibir uma mensagem informando que a autenticação é necessária \ No newline at end of file diff --git a/features/visualizar_formularios_nao_respondidos.feature b/features/visualizar_formularios_nao_respondidos.feature new file mode 100644 index 0000000000..aee9953666 --- /dev/null +++ b/features/visualizar_formularios_nao_respondidos.feature @@ -0,0 +1,32 @@ +Feature: Visualização de formulários não respondidos pelo participante + Como Participante de uma turma + Quero visualizar os formulários não respondidos das turmas em que estou matriculado + A fim de poder escolher qual irei responder + + Background: + Given que existe um participante autenticado + And que o participante está matriculado em uma ou mais turmas + + Scenario: Visualizar formulários não respondidos com sucesso + Given que existem formulários disponíveis e não respondidos nas turmas do participante + When o participante acessa a página de formulários pendentes + Then o sistema deve exibir a lista de formulários não respondidos + And cada formulário deve mostrar informações como nome, turma e prazo (se houver) + And cada formulário deve apresentar uma opção para iniciar a resposta + + Scenario: Não há formulários pendentes + Given que o participante já respondeu todos os formulários disponíveis nas turmas em que está matriculado + When o participante acessa a página de formulários pendentes + Then o sistema deve informar que não existem formulários pendentes de resposta + + Scenario: Participante tenta acessar página sem estar autenticado + Given que o usuário não está autenticado + When o usuário tenta acessar a página de formulários pendentes + Then o sistema deve negar o acesso + And exibir uma mensagem informando que a autenticação é necessária + + Scenario: Erro ao carregar formulários pendentes + Given que existe um problema temporário no carregamento das informações + When o participante acessa a página de formulários pendentes + Then o sistema deve exibir uma mensagem de erro + And instruir o usuário a tentar novamente mais tarde \ No newline at end of file diff --git a/features/visualizar_templates.feature b/features/visualizar_templates.feature new file mode 100644 index 0000000000..14c6b7327a --- /dev/null +++ b/features/visualizar_templates.feature @@ -0,0 +1,32 @@ +Feature: Visualização de templates criados + Como Administrador + Quero visualizar os templates criados + A fim de poder editar e/ou deletar um template que eu criei + + # Cenários que exigem autenticação do administrador + Background: + Given que existe um administrador autenticado + + Scenario: Visualizar lista de templates com sucesso + Given que existem templates cadastrados no sistema + When o administrador acessa a página de templates + Then o sistema deve exibir a lista de templates existentes + And cada template deve apresentar opções para edição e exclusão + + Scenario: Visualizar lista de templates vazia + Given que não existem templates cadastrados no sistema + When o administrador acessa a página de templates + Then o sistema deve informar que não há templates disponíveis + + Scenario: Acessar detalhes de um template + Given que existe ao menos um template cadastrado + When o administrador seleciona um template da lista + Then o sistema deve exibir os detalhes do template + And deve disponibilizar opções para editar ou deletar o template + + # Cenário sem Background, pois não envolve administrador autenticado + Scenario: Tentar acessar lista de templates sem estar autenticado + Given que o usuário não está autenticado como administrador + When ele tenta acessar a página de templates + Then o sistema deve negar o acesso + And exibir uma mensagem indicando falta de permissão \ No newline at end of file