Skip to content

Commit d562739

Browse files
ndbroadbentndbroadbent
committed
renamed data attribute to additional_data
1 parent ba5a71c commit d562739

File tree

16 files changed

+115
-106
lines changed

16 files changed

+115
-106
lines changed

‎lib/log_struct/integrations/action_mailer/event_logging.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ def log_mailer_event(event_type, level = :info, additional_data = {})
6969
to: to,
7070
from: from,
7171
subject: subject,
72-
data: data
72+
additional_data: data
7373
)
7474
LogStruct.log(log_data)
7575
log_data

‎lib/log_struct/integrations/active_job/log_subscriber.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def log_job_event(event_type, job, _event, additional_data = {})
5858
# Add arguments if the job class allows it
5959
arguments: job.class.log_arguments? ? job.arguments : nil,
6060
# Store additional data in the data hash
61-
data: {
61+
additional_data: {
6262
executions: job.executions,
6363
scheduled_at: additional_data[:scheduled_at],
6464
provider_job_id: job.provider_job_id

‎lib/log_struct/integrations/carrierwave.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def store!(*args)
6262
mime_type: file.content_type,
6363
size: file_size,
6464
file_id: identifier,
65-
data: {
65+
additional_data: {
6666
version: version_name.to_s,
6767
store_path: store_path,
6868
extension: file.extension
@@ -95,7 +95,7 @@ def retrieve_from_store!(identifier, *args)
9595
filename: file&.filename,
9696
mime_type: file&.content_type,
9797
size: file_size,
98-
data: {
98+
additional_data: {
9999
version: version_name.to_s
100100
}
101101
)

‎lib/log_struct/integrations/shrine.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ def self.setup(config)
4848
download_options: payload[:download_options],
4949
options: payload[:options],
5050
# Data is flattened by the JSON formatter
51-
data: payload.except(
51+
additional_data: payload.except(
5252
:storage,
5353
:location,
5454
:uploader,

‎lib/log_struct/log/action_mailer.rb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
# frozen_string_literal: true
33

44
require_relative "interfaces/common_fields"
5-
require_relative "interfaces/data_field"
5+
require_relative "interfaces/additional_data_field"
66
require_relative "shared/serialize_common"
7-
require_relative "shared/merge_data_fields"
7+
require_relative "shared/merge_additional_data_fields"
88
require_relative "../enums/source"
99
require_relative "../enums/event"
1010
require_relative "../enums/level"
@@ -17,9 +17,9 @@ class ActionMailer < T::Struct
1717
extend T::Sig
1818

1919
include Interfaces::CommonFields
20-
include Interfaces::DataField
20+
include Interfaces::AdditionalDataField
2121
include SerializeCommon
22-
include MergeDataFields
22+
include MergeAdditionalDataFields
2323

2424
ActionMailerEvent = T.type_alias {
2525
T.any(Event::Delivery, Event::Delivered)
@@ -35,13 +35,13 @@ class ActionMailer < T::Struct
3535
const :to, T.nilable(T.any(String, T::Array[String])), default: nil
3636
const :from, T.nilable(String), default: nil
3737
const :subject, T.nilable(String), default: nil
38-
const :data, T::Hash[Symbol, T.untyped], default: {}
38+
const :additional_data, T::Hash[Symbol, T.untyped], default: {}
3939

4040
# Convert the log entry to a hash for serialization
4141
sig { override.params(strict: T::Boolean).returns(T::Hash[Symbol, T.untyped]) }
4242
def serialize(strict = true)
4343
hash = serialize_common(strict)
44-
merge_data_fields(hash)
44+
merge_additional_data_fields(hash)
4545

4646
# Add email-specific fields if they're present
4747
hash[LOG_KEYS.fetch(:to)] = to if to

‎lib/log_struct/log/active_job.rb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
# frozen_string_literal: true
33

44
require_relative "interfaces/common_fields"
5-
require_relative "interfaces/data_field"
5+
require_relative "interfaces/additional_data_field"
66
require_relative "shared/serialize_common"
7-
require_relative "shared/merge_data_fields"
7+
require_relative "shared/merge_additional_data_fields"
88
require_relative "../enums/source"
99
require_relative "../enums/event"
1010
require_relative "../enums/level"
@@ -17,9 +17,9 @@ class ActiveJob < T::Struct
1717
extend T::Sig
1818

1919
include Interfaces::CommonFields
20-
include Interfaces::DataField
20+
include Interfaces::AdditionalDataField
2121
include SerializeCommon
22-
include MergeDataFields
22+
include MergeAdditionalDataFields
2323

2424
ActiveJobEvent = T.type_alias {
2525
T.any(
@@ -42,13 +42,13 @@ class ActiveJob < T::Struct
4242
const :queue_name, T.nilable(String), default: nil
4343
const :arguments, T.nilable(T::Array[T.untyped]), default: nil
4444
const :duration, T.nilable(Float), default: nil
45-
const :data, T::Hash[Symbol, T.untyped], default: {}
45+
const :additional_data, T::Hash[Symbol, T.untyped], default: {}
4646

4747
# Convert the log entry to a hash for serialization
4848
sig { override.params(strict: T::Boolean).returns(T::Hash[Symbol, T.untyped]) }
4949
def serialize(strict = true)
5050
hash = serialize_common(strict)
51-
merge_data_fields(hash)
51+
merge_additional_data_fields(hash)
5252

5353
# Add job-specific fields if they're present
5454
hash[LOG_KEYS.fetch(:job_id)] = job_id if job_id

‎lib/log_struct/log/carrierwave.rb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
# frozen_string_literal: true
33

44
require_relative "interfaces/common_fields"
5-
require_relative "interfaces/data_field"
5+
require_relative "interfaces/additional_data_field"
66
require_relative "shared/serialize_common"
7-
require_relative "shared/merge_data_fields"
7+
require_relative "shared/merge_additional_data_fields"
88
require_relative "../enums/source"
99
require_relative "../enums/event"
1010
require_relative "../enums/level"
@@ -17,9 +17,9 @@ class CarrierWave < T::Struct
1717
extend T::Sig
1818

1919
include Interfaces::CommonFields
20-
include Interfaces::DataField
20+
include Interfaces::AdditionalDataField
2121
include SerializeCommon
22-
include MergeDataFields
22+
include MergeAdditionalDataFields
2323

2424
CarrierWaveEvent = T.type_alias {
2525
T.any(
@@ -52,13 +52,13 @@ class CarrierWave < T::Struct
5252
const :uploader, T.nilable(String), default: nil
5353
const :model, T.nilable(String), default: nil
5454
const :mount_point, T.nilable(String), default: nil
55-
const :data, T::Hash[Symbol, T.untyped], default: {}
55+
const :additional_data, T::Hash[Symbol, T.untyped], default: {}
5656

5757
# Convert the log entry to a hash for serialization
5858
sig { override.params(strict: T::Boolean).returns(T::Hash[Symbol, T.untyped]) }
5959
def serialize(strict = true)
6060
hash = serialize_common(strict)
61-
merge_data_fields(hash)
61+
merge_additional_data_fields(hash)
6262

6363
# Add file-specific fields if they're present
6464
hash[LOG_KEYS.fetch(:storage)] = storage if storage

‎lib/log_struct/log/error.rb‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
# frozen_string_literal: true
33

44
require_relative "interfaces/common_fields"
5-
require_relative "interfaces/data_field"
5+
require_relative "interfaces/additional_data_field"
66
require_relative "interfaces/message_field"
77
require_relative "shared/serialize_common"
8-
require_relative "shared/merge_data_fields"
8+
require_relative "shared/merge_additional_data_fields"
99
require_relative "../enums/source"
1010
require_relative "../enums/event"
1111
require_relative "../enums/level"
@@ -18,9 +18,9 @@ class Error < T::Struct
1818
extend T::Sig
1919

2020
include Interfaces::CommonFields
21-
include Interfaces::DataField
21+
include Interfaces::AdditionalDataField
2222
include Interfaces::MessageField
23-
include MergeDataFields
23+
include MergeAdditionalDataFields
2424

2525
ErrorEvent = T.type_alias {
2626
Event::Error
@@ -36,13 +36,13 @@ class Error < T::Struct
3636
const :err_class, T.class_of(StandardError)
3737
const :message, String
3838
const :backtrace, T.nilable(T::Array[String]), default: nil
39-
const :data, T::Hash[Symbol, T.untyped], default: {}
39+
const :additional_data, T::Hash[Symbol, T.untyped], default: {}
4040

4141
# Convert the log entry to a hash for serialization
4242
sig { override.params(strict: T::Boolean).returns(T::Hash[Symbol, T.untyped]) }
4343
def serialize(strict = true)
4444
hash = serialize_common(strict)
45-
merge_data_fields(hash)
45+
merge_additional_data_fields(hash)
4646

4747
# Add exception-specific fields
4848
hash[LOG_KEYS.fetch(:err_class)] = err_class.name
@@ -59,16 +59,16 @@ def serialize(strict = true)
5959
params(
6060
source: Source,
6161
ex: StandardError,
62-
data: T::Hash[Symbol, T.untyped]
62+
additional_data: T::Hash[Symbol, T.untyped]
6363
).returns(Log::Error)
6464
}
65-
def self.from_exception(source, ex, data = {})
65+
def self.from_exception(source, ex, additional_data = {})
6666
new(
6767
source: source,
6868
message: ex.message,
6969
err_class: ex.class,
7070
backtrace: ex.backtrace,
71-
data: data
71+
additional_data: additional_data
7272
)
7373
end
7474
end

lib/log_struct/log/interfaces/data_field.rb renamed to lib/log_struct/log/interfaces/additional_data_field.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44
module LogStruct
55
module Log
66
module Interfaces
7-
# Common interface for logs that include a data field
8-
module DataField
7+
# Common interface for logs that include an additional_data field
8+
module AdditionalDataField
99
extend T::Sig
1010
extend T::Helpers
1111

1212
interface!
1313

14-
# Data field for additional context
14+
# Additional data field for extra context
1515
sig { abstract.returns(T::Hash[Symbol, T.untyped]) }
16-
def data; end
16+
def additional_data; end
1717
end
1818
end
1919
end

‎lib/log_struct/log/plain.rb‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
# frozen_string_literal: true
33

44
require_relative "interfaces/common_fields"
5+
require_relative "interfaces/additional_data_field"
56
require_relative "shared/serialize_common"
7+
require_relative "shared/merge_additional_data_fields"
68
require_relative "../enums/source"
79
require_relative "../enums/event"
810
require_relative "../enums/level"
@@ -15,9 +17,9 @@ class Plain < T::Struct
1517
extend T::Sig
1618

1719
include Interfaces::CommonFields
18-
include Interfaces::DataField
20+
include Interfaces::AdditionalDataField
1921
include SerializeCommon
20-
include MergeDataFields
22+
include MergeAdditionalDataFields
2123

2224
PlainEvent = T.type_alias {
2325
Event::Log
@@ -36,13 +38,13 @@ class Plain < T::Struct
3638
const :message, T.untyped # rubocop:disable Sorbet/ForbidUntypedStructProps
3739

3840
# Allow people to submit additional data
39-
const :data, T::Hash[Symbol, T.untyped], default: {}
41+
const :additional_data, T::Hash[Symbol, T.untyped], default: {}
4042

4143
# Convert the log entry to a hash for serialization
4244
sig { override.params(strict: T::Boolean).returns(T::Hash[Symbol, T.untyped]) }
4345
def serialize(strict = true)
4446
hash = serialize_common(strict)
45-
merge_data_fields(hash)
47+
merge_additional_data_fields(hash)
4648
hash[LOG_KEYS.fetch(:message)] = message
4749
hash
4850
end

0 commit comments

Comments
 (0)