Sha256: d7f44c5d93831d79ffcdce07304f4a3edab2154a741514463b46366630b550ce

Contents?: true

Size: 1.34 KB

Versions: 17

Compression:

Stored size: 1.34 KB

Contents

# getaround_utils

Backend shared utility classes

## Railties

### GetaroundUtils::Railties::Lograge

Enables lograge (http logs) with favored default.
```
# config/application.rb
require 'getaround_utils/railties/lograge'
```

For more details, [read the spec](spec/getaround_utils/railties/lograge_spec.rb)

### GetaroundUtils::Railties::Ougai

Enables structured log with Ougai.
```
# config/application.rb
require 'getaround_utils/railties/ougai'
```

For more details, [read the spec](spec/getaround_utils/railties/ougai_spec.rb)

## Mixins

### GetaroundUtils::Mixins::Loggable

Enables lograge (http logs) with favored default.
```
class MyClass
  include GetaroundUtils::Mixins::Loggable

  def append_infos_to_loggable(payload)
    payload[:static] = 'value'
  end

  def action
    loggable_log(:info, 'hello', dynamic: 'value')
  end
end

MyClass.new.action # :info message="hello" origin="MyClass" static="value" dynamic="value"

```

For more details, [read the spec](spec/getaround_utils/mixins/loggable_spec.rb)

## Misc

### GetaroundUtils::LogFormatters::DeepKeyValue

This log formatter will serialize an object of any depth into a key-value string.
It supports basic scalars (ie: `Hash`,`Array`,`Numeric`,`String`) and will call "#inspect" for any other type.

For more details, [read the spec](spec/getaround_utils/log_formatters/deep_key_value_spec.rb)


Version data entries

17 entries across 17 versions & 1 rubygems

Version Path
getaround_utils-0.2.22 README.md
getaround_utils-0.2.21 README.md
getaround_utils-0.2.20 README.md
getaround_utils-0.2.19 README.md
getaround_utils-0.2.18 README.md
getaround_utils-0.2.16 README.md
getaround_utils-0.2.15 README.md
getaround_utils-0.2.14 README.md
getaround_utils-0.2.13 README.md
getaround_utils-0.2.11 README.md
getaround_utils-0.2.10 README.md
getaround_utils-0.2.9 README.md
getaround_utils-0.2.7 README.md
getaround_utils-0.2.6 README.md
getaround_utils-0.2.5 README.md
getaround_utils-0.2.1 README.md
getaround_utils-0.2.0 README.md