effective_email_templates 0.6.1 → 1.0.0

data/lib/generators/effective_email_templates/install_generator.rb

@@ -8,7 +8,7 @@ module EffectiveEmailTemplates
       source_root File.expand_path('../../templates', __FILE__)
 
       def self.next_migration_number(dirname)
-        if not ActiveRecord::Base.timestamped_migrations
+        unless ActiveRecord::Base.timestamped_migrations
           Time.new.utc.strftime("%Y%m%d%H%M%S")
         else
           "%.3d" % (current_migration_number(dirname) + 1)

data/lib/tasks/effective_email_templates_tasks.rake

@@ -0,0 +1,19 @@
+# rake effective_email_templates:import
+# rake effective_email_templates:overwrite
+
+namespace :effective_email_templates do
+  desc 'Import email templates from the filesystem to the database. Skips existing.'
+  task import: :environment do
+    require 'effective_email_templates/importer'
+    EffectiveEmailTemplates::Importer.import()
+  end
+
+  desc 'Overwrite email templates from the filesystem to the database. Overwrites existing.'
+  task overwrite: :environment do
+    puts 'WARNING: this task will overwrite existing email templates. Proceed? (y/n)'
+    (puts 'Aborted'; exit) unless STDIN.gets.chomp.downcase == 'y'
+
+    require 'effective_email_templates/importer'
+    EffectiveEmailTemplates::Importer.overwrite()
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_email_templates
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Code and Effect
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2020-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
-  name: coffee-rails
+  name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,27 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: liquid
+  name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: simple_form
+  name: effective_bootstrap
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -78,15 +72,29 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
-description: Uses liquid templates
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: effective_resources
+  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'
+description: Effective Email Templates provides an admin access to modify email templates
 email:
 - info@codeandeffect.com
 executables: []
@@ -95,93 +103,30 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
-- Rakefile
-- app/assets/javascripts/effective_email_templates.js
-- app/assets/stylesheets/effective_email_templates.css.scss
 - app/controllers/admin/email_templates_controller.rb
 - app/datatables/effective_email_templates_datatable.rb
-- app/helpers/effective_email_templates_helper.rb
-- app/mailers/effective/email_template_mailer.rb
+- app/mailers/effective/email_templates_mailer.rb
 - app/models/effective/access_denied.rb
 - app/models/effective/email_template.rb
 - app/views/admin/email_templates/_actions.html.haml
 - app/views/admin/email_templates/_form.html.haml
 - app/views/admin/email_templates/edit.html.haml
 - app/views/admin/email_templates/index.html.haml
-- app/views/effective/email_template_mailer/templated_email.html.haml
+- app/views/layouts/effective_email_templates_mailer_layout.html.haml
 - config/effective_email_templates.rb
 - config/routes.rb
 - db/migrate/01_create_effective_email_templates.rb.erb
-- lib/effective/liquid_mailer.rb
 - lib/effective_email_templates.rb
-- lib/effective_email_templates/email_view_template.rb
 - lib/effective_email_templates/engine.rb
-- lib/effective_email_templates/liquid_resolver.rb
-- lib/effective_email_templates/template_importer.rb
+- lib/effective_email_templates/importer.rb
 - lib/effective_email_templates/version.rb
 - lib/generators/effective_email_templates/install_generator.rb
-- lib/tasks/effective_email_templates/import_default_views.rake
-- spec/controllers/admin/email_templates_controller_spec.rb
-- spec/dummy/README.rdoc
-- spec/dummy/Rakefile
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/welcome_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/mailers/liquid_resolved_mailer.rb
-- spec/dummy/app/mailers/user_liquid_mailer.rb
-- spec/dummy/app/models/user.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/views/user_liquid/after_create_user.liquid
-- spec/dummy/app/views/welcome/index.html.haml
-- spec/dummy/bin/bundle
-- spec/dummy/bin/rails
-- spec/dummy/bin/rake
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/assets.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/cookies_serializer.rb
-- spec/dummy/config/initializers/devise.rb
-- spec/dummy/config/initializers/effective_email_templates.rb
-- spec/dummy/config/initializers/filter_parameter_logging.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/devise.en.yml
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/config/secrets.yml
-- spec/dummy/db/migrate/20141126222940_devise_create_users.rb
-- spec/dummy/db/migrate/20141126222941_create_effective_email_templates.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/effective_email_templates_spec.rb
-- spec/factories/email_template.rb
-- spec/factories/user.rb
-- spec/factory_spec.rb
-- spec/lib/effective_email_templates/template_importer_spec.rb
-- spec/mailers/liquid_resolved_mailer_spec.rb
-- spec/models/email_template_spec.rb
-- spec/models/user_spec.rb
-- spec/sanity_spec.rb
-- spec/spec_helper.rb
+- lib/tasks/effective_email_templates_tasks.rake
 homepage: https://github.com/code-and-effect/effective_email_templates
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -196,64 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Effective Email Templates provides an admin access to modify email templates
-test_files:
-- spec/spec_helper.rb
-- spec/sanity_spec.rb
-- spec/dummy/app/mailers/user_liquid_mailer.rb
-- spec/dummy/app/mailers/liquid_resolved_mailer.rb
-- spec/dummy/app/models/user.rb
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/welcome_controller.rb
-- spec/dummy/app/views/welcome/index.html.haml
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/views/user_liquid/after_create_user.liquid
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/bin/rake
-- spec/dummy/bin/bundle
-- spec/dummy/bin/rails
-- spec/dummy/config/secrets.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/locales/devise.en.yml
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/environment.rb
-- spec/dummy/config/application.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/boot.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/filter_parameter_logging.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/initializers/assets.rb
-- spec/dummy/config/initializers/cookies_serializer.rb
-- spec/dummy/config/initializers/devise.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/effective_email_templates.rb
-- spec/dummy/config.ru
-- spec/dummy/Rakefile
-- spec/dummy/public/favicon.ico
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/404.html
-- spec/dummy/db/schema.rb
-- spec/dummy/db/migrate/20141126222940_devise_create_users.rb
-- spec/dummy/db/migrate/20141126222941_create_effective_email_templates.rb
-- spec/dummy/README.rdoc
-- spec/factory_spec.rb
-- spec/mailers/liquid_resolved_mailer_spec.rb
-- spec/models/email_template_spec.rb
-- spec/models/user_spec.rb
-- spec/factories/email_template.rb
-- spec/factories/user.rb
-- spec/lib/effective_email_templates/template_importer_spec.rb
-- spec/effective_email_templates_spec.rb
-- spec/controllers/admin/email_templates_controller_spec.rb
+test_files: []

data/Rakefile

@@ -1,23 +0,0 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-# Our tasks
-load 'lib/tasks/effective_email_templates/import_default_views.rake'
-
-# Testing tasks
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-desc "Run all specs in spec directory (excluding plugin specs)"
-RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
-
-task :default => :spec

data/app/assets/javascripts/effective_email_templates.js

@@ -1 +0,0 @@
-//= require_tree ./effective_email_templates

data/app/assets/stylesheets/effective_email_templates.css.scss

@@ -1 +0,0 @@
-//

data/app/helpers/effective_email_templates_helper.rb

@@ -1,19 +0,0 @@
-module EffectiveEmailTemplatesHelper
-  def datatable_of(description_of_objects, datatable)
-    if datatable.nil?
-      content_tag(:p, "Please use Effective Datatables gem")
-    elsif datatable.collection.length > 0
-      render_datatable(datatable)
-    else
-      content_tag(:p, "There are no email templates")
-    end
-  end
-
-  def email_template_form_url( email_template )
-    if email_template.new_record?
-      effective_email_templates.admin_email_templates_path
-    else
-      effective_email_templates.admin_email_template_path( email_template )
-    end
-  end
-end

data/app/mailers/effective/email_template_mailer.rb

@@ -1,14 +0,0 @@
-module Effective
-  class EmailTemplateMailer < ActionMailer::Base
-    def templated_email(address, body, email_template, options)
-      @body = body
-      mail(
-        to: address,
-        from: email_template.from,
-        subject: email_template.subject,
-        cc: options.fetch(:cc, false),
-        bcc: options.fetch(:bcc, false),
-      )
-    end
-  end
-end

data/app/views/effective/email_template_mailer/templated_email.html.haml

@@ -1 +0,0 @@
-= @body

data/lib/effective/liquid_mailer.rb

@@ -1,15 +0,0 @@
-module Effective
-  class LiquidMailer < (defined?(::ApplicationMailer) ? ::ApplicationMailer : ::ActionMailer::Base)
-    def mail(headers = {}, &block)
-      # this be dangerous and requires ruby 2.0+
-      mail_method = caller_locations(1, 1)[0].label
-      options = EffectiveEmailTemplates.get(mail_method).mail_options
-
-      if options[:subject].present?
-        options[:subject] = Liquid::Template.parse(options[:subject]).render(@to_liquid) rescue options[:subject]
-      end
-
-      super(headers.merge(options), &block)
-    end
-  end
-end

data/lib/effective_email_templates/email_view_template.rb

@@ -1,42 +0,0 @@
-module EffectiveEmailTemplates
-  class EmailViewTemplate
-    def initialize( effective_email_template )
-      @effective_email_template = effective_email_template
-    end
-
-    attr_accessor :locals
-    attr_reader :effective_email_template
-
-    def render(view, locals, buffer=nil, &block)
-      # The view object here is an anonymous view object (it has a class
-      # of Class). It has all of the view helper methods inside of it.
-
-      if view.assigns['email_body']
-        effective_email_template.body = view.assigns['email_body']
-        effective_email_template.precompile
-
-        if effective_email_template.errors[:template].present?
-          raise "Email body error: #{effective_email_template.errors[:template].join('')}"
-        end
-      end
-
-      effective_email_template.render(view.assigns['to_liquid'])
-    end
-
-    def format
-      :html
-    end
-
-    def formats
-      [:html]
-    end
-
-    def identifier
-      effective_email_template.slug
-    end
-
-    def type
-      formats.first
-    end
-  end
-end

data/lib/effective_email_templates/liquid_resolver.rb

@@ -1,46 +0,0 @@
-module EffectiveEmailTemplates
-  class LiquidResolver < ::ActionView::Resolver
-
-    attr_reader :name, :prefix
-    alias_method :slug, :name
-
-    def find_all(name, prefix=nil, partial=false, details={}, key=nil, locals=[])
-      # key is used for caching which we won't do since
-      # these templates can be updated at any time by
-      # an admin. TODO: expire the resolver's cache when
-      # a template is updated rather than skip caching
-      @name = name
-      @prefix = prefix
-
-      return [] unless liquid_mailer?
-
-      templates = collect_view_templates
-      decorate(templates, [name, prefix, partial], details, locals)
-      templates
-    end
-
-  private
-
-    # Ensures all the resolver information is set in the template.
-    def decorate(templates, path_info, details, locals)
-      templates.each do |t|
-        t.locals = locals
-      end
-    end
-
-    def collect_view_templates
-      effective_email_templates.map do |eet|
-        EmailViewTemplate.new(eet)
-      end
-    end
-
-    def effective_email_templates
-      Array.wrap(Effective::EmailTemplate.find_by_slug(slug))
-    end
-
-    def liquid_mailer?
-      prefix =~ /liquid/
-    end
-  end
-end
-

data/lib/effective_email_templates/template_importer.rb

@@ -1,51 +0,0 @@
-module EffectiveEmailTemplates
-  class TemplateImporter
-    def self.invoke(importer = new, overwrite: false)
-      importer.invoke(overwrite)
-    end
-
-    def invoke(overwrite = false)
-      Dir[Rails.root.join('app', 'views', '**', '*.liquid')].each do |liquid_template_filepath|
-        slug = File.basename(liquid_template_filepath, '.liquid')
-        template = Effective::EmailTemplate.find_or_initialize_by(slug: slug)
-
-        update_template(template, liquid_template_filepath) if (template.persisted? && overwrite) || template.new_record?
-      end
-    end
-
-  private
-
-    def add_template_meta(file, template)
-      template.attributes = File.open(file) do |f|
-        attr = YAML.load(f)
-        attr.is_a?(Hash) ? attr : {}
-      end
-      template
-    end
-
-    def extract_template_body(file)
-      contents = file.read
-      match = contents.match(/(---+(.|\n)+---+)/)
-
-      contents.gsub(match[1], '').strip if match
-    end
-
-    def print_errors(template, liquid_template_filepath)
-      puts 'ERROR -- There was one or more validation errors while uploading:'
-      puts "  Email Template: #{liquid_template_filepath}"
-      template.errors.each do |attribute, error|
-        puts "  -> #{attribute} #{error}"
-      end
-    end
-
-    def update_template(template, liquid_template_filepath)
-      file = File.new(liquid_template_filepath, 'r')
-
-      template = add_template_meta(file, template)
-      template.body = extract_template_body(file)
-      template.save
-
-      print_errors(template, liquid_template_filepath) unless template.valid?
-    end
-  end
-end

data/lib/tasks/effective_email_templates/import_default_views.rake

@@ -1,19 +0,0 @@
-namespace :effective_email_templates do
-  desc 'Import email templates from the filesystem to the database. This rake task does not overwrite existing database templates.'
-  task import_templates: :environment do
-    EffectiveEmailTemplates::TemplateImporter.invoke
-  end
-
-  desc 'Overwrite existing default database email templates from the filesystem.'
-  task overwrite_templates: :environment do
-    puts 'By running this task, all email templates that exist in the database will be overwritten by the templates in the filesystem. Do you still want to run this task? (Y/n): '
-    answer = $stdin.gets.chomp
-
-    if answer.downcase == 'y'
-      EffectiveEmailTemplates::TemplateImporter.invoke(overwrite: true)
-      puts 'Default email templates have been overwritten successfully!'
-    else
-      puts 'Cancelled!'
-    end
-  end
-end

data/spec/controllers/admin/email_templates_controller_spec.rb

@@ -1,60 +0,0 @@
-require 'spec_helper'
-
-describe Admin::EmailTemplatesController do
-  context "as an admin" do
-    before :each do
-      @admin = create(:admin)
-      sign_in @admin
-    end
-
-    describe "#index" do
-      it 'opens' do
-        get :index, :use_route => :effective_email_templates
-        expect(response.status).to eq 200
-      end
-    end
-
-    describe "#new" do
-      it 'opens' do
-        get :new, :use_route => :effective_email_templates
-        expect(response.status).to eq 200
-      end
-    end
-
-    describe "#create" do
-      it 'creates an email template' do
-        expect{
-          post :create, effective_email_template: attributes_for(:email_template), :use_route => :effective_email_templates
-        }.to change(Effective::EmailTemplate,:count).by(1)
-      end
-    end
-
-    context "member actions" do
-      before :each do
-        @email_template = create(:email_template)
-      end
-
-      describe "#edit" do
-        it 'opens' do
-          get :edit, :id => @email_template.id, :use_route => :effective_email_templates
-          expect(response.status).to eq 200
-        end
-      end
-
-      describe "#update" do
-        it 'updates an email template' do
-          attributes = @email_template.attributes
-          old_from = @email_template.from
-          new_from = "gfssljewr@dsfa.com"
-          attributes["from"] = new_from
-          expect{
-            patch :update, id: @email_template.id, effective_email_template: attributes, :use_route => :effective_email_templates
-            @email_template.reload
-          }.to change(@email_template,:from)
-        end
-      end
-    end
-
-  end
-end
-

data/spec/dummy/README.rdoc

@@ -1,28 +0,0 @@
-== README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
-
-
-Please feel free to use a different markup language if you do not plan to run
-<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('../config/application', __FILE__)
-
-Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -1,13 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
-//
-// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/spec/dummy/app/controllers/application_controller.rb

@@ -1,5 +0,0 @@
-class ApplicationController < ActionController::Base
-  # Prevent CSRF attacks by raising an exception.
-  # For APIs, you may want to use :null_session instead.
-  protect_from_forgery with: :exception
-end