e11y 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae952b91e779ee9e04150e324109586016d6dd0e9831d6acf7867e05f686f579
-  data.tar.gz: 8c3a957e11bd4cc84b4f5fa9c90eae3248c083b98a518ee328cad76401d5454b
+  metadata.gz: 4c2fbfb3af2fb95f263bbd3e7068b9096bb3fda318142963d90367e0feabfb9d
+  data.tar.gz: 433928d7153ffce185577c99d82a31a63a25f0720b7c2ea7c27a306425c8abce
 SHA512:
-  metadata.gz: ce56d9787c13db96db175a07418a34b17a43dd11dceb23d463c346abb7082caa1c45151826f6dc59981a069d8f2ec10d0f6eb4516f2da8cbce91754c483bae20
-  data.tar.gz: b5b650f09a2b634e31fedcebd058965dbc9787960769387b12a84bb5c14c96eb68bcc3245d04393bb75d51011dd290064185040daddcbc975aa8a66f6bda1709
+  metadata.gz: 9119ba005f1b8be835aa331e50ecf0ab9c52c8dd13e14c2b9bdfa9f5af3c4341937a9c9f1b7c30b8d43c31b7287d1632221e67c82380b882c770a94af7cf2bbf
+  data.tar.gz: c29c35fffbc7c959cc56e1774338c8717cde744c677d38c98bd308cf96487a8ebe2a57690e82808afec347b5f48497e4ea0536e9067b413c3fa39776f655f266

data/.rspec

@@ -2,3 +2,4 @@
 --format documentation
 --color
 --order random
+--tag ~benchmark

data/.rubocop.yml

@@ -5,6 +5,12 @@
 
 require:
   - rubocop-rspec
+  - rubocop-rspec_rails
+
+plugins:
+  - rubocop-capybara
+  - rubocop-factory_bot
+  - rubocop-performance
 
 AllCops:
   TargetRubyVersion: 3.2
@@ -15,6 +21,7 @@ AllCops:
     - 'vendor/**/*'
     - 'node_modules/**/*'
     - 'tmp/**/*'
+    - 'benchmarks/**/*'
 
 # Metrics
 Metrics/BlockLength:
@@ -52,6 +59,9 @@ RSpec/ExampleLength:
 RSpec/MultipleExpectations:
   Max: 10 # Allow more expectations for integration tests
 
+RSpec/MultipleMemoizedHelpers:
+  Max: 10 # Allow more memoized helpers for complex tests
+
 RSpec/NestedGroups:
   Max: 3
 
@@ -63,7 +73,17 @@ Gemspec/DevelopmentDependencies:
 RSpec/DescribeClass:
   Exclude:
     - "spec/zeitwerk_spec.rb"
+    - "spec/integration/**/*"
 
 # Allow simple doubles for now (will improve in Phase 1)
 RSpec/VerifiedDoubles:
   Enabled: false
+
+# MessageSpies: Prefer explicit expect().to receive() for readability.
+# Large codebase uses this pattern consistently (116 occurrences).
+# Will be gradually migrated to have_received in future.
+RSpec/MessageSpies:
+  Enabled: false
+
+Capybara/RSpec/PredicateMatcher:
+  Enabled: false

data/CHANGELOG.md

@@ -2,25 +2,163 @@
 
 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.1.0/),
+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).
 
 ## [Unreleased]
 
 ### Added
-- Initial gem skeleton setup
-- Zeitwerk autoloading configuration
-- Basic project structure (lib/, spec/, bin/)
-- CI/CD pipeline (GitHub Actions)
-- Documentation framework (YARD, README)
 
-## [0.1.0] - 2026-01-17
+### Changed
+
+### Fixed
+
+### Deprecated
+
+### Removed
+
+### Security
+
+## [0.2.0] - 2026-01-26
 
 ### Added
-- Project initialization
-- Phase 0: Gem Setup & Best Practices Research complete
-- Research documents for 6 successful gems (Devise, Sidekiq, Puma, Dry-rb, Yabeda, Sentry)
-- Best practices synthesis for configuration DSL, testing, documentation, CI/CD, release process
+- Multi-Rails version support (7.0, 7.1, 8.0) (#5)
+  - CI matrix testing across Ruby 3.2, 3.3 with Rails 7.0, 7.1, 8.0
+  - Dynamic Gemfile dependencies based on RAILS_VERSION env var
+  - Support for sqlite3 1.4 (Rails 7.x) and 2.0 (Rails 8.x)
+- Comprehensive test suite documentation in README (#5)
+  - Quick commands using rake tasks
+  - Manual commands for each test suite
+  - Test suite overview with timing and example counts
+  - Development commands reference
+- Climate Control gem for ENV manipulation in tests (#5)
+
+### Fixed
+- **RequestScopedBuffer API method names** (#5)
+  - `start!` → `initialize!` (correct initialization method)
+  - `flush!` → `discard` (for success path - discard buffered events)
+  - `flush_on_error!` → `flush_on_error` (remove bang, method doesn't modify in-place)
+  - This eliminates warning messages during test execution
+  - **BREAKING CHANGE:** If you use `E11y::Buffers::RequestScopedBuffer` directly, update method names
+- Rails instrumentation event namespaces (#5)
+  - Fixed: `"Events::Rails::*"` → `"E11y::Events::Rails::*"`
+  - Resolves uninitialized constant errors in Rails instrumentation
+- Rails 8.0 exception handling test compatibility (#5)
+  - Updated error handling test to support both Rails 7.x and 8.0 behaviors
+  - Rails 8.0 changed: exceptions caught and converted to 500 responses
+  - Rails 7.x: exceptions raised with show_exceptions = false
+- HTTP request format validation (#5)
+  - Now accepts Symbol (e.g., :html, :json) as Rails passes format as Symbol
+  - Removed strict :string type check from format field
+- Integration test isolation issues (#5)
+  - Moved Rails initialization to spec_helper.rb (prevents FrozenError)
+  - Renamed TestJob → DummyTestJob to prevent class conflicts
+  - Fixed railtie integration spec tag isolation
+  - Added File.exist? check for routes file in railtie tests
+- Floating point precision in stratified sampling tests (#5)
+  - Increased upper bound from 0.95 to 0.96 to handle FP precision
+  - Fixes intermittent test failures: expected 0.9500000000000001 to be <= 0.95
+- Test isolation in active_job_spec.rb (#5)
+  - Store and restore original request_buffer.enabled config
+  - Prevents config changes from affecting subsequent tests
+- View rendering instrumentation test (#5)
+  - Added posts/list.html.erb template
+  - Added posts#list action to render HTML views
+  - Implemented complete test for view rendering events (was pending)
+
+### Changed
+- CI workflow now tests against multiple Rails versions (#5)
+  - Matrix: Ruby 3.2, 3.3 × Rails 7.0, 7.1, 8.0
+  - Separate artifact uploads per Ruby/Rails combination
+  - Enhanced test output with Rails version information
+- Improved test execution speed with better organization (#5)
+  - Separate rake tasks: spec:unit, spec:integration, spec:railtie
+  - Unit tests exclude integration and railtie specs
+  - Integration tests run only integration specs
+  - Total: 1729 examples (1672 unit + 36 integration + 21 railtie)
+- RuboCop configuration (#5)
+  - Exclude spec/integration/**/* from RSpec/DescribeClass cop
+  - Integration tests don't always describe a specific class
+
+### Breaking Changes
+
+#### RequestScopedBuffer API (affects only direct usage)
+
+If you use `E11y::Buffers::RequestScopedBuffer` directly in your code, update method names:
+
+**Before (incorrect):**
+```ruby
+E11y::Buffers::RequestScopedBuffer.start!          # ❌ Wrong
+E11y::Buffers::RequestScopedBuffer.flush!          # ❌ Wrong
+E11y::Buffers::RequestScopedBuffer.flush_on_error! # ❌ Wrong
+```
+
+**After (correct):**
+```ruby
+E11y::Buffers::RequestScopedBuffer.initialize!     # ✅ Correct
+E11y::Buffers::RequestScopedBuffer.discard         # ✅ Correct
+E11y::Buffers::RequestScopedBuffer.flush_on_error  # ✅ Correct
+```
+
+**Impact:** LOW - RequestScopedBuffer is an internal API. Most users are not affected as the middleware, ActiveJob, and Sidekiq instrumentations are already updated. Only users who directly call these methods need to update their code.
+
+**Migration:** Search your codebase for `RequestScopedBuffer` and update method names if found.
+
+---
+
+## [0.1.0] - 2026-01-17
+
+Initial release of E11y - Event-driven observability for Rails applications.
+
+### Features
+
+- **Core Event System**
+  - Unified event API with dry-schema validation
+  - Type-safe event schemas
+  - Extensible adapter architecture
+  - Request-scoped debug buffering
+
+- **Rails Integration**
+  - Automatic Rails instrumentation
+  - ActiveJob tracking
+  - Sidekiq middleware
+  - Rails.logger bridge
+  - Trace context propagation
+
+- **Adapters**
+  - Loki (logs)
+  - Prometheus (metrics)
+  - Sentry (errors)
+  - OpenTelemetry (traces)
+  - Elasticsearch (search)
+  - Redis (fast writes)
+  - Audit log (encrypted storage)
+
+- **Advanced Features**
+  - Pattern-based metrics extraction
+  - PII filtering with configurable rules
+  - Stratified sampling
+  - Rate limiting
+  - High-cardinality protection
+  - Error handling with retry and DLQ
+
+- **Developer Experience**
+  - RSpec matchers for testing
+  - InMemory test adapter
+  - Zero-config defaults
+  - Comprehensive documentation
+  - 25+ ADRs and use cases
+
+### Supported Versions
+
+- Ruby: 3.2, 3.3
+- Rails: 8.0
+- RSpec: 3.13+
+
+### Documentation
 
-[Unreleased]: https://github.com/arturseletskiy/e11y/compare/v0.1.0...HEAD
-[0.1.0]: https://github.com/arturseletskiy/e11y/releases/tag/v0.1.0
+- 17 Architecture Decision Records (ADRs)
+- 22 Use Cases with examples
+- Complete API documentation
+- Testing guide
+- Migration guides