actionmailer-markdown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 874c3169e4c82c8ca92ede8f58400d04266df87c
+  data.tar.gz: 5b05edf6162e53a0df8219a37a147918a8b86c20
+SHA512:
+  metadata.gz: caa5bf5a3638f51410da282d057a7cc1ee19d94d7c54e083a34c7abe125c75cf3897771047f61e16c3082ce7754fc8fe189b906ab6470191bf6349fea80a16f0
+  data.tar.gz: db8a7e8212ad66eb758bf36f36191c67a39507fb172d5bb93d84a453e9e53e9d05274c90d60511f5d507473d0508b9728e3119980cb1e5e5d7b5f89cce913c82

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+  - 2.2.2
+before_install: gem install bundler
+notifications:
+  email: false

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 actionmailer-markdown.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nando Vieira
+
+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,202 @@
+# ActionMailer::Markdown
+
+![build status](https://travis-ci.org/fnando/actionmailer-markdown.svg)
+
+A different take on using ActionMailer, Markdown and I18n.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'actionmailer-markdown'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install actionmailer-markdown
+
+## Usage
+
+Imagine that you have a mail named `UserMailer#welcome`. Instead of manually defining your subjects like the following, you can create the subject by defining the `user_mailer.welcome.subject` translation.
+
+```ruby
+# app/mailers/user_mailer.rb
+class UserMailer < ApplicationMailer
+  def welcome(email)
+    mail to: email, subject: 'Welcome to Myapp'
+  end
+end
+```
+
+```yaml
+# config/locales/en.yml
+en:
+  user_mailer:
+    welcome:
+      subject: Welcome to my app
+```
+
+Since I really like defining everything I can in I18n files, I always extend this behavior to the message's body, through the `user_mailer.welcome.body` translation.
+
+```yaml
+# config/locales/en.yml
+en:
+  user_mailer:
+    welcome:
+      subject: Welcome to my app
+      body: |
+        This is an e-mail body.
+
+        --
+        Myapp team
+```
+
+Did you notice that `|`? That allows YAML strings to be multiline. And on your e-mail class you can do something like this:
+
+```ruby
+# app/mailers/user_mailer.rb
+class UserMailer < ApplicationMailer
+  def welcome(email)
+    mail to: email, body: I18n.t('user_mailer.welcome.body')
+  end
+end
+```
+
+And if you want to render HTML and text-plain from this string, you may have to do something like this (Markdown class not shown).
+
+```ruby
+# app/mailers/user_mailer.rb
+class UserMailer < ApplicationMailer
+  def welcome(email)
+    message = I18n.t('user_mailer.welcome.body')
+
+    mail to: email do |format|
+      format.text { render plain: message }
+      format.html { render html: Markdown.html(message).html_safe }
+    end
+  end
+end
+```
+
+This idea is really nice, but you have too much things to deal with. Not anymore!
+
+With ActionMailer::Markdown you can just define your mailer action like this:
+
+```ruby
+# app/mailers/user_mailer.rb
+class UserMailer < ApplicationMailer
+  def welcome(email)
+    mail to: email
+  end
+end
+```
+
+That's right! This gem automatically uses `user_mailer.welcome.{subject,body}` from your translation files. And the best part: it evens supports Markdown.
+
+### Passing variables
+
+You're likely to pass in variables to your messages. To do this, just define instance variables. Imagine you want to parse the user's name on your subject and message. Let's suppose you have your translation file defined like this:
+
+```yaml
+en:
+  user_mailer:
+    welcome:
+      subject: 'Welcome to Myapp, %{name}'
+      body: |
+        Hello, %{name}. And welcome to Myapp.
+```
+
+This is what your mailer will look like:
+
+```ruby
+class UserMailer < ApplicationMailer
+  def welcome(user)
+    @name = user.name
+    mail to: user.email
+  end
+end
+```
+
+Same thing for URLs:
+
+```ruby
+class UserMailer < ApplicationMailer
+  def activation_email(user)
+    @name = user.name
+    @activation_url = account_activation_url(user.uuid)
+    mail to: user.email
+  end
+end
+```
+
+And your e-mail body can be something like this:
+
+```yaml
+en:
+  user_mailer:
+    activation_email:
+      subject: Activate your account
+      body: |
+        Hello, %{name}!
+
+        You have to [activate your account](%{activation_url}).
+
+        Thanks,
+
+        --
+        Myapp team
+```
+
+You may be wondering what happens with the mail's text part. Don't worry! ActionMailer::Markdown will take care of that. That message will be rendered as:
+
+```text
+Hello, John!
+
+You have to activate your account[1].
+
+Thanks,
+--
+Myapp team
+
+[1]: http://example.com/activate/4d4b4396-dc26-47c4-b433-2cd9a1b45ce1
+```
+
+Lists and other elements are also exported to a more friendly text version.
+
+**PROTIP:** Use [i18n-dot_lookup](https://github.com/fnando/i18n-dot_lookup) if you want to access properties from an object, like `%{user.name}`
+
+### Replacing the Markdown engine
+
+[redcarpet](https://github.com/vmg/redcarpet) is the default Markdown parser. You may want to specify different options or even switch out to a different Markdown library. All you have to do is defining a processor that responds to `.call`. Let's say you want to use [kramdown](http://kramdown.gettalong.org/) as your Markdown engine.
+
+```ruby
+ActionMailer::Markdown.processor = -> text { Kramdown::Document.new(text).to_html }
+```
+
+### Falling back to ActionMailer's default behavior
+
+You can use templates if you want. Just don't define the `.body` part of your translation. Also, if you pass a block to the `mail()` method, it will skip this functionally completely.
+
+### Using markdown files
+
+If you want to use Markdown files instead of I18n translations, this gem is not for you. Consider using [maildown](https://github.com/schneems/maildown) or [markerb](https://github.com/plataformatec/markerb).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/actionmailer-markdown. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/actionmailer-markdown.gemspec

@@ -0,0 +1,26 @@
+require './lib/action_mailer/markdown/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'actionmailer-markdown'
+  spec.version       = ActionMailer::Markdown::VERSION
+  spec.authors       = ['Nando Vieira']
+  spec.email         = ['fnando.vieira@gmail.com']
+  spec.summary       = 'A different take on using ActionMailer, Markdown and I18n.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/fnando/actionmailer-markdown'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'actionmailer'
+  spec.add_dependency 'redcarpet'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-utils'
+  spec.add_development_dependency 'pry-meta'
+  spec.add_development_dependency 'kramdown'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "actionmailer-markdown"
+
+# 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/action_mailer/markdown.rb

@@ -0,0 +1,11 @@
+module ActionMailer
+  module Markdown
+    require 'action_mailer'
+    require 'redcarpet'
+
+    require 'action_mailer/markdown/version'
+    require 'action_mailer/markdown/ext'
+    require 'action_mailer/markdown/renderer'
+    require 'action_mailer/markdown/renderer/text'
+  end
+end

data/lib/action_mailer/markdown/ext.rb

@@ -0,0 +1,37 @@
+ActionMailer::Base.class_eval do
+  mail_method = instance_method(:mail)
+
+  define_method(:mail) do |headers = {}, &block|
+    options = variables_set_by_user
+    message = get_translation_for('body', options)
+    subject = get_translation_for('subject', options)
+    headers[:subject] ||= subject
+
+    if message
+      block = proc do |format|
+        format.text { render plain: ActionMailer::Markdown.text(message) }
+        format.html { render html: ActionMailer::Markdown.html(message).html_safe }
+      end
+    end
+
+    mail_method.bind(self).call(headers, &block)
+  end
+
+  def mailer_scope
+    self.class.mailer_name.tr('/', '.')
+  end
+
+  def get_translation_for(key, options)
+    I18n.t(key, options.merge(scope: [mailer_scope, action_name], raise: true))
+  rescue I18n::MissingTranslationData
+    nil
+  end
+
+  def variables_set_by_user
+    instance_variables.each_with_object({}) do |name, buffer|
+      next if name.match(/^@_/)
+      name = name.to_s[/^@(.*?)$/, 1]
+      buffer[name.to_sym] = instance_variable_get("@#{name}")
+    end
+  end
+end

data/lib/action_mailer/markdown/renderer.rb

@@ -0,0 +1,36 @@
+module ActionMailer
+  module Markdown
+    class Renderer < Redcarpet::Render::HTML
+      include Redcarpet::Render::SmartyPants
+    end
+
+    class << self
+      # Set markdown renderer
+      attr_accessor :processor, :default_processor
+    end
+
+    renderer = Renderer.new(hard_wrap: true, safe_links_only: true)
+
+    markdown_engine = Redcarpet::Markdown.new(renderer, {
+      tables: true,
+      footnotes: true,
+      space_after_headers: true,
+      superscript: true,
+      highlight: true,
+      strikethrough: true,
+      autolink: true,
+      no_intra_emphasis: true
+    })
+
+    self.default_processor = -> text { markdown_engine.render(text) }
+    self.processor = default_processor
+
+    def self.html(text)
+      processor.call(text)
+    end
+
+    def self.text(source)
+      Renderer::Text.extract(source)
+    end
+  end
+end

data/lib/action_mailer/markdown/renderer/text.rb

@@ -0,0 +1,82 @@
+module ActionMailer
+  module Markdown
+    class Renderer
+      class Text
+        attr_reader :source, :root
+
+        def self.extract(source)
+          new(source).extract
+        end
+
+        def initialize(source)
+          @source = source
+          @root = Nokogiri::HTML(Markdown.html(source)).css('body')
+        end
+
+        def extract
+          process_hr
+          process_links
+          process_h1
+          process_h2
+          process_lists
+          process_code
+
+          root.text
+        end
+
+        def process_code
+          root.css('code').each do |code|
+            next if code.parent.name == 'pre'
+            code.content = "`#{code.content}`"
+          end
+        end
+
+        def process_hr
+          root.css('hr').each(&:remove)
+        end
+
+        def process_h1
+          root.css('h1').each do |heading|
+            heading.content = "#{heading.text}\n#{'=' * heading.text.size}"
+          end
+        end
+
+        def process_h2
+          root.css('h2').each do |heading|
+            heading.content = "\n#{heading.text}\n#{'-' * heading.text.size}"
+          end
+        end
+
+        def process_lists
+          root.css('ol, ul').each do |list|
+            list.css('li').to_enum(:each).with_index(1) do |item, index|
+              prefix = (list.name == 'ol' ? "#{index}." : "-")
+              item.content = "#{prefix} #{item.text}"
+            end
+          end
+        end
+
+        def process_links
+          links = []
+
+          root.css('a').each do |link|
+            href = link['href']
+
+            if href.starts_with?('mailto:')
+              link.content = href.sub('mailto:', '')
+            elsif link.content.match(%r[^(?!\w+://)])
+              links << href unless links.include?(href)
+              index = links.index(href) + 1
+              link.content = "#{link.content}[#{index}]"
+            end
+          end
+
+          links_list = links.map.with_index(1) {|link, index| "[#{index}]: #{link}" }.join("\n")
+          node = Nokogiri::HTML.fragment "<pre>#{links_list}</pre>"
+
+          root << node
+        end
+      end
+    end
+  end
+end

data/lib/action_mailer/markdown/version.rb

@@ -0,0 +1,5 @@
+module ActionMailer
+  module Markdown
+    VERSION = '0.1.0'
+  end
+end

data/lib/actionmailer-markdown.rb

@@ -0,0 +1 @@
+require 'action_mailer/markdown'

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: actionmailer-markdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-11 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: redcarpet
+  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: 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: minitest
+  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: minitest-utils
+  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-meta
+  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: kramdown
+  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: A different take on using ActionMailer, Markdown and I18n.
+email:
+- fnando.vieira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- actionmailer-markdown.gemspec
+- bin/console
+- bin/setup
+- lib/action_mailer/markdown.rb
+- lib/action_mailer/markdown/ext.rb
+- lib/action_mailer/markdown/renderer.rb
+- lib/action_mailer/markdown/renderer/text.rb
+- lib/action_mailer/markdown/version.rb
+- lib/actionmailer-markdown.rb
+homepage: https://github.com/fnando/actionmailer-markdown
+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.6
+signing_key: 
+specification_version: 4
+summary: A different take on using ActionMailer, Markdown and I18n.
+test_files: []