wallaby-core 0.1.0

data/lib/utils/wallaby/utils.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # Utils
+  module Utils
+    # Display deprecate message including the line where it's used
+    # @param key [String]
+    # @param caller [String] the line where it's called
+    # @param options [Hash]
+    def self.deprecate(key, caller:, options: {})
+      warn I18n.t(key, options.merge(from: caller[0]))
+    end
+
+    # @deprecated Use {Wallaby::FilterUtils.filter_name_by} instead. It will be removed from 5.3.*
+    def self.find_filter_name(filter_name, filters)
+      deprecate 'deprecation.find_filter_name', caller: caller
+      FilterUtils.filter_name_by filter_name, filters
+    end
+
+    # @see http://stackoverflow.com/a/8710663/1326499
+    # @param object [Object]
+    # @return [Object] a clone object
+    def self.clone(object)
+      ::Marshal.load(::Marshal.dump(object))
+    end
+  end
+end

data/lib/wallaby/configuration.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# Wallaby
+module Wallaby
+  # Global configuration
+  class Configuration
+    # @!attribute [w] base_controller
+    attr_writer :base_controller
+
+    # @!attribute [r] base_controller
+    # To globally configure the base controller class that {Wallaby::ApplicationController} should inherit from.
+    #
+    # If no configuration is given, {Wallaby::ApplicationController} 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|
+    #     config.base_controller = ::CoreController
+    #   end
+    # @return [Class] base controller class
+    def base_controller
+      @base_controller ||= ::ApplicationController
+    end
+
+    # @return [Wallaby::Configuration::Models] models configuration for custom mode
+    def custom_models
+      @custom_models ||= Models.new
+    end
+
+    # To globally configure the models for custom mode.
+    # @example To update the model classes in `config/initializers/wallaby.rb`
+    #   Wallaby.config do |config|
+    #     config.custom_models = [Product, Order]
+    #   end
+    # @param models [Array<[Class, String]>] a list of model classes/name strings
+    def custom_models=(models)
+      custom_models.set models
+    end
+
+    # @return [Wallaby::Configuration::Models] models configuration
+    def models
+      @models ||= Models.new
+    end
+
+    # To globally configure the models that Wallaby should handle.
+    # @example To update the model classes in `config/initializers/wallaby.rb`
+    #   Wallaby.config do |config|
+    #     config.models = [Product, Order]
+    #   end
+    # @param models [Array<[Class, String]>] a list of model classes/name strings
+    def models=(models)
+      self.models.set models
+    end
+
+    # @return [Wallaby::Configuration::Security] security configuration
+    def security
+      @security ||= Security.new
+    end
+
+    # @return [Wallaby::Configuration::Mapping] mapping configuration
+    def mapping
+      @mapping ||= Mapping.new
+    end
+
+    # @return [Wallaby::Configuration::Metadata] metadata configuration
+    def metadata
+      @metadata ||= Metadata.new
+    end
+
+    # @return [Wallaby::Configuration::Pagination] pagination configuration
+    def pagination
+      @pagination ||= Pagination.new
+    end
+
+    # @return [Wallaby::Configuration::Features] features configuration
+    def features
+      @features ||= Features.new
+    end
+
+    # @return [Wallaby::Configuration::Sorting] sorting configuration
+    def sorting
+      @sorting ||= Sorting.new
+    end
+
+    # Clear all configurations
+    def clear
+      instance_variables.each { |name| instance_variable_set name, nil }
+    end
+  end
+
+  # @return [Wallaby::Configuration]
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # To config settings using a block
+  # @example
+  #   Wallaby.config do |c|
+  #     c.pagination.page_size = 20
+  #   end
+  def self.config
+    yield configuration
+  end
+end

data/lib/wallaby/configuration/features.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Configuration
+    # Features global configuration
+    class Features
+      # @!attribute [w] turbolinks_enabled
+      attr_writer :turbolinks_enabled
+
+      # @!attribute [r] turbolinks_enabled
+      # To globally configure whether to use turbolinks or not.
+      #
+      # By default, turbolinks is disabled.
+      # @example To enable turbolinks:
+      #   Wallaby.config do |config|
+      #     config.features.turbolinks_enabled = true
+      #   end
+      # @return [Boolean] a feture flag of turbolinks, default to false.
+      def turbolinks_enabled
+        @turbolinks_enabled ||= false
+      end
+    end
+  end
+end

data/lib/wallaby/configuration/mapping.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Configuration
+    # Configuration used in {Wallaby::Map}
+    # @since 5.1.6
+    class Mapping
+      # @!attribute [w] resources_controller
+      attr_writer :resources_controller
+
+      # @!attribute [r] resources_controller
+      # To globally configure the resources controller.
+      #
+      # If no configuration is given, Wallaby will look up from the following controller classes
+      # and use the first available one:
+      #
+      # - ::Admin::ApplicationController (only when it inherits from {Wallaby::ResourcesController})
+      # - {Wallaby::ResourcesController}
+      # @example To update the resources controller to `GlobalResourcesController` in `config/initializers/wallaby.rb`
+      #   Wallaby.config do |config|
+      #     config.mapping.resources_controller = ::GlobalResourcesController
+      #   end
+      # @return [Class] resources controller class
+      # @since 5.1.6
+      def resources_controller
+        @resources_controller ||=
+          defined?(::Admin::ApplicationController) \
+            && ::Admin::ApplicationController < ::Wallaby::ResourcesController \
+            && ::Admin::ApplicationController
+        @resources_controller ||= ResourcesController
+      end
+
+      # @!attribute [w] resource_decorator
+      attr_writer :resource_decorator
+
+      # @!attribute [r] resource_decorator
+      # To globally configure the resource decorator.
+      #
+      # If no configuration is given, Wallaby will look up from the following decorator classes
+      # and use the first available one:
+      #
+      # - ::Admin::ApplicationDecorator (only when it inherits from {Wallaby::ResourceDecorator})
+      # - {Wallaby::ResourceDecorator}
+      # @example To update the resource decorator to `GlobalResourceDecorator` in `config/initializers/wallaby.rb`
+      #   Wallaby.config do |config|
+      #     config.mapping.resource_decorator = ::GlobalResourceDecorator
+      #   end
+      # @return [Class] resource decorator class
+      # @since 5.1.6
+      def resource_decorator
+        @resource_decorator ||=
+          defined?(::Admin::ApplicationDecorator) \
+            && ::Admin::ApplicationDecorator < ::Wallaby::ResourceDecorator \
+            && ::Admin::ApplicationDecorator
+        @resource_decorator ||= ResourceDecorator
+      end
+
+      # @!attribute [w] model_servicer
+      attr_writer :model_servicer
+
+      # @!attribute [r] model_servicer
+      # To globally configure the model servicer.
+      #
+      # If no configuration is given, Wallaby will look up from the following servicer classes
+      # and use the first available one:
+      #
+      # - ::Admin::ApplicationServicer (only when it inherits from {Wallaby::ModelServicer})
+      # - {Wallaby::ModelServicer}
+      # @example To update the model servicer to `GlobalModelServicer` in `config/initializers/wallaby.rb`
+      #   Wallaby.config do |config|
+      #     config.mapping.model_servicer = ::GlobalModelServicer
+      #   end
+      # @return [Class] model servicer class
+      # @since 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
+      end
+
+      # @!attribute [w] model_authorizer
+      attr_writer :model_authorizer
+
+      # @!attribute [r] model_authorizer
+      # To globally configure the model authorizer.
+      #
+      # If no configuration is given, Wallaby will look up from the following authorizer classes
+      # and use the first available one:
+      #
+      # - ::Admin::ApplicationAuthorizer (only when it inherits from {Wallaby::ModelAuthorizer})
+      # - {Wallaby::ModelAuthorizer}
+      # @example To update the model authorizer to `GlobalModelAuthorizer` in `config/initializers/wallaby.rb`
+      #   Wallaby.config do |config|
+      #     config.mapping.model_authorizer = ::GlobalModelAuthorizer
+      #   end
+      # @return [Class] model authorizer class
+      # @since 5.2.0
+      def model_authorizer
+        @model_authorizer ||=
+          defined?(::Admin::ApplicationAuthorizer) \
+            && ::Admin::ApplicationAuthorizer < ::Wallaby::ModelAuthorizer \
+            && ::Admin::ApplicationAuthorizer
+        @model_authorizer ||= ModelAuthorizer
+      end
+
+      # @!attribute [w] model_paginator
+      attr_writer :model_paginator
+
+      # @!attribute [r] model_paginator
+      # To globally configure the resource paginator.
+      #
+      # If no configuration is given, Wallaby will look up from the following paginator classes
+      # and use the first available one:
+      #
+      # - ::Admin::ApplicationPaginator (only when it inherits from {Wallaby::ModelPaginator})
+      # - {Wallaby::ModelPaginator}
+      # @example To update the resource paginator to `GlobalModelPaginator` in `config/initializers/wallaby.rb`
+      #   Wallaby.config do |config|
+      #     config.mapping.model_paginator = ::GlobalModelPaginator
+      #   end
+      # @return [Class] resource paginator class
+      # @since 5.2.0
+      def model_paginator
+        @model_paginator ||=
+          defined?(::Admin::ApplicationPaginator) \
+            && ::Admin::ApplicationPaginator < ::Wallaby::ModelPaginator \
+            && ::Admin::ApplicationPaginator
+        @model_paginator ||= ModelPaginator
+      end
+    end
+  end
+end

data/lib/wallaby/configuration/metadata.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Configuration
+    # Metadata configuration
+    class Metadata
+      # @!attribute [w] max
+      attr_writer :max
+
+      # @!attribute [r] resources_controller
+      # To globally configure max number of characters to truncate.
+      # @example To update max number of characters to truncate to 50 in `config/initializers/wallaby.rb`
+      #   Wallaby.config do |config|
+      #     config.metadata.max = 50
+      #   end
+      # @return [Integer] max number of characters to truncate, default to 20
+      # @since 5.1.6
+      def max
+        @max ||= DEFAULT_MAX
+      end
+    end
+  end
+end

data/lib/wallaby/configuration/models.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+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.
+    # Models configuration to specify the model classes that Wallaby should handle.
+    class Models
+      # @note If models are whitelisted, models exclusion will NOT be applied.
+      # To globally configure what model classes that Wallaby should handle.
+      # @example To whitelist the model classes in `config/initializers/wallaby.rb`
+      #   Wallaby.config do |config|
+      #     config.models = [Product, Order]
+      #   end
+      # @param models [Array<Class, String>]
+      def set(*models)
+        @models = Array(models).flatten.map(&:to_s)
+      end
+
+      # @return [Array<Class>] the models configured
+      def presence
+        (@models ||= []).map(&:constantize)
+      end
+
+      # @note If models are whitelisted using {#set}, models exclusion will NOT be applied.
+      # To globally configure what model classes to exclude.
+      # @example To exclude models in `config/initializers/wallaby.rb`
+      #   Wallaby.config do |config|
+      #     config.models.exclude Product, Order
+      #   end
+      # @param models [Array<Class, String>]
+      def exclude(*models)
+        @excludes = Array(models).flatten.map(&:to_s)
+      end
+
+      # @return [Array<Class>] the list of models to exclude.
+      #   By default, `ActiveRecord::SchemaMigration` is excluded.
+      def excludes
+        (@excludes ||= ['ActiveRecord::SchemaMigration']).map(&:constantize)
+      end
+    end
+  end
+end

data/lib/wallaby/configuration/pagination.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Configuration
+    # Pagination configuration
+    class Pagination
+      # @!attribute [w] page_size
+      attr_writer :page_size
+
+      # @!attribute [r] page_size
+      # To globally configure the page size for pagination.
+      #
+      # Page size can be one of the following values:
+      #
+      # - 10
+      # - 20
+      # - 50
+      # - 100
+      # @see Wallaby::PERS
+      # @example To update the page size in `config/initializers/wallaby.rb`
+      #   Wallaby.config do |config|
+      #     config.pagination.page_size = 50
+      #   end
+      # @return [Integer] page size, default to 20
+      def page_size
+        @page_size ||= DEFAULT_PAGE_SIZE
+      end
+    end
+  end
+end

data/lib/wallaby/configuration/security.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Configuration
+    # Security configuration
+    class Security
+      # Default block to return nil for current user
+      DEFAULT_CURRENT_USER = -> { nil }
+      # 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 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 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 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)
+        if block_given?
+          @current_user = block
+        else
+          @current_user ||= DEFAULT_CURRENT_USER
+        end
+      end
+
+      # Check if {#current_user} configuration is set.
+      # @return [Boolean]
+      def current_user?
+        current_user != DEFAULT_CURRENT_USER
+      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)
+        if block_given?
+          @authenticate = block
+        else
+          @authenticate ||= DEFAULT_AUTHENTICATE
+        end
+      end
+
+      # Check if {#authenticate} configuration is set.
+      # @return [Boolean]
+      def authenticate?
+        authenticate != DEFAULT_AUTHENTICATE
+      end
+    end
+  end
+end