activeadmin_favorites 0.1.0

data/lib/activeadmin/favorites/view_lens/patches.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Favorites
+    module ViewLens
+      module TableForPatch
+        def column(*args, &block)
+          layout = Applicator.current_layout
+          resource_key = helpers.active_admin_config&.resource_name&.route_key
+          column_id = Applicator.extract_column_id(args, resource_key: resource_key)
+
+          if resource_key.present? && column_id.present?
+            label = Applicator.column_label_from_args(args, column_id: column_id)
+            Applicator.register_column(resource_key: resource_key, id: column_id, label: label)
+          end
+
+          return if layout&.hidden_column?(column_id)
+
+          super
+        end
+      end
+
+      module AttributesTablePatch
+        def row(*args, &block)
+          layout = Applicator.current_layout
+          title = args[0]
+          options = args.last.is_a?(Hash) ? args.last : {}
+          row_id = Applicator.extract_row_id(title, options)
+          resource_key = helpers.active_admin_config&.resource_name&.route_key
+
+          if resource_key.present? && row_id.present?
+            Applicator.register_row(resource_key: resource_key, id: row_id, label: title.to_s)
+          end
+
+          return if layout&.hidden_show_row?(row_id)
+
+          super
+        end
+      end
+
+      module PanelPatch
+        def build(title, attributes = {})
+          layout = Applicator.current_layout
+          panel_id = Applicator.extract_panel_id(title, attributes)
+          resource_key = helpers.active_admin_config&.resource_name&.route_key
+
+          if resource_key.present? && panel_id.present?
+            Applicator.register_panel(resource_key: resource_key, id: panel_id, label: title.to_s)
+          end
+
+          return if layout&.hidden_panel?(panel_id)
+
+          attributes = attributes.merge("data-lens-panel": panel_id)
+          super
+        end
+      end
+
+      module FiltersPatch
+        private
+
+        def filter_lookup
+          filters = super
+          layout = Applicator.current_layout
+          return filters if filters.nil?
+          return filters unless layout.respond_to?(:hidden_filter?)
+
+          filters.reject { |filter_key, _| layout.hidden_filter?(filter_key) }
+        end
+      end
+
+      module ActionItemsPatch
+        def action_items_for(action, render_context = nil)
+          items = super
+          layout = Applicator.current_layout
+          return items if items.nil?
+          return items unless layout.respond_to?(:hidden_action_item?)
+
+          items.reject { |item| layout.hidden_action_item?(item.name) }
+        end
+      end
+
+      module InstallPatches
+        module_function
+
+        def call
+          ActiveAdmin::Views::TableFor.prepend(TableForPatch) unless ActiveAdmin::Views::TableFor < TableForPatch
+          ActiveAdmin::Views::AttributesTable.prepend(AttributesTablePatch) unless ActiveAdmin::Views::AttributesTable < AttributesTablePatch
+          ActiveAdmin::Views::Panel.prepend(PanelPatch) unless ActiveAdmin::Views::Panel < PanelPatch
+          ActiveAdmin::Filters::ResourceExtension.prepend(FiltersPatch) unless ActiveAdmin::Filters::ResourceExtension < FiltersPatch
+          ActiveAdmin::Resource::ActionItems.prepend(ActionItemsPatch) unless ActiveAdmin::Resource::ActionItems < ActionItemsPatch
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin/favorites/view_lens/resource_dsl.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Favorites
+    module ViewLens
+      module ControllerMethods
+        extend ActiveSupport::Concern
+
+        included do
+          before_action :apply_active_admin_favorites_lens, only: [:index, :show]
+          after_action :clear_active_admin_favorites_lens, only: [:index, :show]
+
+          helper_method :active_admin_favorites_catalog, :active_admin_favorites_layout
+        end
+
+        def clear_active_admin_favorites_lens
+          ViewLens::Applicator.reset!
+        end
+
+        def apply_active_admin_favorites_lens
+          return if active_admin_config.resource_class == Favorite
+
+          ViewLens::Applicator.resolve_layout(controller: self)
+        end
+
+        def active_admin_favorites_catalog
+          context = ViewLens::Current.catalog_context
+          return ViewLens::Applicator.current_catalog if ViewLens::Applicator.current_catalog.present?
+          return [] unless context
+
+          ViewLens::Applicator.build_catalog(
+            active_admin_config: context[:active_admin_config],
+            action: context[:action],
+            render_context: context[:render_context]
+          )
+        end
+
+        def active_admin_favorites_layout
+          ViewLens::Applicator.current_layout
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin/favorites/view_lens.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Favorites
+    module ViewLens
+    end
+  end
+end

data/lib/activeadmin/favorites.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "activeadmin/favorites/version"
+require "activeadmin/favorites/configuration"
+
+module ActiveAdmin
+  module Favorites
+    class << self
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield config
+      end
+
+      def install!
+        require "activeadmin/favorites/install"
+        Install.call
+      end
+
+      def register_resources!
+        require "activeadmin/favorites/register_favorites"
+        require "activeadmin/favorites/register_view_lens_preferences"
+        RegisterFavorites.call
+        RegisterViewLensPreferences.call
+      end
+    end
+  end
+end

data/lib/activeadmin_favorites.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "activeadmin/favorites/version"
+require "activeadmin/favorites"
+require "activeadmin/favorites/engine"

data/lib/generators/activeadmin_favorites/install/templates/favorite_policy.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Favorites
+    class FavoritePolicy < ApplicationPolicy
+      def index?
+        staff?
+      end
+
+      def show?
+        visible?
+      end
+
+      def create?
+        staff?
+      end
+
+      def new?
+        create?
+      end
+
+      def update?
+        owner?
+      end
+
+      def edit?
+        update?
+      end
+
+      def destroy?
+        owner?
+      end
+
+      default_scope do |relation|
+        return relation.none unless staff?
+
+        relation.visible_to(user)
+      end
+
+      private
+
+      def staff?
+        user.present?
+      end
+
+      def visible?
+        staff? && (owner? || record.published?)
+      end
+
+      def owner?
+        foreign_key = ActiveAdmin::Favorites.config.user_foreign_key
+        staff? && record.public_send(foreign_key) == user.id
+      end
+    end
+  end
+end

data/lib/generators/activeadmin_favorites/install/templates/initializer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+ActiveAdmin::Favorites.configure do |config|
+  # Example for a custom staff model:
+  # config.user_class = "AdminUser"
+  # config.user_foreign_key = :admin_user_id
+  # config.user_association_name = :admin_user
+  # config.user_label_method = :email
+  # config.current_user_method = :current_admin_user
+
+  config.user_class = "User"
+  config.user_foreign_key = :user_id
+  config.user_association_name = :user
+  config.user_label_method = :email
+  config.current_user_method = :current_user
+end

data/lib/generators/activeadmin_favorites/install/templates/locale.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/lib/generators/activeadmin_favorites/install_generator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module ActiveadminFavorites
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("install/templates", __dir__)
+
+    desc "Install activeadmin_favorites initializer, policy, and locale template"
+
+    def copy_initializer
+      template "initializer.rb", "config/initializers/activeadmin_favorites.rb"
+    end
+
+    def copy_policy
+      template "favorite_policy.rb", "app/policies/active_admin/favorites/favorite_policy.rb"
+    end
+
+    def copy_locale_template
+      template "locale.en.yml", "config/locales/activeadmin_favorites.en.yml"
+    end
+
+    def install_migrations
+      rake "activeadmin_favorites:install:migrations"
+    end
+
+    def show_page_policy_note
+      say <<~NOTE, :yellow
+
+        Add save_lens_favorite? and reset? to your ActiveAdmin::PagePolicy (or equivalent)
+        so view lens preference page actions authorize correctly.
+
+        Copy active_admin.favorites keys into your fi/sv locale files if needed.
+      NOTE
+    end
+  end
+end

data/lib/tasks/activeadmin_favorites_tasks.rake

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+namespace :activeadmin_favorites do
+  namespace :install do
+    desc "Copy activeadmin_favorites migrations into db/migrate"
+    task migrations: :environment do
+      require "fileutils"
+      require "activeadmin/favorites/migration_helpers"
+
+      destination = Rails.root.join("db/migrate")
+      FileUtils.mkdir_p(destination)
+
+      copied = []
+      skipped = []
+
+      ActiveAdmin::Favorites::MigrationHelpers.engine_migration_paths.each do |source|
+        target = destination.join(File.basename(source))
+        version = File.basename(source).split("_", 2).first
+
+        if target.exist?
+          skipped << version
+          next
+        end
+
+        FileUtils.cp(source, target)
+        copied << version
+      end
+
+      if copied.any?
+        puts "Copied migrations: #{copied.join(", ")}"
+      else
+        puts "No new migrations copied."
+      end
+
+      puts "Skipped existing versions: #{skipped.join(", ")}" if skipped.any?
+      puts "Run bin/rails db:migrate when ready."
+    end
+  end
+end

data/sig/activeadmin/favorites.rbs

@@ -0,0 +1,5 @@
+module ActiveAdmin
+  module Favorites
+    VERSION: String
+  end
+end