custom_emails 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (64) hide show
  1. data/Rakefile +34 -0
  2. data/app/mailers/custom_emails/mailer.rb +22 -0
  3. data/app/models/custom_emails/email.rb +15 -0
  4. data/app/models/custom_emails/email_kind.rb +8 -0
  5. data/db/migrate/20131018141445_create_custom_emails_emails.rb +17 -0
  6. data/db/migrate/20131018143726_create_custom_emails_email_kinds.rb +17 -0
  7. data/lib/custom_emails.rb +12 -0
  8. data/lib/custom_emails/engine.rb +5 -0
  9. data/lib/custom_emails/models.rb +17 -0
  10. data/lib/custom_emails/orm/active_record.rb +1 -0
  11. data/lib/custom_emails/version.rb +3 -0
  12. data/lib/generators/custom_emails/install_generator.rb +11 -0
  13. data/lib/generators/templates/custom_emails.rb +21 -0
  14. data/lib/tasks/custom_emails_tasks.rake +4 -0
  15. data/test/custom_emails_test.rb +7 -0
  16. data/test/dummy/README.rdoc +28 -0
  17. data/test/dummy/Rakefile +6 -0
  18. data/test/dummy/app/assets/javascripts/application.js +13 -0
  19. data/test/dummy/app/assets/stylesheets/application.css +13 -0
  20. data/test/dummy/app/controllers/application_controller.rb +5 -0
  21. data/test/dummy/app/helpers/application_helper.rb +2 -0
  22. data/test/dummy/app/models/example.rb +2 -0
  23. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  24. data/test/dummy/bin/bundle +3 -0
  25. data/test/dummy/bin/rails +4 -0
  26. data/test/dummy/bin/rake +4 -0
  27. data/test/dummy/config.ru +4 -0
  28. data/test/dummy/config/application.rb +23 -0
  29. data/test/dummy/config/boot.rb +5 -0
  30. data/test/dummy/config/database.yml +25 -0
  31. data/test/dummy/config/environment.rb +5 -0
  32. data/test/dummy/config/environments/development.rb +29 -0
  33. data/test/dummy/config/environments/production.rb +80 -0
  34. data/test/dummy/config/environments/test.rb +36 -0
  35. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  36. data/test/dummy/config/initializers/custom_emails.rb +10 -0
  37. data/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  38. data/test/dummy/config/initializers/inflections.rb +16 -0
  39. data/test/dummy/config/initializers/mime_types.rb +5 -0
  40. data/test/dummy/config/initializers/secret_token.rb +12 -0
  41. data/test/dummy/config/initializers/session_store.rb +3 -0
  42. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  43. data/test/dummy/config/locales/en.yml +23 -0
  44. data/test/dummy/config/routes.rb +56 -0
  45. data/test/dummy/db/development.sqlite3 +0 -0
  46. data/test/dummy/db/migrate/20131018164626_create_examples.rb +6 -0
  47. data/test/dummy/db/schema.rb +44 -0
  48. data/test/dummy/db/test.sqlite3 +0 -0
  49. data/test/dummy/log/development.log +1201 -0
  50. data/test/dummy/log/test.log +3167 -0
  51. data/test/dummy/public/404.html +58 -0
  52. data/test/dummy/public/422.html +58 -0
  53. data/test/dummy/public/500.html +57 -0
  54. data/test/dummy/public/favicon.ico +0 -0
  55. data/test/fixtures/custom_emails/email_kinds.yml +11 -0
  56. data/test/fixtures/custom_emails/emails.yml +0 -0
  57. data/test/integration/navigation_test.rb +10 -0
  58. data/test/lib/models_test.rb +53 -0
  59. data/test/mailers/custom_emails/mailer_test.rb +47 -0
  60. data/test/models/custom_emails/email_kind_test.rb +9 -0
  61. data/test/models/custom_emails/email_test.rb +42 -0
  62. data/test/test_helper.rb +16 -0
  63. data/test/test_models.rb +3 -0
  64. metadata +211 -0
data/Rakefile ADDED
@@ -0,0 +1,34 @@
1
+ begin
2
+ require 'bundler/setup'
3
+ rescue LoadError
4
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
5
+ end
6
+
7
+ require 'rdoc/task'
8
+
9
+ RDoc::Task.new(:rdoc) do |rdoc|
10
+ rdoc.rdoc_dir = 'rdoc'
11
+ rdoc.title = 'CustomEmails'
12
+ rdoc.options << '--line-numbers'
13
+ rdoc.rdoc_files.include('README.rdoc')
14
+ rdoc.rdoc_files.include('lib/**/*.rb')
15
+ end
16
+
17
+ APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
18
+ load 'rails/tasks/engine.rake'
19
+
20
+
21
+
22
+ Bundler::GemHelper.install_tasks
23
+
24
+ require 'rake/testtask'
25
+
26
+ Rake::TestTask.new(:test) do |t|
27
+ t.libs << 'lib'
28
+ t.libs << 'test'
29
+ t.pattern = 'test/**/*_test.rb'
30
+ t.verbose = false
31
+ end
32
+
33
+
34
+ task default: :test
@@ -0,0 +1,22 @@
1
+ if defined?(ActionMailer)
2
+ module CustomEmails
3
+ class Mailer < ActionMailer::Base
4
+ def custom_email_to(dest, kind_name, emailable=nil, options={})
5
+ locale = options[:locale] || CustomEmails.default_locale
6
+ kind = EmailKind.find_by!(name: kind_name)
7
+ email = Email.find_by!(kind_id: kind.id, emailable_id: emailable.try(:id), locale: locale)
8
+
9
+ email_to(email, dest, options)
10
+ end
11
+
12
+ def email_to(email, dest, options={})
13
+ sender = options[:from] || CustomEmails.default_from
14
+
15
+ mail(to: dest, from: sender, subject: email.subject) do |format|
16
+ format.html { email.content_html } unless email.content_html.blank?
17
+ format.text { email.content_text }
18
+ end
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,15 @@
1
+ module CustomEmails
2
+ class Email < ActiveRecord::Base
3
+ if CustomEmails.scoped
4
+ belongs_to :emailable, polymorphic: true
5
+ end
6
+
7
+ belongs_to :kind, class_name: EmailKind, inverse_of: :emails
8
+
9
+ validates_presence_of :locale, :subject, :content_text, :kind
10
+
11
+ def to(dest, options={})
12
+ CustomEmails::Mailer.email_to(self, dest, options)
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,8 @@
1
+ module CustomEmails
2
+ class EmailKind < ActiveRecord::Base
3
+ validates_presence_of :name
4
+ validates_uniqueness_of :name
5
+
6
+ has_many :emails, foreign_key: :kind_id, inverse_of: :kind, dependent: :destroy
7
+ end
8
+ end
@@ -0,0 +1,17 @@
1
+ class CreateCustomEmailsEmails < ActiveRecord::Migration
2
+ def change
3
+ create_table :custom_emails_emails do |t|
4
+ t.integer :emailable_id
5
+ t.string :emailable_type
6
+ t.string :locale
7
+ t.text :subject
8
+ t.text :content_text
9
+ t.text :content_html
10
+
11
+ t.timestamps
12
+ end
13
+
14
+ add_index :custom_emails_emails, :locale
15
+ add_index :custom_emails_emails, :emailable_id
16
+ end
17
+ end
@@ -0,0 +1,17 @@
1
+ class CreateCustomEmailsEmailKinds < ActiveRecord::Migration
2
+ def change
3
+ create_table :custom_emails_email_kinds do |t|
4
+ t.string :name
5
+
6
+ t.timestamps
7
+ end
8
+
9
+ add_index :custom_emails_email_kinds, :name, unique: true
10
+
11
+ add_column :custom_emails_emails, :kind_id, :integer
12
+ add_index :custom_emails_emails, [:kind_id, :emailable_id]
13
+
14
+ # The uniqueness of the (kind, locale, emailable) tuple is ensured here
15
+ add_index :custom_emails_emails, [:kind_id, :locale, :emailable_id, :emailable_type], unique: true, name: 'unique_w_kind_locale_and_emailable'
16
+ end
17
+ end
@@ -0,0 +1,12 @@
1
+ require 'custom_emails/engine'
2
+
3
+ module CustomEmails
4
+ @@scoped = true
5
+ @@default_locale = :en
6
+
7
+ mattr_accessor :default_locale
8
+ mattr_accessor :default_from
9
+ mattr_accessor :scoped
10
+
11
+ autoload :Models, 'custom_emails/models'
12
+ end
@@ -0,0 +1,5 @@
1
+ module CustomEmails
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace CustomEmails
4
+ end
5
+ end
@@ -0,0 +1,17 @@
1
+ module CustomEmails
2
+ module Models
3
+ def has_custom_emails(options={})
4
+ options = options.reverse_merge({
5
+ as: :emails
6
+ })
7
+
8
+ has_many options[:as], as: :emailable, class_name: ::CustomEmails::Email, dependent: :destroy
9
+
10
+ class_eval "def #{options[:as]}_by_kind(locale=nil)
11
+ assoc = #{options[:as]}.includes(:kind)
12
+ assoc = assoc.where(locale: locale) if locale
13
+ assoc.group_by(&:kind)
14
+ end"
15
+ end
16
+ end
17
+ end
@@ -0,0 +1 @@
1
+ ActiveRecord::Base.extend CustomEmails::Models
@@ -0,0 +1,3 @@
1
+ module CustomEmails
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,11 @@
1
+ module CustomEmails
2
+ class InstallGenerator < Rails::Generators::Base
3
+ source_root File.expand_path('../../templates', __FILE__)
4
+
5
+ desc 'Copy the initializer for configuring custom_emails'
6
+
7
+ def copy_initializer
8
+ copy_file 'custom_emails.rb', 'config/initializers/custom_emails.rb'
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,21 @@
1
+ # You can replace active_record with something else that is supported.
2
+ # This is the list of supported ORMs:
3
+ # - active_record
4
+ require 'custom_emails/orm/active_record'
5
+
6
+ # If emails are scoped to a certain model you should declare it with
7
+ # the `has_custom_emails` method and activate the association in the
8
+ # custom_emails with this option. The default is true
9
+ #
10
+ #CustomEmails.scoped = false
11
+
12
+ # You can customize the default sender of the custom emails here.
13
+ # This will be used by CustomEmails::Mailer#custom_email_to
14
+ #
15
+ CustomEmails.default_from = 'change-me@your-domain.com'
16
+
17
+ # This is the default locale used by CustomEmails::Mailer.custom_email_to
18
+ # the default is :en
19
+ #
20
+ #CustomEmails.default_locale = :en
21
+
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :custom_emails do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,7 @@
1
+ require 'test_helper'
2
+
3
+ class CustomEmailsTest < ActiveSupport::TestCase
4
+ test "truth" do
5
+ assert_kind_of Module, CustomEmails
6
+ end
7
+ end
@@ -0,0 +1,28 @@
1
+ == README
2
+
3
+ This README would normally document whatever steps are necessary to get the
4
+ application up and running.
5
+
6
+ Things you may want to cover:
7
+
8
+ * Ruby version
9
+
10
+ * System dependencies
11
+
12
+ * Configuration
13
+
14
+ * Database creation
15
+
16
+ * Database initialization
17
+
18
+ * How to run the test suite
19
+
20
+ * Services (job queues, cache servers, search engines, etc.)
21
+
22
+ * Deployment instructions
23
+
24
+ * ...
25
+
26
+
27
+ Please feel free to use a different markup language if you do not plan to run
28
+ <tt>rake doc:app</tt>.
@@ -0,0 +1,6 @@
1
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
2
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
3
+
4
+ require File.expand_path('../config/application', __FILE__)
5
+
6
+ Dummy::Application.load_tasks
@@ -0,0 +1,13 @@
1
+ // This is a manifest file that'll be compiled into application.js, which will include all the files
2
+ // listed below.
3
+ //
4
+ // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
5
+ // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
6
+ //
7
+ // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
8
+ // compiled file.
9
+ //
10
+ // Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
11
+ // about supported directives.
12
+ //
13
+ //= require_tree .
@@ -0,0 +1,13 @@
1
+ /*
2
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
3
+ * listed below.
4
+ *
5
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
6
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
7
+ *
8
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
9
+ * compiled file, but it's generally better to create a new file per style scope.
10
+ *
11
+ *= require_self
12
+ *= require_tree .
13
+ */
@@ -0,0 +1,5 @@
1
+ class ApplicationController < ActionController::Base
2
+ # Prevent CSRF attacks by raising an exception.
3
+ # For APIs, you may want to use :null_session instead.
4
+ protect_from_forgery with: :exception
5
+ end
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
@@ -0,0 +1,2 @@
1
+ class Example < ActiveRecord::Base
2
+ end
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Dummy</title>
5
+ <%= stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => true %>
6
+ <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env ruby
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
3
+ load Gem.bin_path('bundler', 'bundle')
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ APP_PATH = File.expand_path('../../config/application', __FILE__)
3
+ require_relative '../config/boot'
4
+ require 'rails/commands'
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ require_relative '../config/boot'
3
+ require 'rake'
4
+ Rake.application.run
@@ -0,0 +1,4 @@
1
+ # This file is used by Rack-based servers to start the application.
2
+
3
+ require ::File.expand_path('../config/environment', __FILE__)
4
+ run Rails.application
@@ -0,0 +1,23 @@
1
+ require File.expand_path('../boot', __FILE__)
2
+
3
+ require 'rails/all'
4
+
5
+ Bundler.require(*Rails.groups)
6
+ require "custom_emails"
7
+
8
+ module Dummy
9
+ class Application < Rails::Application
10
+ # Settings in config/environments/* take precedence over those specified here.
11
+ # Application configuration should go into files in config/initializers
12
+ # -- all .rb files in that directory are automatically loaded.
13
+
14
+ # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
15
+ # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
16
+ # config.time_zone = 'Central Time (US & Canada)'
17
+
18
+ # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
19
+ # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
20
+ # config.i18n.default_locale = :de
21
+ end
22
+ end
23
+
@@ -0,0 +1,5 @@
1
+ # Set up gems listed in the Gemfile.
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
3
+
4
+ require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
5
+ $LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
@@ -0,0 +1,25 @@
1
+ # SQLite version 3.x
2
+ # gem install sqlite3
3
+ #
4
+ # Ensure the SQLite 3 gem is defined in your Gemfile
5
+ # gem 'sqlite3'
6
+ development:
7
+ adapter: sqlite3
8
+ database: db/development.sqlite3
9
+ pool: 5
10
+ timeout: 5000
11
+
12
+ # Warning: The database defined as "test" will be erased and
13
+ # re-generated from your development database when you run "rake".
14
+ # Do not set this db to the same as development or production.
15
+ test:
16
+ adapter: sqlite3
17
+ database: db/test.sqlite3
18
+ pool: 5
19
+ timeout: 5000
20
+
21
+ production:
22
+ adapter: sqlite3
23
+ database: db/production.sqlite3
24
+ pool: 5
25
+ timeout: 5000
@@ -0,0 +1,5 @@
1
+ # Load the Rails application.
2
+ require File.expand_path('../application', __FILE__)
3
+
4
+ # Initialize the Rails application.
5
+ Dummy::Application.initialize!
@@ -0,0 +1,29 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb.
3
+
4
+ # In the development environment your application's code is reloaded on
5
+ # every request. This slows down response time but is perfect for development
6
+ # since you don't have to restart the web server when you make code changes.
7
+ config.cache_classes = false
8
+
9
+ # Do not eager load code on boot.
10
+ config.eager_load = false
11
+
12
+ # Show full error reports and disable caching.
13
+ config.consider_all_requests_local = true
14
+ config.action_controller.perform_caching = false
15
+
16
+ # Don't care if the mailer can't send.
17
+ config.action_mailer.raise_delivery_errors = false
18
+
19
+ # Print deprecation notices to the Rails logger.
20
+ config.active_support.deprecation = :log
21
+
22
+ # Raise an error on page load if there are pending migrations
23
+ config.active_record.migration_error = :page_load
24
+
25
+ # Debug mode disables concatenation and preprocessing of assets.
26
+ # This option may cause significant delays in view rendering with a large
27
+ # number of complex assets.
28
+ config.assets.debug = true
29
+ end