wallaby-core 0.2.11 → 0.3.0.beta1

data/lib/wallaby/configuration/security.rb

@@ -2,99 +2,107 @@
 
 module Wallaby
   class Configuration
-    # Security configuration
-    # TODO: remove this from 6.2
+    # @deprecated
     class Security
       # Default block to return nil for current user
-      DEFAULT_CURRENT_USER = -> { nil }
+      DEFAULT_CURRENT_USER = -> {}
       # Default block to return nil
       DEFAULT_AUTHENTICATE = -> { true }
 
-      # @!attribute logout_path
-      # To globally configure the logout path.
-      #
-      # Wallaby does not implement any authentication (e.g. login/logout), therefore, logout path will be required
-      # so that Wallaby knows where to navigate the user to when user clicks the logout button.
-      #
-      # But once it detects `Devise`, it will use the path that Devise uses without the need of configuration.
-      # @example To update the logout path in `config/initializers/wallaby.rb`
-      #   Wallaby.config do |config|
-      #     config.security.logout_path = 'logout_path'
-      #   end
-      # @since wallaby-5.1.4
-      attr_accessor :logout_path
-
-      # @!attribute logout_method
-      # To globally configure the logout HTTP method.
-      #
-      # Wallaby does not implement any authentication (e.g. login/logout), therefore, logout method will be required
-      # so that Wallaby knows how navigate the user via what HTTP method when user clicks the logout button.
-      #
-      # But once it detects `Devise`, it will use the HTTP method that Devise uses without the need of configuration.
-      # @example To update the logout method in `config/initializers/wallaby.rb`
-      #   Wallaby.config do |config|
-      #     config.security.logout_method = 'post'
-      #   end
-      # @since wallaby-5.1.4
-      attr_accessor :logout_method
-
-      # @!attribute email_method
-      # To globally configure the method on {#current_user} to retrieve email address.
-      #
-      # If no configuration is given, it will attempt to call `email` on {#current_user}.
-      # @example To update the email method in `config/initializers/wallaby.rb`
-      #   Wallaby.config do |config|
-      #     config.security.email_method = 'email_address'
-      #   end
-      # @since wallaby-5.1.4
-      attr_accessor :email_method
-
-      # To globally configure how to get user object.
-      # @example To update how to get the current user object in `config/initializers/wallaby.rb`
-      #   Wallaby.config do |config|
-      #     config.security.current_user do
-      #       User.find_by_email session[:user_email]
-      #     end
-      #   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
-          @current_user ||= DEFAULT_CURRENT_USER
-        end
+      # @deprecated
+      def logout_path
+        Deprecator.alert 'config.security.logout_path', from: '0.3.0', alternative: <<~INSTRUCTION
+          Please use controller_class.logout_path instead.
+        INSTRUCTION
       end
 
-      # Check if {#current_user} configuration is set.
-      # @return [Boolean]
+      # @deprecated
+      def logout_path=(_logout_path)
+        Deprecator.alert 'config.security.logout_path=', from: '0.3.0', alternative: <<~INSTRUCTION
+          Please use #logout_path= from the controller instead, for example:
+
+            class Admin::ApplicationController < Wallaby::ResourcesController
+              self.logout_path = 'destroy_admin_user_session_path'
+            end
+        INSTRUCTION
+      end
+
+      # @deprecated
+      def logout_method
+        Deprecator.alert 'config.security.logout_method', from: '0.3.0', alternative: <<~INSTRUCTION
+          Please use controller_class.logout_method instead.
+        INSTRUCTION
+      end
+
+      # @deprecated
+      def logout_method=(_logout_method)
+        Deprecator.alert 'config.security.logout_method=', from: '0.3.0', alternative: <<~INSTRUCTION
+          Please use #logout_method= from the controller instead, for example:
+
+          class Admin::ApplicationController < Wallaby::ResourcesController
+            self.logout_method = 'put'
+          end
+        INSTRUCTION
+      end
+
+      # @deprecated
+      def email_method
+        Deprecator.alert 'config.security.email_method', from: '0.3.0', alternative: <<~INSTRUCTION
+          Please use controller_class.email_method instead.
+        INSTRUCTION
+      end
+
+      # @deprecated
+      def email_method=(_email_method)
+        Deprecator.alert 'config.security.email_method=', from: '0.3.0', alternative: <<~INSTRUCTION
+          Please use #email_method= from the controller instead, for example:
+
+            class Admin::ApplicationController < Wallaby::ResourcesController
+              self.email_method = 'email_address'
+            end
+        INSTRUCTION
+      end
+
+      # @deprecated
+      def current_user
+        Deprecator.alert 'config.security.current_user', from: '0.3.0', alternative: <<~INSTRUCTION
+          Please change #wallaby_user from the controller instead, for example:
+
+            class Admin::ApplicationController < Wallaby::ResourcesController
+              def wallaby_user
+                User.find_by_email session[:user_email]
+              end
+            end
+        INSTRUCTION
+      end
+
+      # @deprecated
       def current_user?
-        current_user != DEFAULT_CURRENT_USER
+        Deprecator.alert 'config.security.current_user?', from: '0.3.0', alternative: <<~INSTRUCTION
+          Please use controller#wallaby_user instead.
+        INSTRUCTION
       end
 
-      # To globally configure how to authenicate a user.
-      # @example
-      #   Wallaby.config do |config|
-      #     config.security.authenticate do
-      #       authenticate_or_request_with_http_basic do |username, password|
-      #         username == 'too_simple' && password == 'too_naive'
-      #       end
-      #     end
-      #   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
-          @authenticate ||= DEFAULT_AUTHENTICATE
-        end
+      # @deprecated
+      def authenticate
+        Deprecator.alert 'config.security.authenticate', from: '0.3.0', alternative: <<~INSTRUCTION
+          Please change #authenticate_wallaby_user! from the controller instead, for example:
+
+            class Admin::ApplicationController < Wallaby::ResourcesController
+              def authenticate_wallaby_user!
+                authenticate_or_request_with_http_basic do |username, password|
+                  username == 'too_simple' && password == 'too_naive'
+                end
+              end
+            end
+        INSTRUCTION
       end
 
-      # Check if {#authenticate} configuration is set.
-      # @return [Boolean]
+      # @deprecated
       def authenticate?
-        authenticate != DEFAULT_AUTHENTICATE
+        Deprecator.alert 'config.security.authenicate?', from: '0.3.0', alternative: <<~INSTRUCTION
+          Please use controller#authenticate_wallaby_user! instead.
+        INSTRUCTION
       end
     end
   end

data/lib/wallaby/configuration/sorting.rb

@@ -2,26 +2,24 @@
 
 module Wallaby
   class Configuration
-    # Sorting global configuration
-    # @since wallaby-5.2.0
+    # @deprecated
     class Sorting
-      # @!attribute [w] strategy
-      attr_writer :strategy
+      # @deprecated
+      def strategy=(_strategy)
+        Deprecator.alert 'config.sorting.strategy=', from: '0.3.0', alternative: <<~INSTRUCTION
+          Please set #sorting_strategy= from the controller instead, for example:
 
-      # @!attribute [r] strategy
-      # To globally configure which strategy to use for sorting. Options are
-      #
-      #   - `:multiple`: support multiple columns sorting
-      #   - `:single`: support single column sorting
-      #
-      # By default, strategy is `:multiple`.
-      # @example To enable turbolinks:
-      #   Wallaby.config do |config|
-      #     config.sorting.strategy = :single
-      #   end
-      # @return [Symbol, String]
+            class Admin::ApplicationController < Wallaby::ResourcesController
+              self.sorting_strategy = :multiple
+            end
+        INSTRUCTION
+      end
+
+      # @deprecated
       def strategy
-        @strategy ||= :multiple
+        Deprecator.alert 'config.sorting.strategy', from: '0.3.0', alternative: <<~INSTRUCTION
+          Please use controller_class.sorting_strategy instead.
+        INSTRUCTION
       end
     end
   end

data/lib/wallaby/configuration.rb

@@ -6,21 +6,27 @@ module Wallaby
   class Configuration
     include Classifier
 
+    # @!attribute [w] logger
+    attr_writer :logger
+
+    # @!attribute [r] logger
+    def logger
+      @logger ||= Rails.logger
+    end
+
     # @!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) }
+          next paths if paths.all?(String)
 
-          raise(
-            ArgumentError,
-            'Please provide a list of string paths, e.g. `["app/models", "app/core"]`'
-          )
+          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.
+    # To configure the model folders that {Preloader} needs to load before everything else.
+    # Default is `%w(app/models)`
     # @example To set the model paths
     #   Wallaby.config do |config|
     #     config.model_paths = ["app/models", "app/core"]
@@ -28,18 +34,18 @@ module Wallaby
     # @return [Array<String>] model paths
     # @since 0.2.2
     def model_paths
-      @model_paths ||= %w(app/models)
+      @model_paths ||= %w[app/models]
     end
 
     # @!attribute [w] base_controller
     def base_controller=(base_controller)
-      @base_controller = to_class_name base_controller
+      @base_controller = class_name_of base_controller
     end
 
     # @!attribute [r] base_controller
-    # To globally configure the base controller class that {Wallaby::ApplicationController} should inherit from.
+    # To globally configure the base controller class that {ResourcesController} should inherit from.
     #
-    # If no configuration is given, {Wallaby::ApplicationController} defaults to inherit from `::ApplicationController`
+    # If no configuration is given, {ResourcesController} defaults to inherit from **::ApplicationController**
     # from the host Rails app.
     # @example To update base controller to `CoreController` in `config/initializers/wallaby.rb`
     #   Wallaby.config do |config|
@@ -50,9 +56,34 @@ module Wallaby
       to_class @base_controller ||= '::ApplicationController'
     end
 
-    # @return [Wallaby::Configuration::Models] models configuration for custom mode
+    # @!attribute [w] resources_controller
+    def resources_controller=(resources_controller)
+      @resources_controller = class_name_of resources_controller
+    end
+
+    # @!attribute [r] resources_controller
+    # To globally configure the application controller class that {Engine} should use.
+    #
+    # If no configuration is given, {Engine} defaults to use **Admin::ApplicationController** or
+    # {Wallaby::ResourcesController}
+    # from the host Rails app.
+    # @example To update base controller to `CoreController` in `config/initializers/wallaby.rb`
+    #   Wallaby.config do |config|
+    #     config.resources_controller = ::CoreController
+    #   end
+    # @return [Class] base controller class
+    # @since 0.2.3
+    def resources_controller
+      to_class(
+        @resources_controller ||=
+          (to_class('Admin::ApplicationController') && \
+            'Admin::ApplicationController') || 'Wallaby::ResourcesController'
+      )
+    end
+
+    # @return [Configuration::Models] models configuration for custom mode
     def custom_models
-      @custom_models ||= Models.new
+      @custom_models ||= ClassArray.new
     end
 
     # To globally configure the models for custom mode.
@@ -62,12 +93,14 @@ module Wallaby
     #   end
     # @param models [Array<[Class, String]>] a list of model classes/name strings
     def custom_models=(models)
-      custom_models.set models
+      @custom_models = ClassArray.new models.flatten
     end
 
-    # @return [Wallaby::Configuration::Models] models configuration
+    # @return [Configuration::Models] models configuration
     def models
-      @models ||= Models.new
+      Deprecator.alert 'config.models.presence', from: '0.3.0', alternative: <<~INSTRUCTION
+        Please use controller_class.models instead.
+      INSTRUCTION
     end
 
     # To globally configure the models that Wallaby should handle.
@@ -80,34 +113,36 @@ module Wallaby
       self.models.set models
     end
 
-    # @return [Wallaby::Configuration::Security] security configuration
+    # @return [Configuration::Security] security configuration
     def security
       @security ||= Security.new
     end
 
-    # @return [Wallaby::Configuration::Mapping] mapping configuration
+    # @return [Configuration::Mapping] mapping configuration
     def mapping
       @mapping ||= Mapping.new
     end
 
-    # @return [Wallaby::Configuration::Metadata] metadata configuration
+    # @return [Configuration::Metadata] metadata configuration
     def metadata
       @metadata ||= Metadata.new
     end
 
-    # @return [Wallaby::Configuration::Pagination] pagination configuration
+    # @return [Configuration::Pagination] pagination configuration
     def pagination
       @pagination ||= Pagination.new
     end
 
-    # @return [Wallaby::Configuration::Features] features configuration
+    # @return [Configuration::Features] features configuration
     def features
       @features ||= Features.new
     end
 
-    # @return [Wallaby::Configuration::Sorting] sorting configuration
+    # @return [Configuration::Sorting] sorting configuration
     def sorting
-      @sorting ||= Sorting.new
+      Deprecator.alert 'config.sorting.strategy', from: '0.3.0', alternative: <<~INSTRUCTION
+        Please use controller_class.sorting_strategy instead.
+      INSTRUCTION
     end
 
     # Clear all configurations
@@ -116,7 +151,7 @@ module Wallaby
     end
   end
 
-  # @return [Wallaby::Configuration]
+  # @return [Configuration]
   def self.configuration
     @configuration ||= Configuration.new
   end

data/lib/wallaby/constants.rb

@@ -9,17 +9,20 @@ module Wallaby
   COLONS = '::' # :nodoc:
   COMMA = ',' # :nodoc:
   DOT = '.' # :nodoc:
+  HASH = '#' # :nodoc:
+  HYPHEN = '-' # :nodoc:
   UNDERSCORE = '_' # :nodoc:
   PCT = '%' # :nodoc:
 
-  # Default page size for {Wallaby::Configuration::Pagination#page_size}
+  # Default page size for {Configuration::Pagination#page_size}
   DEFAULT_PAGE_SIZE = 20
-  # Default max charactoers to display for {Wallaby::Configuration::Metadata#max}
+  # Default max charactoers to display for {Configuration::Metadata#max}
   DEFAULT_MAX = 20
   # Default provider name for authorizer sorting.
   DEFAULT_PROVIDER = 'default'
 
-  ERRORS = %i(
+  # HTTP error types that Wallaby handles
+  ERRORS = %i[
     bad_request
     forbidden
     internal_server_error
@@ -27,21 +30,26 @@ module Wallaby
     not_implemented
     unauthorized
     unprocessable_entity
-  ).freeze
-  MODEL_ACTIONS = %i(index new create show edit update destroy).freeze
+  ].freeze
+  MODEL_ACTIONS = %i[index new create show edit update destroy].freeze
   FORM_ACTIONS = { new: 'form', create: 'form', edit: 'form', update: 'form' }.with_indifferent_access.freeze
-  SAVE_ACTIONS = %w(create update).freeze
-  NON_FIND_ACTIONS = %w(index new create).freeze
+  SAVE_ACTIONS = %w[create update].freeze
 
-  SCRIPT_NAME = 'SCRIPT_NAME'
-  PATH_INFO = 'PATH_INFO'
+  SCRIPT_NAME = 'SCRIPT_NAME' # :nodoc:
+  PATH_INFO = 'PATH_INFO' # :nodoc:
   # Page size list
-  # @see Wallaby::Configuration::Pagination#page_size
+  # @see Configuration::Pagination#page_size
   PERS = [10, 20, 50, 100].freeze
-  CSV = 'csv'
-  WILDCARD = 'QUERY'
-  TITLE_NAMES = %w(name title string text).freeze
+  CSV = 'csv' # :nodoc:
+  WILDCARD = 'QUERY' # :nodoc:
 
   # A constant of error path for error handling
   ERROR_PATH = 'error'
+
+  CONTROLLER = 'Controller' # :nodoc:
+  DECORATOR = 'Decorator' # :nodoc:
+  SERVICER = 'Servicer' # :nodoc:
+  AUTHORIZER = 'Authorizer' # :nodoc:
+  PAGINATOR = 'Paginator' # :nodoc:
+  FINDER = 'Finder' # :nodoc:
 end

data/lib/wallaby/core/version.rb

@@ -2,6 +2,6 @@
 
 module Wallaby
   module Core
-    VERSION = '0.2.11' # :nodoc:
+    VERSION = '0.3.0.beta1' # :nodoc:
   end
 end

data/lib/wallaby/core.rb

@@ -7,8 +7,10 @@ require 'wallaby/view'
 
 require 'wallaby/core/version'
 require 'wallaby/constants'
+require 'wallaby/deprecator'
 require 'wallaby/logger'
 require 'wallaby/preloader'
+require 'wallaby/guesser'
 require 'wallaby/engine'
 
 # Global class attributes that holds the most important configuration/information
@@ -29,34 +31,39 @@ require 'wallaby/map'
 require 'support/action_dispatch/routing/mapper'
 
 require 'routes/wallaby/resources_router'
+require 'routes/wallaby/engines/base_route'
+require 'routes/wallaby/engines/engine_route'
+require 'routes/wallaby/engines/custom_app_route'
+require 'fields/wallaby/all_fields'
 require 'tree/wallaby/node'
 require 'parsers/wallaby/parser'
 
+require 'utils/wallaby/inflector'
 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/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/configurable'
+require 'concerns/wallaby/urlable'
+
 require 'concerns/wallaby/decoratable'
-require 'concerns/wallaby/defaultable'
 require 'concerns/wallaby/engineable'
 require 'concerns/wallaby/fieldable'
 require 'concerns/wallaby/paginatable'
 require 'concerns/wallaby/prefixable'
 require 'concerns/wallaby/resourcable'
 require 'concerns/wallaby/servicable'
-require 'concerns/wallaby/shared_helpers'
 
+require 'concerns/wallaby/application_concern'
+require 'concerns/wallaby/authentication_concern'
+require 'concerns/wallaby/resources_concern'
+
+# These are the designed interfaces if you want to get any ORMs to work with Wallaby
 require 'interfaces/wallaby/mode'
 require 'interfaces/wallaby/model_decorator'
 require 'interfaces/wallaby/model_finder'
@@ -70,6 +77,7 @@ require 'errors/wallaby/class_not_found'
 require 'errors/wallaby/invalid_error'
 require 'errors/wallaby/not_implemented'
 require 'errors/wallaby/not_found'
+require 'errors/wallaby/method_removed'
 require 'errors/wallaby/model_not_found'
 require 'errors/wallaby/resource_not_found'
 
@@ -87,13 +95,23 @@ require 'authorizers/wallaby/pundit_authorization_provider'
 
 require 'forms/wallaby/form_builder'
 
+# These are the service classes responsible
+# for finding out the controller/decorator/authorizer/servicer/paginator
+require 'services/wallaby/class_finder'
+require 'services/wallaby/controller_finder'
+require 'services/wallaby/decorator_finder'
+require 'services/wallaby/authorizer_finder'
+require 'services/wallaby/servicer_finder'
+require 'services/wallaby/paginator_finder'
+require 'services/wallaby/default_models_excluder'
+require 'services/wallaby/fields_regulator'
+
 require 'services/wallaby/map/mode_mapper'
-require 'services/wallaby/map/model_class_collector'
 require 'services/wallaby/map/model_class_mapper'
+require 'services/wallaby/model_class_filter'
 require 'services/wallaby/prefixes_builder'
 require 'services/wallaby/engine_name_finder'
 require 'services/wallaby/engine_url_for'
-require 'services/wallaby/type_renderer'
 require 'services/wallaby/link_options_normalizer'
 require 'services/wallaby/sorting/hash_builder'
 require 'services/wallaby/sorting/next_builder'
@@ -120,3 +138,9 @@ require 'adaptors/wallaby/custom/model_finder'
 require 'adaptors/wallaby/custom/model_decorator'
 require 'adaptors/wallaby/custom/model_pagination_provider'
 require 'adaptors/wallaby/custom/model_service_provider'
+
+module Wallaby
+  # Core module that can be included by controller
+  module Core
+  end
+end

data/lib/wallaby/deprecator.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # Deprecation log for methods
+  class Deprecator
+    include ActiveModel::Model
+
+    # @!attribute method_instance
+    # @return [Method]
+    attr_accessor :method_instance
+    # @!attribute from
+    # @return [String]
+    attr_accessor :from
+    # @!attribute mod
+    # @return [Class]
+    attr_accessor :mod
+    # @!attribute alternative
+    # @return [Method]
+    attr_accessor :alternative
+
+    # Log an warning deprecation message or raise {MethodRemoved} when the given method is obsolete.
+    # @param method_instance [Method] deprecated/obsolete method
+    # @param from [String] from/since version
+    # @param mod [Class] class name which has `VERSION` constants
+    # @param alternative [Method] method to replace the deprecated/obsolete one
+    # @see #alert
+    def self.alert(method_instance, from:, mod: Core, alternative: nil)
+      new(
+        method_instance: method_instance, from: from, mod: mod, alternative: alternative
+      ).alert
+    end
+
+    # @raise [MethodRemoved] when given method is obsolete
+    def alert
+      # if current version is larger than from version
+      already = Gem::Version.new(mod_version) >= Gem::Version.new(from)
+      raise MethodRemoved, obsolete_message if already
+
+      Logger.warn deprecated_message, sourcing: 2
+    end
+
+    protected
+
+    def obsolete_message
+      "ERROR: #{full method_instance} is removed since #{mod_name} #{from}. #{alternative_message}"
+    end
+
+    def deprecated_message
+      "DEPRECATED: #{full method_instance} will be removed from #{mod_name} #{from}. #{alternative_message}"
+    end
+
+    def alternative_message
+      return "Please use #{full alternative} instead." if alternative.is_a? Method
+
+      alternative.to_s
+    end
+
+    def mod_name
+      return mod unless mod.is_a? Module
+
+      mod.name.underscore.gsub SLASH, HYPHEN
+    end
+
+    def mod_version
+      return mod unless mod.is_a? Module
+
+      mod::VERSION
+    end
+
+    # @param method_instance [Method]
+    # @return [String] `Class.class_method` or `Class#instance_method`
+    def full(method_instance)
+      return method_instance unless method_instance.is_a? Method
+
+      owner = method_instance.owner
+      is_klass_method = owner.singleton_class?
+      klass = is_klass_method ? owner.to_s[8..-2] : owner.name
+      "#{klass}#{is_klass_method ? DOT : HASH}#{method_instance.name}"
+    end
+  end
+end

data/lib/wallaby/engine.rb

@@ -5,27 +5,10 @@ module Wallaby
   class Engine < ::Rails::Engine
     initializer 'wallaby.development.reload' do |_|
       # NOTE: Rails reload! will hit here
-      # @see https://rmosolgo.github.io/ruby/rails/2017/04/12/watching-files-during-rails-development.html
+      # @see http://rmosolgo.github.io/blog/2017/04/12/watching-files-during-rails-development/
       config.to_prepare do
-        Map.clear
-        Preloader.clear
+        Map.clear if Rails.env.development? || Rails.configuration.eager_load
       end
     end
-
-    config.before_eager_load do
-      Logger.debug 'Preload all model files before everything else.', sourcing: false
-      Preloader.require_models
-    end
-
-    config.after_initialize do
-      # Preload will be postponed to Map when `cache_classes` is set to false
-      next unless Rails.configuration.cache_classes
-      # Models are preloaded in `before_eager_load` block,
-      # therefore, it's not essential to preload all files Since Rails will do it
-      next if Rails.configuration.eager_load
-
-      Logger.debug 'Preload all files in model first and non-model last order', sourcing: false
-      Preloader.require_all
-    end
   end
 end