html-proofer-mailto_awesome 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8cac7e46331c90400b693b1c70e6bc03e3074940082f4600bcce25d0dbdcebc
-  data.tar.gz: 60757e57485776f112fd3875e13d39aeb34757a0f2601e9be8612fa56c75d46f
+  metadata.gz: a5f60bc0be820e0d12043208367c5f8f81be17f59e47e1ed458d7322d81239b7
+  data.tar.gz: c223ddaa2d3850053804f8fa70e2ca9c5276c05e171ff81cc21e5b49240b9db7
 SHA512:
-  metadata.gz: 1a3b51f008450efcf9084bf3a7764bbbf45c4c3c7b53f996bd250658591501c35bb61b961d3851f1206e630c382ce27c57774bf8a0a8407709bfb396cae53818
-  data.tar.gz: 373b824619d2eedc650413a1afd223ffa648242d7cc8fc11c177b9f443c935cd193a0b019fb2fc9ff8f85e24225a91b53deb57a959208a0eb39d91bed1a0664c
+  metadata.gz: 405f7bb715f53680bced7ba88605289cc13567461ca4f79bdc1bc4fbe0850587e58765d8a5f41aa419ccaf6c2c54b2d6f28c9e38137e9148aee2037f94792ffa
+  data.tar.gz: c19f8f444ade6c723d405b102679ff68df9a0afa77de80fa01d65f0fd95946d4601750862559a86fb2c47a3242b437ad8d56ac11a53bbefa26479cb6da1118e2

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/vendor/*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in html-proofer-mailto_awesome.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    html-proofer-mailto_awesome (1.0.0)
+      html-proofer (~> 3.0, >= 3.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.11.1)
+    html-proofer (3.11.1)
+      activesupport (>= 4.2, < 6.0)
+      addressable (~> 2.3)
+      mercenary (~> 0.3.2)
+      nokogiri (~> 1.9)
+      parallel (~> 1.3)
+      rainbow (~> 3.0)
+      typhoeus (~> 1.3)
+      yell (~> 2.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    mercenary (0.3.6)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.17.0)
+    public_suffix (3.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thread_safe (0.3.6)
+    timecop (0.9.1)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    vcr (3.0.3)
+    yell (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  html-proofer-mailto_awesome!
+  rake (~> 10.0)
+  rspec (~> 3.5, >= 3.5.0)
+  timecop (~> 0.8, >= 0.8.1)
+  vcr (~> 3.0, >= 3.0.3)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 William Entriken
+
+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,80 @@
+[![Build Status](https://travis-ci.org/fulldecent/html-proofer-mailto_awesome.svg?branch=master)](https://travis-ci.org/fulldecent/html-proofer-mailto_awesome)
+
+# html-proofer-mailto_awesome
+A custom [html-proofer](https://github.com/gjtorikian/html-proofer) test that makes your `mailto:` links awesome.
+
+## What is an awesome `mailto` link?
+
+We should use awesome links as psychological warfare against users. Users will send us emails with stupid or annoying content that we don't want. At big companies (like Amazon) they have abandoned email altogether because of this reason. So instead we prefill the email with the message we want to receive. It takes active cognitive effort for the user to put in their unwanted message.
+
+For example, this is a not-awesome `mailto` link:
+
+```html
+<a href="mailto:support@pacificmedicaltraining.com">Email us</a>
+```
+
+This is an awesome link:
+
+```html
+<a href="mailto:support@pacificmedicaltraining.com?subject=Signing up&amp;body=Hello,\nI'd like to sign up for your course, can you please send me more information.">Email us</a>
+```
+
+For more reference, see http://marcwitteveen.com/mailtogenerator/
+
+## How do I use it
+
+Follow the same instructions as for any [html-proofer custom class](https://github.com/gjtorikian/html-proofer/wiki/Extensions-(custom-classes)).
+
+Our ruby gem is [html-proofer-mailto_awesome](https://rubygems.org/gems/html-proofer-mailto_awesome)
+
+1. Add new dependency to your Ruby project
+  
+    In Gemfile:
+        
+         gem 'html-proofer-mailto_awesome'
+    
+    Or in your .gemspec: 
+
+         Gem::Specification.new do |s|
+             ...
+             s.add_runtime_dependency 'html-proofer-mailto_awesome'
+         end
+    
+2. Create a Rakefile like the following and add it to your project
+
+       task :default => [:test]
+       
+       desc 'run Rspec specs'
+       task :test do
+         sh 'rspec spec'
+       end
+  
+3. Run `bundle install`
+
+4. Run `rake`
+
+Also if you like, you can enable your project for continuous integration testing with Travis:
+
+1. Set up Travis CI for your project
+
+2. Add a `.travis.yml` file like the following to your project and your spec will run automatically
+
+       language: ruby
+       rvm:
+         - 2.5.3       
+For additional tests you can run on your website, see [Lightning Sites](https://github.com/fulldecent/lightning-sites) and for a sample GitHub project that implements this testing and follows many other HTML development best practices, see [HTML Website Template](https://github.com/fulldecent/html-website-template).
+
+For a full example of a website project that includes testing  continuous integration testing for awesome mailto links and many other best practices, see our 
+       
+## Contributing
+
+This project is released under the MIT license.
+
+Releasing new versions:
+
+```sh
+gem bump
+rm html-proofer-mailto_awesome-*.gem
+gem build html-proofer-mailto_awesome.gemspec
+gem push html-proofer-mailto_awesome-*.gem
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "html/proofer/mailto_awesome"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/html-proofer-mailto_awesome.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'html/proofer/mailto_awesome/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'html-proofer-mailto_awesome'
+  spec.version = MailtoAwesome::VERSION
+  spec.authors = ['William Entriken']
+  spec.email = 'github.com@phor.net'
+
+  spec.summary = 'Checker for mailto links'
+  spec.description = 'A custom html-proofer test that makes your mailto links awesome'
+  spec.homepage = 'https://github.com/fulldecent/html-proofer-mailto_awesome'
+  spec.license = 'MIT'
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency 'html-proofer', '~> 3.0', '>= 3.9.0'
+  spec.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'
+  spec.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.3'
+  spec.add_development_dependency 'timecop', '~> 0.8', '>= 0.8.1'
+end

data/lib/html/proofer/mailto_awesome/version.rb

@@ -0,0 +1,3 @@
+module MailtoAwesome
+  VERSION = "1.0.1"
+end

data/lib/mailto_awesome.rb

@@ -0,0 +1,32 @@
+require "html/proofer/mailto_awesome/version"
+
+module Html
+  module Proofer
+    module MailtoAwesome
+      class Error < StandardError; end
+      class MailToAwesome < ::HTMLProofer::Check
+        def mailto?
+          return false if @link.ignore? || @link.href.nil?
+          @link.href.match /^mailto:/i
+        end
+      
+        def awesome?
+          @link.href.downcase.include? 'subject=' and @link.href.downcase.include? 'body='
+        end
+      
+        def run
+          return unless @options[:check_mailto_awesome]
+          @html.css('a').each do |node|
+            @link = create_element(node)
+            line = node.line
+            content = node.to_s
+      
+            if mailto? && !awesome?
+              add_issue("This is a not-awesome mailto link!", line: line, content: content)
+            end
+          end
+        end
+      end      
+    end
+  end
+end

metadata

@@ -1,75 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer-mailto_awesome
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - William Entriken
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2018-12-29 00:00:00.000000000 Z
+date: 2019-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: html-proofer
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.9.0
-  type: :runtime
+        version: '2.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        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: html-proofer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 3.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -116,7 +124,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/mail_to_awesome.rb
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- html-proofer-mailto_awesome.gemspec
+- lib/html/proofer/mailto_awesome/version.rb
+- lib/mailto_awesome.rb
 homepage: https://github.com/fulldecent/html-proofer-mailto_awesome
 licenses:
 - MIT
@@ -136,8 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Checker for mailto links

data/lib/mail_to_awesome.rb

@@ -1,23 +0,0 @@
-class MailToAwesome < ::HTMLProofer::Check
-  def mailto?
-    return false if @link.ignore? || @link.href.nil?
-    @link.href.match /^mailto:/i
-  end
-
-  def awesome?
-    @link.href.downcase.include? 'subject=' and @link.href.downcase.include? 'body='
-  end
-
-  def run
-    return unless @options[:check_mailto_awesome]
-    @html.css('a').each do |node|
-      @link = create_element(node)
-      line = node.line
-      content = node.to_s
-
-      if mailto? && !awesome?
-        add_issue("This is a not-awesome mailto link!", line: line, content: content)
-      end
-    end
-  end
-end