spree_emails 4.3.0.rc1

data/app/views/spree/shared/_mailer_line_item.html.erb

@@ -0,0 +1,12 @@
+<tr>
+  <td class="six sub-columns">
+    <strong>
+      <%= link_to raw(line_item.variant.product.name), spree_storefront_resource_url(line_item.variant.product) %>
+    </strong>
+    <%= raw(line_item.variant.options_text) -%>
+    (<%= line_item.variant.sku %>)
+  </td>
+  <td class="six sub-columns last right">
+    <%= line_item.quantity %> x <%= line_item.single_money %> = <%= line_item.display_amount %>
+  </td>
+</tr>

data/app/views/spree/shared/_purchased_items_table.html.erb

@@ -0,0 +1,64 @@
+<table class="purchase_content">
+  <%= render collection: line_items, partial: 'spree/shared/purchased_items_table/line_item', as: :line_item %>
+  <%= render 'spree/shared/purchased_items_table/subtotal', order: order %>
+  <% if order.line_item_adjustments.exists? %>
+    <% if order.all_adjustments.promotion.eligible.exists? %>
+      <% order.all_adjustments.promotion.eligible.group_by(&:label).each do |label, adjustments| %>
+        <tr>
+          <td></td>
+          <td>
+            <p class="f-fallback purchase_total purchase_total--label">
+              <%= Spree.t(:promotion) %>:
+            </p>
+            <p class="f-fallback purchase_total--name purchase_total--label">
+              <%= label %>
+            </p>
+          </td>
+          <td class="purchase_total-col">
+            <p class="f-fallback purchase_total">
+              <%= Spree::Money.new(adjustments.sum(&:amount), currency: order.currency) %>
+            </p>
+          </td>
+        </tr>
+      <% end %>
+    <% end %>
+  <% end %>
+  <% order.shipments.group_by { |s| s.selected_shipping_rate&.name }.each do |name, shipments| %>
+    <tr>
+      <td></td>
+      <td>
+        <p class="f-fallback purchase_total purchase_total--label">
+          <%= Spree.t(:shipping) %>:
+        </p>
+        <p class="f-fallback purchase_total--name purchase_total--label">
+          <%= name %>
+        </p>
+      </td>
+      <td class="purchase_total-col">
+        <p class="f-fallback purchase_total">
+          <%= Spree::Money.new(shipments.sum(&:discounted_cost), currency: order.currency) %>
+        </p>
+      </td>
+    </tr>
+  <% end %>
+  <% if order.additional_tax_total != 0 %>
+    <tr>
+      <td></td>
+      <td>
+        <p class="f-fallback purchase_total purchase_total--label">
+          <%= Spree.t(:tax) %>:
+        </p>
+      </td>
+      <td class="purchase_total-col">
+        <p class="f-fallback purchase_total">
+          <%= order.display_additional_tax_total.to_html %>
+        </p>
+      </td>
+    </tr>
+  <% end %>
+  <% order.adjustments.eligible.each do |adjustment| %>
+    <% next if (adjustment.source_type == 'Spree::TaxRate') || (adjustment.amount == 0) %>
+    <%= render 'spree/shared/purchased_items_table/adjustment', adjustment: adjustment, order: order %>
+  <% end %>
+  <%= render 'spree/shared/purchased_items_table/total', order: order %>
+</table>

data/app/views/spree/shared/purchased_items_table/_adjustment.html.erb

@@ -0,0 +1,13 @@
+<tr>
+  <td></td>
+  <td>
+    <p class="f-fallback purchase_total purchase_total--label">
+      <%= raw(adjustment.label) %>:
+    </p>
+  </td>
+  <td class="purchase_total-col">
+    <p class="f-fallback purchase_total">
+      <%= Spree::Money.new(adjustment.amount, currency: order.currency) %>
+    </p>
+  </td>
+</tr>

data/app/views/spree/shared/purchased_items_table/_line_item.html.erb

@@ -0,0 +1,19 @@
+<tr>
+  <td class="purchase_image">
+    <%= link_to(image_tag(variant_image_url(line_item.variant)), spree_storefront_resource_url(line_item.product)) %>
+  </td>
+  <td class="purchase_item">
+    <strong>
+      <span class="f-fallback">
+        <%= link_to raw(line_item.name), spree_storefront_resource_url(line_item.product) %>
+      </span>
+    </strong>
+    <p class="purchase_item--additional"><%= raw(line_item.variant.options_text) -%></p>
+  </td>
+  <td class="align-right" width="30%">
+    <span class="f-fallback purchase_item_price">
+      <%= line_item.quantity %> x <%= line_item.single_money %><br>
+      <%= line_item.display_amount %>
+    </span>
+  </td>
+</tr>

data/app/views/spree/shared/purchased_items_table/_subtotal.html.erb

@@ -0,0 +1,13 @@
+<tr>
+  <td class="purchase_footer" valign="middle"></td>
+  <td class="purchase_footer" valign="middle">
+    <p class="f-fallback purchase_total purchase_total--label">
+      <%= Spree.t('order_mailer.subtotal') %>
+    </p>
+  </td>
+  <td class="purchase_footer" valign="middle">
+    <p class="f-fallback purchase_total">
+      <%= order.display_item_total %>
+    </p>
+  </td>
+</tr>

data/app/views/spree/shared/purchased_items_table/_total.html.erb

@@ -0,0 +1,13 @@
+<tr>
+  <td></td>
+  <td>
+    <p class="f-fallback purchase_total purchase_total--label">
+      <strong><%= Spree.t('order_mailer.total') %></strong>
+    </p>
+  </td>
+  <td>
+    <p class="f-fallback purchase_total">
+      <strong><%= order.display_total %></strong>
+    </p>
+  </td>
+</tr>

data/app/views/spree/shipment_mailer/shipped_email.html.erb

@@ -0,0 +1,36 @@
+<h1>
+  <%= Spree.t('shipment_mailer.shipped_email.dear_customer', name: name_for(@shipment.order)) %>
+</h1>
+<p>
+  <%= Spree.t('shipment_mailer.shipped_email.instructions', number: @shipment.order.number) %>
+</p>
+<table class="purchase" role="presentation">
+  <tr>
+    <td>
+      <h3><%= Spree.t('shipment_mailer.shipped_email.shipment_summary') %></h3>
+    </td>
+  </tr>
+  <tr>
+    <td colspan="2">
+      <%= render 'spree/shared/purchased_items_table', line_items: @shipment.manifest.map(&:line_item), order: @shipment.order %>
+    </td>
+  </tr>
+</table>
+<p>
+  <%= Spree.t('shipment_mailer.shipped_email.shipping_method', shipping_method: @shipment.shipping_method.name) %>
+</p>
+<% if @shipment.tracking %>
+  <p>
+    <%= Spree.t('shipment_mailer.shipped_email.track_information', tracking: @shipment.tracking) %>
+  </p>
+<% end %>
+<% if @shipment.tracking_url %>
+  <p>
+    <%= Spree.t('shipment_mailer.shipped_email.track_link', url: link_to(@shipment.tracking_url, @shipment.tracking_url)).html_safe %>
+  </p>
+<% end %>
+<p>
+  <%= Spree.t('shipment_mailer.shipped_email.thanks') %>
+  <br />
+  <%= Spree.t('shipment_mailer.shipped_email.store_team', store_name: current_store.name) %>
+</p>

data/app/views/spree/shipment_mailer/shipped_email.text.erb

@@ -0,0 +1,17 @@
+<%= Spree.t('shipment_mailer.shipped_email.dear_customer', name: name_for(@shipment.order)) %>
+
+<%= Spree.t('shipment_mailer.shipped_email.instructions', number: @shipment.order.number) %>
+
+============================================================
+<%= Spree.t('shipment_mailer.shipped_email.shipment_summary') %>
+============================================================
+<% @shipment.manifest.each do |item| %>
+  <%= item.variant.sku %> <%= item.variant.product.name %> <%= item.variant.options_text %>
+<% end %>
+============================================================
+
+<%= Spree.t('shipment_mailer.shipped_email.track_information', tracking: @shipment.tracking) if @shipment.tracking %>
+<%= Spree.t('shipment_mailer.shipped_email.track_link', url: @shipment.tracking_url) if @shipment.tracking_url %>
+
+<%= Spree.t('shipment_mailer.shipped_email.thanks') %>
+<%= Spree.t('shipment_mailer.shipped_email.store_team', store_name: current_store.name) %>

data/app/views/spree/test_mailer/test_email.html.erb

@@ -0,0 +1,40 @@
+<table>
+  <tr>
+    <td>
+
+      <center>
+        <h1 class="center">
+          <%= Spree.t('test_mailer.test_email.greeting') %>
+        </h1>
+      </center>
+
+    </td>
+    <td class="expander"></td>
+  </tr>
+</table>
+
+<table>
+  <tr>
+    <td>
+
+      <p class="lede">
+        <%= Spree.t('test_mailer.test_email.message') %>
+      </p>
+
+      <p>
+        Please remember to configure all of the emails that Spree has provided to your needs.
+        Spree comes shipped with <a href="http://zurb.com/ink/" target="_blank"> Ink </a>
+        prepackaged, but you can use your own version. Ink is not placed in the asset pipeline.
+      </p>
+
+      <p>
+        Also take note that Gmail does not support <code>&lt;style&gt;</code> tags.
+        Therefore, you will need a gem that will be able to remove your <code>&lt;style&gt;</code>
+        tags and place them inline. Gmail only supports inline styles. We use
+        <a href="https://github.com/fphilipe/premailer-rails" target="_blank">Premailer for Rails</a> by default.
+      </p>
+
+    </td>
+    <td class="expander"></td>
+  </tr>
+</table>

data/app/views/spree/test_mailer/test_email.text.erb

@@ -0,0 +1,4 @@
+<%= Spree.t('test_mailer.test_email.greeting') %>
+================
+
+<%= Spree.t('test_mailer.test_email.message') %>

data/config/initializers/assets.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.precompile << 'spree_emails_manifest.js'

data/lib/generators/spree/emails/install/install_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators'
+require 'spree/core'
+
+module Spree
+  module Emails
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        desc 'Installs mailers previews for Spree transactional emails'
+
+        def self.source_paths
+          [
+            File.expand_path('templates', __dir__)
+          ]
+        end
+
+        def copy_mailers_previews
+          preview_path = Rails.application&.config&.action_mailer&.preview_path.presence || 'test/mailers/previews'
+
+          template 'mailers/previews/order_preview.rb', "#{preview_path}/order_preview.rb"
+          template 'mailers/previews/shipment_preview.rb', "#{preview_path}/shipment_preview.rb"
+          template 'mailers/previews/reimbursement_preview.rb', "#{preview_path}/reimbursement_preview.rb"
+          template 'mailers/previews/user_preview.rb', "#{preview_path}/user_preview.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/spree/emails/install/templates/mailers/previews/order_preview.rb

@@ -0,0 +1,13 @@
+class OrderPreview < ActionMailer::Preview
+  def confirm_email
+    Spree::OrderMailer.confirm_email(Spree::Order.complete.first)
+  end
+
+  def cancel_email
+    Spree::OrderMailer.cancel_email(Spree::Order.complete.first)
+  end
+
+  def store_owner_notification_email
+    Spree::OrderMailer.store_owner_notification_email(Spree::Order.complete.first)
+  end
+end

data/lib/generators/spree/emails/install/templates/mailers/previews/reimbursement_preview.rb

@@ -0,0 +1,5 @@
+class ReimbursementPreview < ActionMailer::Preview
+  def reimbursement_email
+    Spree::ReimbursementMailer.reimbursement_email(Spree::Reimbursement.first)
+  end
+end

data/lib/generators/spree/emails/install/templates/mailers/previews/shipment_preview.rb

@@ -0,0 +1,5 @@
+class ShipmentPreview < ActionMailer::Preview
+  def shipped_email
+    Spree::ShipmentMailer.shipped_email(Spree::Shipment.shipped.first)
+  end
+end

data/lib/generators/spree/emails/install/templates/mailers/previews/user_preview.rb

@@ -0,0 +1,11 @@
+class UserPreview < ActionMailer::Preview
+  def reset_password_instructions
+    Spree::UserMailer.reset_password_instructions(Spree.user_class.first, 'your_token', { current_store_id: Spree::Store.default.id })
+  end
+
+  if Spree::Auth::Config[:confirmable]
+    def confirmation_instructions
+      Spree::UserMailer.confirmation_instructions(Spree.user_class.first, 'your_token')
+    end
+  end
+end

data/lib/spree/emails.rb

@@ -0,0 +1,12 @@
+require 'mail'
+require 'action_mailer/railtie'
+require 'action_view/railtie'
+require 'sprockets/railtie'
+require 'spree/core'
+
+module Spree
+  module Emails
+  end
+end
+
+require 'spree/emails/engine'

data/lib/spree/emails/engine.rb

@@ -0,0 +1,18 @@
+require 'rails/engine'
+
+module Spree
+  module Emails
+    class Engine < Rails::Engine
+      isolate_namespace Spree
+      engine_name 'spree_emails'
+
+      def self.activate
+        Dir.glob(File.join(File.dirname(__FILE__), '../../../app/**/*_decorator*.rb')).sort.each do |c|
+          Rails.configuration.cache_classes ? require(c) : load(c)
+        end
+      end
+
+      config.to_prepare &method(:activate).to_proc
+    end
+  end
+end

data/lib/spree_emails.rb

@@ -0,0 +1 @@
+require 'spree/emails'

data/lib/tasks/email.rake

@@ -0,0 +1,10 @@
+namespace :email do
+  desc 'Sends test email to specified address - Example: EMAIL=spree@example.com bundle exec rake email:test'
+  task test: :environment do
+    unless ENV['EMAIL'].present?
+      raise ArgumentError, 'Must pass EMAIL environment variable. ' \
+                           'Example: EMAIL=spree@example.com bundle exec rake email:test'
+    end
+    Spree::TestMailer.test_email(ENV['EMAIL']).deliver_now
+  end
+end

data/script/rails

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree/emails/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'
+

data/spree_emails.gemspec

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+
+require_relative '../core/lib/spree/core/version.rb'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_emails'
+  s.version     = Spree.version
+  s.authors     = ['Sean Schofield', 'Spark Solutions']
+  s.email       = 'hello@spreecommerce.org'
+  s.summary     = 'Transactional emails for Spree eCommerce platform'
+  s.description = 'Optional transactional emails for Spree such as Order placed or Shipment notification emails'
+  s.homepage    = 'https://spreecommerce.org'
+  s.license     = 'BSD-3-Clause'
+
+  s.metadata = {
+    "bug_tracker_uri"   => "https://github.com/spree/spree/issues",
+    "changelog_uri"     => "https://github.com/spree/spree/releases/tag/v#{s.version}",
+    "documentation_uri" => "https://guides.spreecommerce.org/",
+    "source_code_uri"   => "https://github.com/spree/spree/tree/v#{s.version}",
+  }
+
+  s.required_ruby_version     = '>= 2.5.0'
+  s.required_rubygems_version = '>= 1.8.23'
+
+  s.files        = `git ls-files`.split("\n").reject { |f| f.match(/^spec/) && !f.match(/^spec\/fixtures/) }
+  s.require_path = 'lib'
+
+  s.add_dependency 'spree_core', ">= #{s.version}"
+  s.add_dependency 'actionmailer'
+  s.add_dependency 'sprockets', '>= 4.0'
+
+  s.add_development_dependency 'email_spec', '~> 2.2'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: spree_emails
+version: !ruby/object:Gem::Version
+  version: 4.3.0.rc1
+platform: ruby
+authors:
+- Sean Schofield
+- Spark Solutions
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0.rc1
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: email_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Optional transactional emails for Spree such as Order placed or Shipment
+  notification emails
+email: hello@spreecommerce.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- Rakefile
+- app/assets/config/spree_emails_manifest.js
+- app/assets/images/logo/spree_50.png
+- app/assets/images/noimage/mini.png
+- app/assets/images/noimage/noimage/large.png
+- app/assets/images/noimage/noimage/mini.png
+- app/assets/images/noimage/noimage/product.png
+- app/assets/images/noimage/noimage/small.png
+- app/assets/images/noimage/small.png
+- app/helpers/spree/mail_helper.rb
+- app/mailers/spree/base_mailer.rb
+- app/mailers/spree/order_mailer.rb
+- app/mailers/spree/reimbursement_mailer.rb
+- app/mailers/spree/shipment_mailer.rb
+- app/mailers/spree/test_mailer.rb
+- app/models/spree/emails/order_decorator.rb
+- app/models/spree/emails/reimbursement_decorator.rb
+- app/models/spree/emails/shipment_handler_decorator.rb
+- app/views/layouts/spree/base_mailer.html.erb
+- app/views/spree/order_mailer/cancel_email.html.erb
+- app/views/spree/order_mailer/cancel_email.text.erb
+- app/views/spree/order_mailer/confirm_email.html.erb
+- app/views/spree/order_mailer/confirm_email.text.erb
+- app/views/spree/order_mailer/store_owner_notification_email.html.erb
+- app/views/spree/order_mailer/store_owner_notification_email.text.erb
+- app/views/spree/reimbursement_mailer/reimbursement_email.html.erb
+- app/views/spree/reimbursement_mailer/reimbursement_email.text.erb
+- app/views/spree/shared/_base_mailer_footer.html.erb
+- app/views/spree/shared/_base_mailer_header.html.erb
+- app/views/spree/shared/_base_mailer_stylesheets.html.erb
+- app/views/spree/shared/_mailer_line_item.html.erb
+- app/views/spree/shared/_purchased_items_table.html.erb
+- app/views/spree/shared/purchased_items_table/_adjustment.html.erb
+- app/views/spree/shared/purchased_items_table/_line_item.html.erb
+- app/views/spree/shared/purchased_items_table/_subtotal.html.erb
+- app/views/spree/shared/purchased_items_table/_total.html.erb
+- app/views/spree/shipment_mailer/shipped_email.html.erb
+- app/views/spree/shipment_mailer/shipped_email.text.erb
+- app/views/spree/test_mailer/test_email.html.erb
+- app/views/spree/test_mailer/test_email.text.erb
+- config/initializers/assets.rb
+- lib/generators/spree/emails/install/install_generator.rb
+- lib/generators/spree/emails/install/templates/mailers/previews/order_preview.rb
+- lib/generators/spree/emails/install/templates/mailers/previews/reimbursement_preview.rb
+- lib/generators/spree/emails/install/templates/mailers/previews/shipment_preview.rb
+- lib/generators/spree/emails/install/templates/mailers/previews/user_preview.rb
+- lib/spree/emails.rb
+- lib/spree/emails/engine.rb
+- lib/spree_emails.rb
+- lib/tasks/email.rake
+- script/rails
+- spree_emails.gemspec
+homepage: https://spreecommerce.org
+licenses:
+- BSD-3-Clause
+metadata:
+  bug_tracker_uri: https://github.com/spree/spree/issues
+  changelog_uri: https://github.com/spree/spree/releases/tag/v4.3.0.rc1
+  documentation_uri: https://guides.spreecommerce.org/
+  source_code_uri: https://github.com/spree/spree/tree/v4.3.0.rc1
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.23
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Transactional emails for Spree eCommerce platform
+test_files: []