plutonium 0.10.3 → 0.11.1

data/lib/plutonium/railtie.rb

@@ -6,27 +6,45 @@ module Plutonium
     config.plutonium.cache_discovery = defined?(Rails.env) && !Rails.env.development?
     config.plutonium.enable_hotreload = defined?(Rails.env) && Rails.env.development?
 
-    initializer "plutonium.append_assets_path" do |app|
-      config.to_prepare do
-        Rails.application.config.assets.paths << Plutonium.root.join("app/assets/build").to_s
-      end
+    config.plutonium.assets = ActiveSupport::OrderedOptions.new
+    config.plutonium.assets.logo = "plutonium.png"
+    config.plutonium.assets.favicon = "plutonium.ico"
+    config.plutonium.assets.stylesheet = "plutonium.css"
+    config.plutonium.assets.script = "plutonium.min.js"
+
+    # If you don't want to precompile Plutonium's assets (eg. because you're using webpack),
+    # you can do this in an intiailzer:
+    #
+    # config.after_initialize do
+    #   config.assets.precompile -= Plutonium::Railtie::PRECOMPILE_ASSETS
+    # end
+    PRECOMPILE_ASSETS = %w[plutonium.js plutonium.js.map plutonium.min.js plutonium.min.js.map plutonium.css]
+
+    initializer "plutonium.assets" do
+      next unless Rails.application.config.respond_to?(:assets)
+
+      Rails.application.config.assets.precompile += PRECOMPILE_ASSETS
+      Rails.application.config.assets.paths << Plutonium.root.join("app/assets").to_s
     end
 
-    initializer "plutonium.load_view_components" do
+    initializer "plutonium.load_components" do
       load Plutonium.root.join("app", "views", "components", "base.rb")
     end
 
-    initializer "plutonium.load_initializers" do
+    initializer "plutonium.initializers" do
       Dir.glob(Plutonium.root.join("config", "initializers", "**", "*.rb")) { |file| load file }
     end
 
     initializer "plutonium.asset_server" do
+      next unless Plutonium.development?
+
+      puts "=> [plutonium] starting assets server"
       # setup a middleware to serve our assets
       config.app_middleware.insert_before(
         ActionDispatch::Static,
         Rack::Static,
-        urls: ["/plutonium-assets"],
-        root: Plutonium.root.join("public"),
+        urls: ["/build"],
+        root: Plutonium.root.join("src").to_s,
         cascade: true,
         header_rules: [
           # Cache all static files in public caches (e.g. Rack::Cache) as well as in the browser

data/lib/plutonium/reloader.rb

@@ -1,5 +1,6 @@
+require "active_support/notifications"
+
 # Be sure to restart your server when you modify this file.
-# This is a glorified initializer
 
 module Plutonium
   class Reloader
@@ -7,8 +8,11 @@ module Plutonium
       def start!
         puts "=> [plutonium] starting reloader"
 
-        @listener&.stop
-        @listener = initialize_listener
+        ActiveSupport::Notifications.instrument("plutonium.reloader.start") do
+          # Task code here
+          @listener&.stop
+          @listener = initialize_listener
+        end
       end
 
       private
@@ -75,16 +79,23 @@ module Plutonium
       end
 
       def reload_engine_and_routes(file)
-        Plutonium.logger.debug "[plutonium] reloading #{file}"
+        Plutonium.logger.debug "[plutonium] reloading: engine+routes"
         load file
         Rails.application.reload_routes!
       end
 
       def reload_framework_and_file(file)
-        Plutonium.logger.debug "[plutonium] reloading framework"
+        # # Ensure that the file loads correctly before we do any reloading
+        # load file
+
+        Plutonium.logger.debug "[plutonium] reloading: app+framework"
+        Rails.application.reloader.reload!
         Plutonium::ZEITWERK_LOADER.reload
+        # reload components
+        Object.send(:remove_const, "PlutoniumUi")
         load Plutonium.root.join("app", "views", "components", "base.rb")
-        load file # Ensure files that do not contain constants are loaded
+        # # Ensure files that do not contain constants are loaded again e.g. initializers
+        # load file
       end
 
       def reload_file(file)
@@ -92,7 +103,7 @@ module Plutonium
       end
 
       def log_reload_failure(file, error)
-        Plutonium.logger.error "\n[plutonium] reload failed #{file}\n\n#{error}\n"
+        Plutonium.logger.error "\n[plutonium] reloading failed\n\n#{error.message}\n"
       end
     end
   end

data/lib/plutonium/resource/controller.rb

@@ -95,6 +95,8 @@ module Plutonium
       def resource_presenter(resource_class, resource_record)
         presenter_class = "#{current_package}::#{resource_class}Presenter".constantize
         presenter_class.new resource_context, resource_record
+      rescue NameError
+        super(resource_class, resource_record)
       end
 
       # Creates a resource query object
@@ -104,6 +106,8 @@ module Plutonium
       def resource_query_object(resource_class, params)
         query_object_class = "#{current_package}::#{resource_class}QueryObject".constantize
         query_object_class.new resource_context, params
+      rescue NameError
+        super(resource_class, params)
       end
 
       # Applies submitted resource params if they have been passed

data/lib/plutonium/resource/policy.rb

@@ -1,14 +1,18 @@
 module Plutonium
   module Resource
-    # Policy class to define permissions and attributes for a 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
 
+      # Scope class to define the scope of the policy.
       class Scope < Plutonium::Policy::Scope
       end
 
-      # Sends a method and raises an error if the method is not implemented
-      # @param [Symbol] method The method to send
+      # Sends a method and raises an error if the method is not implemented.
+      #
+      # @param method [Symbol] The method to send.
       def send_with_report(method)
         unless respond_to?(method)
           raise NotImplementedError, "#{self.class.name} does not implement the required #{method}"
@@ -19,66 +23,76 @@ module Plutonium
 
       # Core actions
 
-      # Checks if the create action is permitted
-      # @return [Boolean]
+      # Checks if the create action is permitted.
+      #
+      # @return [Boolean] false by default.
       def create?
         false
       end
 
-      # Checks if the read action is permitted
-      # @return [Boolean]
+      # Checks if the read action is permitted.
+      #
+      # @return [Boolean] false by default.
       def read?
         false
       end
 
-      # Checks if the update action is permitted
-      # @return [Boolean]
+      # Checks if the update action is permitted.
+      #
+      # @return [Boolean] Delegates to create?.
       def update?
         create?
       end
 
-      # Checks if the destroy action is permitted
-      # @return [Boolean]
+      # Checks if the destroy action is permitted.
+      #
+      # @return [Boolean] Delegates to create?.
       def destroy?
         create?
       end
 
       # Inferred actions
 
-      # Checks if the index action is permitted
-      # @return [Boolean]
+      # Checks if the index action is permitted.
+      #
+      # @return [Boolean] Delegates to read?.
       def index?
         read?
       end
 
-      # Checks if the new action is permitted
-      # @return [Boolean]
+      # Checks if the new action is permitted.
+      #
+      # @return [Boolean] Delegates to create?.
       def new?
         create?
       end
 
-      # Checks if the show action is permitted
-      # @return [Boolean]
+      # Checks if the show action is permitted.
+      #
+      # @return [Boolean] Delegates to read?.
       def show?
         read?
       end
 
-      # Checks if the edit action is permitted
-      # @return [Boolean]
+      # Checks if the edit action is permitted.
+      #
+      # @return [Boolean] Delegates to update?.
       def edit?
         update?
       end
 
-      # Checks if the search action is permitted
-      # @return [Boolean]
+      # Checks if the search action is permitted.
+      #
+      # @return [Boolean] Delegates to index?.
       def search?
         index?
       end
 
       # Core attributes
 
-      # Returns the permitted attributes for the create action
-      # @return [Array<Symbol>]
+      # Returns the permitted attributes for the create action.
+      #
+      # @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
@@ -86,64 +100,72 @@ module Plutonium
         ]
       end
 
-      # Returns the permitted attributes for the read action
-      # @return [Array<Symbol>]
+      # Returns the permitted attributes for the read action.
+      #
+      # @return [Array<Symbol>] The permitted attributes.
       def permitted_attributes_for_read
         autodetect_permitted_fields(:permitted_attributes_for_read)
       end
 
-      # Returns the permitted attributes for the update action
-      # @return [Array<Symbol>]
+      # Returns the permitted attributes for the update action.
+      #
+      # @return [Array<Symbol>] Delegates to permitted_attributes_for_create.
       def permitted_attributes_for_update
         permitted_attributes_for_create
       end
 
       # Inferred attributes
 
-      # Returns the permitted attributes for the index action
-      # @return [Array<Symbol>]
+      # Returns the permitted attributes for the index action.
+      #
+      # @return [Array<Symbol>] Delegates to permitted_attributes_for_read.
       def permitted_attributes_for_index
         permitted_attributes_for_read
       end
 
-      # Returns the permitted attributes for the show action
-      # @return [Array<Symbol>]
+      # Returns the permitted attributes for the show action.
+      #
+      # @return [Array<Symbol>] Delegates to permitted_attributes_for_read.
       def permitted_attributes_for_show
         permitted_attributes_for_read
       end
 
-      # Returns the permitted attributes for the new action
-      # @return [Array<Symbol>]
+      # Returns the permitted attributes for the new action.
+      #
+      # @return [Array<Symbol>] Delegates to permitted_attributes_for_create.
       def permitted_attributes_for_new
         permitted_attributes_for_create
       end
 
-      # Returns the permitted attributes for the edit action
-      # @return [Array<Symbol>]
+      # Returns the permitted attributes for the edit action.
+      #
+      # @return [Array<Symbol>] Delegates to permitted_attributes_for_update.
       def permitted_attributes_for_edit
         permitted_attributes_for_update
       end
 
-      # # Returns the permitted associations
-      # # @return [Array<Symbol>]
-      # def permitted_associations
-      #   []
-      # end
+      # Returns the permitted associations.
+      #
+      # @return [Array<Symbol>] An empty array by default.
+      def permitted_associations
+        []
+      end
 
       private
 
-      # Autodetects the permitted fields for a given method
-      # @param [Symbol] method_name The name of the method
-      # @return [Array<Symbol>]
+      # 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
       end
 
-      # Warns about the usage of auto-detection of fields
-      # @param [Symbol] method The method name
-      # @raise [RuntimeError] if not in development environment
+      # Warns about the usage of auto-detection of fields.
+      #
+      # @param method [Symbol] The method name.
+      # @raise [RuntimeError] if not in the development environment.
       def warn_about_autodetect_usage(method)
         unless Rails.env.development?
           raise "Resource field auto-detection: #{self.class}##{method} outside development"

data/lib/plutonium/resource/presenter.rb

@@ -5,6 +5,7 @@ module Plutonium
     class Presenter
       include Plutonium::Core::Definers::FieldDefiner
       include Plutonium::Core::Definers::ActionDefiner
+      include Plutonium::Core::Definers::AssociationRendererDefiner
 
       # Initializes the presenter with context and resource record
       # @param [Object] context The context in which the presenter is used