Class: ClaudeHooks::PreToolUse

Inherits:
Base
  • Object
show all
Defined in:
lib/claude_hooks/pre_tool_use.rb

Constant Summary

Constants inherited from Base

Base::COMMON_INPUT_FIELDS

Instance Attribute Summary

Attributes inherited from Base

#config, #input_data, #logger, #output, #output_data

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#agent_id, #agent_type, #allow_continue!, #base_dir, #call, #clear_specifics!, #clear_system_message!, #cwd, #effort, #home_claude_dir, #home_path_for, #hook_event_name, #hook_type, #initialize, #log, #output_and_exit, #path_for, #permission_mode, #prevent_continue!, #project_claude_dir, #project_path_for, #prompt_id, #read_transcript, #session_id, #show_output!, #stringify_output, #suppress_output!, #system_message!, #terminal_sequence, #terminal_sequence!, #transcript_path

Constructor Details

This class inherits a constructor from ClaudeHooks::Base

Class Method Details

.hook_typeObject



7
8
9
# File 'lib/claude_hooks/pre_tool_use.rb', line 7

def self.hook_type
  'PreToolUse'
end

.input_fieldsObject



11
12
13
# File 'lib/claude_hooks/pre_tool_use.rb', line 11

def self.input_fields
  %w[tool_name tool_input tool_use_id]
end

Instance Method Details

#add_additional_context!(context) ⇒ Object



79
80
81
82
# File 'lib/claude_hooks/pre_tool_use.rb', line 79

def add_additional_context!(context)
  @output_data['hookSpecificOutput'] ||= { 'hookEventName' => hook_event_name }
  @output_data['hookSpecificOutput']['additionalContext'] = context
end

#approve_tool!(reason = '') ⇒ Object

OUTPUT DATA HELPERS ===



31
32
33
34
35
36
37
# File 'lib/claude_hooks/pre_tool_use.rb', line 31

def approve_tool!(reason = '')
  @output_data['hookSpecificOutput'] = {
    'hookEventName' => hook_event_name,
    'permissionDecision' => 'allow',
    'permissionDecisionReason' => reason
  }
end

#ask_for_permission!(reason = '') ⇒ Object



47
48
49
50
51
52
53
# File 'lib/claude_hooks/pre_tool_use.rb', line 47

def ask_for_permission!(reason = '')
  @output_data['hookSpecificOutput'] = {
    'hookEventName' => hook_event_name,
    'permissionDecision' => 'ask',
    'permissionDecisionReason' => reason
  }
end

#block_tool!(reason = '') ⇒ Object



39
40
41
42
43
44
45
# File 'lib/claude_hooks/pre_tool_use.rb', line 39

def block_tool!(reason = '')
  @output_data['hookSpecificOutput'] = {
    'hookEventName' => hook_event_name,
    'permissionDecision' => 'deny',
    'permissionDecisionReason' => reason
  }
end

#defer_permission!Object



64
65
66
67
68
69
# File 'lib/claude_hooks/pre_tool_use.rb', line 64

def defer_permission!
  @output_data['hookSpecificOutput'] = {
    'hookEventName' => hook_event_name,
    'permissionDecision' => 'defer'
  }
end

#tool_inputObject



21
22
23
# File 'lib/claude_hooks/pre_tool_use.rb', line 21

def tool_input
  @input_data['tool_input']
end

#tool_nameObject

INPUT DATA ACCESS ===



17
18
19
# File 'lib/claude_hooks/pre_tool_use.rb', line 17

def tool_name
  @input_data['tool_name']
end

#tool_use_idObject



25
26
27
# File 'lib/claude_hooks/pre_tool_use.rb', line 25

def tool_use_id
  @input_data['tool_use_id'] || @input_data['toolUseId']
end

#update_input!(updated_input) ⇒ Object



71
72
73
74
75
76
77
# File 'lib/claude_hooks/pre_tool_use.rb', line 71

def update_input!(updated_input)
  @output_data['hookSpecificOutput'] ||= {
    'hookEventName' => hook_event_name,
    'permissionDecision' => 'allow'
  }
  @output_data['hookSpecificOutput']['updatedInput'] = updated_input
end

#update_tool_input!(updated_input) ⇒ Object



55
56
57
58
59
60
61
62
# File 'lib/claude_hooks/pre_tool_use.rb', line 55

def update_tool_input!(updated_input)
  @output_data['hookSpecificOutput'] ||= {
    'hookEventName' => hook_event_name,
    'permissionDecision' => 'allow'
  }
  @output_data['hookSpecificOutput']['updatedInput'] = updated_input
  @output_data['hookSpecificOutput']['permissionDecision'] = 'allow'
end