active_admin_prism 0.1.0

data/lib/active_admin/views/prism_sidebar.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Views
+    # Renders ActiveAdmin's existing Menu/MenuItem data (built by the
+    # standard `menu do |m| ... end` DSL in app/admin/*.rb, untouched) as a
+    # collapsible left sidebar instead of the default top nav bar.
+    #
+    # This is a drop-in replacement for ActiveAdmin::Views::Header: its
+    # #build(namespace, menu) signature matches Header#build exactly, so it
+    # can be swapped in via the supported extension point
+    #
+    #   ActiveAdmin::ViewFactory.register(header: ActiveAdmin::Views::PrismSidebar)
+    #
+    # (see ActiveAdminPrism.enable!) without touching Pages::Base or any
+    # layout template.
+    #
+    # It does not reuse ActiveAdmin::Views::Menu/MenuItem's Arbre builder
+    # verbs (`menu`/`menu_item`) because those are shared globally with
+    # ActiveAdmin::Views::TabbedNavigation; walking the ActiveAdmin::Menu
+    # data structure directly here keeps this theme fully isolated from
+    # anything else that might rely on the stock nav rendering.
+    class PrismSidebar < Component
+      # Fallback icons for ActiveAdmin's own default utility-nav items
+      # (id: "current_user" / id: "logout", added by
+      # Namespace#build_default_utility_nav) when the host hasn't set one
+      # explicitly via html_options: { icon: ... }.
+      DEFAULT_ITEM_ICONS = { "current_user" => :users, "logout" => :logout }.freeze
+
+      def build(namespace, menu)
+        super(id: "header", class: "prism-sidebar")
+
+        @namespace = namespace
+        @menu = menu
+        @utility_menu = namespace.fetch_menu(:utility_navigation)
+        @current_tab = assigns[:current_tab]
+
+        span(class: "prism-sidebar-mobile-toggle", data: { "prism-toggle-sidebar": true }) do
+          text_node ActiveAdminPrism::Icons.svg(:menu, css_class: "prism-nav-icon").html_safe
+        end
+
+        div class: "prism-sidebar-inner" do
+          div(class: "prism-sidebar-brand") { site_title @namespace }
+          render_language_switcher if ActiveAdminPrism.configuration.language_switcher
+          div(class: "prism-sidebar-scroll") do
+            div "Pages", class: "prism-nav-section-label"
+            render_menu @menu, class: "prism-nav"
+          end
+          if @utility_menu.items.any?
+            div(class: "prism-sidebar-utility") do
+              render_menu @utility_menu, class: "prism-nav prism-nav-utility"
+            end
+          end
+          if ActiveAdminPrism.configuration.sidebar_footer
+            div(class: "prism-sidebar-footer") { text_node footer_message }
+          end
+        end
+      end
+
+      private
+
+      # Same content ActiveAdmin::Views::Footer renders into the page's own
+      # #footer (custom config.footer text, or the default "Powered by
+      # Active Admin X.Y.Z") — moved here instead, so it's pinned below the
+      # nav/account area rather than trailing after the main content. The
+      # original #footer is hidden via CSS (scss-src/_sidebar.scss) rather
+      # than suppressed here, since Pages::Base#build_page always renders it
+      # and overriding that too is more surface area than a display:none.
+      def footer_message
+        custom = @namespace.footer(self)
+        return custom.html_safe if custom.present?
+
+        helpers.t(
+          "active_admin.powered_by",
+          active_admin: helpers.link_to("Active Admin", "https://activeadmin.info"),
+          version: ActiveAdmin::VERSION
+        ).html_safe
+      end
+
+      # A small "Languages" dropdown near the top of the sidebar — see
+      # ActiveAdminPrism::Configuration#language_switcher/#languages. Built
+      # here directly (rather than via the `admin.build_menu
+      # :utility_navigation do |menu| ... end` pattern ActiveAdmin apps
+      # normally use for this by hand) so it needs no per-namespace
+      # initializer code and stays in sync with runtime config changes —
+      # every render reads the current config, the same as
+      # sidebar_footer/collapsible_filters elsewhere in this gem.
+      def render_language_switcher
+        languages = ActiveAdminPrism.configuration.languages
+        return if languages.blank?
+
+        current = languages.find { |lang| lang[:locale].to_s == I18n.locale.to_s } || languages.first
+
+        div(class: "prism-sidebar-lang") do
+          span(class: "prism-lang-toggle", data: { "prism-toggle-lang": true }, "aria-expanded": "false") do
+            text_node ActiveAdminPrism::Icons.svg(:globe, css_class: "prism-nav-icon").html_safe
+            span(current[:label], class: "prism-lang-current")
+            text_node chevron_svg
+          end
+
+          ul(class: "prism-lang-menu") do
+            languages.each do |lang|
+              classes = ["prism-lang-option"]
+              classes << "active" if lang == current
+
+              li do
+                text_node helpers.link_to(lang[:label], language_url(lang), class: classes.join(" "))
+              end
+            end
+          end
+        end
+      end
+
+      # Each language entry's own :url (String/Proc/Symbol — same
+      # nil/String/Proc/Symbol convention as config.login_logo etc.,
+      # evaluated the same way item.url is above) wins when given, e.g. to
+      # hit a remote endpoint that switches the locale server-side before
+      # redirecting back:
+      #
+      #   { label: "English", locale: :en,
+      #     url: -> { "https://example.com/set_locale?locale=en&return_to=#{request.path}" } }
+      #
+      # With no :url, this defaults to url_for(locale: lang[:locale]) —
+      # appending "?locale=xx" to the *current* page, the same convention
+      # ActiveAdmin apps already reach for by hand for this (see the
+      # `url: proc { url_for(locale: l.locale) }` pattern in a hand-rolled
+      # `admin.build_menu :utility_navigation` block).
+      def language_url(lang)
+        return evaluated(lang[:url]) if lang[:url]
+
+        helpers.url_for(locale: lang[:locale])
+      end
+
+      def render_menu(menu_node, html_options = {})
+        ul(html_options) do
+          visible_items(menu_node).each { |item| render_item(item) }
+        end
+      end
+
+      def visible_items(menu_node)
+        menu_node.items
+                 .select { |item| helpers.render_in_context(self, item.should_display) }
+                 .sort_by { |item| [item.priority, evaluated(item.label).to_s] }
+      end
+
+      def render_item(item)
+        label = evaluated(item.label)
+        url = evaluated(item.url)
+        has_children = item.items.any?
+        active = item.current?(@current_tab)
+
+        classes = ["prism-nav-item"]
+        classes << "has-children" if has_children
+        classes << "active" if active
+        classes << "open" if has_children && active
+
+        li(id: "prism_nav_#{item.id}", class: classes.join(" ")) do
+          if has_children
+            render_group_toggle(item, label)
+            render_menu item, class: "prism-nav-submenu"
+          else
+            render_leaf(item, label, url)
+          end
+        end
+      end
+
+      def render_group_toggle(item, label)
+        span(class: "prism-nav-group-toggle", data: { "prism-toggle": true }) do
+          text_node icon_for(item)
+          span(label, class: "prism-nav-label")
+          text_node chevron_svg
+        end
+      end
+
+      def render_leaf(item, label, url)
+        link_options = item.html_options.except(:icon)
+        link_options[:class] = ["prism-nav-link", link_options[:class]].compact.join(" ")
+
+        if real_url?(url)
+          text_node helpers.link_to(link_body(item, label), url, **link_options)
+        else
+          span(class: "prism-nav-link") { link_body(item, label) }
+        end
+      end
+
+      def link_body(item, label)
+        helpers.safe_join([icon_for(item), helpers.content_tag(:span, label, class: "prism-nav-label")])
+      end
+
+      # Always returns an html_safe string (possibly empty) — never escape-able
+      # raw markup should cross a text_node/content_tag boundary unmarked.
+      def icon_for(item)
+        name = item.html_options[:icon] || DEFAULT_ITEM_ICONS[item.id]
+        return "".html_safe unless name
+
+        (ActiveAdminPrism::Icons.svg(name, css_class: "prism-nav-icon") || "").html_safe
+      end
+
+      def chevron_svg
+        ActiveAdminPrism::Icons.svg(:chevron_down, css_class: "prism-chevron").html_safe
+      end
+
+      def evaluated(value)
+        helpers.render_in_context(self, value)
+      end
+
+      def real_url?(url)
+        url.present? && url != "#"
+      end
+    end
+  end
+end

data/lib/active_admin_prism/configuration.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module ActiveAdminPrism
+  # Per-feature toggles, so a host can turn off individual pieces of the
+  # theme without forking it. Every flag defaults to the theme's normal,
+  # fully-on behavior — an app that never touches this class gets exactly
+  # what it got before this class existed.
+  #
+  #   ActiveAdminPrism.configure do |config|
+  #     config.sidebar = false               # keep AA's stock top nav
+  #     config.colorize_action_icons = false # plain text View/Edit/Delete
+  #     config.flash_auto_dismiss_seconds = 8
+  #   end
+  #
+  # `sidebar` and `colorize_action_icons` are pure server-side toggles
+  # (they just change what Ruby renders). `sidebar_footer` is server-side
+  # for whether the sidebar renders its own footer, plus a body class (like
+  # `styled_confirms`/`collapsible_filters`) so the CSS knows whether to
+  # keep hiding ActiveAdmin's original #footer. The flash_* flags are read
+  # by the client-side prism.js via data attributes on ".flashes". See
+  # lib/active_admin/views/flash_messages.rb for all of the body
+  # class/data-attribute rendering.
+  class Configuration
+    # Whether ActiveAdminPrism.enable! swaps ActiveAdmin's top nav for
+    # the Prism sidebar. Set to false to keep AA's stock header/TabbedNavigation
+    # while still getting the rest of the theme (panels, tables, forms,
+    # buttons, icons, flash/confirm styling) — useful for adopting Prism
+    # incrementally, or reverting just the navigation without uninstalling
+    # the gem.
+    attr_accessor :sidebar
+
+    # Whether index-table View/Edit/Delete links render as color-coded icon
+    # buttons (see lib/active_admin/views/index_table_actions.rb). false
+    # falls back to ActiveAdmin's plain text links.
+    attr_accessor :colorize_action_icons
+
+    # Whether row-level data-confirm links (View/Edit/Delete, or any other
+    # rails-ujs confirm) are routed through ActiveAdmin's own styled jQuery
+    # UI dialog instead of the native browser confirm(). Batch Actions
+    # confirms are unaffected either way — they always use that dialog.
+    attr_accessor :styled_confirms
+
+    # Whether flash messages get a dismiss ("x") button.
+    attr_accessor :flash_dismissible
+
+    # Whether flash messages disappear on their own after
+    # flash_auto_dismiss_seconds. Set to false to require a manual dismiss
+    # (or, if flash_dismissible is also false, to leave them on screen
+    # until the next page load, matching ActiveAdmin's own default).
+    attr_accessor :flash_auto_dismiss
+    attr_accessor :flash_auto_dismiss_seconds
+
+    # How long the fade/slide-out transition takes (in milliseconds) when a
+    # flash is dismissed — manually or automatically. Rendered as a data
+    # attribute and read by prism.js, which sets it as an inline
+    # transition-duration and uses the same value to time the element's
+    # actual removal from the DOM, so the two always stay in sync.
+    attr_accessor :flash_transition_ms
+
+    # Whether ActiveAdmin's "Filters" sidebar panel starts collapsed to a
+    # single icon button, expanding to the full form on click. false shows
+    # it fully expanded at all times, matching ActiveAdmin's own default.
+    attr_accessor :collapsible_filters
+
+    # Whether "Powered by Active Admin" (or your own config.footer text)
+    # moves from ActiveAdmin's page-level #footer into the sidebar, pinned
+    # below the account/logout area. false leaves the original #footer
+    # visible in its normal place instead (ActiveAdmin's own default).
+    attr_accessor :sidebar_footer
+
+    # Whether the sign-in page (Devise's sessions#new) gets Prism's
+    # centered-card/brand-mark treatment. false renders ActiveAdmin's
+    # original plain gradient-header login box instead (see
+    # app/views/active_admin/devise/sessions/new.html.erb).
+    attr_accessor :login_page
+
+    # Customizes the mark shown above the sign-in form. One of:
+    #   nil     - Prism's own built-in mark (default)
+    #   String  - raw HTML, e.g. a pre-rendered image_tag/svg — used as-is,
+    #             so make sure it's from a trusted source (html_safe)
+    #   Proc    - instance_exec'd in the view's own context (so helpers like
+    #             `image_tag`/`prism_icon` are available), e.g.:
+    #               config.login_logo = -> { image_tag "logo.svg", height: 40 }
+    #   Symbol  - a method name called on the view context
+    # Same nil/String/Proc/Symbol convention ActiveAdmin itself uses for
+    # config.footer / config.site_title_image.
+    attr_accessor :login_logo
+
+    # The name/title shown on the sign-in page. nil (default) falls back to
+    # ActiveAdmin's own `config.site_title`. Accepts a String, Proc, or
+    # Symbol — same convention as login_logo.
+    attr_accessor :login_app_name
+
+    # The line of text shown under the title on the sign-in page. nil means
+    # no tagline is rendered. Accepts a String, Proc, or Symbol — same
+    # convention as login_logo.
+    attr_accessor :login_tagline
+
+    # Whether a "Languages" dropdown renders near the top of the sidebar
+    # (below the brand, above the Pages nav), letting a visitor switch
+    # `locale` without your own `admin.build_menu :utility_navigation` code
+    # — see lib/active_admin/views/prism_sidebar.rb for the actual link
+    # (`url_for(locale: ...)`, the same query-param convention ActiveAdmin
+    # apps already use for this by hand). false renders no dropdown at all.
+    attr_accessor :language_switcher
+
+    # The options the dropdown lists — an array of
+    # `{ label:, locale:, url: }` hashes (`url:` is optional). Defaults to
+    # 3 common ones; replace the whole array to add, remove, or reorder
+    # languages:
+    #
+    #   ActiveAdminPrism.configure do |config|
+    #     config.languages = [
+    #       { label: "English", locale: :en },
+    #       { label: "Deutsch", locale: :de },
+    #       { label: "日本語", locale: :ja,
+    #         url: -> { "https://example.com/set_locale?locale=ja&return_to=#{request.path}" } }
+    #     ]
+    #   end
+    #
+    # `url:` accepts a String, Proc, or Symbol (same nil/String/Proc/Symbol
+    # convention as login_logo, evaluated the same way an
+    # ActiveAdmin::MenuItem's own `url:` proc is — bare `url_for`/`request`/
+    # any other view helper is available inside it, same as in the
+    # `url: proc { url_for(locale: l.locale) }` pattern an ActiveAdmin app
+    # already reaches for by hand for this). With no `url:`, this defaults
+    # to `url_for(locale: lang[:locale])` — appending `?locale=xx` to the
+    # *current* page. Use `url:` when switching locale needs to hit a
+    # remote/dedicated endpoint (e.g. one that sets a cookie or session key
+    # and redirects back) rather than just changing a query param on the
+    # current URL.
+    #
+    # This only renders the switcher itself — actually honoring the
+    # `locale` param (e.g. a `before_action { I18n.locale = params[:locale]
+    # || I18n.default_locale }`) is your own app's responsibility, the same
+    # as it would be if you'd wired up the utility_navigation menu by hand.
+    attr_accessor :languages
+
+    def initialize
+      @sidebar = true
+      @colorize_action_icons = true
+      @styled_confirms = true
+      @flash_dismissible = true
+      @flash_auto_dismiss = true
+      @flash_auto_dismiss_seconds = 5
+      @flash_transition_ms = 320
+      @collapsible_filters = true
+      @sidebar_footer = true
+      @login_page = true
+      @login_logo = nil
+      @login_app_name = nil
+      @login_tagline = "Sign in to your admin dashboard"
+      @language_switcher = true
+      @languages = [
+        { label: "English", locale: :en },
+        { label: "Español", locale: :es },
+        { label: "Français", locale: :fr }
+      ]
+    end
+  end
+
+  class << self
+    # @return [ActiveAdminPrism::Configuration]
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # ActiveAdminPrism.configure do |config|
+    #   config.sidebar = false
+    # end
+    def configure
+      yield(configuration)
+    end
+
+    # Mainly for test suites: resets every flag back to its default.
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/active_admin_prism/engine.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ActiveAdminPrism
+  class Engine < ::Rails::Engine
+    engine_name "active_admin_prism"
+
+    # Must run before ActiveAdmin's own "active_admin.precompile" initializer,
+    # which copies every registered stylesheet/javascript path into
+    # app.config.assets.precompile. Registering here means a host app never
+    # has to touch config.assets.precompile or add a manifest line itself.
+    initializer "active_admin_prism.register_assets", before: "active_admin.precompile" do
+      next unless defined?(ActiveAdmin)
+
+      ActiveAdmin.application.register_stylesheet "active_admin_prism/prism.css", media: "all"
+      ActiveAdmin.application.register_javascript "active_admin_prism/prism.js"
+    end
+  end
+end

data/lib/active_admin_prism/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveAdminPrism
+  VERSION = "0.1.0"
+end

data/lib/active_admin_prism.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "active_admin"
+
+require_relative "active_admin_prism/version"
+require_relative "active_admin_prism/configuration"
+require_relative "active_admin_prism/engine"
+require_relative "prism_icons"
+require_relative "prism_toggle_tag"
+require_relative "prism_login_helper"
+require_relative "active_admin/views/prism_sidebar"
+require_relative "active_admin/views/index_table_actions"
+require_relative "active_admin/views/flash_messages"
+require_relative "active_admin/views/filters_sidebar"
+require_relative "formtastic/inputs/prism_toggle_input"
+
+module ActiveAdminPrism
+  class Error < StandardError; end
+
+  # Swaps ActiveAdmin's default top navigation ("header") for Prism's
+  # collapsible left sidebar, unless disabled via
+  # `configure { |c| c.sidebar = false }`. Call once from
+  # config/initializers/active_admin.rb (the install generator does this
+  # automatically).
+  #
+  # This is a supported ActiveAdmin extension point, not a monkeypatch: see
+  # ActiveAdmin::ViewFactory / AbstractViewFactory#add_writer, which wires the
+  # "header" builder verb used by ActiveAdmin::Views::Pages::Base#build_page.
+  def self.enable!
+    ActiveAdmin::ViewFactory.register(header: ActiveAdmin::Views::PrismSidebar) if configuration.sidebar
+    true
+  end
+end

data/lib/formtastic/inputs/prism_toggle_input.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Formtastic
+  module Inputs
+    # An opt-in boolean input rendered as an iOS-style switch instead of a
+    # checkbox, matching the "Toggle switches" section of the Prism theme.
+    #
+    #   f.input :active, as: :prism_toggle
+    #
+    # Reuses BooleanInput's hidden-field/checked-value/name logic verbatim —
+    # only the wrapping markup changes, so submitted params are identical to
+    # a normal `as: :boolean` input.
+    class PrismToggleInput < Formtastic::Inputs::BooleanInput
+      def label_with_nested_checkbox
+        builder.label(
+          method,
+          check_box_html + template.content_tag(:span, "", class: "prism-toggle-track") + label_text,
+          label_html_options
+        )
+      end
+
+      def input_html_options
+        super.merge(class: [super[:class], "prism-toggle-input"].reject(&:blank?).join(" "))
+      end
+
+      def label_html_options
+        super.merge(class: [super[:class], "prism-toggle"].reject(&:blank?).join(" "))
+      end
+    end
+  end
+end

data/lib/generators/active_admin_prism/error_pages/error_pages_generator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ActiveAdminPrism
+  module Generators
+    # rails g active_admin_prism:error_pages
+    #
+    # Copies Prism-styled public/404.html and public/500.html into this
+    # app. Unlike the rest of the theme, static exception pages
+    # (config.exceptions_app's default, ActionDispatch::PublicExceptions)
+    # are read straight off disk from Rails.public_path, completely
+    # outside the asset pipeline and Rails' view-resolution/engine-view-path
+    # mechanism — there's no way for a gem to "register" or override them
+    # the way ActiveAdminPrism::Engine registers stylesheets/
+    # javascripts, or the way this gem's own sign-in page view shadows
+    # ActiveAdmin's. Copying them into the host app (the same way `rails
+    # new` scaffolds its own default public/404.html) is the only option.
+    #
+    # Not run automatically by the `install` generator, unlike everything
+    # else in this theme: a host's public/404.html and public/500.html are
+    # typically already customized/committed, and silently overwriting them
+    # (or ambushing an unrelated `install` run with copy_file's overwrite
+    # prompt) would be surprising. This is an explicit, separate opt-in.
+    #
+    # These are plain static HTML/CSS, not ERB — no Ruby config, no
+    # ActiveAdminPrism::Configuration flag, and no @import of
+    # prism.css (impossible for a file with no Rails request cycle behind
+    # it). Edit the copied files directly for any further changes; a
+    # future gem upgrade never touches them again once copied.
+    class ErrorPagesGenerator < ::Rails::Generators::Base
+      desc "Copies Prism-styled public/404.html and public/500.html into this app"
+
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_error_pages
+        copy_file "404.html", "public/404.html"
+        copy_file "500.html", "public/500.html"
+      end
+
+      def show_notes
+        say_status :note,
+                   "these are plain static files now living in public/ — edit them " \
+                   "directly for further changes, and re-run this generator " \
+                   "(it will prompt before overwriting) to pick up a newer version " \
+                   "of the gem's default templates",
+                   :yellow
+      end
+    end
+  end
+end