AlyBadawy / Securial / 15928319856

98%

push

github

Docs: Enhance YARD docs (#74)

- Added detailed documentation for configuration validation in
`lib/securial/config/validation.rb`, including methods for required
fields, type validation, and password length checks.
- Implemented key transformation utilities in
`lib/securial/helpers/key_transformer.rb` to support deep transformation
of hash keys between different naming conventions.
- Introduced data normalization methods in
`lib/securial/helpers/normalizing_helper.rb` for consistent user input
handling, including email and role name normalization.
- Centralized regular expression patterns and validation methods in
`lib/securial/helpers/regex_helper.rb` for email, username, and password
validation.
- Enhanced role management utilities in
`lib/securial/helpers/roles_helper.rb` for consistent role name
formatting and namespace generation.
- Developed middleware for logging request context in
`lib/securial/middleware/request_tag_logger.rb`, improving traceability
of log messages.
- Added response header middleware in
`lib/securial/middleware/response_headers.rb` to include Securial
identification headers in HTTP responses.
- Created middleware in
`lib/securial/middleware/transform_request_keys.rb` to convert incoming
JSON request keys to snake_case.
- Implemented middleware in
`lib/securial/middleware/transform_response_keys.rb` to transform
outgoing JSON response keys to client-preferred formats.
- Updated gemspec file `securial.gemspec` to include additional metadata
and improve post-install messages for better user guidance.

---------

Signed-off-by: Aly Badawy <1198568+AlyBadawy@users.noreply.github.com>

214 of 220 branches covered (97.27%)

Branch coverage included in aggregate %.

35 of 37 new or added lines in 5 files covered. (94.59%)

1111 of 1146 relevant lines covered (96.95%)

52.27 hits per line