locale_mailer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84976aa5d9e1e0a87851e1fa39fc4468e39ec92d
+  data.tar.gz: 77e1d7298c24e1dd3af103e5c328d07500a10ee5
+SHA512:
+  metadata.gz: d4f529b8cf0d3b852d2111797237cff27e83f1901cb2f081c3ad8291ce994420ef8eeddebdac39112c49325a33243cb057d5c1988a9bf43e20a0a292a511ee97
+  data.tar.gz: 0e11a064d9cfd5f766a45f2be01f971eb124cf91cd0ef82a093e163c12eacf82928888b8d30061db1c0ff6b93f596016c8a4c2fe526ef0ad2a618fc201fac244

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+spec/internal/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in locale_mailer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 itkin
+
+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,80 @@
+# LocaleMailer
+
+Handling action mailer view templates can become a bit heavy when your app has to send a lot of different emails
+    
+This gem aims at generating email view templates straight from your localization files when no template view is found
+     
+This is especially relevant for email views with simple content
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'locale_mailer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install locale_mailer
+
+## Usage
+
+Include `LocaleMailer::Concern` is automatically mixed into ActionMailer::Base during initialization phase. 
+
+Considering the following localization file
+
+```yaml
+en:
+  my_mailer:
+    notify:
+      subject: "hello %{user_name}"
+      body:
+        - line 1
+        - line 2
+        - '<a href="%{user_link}">Click here</a>'
+```
+
+```ruby
+class MyMailer < ApplicationMailer
+  def notify user
+    @user_name = "toto"
+    @user_link = "http://localhost.local" 
+    mail to: user.email
+  end
+end
+
+MyMailer.notify.subject
+> "hello toto"
+
+MyMailer.notify.html_part.decoded
+> "<p>line 1</p><p>line 2</p><p><a href=\"http://localhost.local\">Click here</a></p>" 
+
+MyMailer.notify.text_part.decoded
+> "\nline 1\n\nline 2\n\nClick here http://localhost.local\n" 
+
+```
+
+1 - If no template view is found by ActionMailer::Base, LocaleMailer will check if there is some locales specified at 
+`mailer_name`.`action_name` per default (or whatever template_path / template_name you passed to the `mail` method)
+
+2 - Your instance variables (usually available to views) will be passed to `I18n.translate`.
+ 
+3 - If your locale returns an array it will be converted in `<p>` tags into the html_part
+
+4 - Link tags present into the locale data will be converted to `text_content href_content`, other tags will be stripped  
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/itkin/locale_mailer. This project is intended to be a safe, welcoming space for collaboration bla bla bla ... 
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "locale_mailer"
+
+# 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

data/bin/setup

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

data/lib/locale_mailer/actionview_helpers.rb

@@ -0,0 +1,41 @@
+module LocaleMailer
+  module ActionViewHelpers
+
+    #
+    # Retrieve and wrap a locale into a tag (p per default)
+    # If the locale sends back an array, build a collection of tags
+    #
+    def text locale, opts = {}
+      tag = opts.key?(:tag) ? opts.delete(:tag) :  :p
+      array_to_tags t(locale, opts), tag
+    end
+
+    #
+    # Allow t to parse array retrieved from locale
+    #
+    def t *args
+      str  = super
+      opts = args.extract_options!.except(:throw, :raise)
+      if str.is_a?(Array) and not opts.empty?
+        str.map { |item| I18n.interpolate(item, opts) unless item.nil? }.map(&:to_s)
+      else
+        str
+      end
+    end
+
+    #
+    # Build a collection of tags from an array
+    # todo : Check potential security issue here, use with caution
+    #
+    def array_to_tags array, tag_name = nil
+      Array.wrap(array).flatten.map do |line|
+        if tag_name
+          content_tag tag_name, line.to_s.html_safe
+        else
+          line.to_s.html_safe
+        end
+      end.join.html_safe
+    end
+
+  end
+end

data/lib/locale_mailer/concern.rb

@@ -0,0 +1,77 @@
+require 'active_support/concern'
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/hash/keys'
+require 'loofah'
+
+module LocaleMailer
+
+  A2HREF = Loofah::Scrubber.new do |node|
+    if node.name == "a"
+      node.name = "text"
+      node.content = [node.content, node.attributes["href"].value].join(' ')
+      Loofah::Scrubber::STOP
+    end
+  end
+
+  module Concern
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method_chain :mail, :localized_templates
+      private :mail, :mail_with_localized_templates, :mail_without_localized_templates
+    end
+
+    private
+
+      def mail_with_localized_templates(options = {}, &block)
+        begin
+          mail_without_localized_templates(options, &block)
+        rescue ActionView::MissingTemplate => e
+          options.symbolize_keys!
+
+          i18n_path = [
+            Rails.configuration.locale_mailer_path_prefix,
+            options[:template_path] || mailer_name,
+            options[:template_name] || action_name
+          ].compact.join('.')
+
+          if I18n.exists? i18n_path, I18n.locale
+            locale_options = instance_public_variables_to_hash
+            options[:subject] = subject_from_locale(i18n_path, locale_options) unless options.key?(:subject)
+            mail_without_localized_templates options do |format|
+              html_body = body_from_locale i18n_path, locale_options, options
+              format.html {
+                html_body
+              }
+              format.text {
+                Loofah.scrub_fragment(html_body, LocaleMailer::A2HREF).to_text
+              }
+            end
+          else
+            raise e
+          end
+        end
+      end
+
+
+
+      def instance_public_variables_to_hash
+        instance_variables.inject({}) do |memo, name|
+          memo[name.to_s.gsub(/\A@/,'').to_sym] = instance_variable_get(name) if name.to_s.match(/\A@(?!_).*/)
+          memo
+        end
+      end
+
+      def subject_from_locale i18n_path, locale_options
+        view_context.t([i18n_path, :subject].join('.'), locale_options)
+      end
+
+      def body_from_locale i18n_path, locale_options, options
+        render inline:  view_context.text([i18n_path, :body].join('.'), locale_options),
+           layout: options[:layout] || _layout
+      end
+
+  end
+end
+

data/lib/locale_mailer/railtie.rb

@@ -0,0 +1,15 @@
+module LocaleMailer
+  class Railtie < Rails::Railtie
+
+    config.locale_mailer_path_prefix = nil
+
+    initializer 'locale_mailer.actionview' do
+      ActionView::Base.send :include, LocaleMailer::ActionViewHelpers
+    end
+
+    initializer 'locale_mailer.actionmailer' do
+      ActionMailer::Base.send :include, LocaleMailer::Concern
+    end
+
+  end
+end

data/lib/locale_mailer/version.rb

@@ -0,0 +1,3 @@
+module LocaleMailer
+  VERSION = "0.1.0"
+end

data/lib/locale_mailer.rb

@@ -0,0 +1,9 @@
+require "locale_mailer/version"
+require "locale_mailer/actionview_helpers"
+require "locale_mailer/concern"
+require "locale_mailer/railtie" if defined?(Rails)
+
+module LocaleMailer
+
+end
+

data/locale_mailer.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'locale_mailer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "locale_mailer"
+  spec.version       = LocaleMailer::VERSION
+  spec.authors       = ["itkin"]
+  spec.email         = ["nicolas.papon@gmail.com"]
+
+  spec.summary       = %q{Ruby on Rails gem to allow email template views generation straight from localization data}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/itkin/locale_mailer"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "actionmailer"
+  spec.add_dependency "activesupport"
+  spec.add_dependency 'loofah'
+  spec.add_development_dependency 'combustion'
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: locale_mailer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- itkin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: loofah
+  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'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- nicolas.papon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/locale_mailer.rb
+- lib/locale_mailer/actionview_helpers.rb
+- lib/locale_mailer/concern.rb
+- lib/locale_mailer/railtie.rb
+- lib/locale_mailer/version.rb
+- locale_mailer.gemspec
+homepage: https://github.com/itkin/locale_mailer
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby on Rails gem to allow email template views generation straight from
+  localization data
+test_files: []