RubyGems - ruby_cms - Versions diffs - 0.1.0 - Mend

ruby_cms 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 (131) hide show

data/lib/generators/ruby_cms/templates/admin.html.erb ADDED Viewed

@@ -0,0 +1,82 @@
+<%# Single admin layout for app and RubyCMS. Uses RubyCMS sidebar, flash, content_for. %>
+<!DOCTYPE html>
+<html lang="<%= I18n.locale %>">
+  <head>
+    <title><%= content_for(:title) || "Admin Panel" %></title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <meta name="rails-env" content="<%= Rails.env %>">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <%= favicon_link_tag asset_path("favicon.ico") rescue nil %>
+    <link rel="icon" type="image/png" sizes="32x32" href="<%= asset_path("favicon-32x32.png") %>">
+    <link rel="icon" type="image/png" sizes="16x16" href="<%= asset_path("favicon-16x16.png") %>">
+    <link rel="apple-touch-icon" href="<%= asset_path("apple-touch-icon.png") %>">
+    <link rel="manifest" href="<%= asset_path("site.webmanifest") %>">
+    <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+    <%= stylesheet_link_tag "tailwind", "data-turbo-track": "reload" %>
+    <%= stylesheet_link_tag "actiontext", "data-turbo-track": "reload" rescue nil %>
+    <%= javascript_importmap_tags "admin" %>
+  </head>
+  <body class="min-h-screen bg-gray-50 text-gray-900">
+    <div class="flex h-screen overflow-hidden" data-controller="ruby-cms--mobile-menu">
+      <%# Mobile menu toggle (visible on md and below) %>
+      <button type="button" class="md:hidden fixed top-4 left-4 z-50 inline-flex items-center justify-center p-2 bg-white border border-gray-200/80 rounded-lg shadow-sm cursor-pointer" aria-label="Toggle menu" data-action="click->ruby-cms--mobile-menu#toggle">
+        <svg class="w-6 h-6" fill="none" stroke="currentColor" viewBox="0 0 24 24">
+          <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 6h16M4 12h16M4 18h16"></path>
+        </svg>
+      </button>
+      <%= render "layouts/ruby_cms/admin_sidebar" %>
+      <%# Mobile overlay (JS adds class "show") %>
+      <div class="hidden fixed inset-0 bg-black/50 z-40 lg:hidden" data-ruby-cms--mobile-menu-target="overlay" data-action="click->ruby-cms--mobile-menu#close"></div>
+      <main class="flex-1 flex flex-col overflow-hidden bg-gray-50 min-w-0" role="main">
+        <% if content_for?(:full_width) %>
+          <%= yield %>
+        <% else %>
+          <div class="flex-1 flex flex-col min-h-0 p-6 overflow-y-auto bg-gray-50">
+            <div class="mx-auto w-full max-w-7xl">
+            <% if content_for?(:title) || content_for?(:header_actions) %>
+              <header class="flex-shrink-0 mb-4 <%= yield(:header_styles) if content_for?(:header_styles) %>">
+                <div class="flex flex-wrap items-center justify-between gap-4">
+                  <div>
+                    <% if content_for?(:title) %>
+                      <h1 class="text-lg font-semibold tracking-tight text-gray-900"><%= yield :title %></h1>
+                    <% end %>
+                    <% if content_for?(:breadcrumbs) %>
+                      <nav class="mt-0.5 text-sm text-gray-500" aria-label="Breadcrumb">
+                        <ol class="flex items-center flex-wrap gap-x-2 gap-y-1">
+                          <%= yield :breadcrumbs %>
+                        </ol>
+                      </nav>
+                    <% end %>
+                  </div>
+                  <% if content_for?(:header_actions) %>
+                    <div class="flex items-center flex-shrink-0">
+                      <%= yield :header_actions %>
+                    </div>
+                  <% end %>
+                </div>
+              </header>
+            <% elsif content_for?(:breadcrumbs) %>
+              <nav class="mb-4" aria-label="Breadcrumb">
+                <ol class="flex items-center space-x-2 text-sm text-gray-600">
+                  <%= content_for :breadcrumbs %>
+                </ol>
+              </nav>
+            <% end %>
+            <%= render "layouts/ruby_cms/admin_flash_messages" %>
+            <%= yield %>
+            </div>
+          </div>
+        <% end %>
+      </main>
+    </div>
+  </body>
+</html>

data/lib/generators/ruby_cms/templates/ruby_cms.rb ADDED Viewed

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+# RubyCMS configuration
+# -----------------------------------------------------------------------------
+# Session / cookie hardening (recommended for /admin)
+# Apply in config/initializers/session_store.rb or your session config:
+#
+#   Rails.application.config.session_store :cookie_store,
+#     key: "_session",
+#     httponly: true,
+#     same_site: :lax,        # or :strict
+#     secure: Rails.env.production?,
+#     expire_after: 2.weeks
+#
+# In your auth flow: rotate session on sign-in (e.g. Session.find_by(...)&.destroy
+# before creating a new one). Use safe return-to: validate redirect paths to same
+# origin or allowlist; avoid open redirects.
+# -----------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
+# CSP (Content Security Policy): set sensible defaults; document overrides.
+# Example in config/initializers/content_security_policy.rb:
+#
+#   Rails.application.config.content_security_policy do |p|
+#     p.default_src :self; p.script_src :self; p.style_src :self, :unsafe_inline
+#   end
+# -----------------------------------------------------------------------------
+RubyCms.configure do |c|
+  # Controller from which all /admin controllers inherit.
+  # Must provide current_user and run require_authentication.
+  # c.admin_base_controller = "ApplicationController"
+  # User model class name for permissions. Change if your app uses a different name.
+  # c.user_class_name = "User"
+  # When no Permission records exist, allow user.admin? to access /admin (bootstrap).
+  # Set to false to require permissions from the start.
+  # c.bootstrap_admin_with_role = true
+  # Redirect path when unauthenticated or not permitted (default: "/").
+  # Use "/session/new" to send to sign-in.
+  # c.unauthorized_redirect_path = "/"
+  # Visual editor: allowlist of page_key => template path.
+  # c.preview_templates = { "home" => "pages/home", "about" => "pages/about" }
+  # Preview data proc to pass instance variables.
+  # c.preview_data = ->(page_key, view) { { products: Product.limit(5) } }
+  # Optional hook: customize Ahoy visit scope (e.g. exclude internal traffic)
+  # c.analytics_visit_scope = ->(scope) { scope.where.not(ip: ["127.0.0.1"]) }
+  # Optional hook: customize Ahoy event scope
+  # c.analytics_event_scope = ->(scope) { scope }
+  # Optional hook: provide extra dashboard cards
+  # c.analytics_extra_cards = lambda do |start_date:, end_date:, period:, visits_scope:, events_scope:|
+  #   [{ title: "Custom KPI", value: visits_scope.where.not(utm_source: nil).count }]
+  # end
+  # -----------------------------------------------------------------------------
+  # Optional bootstrap values (initializer -> DB import, once)
+  #
+  # On first boot/install, RubyCMS imports matching keys from config.ruby_cms into
+  # ruby_cms_preferences. After that, DB settings are source of truth.
+  #
+  # Example bootstrap values:
+  # c.analytics_default_period = "week"
+  # c.analytics_max_date_range_days = 365
+  # c.analytics_cache_duration_seconds = 600
+  # c.analytics_max_popular_pages = 10
+  # c.analytics_max_top_visitors = 10
+  # c.analytics_high_volume_threshold = 1000
+  # c.analytics_rapid_request_threshold = 50
+  # c.pagination_min_per_page = 5
+  # c.pagination_max_per_page = 200
+  # c.reserved_key_prefixes = %w[admin_]
+  # c.image_content_types = %w[image/png image/jpeg image/gif image/webp]
+  # c.image_max_size = 5 * 1024 * 1024
+  #
+  # To re-run manually:
+  #   rails ruby_cms:import_initializer_settings
+  # -----------------------------------------------------------------------------
+end

data/lib/ruby_cms/app_integration.rb ADDED Viewed

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+module RubyCms
+  # App Integration: Connect CMS to host app features
+  module AppIntegration
+    # Link App: Connect CMS pages to app routes/controllers
+    module LinkApp
+      # Register an app route that can be linked from CMS
+      # @param key [String] Unique identifier for the route
+      # @param route_name [String] Route helper name (e.g. "products_path", "user_dashboard_path")
+      # @param label [String] Display label
+      # @param description [String] Optional description
+      # @param params [Hash] Default route parameters
+      def self.register_route(key:, route_name:, label:, description: nil, params: {})
+        @registered_routes ||= {}
+        @registered_routes[key] = {
+          route_name:,
+          label:,
+          description:,
+          params:
+        }
+      end
+      # Get all registered routes
+      def self.registered_routes
+        @registered_routes || {}
+      end
+      # Get a route by key
+      def self.get_route(key)
+        registered_routes[key.to_s]
+      end
+    end
+    # App Settings: Load app-specific settings/config into CMS context
+    module AppSettings
+      # Register a setting that can be loaded into CMS context
+      # @param key [String] Setting key
+      # @param loader [Proc] Callable that returns the setting value: ->(view_context) { ... }
+      def self.register_setting(key:, loader:)
+        @registered_settings ||= {}
+        @registered_settings[key.to_s] = loader
+      end
+      # Get all settings for a view context
+      def self.load_settings(view_context)
+        (@registered_settings || {}).transform_values do |loader|
+          loader.call(view_context)
+        end
+      end
+      # Get a specific setting
+      def self.get_setting(key, view_context)
+        loader = (@registered_settings || {})[key.to_s]
+        loader&.call(view_context)
+      end
+    end
+  end
+  # Convenience methods
+  class << self
+    # Register an app route
+    def register_app_route(**)
+      AppIntegration::LinkApp.register_route(**)
+    end
+    # Get registered routes
+    def app_routes
+      AppIntegration::LinkApp.registered_routes
+    end
+    # Register an app setting
+    def register_app_setting(**)
+      AppIntegration::AppSettings.register_setting(**)
+    end
+    # Load app settings for view context
+    def load_app_settings(view_context)
+      AppIntegration::AppSettings.load_settings(view_context)
+    end
+  end
+end

data/lib/ruby_cms/cli.rb ADDED Viewed

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+require "thor"
+module RubyCms
+  class CLI < Thor
+    default_task :setup_admin
+    desc "setup_admin",
+         "Interactively create or select the first admin user and grant full permissions"
+    def setup_admin
+      RunSetupAdmin.call(shell:)
+    end
+    private
+    def shell
+      @shell ||= Thor::Shell::Basic.new
+    end
+  end
+  # Logic for the interactive first-admin setup. Uses Thor::Shell for prompts.
+  class RunSetupAdmin
+    ADMIN_PERMISSION_KEYS = %w[
+      manage_admin manage_permissions manage_content_blocks manage_visitor_errors
+    ].freeze
+    class << self
+      def call(shell: Thor::Shell::Basic.new)
+        new(shell:).call
+      end
+    end
+    def initialize(shell:)
+      @shell = shell
+    end
+    def call
+      RubyCms::Permission.ensure_defaults!
+      user_class = Rails.application.config.ruby_cms.user_class_name.constantize
+      email_attr = user_class.column_names.include?("email_address") ? :email_address : :email
+      user = choose_or_create_user(user_class, email_attr)
+      return if user.nil?
+      grant_permissions(user)
+      notify_success(user, email_attr)
+    end
+    private
+    def notify_success(user, email_attr)
+      @shell.say(
+        "\nDone. #{user.public_send(email_attr)}
+        now has: #{ADMIN_PERMISSION_KEYS.join(', ')}.", :green
+      )
+      @shell.say("Visit /admin to sign in.", :green)
+    end
+    def choose_or_create_user(user_class, email_attr)
+      users = fetch_recent_users(user_class)
+      if users.any?
+        prompt_existing_users(users, email_attr)
+      else
+        @shell.say("\nNo users yet. Create the first admin user.")
+        create_user(user_class, email_attr)
+      end
+    end
+    def fetch_recent_users(user_class)
+      user_class.order(id: :asc).limit(20).to_a
+    end
+    def prompt_existing_users(users, email_attr)
+      display_users(users, email_attr)
+      choice = ask_for_user_choice(users.size)
+      case choice
+      when "0"
+        find_or_create_by_email(users.first.class, email_attr)
+      else
+        select_user_or_fallback(users, choice.to_i, email_attr)
+      end
+    end
+    def display_users(users, email_attr)
+      @shell.say("\nExisting users:", :bold)
+      users.each_with_index do |u, i|
+        @shell.say("  #{i + 1}. #{u.public_send(email_attr)}")
+      end
+      @shell.say("  0. Enter another email (or create new user)")
+    end
+    def ask_for_user_choice(max)
+      @shell.ask("Select (0–#{max}):", default: "1").to_s.strip
+    end
+    def select_user_or_fallback(users, index, email_attr)
+      if index.between?(1, users.size)
+        users[index - 1]
+      else
+        find_or_create_by_email(users.first.class, email_attr)
+      end
+    end
+    def find_or_create_by_email(user_class, email_attr)
+      email = @shell.ask("Email:").to_s.strip
+      return nil if email.blank?
+      user = user_class.find_by(email_attr => email)
+      if user
+        user
+      else
+        @shell.say("User not found.")
+        create = @shell.yes?("Create new user with this email?", default: true)
+        create ? create_user_with_email(user_class, email_attr, email) : nil
+      end
+    end
+    def create_user(user_class, email_attr)
+      email = @shell.ask("Email:").to_s.strip
+      return nil if email.blank?
+      create_user_with_email(user_class, email_attr, email)
+    end
+    def create_user_with_email(user_class, email_attr, email)
+      password, password_confirmation = ask_password_and_confirmation
+      return nil if password.blank? || password_confirmation.blank?
+      attrs = {
+        email_attr => email, password: password,
+        password_confirmation: password_confirmation
+      }
+      user_class.create!(attrs)
+    rescue ActiveRecord::RecordInvalid => e
+      @shell.say("Could not create user: #{e.record.errors.full_messages.to_sentence}", :red)
+      nil
+    end
+    def ask_password_and_confirmation
+      password = ask_password("Password:")
+      return [nil, nil] if password.blank?
+      password_confirmation = ask_password("Password (again):")
+      return [password, password_confirmation] unless password != password_confirmation
+      @shell.say("Passwords did not match. Aborted.", :red)
+      [nil, nil]
+    end
+    def ask_password(prompt)
+      if $stdin.respond_to?(:noecho) && $stdin.tty?
+        @shell.say("#{prompt} (hidden)")
+        $stdin.noecho { $stdin.gets&.chomp }.to_s
+      else
+        @shell.ask("#{prompt}:").to_s.strip
+      end
+    end
+    def grant_permissions(user)
+      ADMIN_PERMISSION_KEYS.each do |key|
+        perm = RubyCms::Permission.find_by!(key:)
+        RubyCms::UserPermission.find_or_create_by!(user: user, permission: perm)
+      end
+    end
+  end
+end

data/lib/ruby_cms/content_blocks_grouping.rb ADDED Viewed

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module RubyCms
+  module ContentBlocksGrouping
+    Row = ::Struct.new(:key, :id, :locale, :title, :content_type, :published, :content_block) do
+      def published?
+        published
+      end
+      def model_name # rubocop:disable Rails/Delegate
+        ::ContentBlock.model_name
+      end
+    end
+    class << self
+      # rubocop:disable Rails/Blank -- use plain Ruby for standalone unit specs without Rails
+      def group_by_key(collection)
+        return [] if collection.nil? || collection.empty?
+        collection
+          .group_by(&:key)
+          .map {|key, blocks| build_row(key, blocks) }
+          .sort_by(&:key)
+      end
+      # rubocop:enable Rails/Blank
+      def build_row(key, blocks)
+        first = blocks.first
+        Row.new(
+          key: key,
+          id: first.id,
+          locale: blocks.map(&:locale).sort.join(", "),
+          title: first.title,
+          content_type: first.content_type,
+          published: blocks.all?(&:published?),
+          content_block: first
+        )
+      end
+    end
+  end
+end