activeadmin_favorites 0.1.0

data/app/views/active_admin/resource/index.html.arb

@@ -0,0 +1,99 @@
+def wrap_with_batch_action_form(&block)
+  if active_admin_config.batch_actions.any?
+    insert_tag(ActiveAdmin::BatchActions::BatchActionForm, &block)
+    batch_actions_to_display.each do |batch_action|
+      if batch_action.partial.present?
+        render(batch_action.partial)
+      end
+    end
+  else
+    block.call
+  end
+end
+
+def build_collection
+  if collection_empty?(collection)
+    if params[:q] || params[:scope]
+      render("active_admin/resource/index_empty_results")
+    else
+      render("active_admin/resource/index_blank_slate")
+    end
+  else
+    render_index
+  end
+end
+
+def build_table_tools
+  if any_table_tools?
+    div class: "index-data-table-toolbar" do
+      render "batch_actions_dropdown"
+      build_scopes
+      build_index_list
+    end
+  end
+end
+
+def any_table_tools?
+  active_admin_config.batch_actions.any? ||
+    active_admin_config.scopes.any? ||
+    active_admin_config.page_presenters[:index].try(:size).try(:>, 1)
+end
+
+def build_scopes
+  if active_admin_config.scopes.any?
+    scope_options = {scope_count: page_presenter.fetch(:scope_count, true)}
+    insert_tag(ActiveAdmin::Views::Scopes, active_admin_config.scopes, scope_options)
+  end
+end
+
+def build_index_list
+  indexes = active_admin_config.page_presenters[:index]
+
+  if indexes.is_a?(Hash) && indexes.length > 1
+    index_classes = []
+    active_admin_config.page_presenters[:index].each do |type, page_presenter|
+      index_classes << find_index_renderer_class(page_presenter[:as])
+    end
+
+    insert_tag(ActiveAdmin::Views::IndexList, index_classes)
+  end
+end
+
+# Returns the actual class for rendering the main content on the index
+# page. To set this, use the :as option in the page_presenter block.
+def find_index_renderer_class(klass)
+  if klass.is_a?(Class)
+    klass
+  else
+    ::ActiveAdmin::Views.const_get("IndexAs" + klass.to_s.camelcase)
+  end
+end
+
+def render_index
+  renderer_class = find_index_renderer_class(page_presenter[:as])
+
+  paginator = page_presenter.fetch(:paginator, true)
+  download_links = page_presenter.fetch(:download_links, active_admin_config.namespace.download_links)
+  pagination_total = page_presenter.fetch(:pagination_total, true)
+  per_page = page_presenter.fetch(:per_page, active_admin_config.per_page)
+
+  paginated_collection(
+    collection, entry_name: active_admin_config.resource_label,
+    entries_name: active_admin_config.plural_resource_label(count: collection_size),
+    download_links: download_links,
+    paginator: paginator,
+    per_page: per_page,
+    pagination_total: pagination_total
+  ) do
+    insert_tag(renderer_class, page_presenter, collection)
+  end
+end
+
+div class: "main-content-container" do
+  wrap_with_batch_action_form do
+    build_table_tools
+    build_collection
+  end
+end
+
+render partial: "active_admin/favorites/lens_catalog_data", locals: {action_name: "index", render_context: self}

data/app/views/active_admin/resource/show.html.arb

@@ -0,0 +1,13 @@
+def attributes_table(*args, &block)
+  attributes_table_for resource, *args, &block
+end
+
+div class: "main-content-container" do
+  if page_presenter.block
+    instance_exec resource, &page_presenter.block
+  else
+    render "show_default"
+  end
+end
+
+render partial: "active_admin/favorites/lens_catalog_data", locals: {action_name: "show", render_context: self}

data/config/locales/activeadmin_favorites.en.yml

@@ -0,0 +1,60 @@
+en:
+  active_admin:
+    favorites:
+      add_favorite: Add to favorites
+      advanced_macros: Advanced macros
+      created: Favorite saved
+      creator_column: Creator
+      edit_favorite: Edit favorite
+      filters_column: Filters
+      form_panel: Favorite details
+      macros_hint: Choose shortcut templates to keep date filters up to date when you open this favorite.
+      macros_json_hint: JSON array of macro objects. Use only when templates are not enough.
+      macros_json_invalid: Macros JSON is invalid
+      macros_panel: Dynamic filters
+      menu: Favorites
+      no_detected_ranges: No date range filters detected in the current view. Use advanced macros if needed.
+      open: Open
+      published: Published for everyone
+      updated: Favorite updated
+      use_advanced_macros: Edit macros as JSON
+      use_dynamic_range: Use dynamic range
+      visibility:
+        mine: Only me
+        published: "Published (%{time})"
+      visibility_column: Visibility
+      macro_templates:
+        previous_calendar_month: Previous calendar month
+        current_calendar_month: Current calendar month
+        previous_calendar_day: Previous day
+        current_calendar_day: Today
+        rolling_last_7_days: Last 7 days
+        rolling_last_30_days: Last 30 days
+        previous_fiscal_year: Previous fiscal year (Apr–Mar)
+        current_fiscal_year_to_date: Current fiscal year to date (Apr–Mar)
+      personalize_page: Personalize page
+      personalization_region: Page personalization
+      save_default: Save as my default
+      reset_default: Reset to defaults
+      save_lens_favorite: Save lens as favorite
+      include_layout: Include current page layout
+      lens_summary: Page layout
+      lens_created: Lens favorite saved
+      combined_created: Combined favorite saved
+      layout_saved: Page layout saved
+      layout_reset: Page layout reset
+      kind_column: Type
+      kind_navigation: Favorite types
+      no_personalization_items: No personalization options are available on this page.
+      kinds:
+        all: All
+        filters: Filters
+        lens: Lens
+        combined: Combined
+      groups:
+        columns: Columns
+        filters: Filters
+        action_items: Actions
+        panels: Panels
+        show_rows: Rows
+      block_column: Custom column %{position}

data/config/locales/activeadmin_favorites.host.yml.example

@@ -0,0 +1,17 @@
+# Copy these keys into your host locale files (for example config/locales/activeadmin_favorites.fi.yml).
+# The gem loads English from config/locales/activeadmin_favorites.en.yml automatically.
+#
+# Merge active_admin.favorites into each locale you support.
+
+en:
+  active_admin:
+    favorites:
+      add_to_favorites: Add to favorites
+      personalize_page: Personalize page
+      hub_title: Favorites
+      filters_tab: Filters
+      lens_tab: Layout
+      combined_tab: Combined
+      save_lens_favorite: Save lens as favorite
+      lens_created: Layout favorite saved
+      combined_created: Combined favorite saved

data/config/polyrun_coverage.yml

@@ -0,0 +1,8 @@
+track_under:
+  - lib
+  - app
+minimum_line_percent: 50
+report_formats:
+  - html
+  - cobertura
+  - console

data/db/migrate/20260709100000_create_active_admin_view_lens_defaults.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class CreateActiveAdminViewLensDefaults < ActiveRecord::Migration[7.2]
+  include ActiveAdmin::Favorites::MigrationSupport
+
+  def change
+    json_type = favorites_json_column_type
+    user_foreign_key = favorites_user_foreign_key
+
+    create_table :active_admin_view_lens_defaults do |t|
+      t.bigint user_foreign_key, null: false
+      t.string :resource_key, null: false
+      t.string :action, null: false
+      t.public_send(json_type, :layout, null: false, default: {})
+
+      t.timestamps
+    end
+
+    add_index :active_admin_view_lens_defaults,
+      [user_foreign_key, :resource_key, :action],
+      unique: true,
+      name: "index_view_lens_defaults_on_user_resource_action"
+  end
+end

data/db/migrate/20260709130000_create_admin_favorites.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class CreateAdminFavorites < ActiveRecord::Migration[7.2]
+  include ActiveAdmin::Favorites::MigrationSupport
+
+  def change
+    json_type = favorites_json_column_type
+    user_foreign_key = favorites_user_foreign_key
+
+    create_table :admin_favorites do |t|
+      t.string :type, null: false
+      t.bigint user_foreign_key, null: false
+      t.string :name, null: false
+      t.text :note
+      t.string :resource_key, null: false
+      t.string :path, null: false
+      t.text :query_string
+      t.boolean :published, null: false, default: false
+      t.datetime :published_at
+      t.public_send(json_type, :macros, null: false, default: [])
+      t.integer :macros_version, null: false, default: 1
+      t.string :action
+      t.public_send(json_type, :layout)
+
+      t.timestamps
+    end
+
+    add_index :admin_favorites, [user_foreign_key, :path, :query_string, :type],
+      unique: true,
+      name: "index_admin_favorites_on_user_path_query_and_type"
+    add_index :admin_favorites, :type
+  end
+end

data/lib/activeadmin/favorites/configuration.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Favorites
+    class Configuration
+      attr_accessor :user_class,
+        :user_foreign_key,
+        :user_association_name,
+        :user_label_method,
+        :current_user_method,
+        :stimulus_controller,
+        :namespace_name,
+        :table_name
+
+      def initialize
+        @user_class = "User"
+        @user_foreign_key = :user_id
+        @user_association_name = :user
+        @user_label_method = :email
+        @current_user_method = :current_user
+        @stimulus_controller = "activeadmin-favorites--personalization"
+        @namespace_name = :admin
+        @table_name = "admin_favorites"
+      end
+
+      def namespace_path_prefix
+        "/#{namespace_name}/"
+      end
+    end
+  end
+end

data/lib/activeadmin/favorites/engine.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Favorites
+    class Engine < ::Rails::Engine
+      engine_name "activeadmin_favorites"
+
+      initializer "activeadmin_favorites.load_lib" do
+        require "activeadmin/favorites/migration_helpers"
+        require "activeadmin/favorites/migration_support"
+        require "activeadmin/favorites/view_lens/current"
+        require "activeadmin/favorites/user_record"
+        require "activeadmin/favorites/view_lens"
+        require "activeadmin/favorites/hash_coercion"
+        require "activeadmin/favorites/view_lens/applicator"
+        require "activeadmin/favorites/view_lens/catalog"
+        require "activeadmin/favorites/view_lens/patches"
+        require "activeadmin/favorites/view_lens/resource_dsl"
+        require "activeadmin/favorites/install"
+        require "activeadmin/favorites/register_favorites"
+        require "activeadmin/favorites/register_view_lens_preferences"
+      end
+
+      initializer "activeadmin_favorites.assets" do |app|
+        assets_path = root.join("app/assets")
+        app.config.importmap.cache_sweepers << assets_path.join("controllers") if app.config.respond_to?(:importmap)
+
+        next unless app.config.respond_to?(:assets)
+
+        app.config.assets.precompile << "activeadmin_favorites/personalization_controller.js"
+      end
+
+      initializer "activeadmin_favorites.importmap", after: :importmap do
+        pin_controller = proc do |importmap|
+          importmap.pin "controllers/activeadmin_favorites/personalization_controller",
+            to: "activeadmin_favorites/personalization_controller.js"
+        end
+
+        application_importmap = Rails.application.importmap if Rails.application.respond_to?(:importmap)
+        application_importmap&.draw(&pin_controller)
+        ActiveAdmin.importmap.draw(&pin_controller) if defined?(ActiveAdmin) && ActiveAdmin.respond_to?(:importmap)
+      end
+
+      initializer "activeadmin_favorites.i18n" do
+        I18n.load_path << root.join("config/locales/activeadmin_favorites.en.yml")
+      end
+
+      initializer "activeadmin_favorites.append_migrations" do |app|
+        ActiveAdmin::Favorites::MigrationHelpers.append_engine_migrations!(app)
+      end
+
+      rake_tasks do
+        load root.join("lib/tasks/activeadmin_favorites_tasks.rake")
+      end
+
+      initializer "activeadmin_favorites.after_load", after: :load_config_initializers do
+        next unless defined?(ActiveAdmin) && ActiveAdmin.respond_to?(:after_load)
+
+        ActiveAdmin.after_load do
+          ActiveAdmin::Favorites.register_resources!
+          ActiveAdmin::Favorites.install!
+        end
+      end
+
+      config.to_prepare do
+        next unless defined?(ActiveAdmin::ResourceController)
+
+        ActiveAdmin::Favorites::Favorite.define_favorites_user_association!
+        ActiveAdmin::Favorites::ViewLensDefault.define_favorites_user_association!
+        ActiveAdmin::Favorites.register_resources!
+        ActiveAdmin::Favorites.install!
+      end
+    end
+  end
+end

data/lib/activeadmin/favorites/hash_coercion.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Favorites
+    module HashCoercion
+      module_function
+
+      def deep_stringify(value, default: {})
+        case value
+        when Hash
+          value.deep_stringify_keys
+        when ActionController::Parameters
+          value.to_unsafe_h.deep_stringify_keys
+        else
+          return default unless value.respond_to?(:to_h)
+
+          hash = value.to_h
+          hash.is_a?(Hash) ? hash.deep_stringify_keys : default
+        end
+      end
+
+      def assignment_values(assignments)
+        case assignments
+        when ActionController::Parameters
+          assignments.to_unsafe_h.values
+        when Hash
+          assignments.values
+        else
+          Array(assignments)
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin/favorites/install.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Favorites
+    module Install
+      FILTER_FAVOURITE_ACTION = :save_filter_favorite
+      PERSONALIZE_ACTION = :personalize_page
+
+      module_function
+
+      def call
+        install_controller_methods!
+        install_action_items!
+        configure_favorites_resource!
+        ViewLens::InstallPatches.call
+      end
+
+      def configure_favorites_resource!
+        resource = ActiveAdmin.application.namespace(ActiveAdmin::Favorites.config.namespace_name)
+          .resources.find { |config| config.resource_class == Favorite }
+        return unless resource
+
+        resource.instance_variable_set(:@batch_actions, {}) if resource.instance_variable_get(:@batch_actions).nil?
+
+        if resource.respond_to?(:batch_actions=)
+          resource.batch_actions = false
+        else
+          resource.instance_variable_set(:@batch_actions_enabled, false)
+        end
+      end
+
+      def install_controller_methods!
+        return unless defined?(ActiveAdmin::ResourceController)
+
+        controller = ActiveAdmin::ResourceController
+        return if controller.included_modules.include?(ViewLens::ControllerMethods)
+
+        controller.include(ViewLens::ControllerMethods)
+      end
+
+      def install_action_items!
+        ActiveAdmin.application.namespaces.each do |namespace|
+          namespace.resources.each do |config|
+            next if config.is_a?(ActiveAdmin::Page)
+            next unless config.controller.action_methods.include?("index")
+            next if config.resource_class == Favorite
+
+            install_filter_favorite_action_item!(config)
+            install_personalize_action_item!(config)
+            install_show_personalize_action_item!(config)
+          end
+        end
+      end
+
+      def install_filter_favorite_action_item!(config)
+        return if config.action_items.any? { |item| item.name == FILTER_FAVOURITE_ACTION }
+
+        config.add_action_item(FILTER_FAVOURITE_ACTION, only: :index, priority: 5) do
+          sanitized_query = Favorite.sanitize_query_string(request.query_string)
+          user = send(ActiveAdmin::Favorites.config.current_user_method)
+
+          if sanitized_query.blank?
+            label = I18n.t("active_admin.favorites.add_favorite")
+            destination = new_admin_favorite_path(
+              path: request.path,
+              query_string: sanitized_query,
+              resource_key: active_admin_config.resource_name.route_key,
+              action_name: "index"
+            )
+          else
+            lookup = {
+              path: request.path,
+              query_string: sanitized_query
+            }
+            lookup[ActiveAdmin::Favorites.config.user_foreign_key] = user.id
+            owned_existing = Favorite.filters_kind.find_by(lookup)
+
+            label = if owned_existing
+              I18n.t("active_admin.favorites.edit_favorite")
+            else
+              I18n.t("active_admin.favorites.add_favorite")
+            end
+
+            destination = if owned_existing
+              edit_admin_favorite_path(owned_existing)
+            else
+              new_admin_favorite_path(
+                path: request.path,
+                query_string: sanitized_query,
+                resource_key: active_admin_config.resource_name.route_key,
+                action_name: "index"
+              )
+            end
+          end
+
+          link_to label, destination, class: "action-item-button"
+        end
+      end
+
+      def install_personalize_action_item!(config)
+        return unless config.controller.action_methods.include?("index")
+        return if config.action_items.any? { |item| item.name == :"#{PERSONALIZE_ACTION}_index" }
+
+        config.add_action_item(:"#{PERSONALIZE_ACTION}_index", only: :index, priority: 1) do
+          render partial: "active_admin/favorites/personalization_trigger",
+            locals: {action_name: "index"}
+        end
+      end
+
+      def install_show_personalize_action_item!(config)
+        return unless config.controller.action_methods.include?("show")
+        return if config.action_items.any? { |item| item.name == :"#{PERSONALIZE_ACTION}_show" }
+
+        config.add_action_item(:"#{PERSONALIZE_ACTION}_show", only: :show, priority: 1) do
+          render partial: "active_admin/favorites/personalization_trigger",
+            locals: {action_name: "show"}
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin/favorites/migration_helpers.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Favorites
+    module MigrationHelpers
+      module_function
+
+      def engine_migration_paths
+        root = ActiveAdmin::Favorites::Engine.root
+        Dir[root.join("db/migrate/*.rb")].sort
+      end
+
+      def host_migration_versions(app_root)
+        Dir[app_root.join("db/migrate/*.rb")].map { |path| File.basename(path).split("_", 2).first }
+      end
+
+      def append_engine_migrations!(app)
+        return if app.root.to_s.start_with?(ActiveAdmin::Favorites::Engine.root.to_s)
+
+        host_versions = host_migration_versions(app.root)
+        paths = app.config.paths["db/migrate"]
+        return if paths.frozen?
+
+        engine_migration_paths.each do |migration_path|
+          version = File.basename(migration_path).split("_", 2).first
+          next if host_versions.include?(version)
+          next if paths.include?(migration_path)
+
+          paths << migration_path
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin/favorites/migration_support.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Favorites
+    module MigrationSupport
+      def favorites_user_foreign_key
+        ActiveAdmin::Favorites.config.user_foreign_key
+      end
+
+      def favorites_json_column_type
+        postgresql_adapter? ? :jsonb : :json
+      end
+
+      def postgresql_adapter?
+        connection.adapter_name.match?(/postgresql/i)
+      end
+    end
+  end
+end