RubyGems - develoz-rails - Versions diffs - 0.1.0 - Mend

develoz-rails 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (172) hide show

data/lib/generators/develoz/pwa/templates/app/views/pwa/offline.html.erb.tt ADDED Viewed

@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>You're offline</title>
+  <style>
+    body {
+      font-family: system-ui, -apple-system, sans-serif;
+      display: flex;
+      align-items: center;
+      justify-content: center;
+      min-height: 100vh;
+      margin: 0;
+      background: #f5f5f5;
+      color: #333;
+    }
+    .container {
+      text-align: center;
+      padding: 2rem;
+    }
+    h1 {
+      font-size: 1.5rem;
+      margin-bottom: 0.5rem;
+    }
+    p {
+      color: #666;
+      margin-bottom: 1.5rem;
+    }
+    button {
+      padding: 0.75rem 1.5rem;
+      font-size: 1rem;
+      background: #333;
+      color: #fff;
+      border: none;
+      border-radius: 0.375rem;
+      cursor: pointer;
+    }
+    button:hover {
+      background: #555;
+    }
+  </style>
+</head>
+<body>
+  <div class="container">
+    <h1>You're offline</h1>
+    <p>You appear to be offline. Please check your connection and try again.</p>
+    <button onclick="window.location.reload()">Retry</button>
+  </div>
+</body>
+</html>

data/lib/generators/develoz/pwa/templates/app/views/pwa/service-worker.js.tt ADDED Viewed

@@ -0,0 +1,109 @@
+// Develoz PWA service worker - offline caching + offline fallback page
+// Push notification handlers are added by the develoz:push generator (T27)
+const STATIC_CACHE = "develoz-static-v1"
+const PAGES_CACHE = "develoz-pages-v1"
+const OFFLINE_URL = "/offline"
+// App shell assets to pre-cache on install
+const APP_SHELL = [
+  "/",
+  OFFLINE_URL
+]
+// install: pre-cache the app shell
+self.addEventListener("install", (event) => {
+  event.waitUntil(
+    caches.open(STATIC_CACHE).then((cache) => cache.addAll(APP_SHELL))
+  )
+  self.skipWaiting()
+})
+// activate: clean up old caches
+self.addEventListener("activate", (event) => {
+  const validCaches = [STATIC_CACHE, PAGES_CACHE]
+  event.waitUntil(
+    caches.keys().then((cacheNames) =>
+      Promise.all(
+        cacheNames
+          .filter((name) => !validCaches.includes(name))
+          .map((name) => caches.delete(name))
+      )
+    )
+  )
+  self.clients.claim()
+})
+// fetch: cache-first for app shell, network-first for everything else
+self.addEventListener("fetch", (event) => {
+  const request = event.request
+  // Only handle GET requests
+  if (request.method !== "GET") return
+  const url = new URL(request.url)
+  // Same-origin only
+  if (url.origin !== self.location.origin) return
+  // Cache-first for static assets (JS, CSS, fonts, images)
+  if (isStaticAsset(request)) {
+    event.respondWith(cacheFirst(request, STATIC_CACHE))
+    return
+  }
+  // Network-first for HTML pages with offline fallback
+  if (request.mode === "navigate" || request.headers.get("accept")?.includes("text/html")) {
+    event.respondWith(networkFirstWithOffline(request))
+    return
+  }
+  // Network-first for everything else
+  event.respondWith(networkFirst(request, PAGES_CACHE))
+})
+function isStaticAsset(request) {
+  const destination = request.destination
+  return ["style", "script", "font", "image", "manifest"].includes(destination)
+}
+async function cacheFirst(request, cacheName) {
+  const cache = await caches.open(cacheName)
+  const cached = await cache.match(request)
+  if (cached) return cached
+  try {
+    const response = await fetch(request)
+    if (response.ok) cache.put(request, response.clone())
+    return response
+  } catch {
+    return new Response("", { status: 504, statusText: "Gateway Timeout" })
+  }
+}
+async function networkFirst(request, cacheName) {
+  const cache = await caches.open(cacheName)
+  try {
+    const response = await fetch(request)
+    if (response.ok) cache.put(request, response.clone())
+    return response
+  } catch {
+    const cached = await cache.match(request)
+    return cached || new Response("", { status: 504, statusText: "Gateway Timeout" })
+  }
+}
+async function networkFirstWithOffline(request) {
+  const cache = await caches.open(PAGES_CACHE)
+  try {
+    const response = await fetch(request)
+    if (response.ok) cache.put(request, response.clone())
+    return response
+  } catch {
+    const cached = await cache.match(request)
+    if (cached) return cached
+    // Fall back to the offline page
+    const offlineCache = await caches.open(STATIC_CACHE)
+    const offlinePage = await offlineCache.match(OFFLINE_URL)
+    return offlinePage || new Response("You're offline", { status: 503, headers: { "Content-Type": "text/html" } })
+  }
+}

data/lib/generators/develoz/pwa/templates/routes.rb.tt ADDED Viewed

@@ -0,0 +1,3 @@
+  get "manifest" => "pwa#manifest", as: :pwa_manifest
+  get "service-worker" => "pwa#service_worker", as: :pwa_service_worker
+  get "offline" => "pwa#offline", as: :pwa_offline

data/lib/generators/develoz/solid/solid_generator.rb ADDED Viewed

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require "develoz"
+module Develoz
+  module Generators
+    class SolidGenerator < Develoz::Generators::Base
+      def self.source_root
+        File.expand_path("templates", __dir__)
+      end
+      def add_solid_gems
+        add_gem "solid_queue"
+        add_gem "solid_cache"
+        add_gem "solid_cable"
+        add_gem "mission_control-jobs"
+      end
+      def create_queue_config
+        template "config/queue.yml.tt", "config/queue.yml"
+      end
+      def create_cache_config
+        template "config/cache.yml.tt", "config/cache.yml"
+      end
+      def create_cable_config
+        template "config/cable.yml.tt", "config/cable.yml"
+      end
+      def create_recurring_config
+        template "config/recurring.yml.tt", "config/recurring.yml"
+      end
+      def create_application_job
+        template "app/jobs/application_job.rb.tt", "app/jobs/application_job.rb"
+      end
+      def create_mission_control_initializer
+        template "config/initializers/mission_control.rb.tt", "config/initializers/mission_control.rb"
+      end
+      def create_solid_initializer
+        template "config/initializers/solid.rb.tt", "config/initializers/solid.rb"
+      end
+      def insert_mission_control_route
+        insert_route('mount MissionControl::Jobs::Engine, at: "/jobs"')
+      end
+    end
+  end
+end

data/lib/generators/develoz/solid/templates/app/jobs/application_job.rb.tt ADDED Viewed

@@ -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

data/lib/generators/develoz/solid/templates/config/cable.yml.tt ADDED Viewed

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+test:
+  adapter: test
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: <%= app_name %>_production

data/lib/generators/develoz/solid/templates/config/cache.yml.tt ADDED Viewed

@@ -0,0 +1,16 @@
+default: &default
+  store_options:
+    # Cap age of oldest cache entry to fulfill retention policies
+    # max_age: 5184000
+    max_size: 268435456
+    namespace: <%= ENV.fetch("RAILS_ENV", "development") %>
+development:
+  <<: *default
+test:
+  <<: *default
+production:
+  database: cache
+  <<: *default

data/lib/generators/develoz/solid/templates/config/initializers/mission_control.rb.tt ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+# Mission Control - Jobs authentication
+# Disable HTTP basic auth — Mission Control is gated behind the app's
+# authentication system instead (e.g. Rails 8 authentication via --auth).
+# When no authentication is configured, Mission Control is accessible
+# without credentials in development and test environments.
+MissionControl::Jobs.http_basic_auth_enabled = false

data/lib/generators/develoz/solid/templates/config/initializers/solid.rb.tt ADDED Viewed

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# Solid Queue, Cache, and Cable configuration
+Rails.application.configure do
+  config.active_job.queue_adapter = :solid_queue
+  config.cache_store = :solid_cache_store
+end

data/lib/generators/develoz/solid/templates/config/queue.yml.tt ADDED Viewed

@@ -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

data/lib/generators/develoz/solid/templates/config/recurring.yml.tt ADDED Viewed

@@ -0,0 +1,20 @@
+# 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
+development:
+  clear_solid_queue_finished_jobs:
+    command: "SolidQueue::Job.clear_finished_in_batches(sleep_between_batches: 0.3)"
+    schedule: every hour at minute 12
+production:
+  clear_solid_queue_finished_jobs:
+    command: "SolidQueue::Job.clear_finished_in_batches(sleep_between_batches: 0.3)"
+    schedule: every hour at minute 12

data/lib/generators/develoz/strict_loading/strict_loading_generator.rb ADDED Viewed

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require "develoz"
+module Develoz
+  module Generators
+    class StrictLoadingGenerator < Develoz::Generators::Base
+      def self.source_root
+        File.expand_path("templates", __dir__)
+      end
+      def create_strict_loading_initializer
+        template "config/initializers/strict_loading.rb.tt", "config/initializers/strict_loading.rb"
+      end
+    end
+  end
+end

data/lib/generators/develoz/strict_loading/templates/config/initializers/strict_loading.rb.tt ADDED Viewed

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# Strict loading configuration
+# Enables strict loading by default with n_plus_one_only mode.
+# Violations raise in test, log in development and production.
+Rails.application.config.active_record.strict_loading_by_default = true
+Rails.application.config.active_record.strict_loading_mode = :n_plus_one_only
+ActiveRecord.action_on_strict_loading_violation =
+  case Rails.env
+  when "test" then :raise
+  else :log
+  end

data/lib/generators/develoz/testing/templates/rspec.tt ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ --require spec_helper
2	+ --format documentation

data/lib/generators/develoz/testing/templates/rspec_parallel.tt ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ --require spec_helper
2	+ --format documentation

data/lib/generators/develoz/testing/templates/spec/rails_helper.rb.tt ADDED Viewed

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require "spec_helper"
+require_relative "../config/environment"
+require "rspec/rails"
+require "factory_bot"
+require "capybara/rspec"
+require "selenium-webdriver"
+Dir[Rails.root.join("spec/support/**/*.rb")].sort.each { |f| require f }
+RSpec.configure do |config|
+  config.fixture_paths = [ "#{::Rails.root}/spec/fixtures" ]
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+  config.filter_rails_from_backtrace!
+end
+Capybara.register_driver :headless_chrome do |app|
+  options = Selenium::WebDriver::Chrome::Options.new
+  options.add_argument("--headless=new")
+  options.add_argument("--no-sandbox")
+  options.add_argument("--disable-gpu")
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
+end
+Capybara.javascript_driver = :headless_chrome
+FactoryBot.definition_file_paths = [ File.expand_path("factories", __dir__) ]
+FactoryBot.find_definitions
+ActiveRecord::Migration.maintain_test_schema!

data/lib/generators/develoz/testing/templates/spec/spec_helper.rb.tt ADDED Viewed

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require "simplecov"
+require "simplecov-lcov"
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::LcovFormatter
+]
+SimpleCov.start do
+  enable_coverage :branch
+  minimum_coverage line: 100, branch: 100
+  coverage_dir "public/coverage"
+  command_name "RSpec_#{ENV['TEST_ENV_NUMBER']}" if ENV['TEST_ENV_NUMBER']
+  use_merging true
+  add_filter %w[/spec/ /config/ /db/]
+  add_filter %w[/bin/ *.sh]
+end
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

data/lib/generators/develoz/testing/testing_generator.rb ADDED Viewed

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require "develoz"
+module Develoz
+  module Generators
+    class TestingGenerator < Develoz::Generators::Base
+      def self.source_root
+        File.expand_path("templates", __dir__)
+      end
+      def add_test_gems
+        add_gem "rspec-rails", group: %i[development test]
+        add_gem "capybara", group: %i[test]
+        add_gem "selenium-webdriver", group: %i[test]
+        add_gem "simplecov", require: false, group: %i[test]
+        add_gem "simplecov-lcov", require: false, group: %i[test]
+        add_gem "parallel_tests", group: %i[test]
+        add_gem "factory_bot_rails", group: %i[test]
+      end
+      def create_rspec_config
+        template "rspec.tt", ".rspec"
+      end
+      def create_spec_helper
+        template "spec/spec_helper.rb.tt", "spec/spec_helper.rb"
+      end
+      def create_rails_helper
+        template "spec/rails_helper.rb.tt", "spec/rails_helper.rb"
+      end
+      def create_rspec_parallel_config
+        template "rspec_parallel.tt", ".rspec_parallel"
+      end
+    end
+  end
+end

data/lib/generators/develoz/tooling/templates/constants.rb.tt ADDED Viewed

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+## Assign all environment variables used by the Rails app to constants for easy access and tracking
+module Constants
+  DATABASE_HOST = ENV.fetch("DATABASE_HOST", "localhost")
+  DATABASE_PORT = ENV.fetch("DATABASE_PORT", 5432)
+  DATABASE_NAME = ENV.fetch("DATABASE_NAME", "<%= app_name %>")
+  TEST_DATABASE_NAME = ENV.fetch("TEST_DATABASE_NAME", "#{DATABASE_NAME}_test")
+  REDIS_URL = ENV.fetch("REDIS_URL", "redis://localhost:6379/#{ENV.fetch("TEST_ENV_NUMBER", 1)}")
+  RAILS_MAX_THREADS = ENV.fetch("RAILS_MAX_THREADS", `nproc || echo 2`.strip.to_i * 5)
+  SERVER_PORT = ENV.fetch("SERVER_PORT", 3000)
+  HOST = ENV.fetch("APP_HOST") { ENV.fetch("HOST", "localhost:#{SERVER_PORT}") }
+  CACHING_DEV = ENV.fetch("CACHING_DEV", nil) == "true" # Enable caching in development if set to "true"
+  MEMCACHIER_SERVERS = ENV.fetch("MEMCACHIER_SERVERS", "").split(",")
+  APP_NAME = ENV.fetch("APP_NAME", "<%= app_class %>")
+  # additional constants appended by generators
+end

data/lib/generators/develoz/tooling/templates/env.example.tt ADDED Viewed

@@ -0,0 +1,4 @@
+# Application Configuration
+APP_NAME=<%= app_name %>
+DATABASE_URL=
+RAILS_ENV=development

data/lib/generators/develoz/tooling/templates/vscode/extensions.json.tt ADDED Viewed

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "Shopify.ruby-lsp",
+    "EditorConfig.EditorConfig",
+    "GitHub.copilot",
+    "ms-vscode.makefile-tools"
+  ]
+}

data/lib/generators/develoz/tooling/templates/vscode/settings.json.tt ADDED Viewed

@@ -0,0 +1,26 @@
+{
+  "[ruby]": {
+    "editor.defaultFormatter": "Shopify.ruby-lsp",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll.rubocop": "explicit"
+    }
+  },
+  "files.trimTrailingWhitespace": true,
+  "files.insertFinalNewline": true,
+  "editor.formatOnSave": true,
+  "editor.rulers": [80, 120],
+  "files.exclude": {
+    "**/tmp": true,
+    "**/log": true,
+    "**/.git": true,
+    "**/coverage": true,
+    "**/.rspec_status": true
+  },
+  "search.exclude": {
+    "**/node_modules": true,
+    "**/tmp": true,
+    "**/log": true,
+    "**/coverage": true
+  }
+}

data/lib/generators/develoz/tooling/templates/vscode/tasks.json.tt ADDED Viewed

@@ -0,0 +1,26 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "rspec",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "rspec"],
+      "problemMatcher": [],
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      }
+    },
+    {
+      "label": "rubocop",
+      "type": "shell",
+      "command": "bundle",
+      "args": ["exec", "rubocop"],
+      "problemMatcher": [],
+      "group": {
+        "kind": "build"
+      }
+    }
+  ]
+}

data/lib/generators/develoz/tooling/tooling_generator.rb ADDED Viewed

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require "develoz"
+module Develoz
+  module Generators
+    class ToolingGenerator < Develoz::Generators::Base
+      def self.source_root
+        File.expand_path("templates", __dir__)
+      end
+      def create_vscode
+        template "vscode/settings.json.tt",   ".vscode/settings.json"
+        template "vscode/extensions.json.tt", ".vscode/extensions.json"
+        template "vscode/tasks.json.tt",      ".vscode/tasks.json"
+      end
+      def create_env_files
+        template "env.example.tt", ".env.example"
+        create_file ".env", "" unless File.exist?(File.join(destination_root, ".env"))
+        ensure_gitignore(".env")
+      end
+      def create_constants
+        template "constants.rb.tt", "config/initializers/constants.rb"
+      end
+      def add_dotenv
+        add_gem "dotenv-rails", group: %i[development test]
+      end
+    end
+  end
+end

data/lib/generators/develoz/ui/templates/bin/setup_develoz_ui.tt ADDED Viewed

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+set -e
+# Setup script for the develoz-ui submodule.
+# Initializes the develoz-ui git submodule at vendor/develoz-ui.
+#
+# If the submodule is not initialized, the develoz_ui gem will fail to load
+# in development/test environments where it uses `path: "vendor/develoz-ui"`.
+# In production, the gem is fetched from GitHub directly.
+echo "Initializing develoz-ui submodule..."
+git submodule update --init --recursive vendor/develoz-ui
+if [ ! -d "vendor/develoz-ui" ] || [ -z "$(ls -A vendor/develoz-ui 2>/dev/null)" ]; then
+  echo "ERROR: develoz-ui submodule is not initialized."
+  echo "Run 'bin/setup_develoz_ui' to initialize it."
+  exit 1
+fi
+echo "develoz-ui submodule is ready."

data/lib/generators/develoz/ui/ui_generator.rb ADDED Viewed

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require "develoz"
+module Develoz
+  module Generators
+    class UiGenerator < Develoz::Generators::Base
+      def self.source_root
+        File.expand_path("templates", __dir__)
+      end
+      def add_develoz_ui_gems
+        inject_once(
+          into: "Gemfile",
+          content: <<~RUBY
+            group :development, :test do
+              gem "develoz_ui", path: "vendor/develoz-ui"
+            end
+            group :production do
+              gem "develoz_ui", github: "develoz-com/develoz-ui"
+            end
+          RUBY
+        )
+      end
+      def create_gitmodules
+        gitmodules_path = File.join(destination_root, ".gitmodules")
+        File.write(gitmodules_path, "") unless File.exist?(gitmodules_path)
+        inject_once(
+          into: ".gitmodules",
+          content: "[submodule \"vendor/develoz-ui\"]\n" \
+                   "\tpath = vendor/develoz-ui\n" \
+                   "\turl = git@github.com:develoz-com/develoz-ui.git"
+        )
+      end
+      def create_setup_script
+        template "bin/setup_develoz_ui.tt", "bin/setup_develoz_ui"
+        dest = File.join(destination_root, "bin/setup_develoz_ui")
+        File.chmod(0o755, dest)
+      end
+      def inject_importmap_pins
+        inject_once(
+          into: "config/importmap.rb",
+          content: <<~RUBY
+            # develoz-ui Stimulus controllers
+            pin "develoz-ui", to: "develoz-ui/index.js"
+            pin_all_from "vendor/develoz-ui/app/javascript/controllers", under: "develoz-ui/controllers"
+          RUBY
+        )
+      end
+    end
+  end
+end

data/lib/generators/develoz/versioning/templates/app/helpers/application_helper.rb.tt ADDED Viewed

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module ApplicationHelper
+  def app_version
+    APP_VERSION
+  end
+end