Skip to content

Improve messaging #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ghost wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improve messaging #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a5111bc
Split messaging.rb into module-based files
Mar 4, 2023
fcd61fb
Remove implicit message codes from exceptions
Aug 30, 2023
daca9d2
Prefer class-based messages
Mar 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions lib/sheetah/backends.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# frozen_string_literal: true

require_relative "backends_registry"
require_relative "messaging/messages/no_applicable_backend"
require_relative "utils/monadic_result"

module Sheetah
module Backends
@registry = BackendsRegistry.new

SimpleError = Struct.new(:msg_code)
private_constant :SimpleError

class << self
attr_reader :registry

def open(*args, **opts, &block)
backend = opts.delete(:backend) || registry.get(*args, **opts)

if backend.nil?
return Utils::MonadicResult::Failure.new(SimpleError.new("no_applicable_backend"))
return Utils::MonadicResult::Failure.new(
Messaging::Messages::NoApplicableBackend.new
)
end

backend.open(*args, **opts, &block)
Expand Down
39 changes: 0 additions & 39 deletions lib/sheetah/errors/error.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,45 +3,6 @@
module Sheetah
module Errors
class Error < StandardError
class << self
def inherited(klass)
super

klass.msg_code! if klass.detect_msg_code?
end

attr_reader :msg_code

def detect_msg_code?
name && /^[a-z0-9:]+$/i.match?(name)
end

def msg_code!(msg_code = build_msg_code)
@msg_code = msg_code
end

private

def build_msg_code
unless detect_msg_code?
raise ::TypeError, "Cannot build msg_code from anonymous exception: #{inspect}"
end

msg_code = name.dup
msg_code.gsub!("::", ".")
msg_code.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
msg_code.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
msg_code.downcase!

msg_code
end
end

msg_code!

def msg_code
self.class.msg_code
end
end
end
end
15 changes: 12 additions & 3 deletions lib/sheetah/headers.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# frozen_string_literal: true

require "set"
require_relative "messaging/messages/invalid_header"
require_relative "messaging/messages/duplicated_header"
require_relative "messaging/messages/missing_column"

module Sheetah
class Headers
Expand Down Expand Up @@ -51,7 +54,9 @@ def result
@failure = true

missing_columns.each do |column|
@messenger.error("missing_column", column.header)
@messenger.error(
Messaging::Messages::MissingColumn.new(code_data: column.header)
)
end
end

Expand All @@ -69,7 +74,9 @@ def add_ensure_column_is_specified(header, column)

unless @specification.ignore_unspecified_columns?
@failure = true
@messenger.error("invalid_header", header.value)
@messenger.error(
Messaging::Messages::InvalidHeader.new(code_data: header.value)
)
end

false
Expand All @@ -79,7 +86,9 @@ def add_ensure_column_is_unique(header, column)
return true if @columns.add?(column)

@failure = true
@messenger.error("duplicated_header", header.value)
@messenger.error(
Messaging::Messages::DuplicatedHeader.new(code_data: header.value)
)

false
end
Expand Down
195 changes: 11 additions & 184 deletions lib/sheetah/messaging.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,194 +2,21 @@

module Sheetah
module Messaging
module SCOPES
SHEET = "SHEET"
ROW = "ROW"
COL = "COL"
CELL = "CELL"
end

module SEVERITIES
WARN = "WARN"
ERROR = "ERROR"
end
require_relative "messaging/config"
require_relative "messaging/constants"
require_relative "messaging/message"
require_relative "messaging/messenger"

# TODO: list all possible message code in a systematic way,
# so that i18n do not miss any by mistake.
class Message
def initialize(
code:,
code_data: nil,
scope: nil,
scope_data: nil,
severity: nil
)
@code = code
@code_data = code_data || nil
@scope = scope || SCOPES::SHEET
@scope_data = scope_data || nil
@severity = severity || SEVERITIES::WARN
end

attr_reader(
:code,
:code_data,
:scope,
:scope_data,
:severity
)

def ==(other)
other.is_a?(self.class) &&
code == other.code &&
code_data == other.code_data &&
scope == other.scope &&
scope_data == other.scope_data &&
severity == other.severity
end
class << self
attr_accessor :config

def to_s
parts = [scoping_to_s, "#{severity}: #{code}", code_data]
parts.compact!
parts.join(" ")
end

private

def scoping_to_s
case scope
when SCOPES::SHEET then "[#{scope}]"
when SCOPES::ROW then "[#{scope}: #{scope_data[:row]}]"
when SCOPES::COL then "[#{scope}: #{scope_data[:col]}]"
when SCOPES::CELL then "[#{scope}: #{scope_data[:col]}#{scope_data[:row]}]"
end
def configure
config = self.config.dup
yield config
self.config = config.freeze
end
end

class Messenger
def initialize(
scope: SCOPES::SHEET,
scope_data: nil
)
@scope = scope.freeze
@scope_data = scope_data.freeze
@messages = []
end

attr_reader :scope, :scope_data, :messages

def ==(other)
other.is_a?(self.class) &&
scope == other.scope &&
scope_data == other.scope_data &&
messages == other.messages
end

def dup
self.class.new(
scope: @scope,
scope_data: @scope_data
)
end

def scoping!(scope, scope_data, &block)
scope = scope.freeze
scope_data = scope_data.freeze

if block
replace_scoping_block(scope, scope_data, &block)
else
replace_scoping_noblock(scope, scope_data)
end
end

def scoping(...)
dup.scoping!(...)
end

def scope_row!(row, &block)
scope = case @scope
when SCOPES::COL, SCOPES::CELL
SCOPES::CELL
else
SCOPES::ROW
end

scope_data = @scope_data.dup || {}
scope_data[:row] = row

scoping!(scope, scope_data, &block)
end

def scope_col!(col, &block)
scope = case @scope
when SCOPES::ROW, SCOPES::CELL
SCOPES::CELL
else
SCOPES::COL
end

scope_data = @scope_data.dup || {}
scope_data[:col] = col

scoping!(scope, scope_data, &block)
end

def scope_row(...)
dup.scope_row!(...)
end

def scope_col(...)
dup.scope_col!(...)
end

def warn(code, data = nil)
add(SEVERITIES::WARN, code, data)
end

def error(code, data = nil)
add(SEVERITIES::ERROR, code, data)
end

def exception(error)
error(error.msg_code)
end

private

def add(severity, code, data)
messages << Message.new(
code: code,
code_data: data,
scope: @scope,
scope_data: @scope_data,
severity: severity
)

self
end

def replace_scoping_noblock(new_scope, new_scope_data)
@scope = new_scope
@scope_data = new_scope_data

self
end

def replace_scoping_block(new_scope, new_scope_data)
prev_scope = @scope
prev_scope_data = @scope_data

@scope = new_scope
@scope_data = new_scope_data

begin
yield self
ensure
@scope = prev_scope
@scope_data = prev_scope_data
end
end
end
self.config = Config.new.freeze
end
end
13 changes: 13 additions & 0 deletions lib/sheetah/messaging/config.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# frozen_string_literal: true

module Sheetah
module Messaging
class Config
def initialize(validate_messages: true)
@validate_messages = validate_messages
end

attr_accessor :validate_messages
end
end
end
17 changes: 17 additions & 0 deletions lib/sheetah/messaging/constants.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# frozen_string_literal: true

module Sheetah
module Messaging
module SCOPES
SHEET = "SHEET"
ROW = "ROW"
COL = "COL"
CELL = "CELL"
end

module SEVERITIES
WARN = "WARN"
ERROR = "ERROR"
end
end
end
Loading