Sha256: 044c4e5f3a23a764910cd211d283d8aaa5066056fe8160fba5c0d4317a3bc9c4

Contents?: true

Size: 1.25 KB

Versions: 46

Compression:

Stored size: 1.25 KB

Contents

# frozen_string_literal: true

module ActiveSupport
  # Actionable errors lets 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

46 entries across 43 versions & 8 rubygems

Version Path
activesupport-7.0.8.6 lib/active_support/actionable_error.rb
activesupport-7.0.8.5 lib/active_support/actionable_error.rb
blacklight-spotlight-3.6.0.beta8 vendor/bundle/ruby/3.2.0/gems/activesupport-7.0.8.4/lib/active_support/actionable_error.rb
cm-admin-1.5.22 vendor/bundle/ruby/3.3.0/gems/activesupport-7.0.5.1/lib/active_support/actionable_error.rb
cm-admin-1.5.21 vendor/bundle/ruby/3.3.0/gems/activesupport-7.0.5.1/lib/active_support/actionable_error.rb
cm-admin-1.5.20 vendor/bundle/ruby/3.3.0/gems/activesupport-7.0.5.1/lib/active_support/actionable_error.rb
activesupport-7.0.8.4 lib/active_support/actionable_error.rb
activesupport-7.0.8.1 lib/active_support/actionable_error.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/activesupport-7.0.3.1/lib/active_support/actionable_error.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/activesupport-7.0.2.3/lib/active_support/actionable_error.rb
activesupport-7.0.8 lib/active_support/actionable_error.rb
activesupport-7.0.7.2 lib/active_support/actionable_error.rb
activesupport-7.0.7.1 lib/active_support/actionable_error.rb
activesupport-7.0.7 lib/active_support/actionable_error.rb
mlh-rubocop-config-1.0.2 vendor/bundle/ruby/3.2.0/gems/activesupport-7.0.6/lib/active_support/actionable_error.rb
fablicop-1.10.3 vendor/bundle/ruby/3.2.0/gems/activesupport-7.0.6/lib/active_support/actionable_error.rb
fablicop-1.10.3 vendor/bundle/ruby/3.2.0/gems/activesupport-7.0.5/lib/active_support/actionable_error.rb
activesupport-7.0.6 lib/active_support/actionable_error.rb
activesupport-7.0.5.1 lib/active_support/actionable_error.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/activesupport-7.0.2.3/lib/active_support/actionable_error.rb