rails_admin_next 1.0.0

data/lib/rails_admin_next/config/actions/dashboard.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  module Config
+    module Actions
+      class Dashboard < RailsAdminNext::Config::Actions::Base
+        RailsAdminNext::Config::Actions.register(self)
+
+        register_instance_option :root? do
+          true
+        end
+
+        register_instance_option :breadcrumb_parent do
+          nil
+        end
+
+        register_instance_option :auditing_versions_limit do
+          100
+        end
+
+        register_instance_option :controller do
+          proc do
+            @history = @auditing_adapter&.latest(@action.auditing_versions_limit) if @action.history?
+            if @action.statistics?
+              model_configs = RailsAdminNext::Config.visible_models(controller: self)
+
+              @abstract_models = model_configs.map(&:abstract_model)
+              @most_recent_created = {}
+              @count = {}
+              @max = 0
+              model_configs.each do |config|
+                scope = @authorization_adapter&.query(:index, config.abstract_model)
+                current_count = config.abstract_model.count({}, scope)
+                @max = (current_count > @max) ? current_count : @max
+                name = config.abstract_model.model.name
+                @count[name] = current_count
+                @most_recent_created[name] = config.last_created_at
+              end
+            end
+            render @action.template_name, status: @status_code || :ok
+          end
+        end
+
+        register_instance_option :route_fragment do
+          ""
+        end
+
+        register_instance_option :link_icon do
+          :dashboard
+        end
+
+        register_instance_option :statistics? do
+          true
+        end
+
+        register_instance_option :history? do
+          true
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/actions/delete.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  module Config
+    module Actions
+      class Delete < RailsAdminNext::Config::Actions::Base
+        RailsAdminNext::Config::Actions.register(self)
+
+        register_instance_option :member do
+          true
+        end
+
+        register_instance_option :route_fragment do
+          "delete"
+        end
+
+        register_instance_option :http_methods do
+          %i[get delete]
+        end
+
+        register_instance_option :authorization_key do
+          :destroy
+        end
+
+        register_instance_option :controller do
+          proc do
+            if request.get? # DELETE
+
+              respond_to do |format|
+                format.html { render @action.template_name }
+                format.js { render @action.template_name, layout: false }
+              end
+
+            elsif request.delete? # DESTROY
+
+              @auditing_adapter&.delete_object(@object, @abstract_model, _current_user)
+              if @object.destroy
+                flash[:success] = t("admin.flash.successful", name: @model_config.label, action: t("admin.actions.delete.done"))
+                redirect_to index_path
+              else
+                handle_save_error :delete
+              end
+
+            end
+          end
+        end
+
+        register_instance_option :link_icon do
+          :delete
+        end
+
+        register_instance_option :writable? do
+          !(bindings[:object] && bindings[:object].readonly?)
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/actions/edit.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  module Config
+    module Actions
+      class Edit < RailsAdminNext::Config::Actions::Base
+        RailsAdminNext::Config::Actions.register(self)
+
+        register_instance_option :member do
+          true
+        end
+
+        register_instance_option :http_methods do
+          %i[get put]
+        end
+
+        register_instance_option :controller do
+          proc do
+            if request.get? # EDIT
+
+              respond_to do |format|
+                format.html { render @action.template_name }
+                format.js { render @action.template_name, layout: "rails_admin_next/modal", content_type: Mime[:html].to_s }
+              end
+
+            elsif request.put? # UPDATE
+              sanitize_params_for!(request.xhr? ? :modal : :update)
+
+              @object.assign_attributes(params[@abstract_model.param_key])
+              @authorization_adapter&.authorize(:update, @abstract_model, @object)
+              changes = @object.changes
+              if @object.save
+                @auditing_adapter&.update_object(@object, @abstract_model, _current_user, changes)
+                respond_to do |format|
+                  format.html { redirect_to_on_success }
+                  format.json { render json: {id: @object.id.to_s, label: @model_config.with(object: @object).object_label} }
+                end
+              else
+                handle_save_error :edit
+              end
+
+            end
+          end
+        end
+
+        register_instance_option :link_icon do
+          :edit
+        end
+
+        register_instance_option :writable? do
+          !(bindings[:object] && bindings[:object].readonly?)
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/actions/export.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  module Config
+    module Actions
+      class Export < RailsAdminNext::Config::Actions::Base
+        RailsAdminNext::Config::Actions.register(self)
+
+        register_instance_option :collection do
+          true
+        end
+
+        register_instance_option :http_methods do
+          %i[get post]
+        end
+
+        register_instance_option :controller do
+          proc do
+            format = params[:json] && :json || params[:csv] && :csv || params[:xml] && :xml
+            # Stream the table only on a non-GET, CSRF-protected request. GET (forgery-exempt)
+            # renders the form so `GET /export?json=1&schema[...]` can't exfiltrate the whole
+            # table with attacker-chosen columns; the export form posts back to this same action.
+            if format && !request.get?
+              request.format = format
+              @schema = HashHelper.symbolize(params[:schema].slice(:except, :include, :methods, :only).permit!.to_h) if params[:schema] # to_json and to_xml expect symbols for keys AND values.
+              @objects = list_entries(@model_config, :export)
+              index
+            else
+              # A format-suffixed URL (a bookmarked `GET /export.csv`) reaches this branch
+              # with request.format already csv/json/xml; render the form explicitly as HTML
+              # so the link fails into the form instead of a MissingTemplate error.
+              render @action.template_name, formats: :html
+            end
+          end
+        end
+
+        register_instance_option :bulkable? do
+          true
+        end
+
+        register_instance_option :link_icon do
+          :export
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/actions/history_index.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  module Config
+    module Actions
+      class HistoryIndex < RailsAdminNext::Config::Actions::Base
+        RailsAdminNext::Config::Actions.register(self)
+
+        register_instance_option :authorization_key do
+          :history
+        end
+
+        register_instance_option :collection do
+          true
+        end
+
+        register_instance_option :route_fragment do
+          "history"
+        end
+
+        register_instance_option :controller do
+          proc do
+            @general = true
+            @history = @auditing_adapter&.listing_for_model(@abstract_model, params[:query], params[:sort], params[:sort_reverse], params[:all], params[:page]) || []
+
+            render @action.template_name
+          end
+        end
+
+        register_instance_option :template_name do
+          :history
+        end
+
+        register_instance_option :link_icon do
+          :history
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/actions/history_show.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  module Config
+    module Actions
+      class HistoryShow < RailsAdminNext::Config::Actions::Base
+        RailsAdminNext::Config::Actions.register(self)
+
+        register_instance_option :authorization_key do
+          :history
+        end
+
+        register_instance_option :member do
+          true
+        end
+
+        register_instance_option :route_fragment do
+          "history"
+        end
+
+        register_instance_option :controller do
+          proc do
+            @general = false
+            @history = @auditing_adapter&.listing_for_object(@abstract_model, @object, params[:query], params[:sort], params[:sort_reverse], params[:all], params[:page]) || []
+
+            render @action.template_name
+          end
+        end
+
+        register_instance_option :template_name do
+          :history
+        end
+
+        register_instance_option :link_icon do
+          :history
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/actions/index.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  module Config
+    module Actions
+      class Index < RailsAdminNext::Config::Actions::Base
+        RailsAdminNext::Config::Actions.register(self)
+
+        register_instance_option :collection do
+          true
+        end
+
+        register_instance_option :http_methods do
+          %i[get post]
+        end
+
+        register_instance_option :route_fragment do
+          ""
+        end
+
+        register_instance_option :breadcrumb_parent do
+          parent_model = bindings[:abstract_model].try(:config).try(:parent)
+          am = parent_model && RailsAdminNext.config(parent_model).try(:abstract_model)
+          if am
+            [:index, am]
+          else
+            [:dashboard]
+          end
+        end
+
+        register_instance_option :controller do
+          proc do
+            # Resolve the active list scope (the scope tabs) and fold it into the
+            # relation *before* pagination. The paginated collection is a resolved
+            # page, not a chainable relation, so a named scope can no longer be
+            # appended afterwards.
+            unless @objects
+              scopes = @model_config.list.scopes
+              list_scope =
+                if scopes.empty? || params[:scope].blank?
+                  scopes.first
+                elsif scopes.collect(&:to_s).include?(params[:scope])
+                  params[:scope].to_sym
+                end
+
+              additional_scope = get_association_scope_from_params
+              if list_scope
+                base_scope = additional_scope
+                additional_scope = proc { (base_scope ? instance_eval(&base_scope) : self).send(list_scope) }
+              end
+
+              @objects = list_entries(@model_config, :index, additional_scope)
+            end
+
+            respond_to do |format|
+              format.html do
+                render @action.template_name, status: @status_code || :ok
+              end
+
+              format.json do
+                output =
+                  if params[:compact]
+                    if @association
+                      @association.collection(@objects).collect { |(label, id)| {id: id, label: label} }
+                    else
+                      @objects.collect { |object| {id: object.id.to_s, label: object.send(@model_config.object_label_method).to_s} }
+                    end
+                  else
+                    @objects.to_json(@schema)
+                  end
+
+                if params[:send_data]
+                  send_data output, filename: "#{params[:model_name]}_#{DateTime.now.strftime("%Y-%m-%d_%Hh%Mm%S")}.json"
+                else
+                  render json: output, root: false
+                end
+              end
+
+              format.xml do
+                output = @objects.map { |object| object.serializable_hash(@schema || {}) }.to_xml(root: @abstract_model.model.model_name.plural)
+                if params[:send_data]
+                  send_data output, filename: "#{params[:model_name]}_#{DateTime.now.strftime("%Y-%m-%d_%Hh%Mm%S")}.xml"
+                else
+                  render xml: output
+                end
+              end
+
+              format.csv do
+                header, encoding, output = CSVConverter.new(@objects, @schema).to_csv(params[:csv_options].permit!.to_h)
+                if params[:send_data]
+                  send_data output,
+                    type: "text/csv; charset=#{encoding}; #{"header=present" if header}",
+                    disposition: "attachment; filename=#{params[:model_name]}_#{DateTime.now.strftime("%Y-%m-%d_%Hh%Mm%S")}.csv"
+                else
+                  render plain: output
+                end
+              end
+            end
+          end
+        end
+
+        register_instance_option :link_icon do
+          :list
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/actions/new.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  module Config
+    module Actions
+      class New < RailsAdminNext::Config::Actions::Base
+        RailsAdminNext::Config::Actions.register(self)
+
+        register_instance_option :collection do
+          true
+        end
+
+        register_instance_option :http_methods do
+          %i[get post] # NEW / CREATE
+        end
+
+        register_instance_option :controller do
+          proc do
+            if request.get? # NEW
+
+              @object = @abstract_model.new
+              @action = @action.with(@action.bindings.merge(object: @object))
+              @authorization_adapter&.attributes_for(:new, @abstract_model)&.each do |name, value|
+                @object.send("#{name}=", value)
+              end
+              object_params = params[@abstract_model.param_key]
+              if object_params
+                sanitize_params_for!(request.xhr? ? :modal : :create)
+                @object.assign_attributes(@object.attributes.merge(object_params.to_h))
+              end
+              respond_to do |format|
+                format.html { render @action.template_name }
+                format.js { render @action.template_name, layout: "rails_admin_next/modal", content_type: Mime[:html].to_s }
+              end
+
+            elsif request.post? # CREATE
+
+              @modified_assoc = []
+              @object = @abstract_model.new
+              sanitize_params_for!(request.xhr? ? :modal : :create)
+
+              @object.assign_attributes(params[@abstract_model.param_key])
+              @authorization_adapter&.authorize(:create, @abstract_model, @object)
+
+              if @object.save
+                @auditing_adapter&.create_object(@object, @abstract_model, _current_user)
+                respond_to do |format|
+                  format.html { redirect_to_on_success }
+                  format.json { render json: {id: @object.id.to_s, label: @model_config.with(object: @object).object_label} }
+                end
+              else
+                handle_save_error
+              end
+
+            end
+          end
+        end
+
+        register_instance_option :link_icon do
+          :new
+        end
+
+        register_instance_option :writable? do
+          !(bindings[:object] && bindings[:object].readonly?)
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/actions/show.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  module Config
+    module Actions
+      class Show < RailsAdminNext::Config::Actions::Base
+        RailsAdminNext::Config::Actions.register(self)
+
+        register_instance_option :member do
+          true
+        end
+
+        register_instance_option :route_fragment do
+          ""
+        end
+
+        register_instance_option :breadcrumb_parent do
+          [:index, bindings[:abstract_model]]
+        end
+
+        register_instance_option :controller do
+          proc do
+            respond_to do |format|
+              format.json { render json: @object }
+              format.html { render @action.template_name }
+            end
+          end
+        end
+
+        register_instance_option :link_icon do
+          :show
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/actions/show_in_app.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  module Config
+    module Actions
+      class ShowInApp < RailsAdminNext::Config::Actions::Base
+        RailsAdminNext::Config::Actions.register(self)
+
+        register_instance_option :member do
+          true
+        end
+
+        register_instance_option :visible? do
+          authorized? && begin
+            bindings[:controller].main_app.url_for(bindings[:object])
+          rescue
+            false
+          end
+        end
+
+        register_instance_option :controller do
+          proc do
+            redirect_to main_app.url_for(@object)
+          end
+        end
+
+        register_instance_option :link_icon do
+          :show_in_app
+        end
+
+        register_instance_option :turbo? do
+          false
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/actions.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  module Config
+    module Actions
+      class << self
+        def all(scope = nil, bindings = {})
+          if scope.is_a?(Hash)
+            bindings = scope
+            scope = :all
+          end
+          scope ||= :all
+          init_actions!
+          actions =
+            case scope
+            when :all
+              @@actions
+            when :root
+              @@actions.select(&:root?)
+            when :collection
+              @@actions.select(&:collection?)
+            when :bulkable
+              @@actions.select(&:bulkable?)
+            when :member
+              @@actions.select(&:member?)
+            end
+
+          actions = actions.collect { |action| action.with(bindings) }
+          bindings[:controller] ? actions.select(&:visible?) : actions
+        end
+
+        def find(custom_key, bindings = {})
+          init_actions!
+          action = @@actions.detect { |a| a.custom_key == custom_key }.try(:with, bindings)
+          bindings[:controller] ? (action.try(:visible?) && action || nil) : action
+        end
+
+        def collection(key, parent_class = :base, &)
+          add_action(key, parent_class, :collection, &)
+        end
+
+        def member(key, parent_class = :base, &)
+          add_action(key, parent_class, :member, &)
+        end
+
+        def root(key, parent_class = :base, &)
+          add_action(key, parent_class, :root, &)
+        end
+
+        def add_action(key, parent_class, parent, &)
+          a = "RailsAdminNext::Config::Actions::#{parent_class.to_s.camelize}".constantize.new
+          a.instance_eval(%(
+            #{parent} true
+            def key
+              :#{key}
+            end
+          ), __FILE__, __LINE__ - 5)
+          add_action_custom_key(a, &)
+        end
+
+        def reset
+          @@actions = nil
+        end
+
+        def register(name, klass = nil)
+          if klass.nil? && name.is_a?(Class)
+            klass = name
+            name = klass.to_s.demodulize.underscore.to_sym
+          end
+
+          instance_eval %{
+            def #{name}(&block)
+              action = #{klass}.new
+              add_action_custom_key(action, &block)
+            end
+          }, __FILE__, __LINE__ - 5
+        end
+
+        private
+
+        def init_actions!
+          @@actions ||= [
+            Dashboard.new,
+            Index.new,
+            Show.new,
+            New.new,
+            Edit.new,
+            Export.new,
+            Delete.new,
+            BulkDelete.new,
+            HistoryShow.new,
+            HistoryIndex.new,
+            ShowInApp.new
+          ]
+        end
+
+        def add_action_custom_key(action, &block)
+          action.instance_eval(&block) if block
+          @@actions ||= []
+          if action.custom_key.in?(@@actions.collect(&:custom_key))
+            raise "Action #{action.custom_key} already exists. Please change its custom key."
+          else
+            @@actions << action
+          end
+        end
+      end
+    end
+  end
+end
+
+require "rails_admin_next/config/actions/base"
+require "rails_admin_next/config/actions/dashboard"
+require "rails_admin_next/config/actions/index"
+require "rails_admin_next/config/actions/show"
+require "rails_admin_next/config/actions/show_in_app"
+require "rails_admin_next/config/actions/history_show"
+require "rails_admin_next/config/actions/history_index"
+require "rails_admin_next/config/actions/new"
+require "rails_admin_next/config/actions/edit"
+require "rails_admin_next/config/actions/export"
+require "rails_admin_next/config/actions/delete"
+require "rails_admin_next/config/actions/bulk_delete"