wallaby-core 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52359ec55f58d6479a497e4d8bb412d2ff4e2a22781abb034721a580d6321a87
-  data.tar.gz: 14009b74724c111574addf3869e4f2bc5b96eae721a40a61c9885773bfb7eb05
+  metadata.gz: b808379fa5d1d1105d40bd2c9f6f960c0c2ebbfab0fffead3c483b1cd07fab4d
+  data.tar.gz: 1cdfde9da6cf530b366fb31a5ed659d9d4175181cb8ec28b6588f686a50a7ece
 SHA512:
-  metadata.gz: 7e772e4457e4892ad725f6d0e65de0854f7cafeaa163c00fb3c4f3c9d88c44e25623bfe5b26fca01454e1bf2facf5d4f904c65a2bdf278ff3a22945679c0054b
-  data.tar.gz: a0a7fa9c558e05e8e62b4570265d4e2d1f063960550bf06148535be0cbb7aa571d416e932419cd0493b209e21c0ab249766de1299105eedbb62e5c3d416e902d
+  metadata.gz: 81f0c8d139ec9975ce47ffb157fb12c273f44c7496c8b071d40e0fed1498226e19ca7ab3254fe2d825b0ed8936a74db1341f2c40d0e3dfa46091880603dbeba2
+  data.tar.gz: fb8f6be411fb84876a7ed7a1f9aa0f5f51341e97a3bdd6d2803c6357c1e8f32bed20d9b11e14bad886f926123d33a65bd49879a572f318b56ddc3a8bb4c897c4

data/app/controllers/wallaby/resources_controller.rb

@@ -1,382 +1,13 @@
 # frozen_string_literal: true
 
 module Wallaby
+  ResourcesController = Class.new configuration.base_controller
+
   # Resources controller, superclass for all customization controllers.
-  # It contains CRUD template action methods (`index`/`new`/`create`/`edit`/`update`/`destroy`)
+  # It contains CRUD template action methods
+  # (`index`/`new`/`create`/`edit`/`update`/`destroy`)
   # that allow subclasses to override.
-  class ResourcesController < ::Wallaby::SecureController
-    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
-
-    self.responder = ResourcesResponder
-    respond_to :html
-    respond_to :json
-    respond_to :csv, only: :index
-    helper ResourcesHelper
-    before_action :authenticate_user!
-
-    # @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
-      # do nothing
-    end
-
-    # @note This is a template method that can be overridden by subclasses.
-    # This is a resourceful action to list records that user can access.
-    #
-    # It can be customized as below 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
-    #   # 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
-    # ```
-    #
-    # 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
-    #   {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
-    def index(options = {}, &block)
-      current_authorizer.authorize :index, current_model_class
-      respond_with collection, options, &block
-    end
-
-    alias index! index
-
-    # @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
-    # ```
-    #
-    # 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
-    #   {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
-    def new(options = {}, &block)
-      current_authorizer.authorize :new, resource
-      respond_with resource, options, &block
-    end
-
-    alias new! new
-
-    # @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.
-    #
-    # If record is created successfully, user will be navigated to the record show page.
-    # Otherwise, the form will be shown again with error messages.
-    #
-    # 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
-    # ```
-    #
-    # 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
-    #   {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})_
-    # @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
-    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 create! create
-
-    # @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
-    # ```
-    #
-    # 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
-    #   {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
-    def show(options = {}, &block)
-      current_authorizer.authorize :show, resource
-      respond_with resource, options, &block
-    end
-
-    alias show! show
-
-    # @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
-    # ```
-    #
-    # 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
-    #   {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
-    def edit(options = {}, &block)
-      current_authorizer.authorize :edit, resource
-      respond_with resource, options, &block
-    end
-
-    alias edit! edit
-
-    # @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.
-    #
-    # If record is updated successfully, user will be navigated to the record show page.
-    # Otherwise, the form will be shown again with error messages.
-    #
-    # 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
-    # ```
-    #
-    # 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
-    #   {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})_
-    # @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
-    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 update! update
-
-    # @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
-    # ```
-    #
-    # 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
-    #   {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})_
-    # @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
-    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 destroy! destroy
-
-    # @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
-    def resource_params
-      @resource_params ||= current_servicer.permit params, action_name
-    end
-
-    # @!method collection(options = {}, &block)
-    #   (see Wallaby::Resourcable#collection)
-    #   @see Wallaby::Resourcable#collection
-    alias collection! collection
-
-    # @!method resource(options = {}, &block)
-    #   (see Wallaby::Resourcable#resource)
-    #   @see Wallaby::Resourcable#resource
-    alias resource! resource
+  class ResourcesController
+    include ResourcesConcern
   end
 end

data/app/security/ability.rb

@@ -4,7 +4,7 @@
 # Defualt ability for wallaby
 # If main app has defined `ability.rb`, this file will not be loaded/used.
 class Ability
-  include ::CanCan::Ability
+  include ::CanCan::Ability if defined?(::CanCan)
 
   # @param _user [Object]
   def initialize(_user)

data/config/locales/wallaby.en.yml

@@ -1,140 +1,104 @@
-# Files in the config/locales directory are used for internationalization
-# and are automatically loaded by Rails. If you want to use locales other
-# than English, add the necessary files in this directory.
-#
-# To use the locales, use `I18n.t`:
-#
-#     I18n.t 'hello'
-#
-# In views, this is aliased to just `t`:
-#
-#     <%= t('hello') %>
-#
-# To use a different locale, set it with `I18n.locale`:
-#
-#     I18n.locale = :es
-#
-# This would use the information in config/locales/es.yml.
-#
-# To learn more, please read the Rails Internationalization guide
-# available at http://guides.rubyonrails.org/i18n.html.
-
 en:
-  labels:
-    count: 'Count: '
-    auto_select_hint: 'Type to select...'
-    upload: 'Upload'
-    empty: 'null'
-    na: 'n/a'
-    edit: 'Edit # %{id}'
-    create: 'Create a %{model}'
+  wallaby:
+    labels:
+      count: 'Count: '
+      auto_select_hint: 'Type to select...'
+      upload: 'Upload'
+      empty: 'null'
+      na: 'n/a'
+      edit: 'Edit # %{id}'
+      create: 'Create a %{model}'
 
-  buttons:
-    save: 'Save'
+    buttons:
+      save: 'Save'
 
-  links:
-    new: 'Create %{model}'
-    show: 'Show'
-    edit: 'Edit'
-    delete: 'Delete'
-    cancel: 'Cancel'
-    confirm:
-      delete: 'Please confirm to delete'
-    export: 'Export as %{ext}'
+    links:
+      new: 'Create %{model}'
+      show: 'Show'
+      edit: 'Edit'
+      delete: 'Delete'
+      cancel: 'Cancel'
+      confirm:
+        delete: 'Please confirm to delete'
+      export: 'Export as %{ext}'
 
-  http_errors:
-    report_error_html: 'And report the error <a href="https://github.com/reinteractive/wallaby/issues/new" target="_blank">here</a>.'
-    not_implemented: 'Not implemented.'
-    internal_server_error: 'Hope you feel better.'
-    bad_request: 'Your request is not supported.'
-    not_found: 'Not found.'
-    unprocessable_entity: 'Your request cannot be processed.'
-    unauthorized: 'You need to sign in to access this page.'
-    forbidden: 'You need permission to access this page.'
+    http_errors:
+      report_error_html: 'And report the error <a href="https://github.com/reinteractive/wallaby/issues/new" target="_blank">here</a>.'
+      not_implemented: 'Not implemented.'
+      internal_server_error: 'Hope you feel better.'
+      bad_request: 'Your request is not supported.'
+      not_found: 'Not found.'
+      unprocessable_entity: 'Your request cannot be processed.'
+      unauthorized: 'You need to sign in to access this page.'
+      forbidden: 'You need permission to access this page.'
 
-  json_errors:
-    not_implemented: 'Not implemented.'
-    internal_server_error: 'Internal server error.'
-    bad_request: 'Your request is not supported.'
-    not_found: 'Not found.'
-    unprocessable_entity: 'Your request cannot be processed.'
-    unauthorized: 'You need to sign in to access this page.'
-    forbidden: 'You need permission to access this page.'
+    json_errors:
+      not_implemented: 'Not implemented.'
+      internal_server_error: 'Internal server error.'
+      bad_request: 'Your request is not supported.'
+      not_found: 'Not found.'
+      unprocessable_entity: 'Your request cannot be processed.'
+      unauthorized: 'You need to sign in to access this page.'
+      forbidden: 'You need permission to access this page.'
 
-  errors:
-    invalid:
-      models: '%{models} are invalid models.'
-      inheritance: '%{klass} does not inherit from %{parent}.'
-      type_required: 'Type is required for %{field_name}.'
-    not_found:
-      collection: 'Records cannot be found. Click + button to add one.'
-      model: 'Model %{model} cannot be found.'
-      resource: 'Record %{resource} cannot be found.'
-    unprocessable_entity:
-      keyword_search: 'Unable to perform keyword search when no text fields can be used.'
-      field_colon_search: 'Unable to perform field colon search for %{invalid_fields}.'
-      model: 'Unable to handle model %{model}.'
-    unauthorized: 'User %{user} is trying to perform %{action} on %{subject}'
-    pundit:
+    errors:
+      invalid:
+        models: '%{models} are invalid models.'
+        inheritance: '%{klass} does not inherit from %{parent}.'
+        type_required: 'Type is required for %{field_name}.'
       not_found:
-        scope_policy: 'Cannot find scope policy for %{scope}.'
-        attributes_for: 'Cannot find attributes for %{subject}.'
-    activerecord:
-      paginatable: '%{collection} is not paginatable.'
-    required: '%{subject} is required.'
-    not_implemented:
-      model_servicer: 'Custom model servicer method `%{method_name}` is not implemented'
-
-  pagination:
-    prev: 'Prev'
-    next: 'Next'
-    from_to: '%{from} to %{to}'
-    of: ' of '
-    total_count: '%{total}'
-    pers: 'Page Size'
-    pages: 'Page Number'
+        collection: 'Records cannot be found. Click + button to add one.'
+        model: 'Model %{model} cannot be found.'
+        resource: 'Record %{resource} cannot be found.'
+      unprocessable_entity:
+        keyword_search: 'Unable to perform keyword search when no text fields can be used.'
+        field_colon_search: 'Unable to perform field colon search for %{invalid_fields}.'
+        model: 'Unable to handle model %{model}.'
+      unauthorized: 'User %{user} is trying to perform %{action} on %{subject}'
+      pundit:
+        not_found:
+          scope_policy: 'Cannot find scope policy for %{scope}.'
+          attributes_for: 'Cannot find attributes for %{subject}.'
+      required: '%{subject} is required.'
+      not_implemented:
+        model_servicer: 'Custom model servicer method `%{method_name}` is not implemented'
 
-  filters:
-    title: 'Filters'
-    all: 'All'
+    pagination:
+      prev: 'Prev'
+      next: 'Next'
+      from_to: '%{from} to %{to}'
+      of: ' of '
+      total_count: '%{total}'
+      pers: 'Page Size'
+      pages: 'Page Number'
 
-  search:
-    hint: 'Press enter to search.'
+    filters:
+      title: 'Filters'
+      all: 'All'
 
-  hints:
-    box_html: 'Format: <code>(x1, y1), (x2, y2)</code> where <i>(x1,y1)</i> and <i>(x2,y2)</i> are any two opposite corners of the box.'
-    cidr_html: 'Example: <code>192.168.1.1/24</code> which holds an IPv4 or IPv6 network specification.'
-    circle_html: 'Format: <code><(x, y), r></code> where <i>(x,y)</i> is the center point and <i>r</i> is the radius of the circle.'
-    hstore_html: 'Format: <code>"Key1" => "Value1", "Key2" => "Value2"</code> is used for input and output, includes zero or more <i>key => value</i> pairs separated by commas.'
-    inet_html: 'Example: <code>192.168.1.1/24</code> which holds an IPv4 or IPv6 network specification.'
-    line_html: 'Format: <code>{ A, B, C }</code> which are represented by the linear equation <i>Ax + By + C = 0</i>.'
-    lseg_html: 'Format: <code>[(x1, y1), (x2, y2)]</code> where <i>(x1,y1)</i> and <i>(x2,y2)</i> are the end points of the line segment.'
-    ltree_html: 'Example: <code>Top.Countries.Europe.Russia</code> which is a sequence of zero or more labels separated by dots.'
-    macaddr_html: 'Example: <code>08:00:2b:01:02:03</code> which stores MAC addresses.'
-    path_html: 'Format: <code>((x1, y1) , ... , (xn, yn))</code> where the points are the end points of the line segments comprising the path.'
-    polygon_html: 'Format: <code>((x1, y1) , ... , (xn, yn))</code> where the points are the end points of the line segments comprising the boundary of the polygon.'
+    search:
+      hint: 'Press enter to search.'
 
-  deprecation:
-    authorizer: "[DEPRECATION] `authorizer` will be removed from 5.3.*. Please use `current_authorizer` instead.\n(called from %{from})"
-    current_model_service: "[DEPRECATION] `current_model_service` will be removed from 5.3.*. Please use `current_servicer` instead.\n(called from %{from})"
-    find_filter_name: "[DEPRECATION] `Wallaby::Utils.find_filter_name` will be removed from 5.3.*. Please use `Wallaby::FilterUtils.filter_name_by` instead.\n(called from %{from})"
-    form_type_partial_render: "[DEPRECATION] `form_type_partial_render` will be removed from 5.3.*. Please use `type_render` instead.\n(called from %{from})"
-    index_params: "[DEPRECATION] `index_params` will be removed from 5.3.*.\n(called from %{from})"
-    paginator_of: "[DEPRECATION] `paginator_of` will be removed from 5.3.*. Please use `current_paginator` instead.\n(called from %{from})"
-    resource_paginator_inheirtance: "[DEPRECATION] `Wallaby::ResourcePaginator` will be removed from 5.3.*. Please inherit from `Wallaby::ModelPaginator` instead.\n(called from %{from})"
-    resource_paginator=: "[DEPRECATION] `resource_paginator=` will be removed from 5.3.*. Please use `model_paginator=` instead.\n(called from %{from})"
-    type_partial_render: "[DEPRECATION] `type_partial_render` will be removed from 5.3.*. Please use `type_render` instead.\n(called from %{from})"
+    hints:
+      box_html: 'Format: <code>(x1, y1), (x2, y2)</code> where <i>(x1,y1)</i> and <i>(x2,y2)</i> are any two opposite corners of the box.'
+      cidr_html: 'Example: <code>192.168.1.1/24</code> which holds an IPv4 or IPv6 network specification.'
+      circle_html: 'Format: <code><(x, y), r></code> where <i>(x,y)</i> is the center point and <i>r</i> is the radius of the circle.'
+      hstore_html: 'Format: <code>"Key1" => "Value1", "Key2" => "Value2"</code> is used for input and output, includes zero or more <i>key => value</i> pairs separated by commas.'
+      inet_html: 'Example: <code>192.168.1.1/24</code> which holds an IPv4 or IPv6 network specification.'
+      line_html: 'Format: <code>{ A, B, C }</code> which are represented by the linear equation <i>Ax + By + C = 0</i>.'
+      lseg_html: 'Format: <code>[(x1, y1), (x2, y2)]</code> where <i>(x1,y1)</i> and <i>(x2,y2)</i> are the end points of the line segment.'
+      ltree_html: 'Example: <code>Top.Countries.Europe.Russia</code> which is a sequence of zero or more labels separated by dots.'
+      macaddr_html: 'Example: <code>08:00:2b:01:02:03</code> which stores MAC addresses.'
+      path_html: 'Format: <code>((x1, y1) , ... , (xn, yn))</code> where the points are the end points of the line segments comprising the path.'
+      polygon_html: 'Format: <code>((x1, y1) , ... , (xn, yn))</code> where the points are the end points of the line segments comprising the boundary of the polygon.'
 
-  fa:
-    # map fa 5's icon name to version 4
-    # @see this fa migration document https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4
-    v4:
-      clock: 'clock-o'
-      bars: 'navicon'
-      calendar: 'calendar-o'
-      check-square: 'check-square-o'
-      square: 'square-o'
-      link: 'chain'
-      user: 'user-o'
-    v5:
-      no-need: 'no-need'
+    deprecation:
+      authorizer: "[DEPRECATION] `authorizer` will be removed from 5.3.*. Please use `current_authorizer` instead.\n(called from %{from})"
+      current_model_service: "[DEPRECATION] `current_model_service` will be removed from 5.3.*. Please use `current_servicer` instead.\n(called from %{from})"
+      find_filter_name: "[DEPRECATION] `Wallaby::Utils.find_filter_name` will be removed from 5.3.*. Please use `Wallaby::FilterUtils.filter_name_by` instead.\n(called from %{from})"
+      form_type_partial_render: "[DEPRECATION] `form_type_partial_render` will be removed from 5.3.*. Please use `type_render` instead.\n(called from %{from})"
+      index_params: "[DEPRECATION] `index_params` will be removed from 5.3.*.\n(called from %{from})"
+      paginator_of: "[DEPRECATION] `paginator_of` will be removed from 5.3.*. Please use `current_paginator` instead.\n(called from %{from})"
+      resource_paginator_inheirtance: "[DEPRECATION] `Wallaby::ResourcePaginator` will be removed from 5.3.*. Please inherit from `Wallaby::ModelPaginator` instead.\n(called from %{from})"
+      resource_paginator=: "[DEPRECATION] `resource_paginator=` will be removed from 5.3.*. Please use `model_paginator=` instead.\n(called from %{from})"
+      type_partial_render: "[DEPRECATION] `type_partial_render` will be removed from 5.3.*. Please use `type_render` instead.\n(called from %{from})"