eml_to_pdf 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8066ee85637834e40eabff881ca5dc0c507dfeec
-  data.tar.gz: 482c532373eebd9c8ac1dd53c8855d05c0f03e4d
+  metadata.gz: 3937b46f020a4ba5bbac39fdfd2c80beaf47f92b
+  data.tar.gz: 58105137f1f5b3de7afd8e7560c141d67f230f36
 SHA512:
-  metadata.gz: a966380147ebf6245004730e86b042738346d5b426ba839fe96613bb575a090887e108b6fee5149a7991a1edd167a798f88e8d050678096e85c14646d3ad2776
-  data.tar.gz: 4955d0bc20a0ad90c44fa2b00a70814cb66dd316f7e765fef4e2d4efd57337c83d72a8a92ea6420cced9a6e90a2e972a46d987004f3871f01566cf87b877a139
+  metadata.gz: 933861a07fe0aa3e26dd57f70e3f1f1a1e36b9f58260fd6890b62d90ac2a5873d6211131195f3aa12da86bbc035a8f60809efd42cc2643a1c0dbeedb2503e2e9
+  data.tar.gz: de3fdd4b821015d8d13dc2da849501ae0d5209d2fcfb959a15cc20a92167f88afb8eab715f399f0c04fcef4c3da731d7e861f5ddbaf3c242976f7052a57f8406

data/.codeclimate.yml

@@ -0,0 +1,5 @@
+languages:
+  Ruby: true
+exclude_paths:
+- "lib/eml_to_pdf/extraction_step.rb"
+- "test/"

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.4.1

data/.travis.yml

@@ -1,8 +1,9 @@
 language: ruby
 rvm:
   - 2.2.2
+  - 2.4.1
 before_install:
-  - gem install bundler -v 1.10.6
+  - gem install bundler -v 1.14.6
   - wget http://download.gna.org/wkhtmltopdf/0.12/0.12.3/wkhtmltox-0.12.3_linux-generic-amd64.tar.xz
   - tar -xvf wkhtmltox-0.12.3_linux-generic-amd64.tar.xz
   - export PATH=$PATH:$PWD/wkhtmltox/bin/

data/README.md

@@ -4,7 +4,8 @@ Welcome to EmlToPdf.
 A small converter to convert an eml file to a pdf.
 This gem uses `wkhtmltopdf`. You can get the installer from [here](http://wkhtmltopdf.org/downloads.html)
 
-[![Build Status](https://travis-ci.org/Elektron1c97/eml_to_pdf.svg?branch=master)](https://travis-ci.org/Elektron1c97/eml_to_pdf)
+[![Build Status](https://travis-ci.org/siegy22/eml_to_pdf.svg?branch=master)](https://travis-ci.org/siegy22/eml_to_pdf)
+[![Code Climate](https://codeclimate.com/github/siegy22/eml_to_pdf/badges/gpa.svg)](https://codeclimate.com/github/siegy22/eml_to_pdf)
 
 ## Installation
 
@@ -58,7 +59,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/eml_to_pdf. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/siegy22/eml_to_pdf. 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

data/eml_to_pdf.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.2.0"
 
   spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 11.0"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency 'minitest', '~> 5.9'
 
   spec.add_runtime_dependency 'filesize', '~> 0.1.1'
   spec.add_runtime_dependency 'mail', '~> 2.5', '>= 2.5.4'
-  spec.add_runtime_dependency 'nokogiri', '~> 1.6', '>= 1.6.7.2'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.7'
 end

data/exe/eml_to_pdf

@@ -1,13 +1,4 @@
 #!/usr/bin/env ruby
-# TODO: use this to convert whole folders
-# Dir["test/fixtures/emails/*.eml"].each do |test_file|
-#   puts "> converting #{test_file}"
-#   begin
-#     EmlToPdf.convert(test_file, "#{test_file[0..-5]}_output.pdf")
-#   rescue NoMethodError => e
-#     puts e.message
-#   end
-# end
 
 if ARGV[0] && ARGV[1]
   require "bundler/setup"

data/lib/eml_to_pdf.rb

@@ -5,6 +5,8 @@ require "eml_to_pdf/converter"
 require "eml_to_pdf/email"
 require "eml_to_pdf/wkhtmltopdf"
 require "eml_to_pdf/metadata_context"
+require "eml_to_pdf/extraction_step"
+require "eml_to_pdf/extraction_step_list"
 
 module EmlToPdf
   def self.convert(input, output)

data/lib/eml_to_pdf/email.rb

@@ -5,12 +5,6 @@ require "erb"
 
 module EmlToPdf
   class Email
-    MIME_TYPES = {
-      plain_text: "text/plain",
-      html: "text/html",
-      multipart_alternative: "multipart/alternative"
-    }
-
     TEMPLATES_PATH = Pathname.new(File.expand_path(__dir__)) + "templates"
 
     def initialize(input_path)
@@ -19,26 +13,15 @@ module EmlToPdf
     end
 
     def to_html
-      html = text_parts(@mail).join
+      extraction = ExtractionStep.new(@mail)
+      extraction = extraction.next until extraction.finished?
+      html = extraction.to_html
       html = resolve_cids_from_attachments(html, @mail.all_parts)
       html = add_mail_metadata_to_html(@mail, html)
       html
     end
 
     private
-    def text_parts(mail_or_part)
-      if mail_or_part.multipart? && multipart_alternative?(mail_or_part)
-        best_part = extract_best_part(mail_or_part.parts)
-        text_parts(best_part)
-      elsif mail_or_part.multipart?
-        mail_or_part.parts.map do |part|
-          text_parts(part)
-        end
-      else
-        [text_body(mail_or_part)]
-      end.flatten
-    end
-
     def visible_attachments(mail)
       mail.attachments.select do |attachment|
         !attachment.inline?
@@ -64,42 +47,6 @@ module EmlToPdf
       end
     end
 
-    def extract_best_part(parts)
-      if multipart_part = parts.detect(&:multipart?)
-        multipart_part
-      elsif html_part = find_body_with_type(parts, :html)
-        html_part
-      elsif text_part = find_body_with_type(parts, :plain_text)
-        text_part
-      else
-        "can't find useable part"
-      end
-    end
-
-    def find_body_with_type(parts, type)
-      parts.detect do |part|
-        part.mime_type == MIME_TYPES[type]
-      end
-    end
-
-    def multipart_alternative?(part)
-      part.mime_type == MIME_TYPES[:multipart_alternative]
-    end
-
-    def text_body(mail_or_part)
-      if mail_or_part.mime_type == MIME_TYPES[:html] && !mail_or_part.attachment?
-        mail_or_part.decoded
-      elsif mail_or_part.mime_type == MIME_TYPES[:plain_text] && !mail_or_part.attachment?
-        wrap_text_in_pre_tag(mail_or_part.decoded)
-      else
-        ""
-      end
-    end
-
-    def wrap_text_in_pre_tag(text)
-      "<pre>#{text}</pre>"
-    end
-
     def add_mail_metadata_to_html(mail, html)
       context = MetadataContext.new(from: save_extract_header(mail, :from),
                                     to: save_extract_header(mail, :to),
@@ -123,11 +70,7 @@ module EmlToPdf
     end
 
     def save_extract_header(mail, header)
-      if header = mail.header[header]
-        header.decoded
-      else
-        ""
-      end
+      (mail.header[header] && mail.header[header].decoded) || ""
     end
   end
 end

data/lib/eml_to_pdf/extraction_step.rb

@@ -1,54 +1,60 @@
 module EmlToPdf
-
-  # TODO: in email#to_html remove recursive function with this class
-  # for a better control and to be able to make more unit tests.
   class ExtractionStep
+    MIME_TYPES = {
+      plain_text: "text/plain",
+      html: "text/html",
+      multipart_alternative: "multipart/alternative"
+    }
+
     def initialize(mail_or_part)
       @mail_or_part = mail_or_part
     end
 
-    # extraction = ExtractionStep.new(@mail)
-    # extraction = extraction.next until extraction.finished?
-
     def next
       if multipart_alternative?(@mail_or_part)
         best_part = extract_best_part(@mail_or_part.parts)
         ExtractionStep.new(best_part)
       elsif @mail_or_part.multipart?
-
+        ExtractionStepList.new(@mail_or_part.parts.map { |part| ExtractionStep.new(part) })
       else
-
+        self
       end
     end
 
     def finished?
-      @mail_or_part.parts.none?(&:multipart?)
+      !@mail_or_part.multipart?
     end
 
     def to_html
-      if html_part = @mail_or_part.html_part
-        html_part
-      elsif text_part = @mail_or_part.text_part
-        wrap_text_in_pre_tag(text_part)
+      text_body(@mail_or_part)
+    end
+
+    private
+    def multipart_alternative?(part)
+      part.mime_type == MIME_TYPES[:multipart_alternative]
+    end
+
+    def text_body(mail_or_part)
+      if mail_or_part.mime_type == MIME_TYPES[:html] && !mail_or_part.attachment?
+        mail_or_part.decoded
+      elsif mail_or_part.mime_type == MIME_TYPES[:plain_text] && !mail_or_part.attachment?
+        wrap_text_in_pre_tag(mail_or_part.decoded)
       else
         ""
       end
     end
 
     def extract_best_part(parts)
-      if multipart_part = parts.detect(&:multipart?)
-        multipart_part
-      elsif html_part = find_body_with_type(parts, :html)
-        html_part
-      elsif text_part = find_body_with_type(parts, :plain_text)
-        text_part
-      else
-        "can't find useable part"
-      end
+      parts.detect(&:multipart?) ||
+        find_body_with_type(parts, :html) ||
+        find_body_with_type(parts, :plain_text) ||
+        EmptyPart.new
     end
 
-    def multipart_alternative?(part)
-      part.mime_type == MIME_TYPES[:multipart_alternative]
+    def find_body_with_type(parts, type)
+      parts.detect do |part|
+        part.mime_type == MIME_TYPES[type]
+      end
     end
 
     def wrap_text_in_pre_tag(text)

data/lib/eml_to_pdf/extraction_step_list.rb

@@ -0,0 +1,24 @@
+module EmlToPdf
+  class ExtractionStepList
+    def initialize(steps)
+      @steps = steps
+    end
+
+    def next
+      self.class.new(@steps.map(&:next))
+    end
+
+    def finished?
+      @steps.all?(&:finished?)
+    end
+
+    def to_html
+      @steps.flatten.map(&:to_html).join
+    end
+
+    private
+    def multipart_alternative?(part)
+      part.mime_type == MIME_TYPES[:multipart_alternative]
+    end
+  end
+end

data/lib/eml_to_pdf/metadata_context.rb

@@ -1,14 +1,9 @@
 require "filesize"
 require "cgi"
+require "ostruct"
 
 module EmlToPdf
-  class MetadataContext
-    def initialize(metadata)
-      metadata.each do |k, v|
-        eval("@#{k}=v")
-      end
-    end
-
+  class MetadataContext < OpenStruct
     def config
       EmlToPdf.configuration
     end

data/lib/eml_to_pdf/templates/heading.html.erb

@@ -3,25 +3,25 @@
   <table>
     <tr>
       <td><strong><%= config.from_label %></strong></td>
-      <td><%= html_escape(@from) %></td>
+      <td><%= html_escape(from) %></td>
     </tr>
     <tr>
       <td><strong><%= config.to_label %></strong></td>
-      <td><%= html_escape(@to) %></td>
+      <td><%= html_escape(to) %></td>
     </tr>
     <tr>
       <td><strong><%= config.cc_label %></strong></td>
-      <td><%= html_escape(@cc) %></td>
+      <td><%= html_escape(cc) %></td>
     </tr>
     <tr>
       <td><strong><%= config.date_label %></strong></td>
-      <td><%= format_date(@date) if @date %></td>
+      <td><%= format_date(date) if date %></td>
     </tr>
   </table>
-  <h3><%= @subject %></h3>
+  <h3><%= subject %></h3>
   <hr>
   <ul class="email-attachments">
-    <% @attachments.each do |att| %>
+    <% attachments.each do |att| %>
       <li class="attachement">
         <span class="filename"><%= att.filename %></span>
         <span class="file-size"><%= format_attachment_size(att) %></span>

data/lib/eml_to_pdf/version.rb

@@ -1,3 +1,3 @@
 module EmlToPdf
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eml_to_pdf
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Yves Siegrist
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2017-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -92,20 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.7.2
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.7.2
+        version: '1.7'
 description: This gem uses wkhtmltopdf to convert an eml to a pdf. (eml -> html ->
   pdf)
 email:
@@ -115,6 +109,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".ruby-version"
 - ".travis.yml"
@@ -133,6 +128,7 @@ files:
 - lib/eml_to_pdf/email.rb
 - lib/eml_to_pdf/empty_part.rb
 - lib/eml_to_pdf/extraction_step.rb
+- lib/eml_to_pdf/extraction_step_list.rb
 - lib/eml_to_pdf/metadata_context.rb
 - lib/eml_to_pdf/templates/heading.html.erb
 - lib/eml_to_pdf/templates/style.html
@@ -159,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: This gem allows you to convert an eml (email) into a pdf.