wallaby-core 0.2.1 → 0.2.2

data/lib/concerns/wallaby/engineable.rb

@@ -17,7 +17,7 @@ module Wallaby
       #     self.engine_name = 'admin_engine'
       #   end
       # @return [String, Symbol, nil] engine name
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       def engine_name
         @engine_name ||= ModuleUtils.try_to superclass, :engine_name
       end

data/lib/concerns/wallaby/fieldable.rb

@@ -18,7 +18,7 @@ module Wallaby
     # @param field_name [String, Symbol] field name
     # @return [String, Symbol] type for a given field
     def type_of(field_name)
-      validate_presence_of field_name, metadata_of(field_name)[:type]
+      ensure_type_is_present field_name, metadata_of(field_name)[:type]
     end
 
     # @param field_name [String, Symbol] field name
@@ -36,7 +36,7 @@ module Wallaby
     # @param field_name [String, Symbol] field name
     # @return [String, Symbol] index type for a given field
     def index_type_of(field_name)
-      validate_presence_of field_name, index_metadata_of(field_name)[:type]
+      ensure_type_is_present field_name, index_metadata_of(field_name)[:type], 'index_'
     end
 
     # @param field_name [String, Symbol] field name
@@ -54,7 +54,7 @@ module Wallaby
     # @param field_name [String, Symbol] field name
     # @return [String, Symbol] show type for a given field
     def show_type_of(field_name)
-      validate_presence_of field_name, show_metadata_of(field_name)[:type]
+      ensure_type_is_present field_name, show_metadata_of(field_name)[:type], 'show_'
     end
 
     # @param field_name [String, Symbol] field name
@@ -72,7 +72,7 @@ module Wallaby
     # @param field_name [String, Symbol] field name
     # @return [String, Symbol] form type for a given field
     def form_type_of(field_name)
-      validate_presence_of field_name, form_metadata_of(field_name)[:type]
+      ensure_type_is_present field_name, form_metadata_of(field_name)[:type], 'form_'
     end
   end
 end

data/lib/concerns/wallaby/paginatable.rb

@@ -20,7 +20,7 @@ module Wallaby
       # @return [Class] model paginator
       # @raise [ArgumentError] when **model_paginator** doesn't inherit from **application_paginator**
       # @see Wallaby::ModelPaginator
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       attr_reader :model_paginator
 
       # @!attribute [w] application_paginator
@@ -38,7 +38,7 @@ module Wallaby
       # @return [Class] application decorator
       # @raise [ArgumentError] when **model_paginator** doesn't inherit from **application_paginator**
       # @see Wallaby::ModelPaginator
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       def application_paginator
         @application_paginator ||= ModuleUtils.try_to superclass, :application_paginator
       end
@@ -53,7 +53,7 @@ module Wallaby
       @current_paginator ||=
         (controller_to_get(:model_paginator) \
           || Map.paginator_map(current_model_class, controller_to_get(:application_paginator))).try do |klass|
-          Logger.debug %(Current paginator: #{klass})
+          Logger.debug %(Current paginator: #{klass}), sourcing: false
           klass.new current_model_class, collection, params
         end
     end

data/lib/concerns/wallaby/resourcable.rb

@@ -3,41 +3,6 @@
 module Wallaby
   # Resources related attributes
   module Resourcable
-    # Configurable attribute
-    module ClassMethods
-      # @!attribute [w] model_class
-      attr_writer :model_class
-
-      # @!attribute [r] model_class
-      # This attribute will be used by the dynamic router to find out which
-      # controller to dispatch to. For example:
-      #
-      # `/admin/products` will be dispatched to the controller that has the
-      # model class `Product`.
-      # @return [Class] the model class for controller.
-      # @example It can be customized as below:
-      #   ```
-      #   self.model_class = Product
-      #   ```
-      #   Or
-      #   ```
-      #   def self.model_class; Product; end
-      #   ```
-      # @example To set model paginator
-      #   class Admin::ProductionsController < Admin::ApplicationController
-      #     self.model_class = ProductResources
-      #   end
-      # @return [Class] model paginator
-      # @raise [ArgumentError] when **model_class** doesn't inherit from **application_paginator**
-      # @see Wallaby::ModelResources
-      def model_class
-        return unless self < ResourcesController
-        return if base_class? || self == Wallaby.configuration.mapping.resources_controller
-
-        @model_class ||= Map.model_class_map(name.gsub(/(^#{namespace}::)|(Controller$)/, EMPTY_STRING))
-      end
-    end
-
     # @return [String] resources name for current request
     def current_resources_name
       @current_resources_name ||= params[:resources]

data/lib/concerns/wallaby/resources_concern.rb

@@ -338,7 +338,6 @@ module Wallaby
       extend Baseable::ClassMethods
       extend Decoratable::ClassMethods
       extend Paginatable::ClassMethods
-      extend Resourcable::ClassMethods
       extend Servicable::ClassMethods
 
       include View
@@ -351,6 +350,8 @@ module Wallaby
       include Resourcable
       include Servicable
 
+      base_class!
+
       # NOTE: to ensure Wallaby's layout
       # is not inheriting from/impacted by parent controller's layout.
       public_send(
@@ -364,7 +365,7 @@ module Wallaby
       respond_to :json
       respond_to :csv
       helper ResourcesHelper
-      before_action :authenticate_user!
+      before_action :authenticate_wallaby_user!
 
       def home
         # do nothing

data/lib/concerns/wallaby/servicable.rb

@@ -20,7 +20,7 @@ module Wallaby
       # @return [Class] model servicer
       # @raise [ArgumentError] when **model_servicer** doesn't inherit from **application_servicer**
       # @see Wallaby::ModelServicer
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       attr_reader :model_servicer
 
       # @!attribute [w] application_servicer
@@ -38,7 +38,7 @@ module Wallaby
       # @return [Class] application decorator
       # @raise [ArgumentError] when **model_servicer** doesn't inherit from **application_servicer**
       # @see Wallaby::ModelServicer
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       def application_servicer
         @application_servicer ||= ModuleUtils.try_to superclass, :application_servicer
       end
@@ -49,12 +49,12 @@ module Wallaby
     # - controller configuration {Wallaby::Servicable::ClassMethods#model_servicer .model_servicer}
     # - a generic servicer based on {Wallaby::Servicable::ClassMethods#application_servicer .application_servicer}
     # @return [Wallaby::ModelServicer] model servicer
-    # @since 5.2.0
+    # @since wallaby-5.2.0
     def current_servicer
       @current_servicer ||=
         (controller_to_get(:model_servicer) \
           || Map.servicer_map(current_model_class, controller_to_get(:application_servicer))).try do |klass|
-          Logger.debug %(Current servicer: #{klass})
+          Logger.debug %(Current servicer: #{klass}), sourcing: false
           klass.new current_model_class, current_authorizer, current_model_decorator
         end
     end

data/lib/decorators/wallaby/resource_decorator.rb

@@ -1,10 +1,53 @@
 # frozen_string_literal: true
 
 module Wallaby
-  # Resource Decorator base class, designed for decorator pattern.
-  # @see Wallaby::ModelDecorator
+  # Decorator base class. It's designed to be used as the decorator (AKA presenter/view object)
+  # for the associated model instance (which means it should be used in the views only).
+  #
+  # And it holds the following metadata information for associated model class:
+  #
+  # - {#fields}
+  # - {#field_names}
+  # - {#index_fields}
+  # - {#index_field_names}
+  # - {#show_fields}
+  # - {#show_field_names}
+  # - {#form_fields}
+  # - {#form_field_names}
+  #
+  # For better practice, please create an application decorator class (see example)
+  # to better control the functions shared between different resource decorators.
+  # @example Create an application class for Admin Interface usage
+  #   class Admin::ApplicationDecorator < Wallaby::ResourceDecorator
+  #     base_class!
+  #   end
   class ResourceDecorator
     extend Baseable::ClassMethods
+    base_class!
+
+    # @!attribute fields
+    #   (see Wallaby::ModelDecorator#fields)
+
+    # @!attribute field_names
+    #   (see Wallaby::ModelDecorator#field_names)
+
+    # @!attribute index_fields
+    #   (see Wallaby::ModelDecorator#index_fields)
+
+    # @!attribute index_field_names
+    #   (see Wallaby::ModelDecorator#index_field_names)
+
+    # @!attribute show_fields
+    #   (see Wallaby::ModelDecorator#show_fields)
+
+    # @!attribute show_field_names
+    #   (see Wallaby::ModelDecorator#show_field_names)
+
+    # @!attribute form_fields
+    #   (see Wallaby::ModelDecorator#form_fields)
+
+    # @!attribute form_field_names
+    #   (see Wallaby::ModelDecorator#form_field_names)
 
     DELEGATE_METHODS =
       ModelDecorator.public_instance_methods(false) + Fieldable.public_instance_methods(false) - %i(model_class)
@@ -12,85 +55,15 @@ module Wallaby
     class << self
       delegate(*DELEGATE_METHODS, to: :model_decorator, allow_nil: true)
 
-      # @!attribute [w] model_class
-      attr_writer :model_class
-
-      # @!attribute [r] model_class
-      # Return associated model class, e.g. return **Product** for **ProductDecorator**.
-      #
-      # If Wallaby can't recognise the model class for Decorator, it's required to be configured as below example:
-      # @example To configure model class
-      #   class Admin::ProductDecorator < Admin::ApplicationDecorator
-      #     self.model_class = Product
-      #   end
-      # @example To configure model class for version below 5.2.0
-      #   class Admin::ProductDecorator < Admin::ApplicationDecorator
-      #     def self.model_class
-      #       Product
-      #     end
-      #   end
-      # @return [Class] assoicated model class
-      # @return [nil] if current class is marked as base class
-      # @return [nil] if current class is the same as the value of {Wallaby::Configuration::Mapping#resource_decorator}
-      # @return [nil] if current class is {Wallaby::ResourceDecorator}
-      # @return [nil] if assoicated model class is not found
-      def model_class
-        return unless self < ResourceDecorator
-        return if base_class? || self == Wallaby.configuration.mapping.resource_decorator
-
-        @model_class ||= Map.model_class_map(name.gsub(/(^#{namespace}::)|(Decorator$)/, EMPTY_STRING))
-      end
-
-      # @!attribute [w] application_decorator
-      def application_decorator=(application_decorator)
-        ModuleUtils.inheritance_check self, application_decorator
-        @application_decorator = application_decorator
-      end
-
-      # @note This attribute have to be the same as the one defined in the controller in order to make things working.
-      #   see {Wallaby::Decoratable::ClassMethods#application_decorator}
-      # @!attribute [r] application_decorator
-      # Assoicated base class.
-      #
-      # Wallaby will try to get the application decorator class from current class's ancestors chain.
-      # For instance, if current class is **ProductDecorator**, and it inherits from **CoreDecorator**,
-      # then Wallaby will return application decorator class **CoreDecorator**.
-      #
-      # However, there is a chance that Wallaby doesn't get it right.
-      # For instance, if **CoreDecorator** in the above example inherits from **Admin::ApplicationDecorator**, and
-      # the controller that needs **ProductDecorator** has set its **application_decorator** to
-      # **Admin::ApplicationDecorator**, then it's needed to configure **application_decorator** as the example
-      # describes
-      # @example To set application decorator class
-      #   class ProductController < Admin::ApplicationController
-      #     self.application_decorator = Admin::ApplicationDecorator
-      #   end
-      #
-      #   class CoreDecorator < Admin::ApplicationDecorator
-      #     base_class!
-      #   end
-      #
-      #   class ProductDecorator < CoreDecorator
-      #     self.application_decorator = Admin::ApplicationDecorator
-      #   end
-      # @return [Class] assoicated base class.
-      # @return [nil] if assoicated base class is not found from its ancestors chain
-      # @raise [ArgumentError] when current class doesn't inherit from given value
-      # @since 5.2.0
-      def application_decorator
-        @application_decorator ||= ancestors.find { |parent| parent < ResourceDecorator && !parent.model_class }
-      end
-
-      # Return associated model decorator.
-      #
-      # Fetch model decorator instance from cached map using keys {.model_class} and {.application_decorator}
-      # so that model decorator can be used in its sub classes declaration/scope.
+      # Return associated model decorator. It is the instance that pull out all the metadata
+      # information for the associated model.
       # @param model_class [Class]
       # @return [Wallaby::ModelDecorator]
+      # @return [nil] if itself is a base class or the given model_class is blank
       def model_decorator(model_class = self.model_class)
-        return unless self < ResourceDecorator || model_class
+        return if model_class.blank?
 
-        Map.model_decorator_map model_class, application_decorator
+        Map.model_decorator_map model_class, base_class
       end
 
       # @!attribute [w] h
@@ -164,13 +137,13 @@ module Wallaby
 
     # @return [ActiveModel::Name]
     def model_name
-      ModuleUtils.try_to(resource, :model_name) || ActiveModel::Name.new(model_class)
+      resource.try(:model_name) || ActiveModel::Name.new(model_class)
     end
 
     # @return [nil] if no primary key
     # @return [Array<String>] primary key
     def to_key
-      key = ModuleUtils.try_to(resource, primary_key)
+      key = resource.try primary_key
       key ? [key] : nil
     end
 
@@ -181,7 +154,7 @@ module Wallaby
       resource.try method_id, *args, &block
     end
 
-    # Delegate missing method check to context
+    # Delegate missing method check to {#resource}
     def respond_to_missing?(method_id, _include_private)
       resource.respond_to?(method_id) || super
     end

data/lib/errors/wallaby/class_not_found.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class ClassNotFound < GeneralError
+  end
+end

data/lib/errors/wallaby/model_not_found.rb

@@ -5,6 +5,8 @@ module Wallaby
   class ModelNotFound < NotFound
     # @return [String] not found error message
     def message
+      return super if super.include? "\n"
+
       Locale.t 'errors.not_found.model', model: super
     end
   end

data/lib/helpers/wallaby/resources_helper.rb

@@ -3,6 +3,9 @@
 module Wallaby
   # Resources helper
   module ResourcesHelper
+    include ApplicationHelper
+    include SecureHelper
+
     include BaseHelper
     include FormHelper
     include IndexHelper

data/lib/helpers/wallaby/secure_helper.rb

@@ -9,7 +9,7 @@ module Wallaby
     # - otherwise, an user icon will be returned
     # @param user [Object]
     # @return [String] IMG or I element
-    def user_portrait(user = current_user)
+    def user_portrait(user = wallaby_user)
       email_method = security.email_method || :email
       email = try_to user, email_method
       if email.present?
@@ -27,7 +27,7 @@ module Wallaby
     # @param user [Object]
     # @param app [Object]
     # @return [String] URL to log out
-    def logout_path(user = current_user, app = main_app)
+    def logout_path(user = wallaby_user, app = main_app)
       path = security.logout_path
       path ||=
         if defined? ::Devise
@@ -41,7 +41,7 @@ module Wallaby
     # @see Wallaby::Configuration::Security#logout_method
     # @param user [Object]
     # @return [String, Symbol] http method to log out
-    def logout_method(user = current_user)
+    def logout_method(user = wallaby_user)
       http_method = security.logout_method
       http_method ||
         if defined? ::Devise

data/lib/interfaces/wallaby/mode.rb

@@ -24,14 +24,14 @@ module Wallaby
 
       # @see Wallaby::ModelPaginationProvider
       # @return [Class] pagination provider for the mode
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       def model_pagination_provider
         check_and_constantize __callee__
       end
 
       # @see Wallaby::ModelPaginationProvider
       # @return [Class] pagination provider for the mode
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       def default_authorization_provider
         check_and_constantize __callee__
       end
@@ -39,7 +39,7 @@ module Wallaby
       # Return a list of authorization providers for authorizer to detect which one to use.
       # @see Wallaby::ModelAuthorizationProvider
       # @return [ActiveSupport::HashWithIndifferentAccess<String, Class>] authorization provider hash
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       def model_authorization_providers(classes = ModelAuthorizationProvider.descendants)
         # NOTE: make sure default provider always comes last
         @model_authorization_providers ||=

data/lib/interfaces/wallaby/model_authorization_provider.rb

@@ -2,7 +2,7 @@
 
 module Wallaby
   # Model Authorizer interface.
-  # @since 5.2.0
+  # @since wallaby-5.2.0
   class ModelAuthorizationProvider
     class << self
       # @!attribute [w] provider_name
@@ -13,34 +13,36 @@ module Wallaby
       # @see Wallaby::ModelAuthorizer.provider_name
       # @return [String/Symbol] provider name
       def provider_name
-        @provider_name || name.demodulize.gsub(/(Authorization)?Provider/, EMPTY_STRING).underscore
+        @provider_name ||= name.demodulize.gsub(/(Authorization)?Provider/, EMPTY_STRING).underscore
       end
 
       # @note Template method to check and see if current provider is in used.
-      # @param _context [ActionController::Base]
+      # @param _context [ActionController::Base, ActionView::Base]
       # @raise [Wallaby::NotImplemented]
       def available?(_context)
         raise NotImplemented
       end
-
-      # @note Template method to pull out the args required for contruction from context.
-      # @param _context [ActionController::Base]
-      # @raise [Wallaby::NotImplemented]
-      def args_from(_context)
-        raise NotImplemented
-      end
     end
 
     # @!attribute [r] context
-    # @return [ActionController::Base]
+    # @return [ActionController::Base, ActionView::Base]
     attr_reader :context
 
     # @!attribute [r] user
     # @return [Object]
     attr_reader :user
 
-    # Empty initialize that accepts all sorts of args
-    def initialize(*); end
+    # @!attribute [r] options
+    # @return [Hash]
+    attr_reader :options
+
+    # @param context [ActionController::Base, ActionView::Base]
+    # @param options [Hash]
+    def initialize(context, **options)
+      @context = context
+      @options = options
+      @user = context.try :wallaby_user
+    end
 
     # @note It can be overridden in subclasses for customization purpose.
     # This is the template method to check user's permission for given action on given subject.