effective_email_templates 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7ceefc31750874cc34b906a00ce64e80ee805bdf247cb69ec33d080e3625e28
-  data.tar.gz: ba54f4fc199b22bb8aed8b01d60f7b71ddfec735b6be56fc37d1cee9853f9a3f
+  metadata.gz: 3f78b09e0fce401909a35e596e6d8628b8b2a79199884de8a27c90ac0145ac18
+  data.tar.gz: 307f2c713e151db5069195446b3fdf2918f108144a64bfffae477afb0902fe08
 SHA512:
-  metadata.gz: e24eb4a7e1fa925844d45de25fab8a7bb9b6b3f4fc631c13ba4418a43e9bb304b6be6e1e7eb16c5396d097d8cb5ac910040464af9e1a7bb2aba5122b40f92c61
-  data.tar.gz: fc6b6f48a42448af82136497ab39ec26a28c9ef60e1db3ef45b42dac8c7c0d7d0d093005e40f6b246e5e671a63a275e8f32ccce34520a6281fd4ff80c821768e
+  metadata.gz: b2ce8cefc4c2f9fb1b4465cfbf1c1fd94a584e41691c894c9ec983ab750676a73676778f9f7bb02ae21090ab569967f27ea573bd4531dccfb3fb569f7481c99d
+  data.tar.gz: 26cc8dddb9911e40e00f64e3423e288e968e7c4617a817e1ed0be007048bc6fa6935cf3aba7555f7dfacb57c36a91549e5b7360727a017206fd004e75ce0c536

data/README.md

@@ -3,7 +3,7 @@
 
 Create email templates that an admin can edit and then send.
 
-Rails 3.2.x and higher
+Rails 3.2.x through Rails 6
 
 ## effective_email_templates 1.0
 
@@ -19,6 +19,7 @@ Please check out [Effective Email Templates 0.x](https://github.com/code-and-eff
 Add to your Gemfile:
 
 ```ruby
+gem 'haml-rails' # or try using gem 'hamlit-rails'
 gem 'effective_email_templates'
 ```
 
@@ -44,77 +45,73 @@ Then migrate the database:
 rake db:migrate
 ```
 
-## Create Email Templates
+And import the provided welcome email template:
 
-`link_to 'Email Templates', effective_email_templates.admin_email_templates_path`
+```ruby
+rake effective_email_templates:import
+```
 
-To create your first post, visit `/admin/email_templates` and click `New Email Template`.
+## Admin View
 
-1. Create a new mailer object (i.e. `/app/mailers/template_mailer.rb`)
-    - Mailer objects need to inherit from `Effective::LiquidMailer`
+To manage the content of the email templates, navigate to `/admin/email_templates` or add,
 
-2. Create a method inside the mailer object based on the name of your email (i.e. `def welcome_email`)
+`link_to 'Email Templates', effective_email_templates.admin_email_templates_path` to your menu.
 
-3. Create a default email template file (i.e. `/app/views/template_mailer/welcome_email.liquid`)
-    - Start out with a plain text email (without any variables and we'll show you how to add dynamic content below)
-    - Add the email subject and from address at the top of the email. For example:
+## Create Email Templates
 
-    ```yaml
-    ---
-    subject: 'Hello User'                   # REQUIRED
-    from: 'effective@email_templates.com'   # REQUIRED
-    cc: 'my_friend@email_templates.com'     # optional
-    bcc: 'my_secret_friend@example.com'     # optional
-    ---
-    Hello new user! I'm a liquid template that will be editable to site admins and/or users.
-    ```
+The installer already created an `app/mailers/email_templates_mailer.rb`. You can change this name. And additional mailers can be created, just make sure they extend from `Effective::EmailTemplatesMailer`.
 
-4. Run this rake task to import this email template from the filesystem to the database (where it will be editable)
-    - Remember to do this in your staging and production environments as well!
-    - This task can be run even when no new templates have been added and will not overwrite existing
-      database templates.  This allows you to run the rake task in a deploy script if you are adding new
-      templates frequently.
+To create an email template:
 
-    ```console
-    rake effective_email_templates:import_templates
-    ```
+1. Create a method inside the mailer, like `def welcome`. The `@assigns` instance variable should contain all the variables that are passed to the liquid view. Any variables that end in `_url` like `root_url` will be automatically expanded.
 
-5. Visit `localhost:3000/admin/email_templates` in your browser to edit templates.
+```ruby
+# app/mailers/email_templates_mailer.rb
+class EmailTemplatesMailer < Effective::EmailTemplatesMailer
+  def welcome(user)
+    @assigns = {
+      user: {
+        first_name: user.first_name,
+        last_name: user.last_name
+      }
+      adjective: 'awesome'
+    }
 
-6. Run this rake task to overwrite to initial state default database email templates that have already been changed. This will touch email templates created only from filesystem.
-    ```console
-    rake effective_email_templates:overwrite_templates
-    ```
+    mail(to: user.email)
+  end
+end
+```
 
+2. Create a .liquid file in `app/views/email_templates_mailer/welcome.liquid`.
 
-## Making Content Dynamic
+```yaml
+---
+subject: 'Welcome {{ user.first_name }}'  # REQUIRED
+from: 'admin@example.com'               # REQUIRED
+cc: 'info@example.com'                  # optional
+bcc: 'info@example.com'                 # optional
+---
+Welcome {{ user.first_name }} {{ user.last_name }}!
 
-```liquid
-Welcome to our site.  We think you're {{ adjective }}!
+I am a liquid template that is imported to the database, and is then editable.
+
+Thanks for using our site at {{ root_url }}.
 ```
 
-The corresponding Mailer:
+3. Run `rake effective_email_templates:import` or `rake effective_email_templates:overwrite`
 
-```ruby
-# app/mailers/template_mailer.rb
-class TemplateMailer < Effective::LiquidMailer
-  def welcome_email(user)
-    @to_liquid = {
-      'adjective' => 'awesome'
-    }
-    mail(to: user.email)
-  end
-end
-```
+- Remember to do this in your staging and production environments as well!
 
-Send the emails like normal:
+- The import task can be run even when no new templates have been added and will not overwrite existing
+  database templates.  This allows you to run the rake task in a deploy script if you are adding new
+  templates frequently.
+
+4. Send the emails like normal:
 
 ```ruby
-mail = TemplateMailer.welcome_email(user)
-mail.deliver
+EmailTemplatesMailer.welcome(user).deliver
 ```
 
-
 ## Authorization
 
 All authorization checks are handled via the config.authorization_method found in the `app/config/initializers/effective_email_templates.rb` file.

data/app/models/effective/email_template.rb

@@ -62,6 +62,8 @@ module Effective
     end
 
     def render(assigns = {})
+      assigns = assigns.deep_stringify_keys() if assigns.respond_to?(:deep_stringify_keys)
+
       {
         from: from,
         cc: cc.presence || false,

data/app/views/admin/email_templates/_form.html.haml

@@ -1,16 +1,22 @@
 = effective_form_with(model: email_template, url: email_template.persisted? ? effective_email_templates.admin_email_template_path(email_template.id) : effective_email_templates.admin_email_templates_path) do |f|
-  - if f.object.persisted?
-    = f.static_field :template_name, label: 'Name'
-
-  = f.text_field :subject, hint: 'The subject of your email.'
-
-  = f.email_field :from, hint: 'Whom the email will be sent from.'
+  = f.static_field :template_name, label: 'Name'
+  = f.select :content_type, Effective::EmailTemplate::CONTENT_TYPES
 
+  = f.email_field :from, hint: 'Whom the email will be sent from'
   = f.text_field :cc
   = f.text_field :bcc
 
-  = f.select :content_type, Effective::EmailTemplate::CONTENT_TYPES
+  = f.text_field :subject, hint: 'The subject of your email'
+  = f.text_area :body, hint: 'The content of your email template', rows: 10
+
+  .card
+    .card-body
+      %p The available variables for this email template are:
+
+      %ul
+        - Array(f.object.template_variables).each do |variable|
+          %li {{ #{variable} }}
 
-  = f.text_area :body, hint: 'The content of your email template'
+      %small.text-muted Only a developer can add additional variables
 
   = f.submit

data/config/effective_email_templates.rb

@@ -32,11 +32,4 @@ EffectiveEmailTemplates.setup do |config|
     admin_email_templates: 'admin'
   }
 
-  # Mailer Settings
-  config.mailer = {
-    subject_prefix: '[example] ',
-    layout: 'effective_email_templates_mailer_layout',
-    deliver_method: nil   # :deliver (rails < 4.2), :deliver_now (rails >= 4.2) or :deliver_later
-  }
-
 end

data/config/email_templates_mailer.rb

@@ -0,0 +1,15 @@
+class EmailTemplatesMailer < Effective::EmailTemplatesMailer
+
+  def welcome(user)
+    @assigns = {
+      'user' => {
+        'first_name' => user.first_name,
+        'last_name' => user.last_name,
+        'email' => user.email,
+      }
+    }
+
+    mail(to: user.email)
+  end
+
+end

data/config/email_templates_mailer_preview.rb

@@ -0,0 +1,11 @@
+# In Rails 4.1 and above, visit:
+# http://localhost:3000/rails/mailers
+# to see a preview of the following emails:
+
+class EmailTemplatesMailerPreview < ActionMailer::Preview
+
+  def welcome
+    EmailTemplatesMailer.welcome(User.first)
+  end
+
+end

data/config/welcome.liquid

@@ -0,0 +1,9 @@
+---
+subject: 'Welcome {{ user.first_name }}'
+from: 'admin@example.com'
+---
+Hello {{ user.first_name }} {{ user.last_name }},
+
+{{ root_url }}
+
+Welcome to our site!

data/lib/effective_email_templates.rb

@@ -7,7 +7,6 @@ module EffectiveEmailTemplates
   mattr_accessor :email_templates_table_name
   mattr_accessor :authorization_method
   mattr_accessor :layout
-  mattr_accessor :mailer
 
   def self.setup
     yield self

data/lib/effective_email_templates/version.rb

@@ -1,3 +1,3 @@
 module EffectiveEmailTemplates
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/lib/generators/effective_email_templates/install_generator.rb

@@ -19,10 +19,27 @@ module EffectiveEmailTemplates
         template ('../' * 3) + 'config/effective_email_templates.rb', 'config/initializers/effective_email_templates.rb'
       end
 
+      def copy_mailer
+        template ('../' * 3) + 'config/email_templates_mailer.rb', 'app/mailers/email_templates_mailer.rb'
+      end
+
+      def copy_liquid
+        template ('../' * 3) + 'config/welcome.liquid', 'app/views/email_templates_mailer/welcome.liquid'
+      end
+
+      def copy_preview
+        template ('../' * 3) + 'config/email_templates_mailer_preview.rb', 'test/mailers/previews/email_templates_mailer_preview.rb'
+      end
+
       def create_migration_file
         @email_templates_table_name = ':' + EffectiveEmailTemplates.email_templates_table_name.to_s
         migration_template ('../' * 3) + 'db/migrate/01_create_effective_email_templates.rb.erb', 'db/migrate/create_effective_email_templates.rb'
       end
+
+      def message
+        puts("Please run rake db:migrate and rake effective_email_templates:import")
+      end
+
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_email_templates
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2020-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coffee-rails
-  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: effective_bootstrap
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +100,10 @@ files:
 - app/views/admin/email_templates/index.html.haml
 - app/views/layouts/effective_email_templates_mailer_layout.html.haml
 - config/effective_email_templates.rb
+- config/email_templates_mailer.rb
+- config/email_templates_mailer_preview.rb
 - config/routes.rb
+- config/welcome.liquid
 - db/migrate/01_create_effective_email_templates.rb.erb
 - lib/effective_email_templates.rb
 - lib/effective_email_templates/engine.rb