mailer_preview_request_model 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3fdd30fb4d510f4b86fc148179f9a95cfa43b9bb
+  data.tar.gz: 0650358a6b09c043bcef81682140e45b4eabeb5d
+SHA512:
+  metadata.gz: 391fb7a7f617b12d8538d9d5870ebf65c46c984c2632ad501d637741289be775d2c816a7e81c06e11acd3c3de2e7c36df1bb53776b0b0957129a9b3293049316
+  data.tar.gz: 7ca0012084a3c127e8b49cdb69b715bd35d177bbaeebedb9c37e6c4dbb38f340657bbff3196c121c7a2c1b5f977020506c3ccbf2d621d93d7ba2bacc11798255

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,116 @@
+# MailerPreviewRequestModel
+
+This gem will patch Rails untill I convince Rails team to merge [PR 20646](https://github.com/rails/rails/pull/20646),
+that will enable Mailer Preview to pass params from Controller.
+
+references:
+
+* https://github.com/rails/rails/pull/20646
+* https://github.com/rails/rails/pull/20608
+* http://stackoverflow.com/questions/29129542/access-request-parameters-in-rails-4-1-mailer-preview
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mailer_preview_request_model'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+By default you will have access to method `mailer_model`  which is equal
+to controller `params`
+
+
+```ruby
+class MyMailerPreview < ActionMailer::Preview
+  def good_news
+    MyMailer.good_news(client)
+  end
+
+  private
+     def client
+       @client ||= Client.find(request_model.fetch(:client_id))
+     end
+end
+```
+
+`http://0.0.0.0:3000/rails/mailers/my_mailer?client_id=123`
+
+But you can extend it to do more complex stuff (like authentication
+objects) ... and teoretically you can have this on some Staging server
+to preview email templates and stuff.
+
+```
+# config/initializer/mailer_preview.rb
+
+module OverrideRequestModel
+  def self.prepended(base)
+     base.before_action :authenticate!
+  end
+
+  def request_model
+     OpenStruct.new(user: current_user, client_id: params[:client_id])
+  end
+
+  def current_user
+    User.find session[:current_user_id]
+  end
+
+  def authenticate!
+     raise "not authenticated" unless current_user.admin?
+  end
+end
+
+Rails::MailersController.prepend OverrideRequestModel
+```
+
+```ruby
+# app/mailer_previews/my_mailer_preview.rb
+class MyMailerPreview < ActionMailer::Preview
+
+  def good_news
+    do_some_stuff_with_user_object
+    MyMailer.good_news(client)
+  end
+
+  private
+     def do_some_stuff_with_user_object
+        request_model.user.do_some_stuff
+     end
+
+     def client
+        Client.find(request_model.client_id) 
+     end
+end
+```
+
+`http://0.0.0.0:3000/rails/mailers/my_mailer/good_news?user_id:123&client_id:345`
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mailer_preview_request_model/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+### Abount the code
+
+The original code of Mailer Preview is composed of long methods with too
+much responsibilities. In order to make this patch work I needed to copy
+relativly large chunks of original code and extend the original with it
+alteration.
+
+### Trobleshooting dev enviroment
+
+* if Nokogiri fails to install make sure you have `zlib1g-dev` installed
+
+## Todo: 
+
+* ApplicationTests::MailerPreviewsTest 

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mailer_preview_request_model"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mailer_preview_request_model.rb

@@ -0,0 +1,66 @@
+require "mailer_preview_request_model/version"
+
+module MailerPreviewRequestModel
+  module PreviewWithRequestModel
+    def self.prepended(base)
+      base.send :attr_accessor, :request_model
+    end
+  end
+
+  module MailersControllerWithRequestModel
+    def preview
+      if params[:path] == @preview.preview_name
+        @page_title = "Mailer Previews for #{@preview.preview_name}"
+        render action: 'mailer'
+      else
+        email = File.basename(params[:path])
+
+        if @preview.email_exists?(email)
+          @email = @preview.call(email, request_model)
+
+          if params[:part]
+            part_type = Mime::Type.lookup(params[:part])
+
+            if part = find_part(part_type)
+              response.content_type = part_type
+              render text: part.respond_to?(:decoded) ? part.decoded : part
+            else
+              raise AbstractController::ActionNotFound, "Email part '#{part_type}' not found in #{@preview.name}##{email}"
+            end
+          else
+            @part = find_preferred_part(request.format, Mime::HTML, Mime::TEXT)
+            render action: 'email', layout: false, formats: %w[html]
+          end
+        else
+          raise AbstractController::ActionNotFound, "Email '#{email}' not found in #{@preview.name}"
+        end
+      end
+    end
+
+    protected
+
+    def request_model
+      params
+    end
+  end
+end
+
+ActionMailer::Preview.prepend MailerPreviewRequestModel::PreviewWithRequestModel
+Rails::MailersController.prepend MailerPreviewRequestModel::MailersControllerWithRequestModel
+
+# due to original code in Rails beeing not extendable I cannot do
+#   ActionMailer::Preview.extend MailerPreviewRequestModel::PreviewWithRequestModel::ClassMethods
+# therefore I need to monkey patch the class method
+module ActionMailer
+  class Preview
+    class << self
+      def call(email, request_model)
+        preview = self.new
+        preview.request_model = request_model
+        message = preview.public_send(email)
+        inform_preview_interceptors(message)
+        message
+      end
+    end
+  end
+end

data/lib/mailer_preview_request_model/version.rb

@@ -0,0 +1,3 @@
+module MailerPreviewRequestModel
+  VERSION = "1.0.0"
+end

data/mailer_preview_request_model.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mailer_preview_request_model/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mailer_preview_request_model"
+  spec.version       = MailerPreviewRequestModel::VERSION
+  spec.authors       = ["Tomas Valent"]
+  spec.email         = ["equivalent@eq8.eu"]
+
+  spec.summary       = %q{Enable Rails ActionMailer Preview to accept argumeents}
+  spec.description   = %q{gem to patch Rails untill PR 20646 https://github.com/rails/rails/pull/20646 is merged that will enable Mailer Preview to pass params}
+  spec.homepage      = "https://github.com/equivalent/mailer_preview_request_model"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_dependency "railties", "~> 4.1"
+  spec.add_dependency "actionmailer", "~> 4.1"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: mailer_preview_request_model
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tomas Valent
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  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: 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: gem to patch Rails untill PR 20646 https://github.com/rails/rails/pull/20646
+  is merged that will enable Mailer Preview to pass params
+email:
+- equivalent@eq8.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mailer_preview_request_model.rb
+- lib/mailer_preview_request_model/version.rb
+- mailer_preview_request_model.gemspec
+homepage: https://github.com/equivalent/mailer_preview_request_model
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: Enable Rails ActionMailer Preview to accept argumeents
+test_files: []