rails/actionmailbox/lib/action_mailbox.rb

# frozen_string_literal: true

require "active_support"
require "active_support/rails"
require "active_support/core_ext/numeric/time"

require "action_mailbox/version"
require "action_mailbox/deprecator"
require "action_mailbox/mail_ext"

# :markup: markdown
# :include: ../README.md
module ActionMailbox
  extend ActiveSupport::Autoload

  autoload :Base
  autoload :Router
  autoload :TestCase

  mattr_accessor :ingress
  mattr_accessor :logger
  mattr_accessor :incinerate, default: true
  mattr_accessor :incinerate_after, default: 30.days
  mattr_accessor :queues, default: {}
  mattr_accessor :storage_service
end
Add frozen_string_literal: true to match Rails codebase 2018-12-14 10:06:12 +00:00			`# frozen_string_literal: true`

Fix missing requires in Action Mailbox Previously, trying to `require "action_mailbox"` would fail if Active Support was not previously required. This fixes requiring Action Mailbox by adding the standard "active_support" and "active_support/rails" requires. In addition, this files uses `30.days` and so it needs to require core_ext/numeric/time as well. 2023-01-13 01:13:47 +00:00			`require "active_support"`
			`require "active_support/rails"`
			`require "active_support/core_ext/numeric/time"`

Load version.rb for Action Mailbox and Action Text This matches the other frameworks, ensuring that `ActionMailbox.version` and `ActionText.version` are available when using Action Mailbox and Action Text, respectively. __Before__ ```console $ bin/rails runner 'puts ActiveRecord.version' 7.1.0.alpha $ bin/rails runner 'puts ActionMailbox.version' undefined method `version' for ActionMailbox:Module $ bin/rails runner 'puts ActionText.version' undefined method `version' for ActionText:Module ``` __After__ ```console $ bin/rails runner 'puts ActiveRecord.version' 7.1.0.alpha $ bin/rails runner 'puts ActionMailbox.version' 7.1.0.alpha $ bin/rails runner 'puts ActionText.version' 7.1.0.alpha ``` 2023-01-12 20:16:44 +00:00			`require "action_mailbox/version"`
Add ActionMailbox.deprecator This commit adds `ActionMailbox.deprecator`, and adds it to `Rails.application.deprecators` so that it can be configured via settings such as `config.active_support.report_deprecations`. 2022-11-01 20:06:07 +00:00			`require "action_mailbox/deprecator"`
Extract Mail-bound methods into mail_ext for future upstream work 2018-11-06 00:36:21 +00:00			`require "action_mailbox/mail_ext"`
ActionMailroom -> ActionMailbox We didn't end up using the mailroom metaphor directly, so let's stick with a more conventional naming strategy. 2018-09-28 19:19:43 +00:00
Include READMEs in main framework pages of the API documentation Currently when opening the main framework pages there is no introduction to the framework. Instead we only see a whole lot of modules and the `gem_version` and `version` methods. By including the READMEs using the `:include:` directive each frameworks has a nice introduction. For markdown READMEs we need to add the :markup: directive. [ci-skip] Co-authored-by: zzak <zzakscott@gmail.com> 2023-03-20 20:38:01 +00:00			`# :markup: markdown`
Use relative includes of README's in documentation [ci-skip] The Rails documentation uses the `:include:` directive to inline the README of the framework into the main documentation page. As the README's aren't in the root directory from where SDoc is run we need to add the framework path to the include: # :include: activesupport/README.md This results in a warning when installing the gems as generating the rdoc for the gem is run from the gem/framework root: Couldn't find file to include 'activesupport/README.rdoc' from lib/active_support.rb The `:include:` RDoc directive supports includes relative to the current file as well: # :include: ../README.md This makes sure it works for the Rails API docs and the separate gems. Co-authored-by: Jonathan Hefner <jonathan@hefner.pro> 2024-01-18 09:29:42 +00:00			`# :include: ../README.md`
ActionMailroom -> ActionMailbox We didn't end up using the mailroom metaphor directly, so let's stick with a more conventional naming strategy. 2018-09-28 19:19:43 +00:00			`module ActionMailbox`
			`extend ActiveSupport::Autoload`

			`autoload :Base`
			`autoload :Router`
Autoload ActionMailbox::TestCase 2018-11-07 13:40:00 +00:00			`autoload :TestCase`
Provide a logger 2018-10-01 12:16:10 +00:00
Read ingress passwords/API keys from encrypted credentials Fall back to ENV for people who prefer that approach. 2018-11-05 14:11:01 +00:00			`mattr_accessor :ingress`
Provide a logger 2018-10-01 12:16:10 +00:00			`mattr_accessor :logger`
Allow skipping incineration of processed emails 2019-02-07 00:28:49 +00:00			`mattr_accessor :incinerate, default: true`
Make incineration horizon configurable 2018-10-07 02:23:19 +00:00			`mattr_accessor :incinerate_after, default: 30.days`
Make job queues configurable 2018-11-11 23:23:13 +00:00			`mattr_accessor :queues, default: {}`
Problem: ActionMailbox uses default ActiveStorage service This is imperfect in situations when a separation between regular files (such as uploads) and emails is necessary (for the purposes of regulatory compliance, proper compartmentalization, etc.) Solution: allow configuring ActionMailbox's storage service 2021-06-29 00:02:23 +00:00			`mattr_accessor :storage_service`
ActionMailroom -> ActionMailbox We didn't end up using the mailroom metaphor directly, so let's stick with a more conventional naming strategy. 2018-09-28 19:19:43 +00:00			`end`