Class: Appom::ElementState::Tracker

Inherits:
Object
  • Object
show all
Includes:
Logging
Defined in:
lib/appom/element_state.rb

Overview

Tracks element states and changes over time

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Logging

level, level=, #log_debug, #log_element_action, #log_error, #log_info, #log_wait_end, #log_wait_start, #log_warn, #logger

Constructor Details

#initialize ⇒ Tracker

Returns a new instance of Tracker.



12
13
14
15
16
17
 
# File 'lib/appom/element_state.rb', line 12

def initialize
  @tracked_elements = {}
  @state_history = []
  @observers = []
  @tracking_enabled = true
end

Instance Attribute Details

#state_history ⇒ Object (readonly)

Returns the value of attribute state_history.



10
11
12
 
# File 'lib/appom/element_state.rb', line 10

def state_history
  @state_history
end

#tracked_elements ⇒ Object (readonly)

Returns the value of attribute tracked_elements.



10
11
12
 
# File 'lib/appom/element_state.rb', line 10

def tracked_elements
  @tracked_elements
end

Instance Method Details

#add_observer(&block) ⇒ Object

Add state change observer



203
204
205
206
 
# File 'lib/appom/element_state.rb', line 203

def add_observer(&block)
  @observers << block
  block
end

#clear! ⇒ Object

Clear all tracking data



220
221
222
223
224
 
# File 'lib/appom/element_state.rb', line 220

def clear!
  @tracked_elements.clear
  @state_history.clear
  log_info('Element state tracking data cleared')
end

#element_history(element_id, limit: 50) ⇒ Object

Get element state history



104
105
106
107
108
 
# File 'lib/appom/element_state.rb', line 104

def element_history(element_id, limit: 50)
  @state_history
    .select { |event| event[:element_id] == element_id }
    .last(limit)
end

#element_state(element_id) ⇒ Object

Get current state of tracked element



94
95
96
97
98
99
100
101
 
# File 'lib/appom/element_state.rb', line 94

def element_state(element_id)
  tracked = @tracked_elements[element_id]
  return nil unless tracked

  # Update state before returning
  update_element_state(element_id)
  tracked[:current_state]
end

#export_tracking_data(file_path: nil, format: :json) ⇒ Object

Export tracking data



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/appom/element_state.rb', line 227

def export_tracking_data(file_path: nil, format: :json)
  file_path ||= "element_state_tracking_#{Time.now.strftime('%Y%m%d_%H%M%S')}.#{format}"

  data = {
    exported_at: Time.now,
    summary: tracking_summary,
    tracked_elements: serialize_tracked_elements,
    state_history: @state_history,
  }

  case format
  when :json
    File.write(file_path, JSON.pretty_generate(data))
  when :yaml
    File.write(file_path, YAML.dump(data))
  else
    raise ArgumentError, "Unsupported format: #{format}"
  end

  log_info("Element state tracking data exported to #{file_path}")
  file_path
end

#find_elements_by_state(criteria) ⇒ Object

Find elements by state criteria



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/appom/element_state.rb', line 185

def find_elements_by_state(criteria)
  if criteria.is_a?(Hash)
    # Always return array of tracked hashes for consistency with test expectations
    @tracked_elements.values.select { |tracked| criteria.all? { |key, value| tracked[:current_state]&.dig(key) == value } }
  else
    @tracked_elements.values.select do |tracked|
      current_state = tracked[:current_state]
      case criteria
      when Proc
        criteria.call(current_state)
      else
        false
      end
    end
  end
end

#remove_observer(observer) ⇒ Object

Remove observer



209
210
211
 
# File 'lib/appom/element_state.rb', line 209

def remove_observer(observer)
  @observers.delete(observer)
end

#stop_tracking(element_id) ⇒ Object

Stop tracking an element



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/appom/element_state.rb', line 157

def stop_tracking(element_id)
  tracked = @tracked_elements.delete(element_id)
  return unless tracked

  log_debug("Stopped tracking element: #{tracked[:name]}")
  notify_observers(:element_untracked, element_id)

  # Return final summary
  {
    name: tracked[:name],
    tracking_duration: Time.now - tracked[:first_seen],
    change_count: tracked[:change_count],
    final_state: tracked[:current_state],
  }
end

#track_element(element, name: nil, context: {}) ⇒ Object

Start tracking an element



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/appom/element_state.rb', line 20

def track_element(element, name: nil, context: {})
  element_id = generate_element_id(element, name)

  state = capture_element_state(element)

  @tracked_elements[element_id] = {
    element: element,
    name: name || element_id,
    context: context,
    first_seen: Time.now,
    last_updated: Time.now,
    current_state: state,
    previous_states: [],
    change_count: 0,
  }

  log_debug("Started tracking element: #{name || element_id}")
  notify_observers(:element_tracked, element_id, state)

  element_id
end

#tracking_enabled=(enabled) ⇒ Object

Enable/disable tracking



214
215
216
217
 
# File 'lib/appom/element_state.rb', line 214

def tracking_enabled=(enabled)
  @tracking_enabled = enabled
  log_info("Element state tracking #{enabled ? 'enabled' : 'disabled'}")
end

#tracking_summary ⇒ Object

Get tracking summary



174
175
176
177
178
179
180
181
182
 
# File 'lib/appom/element_state.rb', line 174

def tracking_summary
  {
    total_tracked: @tracked_elements.count,
    total_changes: @state_history.count,
    most_active: most_active_elements(5),
    recent_changes: @state_history.last(10),
    tracking_enabled: @tracking_enabled,
  }
end

#update_element_state(element_id) ⇒ Object

Update element state and detect changes



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/appom/element_state.rb', line 43

def update_element_state(element_id)
  return unless @tracking_enabled

  tracked = @tracked_elements[element_id]
  return unless tracked

  begin
    new_state = capture_element_state(tracked[:element])
    old_state = tracked[:current_state]

    if state_changed?(old_state, new_state)
      # Store previous state
      tracked[:previous_states] << {
        state: old_state,
        timestamp: tracked[:last_updated],
        duration: Time.now - tracked[:last_updated],
      }

      # Keep only last 10 states
      tracked[:previous_states] = tracked[:previous_states].last(10)

      # Update current state
      tracked[:current_state] = new_state
      tracked[:last_updated] = Time.now
      tracked[:change_count] += 1

      # Record in history
      change_event = {
        timestamp: Time.now,
        element_id: element_id,
        element_name: tracked[:name],
        old_state: old_state,
        new_state: new_state,
        changes: calculate_changes(old_state, new_state),
      }

      @state_history << change_event
      @state_history = @state_history.last(1000) # Keep last 1000 changes

      log_debug("Element state changed: #{tracked[:name]}", change_event[:changes])
      notify_observers(:state_changed, element_id, change_event)

      change_event
    end
  rescue StandardError => e
    log_warn("Failed to update element state: #{e.message}")
    nil
  end
end

#wait_for_state(element_id, condition, timeout: 10, interval: 0.5) ⇒ Object

Wait for element to be in specific state



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/appom/element_state.rb', line 130

def wait_for_state(element_id, condition, timeout: 10, interval: 0.5)
  start_time = Time.now

  loop do
    current_state = element_state(element_id)

    result = case condition
             when Proc
               condition.call(current_state)
             when Hash
               condition.all? { |key, value| current_state&.dig(key) == value }
             else
               false
             end

    return current_state if result

    if Time.now - start_time > timeout
      raise Appom::TimeoutError,
            "Element did not reach expected state within #{timeout}s. Current: #{current_state}"
    end

    sleep interval
  end
end

#wait_for_state_change(element_id, expected_changes: {}, timeout: 10, interval: 0.5) ⇒ Object

Wait for element state change



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/appom/element_state.rb', line 111

def wait_for_state_change(element_id, expected_changes: {}, timeout: 10, interval: 0.5)
  start_time = Time.now

  loop do
    current_state = element_state(element_id)

    return current_state if expected_changes.all? { |key, value| current_state&.dig(key) == value }

    if Time.now - start_time > timeout
      raise Appom::TimeoutError,
            "Element state did not change as expected within #{timeout}s. " \
            "Expected: #{expected_changes}, Current: #{current_state}"
    end

    sleep interval
  end
end