rails-mailer-sandbox 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30219e130ba9277194b1a2d50207f24bf34f4e495e42643121ae6d4cc7226740
-  data.tar.gz: 89b3f2f7b139d429dcc9dda9defce2ebad882d6d28cd398d28d9204f4917aed8
+  metadata.gz: bf80512fe3b9cd60f5842611ee2a68be8b1f5da0f7198872f5aaf0e62fc9c46a
+  data.tar.gz: 8436ff5fa82cf18b5dcb6ea7a905264fcf4bcb638aa711a2f0808528c0aee986
 SHA512:
-  metadata.gz: 1a3e299b55a9b0182955b80fcb319df145703ce129c8e1faac48e1886c9d724e4555073c665d8a8a5ed8e0388feaa4125cc164071a8994bbd1c2ec8f9cf5abbb
-  data.tar.gz: b84defec8928f86cee0e6a6806a831c044f9f9395e80f99ea61f8f92b99f5b66ae53d91226e1c5d45f74fd9da11af1ce71ef9e74d4772274b1e40c3fe0b01bea
+  metadata.gz: 755b5e8a9368bd55e3c3221494a95aedef5604da4378c32ec62baa84a9754318c5a586a7dc4dd28a4b7a6fb6e1e27409613ed8059d3affba7398f4c6b511d234
+  data.tar.gz: b2a089a3a3b475457052833aac2ba039cd76a7ff39fd25d2bf4aac0c573ebd82cd3e6d7440ec2ae18e77bcd4848964092c604fbb1794bdf4ad88a582cd0b70d2

data/.yardopts

@@ -0,0 +1,8 @@
+--markup markdown
+--readme README.md
+lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+CONTRIBUTING.md
+MIT-LICENSE

data/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to Rails Mailer Sandbox are documented here.
 Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions
 follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.2] - 2026-09-21
+
+### Added
+
+- Rubydoc.info documentation metadata and YARD annotations
+- Documentation status badge in README
+- `.yardopts` configuration file
+
 ## [0.2.1] - 2026-09-13
 
 ### Added
@@ -42,5 +50,6 @@ follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   attachments, automatic refresh, and message deletion
 - `rails_mailer_sandbox:setup` Rake task
 
+[0.2.2]: https://github.com/azmi2409/rails-mailer-sandbox/compare/v0.2.1...v0.2.2
 [0.2.1]: https://github.com/azmi2409/rails-mailer-sandbox/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/azmi2409/rails-mailer-sandbox/releases/tag/v0.2.0

data/README.md

@@ -2,6 +2,7 @@
 
 [![CI](https://github.com/azmi2409/rails-mailer-sandbox/actions/workflows/ci.yml/badge.svg)](https://github.com/azmi2409/rails-mailer-sandbox/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/rails-mailer-sandbox.svg)](https://rubygems.org/gems/rails-mailer-sandbox)
+[![Documentation](https://img.shields.io/badge/docs-rubydoc.info-blue.svg)](https://rubydoc.info/gems/rails-mailer-sandbox)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](MIT-LICENSE)
 
 Catch Rails emails locally before they escape into the wild. Rails Mailer Sandbox stores

data/lib/rails_mailer_sandbox/setup.rb

@@ -3,7 +3,11 @@
 require "fileutils"
 
 module RailsMailerSandbox
+  # Generator for sandbox initializer.
   module Setup
+    # Generates initializer and configures routes.
+    # @param root [String, Pathname] Rails application root path
+    # @return [void]
     def self.run(root)
       root = File.expand_path(root)
       raise "Not a Rails application: #{root}" unless File.file?(File.join(root, "config/application.rb"))

data/lib/rails_mailer_sandbox.rb

@@ -11,21 +11,48 @@ require "mail"
 require "base64"
 require "uri"
 
+# Module for local Action Mailer email preview and storage sandbox.
 module RailsMailerSandbox
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 
   class << self
+    # @return [String, nil]
     attr_writer :storage_path
 
+    # Directory where captured emails are stored.
+    # @return [String]
     def storage_path
       @storage_path || File.join(defined?(Rails) && Rails.respond_to?(:root) && Rails.root ? Rails.root.to_s : Dir.pwd, "tmp", "rails_mailer_sandbox")
     end
   end
 
+  # Represents a captured email message.
   class Message
-    attr_reader :id, :from, :to, :cc, :bcc, :subject, :date, :text_part,
-                :html_part, :raw_source, :attachments
-
+    # @return [String] Unique message identifier
+    attr_reader :id
+    # @return [Array<String>] Sender email addresses
+    attr_reader :from
+    # @return [Array<String>] Recipient email addresses
+    attr_reader :to
+    # @return [Array<String>] CC recipient email addresses
+    attr_reader :cc
+    # @return [Array<String>] BCC recipient email addresses
+    attr_reader :bcc
+    # @return [String] Email subject line
+    attr_reader :subject
+    # @return [Time, DateTime] Message timestamp
+    attr_reader :date
+    # @return [String, nil] Plain text body
+    attr_reader :text_part
+    # @return [String, nil] HTML body
+    attr_reader :html_part
+    # @return [String] Raw MIME message source
+    attr_reader :raw_source
+    # @return [Array<Hash{Symbol => Object}>] Parsed attachments
+    attr_reader :attachments
+
+    # @param mail [Mail::Message]
+    # @param id [String]
     def initialize(mail, id: SecureRandom.uuid)
       @id = id
       @date = mail.date || Time.now
@@ -40,18 +67,23 @@ module RailsMailerSandbox
       @raw_source = "Bcc: #{@bcc.join(', ').gsub(/[\r\n]/, '')}\r\n#{@raw_source}" unless @bcc.empty? || @raw_source.match?(/^Bcc:/i)
     end
 
+    # @return [Array<String>]
     def recipients
       to + cc + bcc
     end
 
+    # @return [String]
     def preview
       text_part.to_s.gsub(/\s+/, " ").strip[0, 140]
     end
 
+    # @return [Integer]
     def size
       raw_source.bytesize
     end
 
+    # @param query [String]
+    # @return [Boolean]
     def matches?(query)
       query.empty? || [subject, *from, *recipients, text_part.to_s].any? { |value| value.downcase.include?(query) }
     end
@@ -97,8 +129,12 @@ module RailsMailerSandbox
     end
   end
 
+  # Thread-safe filesystem storage for captured emails.
   class Storage
     class << self
+      # Stores an email message.
+      # @param mail [Mail::Message]
+      # @return [Message]
       def add(mail)
         message = Message.new(mail)
         locked do |directory|
@@ -117,6 +153,8 @@ module RailsMailerSandbox
         message
       end
 
+      # Returns all stored messages, ordered newest first.
+      # @return [Array<Message>]
       def all
         locked do |directory|
           Dir.glob(File.join(directory, "*.eml")).sort_by { |path| [File.mtime(path), path] }.reverse.map do |path|
@@ -125,6 +163,9 @@ module RailsMailerSandbox
         end
       end
 
+      # Finds message by UUID.
+      # @param id [String]
+      # @return [Message, nil]
       def find(id)
         return unless valid_id?(id)
         locked do |directory|
@@ -133,6 +174,9 @@ module RailsMailerSandbox
         end
       end
 
+      # Deletes message by UUID.
+      # @param id [String]
+      # @return [Boolean, nil]
       def delete(id)
         return unless valid_id?(id)
         locked do |directory|
@@ -141,10 +185,14 @@ module RailsMailerSandbox
         end
       end
 
+      # Clears all stored messages.
+      # @return [Array<String>]
       def clear
         locked { |directory| Dir.glob(File.join(directory, "*.eml")).each { |path| File.delete(path) } }
       end
 
+      # Returns count of stored messages.
+      # @return [Integer]
       def count
         locked { |directory| Dir.glob(File.join(directory, "*.eml")).size }
       end
@@ -169,18 +217,25 @@ module RailsMailerSandbox
     end
   end
 
+  # Action Mailer delivery method for sandbox storage.
   class DeliveryMethod
+    # @return [Hash]
     attr_accessor :settings
 
+    # @param values [Hash]
     def initialize(values = {})
       @settings = values
     end
 
+    # Stores incoming email.
+    # @param mail [Mail::Message]
+    # @return [Message]
     def deliver!(mail)
       Storage.add(mail)
     end
   end
 
+  # Rack application providing Web UI to inspect captured emails.
   class Server
     SECURITY_HEADERS = {
       "content-security-policy" => "default-src 'self'; style-src 'unsafe-inline'; script-src 'unsafe-inline'; frame-src 'self'; img-src 'self' data:; object-src 'none'; base-uri 'none'; frame-ancestors 'self'",
@@ -189,6 +244,9 @@ module RailsMailerSandbox
       "x-frame-options" => "SAMEORIGIN"
     }.freeze
 
+    # Rack call entrypoint.
+    # @param env [Hash]
+    # @return [Array]
     def call(env)
       request = Rack::Request.new(env)
       response = route(request)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-mailer-sandbox
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - azmimuwahid
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - MIT-LICENSE
@@ -84,7 +85,10 @@ files:
 homepage: https://github.com/azmi2409/rails-mailer-sandbox
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://rubydoc.info/gems/rails-mailer-sandbox
+  source_code_uri: https://github.com/azmi2409/rails-mailer-sandbox
+  changelog_uri: https://github.com/azmi2409/rails-mailer-sandbox/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib