wallaby-core 0.2.11 → 0.3.0.beta1

data/lib/concerns/wallaby/resources_concern.rb

@@ -1,53 +1,59 @@
 # frozen_string_literal: true
 
 module Wallaby
-  # Resources concern
+  # Resources concern defining the controller behaviors
+  # for {ResourcesController} and other controllers that include itself
   module ResourcesConcern
     extend ActiveSupport::Concern
 
-    # @!parse
-    #   include ApplicationConcern
-    #   include AuthenticationConcern
-    #   extend Authorizable::ClassMethods
-    #   extend Baseable::ClassMethods
-    #   extend Decoratable::ClassMethods
-    #   extend Paginatable::ClassMethods
-    #   extend Resourcable::ClassMethods
-    #   extend Servicable::ClassMethods
-    #
-    #   include View
-    #   prepend Prefixable
-    #
-    #   include Authorizable
-    #   include Decoratable
-    #   include Defaultable
-    #   include Paginatable
-    #   include Resourcable
-    #   include Servicable
-    #
-    #   alias index! index
-    #   alias new! new
-    #   alias create! create
-    #   alias show! show
-    #   alias edit! edit
-    #   alias update! update
-    #   alias destroy! destroy
-    #   alias collection! collection
-    #   alias resource! resource
+    include Authorizable
+    include Baseable
+    include Configurable
+    include Decoratable
+    include Prefixable
+    include Paginatable
+    include Resourcable
+    include Servicable
+
+    included do
+      include View
+      alias_method :_prefixes, :wallaby_prefixes
+
+      include ApplicationConcern
+      include AuthenticationConcern
+
+      base_class! if self == ResourcesController
+
+      # NOTE: to ensure Wallaby's layout
+      # is not inheriting from/impacted by parent controller's layout.
+      if respond_to?(:layout)
+        try(
+          # inherit? or include?
+          self == ResourcesController ? :layout : :theme_name=,
+          ResourcesController.controller_path
+        )
+      end
+
+      self.responder = ResourcesResponder
+      respond_to :html
+      respond_to :json
+      respond_to :csv
+      try :helper, ResourcesHelper
+      before_action :authenticate_wallaby_user!
+    end
 
-    # @!method home
     # @note This is a template method that can be overridden by subclasses.
     # This is an action for landing page display. It does nothing more than rendering `home` template.
     #
     # It can be replaced completely in subclasses as below:
     #
-    # ```
-    # def home
-    #   generate_dashboard_report
-    # end
-    # ```
+    #     def home
+    #       generate_dashboard_report
+    #     end
+    def home
+      # do nothing
+    end
 
-    # @!method index(options = {}, &block)
     # @note This is a template method that can be overridden by subclasses.
     # This is a resourceful action to list records that user can access.
     #
@@ -56,73 +62,75 @@ module Wallaby
     # `WARN: Please keep in mind that Wallaby User Interface requires **index**
     # action to respond to **csv** and **json** format as well.`
     #
-    # ```
-    # def index
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   index!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
+    #     def index
+    #       # do something before the original action
+    #       responder_options = {} # NOTE: see `responder_options` parameter for more details
+    #       # NOTE: this is better than using `super` in many ways, but choose the one that better fits your scenario
+    #       index!(responder_options) do |format|
+    #         # NOTE: this block is for `respond_with` which works similar to `respond_to`
+    #         # customize response behaviour, or do something before the request is rendered
+    #       end
+    #     end
     #
     # Otherwise, it can be replaced completely in subclasses:
     #
     # `WARN: Please keep in mind that Wallaby User Interface requires **index**
     # action to respond to **csv** and **json** format as well.`
     #
-    # ```
-    # def index
-    #   # NOTE: `@collection` will be used by the view, please ensure it is assigned, for example:
-    #   @collection = Product.all
-    #   respond_with @collection
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
+    #     def index
+    #       # NOTE: `@collection` will be used by the view, please ensure it is assigned, for example:
+    #       @collection = Product.all
+    #       respond_with @collection
+    #     end
+    # @param responder_options [Hash] (since wallaby-5.2.0) responder_options for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
     #   respond_with}
     # @yield [format] block for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
     #   respond_with}
     #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
+    # @raise [Forbidden] if user has no access
+    def index(**responder_options, &block)
+      current_authorizer.authorize :index, current_model_class
+      respond_with collection, responder_options, &block
+    end
+    alias_method :index!, :index
 
-    # @!method new(options = {}, &block)
     # @note This is a template method that can be overridden by subclasses.
     # This is a resourceful action to show the form to create record that user is allowed to.
     #
     # It can be customized as below in subclasses:
     #
-    # ```
-    # def new
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   new!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
+    #     def new
+    #       # do something before the original action
+    #       responder_options = {} # NOTE: see `responder_options` parameter for more details
+    #       # NOTE: this is better than using `super` in many ways, but choose the one that better fits your scenario
+    #       new!(responder_options) do |format|
+    #         # NOTE: this block is for `respond_with` which works similar to `respond_to`
+    #         # customize response behaviour, or do something before the request is rendered
+    #       end
+    #     end
     #
     # Otherwise, it can be replaced completely in subclasses:
     #
-    # ```
-    # def new
-    #   # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
-    #   @resource = Product.new new_arrival: true
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
+    #     def new
+    #       # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
+    #       @resource = Product.new new_arrival: true
+    #     end
+    # @param responder_options [Hash] (since wallaby-5.2.0) responder_options for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
     #   respond_with}
     # @yield [format] block for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
     #   respond_with}
     #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
+    # @raise [Forbidden] if user has no access
+    def new(**responder_options, &block)
+      current_authorizer.authorize :new, new_resource
+      respond_with new_resource, responder_options, &block
+    end
+    alias_method :new!, :new
 
-    # @!method create(options = {}, &block)
     # @note This is a template method that can be overridden by subclasses.
     # This is a resourceful action to create a record that user is allowed to.
     #
@@ -131,110 +139,113 @@ module Wallaby
     #
     # It can be customized as below in subclasses:
     #
-    # ```
-    # def create
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   create!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
+    #     def create
+    #       # do something before the original action
+    #       responder_options = {} # NOTE: see `responder_options` parameter for more details
+    #       # NOTE: this is better than using `super` in many ways, but choose the one that better fits your scenario
+    #       create!(responder_options) do |format|
+    #         # NOTE: this block is for `respond_with` which works similar to `respond_to`
+    #         # customize response behaviour, or do something before the request is rendered
+    #       end
+    #     end
     #
     # Otherwise, it can be replaced completely in subclasses:
     #
-    # ```
-    # def create
-    #   # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
-    #   @resource = Product.new resource_params.merge(new_arrival: true)
-    #   if @resource.save
-    #     redirect_to helper.index_path(current_model_class)
-    #   else
-    #     render :new
-    #   end
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
+    #     def create
+    #       # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
+    #       @resource = Product.new resource_params.merge(new_arrival: true)
+    #       if @resource.save
+    #         redirect_to helper.index_path(current_model_class)
+    #       else
+    #         render :new
+    #       end
+    #     end
+    # @param location [Proc, String] (since 0.3.0) location for responder_options
+    # @param responder_options [Hash] (since wallaby-5.2.0) responder_options for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}. In addition, options `:params` is supported, see below
-    # @option options [ActionController::Parameters, Hash] :params
-    #   permitted parameters for servicer to create the record. _(defaults to: {#resource_params})_
+    #   respond_with}
     # @yield [format] block for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
     #   respond_with}
     #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
+    # @raise [Forbidden] if user has no access
+    def create(location: -> { { action: :show, id: new_resource.id } }, **responder_options, &block)
+      current_authorizer.authorize :create, new_resource
+      current_servicer.create new_resource, create_params
+      respond_with new_resource, responder_options.merge(location: location), &block
+    end
+    alias_method :create!, :create
 
-    # @!method show(options = {}, &block)
     # @note This is a template method that can be overridden by subclasses.
     # This is a resourceful action to display the record details that user is allowed to.
     #
     # It can be customized as below in subclasses:
     #
-    # ```
-    # def show
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   show!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
+    #     def show
+    #       # do something before the original action
+    #       responder_options = {} # NOTE: see `responder_options` parameter for more details
+    #       # NOTE: this is better than using `super` in many ways, but choose the one that better fits your scenario
+    #       show!(responder_options) do |format|
+    #         # NOTE: this block is for `respond_with` which works similar to `respond_to`
+    #         # customize response behaviour, or do something before the request is rendered
+    #       end
+    #     end
     #
     # Otherwise, it can be replaced completely in subclasses:
     #
-    # ```
-    # def show
-    #   # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
-    #   @resource = Product.find_by_slug params[:id]
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
+    #     def show
+    #       # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
+    #       @resource = Product.find_by_slug params[:id]
+    #     end
+    # @param responder_options [Hash] (since wallaby-5.2.0) responder_options for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
     #   respond_with}
     # @yield [format] block for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
     #   respond_with}
     #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
+    # @raise [Forbidden] if user has no access
+    def show(**responder_options, &block)
+      current_authorizer.authorize :show, resource
+      respond_with resource, responder_options, &block
+    end
+    alias_method :show!, :show
 
-    # @!method edit(options = {}, &block)
     # @note This is a template method that can be overridden by subclasses.
     # This is a resourceful action to show the form to edit record that user is allowed to.
     #
     # It can be customized as below in subclasses:
     #
-    # ```
-    # def edit
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   edit!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
+    #     def edit
+    #       # do something before the original action
+    #       responder_options = {} # NOTE: see `responder_options` parameter for more details
+    #       # NOTE: this is better than using `super` in many ways, but choose the one that better fits your scenario
+    #       edit!(responder_options) do |format|
+    #         # NOTE: this block is for `respond_with` which works similar to `respond_to`
+    #         # customize response behaviour, or do something before the request is rendered
+    #       end
+    #     end
     #
     # Otherwise, it can be replaced completely in subclasses:
     #
-    # ```
-    # def edit
-    #   # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
-    #   @resource = Product.find_by_slug params[:id]
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
+    #     def edit
+    #       # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
+    #       @resource = Product.find_by_slug params[:id]
+    #     end
+    # @param responder_options [Hash] (since wallaby-5.2.0) responder_options for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
     #   respond_with}
     # @yield [format] block for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
     #   respond_with}
     #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
+    # @raise [Forbidden] if user has no access
+    def edit(**responder_options, &block)
+      current_authorizer.authorize :edit, resource
+      respond_with resource, responder_options, &block
+    end
+    alias_method :edit!, :edit
 
-    # @!method update(options = {}, &block)
     # @note This is a template method that can be overridden by subclasses.
     # This is a resourceful action to update the record that user is allowed to.
     #
@@ -243,192 +254,81 @@ module Wallaby
     #
     # It can be customized as below in subclasses:
     #
-    # ```
-    # def update
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   update!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
+    #     def update
+    #       # do something before the original action
+    #       responder_options = {} # NOTE: see `responder_options` parameter for more details
+    #       # NOTE: this is better than using `super` in many ways, but choose the one that better fits your scenario
+    #       update!(responder_options) do |format|
+    #         # NOTE: this block is for `respond_with` which works similar to `respond_to`
+    #         # customize response behaviour, or do something before the request is rendered
+    #       end
+    #     end
     #
     # Otherwise, it can be replaced completely in subclasses:
     #
-    # ```
-    # def update
-    #   # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
-    #   @resource = Product.find_by_slug params[:id]
-    #   @resource.assign_attributes resource_params.merge(new_arrival: true)
-    #   if @resource.save
-    #     redirect_to helper.index_path(current_model_class)
-    #   else
-    #     render :new
-    #   end
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
+    #     def update
+    #       # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
+    #       @resource = Product.find_by_slug params[:id]
+    #       @resource.assign_attributes resource_params.merge(new_arrival: true)
+    #       if @resource.save
+    #         redirect_to helper.index_path(current_model_class)
+    #       else
+    #         render :new
+    #       end
+    #     end
+    # @param location [Proc, String] (since 0.3.0) location for responder_options
+    # @param responder_options [Hash] (since wallaby-5.2.0) responder_options for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}. In addition, options `:params` is supported, see below
-    # @option options [ActionController::Parameters, Hash] :params
-    #   permitted parameters for servicer to update the record. _(defaults to: {#resource_params})_
+    #   respond_with}
     # @yield [format] block for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
     #   respond_with}
     #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
+    # @raise [Forbidden] if user has no access
+    def update(location: -> { { action: :show } }, **responder_options, &block)
+      current_authorizer.authorize :update, resource
+      current_servicer.update resource, update_params
+      respond_with resource, responder_options.merge(location: location), &block
+    end
+    alias_method :update!, :update
 
-    # @!method destroy(options = {}, &block)
     # @note This is a template method that can be overridden by subclasses.
     # This is a resourceful action to delete the record that user is allowed to.
     #
     # It can be customized as below in subclasses:
     #
-    # ```
-    # def destroy
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   destroy!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
+    #     def destroy
+    #       # do something before the original action
+    #       responder_options = {} # NOTE: see `responder_options` parameter for more details
+    #       # NOTE: this is better than using `super` in many ways, but choose the one that better fits your scenario
+    #       destroy!(responder_options) do |format|
+    #         # NOTE: this block is for `respond_with` which works similar to `respond_to`
+    #         # customize response behaviour, or do something before the request is rendered
+    #       end
+    #     end
     #
     # Otherwise, it can be replaced completely in subclasses:
     #
-    # ```
-    # def destroy
-    #   # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
-    #   @resource = Product.find_by_slug params[:id]
-    #   @resource.destroy
-    #   redirect_to helper.index_path(current_model_class)
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
+    #     def destroy
+    #       # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
+    #       @resource = Product.find_by_slug params[:id]
+    #       @resource.destroy
+    #       redirect_to helper.index_path(current_model_class)
+    #     end
+    # @param location [Proc, String] (since 0.3.0) location for responder_options
+    # @param responder_options [Hash] (since wallaby-5.2.0) responder_options for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}. In addition, options `:params` is supported, see below
-    # @option options [ActionController::Parameters, Hash] :params
-    #   permitted parameters for servicer to destroy the record. _(defaults to: {#resource_params})_
+    #   respond_with}
     # @yield [format] block for
     #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
     #   respond_with}
     #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
-
-    # @!method resource_params
-    # @note This is a template method that can be overridden by subclasses.
-    # To whitelist the params for {#create} and {#update} actions.
-    #
-    # If Wallaby cannot generate the correct strong parameters, it can be replaced, for example:
-    #
-    # ```
-    # def resource_params
-    #   params.fetch(:product, {}).permit(:name, :sku)
-    # end
-    # ```
-    # @return [ActionController::Parameters] whitelisted params
-
-    included do # rubocop:disable Metrics/BlockLength
-      include ApplicationConcern
-      include AuthenticationConcern
-
-      extend Authorizable::ClassMethods
-      extend Baseable::ClassMethods
-      extend Decoratable::ClassMethods
-      extend Paginatable::ClassMethods
-      extend Servicable::ClassMethods
-
-      include View
-      prepend Prefixable
-
-      include Authorizable
-      include Decoratable
-      include Defaultable
-      include Paginatable
-      include Resourcable
-      include Servicable
-
-      base_class!
-
-      # NOTE: to ensure Wallaby's layout
-      # is not inheriting from/impacted by parent controller's layout.
-      public_send(
-        # inherit? or include?
-        self == ResourcesController ? :layout : :theme_name=,
-        ResourcesController.controller_path
-      )
-
-      self.responder = ResourcesResponder
-      respond_to :html
-      respond_to :json
-      respond_to :csv
-      helper ResourcesHelper
-      before_action :authenticate_wallaby_user!
-
-      def home
-        # do nothing
-      end
-
-      def index(options = {}, &block)
-        current_authorizer.authorize :index, current_model_class
-        respond_with collection, options, &block
-      end
-
-      alias_method :index!, :index
-
-      def new(options = {}, &block)
-        current_authorizer.authorize :new, resource
-        respond_with resource, options, &block
-      end
-
-      alias_method :new!, :new
-
-      def create(options = {}, &block)
-        set_defaults_for :create, options
-        current_authorizer.authorize :create, resource
-        current_servicer.create resource, options.delete(:params)
-        respond_with resource, options, &block
-      end
-
-      alias_method :create!, :create
-
-      def show(options = {}, &block)
-        current_authorizer.authorize :show, resource
-        respond_with resource, options, &block
-      end
-
-      alias_method :show!, :show
-
-      def edit(options = {}, &block)
-        current_authorizer.authorize :edit, resource
-        respond_with resource, options, &block
-      end
-
-      alias_method :edit!, :edit
-
-      def update(options = {}, &block)
-        set_defaults_for :update, options
-        current_authorizer.authorize :update, resource
-        current_servicer.update resource, options.delete(:params)
-        respond_with resource, options, &block
-      end
-
-      alias_method :update!, :update
-
-      def destroy(options = {}, &block)
-        set_defaults_for :destroy, options
-        current_authorizer.authorize :destroy, resource
-        current_servicer.destroy resource, options.delete(:params)
-        respond_with resource, options, &block
-      end
-
-      alias_method :destroy!, :destroy
-
-      def resource_params
-        @resource_params ||= current_servicer.permit params, action_name
-      end
+    # @raise [Forbidden] if user has no access
+    def destroy(location: -> { { action: resource_id ? :index : :show } }, **responder_options, &block)
+      current_authorizer.authorize :destroy, resource
+      current_servicer.destroy resource, {}
+      respond_with resource, responder_options.merge(location: location), &block
     end
+    alias_method :destroy!, :destroy
   end
 end