db_mailer_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42052d77f07a90e9ba3872697932400da933c030
+  data.tar.gz: 6577ed9fd4e8a002fc81db6077e9f1dce6e5903e
+SHA512:
+  metadata.gz: 89fb6764666ba884392f5744f70609aa140c0fc1bc0ccf0a2d1f68763dd9c9248d1c96005c22250c45dba0591448ab4aa03c304af890de526769d2a7b3b8a175
+  data.tar.gz: 480ab51e62f100b883c821d4541d3b973de295d2d852635f6f4ed98cfbdbab0b554119d2217029cf0d1664d40b26a439bc65e07e4d26d6a8ab66f3cc8a76940b

data/.gitignore

@@ -0,0 +1,24 @@
+# RubyMine project folder
+/.idea/
+
+# bundler config
+/.bundle/
+
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# test RailsApp
+spec/rails_app/log/
+spec/rails_app/tmp/
+spec/rails_app/db/*.sqlite3
+
+# rspec failure tracking
+.rspec_status
+
+# linux files
+.directory

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alexhifer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rails', '~> 5.1'
+
+group :development do
+  gem 'listen', '~> 3.0'
+end
+
+group :development, :test do
+  gem 'factory_bot', '~> 4.0'
+end
+
+group :test do
+  gem 'database_cleaner', '~> 1.6'
+  gem 'shoulda-matchers', '~> 3.1'
+  gem 'generator_spec', '~> 0.9'
+end

data/Gemfile.lock

@@ -0,0 +1,161 @@
+PATH
+  remote: .
+  specs:
+    db_mailer_rails (0.1.0)
+      actionmailer (>= 4.2, < 5.2)
+      actionpack (>= 4.2, < 5.2)
+      mustache (~> 1.0)
+      railties (>= 4.2, < 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.4)
+      actionpack (= 5.1.4)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.4)
+      activesupport (= 5.1.4)
+      globalid (>= 0.3.6)
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activerecord (5.1.4)
+      activemodel (= 5.1.4)
+      activesupport (= 5.1.4)
+      arel (~> 8.0)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    database_cleaner (1.6.2)
+    diff-lcs (1.3)
+    erubi (1.7.0)
+    factory_bot (4.8.2)
+      activesupport (>= 3.0.0)
+    ffi (1.9.18)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    method_source (0.9.0)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    mustache (1.0.5)
+    nio4r (2.1.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.3)
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
+    rails (5.1.4)
+      actioncable (= 5.1.4)
+      actionmailer (= 5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      activemodel (= 5.1.4)
+      activerecord (= 5.1.4)
+      activesupport (= 5.1.4)
+      bundler (>= 1.3.0)
+      railties (= 5.1.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.4)
+      actionpack (= 5.1.4)
+      activesupport (= 5.1.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.3.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    ruby_dep (1.5.0)
+    shoulda-matchers (3.1.2)
+      activesupport (>= 4.0.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner (~> 1.6)
+  db_mailer_rails!
+  factory_bot (~> 4.0)
+  generator_spec (~> 0.9)
+  listen (~> 3.0)
+  rails (~> 5.1)
+  rspec (~> 3.0)
+  shoulda-matchers (~> 3.1)
+  sqlite3 (~> 1.3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alexey Degtyarev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,157 @@
+![DbMailerRails Logo](https://raw.github.com/alexhifer/db_mailer_rails/master/db_mailer_rails.png)
+
+This gem allows you to store mail templates in the database.
+
+Capabilities:
+
+* Sending mails with ActionMailer::MessageDelivery (#deliver_now and #deliver_later methods)
+* For replace values and logic in mail templates used Mustache
+* To insert mail templates, use the configuration file(*config/db_mailer_templates.yml*) and task(*rake db_mailer_rails:sync*)
+* Refactoring an existing project with sending mails is minimal
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'db_mailer_rails'
+```
+
+And then execute:
+
+    $ bundle install
+
+Next, you need to run the generator:
+
+    $ rails g db_mailer_rails:install
+
+And also execute the created migration:
+
+    $ rake db:migrate
+    
+Syncing the configuration file(*config/db_mailer_templates.yml*) with database:
+    
+    $ rake db_mailer_rails:sync
+    
+## Usage
+
+##### A quick example of sending:
+
+```ruby
+HelloWorldDbMailer.build(OpenStruct.new(name: '')).deliver_now
+```
+
+**HelloWorldDbMailer** - this is the inheritance class of DbMailerRails::Base. It provides a mechanism for searching and rendering a template. All db_mailers need to inherit from it. All db_mailers are in the app /db_mailers folder.
+
+##### A quick example of create db_mailer:
+
+1. Create *app/db_mailers/test_db_mailer.rb* with content: 
+    ````ruby
+    class TestDbMailer < DbMailerRails::Base
+      def fields
+        super.merge(current_year: 'Current year')
+      end
+      
+      def current_year
+        Time.current.year
+      end
+    end
+    ````
+
+2. Add the following lines to *config/db_mailer_rails.yml*:
+    ```yaml
+    TestDbMailer:
+      subject: This test email
+      from: Site <no-reply@example.com>
+      to: User <user@example.com>
+      body: 'Hello, User! Current year is {{current_year}}'
+    ```
+    
+3. Run task:
+
+        $ rake db_mailer_rails:sync
+        
+4. Use db_mailer in your project:
+    
+    ```ruby
+    TestDbMailer.build.deliver_now
+    ````
+    
+##### Build db_mailer with several attributes:
+
+```ruby
+class TestDbMailer < DbMailerRails::Base
+  attr_accessor :auth_token
+  
+  delegate :name, :email, to: :object, prefix: :user
+  
+  def build(object, **args)
+    self.auth_token = args[:auth_token]
+    super
+  end
+  
+  def fields
+    super.merge(
+      user_name: 'User name',
+      user_email: 'User email',
+      auth_token: 'Auth token'
+    )
+  end
+end
+```
+
+Sending a message with multiple attributes:
+
+```ruby
+TestDbMailer.build(current_user, auth_token: 'qwerty123')
+```
+
+**current_user** - instance of User model with attributes *name* and *email*
+
+##### DbMailer layout
+
+The default template is *app/views/layouts/mailer.html.erb*.
+
+To change the template for the db_mailer, you need to override method *layout* in your db_mailer:
+
+```ruby
+def layout
+  'custom_mail_template'
+end
+```
+
+##### Development of mail template editing module
+
+
+For the user to know what variables he can use in the template, you need helper *db_mailer_rails_fields_render*:
+
+```ruby
+db_mailer_rails_fields_render(template)
+```
+
+**template** - instance of DbMailerTemplate
+
+This helper render:
+
+```html
+  <ul class="db_mailer__fields">
+    <li class="db_mailer__field"><span>{{user_name}}</span> - User name</li>
+    <li class="db_mailer__field"><span>{{user_email}}</span> - User e-mail</li>
+  </ul>
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/db_mailer_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DbMailerRails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/db_mailer_rails/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'db_mailer_rails'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/db_mailer_templates.yml

@@ -0,0 +1,8 @@
+HelloWorldDbMailer:
+  subject: '{{app_name}} - Hello world!'
+  from: Site <no-reply@example.com>
+  to: '{{user_name}} <{{user_email}}>'
+  body: >
+    Hello, {{user_name}}!<br><br>
+    This is your first e-mail with <b>DbMailerRails gem</b> :)<br><br>
+    Don't forget to "Star" this <a href="https://github.com/thoughtbot/paperclip">gem on GitHub</a>.

data/db_mailer_rails.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'db_mailer_rails/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'db_mailer_rails'
+  s.version       = DbMailerRails::VERSION.dup
+  s.authors       = 'Alexey Degtyarev'
+  s.email         = 'alexhifer@gmail.com'
+
+  s.summary       = %q{Store mail templates in the database.}
+  s.description   = %q{This gem allows you to store mail templates in the database.}
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'actionpack', ['>= 4.2', '< 5.2']
+  s.add_dependency 'actionmailer', ['>= 4.2', '< 5.2']
+  s.add_dependency 'railties', ['>= 4.2', '< 5.2']
+  s.add_dependency 'mustache', '~> 1.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'sqlite3', '~> 1.3.0'
+end

data/lib/db_mailer_rails/base.rb

@@ -0,0 +1,58 @@
+require 'action_mailer'
+require 'db_mailer_rails/replacer'
+require 'db_mailer_rails/template_finder'
+
+module DbMailerRails
+  class Base < ActionMailer::Base
+    attr_accessor :object
+
+    def build(object = nil, **_args)
+      self.object = object
+      replacer = Replacer.new(fields_with_data)
+      finder = TemplateFinder.new(self.class)
+      template = finder.db_mail_template
+
+      mail_params = {
+        from: replacer.replace(template.from),
+        to: replacer.replace(template.to),
+        subject: replacer.replace(template.subject)
+      }
+
+      # add attachments to mail
+      mail_attachments
+
+      mail(mail_params) do |format|
+        format.html { render html: replacer.replace(template.body).html_safe, layout: layout_by_environment }
+      end
+    end
+
+    def fields
+      {}
+    end
+
+    def mail_attachments
+    end
+
+    private
+
+    def add_inline_image(file_path)
+      file = file_path.split('/').last
+      image_path = Rails.root.join('app', 'assets', 'images', file_path)
+      attachments.inline[file] = File.read(image_path) if File.exists?(image_path)
+    end
+
+    def layout
+      'mailer'
+    end
+
+    def layout_by_environment
+      Rails.env.test? ? false : layout
+    end
+
+    def fields_with_data
+      @fields_with_data ||= fields.keys.each_with_object({}) do |field_name, res|
+        res[field_name] = self.send(field_name)
+      end
+    end
+  end
+end

data/lib/db_mailer_rails/helper.rb

@@ -0,0 +1,24 @@
+module DbMailerRails
+  module Helper
+    include ActionView::Helpers::TagHelper
+
+    # Render DbMailerRails fields
+    # <ul class="db_mailer__fields">
+    #   <li class="db_mailer__field"><span>{{[FIELD_NAME]}}</span> - [FIELD_DESCRIPTION]</li>
+    #   ...
+    # </ul>
+    #
+    # @param db_mailer_template [DbMailerTemplate]
+    # @return [String] html safe string
+    def db_mailer_rails_fields_render(db_mailer_template)
+      return '' unless db_mailer_template
+
+      list = db_mailer_template.db_mailer.new.fields.map do |field_name, description|
+        field = content_tag('span', "{{#{field_name}}}", class: 'db_mailer__field_name')
+        content_tag('li', "#{field} - #{description}".html_safe, class: 'db_mailer__field')
+      end
+
+      content_tag('ul', list.join.html_safe, class: 'db_mailer__fields')
+    end
+  end
+end

data/lib/db_mailer_rails/models/methods.rb

@@ -0,0 +1,11 @@
+module DbMailerRails
+  module Models
+    module Methods
+      extend  ActiveSupport::Concern
+
+      def db_mailer
+        db_mailer_class.constantize rescue nil
+      end
+    end
+  end
+end

data/lib/db_mailer_rails/models/validatable.rb

@@ -0,0 +1,14 @@
+module DbMailerRails
+  module Models
+    module Validatable
+      extend  ActiveSupport::Concern
+
+      included do
+        validates :db_mailer_class, :subject, :from, :to, :body, presence: true, length: { minimum: 3 }
+        validates :subject, length: { maximum: 80 }
+        validates :from, length: { maximum: 64 }
+        validates :to, length: { maximum: 64 }
+      end
+    end
+  end
+end

data/lib/db_mailer_rails/railtie.rb

@@ -0,0 +1,5 @@
+module DbMailerRails
+  class Railtie < Rails::Railtie
+    rake_tasks { load 'tasks/db_mailer_rails.rake' }
+  end
+end

data/lib/db_mailer_rails/replacer.rb

@@ -0,0 +1,18 @@
+require 'mustache'
+
+module DbMailerRails
+  class Replacer
+    attr_accessor :replace_hash
+
+    # @param replace_hash [Hash]
+    def initialize(replace_hash)
+      self.replace_hash = replace_hash
+    end
+
+    # @param text [DbMailerRails::Base]
+    # @return [String]
+    def replace(text)
+      Mustache.render(text, replace_hash)
+    end
+  end
+end

data/lib/db_mailer_rails/template_finder.rb

@@ -0,0 +1,20 @@
+module DbMailerRails
+  class TemplateFinder
+    attr_accessor :db_mail_template
+
+    # @param db_mailer_class [DbMailerRails::Base]
+    def initialize(db_mailer_class)
+      self.db_mail_template = find(db_mailer_class)
+    end
+
+    private
+
+    def find(db_mailer_class)
+      db_mail_template_class.find_by!(db_mailer_class: db_mailer_class.name)
+    end
+
+    def db_mail_template_class
+      DbMailerRails.template_model_class.constantize rescue nil
+    end
+  end
+end

data/lib/db_mailer_rails/version.rb

@@ -0,0 +1,3 @@
+module DbMailerRails
+  VERSION = '0.1.0'.freeze
+end

data/lib/db_mailer_rails.rb

@@ -0,0 +1,20 @@
+require 'rails'
+
+require 'db_mailer_rails/railtie' if defined?(Rails::Railtie)
+require 'db_mailer_rails/base'
+require 'db_mailer_rails/helper'
+ActionView::Base.send :include, DbMailerRails::Helper
+
+module DbMailerRails
+  # Template class
+  mattr_accessor :template_model_class
+  @@template_model_class = 'DbMailerTemplate'
+
+  # Sync file
+  mattr_accessor :sync_file_path
+  @@sync_file_path = 'config/db_mailer_templates.yml'
+
+  def self.setup
+    yield self
+  end
+end

data/lib/generators/db_mailer_rails/helpers/migration_helper.rb

@@ -0,0 +1,25 @@
+module DbMailerRails
+  module Generators
+    module Helpers
+      module MigrationHelper
+        def migration_path
+          if Rails.version >= '5.0.3'
+            db_migrate_path
+          else
+            'db/migrate'
+          end
+        end
+
+        def migration_destination_path
+          File.join(destination_root, migration_path, "create_#{table_name}.rb")
+        end
+
+        def migration_version
+          if rails5?
+            "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/db_mailer_rails/helpers/model_helper.rb

@@ -0,0 +1,29 @@
+module DbMailerRails
+  module Generators
+    module Helpers
+      module ModelHelper
+        private
+
+        def table_name
+          @table_name ||= model_class.tableize.gsub('/', '_')
+        end
+
+        def model_exists?
+          File.exist?(model_path)
+        end
+
+        def model_path
+          @model_path ||= File.join(destination_root, 'app', 'models', "#{model_class.underscore}.rb")
+        end
+
+        def model_class
+          @model_class ||= DbMailerRails.template_model_class
+        end
+
+        def model_superclass
+          rails5? ? 'ApplicationRecord' : 'ActiveRecord::Base'
+        end
+      end
+    end
+  end
+end

data/lib/generators/db_mailer_rails/install_generator.rb

@@ -0,0 +1,53 @@
+require 'rails/generators/base'
+require 'rails/generators/active_record'
+require 'active_support/core_ext/string'
+
+require 'generators/db_mailer_rails/helpers/model_helper'
+require 'generators/db_mailer_rails/helpers/migration_helper'
+
+module DbMailerRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Helpers::ModelHelper
+      include Helpers::MigrationHelper
+      include ActiveRecord::Generators::Migration
+
+      desc 'Creates a DbMailerRails initializer, migration, model, sync file, test db_mailer for your application.'
+
+      INITIALIZER_FILE = 'db_mailer_rails.rb'.freeze
+      TEST_DB_MAILER_FILE = 'hello_world_db_mailer.rb'.freeze
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_sync_file
+        copy_file '../../../../config/db_mailer_templates.yml', sync_file_path
+      end
+
+      def copy_template_model_file
+        template 'template_model.rb', model_path
+      end
+
+      def copy_initializer_file
+        template 'initializer.rb', "config/initializers/#{INITIALIZER_FILE}"
+      end
+
+      def copy_test_db_mailer_file
+        copy_file TEST_DB_MAILER_FILE, "app/db_mailers/#{TEST_DB_MAILER_FILE}"
+      end
+
+      def copy_migration_file
+        migration_template 'migration.rb', migration_destination_path, migration_version: migration_version
+      end
+
+      private
+
+      def rails5?
+        Rails.version.start_with? '5'
+      end
+
+      def sync_file_path
+        DbMailerRails.sync_file_path
+      end
+    end
+  end
+end

data/lib/generators/db_mailer_rails/templates/hello_world_db_mailer.rb

@@ -0,0 +1,19 @@
+class HelloWorldDbMailer < DbMailerRails::Base
+  delegate :name, to: :object, prefix: :app
+
+  def fields
+    super.merge(
+      user_name: 'User test name',
+      user_email: 'User test e-mail address',
+      app_name: 'Application name'
+    )
+  end
+
+  def user_name
+    'User'
+  end
+
+  def user_email
+    'db_mailer_rails@example.com'
+  end
+end

data/lib/generators/db_mailer_rails/templates/initializer.rb

@@ -0,0 +1,7 @@
+DbMailerRails.setup do |config|
+  # The name of the class where the DbMailerRails gem will store the email templates
+  # config.template_model_class = 'DbMailerTemplate'
+
+  # The path to the file that contains the mail templates in YAML format
+  # config.sync_file_path = 'config/db_mailer_templates.yml'
+end

data/lib/generators/db_mailer_rails/templates/migration.rb

@@ -0,0 +1,15 @@
+class Create<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= table_name %> do |t|
+      t.string :db_mailer_class, limit: 64, null: false
+      t.string :subject, limit: 80, null: false
+      t.string :from, limit: 64, null: false
+      t.string :to, limit: 64, null: false
+      t.text :body, null: false
+
+      t.timestamps null: false
+    end
+
+    add_index :<%= table_name %>, :db_mailer_class, unique: true
+  end
+end

data/lib/generators/db_mailer_rails/templates/template_model.rb

@@ -0,0 +1,7 @@
+require 'db_mailer_rails/models/methods'
+require 'db_mailer_rails/models/validatable'
+
+class <%= model_class %> < <%= model_superclass %>
+  include DbMailerRails::Models::Methods
+  include DbMailerRails::Models::Validatable
+end

data/lib/tasks/db_mailer_rails.rake

@@ -0,0 +1,28 @@
+require 'db_mailer_rails'
+
+namespace :db_mailer_rails do
+  desc 'Syncing DbMailerRails templates sync_file_path(default config/db_mailer_rails.yml) file with database.'
+  task :sync, [:force] => :environment do |_task, args|
+    force = args[:force]
+    mail_template_class = DbMailerRails.template_model_class.constantize
+
+    config_path = Rails.root.join(DbMailerRails.sync_file_path).to_s
+    mail_templates_from_file = YAML.load_file(config_path)
+
+    # Remove from database if not exist in configuration file
+    mail_template_class.where('db_mailer_class NOT IN(?)', mail_templates_from_file.keys).delete_all
+
+    mail_templates_from_file.each do |db_mailer_class, attributes|
+      db_mail_template = mail_template_class.find_or_initialize_by(db_mailer_class: db_mailer_class)
+      next if !force && !db_mail_template.new_record?
+
+      db_mail_template.assign_attributes(attributes)
+
+      if db_mail_template.save
+        puts "#{db_mailer_class} synchronization is successful."
+      else
+        puts "#{db_mailer_class} synchronization is failed."
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: db_mailer_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Degtyarev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: This gem allows you to store mail templates in the database.
+email: alexhifer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/db_mailer_templates.yml
+- db_mailer_rails.gemspec
+- db_mailer_rails.png
+- lib/db_mailer_rails.rb
+- lib/db_mailer_rails/base.rb
+- lib/db_mailer_rails/helper.rb
+- lib/db_mailer_rails/models/methods.rb
+- lib/db_mailer_rails/models/validatable.rb
+- lib/db_mailer_rails/railtie.rb
+- lib/db_mailer_rails/replacer.rb
+- lib/db_mailer_rails/template_finder.rb
+- lib/db_mailer_rails/version.rb
+- lib/generators/db_mailer_rails/helpers/migration_helper.rb
+- lib/generators/db_mailer_rails/helpers/model_helper.rb
+- lib/generators/db_mailer_rails/install_generator.rb
+- lib/generators/db_mailer_rails/templates/hello_world_db_mailer.rb
+- lib/generators/db_mailer_rails/templates/initializer.rb
+- lib/generators/db_mailer_rails/templates/migration.rb
+- lib/generators/db_mailer_rails/templates/template_model.rb
+- lib/tasks/db_mailer_rails.rake
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Store mail templates in the database.
+test_files: []