Sha256: a57eaf21ae40afe182539153f14b2685788d0e6d10fddd9d07ca6786633e187c

Contents?: true

Size: 1.25 KB

Versions: 90

Compression:

Stored size: 1.25 KB

Contents

# frozen_string_literal: true

module ActiveSupport
  # Actionable errors let's you define actions to resolve an error.
  #
  # To make an error actionable, include the <tt>ActiveSupport::ActionableError</tt>
  # module and invoke the +action+ class macro to define the action. An action
  # needs a name and a block to execute.
  module ActionableError
    extend Concern

    class NonActionable < StandardError; end

    included do
      class_attribute :_actions, default: {}
    end

    def self.actions(error) # :nodoc:
      case error
      when ActionableError, -> it { Class === it && it < ActionableError }
        error._actions
      else
        {}
      end
    end

    def self.dispatch(error, name) # :nodoc:
      actions(error).fetch(name).call
    rescue KeyError
      raise NonActionable, "Cannot find action \"#{name}\""
    end

    module ClassMethods
      # Defines an action that can resolve the error.
      #
      #   class PendingMigrationError < MigrationError
      #     include ActiveSupport::ActionableError
      #
      #     action "Run pending migrations" do
      #       ActiveRecord::Tasks::DatabaseTasks.migrate
      #     end
      #   end
      def action(name, &block)
        _actions[name] = block
      end
    end
  end
end

Version data entries

90 entries across 88 versions & 13 rubygems

Version Path
activesupport-6.1.6 lib/active_support/actionable_error.rb
activesupport-6.1.5.1 lib/active_support/actionable_error.rb
activesupport-6.0.4.8 lib/active_support/actionable_error.rb
activesupport-6.1.5 lib/active_support/actionable_error.rb
activesupport-6.1.4.7 lib/active_support/actionable_error.rb
activesupport-6.0.4.7 lib/active_support/actionable_error.rb
activesupport-6.1.4.6 lib/active_support/actionable_error.rb
activesupport-6.0.4.6 lib/active_support/actionable_error.rb
activesupport-6.0.4.5 lib/active_support/actionable_error.rb
activesupport-6.1.4.5 lib/active_support/actionable_error.rb
ric-0.14.2 vendor/bundle/ruby/2.7.0/gems/activesupport-6.1.4.4/lib/active_support/actionable_error.rb
ric-0.14.1 vendor/bundle/ruby/2.7.0/gems/activesupport-6.1.4.4/lib/active_support/actionable_error.rb
phillipug-foodie-0.1.0 .vendor/ruby/3.0.0/gems/activesupport-6.1.4.4/lib/active_support/actionable_error.rb
ric-0.14.0 vendor/bundle/ruby/2.7.0/gems/activesupport-6.1.4.4/lib/active_support/actionable_error.rb
activesupport-6.1.4.4 lib/active_support/actionable_error.rb
activesupport-6.0.4.4 lib/active_support/actionable_error.rb
activesupport-6.1.4.3 lib/active_support/actionable_error.rb
activesupport-6.0.4.3 lib/active_support/actionable_error.rb
activesupport-6.0.4.2 lib/active_support/actionable_error.rb
activesupport-6.1.4.2 lib/active_support/actionable_error.rb