plutonium 0.6.2 → 0.8.0

data/lib/plutonium/core/controllers/authorizable.rb

@@ -12,19 +12,17 @@ module Plutonium
           after_action :verify_policy_scoped, except: %i[new create]
 
           helper_method :permitted_attributes
+          helper_method :current_policy
         end
 
         private
 
         def policy_namespace(scope)
-          raise NotImplementedError, "policy_namespace"
+          [current_package.to_s.underscore.to_sym, scope]
         end
 
         def policy_context
-          Plutonium::Reactor::PolicyContext.new(
-            user: current_user,
-            resource_context: resource_context
-          )
+          raise NotImplementedError, "policy_context"
         end
 
         def pundit_user

data/lib/plutonium/core/controllers/base.rb

@@ -0,0 +1,86 @@
+module Plutonium
+  module Core
+    module Controllers
+      module Base
+        extend ActiveSupport::Concern
+        include Plutonium::Core::Controllers::Bootable
+        include Plutonium::Core::Controllers::EntityScoping
+
+        included do
+          add_flash_types :success, :warning, :error
+
+          before_action :set_page_title
+
+          before_action do
+            next unless defined?(ActiveStorage)
+
+            ActiveStorage::Current.url_options = {protocol: request.protocol, host: request.host, port: request.port}
+          end
+
+          helper Plutonium::Helpers
+          helper_method :page_title, :resource_url_for, :resource_url_args_for
+
+          append_view_path File.expand_path("app/views", Plutonium.root)
+          layout -> { turbo_frame_request? ? false : "resource" }
+        end
+
+        private
+
+        def set_page_title
+          @page_title = "Pluton8"
+        end
+
+        def page_title(title)
+          [title.presence, Rails.application.class.module_parent.name].compact.join(" | ")
+        end
+
+        #
+        # Returns a dynamic list of args to be used with `url_for` which considers the route namespace and nesting.
+        # The current entity and parent record (for nested routes) are inserted appropriately, ensuring that generated urls
+        # obey the current routing.
+        #
+        # e.g. of route helpers that will be invoked given the output of this method
+        #
+        # - when invoked in a root route (/acme/dashboard/users)
+        #
+        # `resource_url_args_for User`                   => `entity_users_*`
+        # `resource_url_args_for @user`                  => `entity_user_*`
+        # `resource_url_args_for @user, action: :edit`   => `edit_entity_user_*`
+        # `resource_url_args_for @user, Post             => `entity_user_posts_*`
+        #
+        # - when invoked in a nested route (/acme/dashboard/users/1/post/1)
+        #
+        # `resource_url_args_for Post`                   => `entity_user_posts_*`
+        # `resource_url_args_for @post`                  => `entity_user_post_*`
+        # `resource_url_args_for @post, action: :edit`   => `edit_entity_user_post_*`
+        #
+        # @param [Class, ApplicationRecord] *args arguments you would normally pass to `url_for`
+        # @param [Symbol] action optional action to invoke e.g. :new, :edit
+        #
+        # @return [Array[Class, ApplicationRecord, Symbol]] args to pass to `url_for`
+        #
+        def resource_url_args_for(*args, action: nil, parent: nil, **kwargs)
+          # If the last item is a class and the action is :new e.g. `resource_url User, action: :new`,
+          # it must be converted into a symbol to generate the appropriate helper i.e `new_user_*`
+          # to match the url helper generated by `resources :users`
+          resource = args.pop
+          resource = resource.model_name.singular_route_key.to_sym if action == :new && resource.is_a?(Class)
+          args.push resource
+
+          base_args = if scoped_to_entity? && scoped_entity_strategy == :path
+            [action, current_scoped_entity.becomes(scoped_entity_class), parent]
+          else
+            [action, parent]
+          end
+
+          # rails compacts this list. no need to handle nils
+          base_args + args + [**kwargs]
+        end
+
+        def resource_url_for(...)
+          send(current_package.name.underscore.to_sym).url_for(resource_url_args_for(...))
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/controllers/bootable.rb

@@ -5,38 +5,19 @@ module Plutonium
         extend ActiveSupport::Concern
 
         included do
-          class_attribute :package
-          class_attribute :resource_class, instance_writer: false, instance_predicate: false
+          class_attribute :current_package, instance_writer: false, instance_predicate: false
+          class_attribute :current_engine, instance_writer: false, instance_predicate: false
 
-          helper_method :resource_class
+          helper_method :current_engine, :current_package
         end
 
         class_methods do
-          def current_engine
-            "#{package}::Engine".constantize
-          end
-
-          private
-
           def boot(package)
-            self.package = package
+            self.current_package = package
+            self.current_engine = "#{package}::Engine".constantize
 
             prepend_view_path current_engine.paths["app/views"].first
           end
-
-          def controller_for(resource_class)
-            self.resource_class = resource_class
-          end
-        end
-
-        private
-
-        def current_engine
-          @current_engine ||= self.class.current_engine
-        end
-
-        def current_package
-          self.class.package
         end
       end
     end

data/lib/plutonium/core/controllers/crud_actions.rb

@@ -4,12 +4,19 @@ module Plutonium
       module CrudActions
         extend ActiveSupport::Concern
 
+        included do
+          helper_method :preferred_action_after_submit
+        end
+
         # GET /resources(.{format})
         def index
           authorize resource_class
 
-          @ransack = policy_scope(resource_class).ransack(params[:q])
-          @pagy, @resource_records = pagy @ransack.result
+          @search_object = current_query_object
+          base_query = policy_scope(resource_class)
+          base_query = @search_object.apply(base_query)
+          base_query = base_query.send(params[:scope].to_sym) if params[:scope].present?
+          @pagy, @resource_records = pagy base_query
           @collection = build_collection
 
           render :index
@@ -44,10 +51,10 @@ module Plutonium
           respond_to do |format|
             if resource_record.save
               format.html do
-                redirect_to adapt_route_args(resource_record),
+                redirect_to redirect_url_after_submit,
                   notice: "#{resource_class.model_name.human} was successfully created."
               end
-              format.any { render :show, status: :created, location: adapt_route_args(resource_record) }
+              format.any { render :show, status: :created, location: redirect_url_after_submit }
             else
               format.html do
                 @form = build_form
@@ -78,10 +85,10 @@ module Plutonium
           respond_to do |format|
             if resource_record.update(resource_params)
               format.html do
-                redirect_to adapt_route_args(resource_record), notice: "#{resource_class.model_name.human} was successfully updated.",
+                redirect_to redirect_url_after_submit, notice: "#{resource_class.model_name.human} was successfully updated.",
                   status: :see_other
               end
-              format.any { render :show, status: :ok, location: adapt_route_args(resource_record) }
+              format.any { render :show, status: :ok, location: redirect_url_after_submit }
             else
               format.html do
                 @form = build_form
@@ -103,13 +110,13 @@ module Plutonium
             resource_record.destroy
 
             format.html do
-              redirect_to adapt_route_args(resource_class),
+              redirect_to resource_url_for(resource_class),
                 notice: "#{resource_class.model_name.human} was successfully deleted."
             end
             format.json { head :no_content }
           rescue ActiveRecord::InvalidForeignKey
             format.html do
-              redirect_to adapt_route_args(resource_record),
+              redirect_to resource_url_for(resource_record),
                 alert: "#{resource_class.model_name.human} is referenced by other records."
             end
             format.any do
@@ -120,6 +127,34 @@ module Plutonium
             end
           end
         end
+
+        private
+
+        def redirect_url_after_submit
+          url = case preferred_action_after_submit
+          when "show"
+            resource_url_for(resource_record) if current_policy.show?
+          when "edit"
+            resource_url_for(resource_record, action: :edit) if current_policy.edit?
+          when "new"
+            resource_url_for(resource_class, action: :new) if current_policy.new?
+          when "index"
+            resource_url_for(resource_class) if current_policy.index?
+          else
+            # ensure we have a valid value
+            session[:action_after_submit_preference] = "show"
+          end
+          url || resource_url_for(resource_record)
+        end
+
+        def preferred_action_after_submit
+          @preferred_action_after_submit = begin
+            if %w[new edit show index].include? params[:commit]
+              session[:action_after_submit_preference] = params[:commit]
+            end
+            session[:action_after_submit_preference] || "show"
+          end
+        end
       end
     end
   end

data/lib/plutonium/core/controllers/entity_scoping.rb

@@ -15,6 +15,10 @@ module Plutonium
           current_engine.scoped_to_entity?
         end
 
+        def scoped_entity_strategy
+          current_engine.scoped_entity_strategy
+        end
+
         def scoped_entity_class
           ensure_legal_entity_scoping_method_access! :scoped_entity_class
 
@@ -30,7 +34,7 @@ module Plutonium
         def scoped_entity_session_key
           ensure_legal_entity_scoping_method_access! :scoped_entity_session_key
 
-          :scoped_entity_id
+          :"#{current_package.name.underscore}__scoped_entity_id"
         end
 
         def current_scoped_entity
@@ -38,10 +42,17 @@ module Plutonium
 
           return unless current_user.present?
 
-          @current_scoped_entity ||= scoped_entity_class
-            .associated_with(current_user)
-            .from_path_param(request.path_parameters[scoped_entity_param_key])
-            .first! # Raise NotFound if user does not have access to the entity or it does not exist
+          @current_scoped_entity ||= case scoped_entity_strategy
+          when :current_user
+            current_user
+          when :path
+            scoped_entity_class
+              .associated_with(current_user)
+              .from_path_param(request.path_parameters[scoped_entity_param_key])
+              .first! # Raise NotFound if user does not have access to the entity or it does not exist
+          else
+            raise NotImplementedError, "unknown scoped entity strategy: #{scoped_entity_strategy}"
+          end
         end
 
         def remember_scoped_entity

data/lib/plutonium/core/controllers/interactive_actions.rb

@@ -5,6 +5,8 @@ module Plutonium
         extend ActiveSupport::Concern
 
         included do
+          helper_method :current_interactive_action
+
           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
@@ -41,13 +43,13 @@ module Plutonium
             if @interaction.valid?
               flash[:notice] = "TODO:#{current_interactive_action} was successfully updated."
 
-              format.html { redirect_to adapt_route_args(@interaction.result), status: :see_other }
-              format.any { render :show, status: :ok, location: adapt_route_args(@interaction.result) }
+              format.html { redirect_to resource_url_for(@interaction.result), status: :see_other }
+              format.any { render :show, status: :ok, location: resource_url_for(@interaction.result) }
 
               if helpers.current_turbo_frame == "modal"
                 format.turbo_stream do
                   render turbo_stream: [
-                    turbo_stream.redirect(url_for(adapt_route_args(@interaction.result)))
+                    turbo_stream.redirect(resource_url_for(@interaction.result))
                   ]
                 end
               end
@@ -93,11 +95,11 @@ module Plutonium
 
               flash[:notice] = "TODO:#{current_interactive_action} #{collection_count} #{resource_class.model_name.human.pluralize(collection_count)} successfully updated."
 
-              format.html { redirect_to adapt_route_args(resource_class) }
+              format.html { redirect_to resource_url_for(resource_class) }
               if helpers.current_turbo_frame == "modal"
                 format.turbo_stream do
                   render turbo_stream: [
-                    turbo_stream.redirect(url_for(resource_class))
+                    turbo_stream.redirect(resource_url_for(resource_class))
                   ]
                 end
               end
@@ -143,12 +145,12 @@ module Plutonium
             if @interaction.valid?
               flash[:notice] = "TODO:#{current_interactive_action} was successfully updated."
 
-              format.html { redirect_to adapt_route_args(resource_class) }
+              format.html { redirect_to resource_url_for(resource_class) }
 
               if helpers.current_turbo_frame == "modal"
                 format.turbo_stream do
                   render turbo_stream: [
-                    turbo_stream.redirect(url_for(adapt_route_args(resource_class)))
+                    turbo_stream.redirect(resource_url_for(resource_class))
                   ]
                 end
               end

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

@@ -11,11 +11,12 @@ module Plutonium
         private
 
         def resource_presenter(resource_class, resource_record)
-          raise NotImplementedError, "#{self.class}#resource_presenter"
+          presenter_class = "#{resource_class}Presenter".constantize
+          presenter_class.new resource_context, resource_record
         end
 
         def current_presenter
-          resource_presenter resource_class, @resource_record
+          @current_presenter ||= resource_presenter resource_class, @resource_record
         end
 
         def presentable_attributes
@@ -28,30 +29,29 @@ module Plutonium
         end
 
         def build_collection
-          Plutonium::Core::UI::Collection.new(
+          Plutonium::Core::Ui::Collection.new(
             resource_class:,
             records: @resource_records,
-            fields: current_presenter.defined_renderers_for(presentable_attributes),
+            fields: current_presenter.defined_renderers_for(*presentable_attributes),
             actions: current_presenter.actions,
-            pagination: @pagy,
-            search_object: @ransack,
-            search_field: current_presenter.search_field
+            pager: @pagy,
+            search_object: @search_object
           )
         end
 
         def build_detail
-          Plutonium::Core::UI::Detail.new(
+          Plutonium::Core::Ui::Detail.new(
             resource_class:,
             record: resource_record,
-            fields: current_presenter.defined_renderers_for(presentable_attributes),
+            fields: current_presenter.defined_renderers_for(*presentable_attributes),
             actions: current_presenter.actions
           )
         end
 
         def build_form
-          Plutonium::Core::UI::Form.new(
+          Plutonium::Core::Ui::Form.new(
             record: resource_record,
-            inputs: current_presenter.defined_inputs_for(presentable_attributes)
+            inputs: current_presenter.defined_inputs_for(*presentable_attributes)
           )
         end
       end

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

@@ -0,0 +1,26 @@
+module Plutonium
+  module Core
+    module Controllers
+      module Queryable
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :resource_query_params
+        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 ||= resource_query_object resource_class, resource_query_params
+        end
+
+        def resource_query_params
+          (params[:q]&.to_unsafe_h || {}).with_indifferent_access
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/definers/input_definer.rb

@@ -5,24 +5,62 @@ module Plutonium
         extend ActiveSupport::Concern
         include Plutonium::Core::Autodiscovery::InputDiscoverer
 
-        def defined_inputs_for(names)
+        class InputDefinitions
+          def initialize(hash)
+            @hash = hash
+          end
+
+          def []=(key, value)
+            hash[key] = value
+          end
+
+          def [](key)
+            hash[key]
+          end
+
+          def slice(*)
+            self.class.new(hash.slice(*))
+          end
+
+          def collect_all(params)
+            hash.values.map { |input| input.collect params }.reduce(:merge) || {}
+          end
+
+          def size
+            hash.size
+          end
+
+          def keys
+            hash.keys
+          end
+
+          def values
+            hash.values
+          end
+
+          def blank?
+            hash.blank?
+          end
+
+          private
+
+          attr_reader :hash
+        end
+
+        def defined_inputs_for(*names)
           (names - input_definitions.keys).each do |name|
             define_input(name, input: autodiscover_input(name))
           end
           input_definitions.slice(*names)
         end
 
-        private
-
-        def input_definitions = @input_definitions ||= {}
-
         def define_input(name, input: nil, type: nil, **options)
           input_definitions[name] = if input.present?
             input
           elsif type.present?
-            Plutonium::Core::Fields::Inputs.build(name, type:, **options)
+            Plutonium::Core::Fields::Inputs::Factory.build(name, type:, **options)
           elsif options.present?
-            Plutonium::Core::Fields::Inputs::Factory.for_resource_attribute(context.resource_class, name, **options)
+            Plutonium::Core::Fields::Inputs::Factory.for_resource_attribute(resource_class, name, **options)
           else
             autodiscover_input(name)
           end
@@ -31,6 +69,8 @@ module Plutonium
         def input_defined?(name)
           input_definitions.key? name
         end
+
+        def input_definitions = @input_definitions ||= InputDefinitions.new({})
       end
     end
   end

data/lib/plutonium/core/definers/renderer_definer.rb

@@ -5,7 +5,7 @@ module Plutonium
         extend ActiveSupport::Concern
         include Plutonium::Core::Autodiscovery::RendererDiscoverer
 
-        def defined_renderers_for(names)
+        def defined_renderers_for(*names)
           (names - renderer_definitions.keys).each do |name|
             define_renderer(name, renderer: autodiscover_renderer(name))
           end
@@ -19,8 +19,10 @@ module Plutonium
         def define_renderer(name, renderer: nil, type: nil, **options)
           renderer_definitions[name] = if renderer.present?
             renderer
-          elsif type.present? || options.present?
-            Plutonium::Core::Fields::Renderers::Factory.for_resource_attribute(context.resource_class, name, type:, **options)
+          elsif type.present?
+            Plutonium::Core::Fields::Renderers::Factory.build(name, type:, **options)
+          elsif options.present?
+            Plutonium::Core::Fields::Renderers::Factory.for_resource_attribute(resource_class, name, **options)
           else
             autodiscover_renderer(name)
           end

data/lib/plutonium/core/fields/inputs/base.rb

@@ -10,7 +10,7 @@ module Plutonium
             @user_options = user_options
           end
 
-          def render(f, record)
+          def render(f, record, **)
             raise NotImplementedError, "#{self.class}#render"
           end
 
@@ -26,8 +26,8 @@ module Plutonium
             # - parameter(1i)
             # - parameter(2f)
             regex = /^#{param}(\(\d+[if]?\))?$/
-
-            params.select { |key| regex.match? key }
+            keys = params.select { |key, value| regex.match?(key) }.keys
+            params.slice(*keys)
           end
 
           protected

data/lib/plutonium/core/fields/inputs/date_time_input.rb

@@ -0,0 +1,13 @@
+module Plutonium
+  module Core
+    module Fields
+      module Inputs
+        class DateTimeInput < SimpleFormInput
+          private
+
+          def input_options = {wrapper: :resource_multi_select}
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/fields/inputs/factory.rb

@@ -9,12 +9,17 @@ module Plutonium
 
           map_type :has_one, to: Plutonium::Core::Fields::Inputs::NoopInput
           map_type :belongs_to, to: Plutonium::Core::Fields::Inputs::BelongsToAssociationInput
+          map_type :polymorphic_belongs_to, to: Plutonium::Core::Fields::Inputs::PolymorphicBelongsToAssociationInput
           map_type :has_many, to: Plutonium::Core::Fields::Inputs::HasManyAssociationInput
           map_type :attachment, to: Plutonium::Core::Fields::Inputs::AttachmentInput
+          map_type :datetime, :date, :time, to: Plutonium::Core::Fields::Inputs::DateTimeInput
+          map_type :phone, to: Plutonium::Core::Fields::Inputs::PhoneInput
+          # map_type :text, :string, to: Plutonium::Core::Fields::Inputs::SimpleFormInput
 
-          def self.build(name, type:, **)
-            mapping = mappings[type] || Plutonium::Core::Fields::Inputs::SimpleFormInput
-            mapping.new(name, **)
+          def self.build(name, type:, **options)
+            input_type = options[:as] || type
+            mapping = mappings[input_type] || Plutonium::Core::Fields::Inputs::SimpleFormInput
+            mapping.new(name, **options)
           end
 
           def self.for_resource_attribute(resource_class, attr_name, **options)
@@ -24,11 +29,15 @@ module Plutonium
               type = :attachment
               options[:reflection] = attachment
             elsif (association = resource_class.try(:reflect_on_association, attr_name))
-              type = association.macro
+              type = association.polymorphic? ? :"polymorphic_#{association.macro}" : association.macro
               options[:reflection] = association
             elsif (column = resource_class.try(:column_for_attribute, attr_name))
               type = column.type
               options[:multiple] = column.try(:array?) if options[:multiple].nil?
+            elsif (filter = resource_class.try(:filters).try(:[], attr_name))
+              # type = filter.database_column_type
+              options[:hint] ||= filter.desc
+              options[:multiple] = column.try(:array?) if options[:multiple].nil?
             end
 
             build(attr_name, type:, **options)

data/lib/plutonium/core/fields/inputs/noop_input.rb

@@ -6,7 +6,7 @@ module Plutonium
           def initialize(*)
           end
 
-          def render(f, record)
+          def render(f, record, **)
           end
 
           def collect(params)

data/lib/plutonium/core/fields/inputs/phone_input.rb

@@ -0,0 +1,22 @@
+module Plutonium
+  module Core
+    module Fields
+      module Inputs
+        class PhoneInput < SimpleFormInput
+          # def render(f, record, **opts)
+          #   opts = options.deep_merge opts
+          #   opts.delete(:as)
+          #   f.input name, **opts
+          # end
+
+          # def collect(params)
+          #   value = params[param]
+          #   country = user_options[:country]
+          #   country ||= params[user_options[:country_param].to_sym] if user_options[:country_param].present?
+          #   {param => Phonelib.parse(value, country).full_e164}
+          # end
+        end
+      end
+    end
+  end
+end