plutonium 0.14.0 → 0.15.0.pre.rc1

data/lib/plutonium/{core → resource}/controllers/interactive_actions.rb

@@ -1,5 +1,5 @@
 module Plutonium
-  module Core
+  module Resource
     module Controllers
       module InteractiveActions
         extend ActiveSupport::Concern
@@ -7,17 +7,17 @@ module Plutonium
         included do
           helper_method :current_interactive_action
 
-          before_action :validate_interactive_resource_action, only: %i[
+          before_action :validate_interactive_resource_action!, only: %i[
             begin_interactive_resource_record_action commit_interactive_resource_record_action
             begin_interactive_resource_collection_action commit_interactive_resource_collection_action
             begin_interactive_resource_recordless_action commit_interactive_resource_recordless_action
           ]
 
-          before_action :authorize_interactive_resource_record_action, only: %i[
+          before_action :authorize_interactive_resource_record_action!, only: %i[
             begin_interactive_resource_record_action commit_interactive_resource_record_action
           ]
 
-          before_action :authorize_interactive_resource_action, only: %i[
+          before_action :authorize_interactive_resource_action!, only: %i[
             begin_interactive_resource_collection_action commit_interactive_resource_collection_action
             begin_interactive_resource_recordless_action commit_interactive_resource_recordless_action
           ]
@@ -123,7 +123,7 @@ module Plutonium
 
         # GET /resources/actions/:interactive_action
         def begin_interactive_resource_recordless_action
-          skip_policy_scope
+          # skip_policy_scope
 
           @interaction = current_interactive_action.interaction.new interaction_params
 
@@ -136,7 +136,7 @@ module Plutonium
 
         # POST /resources/actions/:interactive_action
         def commit_interactive_resource_recordless_action
-          skip_policy_scope
+          # skip_policy_scope
 
           respond_to do |format|
             inputs = interaction_params
@@ -182,25 +182,25 @@ module Plutonium
           @interactive_resource_actions ||= current_presenter.actions.except :new, :show, :edit, :destroy
         end
 
-        def validate_interactive_resource_action
+        def validate_interactive_resource_action!
           interactive_resource_action = params[:interactive_action]&.to_sym
           unless interactive_resource_actions.key?(interactive_resource_action)
             raise ::AbstractController::ActionNotFound, "Unknown action '#{interactive_resource_action}'"
           end
         end
 
-        def authorize_interactive_resource_record_action
+        def authorize_interactive_resource_record_action!
           interactive_resource_action = params[:interactive_action]&.to_sym
-          authorize resource_record, :"#{interactive_resource_action}?"
+          authorize_current! resource_record, to: :"#{interactive_resource_action}?"
         end
 
-        def authorize_interactive_resource_action
+        def authorize_interactive_resource_action!
           interactive_resource_action = params[:interactive_action]&.to_sym
-          authorize resource_class, :"#{interactive_resource_action}?"
+          authorize_current! resource_class, to: :"#{interactive_resource_action}?"
         end
 
         def interactive_resource_collection
-          @interactive_resource_collection ||= policy_scope(resource_class).from_path_param(params.require(:ids)).all
+          @interactive_resource_collection ||= current_authorized_scope.from_path_param(params.require(:ids))
         end
 
         def interaction_params

data/lib/plutonium/resource/controllers/presentable.rb

@@ -0,0 +1,41 @@
+module Plutonium
+  module Resource
+    module Controllers
+      module Presentable
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :presentable_attributes, :present_associations?
+          helper_method :build_form, :build_detail, :build_collection
+        end
+
+        private
+
+        def presentable_attributes
+          @presentable_attributes ||= begin
+            presentable_attributes = permitted_attributes
+            presentable_attributes -= [scoped_entity_param_key, :"#{scoped_entity_param_key}_id"] if scoped_to_entity?
+            presentable_attributes -= [parent_input_param, :"#{parent_input_param}_id"] if current_parent.present?
+            presentable_attributes
+          end
+        end
+
+        def build_collection
+          current_definition.collection_class.new(@resource_records, resource_fields: presentable_attributes, resource_definition: current_definition)
+        end
+
+        def build_detail
+          current_definition.detail_class.new(resource_record, resource_fields: presentable_attributes, resource_associations: permitted_associations, resource_definition: current_definition)
+        end
+
+        def build_form
+          current_definition.form_class.new(resource_record, resource_fields: presentable_attributes, resource_definition: current_definition)
+        end
+
+        def present_associations?
+          current_parent.nil?
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/resource/controllers/queryable.rb

@@ -0,0 +1,44 @@
+using Plutonium::Refinements::ParameterRefinements
+
+module Plutonium
+  module Resource
+    module Controllers
+      module Queryable
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :resource_query_params, :current_query_object
+        end
+
+        def resource_query_object(resource_class, params)
+          query_object_class = "#{resource_class}QueryObject".constantize
+          query_object_class.new resource_context, params
+        end
+
+        def current_query_object
+          @current_query_object ||= Plutonium::Resource::QueryObject.new(resource_context, resource_query_params) do |query_object|
+            if current_definition.search_definition
+              query_object.define_search proc { |scope, search:|
+                current_definition.search_definition.call(scope, search)
+              }
+            end
+
+            current_definition.defined_scopes.each do |key, value|
+              query_object.define_scope key, value[:block]
+            end
+
+            current_definition.defined_sorts.each do |key, value|
+              query_object.define_sorter key, value[:block]
+            end
+
+            query_object
+          end
+        end
+
+        def resource_query_params
+          (params[:q]&.nilify&.to_unsafe_h || {}).with_indifferent_access
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/resource/definition.rb

@@ -0,0 +1,6 @@
+module Plutonium
+  module Resource
+    class Definition < Plutonium::Definition::Base
+    end
+  end
+end

data/lib/plutonium/resource/policy.rb

@@ -1,13 +1,19 @@
+# frozen_string_literal: true
+
 module Plutonium
   module Resource
     # Policy class to define permissions and attributes for a resource.
     # This class provides methods to check permissions for various actions
     # and to retrieve permitted attributes for these actions.
-    class Policy
-      include Plutonium::Policy::Initializer
+    class Policy < ActionPolicy::Base
+      authorize :user, allow_nil: false
+      authorize :scope, allow_nil: true
 
-      # Scope class to define the scope of the policy.
-      class Scope < Plutonium::Policy::Scope
+      relation_scope do |relation|
+        if scope.present?
+          relation = relation.associated_with(scope)
+        end
+        relation
       end
 
       # Sends a method and raises an error if the method is not implemented.
@@ -95,7 +101,7 @@ module Plutonium
       # @return [Array<Symbol>] The permitted attributes.
       def permitted_attributes_for_create
         autodetect_permitted_fields(:permitted_attributes_for_create) - [
-          context.resource_context.resource_class.primary_key.to_sym, # primary_key
+          resource_class.primary_key.to_sym, # primary_key
           :created_at, :updated_at # timestamps
         ]
       end
@@ -153,13 +159,17 @@ module Plutonium
 
       private
 
+      def resource_class
+        record.instance_of?(Class) ? record : record.class
+      end
+
       # Autodetects the permitted fields for a given method.
       #
       # @param method_name [Symbol] The name of the method.
       # @return [Array<Symbol>] The auto-detected permitted fields.
       def autodetect_permitted_fields(method_name)
         warn_about_autodetect_usage(method_name)
-        context.resource_context.resource_class.resource_field_names
+        resource_class.resource_field_names
       end
 
       # Warns about the usage of auto-detection of fields.
@@ -171,16 +181,18 @@ module Plutonium
           raise "Resource field auto-detection: #{self.class}##{method} outside development"
         end
 
-        Plutonium.logger.warn %(
-          🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
+        Plutonium.logger.warn {
+          %(
+            🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
 
-          Resource field auto-detection: #{self.class}##{method}
+            Resource field auto-detection: #{self.class}##{method}
 
-          Auto-detected resource fields result in security holes and will fail outside of development.
-          Override #{context.resource_context.resource_class}Policy or #{self.class} with your own ##{method} method.
+            Auto-detected resource fields result in security holes and will fail outside of development.
+            Override #{resource_class}Policy or #{self.class} with your own ##{method} method.
 
-          🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
-        )
+            🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
+          )
+        }
       end
     end
   end

data/lib/plutonium/resource/query_object.rb

@@ -102,7 +102,7 @@ module Plutonium
       #
       # @param context [Object] The context in which the query object is used.
       # @param params [Hash] The parameters for initialization.
-      def initialize(context, params)
+      def initialize(context, params, &)
         @context = context
 
         define_standard_queries
@@ -110,10 +110,54 @@ module Plutonium
         define_filters
         define_sorters
 
+        yield self if block_given?
+
         extract_filter_params(params)
         extract_sort_params(params)
       end
 
+      # Defines a filter with the given name and body.
+      #
+      # @param name [Symbol] The name of the filter.
+      # @param body [Proc, nil] The body of the filter.
+      def define_filter(name, body = nil, &)
+        body ||= name
+        filter_definitions[name] = build_query(body, &)
+      end
+
+      # Defines a scope with the given name and body.
+      #
+      # @param name [Symbol] The name of the scope.
+      # @param body [Proc, nil] The body of the scope.
+      def define_scope(name, body = nil)
+        body ||= name
+        scope_definitions[name] = build_query(body)
+      end
+
+      # Defines a sort with the given name and body.
+      #
+      # @param name [Symbol] The name of the sort.
+      # @param body [Proc, nil] The body of the sort.
+      def define_sorter(name, body = nil)
+        if body.nil?
+          sort_field = determine_sort_field(name)
+          body = ->(scope, direction:) { scope.order(sort_field => direction) }
+        end
+
+        sort_definitions[name] = build_query(body) do |query|
+          query.define_field_input :direction
+        end
+      end
+
+      # Defines a search filter with the given body.
+      #
+      # @param body [Proc, Symbol] The body of the search filter.
+      def define_search(body)
+        @search_filter = build_query(body) do |query|
+          query.define_field_input :search
+        end
+      end
+
       # Builds a URL with the given options for search and sorting.
       #
       # @param options [Hash] The options for building the URL.
@@ -186,48 +230,6 @@ module Plutonium
         define_search(:search) if resource_class.respond_to?(:search)
       end
 
-      # Defines a filter with the given name and body.
-      #
-      # @param name [Symbol] The name of the filter.
-      # @param body [Proc, nil] The body of the filter.
-      def define_filter(name, body = nil, &)
-        body ||= name
-        filter_definitions[name] = build_query(body, &)
-      end
-
-      # Defines a scope with the given name and body.
-      #
-      # @param name [Symbol] The name of the scope.
-      # @param body [Proc, nil] The body of the scope.
-      def define_scope(name, body = nil)
-        body ||= name
-        scope_definitions[name] = build_query(body)
-      end
-
-      # Defines a sort with the given name and body.
-      #
-      # @param name [Symbol] The name of the sort.
-      # @param body [Proc, nil] The body of the sort.
-      def define_sorter(name, body = nil)
-        if body.nil?
-          sort_field = determine_sort_field(name)
-          body = ->(scope, direction:) { scope.order(sort_field => direction) }
-        end
-
-        sort_definitions[name] = build_query(body) do |query|
-          query.define_field_input :direction
-        end
-      end
-
-      # Defines a search filter with the given body.
-      #
-      # @param body [Proc, Symbol] The body of the search filter.
-      def define_search(body)
-        @search_filter = build_query(body) do |query|
-          query.define_field_input :search
-        end
-      end
-
       # Extracts filter parameters from the given params.
       #
       # @param params [Hash] The parameters to extract.
@@ -308,14 +310,11 @@ module Plutonium
           query_params[:sort_fields] << sort.to_s unless query_params[:sort_fields].include?(sort.to_s)
 
           sort_direction = selected_sort_directions[sort]
-          if sort_direction.nil?
-            query_params[:sort_directions][sort] = "ASC"
-          elsif sort_direction == "ASC"
-            query_params[:sort_directions][sort] = "DESC"
-          else
-            query_params[:sort_fields].delete_if { |e| e == sort.to_s }
-            query_params[:sort_directions].delete(sort)
-          end
+          query_params[:sort_directions][sort] = (sort_direction == "ASC") ? "DESC" : "ASC"
+          # else
+          #   query_params[:sort_fields].delete_if { |e| e == sort.to_s }
+          #   query_params[:sort_directions].delete(sort)
+          # end
         end
       end
 

data/lib/plutonium/resource/record.rb

@@ -2,6 +2,7 @@ module Plutonium
   module Resource
     module Record
       extend ActiveSupport::Concern
+      include Plutonium::Models::HasCents
 
       included do
         scope :from_path_param, ->(param) { where(id: param) }
@@ -14,12 +15,12 @@ module Plutonium
           # TODO: add logging
           # TODO: memoize this
 
-          own_association = klass.find_association_to_record(record)
+          own_association = klass.find_association_from_self_to_record(record)
           if own_association
             return klass.query_based_on_association(own_association, record)
           end
 
-          record_association = klass.find_association_to_self(record)
+          record_association = klass.find_association_to_self_from_record(record)
           if record_association
             # TODO: add a warning here about a potentially poor performing query
             return where(id: record.public_send(record_association.name))
@@ -43,7 +44,7 @@ module Plutonium
         # @param [Proc] scope The scope for the association
         # @param [Hash] options The options for the association
         def belongs_to(name, scope = nil, **options)
-          super(name, scope, **options)
+          super
 
           return unless options[:polymorphic]
 
@@ -155,31 +156,10 @@ module Plutonium
           end.compact.to_h
         end
 
-        # Returns the strong parameters definition for the given attribute names
-        # @param [Array<Symbol>] *attributes Attribute names
-        # @return [Array<Symbol, Hash>] A strong parameters compatible array
-        def strong_parameters_for(*attributes)
-          unbacked = attributes - strong_parameters_definition.keys
-
-          backed = strong_parameters_definition.slice(*attributes).values.reduce(:merge)
-            &.map { |key, value| value.nil? ? key : {key => value} } || {}
-
-          case backed.presence
-          when Hash
-            [*unbacked, **backed]
-          when Array
-            [*unbacked, *backed]
-          when nil
-            unbacked
-          else
-            raise "Unexpected strong parameters definition: #{backed.class}"
-          end
-        end
-
         # Finds the association to the given record
         # @param [ActiveRecord::Base] record The record to find the association with
         # @return [ActiveRecord::Reflection::AssociationReflection, nil]
-        def find_association_to_record(record)
+        def find_association_from_self_to_record(record)
           reflect_on_all_associations.find do |assoc|
             assoc.klass.name == record.class.name unless assoc.polymorphic?
           rescue
@@ -191,7 +171,7 @@ module Plutonium
         # Finds the association to self in the given record
         # @param [ActiveRecord::Base] record The record to find the association with
         # @return [ActiveRecord::Reflection::AssociationReflection, nil]
-        def find_association_to_self(record)
+        def find_association_to_self_from_record(record)
           record.class.reflect_on_all_associations.find do |assoc|
             assoc.klass.name == name
           rescue
@@ -231,69 +211,6 @@ module Plutonium
 
         private
 
-        # Defines the strong parameters
-        # @return [Hash]
-        def strong_parameters_definition
-          unless Rails.env.local?
-            return @strong_parameters if defined?(@strong_parameters)
-          end
-
-          @strong_parameters = build_strong_parameters
-        end
-
-        # Builds the strong parameters hash
-        # @return [Hash]
-        def build_strong_parameters
-          parameters = content_column_field_names.map do |name|
-            column = columns_hash[name.to_s]
-            type = if column.try(:array?)
-              []
-            else
-              ([:json, :jsonb].include?(column&.type) ? {} : nil)
-            end
-            [name, {name => type}]
-          end.to_h
-
-          parameters.merge!(belongs_to_association_parameters)
-          parameters.merge!(has_many_association_parameters)
-          parameters.merge!(attachment_parameters)
-          parameters.merge!(nested_attributes_parameters)
-
-          parameters
-        end
-
-        # Returns the parameters for belongs_to associations
-        # @return [Hash]
-        def belongs_to_association_parameters
-          reflect_on_all_associations(:belongs_to).map do |reflection|
-            input_param = reflection.options[:foreign_key] || :"#{reflection.name}_id"
-            [reflection.name, {input_param => nil, :"#{reflection.name}_sgid" => nil}]
-          end.to_h
-        end
-
-        # Returns the parameters for has_many associations
-        # @return [Hash]
-        def has_many_association_parameters
-          has_many_association_field_names.map do |name|
-            [name, {"#{name.to_s.singularize}_ids": []}]
-          end.to_h
-        end
-
-        # Returns the parameters for attachments
-        # @return [Hash]
-        def attachment_parameters
-          has_many_attached_field_names.map { |name| [name, {name => []}] }.to_h
-            .merge(has_one_attached_field_names.map { |name| [name, {name => nil}] }.to_h)
-        end
-
-        # Returns the parameters for nested attributes
-        # @return [Hash]
-        def nested_attributes_parameters
-          all_nested_attributes_options.keys.map do |name|
-            [name, {"#{name}_attributes" => {}}]
-          end.to_h
-        end
-
         # Defines a scope and method for path parameters
         # @param [Symbol] param_name The name of the parameter
         def path_parameter(param_name)

data/lib/plutonium/resource/register.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module Resource
+    # Resource register manages the registration and lookup of resources.
+    class Register
+      include Plutonium::Lib::SmartCache
+
+      # Custom error class for frozen register operations
+      class FrozenRegisterError < StandardError; end
+
+      def initialize
+        @resources = Set.new
+        @frozen = false
+      end
+
+      # Registers a new resource with the register.
+      #
+      # @param resource [Class] The resource class to be registered.
+      # @raise [FrozenRegisterError] If the register is frozen.
+      # @return [void]
+      def register(resource)
+        raise FrozenRegisterError, "Cannot modify frozen resource register" if @frozen
+
+        @resources.add(resource.to_s)
+      end
+
+      # Returns an array of all registered resource classes and freezes the register.
+      #
+      # @return [Array<Class>] An array of registered resource classes.
+      def resources
+        freeze
+        @resources.map(&:constantize)
+      end
+      memoize_unless_reloading :resources
+
+      # Returns a hash mapping route keys to their corresponding resource classes.
+      # This method will freeze the register if it hasn't been frozen already.
+      #
+      # @return [Hash{Symbol => Class}] A hash where keys are route keys and values are resource classes.
+      def route_key_lookup
+        freeze
+        resources.to_h do |resource|
+          [resource.model_name.singular_route_key.to_sym, resource]
+        end
+      end
+      memoize_unless_reloading :route_key_lookup
+
+      # Clears all registered resources and invalidates the cache.
+      #
+      # @return [void]
+      def clear
+        @resources.clear
+        @frozen = false
+        invalidate_cache
+      end
+
+      # Checks if the register is frozen.
+      #
+      # @return [Boolean] True if the register is frozen, false otherwise.
+      def frozen?
+        @frozen
+      end
+
+      private
+
+      # Freezes the register
+      #
+      # @return [Boolean] Always returns true
+      def freeze
+        @frozen ||= true
+      end
+
+      # Invalidates the memoization cache
+      #
+      # @return [void]
+      def invalidate_cache
+        flush_smart_cache
+      end
+    end
+  end
+end

data/lib/plutonium/routing/mapper_extensions.rb

@@ -79,7 +79,7 @@ module Plutonium
       def define_nested_resource_routes(resource)
         nested_configs = route_set.resource_route_config_for(*resource.has_many_association_routes)
         nested_configs.each do |nested_config|
-          resources nested_config[:route_name], **nested_config[:route_options] do
+          resources "nested_#{nested_config[:route_name]}", **nested_config[:route_options] do
             instance_exec(&nested_config[:block]) if nested_config[:block]
           end
         end

data/lib/plutonium/routing/resource_registration.rb

@@ -8,7 +8,7 @@ module Plutonium
 
       class_methods do
         def resource_register
-          @resource_register ||= Plutonium::ResourceRegister.new
+          @resource_register ||= Plutonium::Resource::Register.new
         end
       end
     end

data/lib/plutonium/routing/route_set_extensions.rb

@@ -12,6 +12,9 @@ module Plutonium
     #     register_resource SomeModel
     #   end
     module RouteSetExtensions
+      extend ActiveSupport::Concern
+      include Plutonium::Engine::Validator
+
       # Clears all registered resources and route configurations.
       #
       # This method should be called when you want to reset all registered resources
@@ -30,7 +33,7 @@ module Plutonium
       # @return [void]
       # @yield Executes the given block in the context of route drawing.
       def draw(&block)
-        if supported_engine?
+        if self.class.supported_engine?(engine)
           ActiveSupport::Notifications.instrument("plutonium.resource_routes.draw", app: engine.to_s) do
             super do
               setup_shared_resource_concerns
@@ -48,9 +51,9 @@ module Plutonium
       # @param resource [Class] The resource class to be registered.
       # @yield An optional block for additional resource configuration.
       # @return [Hash] The configuration for the registered resource.
-      # @raise [ArgumentError] If the engine doesn't support Plutonium::Pkg::App.
+      # @raise [ArgumentError] If the engine is not supported.
       def register_resource(resource, &)
-        validate_engine!
+        self.class.validate_engine! engine
         engine.resource_register.register(resource)
 
         route_name = resource.model_name.plural
@@ -85,21 +88,6 @@ module Plutonium
         @resource_route_config_lookup ||= {}
       end
 
-      # Validates that the current engine supports Plutonium features.
-      #
-      # @raise [ArgumentError] If the engine doesn't include Plutonium::Pkg::App.
-      # @return [void]
-      def validate_engine!
-        raise ArgumentError, "#{engine} must include Plutonium::Pkg::App to register resources" unless supported_engine?
-      end
-
-      # Checks if the current engine supports Plutonium features.
-      #
-      # @return [Boolean] True if the engine includes Plutonium::Pkg::App, false otherwise.
-      def supported_engine?
-        engine.include?(Plutonium::Pkg::App)
-      end
-
       # Determines the appropriate engine based on the current scope.
       #
       # @return [Class] The determined engine class.