8114731249

Committed 01 Mar 2024 05:11PM UTC coverage: 92.479% (+0.7%) from 91.789%

Build # 8114731249

Build Type

push

github

Committed by

pboling

Commit Message

🐛 Added missing debug_* methods

Run Details

136 of 158 branches covered (86.08%)

Branch coverage included in aggregate %.

7 of 11 new or added lines in 2 files covered. (63.64%)

8 existing lines in 3 files now uncovered.

528 of 560 relevant lines covered (94.29%)

136.68 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.87

/lib/debug_logging/util.rb

module DebugLogging
  module Util
    module_function

    def debug_time(time_or_monotonic)
      case time_or_monotonic
      when Time, DateTime
        time_or_monotonic
      when Numeric
        Time.at(time_or_monotonic)
      when String
        Time.parse(time_or_monotonic)
      else
        # Garbage in, Sweet Nourishing Gruel Out
        Time.now
      end
    end

    # methods_to_log may be an array of a single method name, followed by config options and payload,
    #   or it could be an array of method names followed by config options and payload to be shared by the whole set.
    def extract_payload_and_config(method_names:, payload: nil, config: nil)
      # When scoped config is present it will always be a new configuration instance per method
      # When scoped config is not present it will reuse the class' configuration object
      scoped_payload = (method_names.is_a?(Array) && method_names.last.is_a?(Hash) && method_names.pop.clone(freeze: false)) || {}
      payload = if payload
        payload.merge(scoped_payload)
      else
        scoped_payload
      end
      config_opts = config&.clone(freeze: false) || {}
      # puts "[EPAC] config: #{config}, scoped_payload: #{scoped_payload}, payload: #{payload}, config_opts: #{config_opts}"
      unless payload.empty?
        DebugLogging::Configuration::CONFIG_KEYS.each { |k| config_opts[k] = payload.delete(k) if payload.key?(k) }
      end
      method_names =
        case method_names
        when Symbol
          method_names
        when String
          method_names.to_sym
        when Array
          if method_names.first.is_a?(Array)
            # Array of arrays?
            method_names.shift
          elsif method_names.size == 1 && method_names.first.is_a?(Symbol)
            # when set as i_methods: [[:i_with_dsplat_payload, { tags: %w[blue green] }], ...]
            method_names.shift.to_sym
          else
            # Or an array of method name symbols?
            # logged :meth1, :meth2, :meth3 without options is valid
            method_names
          end
        else
          raise ArgumentError, "unknown type for method_names: #{method_names.class}"
        end
      [method_names, payload, config_opts]
    end

    def payload_instance_variable_hydration(scope:, payload:)
      paydirt = {}
      # TODO: Could make instance variable introspection configurable before or after method execution
      if payload.key?(:instance_variables)
        paydirt.merge!(payload.reject { |k| k == :instance_variables })
        payload[:instance_variables].each do |k|
          paydirt[k] = scope.send(:instance_variable_get, "@#{k}") if scope.send(:instance_variable_defined?, "@#{k}")
        end
      else
        paydirt.merge!(payload)
      end
      paydirt
    end

    def config_proxy_finder(scope:, method_name:, proxy_ref:, config_opts: {}, &block)
      if (proxy = scope.send(:instance_variable_get, DebugLogging::Configuration.config_pointer(
        proxy_ref,
        method_name,
      )))
        proxy
      else
        base = scope.respond_to?(:debug_config) ? scope.debug_config : DebugLogging.debug_logging_configuration
        proxy = if config_opts.empty?
          base
        else
          DebugLogging::Configuration.new(**base.to_hash.merge(config_opts))
        end
        proxy.register(method_name)
        scope.send(
          :instance_variable_set,
          DebugLogging::Configuration.config_pointer(proxy_ref, method_name),
          proxy,
        )
        yield proxy if block
        proxy
      end
    end
  end
end

1	module DebugLogging	1✔
2	module Util	1✔
3	module_function	1✔
4
5	def debug_time(time_or_monotonic)	1✔
6	case time_or_monotonic	594✔
7	when Time, DateTime	53✔
8	time_or_monotonic	53✔
9	when Numeric	535✔
10	Time.at(time_or_monotonic)	535✔
11	when String	3✔
12	Time.parse(time_or_monotonic)	3✔
13	else
14	# Garbage in, Sweet Nourishing Gruel Out	3✔
15	Time.now	3✔
16	end
17	end
18
19	# methods_to_log may be an array of a single method name, followed by config options and payload,
20	# or it could be an array of method names followed by config options and payload to be shared by the whole set.
21	def extract_payload_and_config(method_names:, payload: nil, config: nil)	1✔
22	# When scoped config is present it will always be a new configuration instance per method
23	# When scoped config is not present it will reuse the class' configuration object
24	scoped_payload = (method_names.is_a?(Array) && method_names.last.is_a?(Hash) && method_names.pop.clone(freeze: false)) \|\| {}	1,290✔
25	payload = if payload	1,290✔
26	payload.merge(scoped_payload)	909✔
27	else	381✔
28	scoped_payload	381✔
29	end
30	config_opts = config&.clone(freeze: false) \|\| {}	1,290✔
31	# puts "[EPAC] config: #{config}, scoped_payload: #{scoped_payload}, payload: #{payload}, config_opts: #{config_opts}"
32	unless payload.empty?	1,290✔
33	DebugLogging::Configuration::CONFIG_KEYS.each { \|k\| config_opts[k] = payload.delete(k) if payload.key?(k) }	5,632✔
34	end
35	method_names =
36	case method_names	1,290✔
37	when Symbol	633✔
38	method_names	633✔
39	when String	2✔
40	method_names.to_sym	2✔
41	when Array	655✔
42	if method_names.first.is_a?(Array)	655✔
43	# Array of arrays?	133✔
44	method_names.shift	133✔
45	elsif method_names.size == 1 && method_names.first.is_a?(Symbol)	522✔
46	# when set as i_methods: [[:i_with_dsplat_payload, { tags: %w[blue green] }], ...]	395✔
47	method_names.shift.to_sym	395✔
48	else
49	# Or an array of method name symbols?
50	# logged :meth1, :meth2, :meth3 without options is valid	127✔
51	method_names	127✔
52	end
53	else	×
UNCOV 54	raise ArgumentError, "unknown type for method_names: #{method_names.class}"	×
55	end
56	[method_names, payload, config_opts]	1,290✔
57	end
58
59	def payload_instance_variable_hydration(scope:, payload:)	1✔
60	paydirt = {}	209✔
61	# TODO: Could make instance variable introspection configurable before or after method execution
62	if payload.key?(:instance_variables)	209✔
63	paydirt.merge!(payload.reject { \|k\| k == :instance_variables })	8✔
64	payload[:instance_variables].each do \|k\|	4✔
65	paydirt[k] = scope.send(:instance_variable_get, "@#{k}") if scope.send(:instance_variable_defined?, "@#{k}")	12!
66	end
67	else	205✔
68	paydirt.merge!(payload)	205✔
69	end
70	paydirt	209✔
71	end
72
73	def config_proxy_finder(scope:, method_name:, proxy_ref:, config_opts: {}, &block)	1✔
74	if (proxy = scope.send(:instance_variable_get, DebugLogging::Configuration.config_pointer(	212✔
75	proxy_ref,
76	method_name,
77	)))	15✔
78	proxy	15✔
79	else	197✔
80	base = scope.respond_to?(:debug_config) ? scope.debug_config : DebugLogging.debug_logging_configuration	197!
81	proxy = if config_opts.empty?	197✔
82	base	126✔
83	else	71✔
84	DebugLogging::Configuration.new(**base.to_hash.merge(config_opts))	71✔
85	end
86	proxy.register(method_name)	197✔
87	scope.send(	197✔
88	:instance_variable_set,
89	DebugLogging::Configuration.config_pointer(proxy_ref, method_name),
90	proxy,
91	)
92	yield proxy if block	197✔
93	proxy	197✔
94	end
95	end
96	end
97	end

pboling / debug_logging / 8114731249

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous