effective_email_templates 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d30287d3cff749da524d949a3350afe46bba6dbd
-  data.tar.gz: cd82018e4b99a829f5809d82abc15e9bf215f1a8
+  metadata.gz: c13e3d65af439b35d89c4033d870d692d08698f3
+  data.tar.gz: 485f5e8e247057d1b3604c0801e20953592ccef1
 SHA512:
-  metadata.gz: 8ec0e2f0d4c32a25d5183d29e425035e316e4475c7fe6b14d0ee8e02d12ad8e435e40f020506851ffcd3b90a82b7075c10e7f8e0b7bfde710a997fc532e9d5e9
-  data.tar.gz: 29fdd97bd3a101baf4a1bff2fc31fbca7e7bfd2f0bc1550dfed71e6d720450aeca8356605a81f5da4ed89c26c027cfcce3c1dd0d122142ccc238560b411aee0e
+  metadata.gz: 6d0c7473ffc31eeaacdf7e00d79e00447fd577096df058fad22cbae046fb7a269576c2665c647f6410b6ec587a432840726ba16a49ed4c2efbb095f45cf236cd
+  data.tar.gz: 9f6d12909a9cf44bf9a67f8d670e814b2d1a1fdc01f2015997c98c88eb845465026fe1bbc812dd76ca42031420643021b6fd10c7e99ea49609e6527568b4bf05

data/README.md

@@ -1,9 +1,12 @@
+
 # Effective Email Templates
 
-Description!!
+Create email templates that an admin or any user can safely edit (you're protected from SQL injection and other nastiness).
+Effective Email Templates relies on [Liquid templates](http://liquidmarkup.org/) built by Shopify to profide this safety.
 
 Rails 3.2.x and Rails 4 Support
 
+
 ## Getting Started
 
 Add to your Gemfile:
@@ -35,27 +38,52 @@ rake db:migrate
 ```
 
 
-## Usage
+## Creating Email Templates
+
+This is very similar to creating other emails in Rails.
 
-- Create some email templates at `/admin/email_templates`
-- Create a mailer method for each email
+1. Create a new mailer object (i.e. `/app/mailers/template_mailer.rb`)
   - Mailer objects need to inherit from `Effective::LiquidMailer`
-  - Mailer methods and email template slugs need to match up
-  - Email headers can be declared in the #mail method but can be overrided by the saved attributes on the Effective::EmailTemplate model.
-- Create mail objects and deliver them like normal
+2. Create a method inside the mailer object based on the name of your email (i.e. `def welcome_email`)
+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:
+
+```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.
+```
 
-An example liquid template (put these into the database through the admin panel: `/admin/email_templates`):
+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.
+
+```console
+rake effective_email_templates:import_default_views
+```
+
+5. Visit `localhost:3000/admin/email_templates` in your browser to edit templates.
+
+
+## Making Content Dynamic
 
 ```liquid
-Welcome to our site.  We think you're {{ adjective }}
+Welcome to our site.  We think you're {{ adjective }}!
 ```
 
 The corresponding Mailer:
 
 ```ruby
-# app/mailers/user_liquid_mailer.rb
-class UserLiquidMailer < Effective::LiquidMailer
-  def after_create_user(user)
+# app/mailers/template_mailer.rb
+class TemplateMailer < Effective::LiquidMailer
+  def welcome_email(user)
     @to_liquid = {
       'adjective' => 'awesome'
     }
@@ -67,39 +95,10 @@ end
 Send the emails like normal:
 
 ```ruby
-mail = UserLiquidMailer.after_create_user(self)
+mail = TemplateMailer.welcome_email(user)
 mail.deliver
 ```
 
-### Default Templates
-
-Email templates can still be added by a developer into a view file if a rake task is run to import
-them into the database in production.  To create a view template for the `after_create_user` email
-above, simply create a template file inside /app/views (probably in the user_liquid directory)
-with a .liquid file extension.  That file should contain metadata in YAML format at the top
-surrounded by two lines with three hyphens:
-
-```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 and you can use {{ }} inside of me to interpolate variables
-defined in the corresponding LiquidMailer method.
-```
-
-To add these templates to the database, run the `effective_email_templates:import_default_views` task.
-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:
-
-```ruby
-# an example Heroku deploy script
-...
-system 'heroku run rake effective_email_templates:import_default_views'
-...
-```
 
 ## Authorization
 
@@ -178,18 +177,3 @@ You are not granted rights or licenses to the trademarks of Code and Effect
 
 ## Testing
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

data/app/models/effective/datatables/email_templates.rb

@@ -2,16 +2,18 @@ if defined?(EffectiveDatatables)
   module Effective
     module Datatables
       class EmailTemplates < Effective::Datatable
-        default_order :subject, :asc
+        datatable do
+          default_order :subject, :asc
 
-        table_column :id, visible: false
-        table_column :slug
-        table_column :subject
-        table_column :from
-        table_column :cc, sortable: false, visible: false, label: 'CC'
-        table_column :bcc, sortable: false, visible: false, label: 'BCC'
-        table_column :body, sortable: false, visible: false
-        table_column :actions, sortable: false, partial: '/admin/email_templates/actions'
+          table_column :id, visible: false
+          table_column :slug
+          table_column :subject
+          table_column :from
+          table_column :cc, sortable: false, visible: false, label: 'CC'
+          table_column :bcc, sortable: false, visible: false, label: 'BCC'
+          table_column :body, sortable: false, visible: false
+          table_column :actions, sortable: false, partial: '/admin/email_templates/actions'
+        end
 
         def collection
           Effective::EmailTemplate.all

data/lib/effective_email_templates/version.rb

@@ -1,3 +1,3 @@
 module EffectiveEmailTemplates
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_email_templates
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -140,16 +140,16 @@ dependencies:
   name: effective_datatables
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.17
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.17
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement