wallaby-core 0.1.2 → 0.2.3

data/lib/wallaby/class_hash.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # This is a constant-safe hash that stores Class key/value as String
+  # and returns value as Class if it was a Class.
+  #
+  # It can be used for global methods (e.g. {Wallaby::Map.mode_map}) which cache the computed result,
+  # so that when Rails reloads, it won't complain that old Class constants still exist in
+  # ObjectSpace (see https://github.com/wallaby-rails/wallaby/issues/181).
+  #
+  # ```
+  # A copy of SupportAdmin::ApplicationAuthorizer has been removed from the module tree but is still active!
+  # ```
+  #
+  # As there won't be any Class constants being stored, they will converted to String in {#internal} Hash.
+  class ClassHash
+    # @!attribute [r] internal
+    # @return [Hash] The hash to store Class keys/values as String.
+    attr_reader :internal
+
+    # @param [Hash] hash
+    def initialize(hash = {})
+      @internal =
+        (hash || {})
+        .transform_keys(&method(:to_class_name))
+        .transform_values(&method(:to_class_name))
+    end
+
+    # @!attribute [r] origin
+    # @return [Hash] The original hash.
+    def origin
+      # NOTE: DO NOT cache it by using instance variable!
+      @internal
+        .transform_keys(&method(:to_class))
+        .transform_values(&method(:to_class))
+        .reject { |k, v| k.nil? || v.nil? }
+    end
+
+    # @!method keys
+    # Return the keys of {#origin}.
+    delegate :keys, to: :origin
+
+    # @!method values
+    # Return the values of {#origin}.
+    delegate :values, to: :origin
+
+    # @!method ==(other)
+    # Compare #{origin} with other.
+    delegate :==, to: :origin
+
+    # Save the key/value to the {#internal} hash, and convert the Class key/value to String
+    def []=(key, value)
+      @internal[to_class_name(key)] = to_class_name(value)
+    end
+
+    # Return the value for the given key, and convert the value back to Class if it was a Class
+    def [](key)
+      to_class @internal[to_class_name(key)]
+    end
+
+    # @param other [Hash]
+    # @return [Wallaby::ClassHash] new Class hash
+    def merge(other)
+      self.class.new origin.merge(other.try(:origin) || other)
+    end
+
+    # @return [Wallaby::ClassHash] new Class hash
+    def select(&block)
+      self.class.new origin.select(&block)
+    end
+
+    # Ensure to freeze the {#internal}
+    # @return [Wallaby::ClassHash] self
+    def freeze
+      @internal.freeze
+      super
+    end
+
+    protected
+
+    # Convert to Class name
+    def to_class_name(klass)
+      klass.is_a?(Class) ? [klass.name, true] : [klass, false]
+    end
+
+    # Convert to Class
+    def to_class(pair)
+      val, is_class = pair
+      is_class ? val.constantize : val
+    rescue NameError
+      Logger.error "`#{val}` is not a valid Class name."
+    end
+  end
+end

data/lib/wallaby/classifier.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # Concern to handle the conversion between Class and String
+  module Classifier
+    # Convert Class to String. If not Class, unchanged.
+    # @param klass [Object]
+    # @return [String] if klass is a Class
+    # @return [Object] if klass is not a Class
+    def to_class_name(klass)
+      klass.try(:name) || klass || nil
+    end
+
+    # Convert String to Class. If not String, unchanged.
+    # @param name [Object]
+    # @return [Class] if name is a Class
+    # @return [Object] if name is not a String
+    # @return [nil] if class cannot be found
+    def to_class(name)
+      return name unless name.is_a? String
+
+      # NOTE: DO NOT try to use const_defined? and const_get EVER.
+      # This is Rails, use constantize
+      name.constantize
+    rescue NameError
+      Logger.error "`#{name}` is not a valid Class name."
+    end
+  end
+end

data/lib/wallaby/configuration/mapping.rb

@@ -3,10 +3,14 @@
 module Wallaby
   class Configuration
     # Configuration used in {Wallaby::Map}
-    # @since 5.1.6
+    # @since wallaby-5.1.6
     class Mapping
+      include Classifier
+
       # @!attribute [w] resources_controller
-      attr_writer :resources_controller
+      def resources_controller=(resources_controller)
+        @resources_controller = to_class_name resources_controller
+      end
 
       # @!attribute [r] resources_controller
       # To globally configure the resources controller.
@@ -21,17 +25,19 @@ module Wallaby
       #     config.mapping.resources_controller = ::GlobalResourcesController
       #   end
       # @return [Class] resources controller class
-      # @since 5.1.6
+      # @since wallaby-5.1.6
       def resources_controller
         @resources_controller ||=
           defined?(::Admin::ApplicationController) \
             && ::Admin::ApplicationController < ::Wallaby::ResourcesController \
-            && ::Admin::ApplicationController
-        @resources_controller ||= ResourcesController
+            && 'Admin::ApplicationController'
+        to_class @resources_controller ||= 'Wallaby::ResourcesController'
       end
 
       # @!attribute [w] resource_decorator
-      attr_writer :resource_decorator
+      def resource_decorator=(resource_decorator)
+        @resource_decorator = to_class_name resource_decorator
+      end
 
       # @!attribute [r] resource_decorator
       # To globally configure the resource decorator.
@@ -46,17 +52,19 @@ module Wallaby
       #     config.mapping.resource_decorator = ::GlobalResourceDecorator
       #   end
       # @return [Class] resource decorator class
-      # @since 5.1.6
+      # @since wallaby-5.1.6
       def resource_decorator
         @resource_decorator ||=
           defined?(::Admin::ApplicationDecorator) \
             && ::Admin::ApplicationDecorator < ::Wallaby::ResourceDecorator \
-            && ::Admin::ApplicationDecorator
-        @resource_decorator ||= ResourceDecorator
+            && 'Admin::ApplicationDecorator'
+        to_class @resource_decorator ||= 'Wallaby::ResourceDecorator'
       end
 
       # @!attribute [w] model_servicer
-      attr_writer :model_servicer
+      def model_servicer=(model_servicer)
+        @model_servicer = to_class_name model_servicer
+      end
 
       # @!attribute [r] model_servicer
       # To globally configure the model servicer.
@@ -71,23 +79,19 @@ module Wallaby
       #     config.mapping.model_servicer = ::GlobalModelServicer
       #   end
       # @return [Class] model servicer class
-      # @since 5.1.6
+      # @since wallaby-5.1.6
       def model_servicer
         @model_servicer ||=
           defined?(::Admin::ApplicationServicer) \
             && ::Admin::ApplicationServicer < ::Wallaby::ModelServicer \
-            && ::Admin::ApplicationServicer
-        @model_servicer ||= ModelServicer
-      end
-
-      # @deprecated Use {#model_paginator=} instead. It will be removed from 5.3.*
-      def resource_paginator=(resource_paginator)
-        Utils.deprecate 'deprecation.resource_paginator=', caller: caller
-        self.model_paginator = resource_paginator
+            && 'Admin::ApplicationServicer'
+        to_class @model_servicer ||= 'Wallaby::ModelServicer'
       end
 
       # @!attribute [w] model_authorizer
-      attr_writer :model_authorizer
+      def model_authorizer=(model_authorizer)
+        @model_authorizer = to_class_name model_authorizer
+      end
 
       # @!attribute [r] model_authorizer
       # To globally configure the model authorizer.
@@ -102,17 +106,19 @@ module Wallaby
       #     config.mapping.model_authorizer = ::GlobalModelAuthorizer
       #   end
       # @return [Class] model authorizer class
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       def model_authorizer
         @model_authorizer ||=
           defined?(::Admin::ApplicationAuthorizer) \
             && ::Admin::ApplicationAuthorizer < ::Wallaby::ModelAuthorizer \
-            && ::Admin::ApplicationAuthorizer
-        @model_authorizer ||= ModelAuthorizer
+            && 'Admin::ApplicationAuthorizer'
+        to_class @model_authorizer ||= 'Wallaby::ModelAuthorizer'
       end
 
       # @!attribute [w] model_paginator
-      attr_writer :model_paginator
+      def model_paginator=(model_paginator)
+        @model_paginator = to_class_name model_paginator
+      end
 
       # @!attribute [r] model_paginator
       # To globally configure the resource paginator.
@@ -127,13 +133,13 @@ module Wallaby
       #     config.mapping.model_paginator = ::GlobalModelPaginator
       #   end
       # @return [Class] resource paginator class
-      # @since 5.2.0
+      # @since wallaby-5.2.0
       def model_paginator
         @model_paginator ||=
           defined?(::Admin::ApplicationPaginator) \
             && ::Admin::ApplicationPaginator < ::Wallaby::ModelPaginator \
-            && ::Admin::ApplicationPaginator
-        @model_paginator ||= ModelPaginator
+            && 'Admin::ApplicationPaginator'
+        to_class @model_paginator ||= 'Wallaby::ModelPaginator'
       end
     end
   end

data/lib/wallaby/configuration/metadata.rb

@@ -14,7 +14,7 @@ module Wallaby
       #     config.metadata.max = 50
       #   end
       # @return [Integer] max number of characters to truncate, default to 20
-      # @since 5.1.6
+      # @since wallaby-5.1.6
       def max
         @max ||= DEFAULT_MAX
       end

data/lib/wallaby/configuration/models.rb

@@ -2,11 +2,7 @@
 
 module Wallaby
   class Configuration
-    # @note In `development` environment, Rails recreates module/class constants on reload event.
-    #   If constants are cached/stored, they will become stale and Rails will raise conflicts.
-    #
-    #   Hence, class name strings should be stored instead.
-    #   When classes are requested, strings will be constantized into classes.
+    # @deprecated will move this configuration to {Wallaby::ResourcesController} from 6.2
     # Models configuration to specify the model classes that Wallaby should handle.
     class Models
       # @note If models are whitelisted, models exclusion will NOT be applied.
@@ -17,12 +13,12 @@ module Wallaby
       #   end
       # @param models [Array<Class, String>]
       def set(*models)
-        @models = Array(models).flatten.map(&:to_s)
+        @models = ClassArray.new(models.flatten)
       end
 
       # @return [Array<Class>] the models configured
       def presence
-        (@models ||= []).map(&:constantize)
+        @models ||= ClassArray.new # rubocop:disable Naming/MemoizedInstanceVariableName
       end
 
       # @note If models are whitelisted using {#set}, models exclusion will NOT be applied.
@@ -33,13 +29,13 @@ module Wallaby
       #   end
       # @param models [Array<Class, String>]
       def exclude(*models)
-        @excludes = Array(models).flatten.map(&:to_s)
+        @excludes = ClassArray.new(models.flatten)
       end
 
       # @return [Array<Class>] the list of models to exclude.
       #   By default, `ActiveRecord::SchemaMigration` is excluded.
       def excludes
-        (@excludes ||= ['ActiveRecord::SchemaMigration']).map(&:constantize)
+        @excludes ||= ClassArray.new ['ActiveRecord::SchemaMigration']
       end
     end
   end

data/lib/wallaby/configuration/security.rb

@@ -3,6 +3,7 @@
 module Wallaby
   class Configuration
     # Security configuration
+    # TODO: remove this from 6.2
     class Security
       # Default block to return nil for current user
       DEFAULT_CURRENT_USER = -> { nil }
@@ -20,7 +21,7 @@ module Wallaby
       #   Wallaby.config do |config|
       #     config.security.logout_path = 'logout_path'
       #   end
-      # @since 5.1.4
+      # @since wallaby-5.1.4
       attr_accessor :logout_path
 
       # @!attribute logout_method
@@ -34,7 +35,7 @@ module Wallaby
       #   Wallaby.config do |config|
       #     config.security.logout_method = 'post'
       #   end
-      # @since 5.1.4
+      # @since wallaby-5.1.4
       attr_accessor :logout_method
 
       # @!attribute email_method
@@ -45,7 +46,7 @@ module Wallaby
       #   Wallaby.config do |config|
       #     config.security.email_method = 'email_address'
       #   end
-      # @since 5.1.4
+      # @since wallaby-5.1.4
       attr_accessor :email_method
 
       # To globally configure how to get user object.
@@ -57,6 +58,7 @@ module Wallaby
       #   end
       # @yield A block to get user object. All application controller methods can be used in the block.
       def current_user(&block)
+        Logger.deprecated 'Wallaby will remove security.current_user? from 6.2.'
         if block_given?
           @current_user = block
         else
@@ -81,6 +83,7 @@ module Wallaby
       #   end
       # @yield A block to authenticate user. All application controller methods can be used in the block.
       def authenticate(&block)
+        Logger.deprecated 'Wallaby will remove security.authenticate from 6.2.'
         if block_given?
           @authenticate = block
         else

data/lib/wallaby/configuration/sorting.rb

@@ -3,7 +3,7 @@
 module Wallaby
   class Configuration
     # Sorting global configuration
-    # @since 5.2.0
+    # @since wallaby-5.2.0
     class Sorting
       # @!attribute [w] strategy
       attr_writer :strategy

data/lib/wallaby/configuration.rb

@@ -4,8 +4,37 @@
 module Wallaby
   # Global configuration
   class Configuration
+    include Classifier
+
+    # @!attribute [w] model_paths
+    def model_paths=(*model_paths)
+      @model_paths =
+        model_paths.flatten.compact.presence.try do |paths|
+          next paths if paths.all? { |p| p.is_a?(String) }
+
+          raise(
+            ArgumentError,
+            'Please provide a list of string paths, e.g. `["app/models", "app/core"]`'
+          )
+        end
+    end
+
+    # @!attribute [r] model_paths
+    # To configure the model folders that {Wallaby::Preloader} needs to load before everything else.
+    # @example To set the model paths
+    #   Wallaby.config do |config|
+    #     config.model_paths = ["app/models", "app/core"]
+    #   end
+    # @return [Array<String>] model paths
+    # @since 0.2.2
+    def model_paths
+      @model_paths ||= %w(app/models)
+    end
+
     # @!attribute [w] base_controller
-    attr_writer :base_controller
+    def base_controller=(base_controller)
+      @base_controller = to_class_name base_controller
+    end
 
     # @!attribute [r] base_controller
     # To globally configure the base controller class that {Wallaby::ApplicationController} should inherit from.
@@ -18,7 +47,7 @@ module Wallaby
     #   end
     # @return [Class] base controller class
     def base_controller
-      @base_controller ||= ::ApplicationController
+      to_class @base_controller ||= '::ApplicationController'
     end
 
     # @return [Wallaby::Configuration::Models] models configuration for custom mode

data/lib/wallaby/constants.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
 module Wallaby
-  EMPTY_STRING = ''.html_safe
-  EMPTY_HASH = {}.freeze
-  EMPTY_ARRAY = [].freeze
-  SPACE = ' '
-  SLASH = '/'
-  COLONS = '::'
-  COMMA = ','
-  DOT = '.'
+  EMPTY_STRING = ''.html_safe.freeze # :nodoc:
+  EMPTY_HASH = {}.freeze # :nodoc:
+  EMPTY_ARRAY = [].freeze # :nodoc:
+  SPACE = ' ' # :nodoc:
+  SLASH = '/' # :nodoc:
+  COLONS = '::' # :nodoc:
+  COMMA = ',' # :nodoc:
+  DOT = '.' # :nodoc:
+  UNDERSCORE = '_' # :nodoc:
+  PCT = '%' # :nodoc:
 
   # Default page size for {Wallaby::Configuration::Pagination#page_size}
   DEFAULT_PAGE_SIZE = 20

data/lib/wallaby/core/version.rb

@@ -2,6 +2,6 @@
 
 module Wallaby
   module Core
-    VERSION = '0.1.2'
+    VERSION = '0.2.3' # :nodoc:
   end
 end

data/lib/wallaby/core.rb

@@ -1,14 +1,21 @@
 # frozen_string_literal: true
 
+require 'active_model'
 require 'parslet'
 require 'responders'
+require 'wallaby/view'
 
 require 'wallaby/core/version'
 require 'wallaby/constants'
+require 'wallaby/logger'
+require 'wallaby/preloader'
 require 'wallaby/engine'
 
-require 'support/action_dispatch/routing/mapper'
-
+# Global class attributes that holds the most important configuration/information
+# NOTE: DO NOT store any Class in both configuration and map
+require 'wallaby/classifier'
+require 'wallaby/class_array'
+require 'wallaby/class_hash'
 require 'wallaby/configuration'
 require 'wallaby/configuration/features'
 require 'wallaby/configuration/mapping'
@@ -19,20 +26,25 @@ require 'wallaby/configuration/security'
 require 'wallaby/configuration/sorting'
 require 'wallaby/map'
 
+require 'support/action_dispatch/routing/mapper'
+
 require 'routes/wallaby/resources_router'
 require 'tree/wallaby/node'
 require 'parsers/wallaby/parser'
 
-require 'utils/wallaby/cell_utils'
 require 'utils/wallaby/field_utils'
 require 'utils/wallaby/filter_utils'
+require 'utils/wallaby/locale'
 require 'utils/wallaby/model_utils'
 require 'utils/wallaby/module_utils'
 require 'utils/wallaby/params_utils'
-require 'utils/wallaby/preload_utils'
 require 'utils/wallaby/test_utils'
 require 'utils/wallaby/utils'
 
+require 'concerns/wallaby/application_concern'
+require 'concerns/wallaby/authentication_concern'
+require 'concerns/wallaby/resources_concern'
+
 require 'concerns/wallaby/authorizable'
 require 'concerns/wallaby/baseable'
 require 'concerns/wallaby/decoratable'
@@ -40,11 +52,10 @@ require 'concerns/wallaby/defaultable'
 require 'concerns/wallaby/engineable'
 require 'concerns/wallaby/fieldable'
 require 'concerns/wallaby/paginatable'
-require 'concerns/wallaby/rails_overridden_methods'
+require 'concerns/wallaby/prefixable'
 require 'concerns/wallaby/resourcable'
 require 'concerns/wallaby/servicable'
 require 'concerns/wallaby/shared_helpers'
-require 'concerns/wallaby/themeable'
 
 require 'interfaces/wallaby/mode'
 require 'interfaces/wallaby/model_decorator'
@@ -54,12 +65,13 @@ require 'interfaces/wallaby/model_pagination_provider'
 require 'interfaces/wallaby/model_authorization_provider'
 
 require 'errors/wallaby/general_error'
+
+require 'errors/wallaby/class_not_found'
 require 'errors/wallaby/invalid_error'
 require 'errors/wallaby/not_implemented'
 require 'errors/wallaby/not_found'
 require 'errors/wallaby/model_not_found'
 require 'errors/wallaby/resource_not_found'
-require 'errors/wallaby/cell_handling'
 
 require 'errors/wallaby/forbidden'
 require 'errors/wallaby/not_authenticated'
@@ -68,7 +80,6 @@ require 'errors/wallaby/unprocessable_entity'
 require 'decorators/wallaby/resource_decorator'
 require 'servicers/wallaby/model_servicer'
 require 'paginators/wallaby/model_paginator'
-require 'paginators/wallaby/resource_paginator'
 require 'authorizers/wallaby/model_authorizer'
 require 'authorizers/wallaby/default_authorization_provider'
 require 'authorizers/wallaby/cancancan_authorization_provider'
@@ -96,19 +107,13 @@ require 'helpers/wallaby/links_helper'
 require 'helpers/wallaby/styling_helper'
 
 require 'helpers/wallaby/base_helper'
-require 'helpers/wallaby/resources_helper'
-require 'helpers/wallaby/secure_helper'
 require 'helpers/wallaby/application_helper'
+require 'helpers/wallaby/secure_helper'
+require 'helpers/wallaby/resources_helper'
 
 require 'responders/wallaby/resources_responder'
 require 'responders/wallaby/json_api_responder'
 
-require 'renderers/wallaby/cell'
-require 'renderers/wallaby/cell_resolver'
-require 'renderers/wallaby/custom_lookup_context'
-require 'renderers/wallaby/custom_renderer'
-require 'renderers/wallaby/custom_partial_renderer'
-
 require 'adaptors/wallaby/custom'
 require 'adaptors/wallaby/custom/default_provider'
 require 'adaptors/wallaby/custom/model_finder'

data/lib/wallaby/engine.rb

@@ -3,40 +3,29 @@
 module Wallaby
   # Wallaby engine
   class Engine < ::Rails::Engine
-    initializer 'wallaby.autoload_paths', before: :set_load_path do |_|
-      # NOTE: this needs to be run before `set_load_path`
-      # so that files under `app/views` can be eager loaded
-      # and therefore, Wallaby's renderer can function properly
-      [Rails.configuration].each do |conf|
-        next if conf.paths['app/views'].eager_load?
-
-        conf.paths.add 'app/views', eager_load: true
-      end
-    end
-
     initializer 'wallaby.development.reload' do |_|
       # NOTE: Rails reload! will hit here
       # @see http://rmosolgo.github.io/blog/2017/04/12/watching-files-during-rails-development/
       config.to_prepare do
         if Rails.env.development? || Rails.configuration.eager_load
-          Rails.logger.debug '  [WALLABY] Reloading...'
-          ::Wallaby::Map.clear
-          ::Wallaby::PreloadUtils.require_all
+          Logger.debug 'Reloading after Rails\' reload...', sourcing: false
+          Map.clear
+          Preloader.require_all
         end
       end
     end
 
     config.before_eager_load do
-      # NOTE: We need to ensure that the core models are loaded before anything else
-      Rails.logger.debug '  [WALLABY] Preload all model files.'
-      ::Wallaby::PreloadUtils.require_one 'app/models'
+      # NOTE: The models must be loaded before everything else
+      Logger.debug 'Preload all `app/models` files.', sourcing: false
+      Preloader.require_models
     end
 
-    # Preload the rest files
     config.after_initialize do
+      # Load the rest files
       unless Rails.env.development? || Rails.configuration.eager_load
-        Rails.logger.debug '  [WALLABY] Preload files after initialize.'
-        ::Wallaby::PreloadUtils.require_all
+        Logger.debug 'Preload all other eager load files after initialize.', sourcing: false
+        Preloader.require_all
       end
     end
   end

data/lib/wallaby/logger.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # Custom logger
+  module Logger
+    class << self
+      %i(unknown fatal error warn info debug deprecated).each do |method_id|
+        define_method method_id do |message, replacements = {}|
+          sourcing = replacements.delete :sourcing # sourcing can be set to false
+          heading = replacements.delete(:heading) || 'WALLABY '
+          new_message, from = normalize message, sourcing != false && Array(caller[sourcing || 0]) || nil
+          Rails.logger.public_send(
+            method_id == :deprecated ? :warn : method_id,
+            "#{heading}#{method_id.to_s.upcase}: #{format new_message, replacements}#{from}"
+          )
+          nil
+        end
+      end
+
+      protected
+
+      # @param message [Object]
+      def normalize(message, sources)
+        case message
+        when String
+          [message, sources && "\nfrom #{sources.join("     \n")}"]
+        when StandardError
+          [message.message, sources && "\n#{message.backtrace.join("\n")}"]
+        else
+          [message.inspect, sources && "\nfrom #{sources.join("     \n")}"]
+        end
+      end
+    end
+  end
+end