action_mailer_auto_previews 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52bad65f9a1b0bca6857aa3b2dbb75f0c3395394
+  data.tar.gz: c9965341bf8952cdeb4790dc6531489d683bb048
+SHA512:
+  metadata.gz: 7c284d8ff304d7b77e9c463b84c171674f3933661ba9baf73412545303feec2919624f344f3deab9b2376f324ac9a77dd2fb535dbe4ceca83f0d6f655c5396cb
+  data.tar.gz: 312c392ea209c157da007b6589c5e43ba884080cac51ff34f59a02cb82e85ccbedd899f6808d749584652413382f98cc34e0a286d15d7cdfec897d5ed4729bf4

data/.yardoc/checksums

@@ -0,0 +1,2 @@
+lib/action_mailer_auto_previews.rb 0e0dfb0d8eb7fecfc1b4ef19108844a138fdbd73
+lib/action_mailer_auto_previews/version.rb 7ff771be0445f700b37db11ae255f4114960eb34

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in action_mailer_auto_previews.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Matthew B. Jones
+
+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,51 @@
+# ActionMailerAutoPreviews
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/action_mailer_auto_previews`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile :development group:
+
+```ruby
+group :development do
+  gem 'action_mailer_auto_previews'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_mailer_auto_previews
+
+## Usage
+
+That's it! Simply include the gem in your Gemfile's :development group, and by default, you will be able to automatically see previews of your ActionMailer emails. Whenever `deliver` or `deliver_later`
+is called on one of your ActionMailers, the gem will automatically generate the ActionMailer::Preview required and open the preview in your default browser. However, there are several configuration options
+that can be used to alter this behavior.
+
+## Configuration Options
+```ruby
+ActionMailerAutoPreviews.setup do |config|
+  config.enabled = true
+  config.history_limit = 10
+  config.intercept_mode = :preview_only # [:preview_only, :preview_and_deliver]
+  config.launch_browser = true
+  config.logger = Rails.logger
+  config.preview_host_url = "http://localhost:3000"
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/makifund/action_mailer_auto_previews.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/action_mailer_auto_previews.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_mailer_auto_previews/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_mailer_auto_previews"
+  spec.version       = ActionMailerAutoPreviews::VERSION
+  spec.authors       = ["Matthew B. Jones", "Andrew Yi"]
+  spec.email         = ["matt@makifund.com", "andrew@makifund.com"]
+
+  spec.summary       = %q{
+    Enhances the ActionMailer Previews introduced in 4.1 by automatically creating ActionMailer Previews at runtime in development mode.
+  }
+  spec.description   = %q{
+    Enhances the ActionMailer Previews introduced in 4.1 by automatically creating ActionMailer Previews at runtime in development mode.
+    See automatic previews of your ActionMailer emails, with no extra effort or mock data. Install the action_mailer_auto_previews gem
+    into your :development group, and it'll 'just work' with sensible defaults. Each ActionMailer email object that has .deliver or
+    .deliver_later called will automatically launch your default browser right to a ActionMailer Preview page with the real data
+    passed to that email. Flexible options allow you to alter this behavior as well.
+
+    Warning: Since this is dynamically creating Ruby classes/methods, you will want to make sure your web-server is single threaded.
+    For example, if you're using Puma, be sure to set the `workers` configuration parameter to 1.
+  }
+  spec.homepage      = "https://github.com/makifund/action_mailer_auto_previews"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "actionmailer", "~> 4.1"
+  spec.add_dependency "launchy", "~> 2.4.3"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "action_mailer_auto_previews"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/action_mailer_auto_previews.rb

@@ -0,0 +1,107 @@
+require "action_mailer_auto_previews/version"
+require "launchy"
+
+# This gem uses sensible defaults, but can be altered as follows:
+# @example
+#  ActionMailerAutoPreviews.setup do |config|
+#    config.enabled = true
+#    config.history_limit = 10
+#    config.intercept_mode = :preview_only
+#    config.launch_browser = true
+#    config.logger = Rails.logger
+#    config.preview_host_url = "http://localhost:3000"
+#  end
+module ActionMailerAutoPreviews
+  # This is a cache that holds onto the Mail objects for viewing via the ActionMailer::Preview web pages. This
+  # cache will grow up the max capacity defined in the :history_limit attribute.
+  MAIL_CACHE = {}
+
+  mattr_accessor :enabled
+  # Whether or not this gem and its functionality should be enabled
+  @@enabled = Rails.env.development?
+
+  mattr_accessor :history_limit
+  # The maximum number of emails to keep around in MAIL_CACHE
+  @@history_limit = 25
+
+  mattr_accessor :intercept_mode
+  # Whether to generate the Preview only (:preview_only), or, to generate the Preview and also do the default Mailer behavior
+  @@intercept_mode = :preview_only
+
+  mattr_accessor :launch_browser
+  # Automatically launch the Preview in the default browser, otherwise, logs the new Preview URL to the logger
+  @@launch_browser = true
+
+  mattr_accessor :logger
+  # Logger to be used. When nil (default), will use Rails.logger if Rails is present, otherwise, defaults to Logger.new(STDOUT)
+  @@logger = nil
+
+  mattr_accessor :preview_host_url
+  # Base URL that is used for the Preview URLs. This should be set to the hostname and port of your development server.
+  @@preview_host_url = "http://localhost:3000"
+
+  # Call with a block to override one or more of the default configuration options.
+  # @example
+  #  ActionMailerAutoPreviews.setup do |config|
+  #    config.launch_browser = false
+  #    config.history_limit = 10
+  #  end
+  def self.setup
+    yield self
+  end
+
+  private
+  # Logic to return the appropriate logger to be used by this gem
+  def self.logger
+    @@logger ||= Object.const_defined?('Rails') ? Rails.logger : Logger.new(STDOUT)
+  end
+
+  # This method is the magic sauce of what we're trying to achieve. It is called via the patch on ActionMailer::MessageDelivery
+  def self.auto_preview(message_delivery)
+    # Generate a unique preview key
+    preview_key = "preview_#{Time.now.to_i}#{rand(1000)}"
+
+    # Store the message object that contains the data for the preview
+    ActionMailerAutoPreviews::MAIL_CACHE[preview_key] = message_delivery
+
+    # Dynamically add a ActionMailer::Preview method, named after `preview_key`
+    eval %Q(
+      class ActionMailerAutoPreviews::AutomaticPreviewMailer < ActionMailer::Preview
+        define_method("#{preview_key}") do
+          ActionMailerAutoPreviews::MAIL_CACHE["#{preview_key}"]
+        end
+      end
+    )
+
+    # Launch the default browser to the newly-available ActionMailer::Preview
+    preview_url = "#{ActionMailerAutoPreviews.preview_host_url}/rails/mailers/action_mailer_auto_previews/automatic_preview_mailer/#{preview_key}"
+    ActionMailerAutoPreviews.launch_browser ? Launchy.open(preview_url) : ActionMailerAutoPreviews.logger.info("New ActionMailer::Preview available at #{preview_url}")
+
+    # Clean up the cache if the number of generated previews now exceeds `history_limit`
+    if ActionMailerAutoPreviews::MAIL_CACHE.count > ActionMailerAutoPreviews.history_limit
+      preview_key_to_purge = ActionMailerAutoPreviews::MAIL_CACHE.keys.first # Get the oldest preview_key
+      ActionMailerAutoPreviews::MAIL_CACHE.delete preview_key_to_purge # Delete the reference to the mail object
+      eval %Q(
+        class ActionMailerAutoPreviews::AutomaticPreviewMailer < ActionMailer::Preview
+          remove_method("#{preview_key_to_purge}")
+        end
+      ) # Removes the ActionMailer::Preview method, so the Preview is no longer available and the old URL will stop functioning
+      ActionMailerAutoPreviews.logger.info("ActionMailer::Preview #{preview_key_to_purge} has been purged, history buffer is full")
+    end
+  end
+
+  # Check to see if we should be enabled or not, and if so, patch into ActionMailer
+  if ActionMailerAutoPreviews.enabled
+    class ActionMailer::MessageDelivery
+      def deliver(options={})
+        ActionMailerAutoPreviews.auto_preview(self)
+        super(options) if ActionMailerAutoPreviews.intercept_mode == :preview_and_deliver
+      end
+
+      def deliver_later(options={})
+        ActionMailerAutoPreviews.auto_preview(self)
+        super(options) if ActionMailerAutoPreviews.intercept_mode == :preview_and_deliver
+      end
+    end
+  end
+end

data/lib/action_mailer_auto_previews/version.rb

@@ -0,0 +1,4 @@
+module ActionMailerAutoPreviews
+  # @private
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: action_mailer_auto_previews
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew B. Jones
+- Andrew Yi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+description: "\n    Enhances the ActionMailer Previews introduced in 4.1 by automatically
+  creating ActionMailer Previews at runtime in development mode.\n    See automatic
+  previews of your ActionMailer emails, with no extra effort or mock data. Install
+  the action_mailer_auto_previews gem\n    into your :development group, and it'll
+  'just work' with sensible defaults. Each ActionMailer email object that has .deliver
+  or\n    .deliver_later called will automatically launch your default browser right
+  to a ActionMailer Preview page with the real data\n    passed to that email. Flexible
+  options allow you to alter this behavior as well.\n\n    Warning: Since this is
+  dynamically creating Ruby classes/methods, you will want to make sure your web-server
+  is single threaded.\n    For example, if you're using Puma, be sure to set the `workers`
+  configuration parameter to 1.\n  "
+email:
+- matt@makifund.com
+- andrew@makifund.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardoc/checksums"
+- ".yardoc/object_types"
+- ".yardoc/objects/root.dat"
+- ".yardoc/proxy_types"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_mailer_auto_previews.gemspec
+- bin/console
+- bin/setup
+- lib/action_mailer_auto_previews.rb
+- lib/action_mailer_auto_previews/version.rb
+homepage: https://github.com/makifund/action_mailer_auto_previews
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Enhances the ActionMailer Previews introduced in 4.1 by automatically creating
+  ActionMailer Previews at runtime in development mode.
+test_files: []
+has_rdoc: