wallaby-core 0.2.0 → 0.2.4

data/lib/concerns/wallaby/baseable.rb

@@ -3,33 +3,114 @@
 module Wallaby
   # Abstract related class methods
   module Baseable
-    # Configurable attributes and class methods for marking a class the base class
-    # and skipping {Wallaby::Map Wallaby mapping}
+    SUFFIX = /(Controller|Decorator|Servicer|Authorizer|Paginator)$/.freeze
+    ATTR_NAME = 'model_class'
+
+    # @param class_name [String]
+    # @param attr_name [String]
+    # @param suffix [String]
+    # @param plural [String]
+    # @return [Class] found associated class
+    # @raise [Wallaby::ClassNotFound] if associated class isn't found
+    def self.guess_associated_class_of(class_name, attr_name: ATTR_NAME, suffix: EMPTY_STRING, plural: false)
+      base_name = class_name.gsub(SUFFIX, EMPTY_STRING).try(plural ? :pluralize : :singularize) << suffix
+      parts = base_name.split(COLONS)
+      parts.each_with_index do |_, index|
+        begin
+          # NOTE: DO NOT try to use const_defined? and const_get EVER.
+          # This is Rails, use constantize
+          return parts[index..-1].join(COLONS).constantize
+        rescue NameError # rubocop:disable Lint/SuppressedException
+        end
+      end
+
+      raise ClassNotFound, <<~INSTRUCTION
+        The `#{attr_name}` hasn't been provided for Class `#{class_name}` and Wallaby cannot guess it right.
+        If `#{class_name}` is supposed to be a base class, add the following line to its class declaration:
+
+          class #{class_name}
+            base_class!
+          end
+
+        Otherwise, please specify the `#{attr_name}` in `#{class_name}`'s declaration as follows:
+
+          class #{class_name}
+            self.#{attr_name} = CorrectClass
+          end
+      INSTRUCTION
+    end
+
+    # Configurable attributes:
+    # 1. mark a class as a base class
+    # 2. guess the model class if model class isn't given
     module ClassMethods
       # @return [true] if class is a base class
       # @return [false] if class is not a base class
       def base_class?
-        @base_class ||= false
+        @base_class == self
       end
 
-      # Mark class a base class
-      # @return [true]
+      # Mark the current class as the base class
       def base_class!
-        @base_class = true
+        @base_class = self
+      end
+
+      # @!attribute [r] base_class
+      # @return [Class] The base class or the one from super class
+      def base_class
+        @base_class || superclass.try(:base_class)
+      end
+
+      # @!attribute [w] model_class
+      def model_class=(model_class)
+        raise ArgumentError 'Please provide a Class for `model_class`.' unless model_class.is_a? Class
+
+        @model_class = model_class
+      end
+
+      # @!attribute [r] model_class
+      # @example To configure the model class
+      #   class Admin::ProductAuthorizer < Admin::ApplicationAuthorizer
+      #     self.model_class = Product
+      #   end
+      # @example To configure the model class for version below 5.2.0
+      #   class Admin::ProductAuthorizer < Admin::ApplicationAuthorizer
+      #     def self.model_class
+      #       Product
+      #     end
+      #   end
+      # @return [Class] assigned model class or Wallaby will guess it
+      #   (see {Wallaby::Baseable.guess_associated_class_of .guess_associated_class_of})
+      # @return [nil] if current class is marked as base class
+      # @raise [Wallaby::ModelNotFound] if model class isn't found
+      # @raise [ArgumentError] if base class is empty
+      def model_class
+        return if base_class?
+
+        @model_class ||= Baseable.guess_associated_class_of name
+      rescue TypeError
+        raise ArgumentError, <<~INSTRUCTION
+          Please specify the base class for class `#{name}`
+          by marking one of its parents `base_class!`, for example:
+
+            class ParentClass
+              base_class!
+            end
+        INSTRUCTION
       end
 
       # @!attribute [w] namespace
       # Used by `model_class`
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       attr_writer :namespace
 
       # @!attribute [r] namespace
       # @return [String] namespace
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       def namespace
         @namespace ||=
-          ModuleUtils.try_to(superclass, :namespace) \
-          || name.deconstantize.gsub(/Wallaby(::)?/, EMPTY_STRING).presence
+          superclass.try(:namespace) \
+            || name.deconstantize.gsub(/Wallaby(::)?/, EMPTY_STRING).presence
       end
     end
   end

data/lib/concerns/wallaby/decoratable.rb

@@ -22,7 +22,7 @@ module Wallaby
       # @return [Class] resource decorator
       # @raise [ArgumentError] when **resource_decorator** doesn't inherit from **application_decorator**
       # @see Wallaby::ResourceDecorator
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       attr_reader :resource_decorator
 
       # @!attribute [w] application_decorator
@@ -40,7 +40,7 @@ module Wallaby
       # @raise [ArgumentError] when **resource_decorator** doesn't inherit from **application_decorator**
       # @return [Class] application decorator
       # @see Wallaby::ResourceDecorator
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       def application_decorator
         @application_decorator ||= ModuleUtils.try_to superclass, :application_decorator
       end
@@ -68,7 +68,7 @@ module Wallaby
       @current_decorator ||=
         (controller_to_get(:resource_decorator) || \
         Map.resource_decorator_map(current_model_class, controller_to_get(:application_decorator))).tap do |decorator|
-          Rails.logger.info %(  - Current decorator: #{decorator})
+          Logger.debug %(Current decorator: #{decorator}), sourcing: false
         end
     end
 

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|
-          Rails.logger.info %(  - 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]
@@ -97,6 +62,8 @@ module Wallaby
         )
     end
 
+    alias collection! collection
+
     # @note This is a template method that can be overridden by subclasses.
     # This is a method to return resource for pages except `index`.
     #
@@ -145,5 +112,7 @@ module Wallaby
           &block
         )
     end
+
+    alias resource! resource
   end
 end