ghostwriter 0.1.0.placeholder → 0.3.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: ebcc9c22952ebb3ffc67cf0e0a6fccc26a7ef03b
-  data.tar.gz: 66ebb78d46f9bff22308d8223cdfeb9b322528b0
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjAxZjQzNDU2NTEyMDgwODc3NTAyYjQyYTRhNGZjOTEwMzg4MTE0Yw==
+  data.tar.gz: !binary |-
+    NjBjZWU4OWExMmYyOGU1NDMzNTI4MDhkNzEzMGU3YWFhNjdiM2M0MA==
 SHA512:
-  metadata.gz: d09deb19bc041c49fb2d87e8b4220b8bd6488deb55d48cc4ca5c72b9ad4eaa6dc94cc41200effdd683fab4727133a9b0a13bd3d7619db3d66215535c4268a531
-  data.tar.gz: 9cacc0548840d48cf2b049bd2d65457c5b248ff0cb4e79b6b7fa2e916dd35fdb69f0a84bfdb7c759099e761c3d8e74d0d0a09dc60b5ee842440412f54a213f94
+  metadata.gz: !binary |-
+    ZDcxMDQ5N2IzMTU0YzlhMzZmMDBkODk2NDVhZjEwZTkyOTY0ZDFmMzZiMmYw
+    NDc3ZmY5NjgyNzkxOTUzMDg4YWU2NmNkZDgyMDdkNjc4OTMzMmIzYWY1MWY2
+    OWRhMzgxNjc5ODM4Yjc4NGE5ZTBmODBmNGUzOGU3NDY2YTA5NDk=
+  data.tar.gz: !binary |-
+    NTIzYTdjNmRmZTRkMTc4NGIxZWJiYjBhYWVkMDI4ZDM1NTc4NDQ4ZTdkZDZk
+    YTVlN2Y1OGMzYTg3MjlkYmNhMjUyMGQwNTZlMmIzNjYxYmQyMDIxMjJiOTVi
+    N2YzMzczODBkZWMxZmY2MmJkYzJkYjQxZjJlZjBjZTM2OWJkMjQ=

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
   - 2.2.1
-before_install: gem install bundler -v 1.11.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -1,49 +1,13 @@
 # Contributor Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
+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, religion, or nationality.
+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:
+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.
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or 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.
 
-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, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
 
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at robin@tenjin.ca. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+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

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in ghostwriter.gemspec
+# Specify gem dependencies in ghostwriter.gemspec
 gemspec

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Robin Miller
+Copyright (c) 2015 Robin Miller
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,6 @@
 # Ghostwriter
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ghostwriter`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ghostwriter rewrites your emails to conform to varying email client requirements. 
 
 ## Installation
 
@@ -16,26 +14,84 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it manually with:
 
     $ gem install ghostwriter
 
 ## Usage
 
-TODO: Write usage instructions here
+###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
+html = '<html><body>This is some markup <a href="tenjin.ca">and a link</a><p>Other tags translate, too</p></body></html>'
+
+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: 
+
+```ruby
+html = '<html><body>Relative links <a href="/contact">Link</a></body></html>'
+
+Ghostwriter::Writer.new(html).textify(link_base: 'tenjin.ca')
+
+=> "Relative links Link (tenjin.ca/contact)"
+
+```
 
-## Development
+#### 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: 
+
+```ruby
+require 'mail'
 
-After checking out the repo, run `bin/setup` 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.
+html = 'My email and a <a href="http://tenjin.ca">link</a>'
 
-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).
+mail = Mail.deliver do
+  to      'bob@example.com'
+  from    'dot@example.com'
+  subject 'Using Ghostwriter with Mail'
+
+  html_part do
+      content_type 'text/html; charset=UTF-8'
+      body html
+    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
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ghostwriter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+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.
 
-## License
+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).
 
+## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "ghostwriter"
+require 'bundler/setup'
+require 'ghostwriter'
 
 # 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.

data/bin/setup

@@ -1,7 +1,6 @@
-#!/usr/bin/env bash
+#!/bin/bash
 set -euo pipefail
 IFS=$'\n\t'
-set -vx
 
 bundle install
 

data/dirt-textify.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$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']
+
+   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'
+
+   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']
+
+   gemspec.add_dependency 'nokogiri', '~> 1.6'
+
+   gemspec.add_development_dependency 'bundler', '~> 1.10'
+   gemspec.add_development_dependency 'rake', '~> 10.0'
+   gemspec.add_development_dependency 'rspec', '~> 3.3'
+end

data/lib/ghostwriter.rb

@@ -1,5 +1,3 @@
-require "ghostwriter/version"
-
-module Ghostwriter
-  # Your code goes here...
-end
+require 'ghostwriter/version'
+require 'ghostwriter/writer'
+require 'nokogiri'

data/lib/ghostwriter/version.rb

@@ -1,3 +1,3 @@
 module Ghostwriter
-  VERSION = "0.1.0.placeholder"
+   VERSION = '0.3.0'
 end

data/lib/ghostwriter/writer.rb

@@ -0,0 +1,54 @@
+module Ghostwriter
+   class Writer
+      def initialize(html)
+         @source_html = html
+      end
+
+      # Intelligently strips HTML down to 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")
+
+         doc = Nokogiri::HTML(html)
+
+         doc.search('style').remove
+         doc.search('script').remove
+
+         base = doc.search('base').first #<base> is unique by W3C spec
+
+         base_url = base ? base['href'] : options[: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})"
+         end
+
+         doc.search('header, h1, h2, h3, h4, h5, h6').each do |node|
+            node.inner_html = "- #{node.inner_html} -\n".squeeze(' ')
+         end
+
+         doc.search('hr').each do |node|
+            node.replace "\n----------\n"
+         end
+
+         doc.search('br').each do |node|
+            node.replace "\n"
+         end
+
+         # doc.search('p').each do |link_node|
+         #   link_node.inner_html = link_node.inner_html + "\n\n"
+         # end
+
+         doc.text.gsub(/^[ ]+|[ ]+$/, '')
+      end
+   end
+end

metadata

@@ -1,68 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: ghostwriter
 version: !ruby/object:Gem::Version
-  version: 0.1.0.placeholder
+  version: 0.3.0
 platform: ruby
 authors:
 - Robin Miller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-03-07 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.11'
+        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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: Transforms HTML into plaintext while preserving legibility and functionality.
-  Previously known as dirt-textify.
+        version: '3.3'
+description: ! 'Transforms HTML into plaintext while preserving legibility and functionality. '
 email:
 - robin@tenjin.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -70,9 +84,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- ghostwriter.gemspec
+- dirt-textify.gemspec
 - lib/ghostwriter.rb
 - lib/ghostwriter/version.rb
+- lib/ghostwriter/writer.rb
 homepage: https://github.com/TenjinInc/ghostwriter
 licenses:
 - MIT
@@ -83,17 +98,17 @@ 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: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Intelligently extracts plaintext from an HTML document.

data/ghostwriter.gemspec

@@ -1,25 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ghostwriter/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "ghostwriter"
-  spec.version       = Ghostwriter::VERSION
-  spec.authors       = ["Robin Miller"]
-  spec.email         = ["robin@tenjin.ca"]
-
-  spec.summary       = %q{Intelligently extracts plaintext from an HTML document.}
-  spec.description   = %q{Transforms HTML into plaintext while preserving legibility and functionality. Previously known as dirt-textify.}
-  spec.homepage      = 'https://github.com/TenjinInc/ghostwriter'
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end