plutonium 0.10.2 → 0.11.0

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