breakfalls 0.0.2.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d4211b87bfa47104d17ec238068830d3e46e44ccb1fe59d7f3b1310de1ad0cd
+  data.tar.gz: bdd3e51080a5eaa22b842e763f3944fa97242e99f23ed67962f08af5da09373b
+SHA512:
+  metadata.gz: 32224dfdb64aceacfe69bc34369fb62859c38782032e910f132c4f91856fbc495cfe2048839546173d681196eb9da00a78adc10fa272de225b8b0420b500e96f
+  data.tar.gz: 2f4a27905a399dce2b5501d2ed635da8ce5b893c7e004357f98d5389a31ae1c76f22a05f1326b053a007d3780f5e0dfcc6249a62c759dfb08368ca2ee27a697f

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## [Unreleased]
+
+## [0.0.2.alpha] - 2025-09-21
+
+- Pre-release (alpha): polish README and gemspec; document handler execution order
+- CI: add GitHub Actions to run `rake test` (Ruby 3.1/3.2/3.3)
+- Metadata: set homepage/source/changelog/issues URLs to `atolix/breakfalls`
+
+## [0.1.0] - 2025-09-18
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 atolix
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# Breakfalls
+
+Breakfalls is a tiny Rails helper that lets you register error-handling hooks for your controllers. It installs an around_action wrapper for selected controllers, catches any StandardError, invokes your registered handlers (global and per-controller), and then re-raises the error so your existing error reporting still works.
+
+## Installation
+
+Add to your application's Gemfile and bundle:
+
+```bash
+bundle add breakfalls
+```
+
+Or install directly:
+
+```bash
+gem install breakfalls
+```
+
+Pre-release builds (alpha/beta/rc):
+
+```bash
+# RubyGems
+gem install breakfalls --pre
+
+# Bundler (explicit version pin)
+bundle add breakfalls --version "0.0.2.alpha"
+```
+
+## Usage
+
+1) Tell Breakfalls which controllers to wrap. In an initializer (e.g. `config/initializers/breakfalls.rb`):
+
+```ruby
+# Wrap these controllers with Breakfalls' around_action
+Rails.application.config.breakfalls.controllers = [
+  'UsersController',
+  'Admin::BaseController'
+]
+```
+
+2) Register one or more handlers. Handlers receive `(exception, request, user, params)` in that order.
+
+```ruby
+# Global handler (runs for any wrapped controller)
+Breakfalls.on_error do |exception, request, user, params|
+  Rails.logger.error("[Global] #{exception.class}: #{exception.message} path=#{request&.path}")
+end
+
+# Controller-specific handler (runs before global handlers)
+Breakfalls.on_error_for('UsersController') do |exception, request, user, params|
+  Rails.logger.warn("[UsersController] #{exception.class} at #{request&.path}")
+end
+```
+
+Order of execution: controller-specific handlers (in registration order) then global handlers (in registration order). After handlers run, the exception is re-raised so your existing error handling/reporting still applies.
+
+## Handler order
+
+- Controller-specific first: If the current controller matches, its handlers run before any global handlers.
+- Registration order: Within each group, handlers run in the order they were registered (FIFO).
+- Match scope: Only handlers registered for the exact controller class name run for that controller.
+- Handler failure: If a handler itself raises, remaining handlers are skipped and that exception bubbles up.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then run `rake test` to execute the test suite.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `lib/breakfalls/version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push the tag/commits, and push the `.gem` file to rubygems.org.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/atolix/breakfalls. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Breakfalls project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/atolix/breakfalls/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/breakfalls/railtie.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module Breakfalls
+  class Railtie < ::Rails::Railtie
+    config.breakfalls = ActiveSupport::OrderedOptions.new
+
+    config.to_prepare do
+      controllers = Array(Rails.application.config.breakfalls.controllers)
+      next if controllers.empty?
+
+      controllers.each do |controller|
+        ActiveSupport.on_load(:action_controller) do
+          klass = controller.to_s.safe_constantize
+          klass.class_eval do
+            unless method_defined?(:dispatch_breakfalls)
+              def dispatch_breakfalls
+                yield
+              rescue StandardError => e
+                Breakfalls.run_error_handlers(
+                  e,
+                  request:,
+                  user: (respond_to?(:current_user) ? current_user : nil),
+                  params:,
+                  controller: self.class.name
+                )
+                raise e
+              end
+            end
+          end
+
+          klass.send(:around_action, :dispatch_breakfalls)
+        end
+      end
+    end
+  end
+end

data/lib/breakfalls/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Breakfalls
+  VERSION = '0.0.2.alpha'
+end

data/lib/breakfalls.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'breakfalls/version'
+require 'breakfalls/railtie' if defined?(Rails)
+
+module Breakfalls
+  class << self
+    def error_handlers
+      @error_handlers ||= []
+    end
+
+    # Registry for controller-specific handlers.
+    # Key: controller class name (String); Value: Array<Proc>.
+    def controller_error_handlers
+      @controller_error_handlers ||= Hash.new { |h, k| h[k] = [] }
+    end
+
+    # Register a global error handler (applies to all controllers).
+    # Called in the order they were registered.
+    # Example:
+    #   Breakfalls.on_error do |exception, request, user, params|
+    #     Rails.logger.error("[Global] #{exception.message} path=#{request&.path}")
+    #   end
+    def on_error(&block)
+      error_handlers << block
+    end
+
+    # Register a controller-specific error handler.
+    # The controller argument should be a class name (String or Symbol).
+    # Invocation order at runtime is: controller-specific handlers first, then global handlers.
+    # Within a controller, handlers run in the order they were registered.
+    # Example:
+    #   Breakfalls.on_error_for('UsersController') do |exception, request, user, params|
+    #     Rails.logger.warn("[UsersController] #{exception.class} at #{request&.path}")
+    #   end
+    def on_error_for(controller, &block)
+      key = controller.to_s
+      controller_error_handlers[key] << block
+    end
+
+    # Execute error handlers.
+    # Call order: controller-specific (when controller matches) → global.
+    # Returns: Array of invoked handler Procs.
+    # Example (manual invocation):
+    #   Breakfalls.run_error_handlers(
+    #     RuntimeError.new('boom'),
+    #     request: req,
+    #     user: current_user,
+    #     params: params,
+    #     controller: 'UsersController'
+    #   )
+    def run_error_handlers(exception, request: nil, user: nil, params: nil, controller: nil)
+      handlers = []
+      controller && handlers.concat(controller_error_handlers[controller.to_s])
+      handlers.concat(error_handlers)
+
+      handlers.each do |eh|
+        eh.call(exception, request, user, params)
+      end
+
+      handlers
+    end
+  end
+end

data/sig/breakfalls.rbs

@@ -0,0 +1,4 @@
+module Breakfalls
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: breakfalls
+version: !ruby/object:Gem::Version
+  version: 0.0.2.alpha
+platform: ruby
+authors:
+- atolix
+bindir: exe
+cert_chain: []
+date: 2025-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Breakfalls provides a small Railtie that wraps selected controllers with
+  an around_action. When a StandardError is raised, it invokes your registered handlers
+  (global and per-controller) with (exception, request, user, params), then re-raises
+  so existing error handling continues.
+email:
+- 82761106+atolix@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/breakfalls.rb
+- lib/breakfalls/railtie.rb
+- lib/breakfalls/version.rb
+- sig/breakfalls.rbs
+homepage: https://github.com/atolix/breakfalls
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/atolix/breakfalls
+  source_code_uri: https://github.com/atolix/breakfalls
+  changelog_uri: https://github.com/atolix/breakfalls/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/atolix/breakfalls/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Rails controller error-handling hooks (global and per-controller).
+test_files: []