simple_email_preview 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e73087223247d26b230fcf9056c82b9758e62e60790454ac618d6ef317b2e4c
+  data.tar.gz: 3eca396535a17023a829bd85847704a9403db5b42c2f1e0806fc4d420dacf50d
+SHA512:
+  metadata.gz: 1816d19dc6c4b1f1909d91d622e98620af0a5c0a76880d1564e8f1f5372ede65d5380fbe148972be19165d335bff9476bfa8684b8fdc14e947b0a016809aeecf
+  data.tar.gz: 6e2997d6474618938140a10d1a8ee0a3c1f5994511916eccfdf9e39a205ab3e628f87f42790dec4c6935d503df3ecf5443908f3cdc2d06209d9a2853c970193d

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rails'
+
+eval_gemfile './shared.gemfile'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012-2013
+
+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,162 @@
+# Simple Email Preview
+Preview email in the browser with this Rails engine. Compatible with Rails 4.2+.
+
+*This gem base on [rails_email_preview](https://github.com/glebm/rails_email_preview), but prune for simple purpose (just preview)*
+
+## Installation
+
+Add [![Gem Version][gem-badge]][gem] to Gemfile:
+
+```ruby
+gem 'simple_email_preview', '~> 1.0.0'
+```
+
+Add an initializer and the routes:
+
+```console
+$ rails g simple_email_preview:install
+```
+
+Generate preview classes and method stubs in app/mailer_previews/
+
+```console
+$ rails g simple_email_preview:update_previews
+```
+
+## Usage
+
+The last generator above will add a stub for each of your emails, then you populate the stubs with mock data:
+
+```ruby
+# app/mailer_previews/user_mailer_preview.rb:
+class UserMailerPreview
+  # preview methods should return Mail objects, e.g.:
+  def invitation
+    UserMailer.invitation mock_user('Alice'), mock_user('Bob')
+  end
+
+  def welcome
+    UserMailer.welcome mock_user
+  end
+
+  private
+  # You can put all your mock helpers in a module
+  # or you can use your factories, just make sure you are not creating anything
+  def mock_user(name = 'Me')
+    fake_id User.new(name: name, email: "user#{rand 100}@test.com")
+  end
+
+  def fake_id(obj)
+    # overrides the method on just this object
+    obj.define_singleton_method(:id) { 123 + rand(100) }
+    obj
+  end
+end
+```
+
+### Parameters as instance variables
+
+All parameters in the search query will be available to the preview class as instance variables.
+For example, if URL to mailer preview looks like:
+
+/emails/user_mailer_preview-welcome?**user_id=1**
+
+The method `welcome` in `UserMailerPreview` have a `@user_id` instance variable defined:
+
+```ruby
+class UserMailerPreview
+  def welcome
+    user = @user_id ? User.find(@user_id) : mock_user
+    UserMailer.welcome(user)
+  end
+end
+```
+
+Now you can preview or send the welcome email to a specific user.
+
+### Routing
+
+You can access REP urls like this:
+
+```ruby
+# engine root:
+simple_email_preview.rep_root_url
+# list of emails (same as root):
+simple_email_preview.rep_emails_url
+# email show:
+simple_email_preview.rep_email_url('user_mailer-welcome')
+```
+
+
+### Views
+
+By default REP views will render inside its own layout.
+
+To render all REP views inside your app layout, first set the layout to use in the initializer:
+
+```ruby
+Rails.application.config.to_prepare do
+  # Use admin layout with REP (this will also make app routes accessible within REP):
+  SimpleEmailPreview.layout = 'admin'
+end
+```
+
+Then, import REP styles into your `application.css.scss`:
+
+```scss
+@import "simple_email_preview/application";
+```
+
+Alternatively, if you are using Bootstrap 3, `@import "simple_email_preview/bootstrap3"`, and add the following
+to the initializer:
+
+```ruby
+config.style.merge!(
+    btn_active_class_modifier: 'active',
+    btn_danger_class:          'btn btn-danger',
+    btn_default_class:         'btn btn-default',
+    btn_group_class:           'btn-group btn-group-sm',
+    btn_primary_class:         'btn btn-primary',
+    form_control_class:        'form-control',
+    list_group_class:          'list-group',
+    list_group_item_class:     'list-group-item',
+    row_class:                 'row',
+)
+```
+
+You can also override any individual view by placing a file with the same path in your project's `app/views`,
+e.g. `app/views/simple_email_preview/emails/index.html.slim`.
+
+#### Hooks
+
+You can add content around or replacing REP UI elements by registering view hooks in the initializer:
+
+```ruby
+# Pass position (before, after, or replace) and render arguments:
+SimpleEmailPreview.view_hooks.add_render :list, :before, partial: 'shared/hello'
+
+# Pass hook id and position (before, after, or replace):
+SimpleEmailPreview.view_hooks.add :headers_content, :after do |mail:, preview:|
+  raw "<dt>ID</dt><dd>#{h mail.header['X-APP-EMAIL-ID']}</dd>"
+end
+```
+
+All of the available hooks can be found [here](/lib/simple_email_preview/view_hooks.rb#L10).
+
+
+
+## Development
+
+Run the tests:
+
+```console
+$ rspec
+```
+
+Start a development web server on [localhost:9292](http://localhost:9292):
+
+```console
+$ rake dev
+```
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,62 @@
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+# Load dummy app tasks
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc 'Start development web server'
+task :dev do
+  host = '0.0.0.0'
+  port = ENV['PORT'] || 9292
+  ENV['RACK_ENV'] = ENV['RAILS_ENV'] = 'development'
+  Dir.chdir 'spec/dummy'
+
+  Rack::Server.start(
+    environment: 'development',
+    Host: host,
+    Port: port,
+    config: 'config.ru'
+  )
+end
+
+desc 'Test all Gemfiles from spec/*.gemfile'
+task :test_all_gemfiles do
+  require 'pty'
+  require 'shellwords'
+  cmd      = 'bundle install --quiet && bundle exec rake --trace'
+  statuses = Dir.glob('./spec/gemfiles/*{[!.lock]}').map do |gemfile|
+    Bundler.with_clean_env do
+      env = { 'BUNDLE_GEMFILE' => gemfile }
+      warn "Testing #{File.basename(gemfile)}:\n  export #{env.map { |k, v| "#{k}=#{Shellwords.escape v}" } * ' '}; #{cmd}"
+      PTY.spawn(env, cmd) do |r, _w, pid|
+        begin
+          r.each_line { |l| puts l }
+        rescue Errno::EIO
+          # Errno:EIO error means that the process has finished giving output.
+        ensure
+          ::Process.wait pid
+        end
+      end
+      [$CHILD_STATUS && $CHILD_STATUS.exitstatus == 0, gemfile]
+    end
+  end
+  failed_gemfiles = statuses.reject(&:first).map { |(_status, gemfile)| gemfile }
+  if failed_gemfiles.empty?
+    warn "✓ Tests pass with all #{statuses.size} gemfiles"
+  else
+    warn "❌ FAILING (#{failed_gemfiles.size} / #{statuses.size})\n#{failed_gemfiles * "\n"}"
+    exit 1
+  end
+end

data/app/assets/javascripts/simple_email_preview/application.js

@@ -0,0 +1 @@
+//= require turbolinks

data/app/assets/stylesheets/simple_email_preview/_bootstrap3.sass

@@ -0,0 +1,68 @@
+// Bootstrap 3 theme for Rails Email Preview
+
+.rep--email-headers
+  @extend .col-md-8
+
+.rep--email-nav-container
+  @extend .col-md-4
+
+.rep--email-list-half
+  @extend .col-md-6
+
+.rep--headers-list
+  dt
+    color: $gray-dark
+    @media (min-width: $screen-sm-min)
+      float: left
+      clear: left
+      margin-right: 0.45em
+      text-align: right
+      width: 100px
+      &::after
+        content: ":"
+  dd
+    width: auto
+    margin-left: 0
+    margin-bottom: 0.3em
+
+.rep--email-options
+  text-align: right
+
+.rep--breadcrumbs
+  @extend .breadcrumb
+
+.rep--breadcrumbs__breadcrumb-active
+  color: $breadcrumb-active-color
+
+.rep--panel
+  box-shadow: inset 0 0 0 1px rgba(0, 0, 0, .125)
+  padding: 15px
+  margin-bottom: 20px
+
+.rep--send-to-form
+  display: block
+  white-space: nowrap
+  padding-bottom: 4px
+  button, [type="email"]
+    display: inline-block
+    &:focus, &:active
+      z-index: 2
+  button
+    line-height: 1.3
+    border-top-right-radius: 0
+    border-bottom-right-radius: 0
+  [type="email"]
+    max-width: 140px
+    border-top-left-radius: 0
+    border-bottom-left-radius: 0
+
+.rep--footer
+  text-align: center
+  color: $state-info-text
+
+.rep--email-headers
+  +make-sm-column(8)
+.rep--email-nav-container
+  +make-sm-column(4)
+.rep--email-list-half
+  +make-sm-column(6)

data/app/assets/stylesheets/simple_email_preview/_default.sass

@@ -0,0 +1,230 @@
+// A standalone theme for Rails Email Preview
+
+$rep-brand-color: #4a90e2 !default
+$rep-link-color: $rep-brand-color !default
+$rep-gray: #818a91 !default
+$rep-gray-light: #dedede !default
+$rep-gray-lighter: #f1f3f4 !default
+
+$rep-breadcrumb-bg: $rep-gray-lighter !default
+
+$rep-grid-gutter: 30px !default
+$rep-grid-breakpoint-sm: 768px !default
+$rep-font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji" !default
+$rep-font-size-nav: 1.15em !default
+$rep-text-color: rgba(black, 0.87) !default
+$rep-text-color-secondary: #263238 !default
+
+=rep--media-sm-plus
+  @media (min-width: $rep-grid-breakpoint-sm)
+    @content
+
+=clearfix
+  &::after
+    content: ""
+    display: table
+    clear: both
+
+%rep--link
+  color: $rep-link-color
+  text-decoration: none
+  transition: color 0.1s linear
+  &:active, &:focus, &:hover
+    color: darken($rep-link-color, 15%)
+  &:active
+    outline: none
+  &:focus
+    outline: thin dotted
+    outline: 5px auto -webkit-focus-ring-color
+    outline-offset: -2px
+
+%rep--hr
+  margin-top: 20px
+  margin-bottom: 20px
+  border: 0
+  border-top: 1px solid $rep-gray-lighter
+
+.rep--main-container
+  box-sizing: border-box
+  color: $rep-text-color
+  font-family: $rep-font-family
+  *, *::before, *::after
+    box-sizing: inherit
+  a
+    @extend %rep--link
+  hr
+    @extend %rep--hr
+
+.rep--row
+  margin-left: ($rep-grid-gutter / -2)
+  margin-right: ($rep-grid-gutter / -2)
+  +clearfix
+
+%rep--row__col
+  position: relative
+  min-height: 1px
+  padding-right: ($rep-grid-gutter / 2)
+  padding-left: ($rep-grid-gutter / 2)
+
+@each $col in (4, 6, 8)
+  %rep--row__col-#{$col}
+    @extend %rep--row__col
+    +rep--media-sm-plus
+      float: left
+      width: percentage($col / 12)
+
+.rep--email-headers
+  @extend %rep--row__col-8
+
+.rep--email-nav-container
+  @extend %rep--row__col-4
+
+.rep--email-list-half
+  @extend %rep--row__col-6
+
+.rep--breadcrumbs
+  padding: 0.75rem 1rem
+  margin-bottom: 1rem
+  font-size: $rep-font-size-nav
+  list-style: none
+  background-color: $rep-breadcrumb-bg
+.rep--breadcrumbs__breadcrumb
+  display: inline-block
+  + ::before
+    display: inline-block
+    padding: 0 0.5em
+    color: $rep-gray-light
+    content: "/"
+.rep--breadcrumbs__breadcrumb-active
+  display: inline-block
+
+.rep--headers-list
+  margin: 0
+  dt
+    color: $rep-text-color-secondary
+    font-weight: bold
+    +rep--media-sm-plus
+      float: left
+      clear: left
+      margin-right: 0.4em
+      text-align: right
+      width: 6em
+  dd
+    width: auto
+    margin-left: 0
+    margin-bottom: 0.2em
+
+.rep--btn
+  appearance: none
+  -webkit-font-smoothing: antialiased
+  border: 1px solid
+  cursor: pointer
+  display: inline-block
+  font-weight: 600
+  padding: 0.75em 1em
+  text-decoration: none
+  user-select: none
+  vertical-align: middle
+  text-align: center
+  white-space: nowrap
+  transition: all .2s ease-in-out
+  &:active, &.rep--btn-active
+    background-image: none
+    outline: 0
+    box-shadow: inset 0 3px 5px rgba(0, 0, 0, .125)
+  &:focus
+    outline: none
+
+=rep--btn($color, $background, $border-color: darken($background, 5%))
+  color: $color
+  background: $background
+  border-color: $border-color
+  &:hover
+    background: darken($background, 10%)
+    border-color: darken($border-color, 12%)
+  &:focus
+    box-shadow: 0 0 3px $background
+    background-color: darken($background, 17%)
+    border-color: darken($border-color, 25%)
+
+.rep--btn-default
+  +rep--btn(#111, $rep-gray-lighter)
+
+.rep--btn-primary
+  +rep--btn(#fff, $rep-brand-color)
+
+.rep--btn-danger
+  +rep--btn(#fff, #d9534f)
+
+.rep--btn-group
+  .rep--btn + .rep--btn
+    margin-left: -1px
+  .rep--btn
+    z-index: 1
+    &.rep--btn-active
+      z-index: 2
+    &:focus, &:hover
+      z-index: 3
+
+.rep--list-group
+  font-size: $rep-font-size-nav
+
+.rep--list-group__item
+  display: block
+  padding: 1rem 1.5rem
+  &:hover
+    background-color: $rep-gray-lighter
+    transition: background-color ease-in-out 0.15s, background-color ease-in-out 0.15s
+  + .rep--list-group__item
+    border-top: 1px solid $rep-gray-light
+
+.rep--panel
+  box-shadow: inset 0 0 0 1px rgba(0, 0, 0, .125)
+  padding: 1.25rem
+  margin-bottom: 1rem
+
+.rep--email-options
+  font-size: 0.875rem
+  text-align: left
+  p
+    margin-top: 0
+  +rep--media-sm-plus
+    text-align: right
+
+.rep--send-to-form
+  display: block
+  white-space: nowrap
+  padding-bottom: 4px
+  button, [type="email"]
+    display: inline-block
+    &:focus, &:active
+      z-index: 2
+  button
+    line-height: 1.25
+    padding: 0.5rem
+  [type="email"]
+    max-width: 135px
+    padding: 0.5rem
+    border-top-left-radius: 0
+    border-bottom-left-radius: 0
+
+.rep--form-control
+  padding: 0.5rem 0.75rem
+  line-height: 1.25
+  background-image: none
+  background-clip: padding-box
+  border: 1px solid rgba(0, 0, 0, 0.15)
+  border-radius: 0.25rem
+  box-shadow: inset 0 1px 1px rgba(0, 0, 0, .075)
+  transition: border-color ease-in-out 0.15s, box-shadow ease-in-out 0.15s
+  &::placeholder
+    color: #999
+    opacity: 1
+  &:focus
+    border-color: lighten($rep-brand-color, 20%)
+    outline: none
+    box-shadow: inset 0 1px 1px rgba(0, 0, 0, .075), 0 0 8px rgba(102, 175, 233, .6)
+
+.rep--footer
+  text-align: center
+  color: $rep-gray