claude_hooks 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08b8b23bcfdeed5cf98e3477b6339f29488d6e547fd2fb10ef40947bbc3d45dc'
-  data.tar.gz: 20d0f599bac9dcde566829dabba1d1f3f13756181ed4ea7bbe4cfa1c0a95838a
+  metadata.gz: bbd6349008b693bddb770b79ac5883a746c826a800ed7141f4de466bd88025e0
+  data.tar.gz: b7a724ed1655ecb7c4af3393619e5dd800b0b59a08721c6d4b7279c4d31a185d
 SHA512:
-  metadata.gz: 7cd6ecea85c72ce39e77613f68c3dc9f689aca7611dd499482e20538bbb456e2c6b4c23bc791372173fd4b955e8d4211c3c8c29e0e97957812916f901327ce22
-  data.tar.gz: 93b6032c1c29c11081419d0415dae8ac5cd2494fa558af1637c081ce11d256403c1b26c49740c9aa8294c385aa311b12da2b3e5a6949e88a4a5f892b68abcf54
+  metadata.gz: a1596119ed1ee346ed133a76a0991cc64f8be594905e96e6b056e6e5187be91ca43ffd4c28c3e822725b5ee4bdb0bdbc03aa0cea38c06a5813b94c3a381ff0c3
+  data.tar.gz: 6063e35f39ffabd8eaf78e9deccd009e56f9103c86f69dedb6a2ed66b97cc9a8606d0aafb6ee2467d6fa29536031f4d0d671ff20e466c672009d16e2c2a962ea

data/CHANGELOG.md

@@ -5,6 +5,98 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0] - 2025-08-27
+
+> [!WARNING]
+> These changes are not backward compatible (hence the version bump to 1.0.0), the API has changed too much.
+
+### Changed
+
+#### Revamped documentation
+
+- **New documentation structure**:
+  - **API Reference**: Comprehensive API reference for all hook types
+  - **Common Helpers**: Shared helpers for all hook types
+  - **Output Helpers**: Helpers for working with the output state
+  - **Hook Exit Codes**: Exit codes for each hook type
+  - **Hook Types**: Overview of all hook types and their purpose
+
+#### Added support for SessionEnd
+Handles the new `SessionEnd` hook type.
+
+#### Handles new field for PostToolUse
+`additionalContext` field is now available in the `hookSpecificOutput` field.
+
+#### Output Objects System
+New output handling with intelligent exit code management.
+
+- **Automatic Exit Code Selection**: Output objects automatically choose the correct exit code (0, 1, 2) based on hook type and the state of the hook
+- - **Enhanced Base Class**: All hook instances now automatically get an `@output` attribute with a `output` accessor. They can still access raw `output_data`
+- **Helper Methods**: Access to hook-specific data via methods like `output.blocked?`, `output.allowed?`, `output.should_ask_permission?`
+- **Automatic Stream Selection**: Output objects automatically route to `STDOUT` or `STDERR` based on exit code and hook type
+- **One-Line Output Execution**: New `output_and_exit` method handles JSON serialization, stream selection, and exit code in one call
+- **Object-Based Merging**: New `ClaudeHooks::Output::*.merge()` methods for cleaner multi-hook merging
+- **Comprehensive Output Classes**: Full coverage for all 8 hook types:
+  - `ClaudeHooks::Output::UserPromptSubmit` - Provides `blocked?`, `reason`, `additional_context`
+  - `ClaudeHooks::Output::PreToolUse` - Provides `allowed?`, `denied?`, `should_ask_permission?`
+  - `ClaudeHooks::Output::PostToolUse` - Provides `blocked?`, `reason`
+  - `ClaudeHooks::Output::Stop` - Provides `should_continue?`, `continue_instructions` (inverted logic)
+  - `ClaudeHooks::Output::SubagentStop` - Inherits Stop behavior
+  - `ClaudeHooks::Output::Notification` - Basic output handling
+  - `ClaudeHooks::Output::SessionStart` - Provides `additional_context`
+  - `ClaudeHooks::Output::PreCompact` - Basic output handling
+
+##### Migration Guide
+
+**Before (Old Pattern):**
+```ruby
+#!/usr/bin/env ruby
+require 'claude_hooks'
+
+begin
+  input_data = JSON.parse(STDIN.read)
+  hook = MyHook.new(input_data)
+  result = hook.call
+  
+  # Manual stream and exit code selection
+  if result['continue'] != false
+    if result.dig('hookSpecificOutput', 'permissionDecision') == 'deny'
+      STDERR.puts hook.stringify_output
+      exit 1
+    elsif result.dig('hookSpecificOutput', 'permissionDecision') == 'ask'  
+      STDERR.puts hook.stringify_output
+      exit 2
+    else
+      puts hook.stringify_output
+      exit 0
+    end
+  else # Continue == false
+    STDERR.puts hook.stringify_output
+    exit 2
+  end
+rescue StandardError => e
+  # Error handling...
+end
+```
+
+**After (New Pattern):**
+```ruby
+#!/usr/bin/env ruby
+require 'claude_hooks'
+
+# Just 3 lines for most cases!
+begin
+  input_data = JSON.parse(STDIN.read)
+  hook = MyHook.new(input_data)
+  hook.call
+  
+  # Handles everything automatically!
+  hook.output_and_exit  
+rescue StandardError => e
+  # Error handling...
+end
+```
+
 ## [0.2.1] - 2025-08-21
 
 ### Fixed