Module: Wallaby

Defined in:
lib/wallaby/configuration.rb,
lib/wallaby/map.rb,
lib/wallaby/core.rb,
lib/wallaby/engine.rb,
lib/wallaby/logger.rb,
lib/wallaby/guesser.rb,
lib/tree/wallaby/node.rb,
lib/wallaby/constants.rb,
lib/wallaby/preloader.rb,
lib/wallaby/class_hash.rb,
lib/wallaby/classifier.rb,
lib/wallaby/deprecator.rb,
lib/utils/wallaby/utils.rb,
lib/wallaby/class_array.rb,
lib/utils/wallaby/locale.rb,
lib/wallaby/core/version.rb,
lib/parsers/wallaby/parser.rb,
lib/adaptors/wallaby/custom.rb,
lib/interfaces/wallaby/mode.rb,
lib/utils/wallaby/inflector.rb,
lib/concerns/wallaby/urlable.rb,
lib/errors/wallaby/forbidden.rb,
lib/errors/wallaby/not_found.rb,
lib/routes/wallaby/id_regexp.rb,
lib/concerns/wallaby/baseable.rb,
lib/fields/wallaby/all_fields.rb,
lib/utils/wallaby/field_utils.rb,
lib/concerns/wallaby/fieldable.rb,
lib/forms/wallaby/form_builder.rb,
lib/routes/wallaby/lazy_regexp.rb,
lib/utils/wallaby/filter_utils.rb,
lib/utils/wallaby/module_utils.rb,
lib/utils/wallaby/params_utils.rb,
lib/concerns/wallaby/engineable.rb,
lib/concerns/wallaby/prefixable.rb,
lib/concerns/wallaby/servicable.rb,
lib/helpers/wallaby/base_helper.rb,
lib/helpers/wallaby/form_helper.rb,
lib/concerns/wallaby/decoratable.rb,
lib/concerns/wallaby/paginatable.rb,
lib/concerns/wallaby/resourcable.rb,
lib/errors/wallaby/general_error.rb,
lib/errors/wallaby/invalid_error.rb,
lib/helpers/wallaby/index_helper.rb,
lib/helpers/wallaby/links_helper.rb,
lib/wallaby/configuration/models.rb,
lib/concerns/wallaby/authorizable.rb,
lib/concerns/wallaby/configurable.rb,
lib/errors/wallaby/method_removed.rb,
lib/helpers/wallaby/secure_helper.rb,
lib/services/wallaby/class_finder.rb,
lib/wallaby/configuration/mapping.rb,
lib/wallaby/configuration/sorting.rb,
lib/errors/wallaby/class_not_found.rb,
lib/errors/wallaby/model_not_found.rb,
lib/errors/wallaby/not_implemented.rb,
lib/helpers/wallaby/styling_helper.rb,
lib/wallaby/configuration/features.rb,
lib/wallaby/configuration/metadata.rb,
lib/wallaby/configuration/security.rb,
lib/interfaces/wallaby/model_finder.rb,
lib/routes/wallaby/resources_regexp.rb,
lib/routes/wallaby/resources_router.rb,
lib/services/wallaby/engine_url_for.rb,
lib/errors/wallaby/not_authenticated.rb,
lib/helpers/wallaby/resources_helper.rb,
lib/servicers/wallaby/model_servicer.rb,
lib/services/wallaby/map/mode_mapper.rb,
lib/services/wallaby/servicer_finder.rb,
lib/wallaby/configuration/pagination.rb,
lib/errors/wallaby/resource_not_found.rb,
lib/routes/wallaby/engines/base_route.rb,
lib/services/wallaby/decorator_finder.rb,
lib/services/wallaby/fields_regulator.rb,
lib/services/wallaby/paginator_finder.rb,
lib/services/wallaby/prefixes_builder.rb,
lib/concerns/wallaby/resources_concern.rb,
lib/helpers/wallaby/application_helper.rb,
lib/interfaces/wallaby/model_decorator.rb,
lib/paginators/wallaby/model_paginator.rb,
lib/services/wallaby/authorizer_finder.rb,
lib/services/wallaby/controller_finder.rb,
lib/errors/wallaby/unprocessable_entity.rb,
lib/routes/wallaby/engines/engine_route.rb,
lib/services/wallaby/engine_name_finder.rb,
lib/services/wallaby/model_class_filter.rb,
lib/adaptors/wallaby/custom/model_finder.rb,
lib/authorizers/wallaby/model_authorizer.rb,
lib/concerns/wallaby/application_concern.rb,
lib/helpers/wallaby/configuration_helper.rb,
lib/decorators/wallaby/resource_decorator.rb,
lib/responders/wallaby/json_api_responder.rb,
lib/services/wallaby/sorting/hash_builder.rb,
lib/services/wallaby/sorting/link_builder.rb,
lib/services/wallaby/sorting/next_builder.rb,
lib/responders/wallaby/resources_responder.rb,
lib/adaptors/wallaby/custom/model_decorator.rb,
lib/concerns/wallaby/authentication_concern.rb,
lib/routes/wallaby/engines/custom_app_route.rb,
lib/services/wallaby/map/model_class_mapper.rb,
lib/services/wallaby/sorting/single_builder.rb,
app/controllers/wallaby/resources_controller.rb,
lib/adaptors/wallaby/custom/default_provider.rb,
lib/services/wallaby/default_models_excluder.rb,
lib/services/wallaby/link_options_normalizer.rb,
lib/interfaces/wallaby/model_service_provider.rb,
lib/interfaces/wallaby/model_pagination_provider.rb,
lib/adaptors/wallaby/custom/model_service_provider.rb,
lib/generators/wallaby/engine/application_generator.rb,
lib/interfaces/wallaby/model_authorization_provider.rb,
lib/adaptors/wallaby/custom/model_pagination_provider.rb,
lib/authorizers/wallaby/pundit_authorization_provider.rb,
lib/authorizers/wallaby/default_authorization_provider.rb,
lib/generators/wallaby/engine/install/install_generator.rb,
lib/authorizers/wallaby/cancancan_authorization_provider.rb,
lib/generators/wallaby/engine/servicer/servicer_generator.rb,
lib/generators/wallaby/engine/decorator/decorator_generator.rb,
lib/generators/wallaby/engine/paginator/paginator_generator.rb,
lib/generators/wallaby/engine/authorizer/authorizer_generator.rb,
lib/generators/wallaby/engine/controller/controller_generator.rb

Overview

Wallaby

Defined Under Namespace

Modules: ApplicationConcern, ApplicationHelper, AuthenticationConcern, Authorizable, BaseHelper, Baseable, Classifier, Configurable, ConfigurationHelper, Core, Decoratable, Engineable, Engines, FieldUtils, Fieldable, FilterUtils, FormHelper, IndexHelper, Inflector, LinksHelper, Locale, Logger, ModuleUtils, Paginatable, ParamsUtils, Prefixable, Resourcable, ResourcesConcern, ResourcesHelper, SecureHelper, Servicable, Sorting, StylingHelper, Urlable, Utils Classes: AllFields, ApplicationGenerator, AuthorizerFinder, CancancanAuthorizationProvider, ClassArray, ClassFinder, ClassHash, Configuration, ControllerFinder, Custom, DecoratorFinder, DefaultAuthorizationProvider, DefaultModelsExcluder, Deprecator, Engine, EngineNameFinder, EngineUrlFor, FieldsRegulator, FormBuilder, GeneralError, Guesser, IdRegexp, JsonApiResponder, LazyRegexp, LinkOptionsNormalizer, Map, Mode, ModelAuthorizationProvider, ModelAuthorizer, ModelClassFilter, ModelDecorator, ModelFinder, ModelNotFound, ModelPaginationProvider, ModelPaginator, ModelServiceProvider, ModelServicer, Node, PaginatorFinder, Parser, PrefixesBuilder, Preloader, PunditAuthorizationProvider, ResourceDecorator, ResourceNotFound, ResourcesController, ResourcesRegexp, ResourcesResponder, ResourcesRouter, ServicerFinder

Constant Summary collapse

EMPTY_STRING =

:nodoc:

''.html_safe.freeze
EMPTY_HASH =

:nodoc:

{}.freeze
EMPTY_ARRAY =

:nodoc:

[].freeze
SPACE =

:nodoc:

' '
SLASH =

:nodoc:

'/'
COLONS =

:nodoc:

'::'
COMMA =

:nodoc:

','
DOT =

:nodoc:

'.'
HASH =

:nodoc:

'#'
HYPHEN =

:nodoc:

'-'
UNDERSCORE =

:nodoc:

'_'
PCT =

:nodoc:

'%'
DEFAULT_PAGE_SIZE =

Default page size for Configuration::Pagination#page_size

20
DEFAULT_MAX =

Default max charactoers to display for Configuration::Metadata#max

20
DEFAULT_PROVIDER =

Default provider name for authorizer sorting.

'default'
ERRORS =

HTTP error types that Wallaby handles

%i[
  bad_request
  forbidden
  internal_server_error
  not_found
  not_implemented
  unauthorized
  unprocessable_entity
].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
SCRIPT_NAME =

:nodoc:

'SCRIPT_NAME'
PATH_INFO =

:nodoc:

'PATH_INFO'
PERS =

Page size list

[10, 20, 50, 100].freeze
CSV =

:nodoc:

'csv'
WILDCARD =

:nodoc:

'QUERY'
ERROR_PATH =

A constant of error path for error handling

'error'
CONTROLLER =

:nodoc:

'Controller'
DECORATOR =

:nodoc:

'Decorator'
SERVICER =

:nodoc:

'Servicer'
AUTHORIZER =

:nodoc:

'Authorizer'
PAGINATOR =

:nodoc:

'Paginator'
FINDER =

:nodoc:

'Finder'
Forbidden =
Class.new(GeneralError)
NotFound =
Class.new(GeneralError)
InvalidError =
Class.new(GeneralError)
MethodRemoved =
Class.new(GeneralError)
ClassNotFound =
Class.new(GeneralError)
NotImplemented =
Class.new(GeneralError)
NotAuthenticated =
Class.new(GeneralError)
UnprocessableEntity =
Class.new(GeneralError)

Class Method Summary collapse

Class Method Details

.config {|configuration| ... } ⇒ Object

To config settings using a block

Examples:

Wallaby.config do |c|
  c.pagination.page_size = 20
end

Yields:



167
168
169
# File 'lib/wallaby/configuration.rb', line 167

def self.config
  yield configuration
end

.configurationConfiguration

Returns:



158
159
160
# File 'lib/wallaby/configuration.rb', line 158

def self.configuration
  @configuration ||= Configuration.new
end