RubyGems - ghostwriter - Versions diffs - 0.3.0 → 1.0.1 - Mend

ghostwriter 0.3.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

checksums.yaml CHANGED Viewed

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjAxZjQzNDU2NTEyMDgwODc3NTAyYjQyYTRhNGZjOTEwMzg4MTE0Yw==
-  data.tar.gz: !binary |-
-    NjBjZWU4OWExMmYyOGU1NDMzNTI4MDhkNzEzMGU3YWFhNjdiM2M0MA==
+SHA256:
+  metadata.gz: 2868e207e695355f8e9f40521b38d1f96b72b45c9ab73207396a87e5b4d535cd
+  data.tar.gz: cf111d734daa4bf94e4d9c2924dbd6c7d12b38b2b26a55db79110730f306fccc
 SHA512:
-  metadata.gz: !binary |-
-    ZDcxMDQ5N2IzMTU0YzlhMzZmMDBkODk2NDVhZjEwZTkyOTY0ZDFmMzZiMmYw
-    NDc3ZmY5NjgyNzkxOTUzMDg4YWU2NmNkZDgyMDdkNjc4OTMzMmIzYWY1MWY2
-    OWRhMzgxNjc5ODM4Yjc4NGE5ZTBmODBmNGUzOGU3NDY2YTA5NDk=
-  data.tar.gz: !binary |-
-    NTIzYTdjNmRmZTRkMTc4NGIxZWJiYjBhYWVkMDI4ZDM1NTc4NDQ4ZTdkZDZk
-    YTVlN2Y1OGMzYTg3MjlkYmNhMjUyMGQwNTZlMmIzNjYxYmQyMDIxMjJiOTVi
-    N2YzMzczODBkZWMxZmY2MmJkYzJkYjQxZjJlZjBjZTM2OWJkMjQ=
+  metadata.gz: 8d71989a44d8d2da33496172c600ec38063100c53642850982a9a93ccefbea37e40847e93edfde09d3b0f0dad98f457296f01c070387d86b11cc06e2ee9e04c1
+  data.tar.gz: 0767f0d24a895477aee922bd960380608185b741c0d87975bba65eaa03270539e2af2776bbcef2f689b604b76fde7882dbe9322e522b190858c2699359ce8a3b

data/.rubocop.yml ADDED Viewed

	@@ -0,0 +1 @@
1	+ inherit_from: ../.rubocop.yml

data/.ruby-version CHANGED Viewed

	@@ -1 +1 @@
1	- ruby-1.9.3
1	+ ruby-2.7.1

data/Gemfile CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 # Specify gem dependencies in ghostwriter.gemspec

data/README.md CHANGED Viewed

@@ -1,6 +1,15 @@
 # Ghostwriter
-Ghostwriter rewrites your emails to conform to varying email client requirements.
+A ruby gem that converts HTML to plain text, preserving as much legibility and functionality as possible.
+It's sort of like a reverse-markdown or a very, very simple screen reader.
+## But Why, Though?
+* Some email clients won't or can’t handle HTML at all
+* Some people explicitly choose plaintext just by preference or accessibility
+* Spam filters tend to prefer emails with a plain text alternative (but if you use this gem to spam people, I will yell
+  at you)
 ## Installation
@@ -12,86 +21,329 @@ gem 'ghostwriter'
 And then execute:
-    $ bundle
+    bundle
 Or install it manually with:
-    $ gem install ghostwriter
+    gem install ghostwriter
 ## Usage
-###Stripping HTML
+Create a `Ghostwriter::Writer` and call `#textify` with the html string you want modified:
+```ruby
+html = <<~HTML
+    <html>
+    <body>
+        <p>This is some text with <a href="tenjin.ca">a link</a></p>
+        <p>It handles other stuff, too.</p>
+        <hr>
+        <h1>Stuff Like</h1>
+        <ul>
+          <li>Images</li>
+          <li>Lists</li>
+          <li>Tables</li>
+          <li>And more</li>
+        </ul>
+    </body>
+    </html>
+HTML
+ghostwriter = Ghostwriter::Writer.new
+puts ghostwriter.textify(html)
+```
+Produces:
-Transform HTML into plaintext while preserving as much legibility and functionality as possible.
-It's prime use is in quickly producing an automatic plaintext version of HTML emails.
+```
+This is some text with a link (tenjin.ca)
-Why offer plaintext?
+It handles other stuff, too.
- * Spam filters prefer included plain text alternative
- * Some email clients and apps can’t handle HTML
- * Some people explicitly choose plaintext, either by requirement or simple preference
-Create a `Ghostwriter::Writer` with the html you want modified, and call `#textify`:
+----------
-```ruby
-html = '<html><body>This is some markup <a href="tenjin.ca">and a link</a><p>Other tags translate, too</p></body></html>'
+-- Stuff Like --
+- Images
+- Lists
+- Tables
+- And more
+```
+### Links
+Links are converted to the link text followed by the link target in brackets:
+```html
+Visit our <a href="https://example.com">Website</a>
+```
+Becomes:
+```
+Visit our Website (https://example.com)
+```
+#### Relative Links
+Since emails are wholly distinct from your web address, relative links might break.
+To avoid this problem, either use the `<base>` header tag:
+```html
+<html>
+<head>
+   <base href="https://www.example.com">
+</head>
+<body>
+Use the base tag to <a href="/contact">expand</a> links.
+</body>
+</html>
+```
-Ghostwriter::Writer.new(html).textify
+Becomes:
-=> "This is some markup and a link (tenjin.ca)\nOther tags translate, too\n\n"
+```
+Use the base tag to expand (https://www.example.com/contact) links.
 ```
-`#textify` will use a `<base>` tag if included in the HTML source, or if one is provided explicitly:
+Or you can use the `link_base` configuration:
 ```ruby
-html = '<html><body>Relative links <a href="/contact">Link</a></body></html>'
+Ghostwriter::Writer.new(link_base: 'tenjin.ca').textify(html)
+```
+### Images
+Images with alt text are converted:
+```html
+<img src="logo.jpg" alt="ACME Anvils" />
+```
+Becomes:
+```
+ACME Anvils (logo.jpg)
+```
+But images lacking alt text or with a presentation ARIA role are ignored:
+```html
+<!-- these will just become an empty string -->
+<img src="decoration.jpg">
+<img src="logo.jpg" role="presentation">
+```
+And images with data URIs won't include the data portion.
+```html
+<img src="data:image/gif;base64,R0lGODdhIwAjAMZ/AAkMBxETEBUUDBoaExkaGCIcFx4fGCEfFCcfECkjHiUlHiglGikmFjAqFi8pJCsrJT8sCjMzLDUzJzs0GjkzLTszKTM1Mzg4MD48Mzs+O0tAIElCJ1NCGVdBHUtEMkNFQjlHTFJDOkdGPT1ISUxLRENOT1tMI01PTGdLKk1RU0hTVEtTT0NVVFRTTExYWE9YVGhVP1VZXGFYTWhaMFRcWHFYL1FdXV1dRHdZMVRgYFhgXFdiY11hY1tkX31hJltmZ2pnWnloLGFrbG9oYXlqN3NqTnBqWHxqRItvRIh0Nod0ToF2U5J4LX55Xm97e4B5aZqAQpGAdqOCOZKEYZ2FOJyEVoyKbqiOXpySbLCVcLCXaKWbdKCdfZyhi66dksGdc76fbbije7mkdLOmgq6ogrCpibyvirexisWvhs2vgsGyiLq1lce1lMC5ks28nsfBmcHDq9bAl9PDmMnFo9TGh8zIoM7Jm9vLs9nRo93QqtfSquLQpdXUs+fdterlw////ywAAAAAIwAjAAAH/oArOTo6PYaGOz08P0KMOTZCOzw7PzY/Pz2JPYSDhTSFPTSXPY0tIiIfJz05o5Q/O7A5moc6O4Q0oS8uQisXGCItwTItP5OxOrKjhzSfLzYvgz85ERQXJKcSIkZeJDqOl43StrSEKzo2LhkOGBISDw40JyIVFVEyorBCkZmwtCsrtnLQSJCAwoMFCiwoiECPAr0TjPrtECJwXLMVNARlUCBhQAEFC2SsgWPGDBs3d2RcorSD1SVGr3qskOkihoIH70DO0cOHDx48evD0KQONmQ0aORZJE3VLRYoPBRwoUCCCSx07eoL+xLNnj5UfNFry4BHuR6EcK0qkKJFhAYUE/g+cdHlz1efPrnvM2MjhQlYOWTxktXThIoUKhQoKDHBi5Y0dO0CD5smzJ46NvWJfjYW1w4WKEiWkKkgw9UYdPXTo8Mn6042bvX9pTHoFa5GKzykekP5owEidN1u6PKnzMw+QJ3ttUPr7qKUs0C5KHOyoAMMaNWrmjKlSRYscMFm+nBBUybkLSYsIl3DxwAgcKwWMzGnz5kqTK1e09AEDI0uGE8rJEgNfsuxVggoujGABF1xMoYAVc9RRhxxq5JGVHn3EEYcIGfT1igvGKLfDZyWMkMINa5QhQRNz9CQhT1n5URmHJ8Sygw2BSWLDbaCpgEFPNzxBV4QwApVhHBhg/vABZ0pJIhuCoI0wQhFlkLEGGWfQ9wZ2W6KRBhoUJKncKyK2tMOBPI6wwAxltInlG1uKcQUUV3xpwQUXACSJjbCAxgJoJShggBVtnmGGlm/M4UYcX14QQQQ1PpJjUjmsd5sKCg5gBRdkYMlGG2KwoUYWWYARxgXVnODXqmP9CWgJIESwxhJTbEHGGGbMsSWpaRRBQQQXpPKIiJOgg+BnI4AwwhxcHFHrGGN0KYYYaEhAzQX/7flIDMqx4CoIJY7QxhpY0GorXXXwkUcRj1Lg7gfMDavcCSx4BqsIHpyxRhtT1FCDEmNgF4YY1j6KZ4eXXTast9GVcAIHG2TZRhlT/qCAAg5IZIzCA+1QQ0EGKbgAG7c0pPOAAgQcwEQSZ2R5RhlYVIFEFVccAQEAAASgWEIrXEZYDDHQYAEBAQSAcxBUbCExGWVsMfMVCHSA89QCbHBDX4QRRsPURuMcQBBQYLHGHGuwoYUYVdQQxAIOBCCACVLUgDMBS7rwwgtENHDAAEYLMIAAHhABRRVYKFEDDjjU0AA9HiQhxQQOCDC1BXe/UAQVVATRwAIDDGCAAAd0EAQTTEgBBQ4IIFSBFHFPdYEIFJBAQOUE1K5AAyZgnsQME/jNwAG/e7QBFT4sYEABBiQv6ANDDLDCCwPULr0ADYyeOQcMLMAAAxNAIQUHJwckYEDn5CfvgAEKvECA3+R7nrwB2k+ggQkmaLB3++Sz3zkMIawQCAA7"
+     alt="Data picture" />
+```
+Becomes:
+```
+Data picture (embedded)
+```
+### Paragraphs and Linebreaks
+Paragraphs are padded with a newline at the end. Line break tags add an empty line.
+```html
+<p>I would like to propose a toast.</p>
+<p>This meal we enjoy together would be improved by one.</p>
+<br />
+<p>... Plug in the toaster and I'll get the bread.</p>
+```
+```
+I would like to propose a toast.
+This meal we enjoy together would be improved by one.
+... Plug in the toaster and I'll get the bread.
+```
+### Headers
+For now, headers are all treated the same and given a simple marker:
+```html
+<h1>Dog Maintenance and Repair</h1>
+<h2>Food Input Port</h2>
+<h3>Exhaust Port Considerations</h3>
+```
+Becomes:
+```
+-- Dog Maintenance and Repair --
+-- Food Input Port --
+-- Exhaust Port Considerations --
+```
+### Lists
+Lists are converted, too. They are padded with newlines and are given simple markers:
+```html
+<ul>
+   <li>Planes</li>
+   <li>Trains</li>
+   <li>Automobiles</li>
+</ul>
+<ol>
+   <li>I get knocked down</li>
+   <li>I get up again</li>
+   <li>Never gonna keep me down</li>
+</ol>
+```
+Becomes:
+```
-Ghostwriter::Writer.new(html).textify(link_base: 'tenjin.ca')
+- Planes
+- Trains
+- Automobiles
-=> "Relative links Link (tenjin.ca/contact)"
+1. I get knocked down
+2. I get up again
+3. Never gonna keep me down
 ```
-#### Mail Gem Example
+### Tables
+Tables are still often used in email structuring because support for more modern HTML and CSS is inconsistent. If your
+table is purely presentational, mark it with `role="presentation"`. See below for details.
+For real data tables, Ghostwriter tries to maintain table structure for simple tables:
+```html
+<table>
+   <thead>
+   <tr>
+      <th>Ship</th>
+      <th>Captain</th>
+   </tr>
+   </thead>
+   <tbody>
+   <tr>
+      <td>Enterprise</td>
+      <td>Jean-Luc Picard</td>
+   </tr>
+   <tr>
+      <td>TARDIS</td>
+      <td>The Doctor</td>
+   </tr>
+   <tr>
+      <td>Planet Express Ship</td>
+      <td>Turanga Leela</td>
+   </tr>
+   </tbody>
+</table>
+```
+Becomes:
+```
+| Ship                | Captain         |
+|---------------------|-----------------|
+| Enterprise          | Jean-Luc Picard |
+| TARDIS              | The Doctor      |
+| Planet Express Ship | Turanga Leela   |
+```
+### Presentation ARIA Role
+Lists and tables with `role="presentation"` will be treated as a simple container and the normal behaviour will be
+suppressed.
+```html
+<table role="presentation">
+   <tr>
+      <td>The table is a lie</td>
+   </tr>
+</table>
+<ul role="presentation">
+   <li>No such list</li>
+</ul>
+```
+Becomes:
+```
+The table is a lie
+No such list
+```
+### Mail Gem Example
-To use `#textify` with the [mail](https://github.com/mikel/mail) gem, just provide the text-part by pasisng the html through Ghostwriter:
+To use `#textify` with the [mail](https://github.com/mikel/mail) gem, just provide the text-part by pasisng the html
+through Ghostwriter:
 ```ruby
 require 'mail'
-html = 'My email and a <a href="http://tenjin.ca">link</a>'
+html        = 'My email and a <a href="https://tenjin.ca">link</a>'
+ghostwriter = Ghostwriter::Writer.new
-mail = Mail.deliver do
-  to      'bob@example.com'
-  from    'dot@example.com'
-  subject 'Using Ghostwriter with Mail'
+Mail.deliver do
+   to 'bob@example.com'
+   from 'dot@example.com'
+   subject 'Using Ghostwriter with Mail'
-  html_part do
+   html_part do
       content_type 'text/html; charset=UTF-8'
       body html
-    end
-  text_part do
-    body Ghostwriter::Writer.new(html).textify
-  end
+   end
+   text_part do
+      body ghostwriter.textify(html)
+   end
 end
 ```
 ## Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/TenjinInc/ghostwriter
-This project is intended to be a friendly space for collaboration, and contributors are expected to adhere to the
+This project is intended to be a friendly space for collaboration, and contributors are expected to adhere to the
 [Contributor Covenant](contributor-covenant.org) code of conduct.
 ### Core Developers
-After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` 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).
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests. You
+can also run `bin/console` for an interactive prompt that will allow you to experiment.
+#### Local Install
+To install this gem onto your local machine only, run
+`bundle exec rake install`
+#### Gem Release
+To release a gem to the world at large
+1. Update the version number in `version.rb`,
+2. 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).
+3. Do a wee dance
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/RELEASE_NOTES.md ADDED Viewed

@@ -0,0 +1,91 @@
+# Release Notes
+## 1.0.1 (2021-03-22)
+### Major
+* none
+### Minor
+* Updated README
+### Bugfixes
+* Fixed hr padding behaviour
+## 1.0.0 (2021-03-21)
+### Major
+* Moved `link_base` parameter to constructor
+* Moved input HTML parameter to `#textify`
+### Minor
+* Treats tables and lists with role="presentation" as simple containers
+* Now handles ordered and unordered lists
+* Images are now replaced with their alt text
+### Bugfixes
+* none
+## 0.4.2 (2021-03-17)
+### Major
+* none
+### Minor
+* none
+### Bugfixes
+* Works with links using `tel:` and `mailto:` schemas.
+## 0.4.1 (2021-03-17)
+### Major
+* none
+### Minor
+* No longer provides link target in brackets after link text when they are the same
+### Bugfixes
+* Added explicit testing for HTML entity interpretation
+## 0.4.0 (2021-03-16)
+### Major
+* Updated gem dependencies
+### Minor
+* Updated docs
+* Added support for tables
+### Bugfixes
+* none
+## 0.3.0 (2016-03-06)
+### Major
+* Renamed to Ghostwriter
+### Minor
+* Docs: Added instruction for using textify with mail gem
+### Bugfixes
+* none

data/Rakefile CHANGED Viewed

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec

data/bin/console CHANGED Viewed

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+#
+# frozen_string_literal: true
 require 'bundler/setup'
 require 'ghostwriter'
@@ -10,5 +12,5 @@ require 'ghostwriter'
 # require "pry"
 # Pry.start
-require "irb"
+require 'irb'
 IRB.start

data/dirt-textify.gemspec CHANGED Viewed

@@ -1,27 +1,39 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ghostwriter/version'
-Gem::Specification.new do |gemspec|
-   gemspec.name    = 'ghostwriter'
-   gemspec.version = Ghostwriter::VERSION
-   gemspec.authors = ['Robin Miller']
-   gemspec.email   = ['robin@tenjin.ca']
+Gem::Specification.new do |spec|
+   spec.name    = 'ghostwriter'
+   spec.version = Ghostwriter::VERSION
+   spec.authors = ['Robin Miller']
+   spec.email   = ['robin@tenjin.ca']
+   spec.summary     = 'Converts HTML to plain text'
+   spec.description = <<~DESC
+      Converts HTML to plain text, preserving as much legibility and functionality as possible.
+      Ideal for providing a plaintext multipart segment of email messages.
+   DESC
+   spec.homepage = 'https://github.com/TenjinInc/ghostwriter'
+   spec.license  = 'MIT'
+   spec.files = `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+   end
-   gemspec.summary     = %q{Intelligently extracts plaintext from an HTML document.}
-   gemspec.description = %q{Transforms HTML into plaintext while preserving legibility and functionality. }
-   gemspec.homepage    = 'https://github.com/TenjinInc/ghostwriter'
-   gemspec.license     = 'MIT'
+   spec.bindir        = 'exe'
+   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+   spec.require_paths = ['lib']
-   gemspec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-   gemspec.bindir        = 'exe'
-   gemspec.executables   = gemspec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-   gemspec.require_paths = ['lib']
+   spec.required_ruby_version = '~> 2.4'
-   gemspec.add_dependency 'nokogiri', '~> 1.6'
+   spec.add_dependency 'nokogiri', '= 1.8.4'
-   gemspec.add_development_dependency 'bundler', '~> 1.10'
-   gemspec.add_development_dependency 'rake', '~> 10.0'
-   gemspec.add_development_dependency 'rspec', '~> 3.3'
+   spec.add_development_dependency 'bundler', '~> 2.2'
+   spec.add_development_dependency 'rake', '~> 13.0'
+   spec.add_development_dependency 'rspec', '~> 3.3'
+   spec.add_development_dependency 'rubocop', '~> 1.11'
+   spec.add_development_dependency 'rubocop-performance', '~> 1.10'
 end

data/lib/ghostwriter.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 require 'ghostwriter/version'
 require 'ghostwriter/writer'
 require 'nokogiri'

data/lib/ghostwriter/version.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 module Ghostwriter
-   VERSION = '0.3.0'
+   VERSION = '1.0.1'
 end

data/lib/ghostwriter/writer.rb CHANGED Viewed

@@ -1,54 +1,164 @@
+# frozen_string_literal: true
 module Ghostwriter
+   # Main Ghostwriter converter object.
    class Writer
-      def initialize(html)
-         @source_html = html
+      # Creates a new ghostwriter
+      #
+      # @param [String] link_base the url to prefix relative links with
+      def initialize(link_base: '')
+         @link_base   = link_base
+         @list_marker = '-'
       end
-      # Intelligently strips HTML down to text.
+      # Strips HTML down to plain text.
+      #
+      # @param html [String] the HTML to be convert to text
       #
-      # Options:
-      #   link_base: the url to prefix relative links with
-      def textify(options={})
-         html = @source_html.dup
+      # @return converted text
+      def textify(html)
+         doc = Nokogiri::HTML(html.gsub(/\s+/, ' '))
-         html.gsub!(/\n|\t/, ' ')
-         html.squeeze!(' ')
+         doc.search('style, script').remove
-         html.gsub!('</p>', "</p>\n\n")
+         replace_anchors(doc)
+         replace_images(doc)
-         doc = Nokogiri::HTML(html)
+         simple_replace(doc, '*[role="presentation"]', "\n")
-         doc.search('style').remove
-         doc.search('script').remove
+         replace_headers(doc)
+         replace_lists(doc)
+         replace_tables(doc)
-         base = doc.search('base').first #<base> is unique by W3C spec
+         simple_replace(doc, 'hr', "\n----------\n\n")
+         simple_replace(doc, 'br', "\n")
+         simple_replace(doc, 'p', "\n\n")
-         base_url = base ? base['href'] : options[:link_base] || ''
+         doc.text.strip.split("\n").collect(&:strip).join("\n").concat("\n")
+      end
+      private
+      def normalize_whitespace(html)
+         html.gsub(/\s/, ' ').squeeze(' ')
+      end
+      def replace_anchors(doc)
          doc.search('a').each do |link_node|
-            href = URI(link_node['href'])
-            href = base_url + href.to_s unless href.absolute?
+            href = get_link_target(link_node, get_link_base(doc))
+            link_node.inner_html = if link_matches(href, link_node.inner_html)
+                                      href.to_s
+                                   else
+                                      "#{ link_node.inner_html } (#{ href })"
+                                   end
+         end
+      end
+      def link_matches(first, second)
+         first.to_s.gsub(%r{^https?://}, '').chomp('/') == second.gsub(%r{^https?://}, '').chomp('/')
+      end
+      def get_link_base(doc)
+         # <base> node is unique by W3C spec
+         base_node = doc.search('base').first
+         base_node ? base_node['href'] : @link_base
+      end
-            link_node.inner_html = "#{link_node.inner_html} (#{href})"
+      def get_link_target(link_node, base)
+         href = URI(link_node['href'])
+         if href.absolute?
+            href
+         else
+            base + href.to_s
          end
+      rescue URI::InvalidURIError
+         link_node['href'].gsub(/^(tel|mailto):/, '').strip
+      end
+      def replace_headers(doc)
          doc.search('header, h1, h2, h3, h4, h5, h6').each do |node|
-            node.inner_html = "- #{node.inner_html} -\n".squeeze(' ')
+            node.inner_html = "-- #{ node.inner_html } --\n".squeeze(' ')
          end
+      end
-         doc.search('hr').each do |node|
-            node.replace "\n----------\n"
+      def replace_images(doc)
+         doc.search('img[role=presentation]').remove
+         doc.search('img').each do |img_node|
+            src = img_node['src']
+            alt = img_node['alt']
+            src = 'embedded' if src.start_with? 'data:'
+            img_node.replace("#{ alt } (#{ src })") unless alt.nil? || alt.empty?
          end
+      end
+      def replace_lists(doc)
+         doc.search('ul, ol').each do |list_node|
+            list_node.search('./li').each_with_index do |list_item, i|
+               marker = if list_node.node_name == 'ol'
+                           "#{ i + 1 }."
+                        else
+                           @list_marker
+                        end
-         doc.search('br').each do |node|
-            node.replace "\n"
+               list_item.inner_html = "#{ marker } #{ list_item.inner_html }\n".squeeze(' ')
+            end
+            list_node.replace("#{ list_node.inner_html }\n")
          end
+      end
+      def replace_tables(doc)
+         doc.css('table').each do |table|
+            column_sizes = calculate_column_sizes(table)
-         # doc.search('p').each do |link_node|
-         #   link_node.inner_html = link_node.inner_html + "\n\n"
-         # end
+            table.search('./thead/tr', './tbody/tr', './tr').each do |row|
+               replace_table_nodes(row, column_sizes)
-         doc.text.gsub(/^[ ]+|[ ]+$/, '')
+               row.inner_html = "#{ row.inner_html }|\n"
+            end
+            add_table_header_underline(table, column_sizes)
+            table.inner_html = "#{ table.inner_html }\n"
+         end
+      end
+      def calculate_column_sizes(table)
+         column_sizes = table.search('tr').collect do |row|
+            row.search('th', 'td').collect do |node|
+               node.inner_html.length
+            end
+         end
+         column_sizes.transpose.collect(&:max)
+      end
+      def add_table_header_underline(table, column_sizes)
+         table.search('./thead').each do |row|
+            header_bottom = "|#{ column_sizes.collect { |len| ('-' * (len + 2)) }.join('|') }|"
+            row.inner_html = "#{ row.inner_html }#{ header_bottom }\n"
+         end
+      end
+      def replace_table_nodes(row, column_sizes)
+         row.search('th', 'td').each_with_index do |node, i|
+            new_content = "| #{ node.inner_html }".squeeze(' ')
+            # +2 for the extra spacing between text and pipe
+            node.inner_html = new_content.ljust(column_sizes[i] + 2)
+         end
+      end
+      def simple_replace(doc, tag, replacement)
+         doc.search(tag).each do |node|
+            node.replace(node.inner_html + replacement)
+         end
       end
    end
-end
+end

metadata CHANGED Viewed

@@ -1,86 +1,119 @@
 --- !ruby/object:Gem::Specification
 name: ghostwriter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Robin Miller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.8.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.8.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
-description: ! 'Transforms HTML into plaintext while preserving legibility and functionality. '
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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'
+description: |
+  Converts HTML to plain text, preserving as much legibility and functionality as possible.
+  Ideal for providing a plaintext multipart segment of email messages.
 email:
 - robin@tenjin.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASE_NOTES.md
 - Rakefile
 - bin/console
 - bin/setup
@@ -98,18 +131,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.4.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
-summary: Intelligently extracts plaintext from an HTML document.
+summary: Converts HTML to plain text
 test_files: []