wallaby-core 0.1.2 → 0.2.3

data/lib/wallaby/map.rb

@@ -1,26 +1,29 @@
 # frozen_string_literal: true
 
 module Wallaby
-  # Global storage to hold all the information that Wallaby needs to look up.
+  # All the lookups that Wallaby needs.
   class Map
     class << self
-      # To store modes
+      include Classifier
+
+      # @!attribute [w] modes
       attr_writer :modes
 
-      # @return [Array<Class>] descendants of Mode
+      # @!attribute [r] modes
+      # @return [Array<String>] all {Wallaby::Mode}s
       def modes
-        @modes ||= Mode.descendants
+        @modes ||= ClassArray.new Mode.descendants
       end
 
-      # @return [Hash] { model => mode }
+      # @return [Wallaby::ClassHash] { Model Class => {Wallaby::Mode} }
       def mode_map
-        @mode_map ||= ModeMapper.new(modes).map.freeze
+        @mode_map ||= ModeMapper.execute(modes).freeze
       end
 
       # TODO: remove this method
       # @return [Array] [ model classes ]
       def model_classes
-        @model_classes ||= ModelClassCollector.new(configuration, mode_map.keys).collect.freeze
+        ModelClassCollector.new(configuration, mode_map.keys).collect
       end
 
       # { model => resources name }
@@ -30,7 +33,7 @@ module Wallaby
       # @param value [String, nil] resources name
       # @return [String] resources name
       def resources_name_map(model_class, value = nil)
-        @resources_name_map ||= {}
+        @resources_name_map ||= ClassHash.new
         @resources_name_map[model_class] ||= value || ModelUtils.to_resources_name(model_class)
       end
 
@@ -40,7 +43,7 @@ module Wallaby
       # @param resources_name [String]
       # @return [Class]
       def model_class_map(resources_name, value = nil)
-        @model_class_map ||= {}
+        @model_class_map ||= ClassHash.new
         @model_class_map[resources_name] ||= value || ModelUtils.to_model_class(resources_name)
       end
     end
@@ -61,7 +64,7 @@ module Wallaby
       # @return [Class] resource decorator class, default to `mapping.resource_decorator`
       def resource_decorator_map(model_class, application_decorator = nil)
         application_decorator ||= mapping.resource_decorator
-        map_of :@decorator_map, model_class, application_decorator
+        map_of :@resource_decorator_map, model_class, application_decorator
       end
 
       # { model => model decorator }
@@ -70,8 +73,8 @@ module Wallaby
       # @return [Wallaby::ModelDecorator] model decorator instance
       def model_decorator_map(model_class, application_decorator = nil)
         application_decorator ||= mapping.resource_decorator
-        @model_decorator_map ||= {}
-        @model_decorator_map[application_decorator] ||= {}
+        @model_decorator_map ||= ClassHash.new
+        @model_decorator_map[application_decorator] ||= ClassHash.new
         @model_decorator_map[application_decorator][model_class] ||=
           mode_map[model_class].try(:model_decorator).try :new, model_class
       end
@@ -109,7 +112,7 @@ module Wallaby
       # @param model_class [Class]
       # @return [Class] model service provider instance
       def service_provider_map(model_class)
-        @service_provider_map ||= {}
+        @service_provider_map ||= ClassHash.new
         @service_provider_map[model_class] ||= mode_map[model_class].try :model_service_provider
       end
 
@@ -117,7 +120,7 @@ module Wallaby
       # @param model_class [Class]
       # @return [Class] model pagination provider class
       def pagination_provider_map(model_class)
-        @pagination_provider_map ||= {}
+        @pagination_provider_map ||= ClassHash.new
         @pagination_provider_map[model_class] ||= mode_map[model_class].try :model_pagination_provider
       end
 
@@ -125,7 +128,7 @@ module Wallaby
       # @param model_class [Class]
       # @return [Class] model authorizer provider class
       def authorizer_provider_map(model_class)
-        @authorizer_provider_map ||= {}
+        @authorizer_provider_map ||= ClassHash.new
         @authorizer_provider_map[model_class] ||= mode_map[model_class].try :model_authorization_providers
       end
     end
@@ -157,10 +160,10 @@ module Wallaby
         return unless model_class
 
         unless mode_map[model_class]
-          Rails.logger.warn I18n.t('wallaby.map.missing_mode_for_model_class', model: model_class.name)
+          Logger.warn Locale.t('map.missing_mode_for_model_class', model: model_class.name), sourcing: 2..5
           return
         end
-        instance_variable_set(variable_name, instance_variable_get(variable_name) || {})
+        instance_variable_set(variable_name, instance_variable_get(variable_name) || ClassHash.new)
         map = instance_variable_get variable_name
         map[application_class] ||= ModelClassMapper.map application_class.descendants
         map[application_class][model_class] ||= application_class

data/lib/wallaby/preloader.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # Preload files for eager load paths.
+  #
+  # As Wallaby is built upon the {Wallaby::Map} which will not be completed
+  # until all models and decorators/controllers/servicers/authorizers/paginators
+  # are loaded. Therefore, when Rails app is initialized,
+  # all files under eager load paths (mostly `app/*` folders),
+  # especially the files under `app/models`, need to be loaded before everything else.
+  class Preloader
+    include ActiveModel::Model
+
+    # Require all files
+    # @see #all_file_paths
+    def self.require_all
+      new.all_file_paths.each(&method(:require_dependency))
+    end
+
+    # Require models under {Wallaby::Configuration#model_paths}
+    # @see #model_file_paths
+    def self.require_models
+      new.model_file_paths.each(&method(:require_dependency))
+    end
+
+    # @return [Array<String>] all files under **Rails.configuration.eager_load_paths**
+    def all_file_paths
+      sort all_eager_load_file_paths
+    end
+
+    # @return [Array<String>] model files under {Wallaby::Configuration#model_paths}
+    def model_file_paths
+      sort(all_eager_load_file_paths).select(&method(:indexed))
+    end
+
+    # @!attribute [w] eager_load_paths
+    attr_writer :eager_load_paths
+
+    # @!attribute [r] eager_load_paths
+    # @return [Array<String, Pathname>]
+    def eager_load_paths # :nodoc:
+      @eager_load_paths ||= Rails.configuration.eager_load_paths
+    end
+
+    # @!attribute [w] model_paths
+    attr_writer :model_paths
+
+    # @!attribute [r] model_paths
+    # @return [Array<String>]
+    def model_paths # :nodoc:
+      @model_paths ||= Wallaby.configuration.model_paths
+    end
+
+    private
+
+    def all_eager_load_file_paths # :nodoc:
+      Dir.glob(eager_load_paths.map { |load_path| "#{load_path}/**/*.rb" })
+    end
+
+    # All files need to be sorted in the following orders:
+    # 1. {Wallaby::Configuration#model_paths} order
+    # 2. Alphabet order
+    def sort(file_paths)
+      file_paths.sort { |p1, p2| conditions_for(p1) <=> conditions_for(p2) }
+    end
+
+    # @see #sort
+    def conditions_for(path)
+      [indexed(path) || model_paths.length, path]
+    end
+
+    # Check if the path is in the {Wallaby::Configuration#model_paths}
+    def indexed(path)
+      model_paths.index(&path.method(:include?))
+    end
+  end
+end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: wallaby-core
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Tian Chen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-17 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: parslet
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: responders
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: wallaby-view
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -89,9 +117,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- app/controllers/wallaby/application_controller.rb
 - app/controllers/wallaby/resources_controller.rb
-- app/controllers/wallaby/secure_controller.rb
 - app/security/ability.rb
 - config/locales/wallaby.en.yml
 - config/locales/wallaby_class.en.yml
@@ -106,6 +132,8 @@ files:
 - lib/authorizers/wallaby/default_authorization_provider.rb
 - lib/authorizers/wallaby/model_authorizer.rb
 - lib/authorizers/wallaby/pundit_authorization_provider.rb
+- lib/concerns/wallaby/application_concern.rb
+- lib/concerns/wallaby/authentication_concern.rb
 - lib/concerns/wallaby/authorizable.rb
 - lib/concerns/wallaby/baseable.rb
 - lib/concerns/wallaby/decoratable.rb
@@ -113,13 +141,13 @@ files:
 - lib/concerns/wallaby/engineable.rb
 - lib/concerns/wallaby/fieldable.rb
 - lib/concerns/wallaby/paginatable.rb
-- lib/concerns/wallaby/rails_overridden_methods.rb
+- lib/concerns/wallaby/prefixable.rb
 - lib/concerns/wallaby/resourcable.rb
+- lib/concerns/wallaby/resources_concern.rb
 - lib/concerns/wallaby/servicable.rb
 - lib/concerns/wallaby/shared_helpers.rb
-- lib/concerns/wallaby/themeable.rb
 - lib/decorators/wallaby/resource_decorator.rb
-- lib/errors/wallaby/cell_handling.rb
+- lib/errors/wallaby/class_not_found.rb
 - lib/errors/wallaby/forbidden.rb
 - lib/errors/wallaby/general_error.rb
 - lib/errors/wallaby/invalid_error.rb
@@ -146,13 +174,7 @@ files:
 - lib/interfaces/wallaby/model_pagination_provider.rb
 - lib/interfaces/wallaby/model_service_provider.rb
 - lib/paginators/wallaby/model_paginator.rb
-- lib/paginators/wallaby/resource_paginator.rb
 - lib/parsers/wallaby/parser.rb
-- lib/renderers/wallaby/cell.rb
-- lib/renderers/wallaby/cell_resolver.rb
-- lib/renderers/wallaby/custom_lookup_context.rb
-- lib/renderers/wallaby/custom_partial_renderer.rb
-- lib/renderers/wallaby/custom_renderer.rb
 - lib/responders/wallaby/json_api_responder.rb
 - lib/responders/wallaby/resources_responder.rb
 - lib/routes/wallaby/resources_router.rb
@@ -171,15 +193,17 @@ files:
 - lib/services/wallaby/type_renderer.rb
 - lib/support/action_dispatch/routing/mapper.rb
 - lib/tree/wallaby/node.rb
-- lib/utils/wallaby/cell_utils.rb
 - lib/utils/wallaby/field_utils.rb
 - lib/utils/wallaby/filter_utils.rb
+- lib/utils/wallaby/locale.rb
 - lib/utils/wallaby/model_utils.rb
 - lib/utils/wallaby/module_utils.rb
 - lib/utils/wallaby/params_utils.rb
-- lib/utils/wallaby/preload_utils.rb
 - lib/utils/wallaby/test_utils.rb
 - lib/utils/wallaby/utils.rb
+- lib/wallaby/class_array.rb
+- lib/wallaby/class_hash.rb
+- lib/wallaby/classifier.rb
 - lib/wallaby/configuration.rb
 - lib/wallaby/configuration/features.rb
 - lib/wallaby/configuration/mapping.rb
@@ -192,7 +216,9 @@ files:
 - lib/wallaby/core.rb
 - lib/wallaby/core/version.rb
 - lib/wallaby/engine.rb
+- lib/wallaby/logger.rb
 - lib/wallaby/map.rb
+- lib/wallaby/preloader.rb
 homepage: https://github.com/wallaby-rails/wallaby-core
 licenses:
 - MIT
@@ -200,7 +226,7 @@ metadata:
   homepage_uri: https://github.com/wallaby-rails/wallaby-core
   source_code_uri: https://github.com/wallaby-rails/wallaby-core
   changelog_uri: https://github.com/wallaby-rails/wallaby-core/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -216,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: The core of Wallaby
 test_files: []

data/app/controllers/wallaby/application_controller.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-module Wallaby
-  # Like ordinary Rails application, it's the base controller that
-  # other Wallaby controllers inherit from.
-  #
-  # However, the difference is that the controller class that {Wallaby::ApplicationController} inherits from
-  # can be configured via {Wallaby::Configuration#base_controller}
-  #
-  # Here, it provides the most basic functions e.g. error handling for common 4xx HTTP status, helpers method,
-  # and URL handling.
-  class ApplicationController < configuration.base_controller
-    extend Engineable::ClassMethods
-    include Engineable
-    include SharedHelpers
-    helper ApplicationHelper
-
-    rescue_from NotFound, with: :not_found
-    rescue_from ::ActionController::ParameterMissing, with: :bad_request
-    rescue_from ::ActiveRecord::StatementInvalid, with: :unprocessable_entity
-    rescue_from NotImplemented, with: :not_implemented
-    rescue_from UnprocessableEntity, with: :unprocessable_entity
-
-    delegate(*ConfigurationHelper.instance_methods(false), :url_for, to: :helpers)
-
-    # Health check page for e.g. NewRelic
-    def healthy
-      render plain: 'healthy'
-    end
-
-    # Not found page
-    # @param exception [Exception] comes from **rescue_from**
-    def not_found(exception = nil)
-      error_rendering exception, __callee__
-    end
-
-    # Bad request page
-    # @param exception [Exception] comes from **rescue_from**
-    def bad_request(exception = nil)
-      error_rendering exception, __callee__
-    end
-
-    # Unprocessable entity page
-    # @param exception [Exception] comes from **rescue_from**
-    def unprocessable_entity(exception = nil)
-      error_rendering exception, __callee__
-    end
-
-    # Internal server error page
-    # @param exception [Exception] comes from **rescue_from**
-    def internal_server_error(exception = nil)
-      error_rendering exception, __callee__
-    end
-
-    # Not implemented
-    # @param exception [Exception] comes from **rescue_from**
-    def not_implemented(exception = nil)
-      error_rendering exception, __callee__
-    end
-
-    # {https://api.rubyonrails.org/classes/ActionController/Helpers.html#method-i-helpers helpers}
-    # exists since Rails 5.0, need to mimic this to support Rails 4.2.
-    # @see https://api.rubyonrails.org/classes/ActionController/Helpers.html#method-i-helpers
-    #   ActionController::Helpers#helpers
-    # @see https://github.com/rails/rails/blob/5-0-stable/actionpack/lib/action_controller/metal/helpers.rb#L118
-    def helpers
-      @helpers ||= defined?(super) ? super : view_context
-    end
-
-    protected
-
-    # Capture exceptions and display the error using error template.
-    # @param exception [Exception]
-    # @param symbol [Symbol] http status symbol
-    def error_rendering(exception, symbol)
-      Rails.logger.error exception
-
-      @exception = exception
-      @symbol = symbol
-      @code = Rack::Utils::SYMBOL_TO_STATUS_CODE[symbol].to_i
-      respond_with @exception, status: @code, template: ERROR_PATH, prefixes: _prefixes
-    end
-  end
-end

data/app/controllers/wallaby/secure_controller.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-module Wallaby
-  # This is the controller with only authentication logics.
-  class SecureController < ::Wallaby::ApplicationController
-    helper SecureHelper
-    helper_method :current_user
-
-    rescue_from NotAuthenticated, with: :unauthorized
-    rescue_from Forbidden, with: :forbidden
-
-    # Unauthorized page.
-    # @param exception [Exception] exception comes from `rescue_from`
-    def unauthorized(exception = nil)
-      error_rendering exception, __callee__
-    end
-
-    # Forbidden page.
-    # @param exception [Exception] exception comes from `rescue_from`
-    def forbidden(exception = nil)
-      error_rendering exception, __callee__
-    end
-
-    # @note This is a template method that can be overridden by subclasses
-    # This {current_user} method will try to looking up the actual implementation from the following
-    # places from high precedence to low:
-    #
-    # - {Wallaby::Configuration::Security#current_user}
-    # - `super`
-    # - do nothing
-    #
-    # It can be replaced completely in subclasses:
-    #
-    # ```
-    # def current_user
-    #   # NOTE: please ensure `@current_user` is assigned, for instance:
-    #   @current_user ||= User.new params.slice(:email)
-    # end
-    # ```
-    # @return [Object] a user object
-    def current_user
-      @current_user ||=
-        if security.current_user? || !defined? super
-          instance_exec(&security.current_user)
-        else
-          super
-        end
-    end
-
-    # @note This is a template method that can be overridden by subclasses
-    # This {authenticate_user!} method will try to looking up the actual implementation from the following
-    # places from high precedence to low:
-    #
-    # - {Wallaby::Configuration::Security#authenticate}
-    # - `super`
-    # - do nothing
-    #
-    # It can be replaced completely in subclasses:
-    #
-    # ```
-    # def authenticate_user!
-    #   authenticate_or_request_with_http_basic do |username, password|
-    #     username == 'too_simple' && password == 'too_naive'
-    #   end
-    # end
-    # ```
-    # @return [true] when user is authenticated successfully
-    # @raise [Wallaby::NotAuthenticated] when user fails to authenticate
-    def authenticate_user!
-      authenticated =
-        if security.authenticate? || !defined? super
-          instance_exec(&security.authenticate)
-        else
-          super
-        end
-      raise NotAuthenticated unless authenticated
-
-      true
-    end
-  end
-end

data/lib/concerns/wallaby/rails_overridden_methods.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Wallaby
-  # This is a collection of the helper methods that overrides the rails methods
-  module RailsOverriddenMethods
-    protected
-
-    # Override {https://github.com/rails/rails/blob/master/actionview/lib/action_view/view_paths.rb
-    # ActionView::ViewPaths::ClassMethods#_prefixes} to extend the prefixes for **ActionView::ViewPaths** to look up
-    # in below precedence from high to low:
-    #
-    # - :mounted_path/:resources_name/:action_prefix (e.g. `admin/products/index`)
-    # - :mounted_path/:resources_name (e.g. `admin/products`)
-    # - :controller_path/:action_prefix
-    # - :controller_path
-    # - :parent_controller_path/:action_prefix
-    # - :parent_controller_path
-    # - :more_parent_controller_path/:action_prefix
-    # - :more_parent_controller_path
-    # - :theme_name/:action_prefix
-    # - :theme_name
-    # - wallaby/resources/:action_prefix
-    # - wallaby/resources
-    # @return [Array<String>]
-    def _prefixes
-      @_prefixes ||= PrefixesBuilder.build(
-        origin_prefixes: super,
-        theme_name: current_theme_name,
-        resources_name: current_resources_name,
-        script_name: request.env[SCRIPT_NAME],
-        action_name: params[:action]
-      )
-    end
-
-    # Override to provide support for cell lookup
-    # @return [Wallaby::CustomLookupContext]
-    def lookup_context
-      @_lookup_context ||= # rubocop:disable Naming/MemoizedInstanceVariableName
-        CustomLookupContext.normalize(super, prefixes: _prefixes)
-    end
-  end
-end

data/lib/concerns/wallaby/themeable.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Wallaby
-  # Theme related methods
-  module Themeable
-    # Configurable attributes
-    module ClassMethods
-      # @!attribute [w] theme_name
-      def theme_name=(theme_name)
-        layout theme_name
-        @theme_name = theme_name
-      end
-
-      # @!attribute [r] theme_name
-      # The theme name is used to apply a set of frontend (html/css/javascript) implementation.
-      #
-      # When theme name is set to e.g. `custom_theme`, the following changes will be made:
-      #
-      # - layout will be set to the same name `custom_theme`
-      # - it will be added to the partial lookup prefixes right on top of `wallaby/resources` prefix.
-      #
-      # Once theme name is set, all its controller subclasses will inherit the same theme name
-      # @example To set an theme name:
-      #   class Admin::ApplicationController < Wallaby::ResourcesController
-      #     self.theme_name = 'admin_theme'
-      #   end
-      # @return [String, Symbol, nil] theme name
-      # @since 5.2.0
-      def theme_name
-        @theme_name ||= ModuleUtils.try_to superclass, :theme_name
-      end
-    end
-
-    # @return [String, Symbol, nil] theme name
-    # @since 5.2.0
-    def current_theme_name
-      controller_to_get __callee__, :theme_name
-    end
-  end
-end

data/lib/paginators/wallaby/resource_paginator.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Wallaby
-  # Resource paginator
-  class ResourcePaginator < ModelPaginator
-    base_class!
-
-    def self.inherited(_sub_class)
-      Utils.deprecate 'deprecation.resource_paginator_inheirtance', caller: caller
-    end
-  end
-end