plain-david 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64f568f2fbb872d1fff35baa76c1aca6cc500783
+  data.tar.gz: d4743a120e6ee5939099884b7a6f3efce990b5a1
+SHA512:
+  metadata.gz: 50cc8f751a1a7c4f96551d3ef3b21cfeb8ae5ffb8b6c9f0ff7e4302850672d8d85658cdf4645b3db4ed1414495016258c907a20994e2acd18a1745ba776c2ca2
+  data.tar.gz: 4ec7e5b0e52696f60daa561f4a99de99bb2e12b7b0a5cb9b07ec6fbb008d891ada7e6cf7bf0c51546d28258ec73d7ec3eef63f68ba5b07a7ed69c3ca3b27bf63

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright © 2013 Luca Spiller
+
+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,51 @@
+# Plain David
+
+Plain David automatically generatess a text part for your HTML emails.
+
+## Install
+
+Add the gem to Rails' Gemfile
+
+    gem 'plain-david', github: 'lucaspiller/plain-david'
+
+## Usage
+
+Nothing. Just send emails as normal, and a text part will be automatically generated. The email will be changed from HTML to multipart like magic!
+
+It works seamlessly with css inliners like [Roadie](https://github.com/kandadaboggu/roadie).
+
+## Conversion Strategies
+
+You can set your own conversion strategy. The default `MarkdownStrategy` converts the HTML to Markdown. If you want to use your own you just need to set the `strategy` option.
+
+For example, in your `application.rb`:
+
+```ruby
+class AwesomeStrategy
+  attr_accessor :html
+
+  def initialize(html)
+    @html = html
+  end
+
+  def convert!
+    @html.awesomize!
+  end
+end
+
+config.plain_david.strategy = AwesomeStrategy
+```
+
+## Contributing
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Send me a pull request. Bonus points for topic branches.
+
+## License
+
+MIT License. See `LICENSE` for details.
+
+## Copyright
+
+Copyright (c) 2013 Luca Spiller.

data/lib/plain-david.rb

@@ -0,0 +1 @@
+require 'plain_david'

data/lib/plain_david/action_mailer_extensions.rb

@@ -0,0 +1,52 @@
+module PlainDavid
+  module ActionMailerExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      if method_defined?(:collect_responses)
+        alias_method_chain :collect_responses, :text_part
+      else
+        alias_method_chain :collect_responses_and_parts_order, :text_part
+      end
+    end
+
+    protected
+
+    # Rails 4
+    def collect_responses_with_text_part(headers, &block)
+      responses = collect_responses_without_text_part(headers, &block)
+
+      html_part, text_part = detect_parts(responses)
+      if html_part && !text_part
+        text_body = generate_text_body(html_part[:body])
+        responses.insert 0, { content_type: "text/plain", body: text_body }
+      end
+
+      responses
+    end
+
+    # Rails 3
+    def collect_responses_and_parts_order_with_text_part(headers, &block)
+      responses, order = collect_responses_and_parts_order_without_text_part(headers, &block)
+
+      html_part, text_part = detect_parts(responses)
+      if html_part && !text_part
+        text_body = generate_text_body(html_part[:body])
+        responses.insert 0, { content_type: "text/plain", body: text_body }
+        order && order.insert(0, "text/plain")
+      end
+
+      [responses, order]
+    end
+
+    def detect_parts(responses)
+      html_part = responses.detect { |response| response[:content_type] == "text/html" }
+      text_part = responses.detect { |response| response[:content_type] == "text/plain" }
+      return html_part, text_part
+    end
+
+    def generate_text_body(html)
+      PlainDavid.current_strategy.new(html.to_str).convert!
+    end
+  end
+end

data/lib/plain_david/railtie.rb

@@ -0,0 +1,16 @@
+require 'action_mailer'
+require 'plain_david'
+require 'plain_david/action_mailer_extensions'
+
+module PlainDavid
+  class Railtie < Rails::Railtie
+    config.plain_david = ActiveSupport::OrderedOptions.new
+    config.plain_david.strategy = PlainDavid::Strategies::MarkdownStrategy
+
+    initializer "plain_david.extend_action_mailer" do
+      ActiveSupport.on_load(:action_mailer) do
+        include PlainDavid::ActionMailerExtensions
+      end
+    end
+  end
+end

data/lib/plain_david/strategies/markdown_strategy.rb

@@ -0,0 +1,17 @@
+require 'html2markdown'
+
+module PlainDavid
+  module Strategies
+    class MarkdownStrategy
+      attr_accessor :html
+
+      def initialize(html)
+        @html = html
+      end
+
+      def convert!
+        HTMLPage.new(:contents => html).markdown!
+      end
+    end
+  end
+end

data/lib/plain_david/strategies/plain_strategy.rb

@@ -0,0 +1,127 @@
+# coding: utf-8
+require 'htmlentities'
+
+# Taken from premailer
+
+# Support functions for Premailer
+module PlainDavid
+  module Strategies
+    class PlainStrategy
+      attr_accessor :html
+
+      def initialize(html)
+        @html = html
+      end
+
+      def convert!
+        convert_to_text(html)
+      end
+
+      private
+      # Returns the text in UTF-8 format with all HTML tags removed
+      #
+      # TODO: add support for DL, OL
+      def convert_to_text(html, line_length = 65, from_charset = 'UTF-8')
+        txt = html
+
+        # decode HTML entities
+        he = HTMLEntities.new
+        txt = he.decode(txt)
+
+        # remove the head tag
+        txt.gsub!(/<head>.+?<\/head>/mi, "")
+        # remove style tags
+        txt.gsub!(/<style\b[^<]*(?:(?!<\/style>)<[^<]*)*<\/style>/mi, "")
+        # remove script tags
+        txt.gsub!(/<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/mi, "")
+
+        # replace image by their alt attribute
+        txt.gsub!(/<img.+?alt=\"([^\"]*)\"[^>]*\/>/i, '\1')
+
+        # replace image by their alt attribute
+        txt.gsub!(/<img.+?alt=\"([^\"]*)\"[^>]*\/>/i, '\1')
+        txt.gsub!(/<img.+?alt='([^\']*)\'[^>]*\/>/i, '\1')
+
+        # links
+        txt.gsub!(/<a.+?href=\"([^\"]*)\"[^>]*>(.+?)<\/a>/i) do |s|
+          $2.strip + ' ( ' + $1.strip + ' )'
+        end
+
+        txt.gsub!(/<a.+?href='([^\']*)\'[^>]*>(.+?)<\/a>/i) do |s|
+          $2.strip + ' ( ' + $1.strip + ' )'
+        end
+
+        # handle headings (H1-H6)
+        txt.gsub!(/(<\/h[1-6]>)/i, "\n\\1") # move closing tags to new lines
+        txt.gsub!(/[\s]*<h([1-6]+)[^>]*>[\s]*(.*)[\s]*<\/h[1-6]+>/i) do |s|
+          hlevel = $1.to_i
+
+          htext = $2
+          htext.gsub!(/<br[\s]*\/?>/i, "\n") # handle <br>s
+          htext.gsub!(/<\/?[^>]*>/i, '') # strip tags
+
+          # determine maximum line length
+          hlength = 0
+          htext.each_line { |l| llength = l.strip.length; hlength = llength if llength > hlength }
+          hlength = line_length if hlength > line_length
+
+          case hlevel
+          when 1   # H1, asterisks above and below
+            htext = ('*' * hlength) + "\n" + htext + "\n" + ('*' * hlength)
+          when 2   # H1, dashes above and below
+            htext = ('-' * hlength) + "\n" + htext + "\n" + ('-' * hlength)
+          else     # H3-H6, dashes below
+            htext = htext + "\n" + ('-' * hlength)
+          end
+
+          "\n\n" + htext + "\n\n"
+        end
+
+        # wrap spans
+        txt.gsub!(/(<\/span>)[\s]+(<span)/mi, '\1 \2')
+
+        # lists -- TODO: should handle ordered lists
+        txt.gsub!(/[\s]*(<li[^>]*>)[\s]*/i, '* ')
+        # list not followed by a newline
+        txt.gsub!(/<\/li>[\s]*(?![\n])/i, "\n")
+
+        # paragraphs and line breaks
+        txt.gsub!(/<\/p>/i, "\n\n")
+        txt.gsub!(/<br[\/ ]*>/i, "\n")
+
+        # strip remaining tags
+        txt.gsub!(/<\/?[^>]*>/, '')
+
+        txt = word_wrap(txt, line_length)
+
+        # remove linefeeds (\r\n and \r -> \n)
+        txt.gsub!(/\r\n?/, "\n")
+
+        # strip extra spaces
+        txt.gsub!(/\302\240+/, " ") # non-breaking spaces -> spaces
+        txt.gsub!(/\n[ \t]+/, "\n") # space at start of lines
+        txt.gsub!(/[ \t]+\n/, "\n") # space at end of lines
+
+        # no more than two consecutive newlines
+        txt.gsub!(/[\n]{3,}/, "\n\n")
+
+        # no more than two consecutive spaces
+        txt.gsub!(/ {2,}/, " ")
+
+        # the word messes up the parens
+        txt.gsub!(/\([ \n](http[^)]+)[\n ]\)/) do |s|
+          "( " + $1 + " )"
+        end
+
+        txt.strip
+      end
+
+      # Taken from Rails' word_wrap helper (http://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-word_wrap)
+      def word_wrap(txt, line_length)
+        txt.split("\n").collect do |line|
+          line.length > line_length ? line.gsub(/(.{1,#{line_length}})(\s+|$)/, "\\1\n").strip : line
+        end * "\n"
+      end
+    end
+  end
+end

data/lib/plain_david/version.rb

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

data/lib/plain_david.rb

@@ -0,0 +1,19 @@
+require 'plain_david/version'
+require 'plain_david/strategies/markdown_strategy'
+require 'plain_david/strategies/plain_strategy'
+require 'plain_david/railtie' if defined?(Rails)
+
+module PlainDavid
+  class << self
+    def current_strategy
+      return config.strategy if config.strategy
+      Strategies::MarkdownStrategy
+    end
+
+    private
+
+    def config
+      Rails.application.config.plain_david
+    end
+  end
+end

data/plain-david.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'plain_david/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "plain-david"
+  gem.version       = PlainDavid::VERSION
+  gem.authors       = ["Luca Spiller"]
+  gem.email         = ["luca@stackednotion.com"]
+  gem.description   = %q{Auto email plain text part generator}
+  gem.summary       = %q{Auto email plain text part generator}
+  gem.homepage      = ""
+
+  gem.add_dependency 'html2markdown'
+  gem.add_dependency 'htmlentities'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: plain-david
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Luca Spiller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html2markdown
+  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: htmlentities
+  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'
+description: Auto email plain text part generator
+email:
+- luca@stackednotion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/plain-david.rb
+- lib/plain_david.rb
+- lib/plain_david/action_mailer_extensions.rb
+- lib/plain_david/railtie.rb
+- lib/plain_david/strategies/markdown_strategy.rb
+- lib/plain_david/strategies/plain_strategy.rb
+- lib/plain_david/version.rb
+- plain-david.gemspec
+homepage: ''
+licenses: []
+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.0.7
+signing_key: 
+specification_version: 4
+summary: Auto email plain text part generator
+test_files: []