custom_emails 0.0.1

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CustomEmails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/mailers/custom_emails/mailer.rb

@@ -0,0 +1,22 @@
+if defined?(ActionMailer)
+  module CustomEmails
+    class Mailer < ActionMailer::Base
+      def custom_email_to(dest, kind_name, emailable=nil, options={})
+        locale = options[:locale] || CustomEmails.default_locale
+        kind   = EmailKind.find_by!(name: kind_name)
+        email  = Email.find_by!(kind_id: kind.id, emailable_id: emailable.try(:id), locale: locale)
+
+        email_to(email, dest, options)
+      end
+
+      def email_to(email, dest, options={})
+        sender = options[:from] || CustomEmails.default_from
+
+        mail(to: dest, from: sender, subject: email.subject) do |format|
+          format.html { email.content_html } unless email.content_html.blank?
+          format.text { email.content_text }
+        end
+      end
+    end
+  end
+end

data/app/models/custom_emails/email.rb

@@ -0,0 +1,15 @@
+module CustomEmails
+  class Email < ActiveRecord::Base
+    if CustomEmails.scoped
+      belongs_to :emailable, polymorphic: true
+    end
+
+    belongs_to :kind, class_name: EmailKind, inverse_of: :emails
+
+    validates_presence_of :locale, :subject, :content_text, :kind
+
+    def to(dest, options={})
+      CustomEmails::Mailer.email_to(self, dest, options)
+    end
+  end
+end

data/app/models/custom_emails/email_kind.rb

@@ -0,0 +1,8 @@
+module CustomEmails
+  class EmailKind < ActiveRecord::Base
+    validates_presence_of :name
+    validates_uniqueness_of :name
+
+    has_many :emails, foreign_key: :kind_id, inverse_of: :kind, dependent: :destroy
+  end
+end

data/db/migrate/20131018141445_create_custom_emails_emails.rb

@@ -0,0 +1,17 @@
+class CreateCustomEmailsEmails < ActiveRecord::Migration
+  def change
+    create_table :custom_emails_emails do |t|
+      t.integer :emailable_id
+      t.string  :emailable_type
+      t.string  :locale
+      t.text    :subject
+      t.text    :content_text
+      t.text    :content_html
+
+      t.timestamps
+    end
+
+    add_index :custom_emails_emails, :locale
+    add_index :custom_emails_emails, :emailable_id
+  end
+end

data/db/migrate/20131018143726_create_custom_emails_email_kinds.rb

@@ -0,0 +1,17 @@
+class CreateCustomEmailsEmailKinds < ActiveRecord::Migration
+  def change
+    create_table :custom_emails_email_kinds do |t|
+      t.string :name
+
+      t.timestamps
+    end
+
+    add_index :custom_emails_email_kinds, :name, unique: true
+
+    add_column :custom_emails_emails, :kind_id, :integer
+    add_index :custom_emails_emails, [:kind_id, :emailable_id]
+
+    # The uniqueness of the (kind, locale, emailable) tuple is ensured here
+    add_index :custom_emails_emails, [:kind_id, :locale, :emailable_id, :emailable_type], unique: true, name: 'unique_w_kind_locale_and_emailable'
+  end
+end

data/lib/custom_emails.rb

@@ -0,0 +1,12 @@
+require 'custom_emails/engine'
+
+module CustomEmails
+  @@scoped         = true
+  @@default_locale = :en
+
+  mattr_accessor :default_locale
+  mattr_accessor :default_from
+  mattr_accessor :scoped
+
+  autoload :Models, 'custom_emails/models'
+end

data/lib/custom_emails/engine.rb

@@ -0,0 +1,5 @@
+module CustomEmails
+  class Engine < ::Rails::Engine
+    isolate_namespace CustomEmails
+  end
+end

data/lib/custom_emails/models.rb

@@ -0,0 +1,17 @@
+module CustomEmails
+  module Models
+    def has_custom_emails(options={})
+      options = options.reverse_merge({
+        as: :emails
+      })
+
+      has_many options[:as], as: :emailable, class_name: ::CustomEmails::Email, dependent: :destroy
+
+      class_eval "def #{options[:as]}_by_kind(locale=nil)
+          assoc = #{options[:as]}.includes(:kind)
+          assoc = assoc.where(locale: locale) if locale
+          assoc.group_by(&:kind)
+        end"
+    end
+  end
+end

data/lib/custom_emails/orm/active_record.rb

@@ -0,0 +1 @@
+ActiveRecord::Base.extend CustomEmails::Models

data/lib/custom_emails/version.rb

@@ -0,0 +1,3 @@
+module CustomEmails
+  VERSION = "0.0.1"
+end

data/lib/generators/custom_emails/install_generator.rb

@@ -0,0 +1,11 @@
+module CustomEmails
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../templates', __FILE__)
+
+    desc 'Copy the initializer for configuring custom_emails'
+
+    def copy_initializer
+      copy_file 'custom_emails.rb', 'config/initializers/custom_emails.rb'
+    end
+  end
+end

data/lib/generators/templates/custom_emails.rb

@@ -0,0 +1,21 @@
+# You can replace active_record with something else that is supported.
+# This is the list of supported ORMs:
+# - active_record
+require 'custom_emails/orm/active_record'
+
+# If emails are scoped to a certain model you should declare it with
+# the `has_custom_emails` method and activate the association in the
+# custom_emails with this option. The default is true
+#
+#CustomEmails.scoped = false
+
+# You can customize the default sender of the custom emails here.
+# This will be used by CustomEmails::Mailer#custom_email_to
+#
+CustomEmails.default_from = 'change-me@your-domain.com'
+
+# This is the default locale used by CustomEmails::Mailer.custom_email_to
+# the default is :en
+#
+#CustomEmails.default_locale = :en
+

data/lib/tasks/custom_emails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :custom_emails do
+#   # Task goes here
+# end

data/test/custom_emails_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CustomEmailsTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, CustomEmails
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== 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/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# 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__)
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,13 @@
+// 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/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

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

@@ -0,0 +1,5 @@
+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

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/example.rb

@@ -0,0 +1,2 @@
+class Example < ActiveRecord::Base
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "custom_emails"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end