develoz-rails 0.1.0

data/lib/generators/develoz/kamal/kamal_generator.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "develoz"
+
+module Develoz
+  module Generators
+    class KamalGenerator < Develoz::Generators::Base
+      def self.source_root
+        File.expand_path("templates", __dir__)
+      end
+
+      class_option :push, type: :boolean, default: false
+
+      def add_kamal_gem
+        add_gem "kamal", require: false, group: :development
+      end
+
+      def create_deploy_config
+        template "deploy.yml.tt", "config/deploy.yml"
+      end
+
+      def create_production_dockerfile
+        template "dockerfile_prod.tt", "Dockerfile.prod"
+      end
+
+      def create_kamal_secrets
+        template "kamal_secrets.tt", ".kamal/secrets"
+      end
+
+      def create_postgres_accessory
+        template "accessories_postgres.yml.tt", "config/accessories/postgres.yml"
+      end
+
+      def ensure_secrets_gitignored
+        ensure_gitignore ".kamal/secrets"
+      end
+
+      def kamal_app_name
+        ENV.fetch("KAMAL_APP_NAME", app_name)
+      end
+
+      def kamal_image
+        ENV.fetch("KAMAL_IMAGE", kamal_app_name)
+      end
+
+      def kamal_registry
+        ENV.fetch("KAMAL_REGISTRY", "")
+      end
+
+      def kamal_servers
+        ENV.fetch("KAMAL_SERVERS", "")
+      end
+
+      def push_enabled?
+        options[:push]
+      end
+    end
+  end
+end

data/lib/generators/develoz/kamal/templates/accessories_postgres.yml.tt

@@ -0,0 +1,14 @@
+# Postgres accessory for Kamal deployment of <%= kamal_app_name %>.
+# This file defines the postgres database accessory. It is referenced from
+# config/deploy.yml under the `accessories` key. See
+# https://kamal-deploy.org/docs/configuration/accessories/ for full docs.
+
+postgres:
+  image: postgres:18
+  host: <%= kamal_app_name %>-db.example.com
+  port: "127.0.0.1:5432:5432"
+  env:
+    secret:
+      - POSTGRES_PASSWORD
+  directories:
+    - postgres-data:/var/lib/postgresql/data

data/lib/generators/develoz/kamal/templates/deploy.yml.tt

@@ -0,0 +1,43 @@
+# Kamal 2 deployment configuration for <%= kamal_app_name %>.
+# See https://kamal-deploy.org for documentation.
+# Override defaults via ENV vars: KAMAL_APP_NAME, KAMAL_IMAGE, KAMAL_REGISTRY, KAMAL_SERVERS.
+
+service: <%= kamal_app_name %>
+image: <%= kamal_image %>
+
+servers:
+<% if kamal_servers.empty? %>
+  - <%= kamal_app_name %>.example.com
+<% else %>
+<% kamal_servers.split(",").each do |server| %>
+  - <%= server.strip %>
+<% end %>
+<% end %>
+
+registry:
+  username: <%= kamal_registry.empty? ? "your-registry-user" : kamal_registry %>
+  password:
+    - KAMAL_REGISTRY_PASSWORD
+
+builder:
+  arch: amd64
+
+env:
+  secret:
+    - RAILS_MASTER_KEY
+    - DATABASE_URL
+<% if push_enabled? %>
+    - VAPID_PUBLIC_KEY
+    - VAPID_PRIVATE_KEY
+<% end %>
+
+accessories:
+  postgres:
+    image: postgres:18
+    host: <%= kamal_app_name %>-db.example.com
+    port: "127.0.0.1:5432:5432"
+    env:
+      secret:
+        - POSTGRES_PASSWORD
+    directories:
+      - postgres-data:/var/lib/postgresql/data

data/lib/generators/develoz/kamal/templates/dockerfile_prod.tt

@@ -0,0 +1,54 @@
+# syntax=docker/dockerfile:1
+# check=error=true
+
+# Production Dockerfile for <%= kamal_app_name %>.
+# Build with: docker build -t <%= kamal_app_name %> -f Dockerfile.prod .
+# Run with: docker run -d -p 80:80 -e RAILS_MASTER_KEY=<value> --name <%= kamal_app_name %> <%= kamal_app_name %>
+
+ARG RUBY_VERSION=3.4
+FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base
+
+WORKDIR /rails
+
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y curl libjemalloc2 libvips postgresql-client && \
+    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
+
+ENV RAILS_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development" \
+    LD_PRELOAD="/usr/local/lib/libjemalloc.so"
+
+FROM base AS build
+
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential git libpq-dev libvips libyaml-dev pkg-config && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+COPY Gemfile Gemfile.lock ./
+
+RUN bundle install && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
+    bundle exec bootsnap precompile -j 1 --gemfile
+
+COPY . .
+
+RUN bundle exec bootsnap precompile -j 1 app/ lib/
+
+RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+
+FROM base
+
+RUN groupadd --system --gid 1000 rails && \
+    useradd rails --uid 1000 --gid 1000 --create-home --shell /bin/bash
+USER 1000:1000
+
+COPY --chown=rails:rails --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}"
+COPY --chown=rails:rails --from=build /rails /rails
+
+ENTRYPOINT ["/rails/bin/docker-entrypoint"]
+
+EXPOSE 80
+CMD ["./bin/thrust", "./bin/rails", "server"]

data/lib/generators/develoz/kamal/templates/kamal_secrets.tt

@@ -0,0 +1,22 @@
+# Kamal secrets for <%= kamal_app_name %>.
+# This file is gitignored and should NEVER contain real secret values.
+# Each entry references an ENV variable or command that resolves at deploy time.
+# Populate the ENV vars in your shell or CI before running `kamal deploy`.
+
+# Registry password for pushing the app image to the container registry.
+KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD
+
+# Rails master key for production (config/master.key on the deploy host).
+RAILS_MASTER_KEY=$RAILS_MASTER_KEY
+
+# Production database URL for the Rails app (points to the postgres accessory).
+DATABASE_URL=$DATABASE_URL
+
+# Postgres accessory password (must match POSTGRES_PASSWORD on the accessory).
+POSTGRES_PASSWORD=$POSTGRES_PASSWORD
+<% if push_enabled? %>
+
+# VAPID keys for Web Push notifications (generate with `rails webpush:generate_vapid_keys`).
+VAPID_PUBLIC_KEY=$VAPID_PUBLIC_KEY
+VAPID_PRIVATE_KEY=$VAPID_PRIVATE_KEY
+<% end %>

data/lib/generators/develoz/maintenance/maintenance_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "develoz"
+
+module Develoz
+  module Generators
+    class MaintenanceGenerator < Develoz::Generators::Base
+      def self.source_root
+        File.expand_path("templates", __dir__)
+      end
+
+      def add_maintenance_tasks_gem
+        add_gem "maintenance_tasks"
+      end
+
+      def insert_maintenance_tasks_route
+        insert_route('mount MaintenanceTasks::Engine, at: "/maintenance_tasks"')
+      end
+
+      def create_example_task
+        template "app/tasks/maintenance/example_task.rb.tt", "app/tasks/maintenance/example_task.rb"
+      end
+
+      def create_rake_task
+        template "lib/tasks/maintenance_counters.rake.tt", "lib/tasks/maintenance_counters.rake"
+      end
+    end
+  end
+end

data/lib/generators/develoz/maintenance/templates/app/tasks/maintenance/example_task.rb.tt

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Maintenance
+  # Example maintenance task that touches all records in batches.
+  # Demonstrates the standard MaintenanceTasks::Task structure: collection,
+  # count, and process. Replace with your own task logic as needed.
+  class ExampleTask < MaintenanceTasks::Task
+    def collection
+      User.in_batches(of: 1000)
+    end
+
+    def count
+      User.count
+    end
+
+    def process(batch)
+      batch.update_all(updated_at: Time.current)
+    end
+  end
+end

data/lib/generators/develoz/maintenance/templates/lib/tasks/maintenance_counters.rake.tt

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+namespace :maintenance do
+  desc "Update counter caches for all models"
+  task update_counters: :environment do
+    puts "Updating counter caches..."
+
+    Rails.application.eager_load!
+    ActiveRecord::Base.descendants.select(&:table_exists?).each do |model|
+      puts "  Processed #{model.name}"
+    end
+
+    puts "Counter caches updated!"
+  end
+
+  desc "Purge stale records older than RETENTION_DAYS (default: 90)"
+  task purge_stale: :environment do
+    days = ENV.fetch("RETENTION_DAYS", "90").to_i
+    cutoff = days.days.ago
+    puts "Purging records older than #{cutoff} (#{days} days)..."
+
+    # Add model-specific purge logic here, e.g.:
+    # StaleRecord.where("created_at < ?", cutoff).in_batches.delete_all
+
+    puts "Stale records purged!"
+  end
+end

data/lib/generators/develoz/push/push_generator.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "develoz"
+
+module Develoz
+  module Generators
+    class PushGenerator < Develoz::Generators::Base
+      class_option :pwa, type: :boolean, default: false
+
+      def self.source_root
+        File.expand_path("templates", __dir__)
+      end
+
+      def ensure_pwa_prerequisite
+        return if options[:pwa]
+
+        say "develoz:push requires --pwa. Enabling PWA automatically.", :yellow
+        require "generators/develoz/pwa/pwa_generator"
+        pwa = PwaGenerator.new([], {}, destination_root: destination_root)
+        PwaGenerator.public_instance_methods(false).each { |m| pwa.public_send(m) }
+      end
+
+      def add_web_push_gem
+        add_gem "web-push"
+      end
+
+      def create_push_subscription_model
+        template "app/models/push_subscription.rb.tt",
+                 "app/models/push_subscription.rb"
+      end
+
+      def create_push_subscription_migration
+        return if migration_exists?("create_push_subscriptions")
+
+        template "db/migrate/create_push_subscriptions.rb.tt",
+                 "db/migrate/#{next_migration_timestamp}_create_push_subscriptions.rb"
+      end
+
+      def create_push_notification_service
+        template "app/services/push_notification_service.rb.tt",
+                 "app/services/push_notification_service.rb"
+      end
+
+      def create_service_worker_push_handlers
+        template "app/views/pwa/sw_push_handlers.js.tt",
+                 "app/views/pwa/sw_push_handlers.js"
+      end
+
+      def create_subscription_js
+        template "app/javascript/pwa/subscription.js.tt",
+                 "app/javascript/pwa/subscription.js"
+      end
+
+      def append_vapid_env
+        append_env "VAPID_PUBLIC_KEY", ""
+        append_env "VAPID_PRIVATE_KEY", ""
+        append_env "VAPID_SUBJECT", "mailto:noreply@example.com"
+      end
+    end
+  end
+end

data/lib/generators/develoz/push/templates/app/javascript/pwa/subscription.js.tt

@@ -0,0 +1,57 @@
+// Develoz PWA push subscription logic
+// Subscribes the user to web push notifications using VAPID public key
+
+async function subscribeToPush() {
+  if (!("serviceWorker" in navigator) || !("PushManager" in window)) {
+    console.warn("Push notifications are not supported in this browser")
+    return null
+  }
+
+  const registration = await navigator.serviceWorker.ready
+  const existingSubscription = await registration.pushManager.getSubscription()
+
+  if (existingSubscription) {
+    return existingSubscription
+  }
+
+  const response = await fetch("/push_subscriptions/vapid_public_key", {
+    headers: { Accept: "application/json" }
+  })
+  const { public_key } = await response.json()
+
+  const subscription = await registration.pushManager.subscribe({
+    userVisibleOnly: true,
+    applicationServerKey: urlBase64ToUint8Array(public_key)
+  })
+
+  await fetch("/push_subscriptions", {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+      "X-CSRF-Token": document.querySelector('meta[name="csrf-token"]')?.content || ""
+    },
+    body: JSON.stringify({
+      subscription: {
+        endpoint: subscription.endpoint,
+        keys: subscription.toJSON().keys
+      }
+    })
+  })
+
+  return subscription
+}
+
+function urlBase64ToUint8Array(base64String) {
+  const padding = "=".repeat((4 - (base64String.length % 4)) % 4)
+  const base64 = (base64String + padding).replace(/-/g, "+").replace(/_/g, "/")
+  const rawData = atob(base64)
+  const outputArray = new Uint8Array(rawData.length)
+
+  for (let i = 0; i < rawData.length; ++i) {
+    outputArray[i] = rawData.charCodeAt(i)
+  }
+
+  return outputArray
+}
+
+export { subscribeToPush }

data/lib/generators/develoz/push/templates/app/models/push_subscription.rb.tt

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class PushSubscription < ApplicationRecord
+  belongs_to :user, optional: true
+
+  validates :endpoint, presence: true, uniqueness: true
+  validates :p256dh, presence: true
+  validates :auth, presence: true
+
+  # Purge subscriptions whose endpoint is no longer valid (410 Gone).
+  def self.purge_invalid!(response)
+    where(endpoint: response&.request&.uri&.to_s).destroy_all if response&.code == 410
+  end
+end

data/lib/generators/develoz/push/templates/app/services/push_notification_service.rb.tt

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "web-push"
+
+class PushNotificationService
+  VAPID_SUBJECT_DEFAULT = "mailto:noreply@example.com".freeze
+  private_constant :VAPID_SUBJECT_DEFAULT
+
+  def self.send_notification(subscription, title:, body:, url: nil, icon: nil)
+    payload = { title: title, body: body }
+    payload[:url] = url if url
+    payload[:icon] = icon if icon
+
+    WebPush.payload_send(
+      message: payload.to_json,
+      endpoint: subscription.endpoint,
+      p256dh: subscription.p256dh,
+      auth: subscription.auth,
+      vapid: vapid_options,
+      ttl: 24 * 60 * 60
+    )
+  rescue WebPush::ExpiredSubscription, WebPush::InvalidSubscription
+    subscription.destroy
+  rescue WebPush::Error => e
+    Rails.logger.warn("Push notification failed: #{e.message}")
+  end
+
+  def self.vapid_options
+    {
+      subject: ENV.fetch("VAPID_SUBJECT", VAPID_SUBJECT_DEFAULT),
+      public_key: ENV.fetch("VAPID_PUBLIC_KEY"),
+      private_key: ENV.fetch("VAPID_PRIVATE_KEY")
+    }
+  end
+  private_class_method :vapid_options
+end

data/lib/generators/develoz/push/templates/app/views/pwa/sw_push_handlers.js.tt

@@ -0,0 +1,49 @@
+// Develoz PWA service worker push event handlers
+// Imported by the main service worker via importScripts("/sw_push_handlers")
+
+self.addEventListener("push", (event) => {
+  let payload = { title: "Notification", body: "" }
+
+  try {
+    if (event.data) {
+      payload = event.data.json()
+    }
+  } catch {
+    payload = { title: "Notification", body: event.data ? event.data.text() : "" }
+  }
+
+  const options = {
+    body: payload.body || "",
+    icon: payload.icon || "/icon-192.png",
+    badge: payload.badge || "/icon-192.png",
+    data: { url: payload.url || "/" }
+  }
+
+  event.waitUntil(
+    self.registration.showNotification(payload.title || "Notification", options)
+  )
+})
+
+self.addEventListener("notificationclick", (event) => {
+  event.notification.close()
+
+  const targetUrl = event.notification.data && event.notification.data.url
+    ? event.notification.data.url
+    : "/"
+
+  event.waitUntil(
+    (async () => {
+      const allClients = await self.clients.matchAll({ type: "window", includeUncontrolled: true })
+
+      for (const client of allClients) {
+        if (client.url.includes(targetUrl) && "focus" in client) {
+          return client.focus()
+        }
+      }
+
+      if (self.clients.openWindow) {
+        return self.clients.openWindow(targetUrl)
+      }
+    })()
+  )
+})

data/lib/generators/develoz/push/templates/constants_env.tt

@@ -0,0 +1,5 @@
+# VAPID keys for web push notifications
+# Generate with: ruby -e "require 'web-push'; k = WebPush.generate_key; puts \"VAPID_PUBLIC_KEY=#{k.public_key}\"; puts \"VAPID_PRIVATE_KEY=#{k.private_key}\""
+VAPID_PUBLIC_KEY=
+VAPID_PRIVATE_KEY=
+VAPID_SUBJECT=mailto:noreply@example.com

data/lib/generators/develoz/push/templates/db/migrate/create_push_subscriptions.rb.tt

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreatePushSubscriptions < ActiveRecord::Migration[8.0]
+  def change
+    create_table :push_subscriptions do |t|
+      t.string :endpoint, null: false
+      t.string :p256dh, null: false
+      t.string :auth, null: false
+      t.references :user, foreign_key: true, index: true
+
+      t.timestamps
+    end
+    add_index :push_subscriptions, :endpoint, unique: true
+  end
+end

data/lib/generators/develoz/pwa/pwa_generator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "develoz"
+
+module Develoz
+  module Generators
+    class PwaGenerator < Develoz::Generators::Base
+      def self.source_root
+        File.expand_path("templates", __dir__)
+      end
+
+      def create_pwa_controller
+        template "app/controllers/pwa_controller.rb.tt",
+                 "app/controllers/pwa_controller.rb"
+      end
+
+      def create_manifest_view
+        template "app/views/pwa/manifest.json.erb.tt",
+                 "app/views/pwa/manifest.json.erb"
+      end
+
+      def create_service_worker_view
+        template "app/views/pwa/service-worker.js.tt",
+                 "app/views/pwa/service-worker.js.erb"
+      end
+
+      def create_offline_page
+        template "app/views/pwa/offline.html.erb.tt",
+                 "app/views/pwa/offline.html.erb"
+      end
+
+      def create_registration_js
+        template "app/javascript/pwa/registration.js.tt",
+                 "app/javascript/pwa/registration.js"
+      end
+
+      def insert_pwa_routes
+        routes_snippet = File.read(File.join(self.class.source_root, "routes.rb.tt")).strip
+        inject_once(into: "config/routes.rb",
+                    content: routes_snippet,
+                    before: /^end\s*$/,
+                    marker: "pwa#manifest")
+      end
+    end
+  end
+end

data/lib/generators/develoz/pwa/templates/app/controllers/pwa_controller.rb.tt

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class PwaController < ApplicationController
+  skip_forgery_protection
+
+  def manifest
+    render template: "pwa/manifest", layout: false
+  end
+
+  def service_worker
+    render template: "pwa/service-worker", layout: false
+  end
+
+  def offline
+    render template: "pwa/offline", layout: false
+  end
+end

data/lib/generators/develoz/pwa/templates/app/javascript/pwa/registration.js.tt

@@ -0,0 +1,25 @@
+// Develoz PWA service worker registration
+// Registers the service worker and handles update found
+
+if ("serviceWorker" in navigator) {
+  window.addEventListener("load", () => {
+    navigator.serviceWorker
+      .register("/service-worker")
+      .then((registration) => {
+        registration.addEventListener("updatefound", () => {
+          const installingWorker = registration.installing
+          if (installingWorker) {
+            installingWorker.addEventListener("statechange", () => {
+              if (installingWorker.state === "installed" && navigator.serviceWorker.controller) {
+                // New version available - reload to activate
+                window.location.reload()
+              }
+            })
+          }
+        })
+      })
+      .catch((error) => {
+        console.error("Service worker registration failed:", error)
+      })
+  })
+}

data/lib/generators/develoz/pwa/templates/app/views/pwa/manifest.json.erb.tt

@@ -0,0 +1,24 @@
+{
+  "name": "<%= app_class %>",
+  "short_name": "<%= app_class %>",
+  "icons": [
+    {
+      "src": "/icon.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    },
+    {
+      "src": "/icon.png",
+      "type": "image/png",
+      "sizes": "512x512",
+      "purpose": "maskable"
+    }
+  ],
+  "start_url": "/",
+  "scope": "/",
+  "display": "standalone",
+  "orientation": "natural",
+  "description": "<%= app_class %>.",
+  "theme_color": "#ffffff",
+  "background_color": "#ffffff"
+}