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

ghostwriter 0.3.0 → 0.4.0

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: afedaad685b3c06c7baf6e7b1a7b00d8397f9ad1446ddfdcf835dfc99df19969
+  data.tar.gz: 786a612861e5d11e19672057371720c57dd7dc67e1f9b7333bf9269b819b0548
 SHA512:
-  metadata.gz: !binary |-
-    ZDcxMDQ5N2IzMTU0YzlhMzZmMDBkODk2NDVhZjEwZTkyOTY0ZDFmMzZiMmYw
-    NDc3ZmY5NjgyNzkxOTUzMDg4YWU2NmNkZDgyMDdkNjc4OTMzMmIzYWY1MWY2
-    OWRhMzgxNjc5ODM4Yjc4NGE5ZTBmODBmNGUzOGU3NDY2YTA5NDk=
-  data.tar.gz: !binary |-
-    NTIzYTdjNmRmZTRkMTc4NGIxZWJiYjBhYWVkMDI4ZDM1NTc4NDQ4ZTdkZDZk
-    YTVlN2Y1OGMzYTg3MjlkYmNhMjUyMGQwNTZlMmIzNjYxYmQyMDIxMjJiOTVi
-    N2YzMzczODBkZWMxZmY2MmJkYzJkYjQxZjJlZjBjZTM2OWJkMjQ=
+  metadata.gz: 610473e1214cd68edd7b1ce952fd43c44c22a29bc0895bebcc57b4e5e00385bccaec2008e23252eaf438a8b9a1ebd56af0a4c3956be53791ef1b5ee8b75dc1a3
+  data.tar.gz: 3f3bee72a1515077e7ccff0b1baae94607e33c84c83a84f8b51fdf3234aeaecaa48ddf0d6cfc2a38584ce6c0d0d7f52db5b4021638eb611089087ee638ba2d16

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,14 @@
 # Ghostwriter
-Ghostwriter rewrites your emails to conform to varying email client requirements.
+Ghostwriter rewrites HTML as plain text while preserving as much legibility and functionality as possible.
+It's sort of like a reverse-markdown.
+## But Why, Though?
+* Spam filters tend to like emails with a plain text alternative
+* Some email clients won't or can’t handle HTML at all
+* Some people explicitly choose plaintext just by preference or accessibility
 ## Installation
@@ -12,25 +20,14 @@ gem 'ghostwriter'
 And then execute:
-    $ bundle
+    bundle
 Or install it manually with:
-    $ gem install ghostwriter
+    gem install ghostwriter
 ## Usage
-###Stripping HTML
-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.
-Why offer plaintext?
- * 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
@@ -39,10 +36,10 @@ html = '<html><body>This is some markup <a href="tenjin.ca">and a link</a><p>Oth
 Ghostwriter::Writer.new(html).textify
 => "This is some markup and a link (tenjin.ca)\nOther tags translate, too\n\n"
 ```
-`#textify` will use a `<base>` tag if included in the HTML source, or if one is provided explicitly:
+`#textify` will use the `<base>` tag if found in the HTML source, or if one is provided explicitly:
 ```ruby
 html = '<html><body>Relative links <a href="/contact">Link</a></body></html>'
@@ -53,9 +50,10 @@ Ghostwriter::Writer.new(html).textify(link_base: 'tenjin.ca')
 ```
-#### Mail Gem Example
+### 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'
@@ -63,35 +61,49 @@ require 'mail'
 html = 'My email and a <a href="http://tenjin.ca">link</a>'
 mail = Mail.deliver do
-  to      'bob@example.com'
-  from    'dot@example.com'
-  subject 'Using Ghostwriter with Mail'
+   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::Writer.new(html).textify
+   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,32 @@
+# Release Notes
+## 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,37 @@
-# 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     = 'Intelligently extracts plaintext from an HTML document.'
+   spec.description = <<~DESC
+      Transforms HTML into plaintext while preserving legibility and functionality.
+   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 = '0.4.0'
 end

data/lib/ghostwriter/writer.rb CHANGED Viewed

@@ -1,54 +1,102 @@
+# frozen_string_literal: true
 module Ghostwriter
+   # Main Ghostwriter converter object.
    class Writer
       def initialize(html)
          @source_html = html
       end
-      # Intelligently strips HTML down to text.
+      # Strips HTML down to plain text.
       #
-      # Options:
-      #   link_base: the url to prefix relative links with
-      def textify(options={})
-         html = @source_html.dup
-         html.gsub!(/\n|\t/, ' ')
-         html.squeeze!(' ')
-         html.gsub!('</p>', "</p>\n\n")
+      # @param link_base the url to prefix relative links with
+      def textify(link_base: '')
+         html = normalize_whitespace(@source_html).gsub('</p>', "</p>\n\n")
          doc = Nokogiri::HTML(html)
          doc.search('style').remove
          doc.search('script').remove
-         base = doc.search('base').first #<base> is unique by W3C spec
+         replace_anchors(doc, link_base)
+         replace_headers(doc)
+         replace_table(doc)
+         simple_replace(doc, 'hr', "\n----------\n")
+         simple_replace(doc, 'br', "\n")
-         base_url = base ? base['href'] : options[:link_base] || ''
+         # doc.search('p').each do |link_node|
+         #   link_node.inner_html = link_node.inner_html + "\n\n"
+         # end
+         # trim, but only single-space character
+         doc.text.gsub(/^ +| +$/, '')
+      end
+      private
+      def normalize_whitespace(html)
+         html.gsub(/\s/, ' ').squeeze(' ')
+      end
+      def replace_anchors(doc, link_base)
+         # <base> node is unique by W3C spec
+         base     = doc.search('base').first
+         base_url = base ? base['href'] : link_base
          doc.search('a').each do |link_node|
             href = URI(link_node['href'])
             href = base_url + href.to_s unless href.absolute?
-            link_node.inner_html = "#{link_node.inner_html} (#{href})"
+            link_node.inner_html = "#{ link_node.inner_html } (#{ href })"
          end
+      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"
-         end
+      def replace_table(doc)
+         doc.css('table').each do |table|
+            column_sizes = table.search('tr').collect do |row|
+               row.search('th', 'td').collect do |node|
+                  node.inner_html.length
+               end
+            end
+            column_sizes = column_sizes.transpose.collect(&:max)
+            table.search('./thead/tr', './tbody/tr', './tr').each do |row|
+               replace_table_nodes(row, column_sizes)
+               row.inner_html = "#{ row.inner_html }|\n"
+            end
-         doc.search('br').each do |node|
-            node.replace "\n"
+            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
+            table.inner_html = "#{ table.inner_html }\n"
          end
+      end
-         # doc.search('p').each do |link_node|
-         #   link_node.inner_html = link_node.inner_html + "\n\n"
-         # end
+      def replace_table_nodes(row, column_sizes)
+         row.search('th', 'td').each_with_index do |node, i|
+            new_content = "| #{ node.inner_html }".squeeze(' ')
-         doc.text.gsub(/^[ ]+|[ ]+$/, '')
+            # +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(replacement)
+         end
       end
    end
-end
+end

metadata CHANGED Viewed

@@ -1,86 +1,118 @@
 --- !ruby/object:Gem::Specification
 name: ghostwriter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Robin Miller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2021-03-17 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: 'Transforms HTML into plaintext while preserving legibility and functionality.
+'
 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,17 +130,16 @@ 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.