Implement Open Graph

README.md

@@ -213,6 +213,7 @@ The `HTMLProofer` constructor takes an optional hash of additional options:
 | `assume_extension` | Automatically add extension (e.g. `.html`) to file paths, to allow extensionless URLs (as supported by Jekyll 3 and GitHub Pages) | `false` |
 | `check_external_hash` | Checks whether external hashes exist (even if the webpage exists). This slows the checker down. | `false` |
 | `check_favicon` | Enables the favicon checker. | `false` |
+| `check_opengraph` | Enables the Open Graph checker. | `false` |
 | `check_html` | Enables HTML validation errors from Nokogiri | `false` |
 |`checks_to_ignore`| An array of Strings indicating which checks you'd like to not perform. | `[]`
 | `directory_index_file` | Sets the file to look for when a link refers to a directory. | `index.html` |

bin/htmlproofer

@@ -22,6 +22,7 @@ Mercenary.program(:htmlproofer) do |p|
   p.option 'check_favicon', '--check-favicon', 'Enables the favicon checker (default: `false`).'
   p.option 'check_html', '--check-html', 'Enables HTML validation errors from Nokogiri (default: `false`).'
   p.option 'check_img_http', '--check-img-http', 'Fails an image if it\'s marked as `http` (default: `false`).'
+  p.option 'check_opengraph', '--check-opengraph', 'Enables the Open Graph checker (default: `false`).'
   p.option 'directory_index_file', '--directory-index-file', String, 'Sets the file to look for when a link refers to a directory. (default: `index.html`)'
   p.option 'disable_external', '--disable-external', 'If `true`, does not run the external link checker, which can take a lot of time (default: `false`)'
   p.option 'empty_alt_ignore', '--empty-alt-ignore', 'If `true`, ignores images with empty alt tags'

lib/html-proofer/check/opengraph.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+class OpenGraphElement < ::HTMLProofer::Element
+  def src
+    @content
+  end
+
+  def url
+    src
+  end
+end
+
+class OpenGraphCheck < ::HTMLProofer::Check
+  def missing_src?
+    !@opengraph.src
+  end
+
+  def empty_src?
+    blank?(@opengraph.src)
+  end
+
+  def run
+    @html.css('meta[property="og:url"], meta[property="og:image"]').each do |m|
+      @opengraph = OpenGraphElement.new(m, self)
+
+      next if @opengraph.ignore?
+
+      # does the opengraph exist?
+      if missing_src?
+        add_issue('open graph has no content attribute', line: m.line, content: m.content)
+      elsif empty_src?
+        add_issue('open graph content attribute is empty', line: m.line, content: m.content)
+      elsif !@opengraph.valid?
+        add_issue("#{@opengraph.src} is an invalid URL", line: m.line)
+      elsif @opengraph.remote?
+        add_to_external_urls(@opengraph.url)
+      else
+        add_issue("internal open graph #{@opengraph.url} does not exist", line: m.line, content: m.content) unless @opengraph.exists?
+      end
+    end
+
+    external_urls
+  end
+end

lib/html-proofer/configuration.rb

@@ -10,6 +10,7 @@ module Configuration
       :check_favicon => false,
       :check_html => false,
       :check_img_http => false,
+      :check_opengraph => false,
       :checks_to_ignore => [],
       :directory_index_file => 'index.html',
       :disable_external => false,

lib/html-proofer/runner.rb

@@ -150,6 +150,7 @@ def checks
       @checks = HTMLProofer::Check.subchecks.map(&:name)
       @checks.delete('FaviconCheck') unless @options[:check_favicon]
       @checks.delete('HtmlCheck') unless @options[:check_html]
+      @checks.delete('OpenGraphCheck') unless @options[:check_opengraph]
       @options[:checks_to_ignore].each { |ignored| @checks.delete(ignored) }
       @checks
     end

spec/html-proofer/fixtures/opengraph/image-broken.html

@@ -0,0 +1 @@
+<meta property="og:image" content="https://github.com/hearticon.ico" />

spec/html-proofer/fixtures/opengraph/image-empty.html

@@ -0,0 +1 @@
+<meta property="og:image" content="" />

spec/html-proofer/fixtures/opengraph/image-internal-broken.html

@@ -0,0 +1 @@
+<meta property="og:image" content="doesnotexist.png" />

spec/html-proofer/fixtures/opengraph/image-missing.html

@@ -0,0 +1 @@
+<meta property="og:image" />

spec/html-proofer/fixtures/opengraph/image-valid.html

@@ -0,0 +1 @@
+<meta property="og:image" content="https://github.com/favicon.ico" />

spec/html-proofer/fixtures/opengraph/url-broken.html

@@ -0,0 +1 @@
+<meta property="og:url" content="http://www.asdo3IRJ395295jsingrkrg4.com/">

spec/html-proofer/fixtures/opengraph/url-empty.html

@@ -0,0 +1 @@
+<meta property="og:url" content="">

spec/html-proofer/fixtures/opengraph/url-missing.html

@@ -0,0 +1 @@
+<meta property="og:url">

spec/html-proofer/fixtures/opengraph/url-valid.html

@@ -0,0 +1 @@
+<meta property="og:url" content="http://www.example.com/">

spec/html-proofer/opengraph_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe 'Open Graph test' do
+  it 'passes for existing external url' do
+    url_valid = "#{FIXTURES_DIR}/opengraph/url-valid.html"
+    proofer = run_proofer(url_valid, :file, { :check_opengraph => true })
+    expect(proofer.failed_tests).to eq []
+  end
+
+  it 'fails for missing url content attribute' do
+    url_valid = "#{FIXTURES_DIR}/opengraph/url-missing.html"
+    proofer = run_proofer(url_valid, :file, { :check_opengraph => true })
+    expect(proofer.failed_tests.first).to match(/open graph has no content attribute/)
+  end
+
+  it 'fails for empty url' do
+    url_valid = "#{FIXTURES_DIR}/opengraph/url-empty.html"
+    proofer = run_proofer(url_valid, :file, { :check_opengraph => true })
+    expect(proofer.failed_tests.first).to match(/open graph content attribute is empty/)
+  end
+
+  it 'fails for missing external url' do
+    url_valid = "#{FIXTURES_DIR}/opengraph/url-broken.html"
+    proofer = run_proofer(url_valid, :file, { :check_opengraph => true })
+    expect(proofer.failed_tests.first).to match(/failed: response code 0/)
+  end
+
+  it 'passes for existing external image' do
+    url_valid = "#{FIXTURES_DIR}/opengraph/image-valid.html"
+    proofer = run_proofer(url_valid, :file, { :check_opengraph => true })
+    expect(proofer.failed_tests).to eq []
+  end
+
+  it 'fails for missing image content attribute' do
+    url_valid = "#{FIXTURES_DIR}/opengraph/image-missing.html"
+    proofer = run_proofer(url_valid, :file, { :check_opengraph => true })
+    expect(proofer.failed_tests.first).to match(/open graph has no content attribute/)
+  end
+
+  it 'fails for empty image' do
+    url_valid = "#{FIXTURES_DIR}/opengraph/image-empty.html"
+    proofer = run_proofer(url_valid, :file, { :check_opengraph => true })
+    expect(proofer.failed_tests.first).to match(/open graph content attribute is empty/)
+  end
+
+  it 'fails for missing external image' do
+    url_valid = "#{FIXTURES_DIR}/opengraph/image-broken.html"
+    proofer = run_proofer(url_valid, :file, { :check_opengraph => true })
+    expect(proofer.failed_tests.first).to match(/failed: 406/)
+  end
+
+  it 'fails for missing internal images' do
+    image_internal_invalid = "#{FIXTURES_DIR}/opengraph/image-internal-broken.html"
+    proofer = run_proofer(image_internal_invalid, :file, { :check_opengraph => true })
+    expect(proofer.failed_tests.first).to match(/doesnotexist.png does not exist/)
+  end
+
+  it 'passes for missing external url when not asked to check' do
+    url_valid = "#{FIXTURES_DIR}/opengraph/url-broken.html"
+    proofer = run_proofer(url_valid, :file, { :check_opengraph => false })
+    expect(proofer.failed_tests).to eq []
+  end
+
+  it 'passes for missing external image when not asked to check' do
+    url_valid = "#{FIXTURES_DIR}/opengraph/image-broken.html"
+    proofer = run_proofer(url_valid, :file, { :check_opengraph => false })
+    expect(proofer.failed_tests).to eq []
+  end
+end