simple_email_preview 1.0.0

data/config/locales/ru.yml

@@ -0,0 +1,51 @@
+---
+ru:
+  rep:
+    headers:
+      subject: "Тема"
+      from: "Отправитель"
+      to: "Получатель"
+      reply_to: "Ответ на"
+      cc: "Копия"
+      bcc: "Скрытая копия"
+      attachments: "Вложения"
+    base:
+      email:
+        one: "%{count} письмо"
+        few: "%{count} письма"
+        many: "%{count} писем"
+        other: "%{count} письма"
+      in: "в"
+      mailer:
+        one: "%{count}-й коллекции"
+        few: "%{count}-х коллекциях"
+        many: "%{count}-и коллекциях"
+        other: "%{count} коллекциях"
+      loading: "Письмо загружается..."
+    test_deliver:
+      no_delivery_method: "Настройте 'config.action_mailer.delivery_method', чтобы отправлять письма в среде '%{environment}'"
+      provide_email: "На какой адрес отправить?"
+      sent_notice: "Оправлено на %{address} через %{delivery_method}"
+    errors:
+      email_missing_format: "Формат отсутствует"
+  layouts:
+    simple_email_preview:
+      application:
+        head_title: "Письма - REP"
+  simple_email_preview:
+    emails:
+      index:
+        list_title: "Письма от приложения"
+      show:
+        breadcrumb_list: "Письма"
+      send_form:
+        send_are_you_sure: "Письмо будет по-настоящему отправлено. Продолжить?"
+        send_btn: "Отправить на"
+        send_recipient_placeholder: "Адрес эл. почты"
+  integrations:
+    cms:
+      errors:
+        site_missing: Сначала создайте сайт для %{locale} в CMS (отметьте опцию "Mirrored").
+      customize_cms_for_simple_email_preview:
+        edit_email: "Редактировать"
+        view_link: "Показать"

data/config/routes.rb

@@ -0,0 +1,23 @@
+SimpleEmailPreview::Engine.routes.draw do
+  controller :emails do
+    scope path: '(:email_locale)',
+          # This constraint resolves ambiguity with :preview_id, allowing locale to be optional
+          constraints: { email_locale: /#{I18n.available_locales.map(&Regexp.method(:escape)) * '|'}/ },
+          defaults: { email_locale: I18n.default_locale.to_s } do
+      get '/' => :index, as: :rep_emails
+      scope path: ':preview_id', constraints: { preview_id: /\w+-\w+/ } do
+        scope '(:part_type)',
+              constraints: { part_type: /html|plain|raw/ },
+              defaults: { part_type: 'html' } do
+          get '' => :show, as: :rep_email
+          get 'body' => :show_body, as: :rep_raw_email
+        end
+        post 'deliver' => :test_deliver, as: :rep_test_deliver
+        get 'attachments/:filename' => :show_attachment, as: :rep_raw_email_attachment
+        get 'headers' => :show_headers, as: :rep_email_headers
+      end
+      # alias rep_emails_url to its stable api name
+      get '/' => :index, as: :rep_root
+    end
+  end
+end

data/lib/generators/simple_email_preview/install_generator.rb

@@ -0,0 +1,17 @@
+module SimpleEmailPreview
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'creates an initializer file at config/initializers/simple_email_preview.rb and adds REP route to config/routes.rb'
+      source_root File.expand_path('../../..', __dir__)
+
+      def generate_initialization
+        copy_file 'config/initializers/simple_email_preview.rb', 'config/initializers/simple_email_preview.rb'
+      end
+
+      def generate_routing
+        route "mount SimpleEmailPreview::Engine, at: 'emails'"
+        log "# You can access REP urls like this: simple_email_preview.rep_emails_url #=> '/emails'"
+      end
+    end
+  end
+end

data/lib/generators/simple_email_preview/update_previews_generator.rb

@@ -0,0 +1,45 @@
+module SimpleEmailPreview
+  module Generators
+    class UpdatePreviewsGenerator < Rails::Generators::Base
+      desc 'creates app/mailer_previews/NEW_MAILER_preview.rb for each new mailer'
+      def generate_mailer_previews
+        previews_dir = 'app/mailer_previews/'
+        empty_directory previews_dir
+        Dir['app/mailers/*.rb'].each do |p|
+          basename = File.basename(p, '.rb')
+          if basename == 'application_mailer' || File.read(p) !~ /\bdef\s/
+            shell.say_status :skip, basename, :blue
+            next
+          end
+          preview_path = File.join(previews_dir, "#{basename}_preview.rb")
+          if File.exist?(preview_path)
+            shell.say_status :exist, preview_path, :blue
+            next
+          end
+          create_file preview_path, mailer_class_body(basename.camelize)
+        end
+      end
+
+      private
+
+      def mailer_class_body(mailer_class_name)
+        <<-RUBY
+class #{mailer_class_name}Preview
+#{(mailer_methods(mailer_class_name) * "\n\n").chomp}
+end
+RUBY
+      end
+
+      def mailer_methods(mailer_class_name)
+        mailer_class = mailer_class_name.constantize
+        ::SimpleEmailPreview::Preview.mail_methods(mailer_class).map do |m|
+          <<-RUBY
+  def #{m}
+    #{mailer_class_name}.#{m} #{mailer_class.instance_method(m).parameters.map(&:second) * ', '}
+  end
+RUBY
+        end
+      end
+    end
+  end
+end

data/lib/simple_email_preview.rb

@@ -0,0 +1,105 @@
+
+require 'simple_email_preview/engine'
+require 'simple_email_preview/main_app_route_delegator'
+require 'simple_email_preview/version'
+require 'simple_email_preview/delivery_handler'
+require 'simple_email_preview/view_hooks'
+
+require 'sassc-rails'
+require 'request_store'
+require 'turbolinks'
+require 'pathname'
+require 'breadcrumbs_on_rails'
+module SimpleEmailPreview
+  mattr_accessor :parent_controller
+  self.parent_controller = '::ApplicationController'
+
+  # preview class names
+  mattr_accessor :preview_classes
+
+  # UI locale
+  mattr_accessor :locale
+
+  # default email locale
+  mattr_accessor :default_email_locale
+
+  # send email button
+  mattr_accessor :enable_send_email
+  self.enable_send_email = true
+
+  # some easy visual settings
+  mattr_accessor :style
+  self.style = {
+    btn_active_class_modifier: 'rep--btn-active',
+    btn_danger_class:          'rep--btn rep--btn-danger',
+    btn_default_class:         'rep--btn rep--btn-default',
+    btn_group_class:           'rep--btn-group',
+    btn_primary_class:         'rep--btn rep--btn-primary',
+    form_control_class:        'rep--form-control',
+    list_group_class:          'rep--list-group',
+    list_group_item_class:     'rep--list-group__item',
+    row_class:                 'rep--row'
+  }
+
+  @view_hooks = SimpleEmailPreview::ViewHooks.new
+  class << self
+    # @return [SimpleEmailPreview::ViewHooks]
+    attr_reader :view_hooks
+
+    def preview_classes=(classes)
+      @preview_classes = classes
+      SimpleEmailPreview::Preview.load_all(classes)
+    end
+
+    def find_preview_classes(dir)
+      return [] unless File.directory?(dir)
+      Dir.chdir(dir) { Dir['**/*_preview.rb'].map { |p| p.sub(/\.rb$/, '').camelize } }
+    end
+
+    def layout=(layout)
+      [::SimpleEmailPreview::ApplicationController, ::SimpleEmailPreview::EmailsController].each { |ctrl| ctrl.layout layout }
+      if layout && layout !~ %r{^simple_email_preview/}
+        # inline application routes if using an app layout
+        inline_main_app_routes!
+      end
+    end
+
+    def run_before_render(mail, preview)
+      (defined?(@hooks) && @hooks[:before_render] || []).each do |block|
+        block.call(mail, preview)
+      end
+    end
+
+    def before_render(&block)
+      inline_main_app_routes!
+      ((@hooks ||= {})[:before_render] ||= []) << block
+    end
+
+    def inline_main_app_routes!
+      unless ::SimpleEmailPreview::EmailsController.instance_variable_get(:@inlined_routes)
+        ::SimpleEmailPreview::EmailsController.helper ::SimpleEmailPreview::MainAppRouteDelegator
+        ::SimpleEmailPreview::EmailsController.instance_variable_set(:@inlined_routes, true)
+      end
+    end
+
+    def setup
+      yield self
+    end
+  end
+
+  # = Editing settings
+  # edit link is rendered inside an iframe, so these options are provided for simple styling
+  mattr_accessor :edit_link_text
+  self.edit_link_text = '✎ Edit Text'
+  mattr_accessor :edit_link_style
+  self.edit_link_style = <<-CSS.strip.gsub(/\n+/m, ' ')
+  display: block;
+  font-family: Monaco, Helvetica, sans-serif;
+  color: #7a4b8a;
+  border: 2px dashed #7a4b8a;
+  font-size: 20px;
+  padding: 8px 12px;
+  margin-top: 0.6em;
+  margin-bottom: 0.6em;
+  CSS
+end

data/lib/simple_email_preview/delivery_handler.rb

@@ -0,0 +1,15 @@
+module SimpleEmailPreview
+  class DeliveryHandler
+    def initialize(mail, headers)
+      @mail = mail
+      @mail.headers(headers)
+      @mail.delivery_handler = self
+    end
+
+    attr_accessor :mail
+
+    def deliver_mail(_mail)
+      yield
+    end
+  end
+end

data/lib/simple_email_preview/engine.rb

@@ -0,0 +1,14 @@
+module ::SimpleEmailPreview
+  class Engine < Rails::Engine
+    isolate_namespace SimpleEmailPreview
+    load_generators
+
+    initializer 'simple_email_preview.setup_assets' do
+      SimpleEmailPreview::Engine.config.assets.precompile += %w[
+        simple_email_preview/application.js
+        simple_email_preview/application.css
+        simple_email_preview/favicon.png
+      ]
+    end
+  end
+end

data/lib/simple_email_preview/main_app_route_delegator.rb

@@ -0,0 +1,20 @@
+module SimpleEmailPreview::MainAppRouteDelegator
+  # delegate url helpers to main_app
+  def method_missing(method, *args, &block)
+    if main_app_route_method?(method)
+      main_app.send(method, *args)
+    else
+      super
+    end
+  end
+
+  def respond_to?(method)
+    super || main_app_route_method?(method)
+  end
+
+  private
+
+  def main_app_route_method?(method)
+    method.to_s =~ /_(?:path|url)$/ && main_app.respond_to?(method)
+  end
+end

data/lib/simple_email_preview/version.rb

@@ -0,0 +1,3 @@
+module SimpleEmailPreview
+  VERSION = '1.0.0'.freeze
+end

data/lib/simple_email_preview/view_hooks.rb

@@ -0,0 +1,102 @@
+module SimpleEmailPreview
+  # Add hooks before, after, or replacing a UI element
+  class ViewHooks
+    args = {
+      index: %i[list previews].freeze,
+      show:  %i[mail preview].freeze
+    }
+    # All valid hooks and their argument names
+    SCHEMA = {
+      list:            args[:index],
+      breadcrumb:      args[:show],
+      breadcrumb_content: args[:show],
+      headers_and_nav: args[:show],
+      headers:         args[:show],
+      headers_content: args[:show],
+      nav:             args[:show],
+      nav_i18n:        args[:show],
+      nav_format:      args[:show],
+      nav_send:        args[:show],
+      email_body:      args[:show]
+    }.freeze
+    POSITIONS = %i[before replace after].freeze
+
+    def initialize
+      @hooks = Hooks.new
+    end
+
+    # @param [Symbol] id
+    # @param [:before, :replace, :after] pos
+    # @example
+    #   view_hooks.add_render :list, :before, partial: 'shared/hello'
+    def add_render(id, pos, *render_args)
+      render_args = render_args.dup
+      render_opts = render_args.extract_options!.dup
+      add id, pos do |locals = {}|
+        render *render_args, render_opts.merge(
+          locals: (render_opts[:locals] || {}).merge(locals)
+        )
+      end
+    end
+
+    # @param [Symbol] id
+    # @param [:before, :replace, :after] pos
+    # @example
+    #   view_hooks.add :headers_content, :after do |mail:, preview:|
+    #     raw "<b>ID</b>: #{h mail.header['X-APP-EMAIL-ID']}"
+    #   end
+    def add(id, pos, &block)
+      @hooks[id][pos] << block
+    end
+
+    def render(hook_id, locals, template)
+      at = @hooks[hook_id]
+      validate_locals! hook_id, locals
+      parts = [
+        render_providers(at[:before], locals, template),
+        if at[:replace].present?
+          render_providers(at[:replace], locals, template)
+        else
+          template.capture { yield(locals) }
+        end,
+        render_providers(at[:after], locals, template)
+      ]
+      template.safe_join(parts, '')
+    end
+
+    private
+
+    def render_providers(providers, locals, template)
+      template.safe_join providers.map { |provider| template.instance_exec(locals, &provider) }, ''
+    end
+
+    def validate_locals!(hook_id, locals)
+      if locals.keys.sort != SCHEMA[hook_id].sort
+        raise ArgumentError, "Invalid arguments #{locals.keys}. Valid: #{SCHEMA[hook_id]}"
+      end
+    end
+
+    class Hooks < DelegateClass(Hash)
+      def initialize
+        super Hash.new { |h, id|
+          validate_id! id
+          h[id] = Hash.new { |hh, pos|
+            validate_pos! pos
+            hh[pos] = []
+          }
+        }
+      end
+
+      private
+
+      def validate_id!(id)
+        raise ArgumentError, 'hook id must be a symbol' unless Symbol === id
+        raise ArgumentError, "Invalid hook #{id}. Valid: #{SCHEMA.keys * ', '}." unless SCHEMA.key?(id)
+      end
+
+      def validate_pos!(pos)
+        raise ArgumentError, "Invalid position #{pos}. Valid: #{POSITIONS * ', '}" unless POSITIONS.include?(pos)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,231 @@
+--- !ruby/object:Gem::Specification
+name: simple_email_preview
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- HUONGNHDH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: breadcrumbs_on_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: sassc-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: turbolinks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.2
+- !ruby/object:Gem::Dependency
+  name: i18n-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+description: A Rails Engine to preview plain text and html email in your browser
+email: huong.nhdh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/images/simple_email_preview/favicon.png
+- app/assets/javascripts/simple_email_preview/application.js
+- app/assets/stylesheets/simple_email_preview/_bootstrap3.sass
+- app/assets/stylesheets/simple_email_preview/_default.sass
+- app/assets/stylesheets/simple_email_preview/application.scss
+- app/controllers/simple_email_preview/application_controller.rb
+- app/controllers/simple_email_preview/emails_controller.rb
+- app/helpers/simple_email_preview/emails_helper.rb
+- app/models/simple_email_preview/preview.rb
+- app/presenters/simple_email_preview/preview_list_presenter.rb
+- app/views/layouts/simple_email_preview/_flash_notices.html.erb
+- app/views/layouts/simple_email_preview/application.html.erb
+- app/views/layouts/simple_email_preview/email.html.erb
+- app/views/simple_email_preview/emails/_email_iframe.html.erb
+- app/views/simple_email_preview/emails/_format_nav.html.erb
+- app/views/simple_email_preview/emails/_headers.html.erb
+- app/views/simple_email_preview/emails/_headers_and_nav.html.erb
+- app/views/simple_email_preview/emails/_i18n_nav.html.erb
+- app/views/simple_email_preview/emails/_nav.html.erb
+- app/views/simple_email_preview/emails/_send_form.html.erb
+- app/views/simple_email_preview/emails/index.html.erb
+- app/views/simple_email_preview/emails/show.html.erb
+- config/i18n-tasks.yml
+- config/initializers/simple_email_preview.rb
+- config/locales/de.yml
+- config/locales/en.yml
+- config/locales/es.yml
+- config/locales/ja.yml
+- config/locales/ru.yml
+- config/routes.rb
+- lib/generators/simple_email_preview/install_generator.rb
+- lib/generators/simple_email_preview/update_previews_generator.rb
+- lib/simple_email_preview.rb
+- lib/simple_email_preview/delivery_handler.rb
+- lib/simple_email_preview/engine.rb
+- lib/simple_email_preview/main_app_route_delegator.rb
+- lib/simple_email_preview/version.rb
+- lib/simple_email_preview/view_hooks.rb
+homepage: https://github.com/huongnhdh/simple_email_preview
+licenses:
+- MIT
+metadata:
+  issue_tracker: https://github.com/huongnhdh/simple_email_preview/issues
+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: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Simple preview emails in browser (rails engine)
+test_files: []