html-proofer 0.0.14 → 0.0.15

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MGZjNTUyZGY2NWNjMzI5Y2MzZWJlMGIzNTQ0ZjZiZjg4ODJmZjMxMw==
-  data.tar.gz: !binary |-
-    YzE4OTgyMzQ1NDFiNmYzNjI5OWUzYmQzMjhkYzg0NTYwM2JiNTRlMg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZGE1MDg2YjI4ZmYzYTMzMzAwYzE1NmM5N2FiYTBiM2MyZjc1MzIxYjA5YTM3
-    N2Y3YzE3ZDYwNGUwNGQ1YmNmYWQxYzk1ZDBjMWNlMWMwZWVhYWEyOGZiYWUx
-    MGRmMjVjYjA1MjRlNjk4NDU4ZGMyYTRhMTYzOGFhMGI0OWU5NmE=
-  data.tar.gz: !binary |-
-    N2IzYTQ5NWYyYmRjZDk4ZmZiOTkwMjM2YmJiYTA4NzI3Yzc5ZWRmZWE2ODEx
-    MWU3ODAyYjYyZGM1MzdhNDExN2M0OGFlNTA4YjA0MmQ5NmE3MTRjZWI5ODhl
-    MmFjZmMzMzllZDBhZjMxZTdkNDNiZmUzNDQxNjMxY2ZiZGJkMWI=
+SHA1:
+  metadata.gz: 0c6a1c51716811e1e38a4eef20a167b2490c5ab5
+  data.tar.gz: d7501e48d9ce855f3a0a75e0bc7794081b875609
+SHA512:
+  metadata.gz: 60524eeedd9b6d31e8d0d629730e1f236b0ff8710b50bbad9444cf28bd275749c98295a54be40a73d32508d6b7d641b715358e57a21fd449d241fb3c75264355
+  data.tar.gz: 6cf390b2b717a84039a96a77c2693f0ea0941ff68c5b918f0ed288e18f545b5264c973fa1d8213ef0abebeb8c88d30a532ed8a023a27910690f740d9aac65a50

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -1,3 +1,11 @@
 source "http://rubygems.org"
 
-gemspec
+gem "nokogiri",        "1.6.0"
+gem "typhoeus",        "~> 0.6.3"
+gem "colored",         "~> 1.2"
+gem 'rake'
+
+group :test, :development do
+  gem "rspec", "~> 2.13.0"
+  gem "html-pipeline", "~> 0.0.12"
+end

data/Gemfile.lock

@@ -1,11 +1,3 @@
-PATH
-  remote: .
-  specs:
-    html-proofer (0.0.14)
-      colored (~> 1.2)
-      nokogiri (= 1.6.0)
-      typhoeus (~> 0.6.3)
-
 GEM
   remote: http://rubygems.org/
   specs:
@@ -40,6 +32,7 @@ GEM
     multi_json (1.7.7)
     nokogiri (1.6.0)
       mini_portile (~> 0.5.0)
+    rake (10.1.0)
     rinku (1.7.3)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
@@ -61,6 +54,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  colored (~> 1.2)
   html-pipeline (~> 0.0.12)
-  html-proofer!
+  nokogiri (= 1.6.0)
+  rake
   rspec (~> 2.13.0)
+  typhoeus (~> 0.6.3)

data/README.md

@@ -4,6 +4,8 @@ Generate HTML files? Use them for documentation? Great, then this tool might be
 
 Here are a set of tests to validate your HTML output. These tests check if your image references are legitimate, if they have alt tags, if your internal links are working, and so on. It's intended to be an all-in-one checker for your documentation output.
 
+[![Build Status](https://travis-ci.org/gjtorikian/html-proofer.png?branch=master)](https://travis-ci.org/gjtorikian/html-proofer)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1,2 +1,8 @@
 require 'bundler'
-Bundler::GemHelper.install_tasks
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/html-proofer.gemspec

@@ -13,11 +13,4 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split($/)
   gem.test_files    = gem.files.grep(%r{^(spec)/})
   gem.require_paths = ["lib"]
-
-  gem.add_dependency "nokogiri",        "1.6.0"
-  gem.add_dependency "colored",         "~> 1.2"
-  gem.add_dependency "typhoeus",        "~> 0.6.3"
-
-  gem.add_development_dependency "html-pipeline", "~> 0.0.12"
-  gem.add_development_dependency "rspec", "~> 2.13.0"
 end

data/lib/html/proofer.rb

@@ -41,6 +41,7 @@ module HTML
     end
 
     def self.create_nokogiri(path)
+      path << "index.html" if File.directory? path #support for Jekyll-style links
       Nokogiri::HTML(File.read(path))
     end
 

data/lib/html/proofer/checks/links.rb

@@ -7,7 +7,7 @@ class Links < ::HTML::Proofer::Checks::Check
       href = a['href']
 
       if href && href.length > 0
-        if @options[:href_swap] 
+        if @options[:href_swap]
           @options[:href_swap].each do |link, replace|
             href = href.gsub(link, replace)
           end
@@ -20,15 +20,15 @@ class Links < ::HTML::Proofer::Checks::Check
         end
         if !external_href?(href)
           # an internal link, with a hash
-          if href_split
+          if href_split && !href_split.empty?
             href_file = href_split[0]
             href_hash = href_split[1]
 
             # it's not an internal hash; it's pointing to some other file
             if href_file.length > 0
-              href_location = File.join(File.dirname(@path), href_file)
+              href_location = resolve_path File.join(File.dirname(@path), href_file)
               if !File.exist?(href_location)
-                self.add_issue("#{@path}".blue + ": internal link #{href_location} does not exist") 
+                self.add_issue("#{@path}".blue + ": internal link #{href_location} does not exist")
               else
                 href_html = HTML::Proofer.create_nokogiri(href_location)
                 found_hash_match = false
@@ -44,7 +44,8 @@ class Links < ::HTML::Proofer::Checks::Check
             end
           # internal link, no hash
           else
-            self.add_issue("#{@path}".blue + ": internally linking to #{href}, which does not exist") unless File.exist?(File.join(File.dirname(@path), href))
+            href_location = resolve_path File.join(File.dirname(@path), href)
+            self.add_issue("#{@path}".blue + ": internally linking to #{href_location}, which does not exist") unless File.exist?(href_location)
           end
         else
           validate_url(href, "#{@path}".blue + ": externally linking to #{href}, which does not exist")
@@ -58,4 +59,10 @@ class Links < ::HTML::Proofer::Checks::Check
   def hash_check(html, href_hash)
     html.xpath("//*[@id='#{href_hash}']", "//*[@name='#{href_hash}']").length > 0
   end
+
+  #support for implicit /index.html in URLs
+  def resolve_path(path)
+    path << "index.html" if File.directory? path
+    path
+  end
 end

data/lib/html/proofer/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class Proofer
-    VERSION = "0.0.14"
+    VERSION = "0.0.15"
   end
 end

data/spec/html/proofer/fixtures/index.html

@@ -0,0 +1 @@
+root.

data/spec/html/proofer/fixtures/linkToFolder.html

@@ -0,0 +1,9 @@
+<html>
+
+<body>
+
+  <p>Blah blah blah. <a href="folder/">A pretty permlaink!</a></p>
+
+</body>
+
+</html>

data/spec/html/proofer/fixtures/rootLink.html

@@ -0,0 +1,9 @@
+<html>
+
+<body>
+
+  <p>Blah blah blah. <a href="/">I am root.</a></p>
+
+</body>
+
+</html>

data/spec/html/proofer/links_spec.rb

@@ -29,7 +29,7 @@ describe "Links tests" do
     brokenLinkInternalFilepath = "#{FIXTURES_DIR}/brokenLinkInternal.html"
     @linkCheck = Links.new(brokenLinkInternalFilepath, HTML::Proofer.create_nokogiri(brokenLinkInternalFilepath))
     @linkCheck.run
-    @linkCheck.issues[0].should eq("spec/html/proofer/fixtures/brokenLinkInternal.html".blue + ": internally linking to ./notreal.html, which does not exist")
+    @linkCheck.issues[0].should eq("spec/html/proofer/fixtures/brokenLinkInternal.html".blue + ": internally linking to spec/html/proofer/fixtures/./notreal.html, which does not exist")
   end
 
   it "fails for link with no href" do
@@ -59,4 +59,18 @@ describe "Links tests" do
     @linkCheck.run
     @linkCheck.issues[0].should eq(nil)
   end
+
+  it 'properly resolves implicit /index.html in link paths' do
+    linkToFolder = "#{FIXTURES_DIR}/linkToFolder.html"
+    @linkCheck = Links.new(linkToFolder, HTML::Proofer.create_nokogiri(linkToFolder))
+    @linkCheck.run
+    @linkCheck.issues[0].should eq(nil)
+  end
+
+  it 'properly checks links to root' do
+    rootLink = "#{FIXTURES_DIR}/rootLink.html"
+    @linkCheck = Links.new(rootLink, HTML::Proofer.create_nokogiri(rootLink))
+    @linkCheck.run
+    @linkCheck.issues[0].should eq(nil)
+  end
 end

metadata

@@ -1,85 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-29 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.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.6.0
-- !ruby/object:Gem::Dependency
-  name: colored
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: typhoeus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.3
-- !ruby/object:Gem::Dependency
-  name: html-pipeline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.12
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.12
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.13.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.13.0
+date: 2013-10-09 00:00:00.000000000 Z
+dependencies: []
 description: Test your rendered HTML files to make sure they're accurate.
 email:
 - gjtorikian@gmail.com
@@ -88,6 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -108,7 +39,10 @@ files:
 - spec/html/proofer/fixtures/brokenLinkInternal.html
 - spec/html/proofer/fixtures/brokenLinkWithNumber.html
 - spec/html/proofer/fixtures/existingImageExternal.html
+- spec/html/proofer/fixtures/folder/index.html
 - spec/html/proofer/fixtures/gpl.png
+- spec/html/proofer/fixtures/index.html
+- spec/html/proofer/fixtures/linkToFolder.html
 - spec/html/proofer/fixtures/linkWithHttps.html
 - spec/html/proofer/fixtures/linkWithRedirect.html
 - spec/html/proofer/fixtures/missingImageAlt.html
@@ -118,6 +52,7 @@ files:
 - spec/html/proofer/fixtures/missingImageInternal.html
 - spec/html/proofer/fixtures/missingImageSrc.html
 - spec/html/proofer/fixtures/missingLinkHref.html
+- spec/html/proofer/fixtures/rootLink.html
 - spec/html/proofer/fixtures/terribleImageName.html
 - spec/html/proofer/images_spec.rb
 - spec/html/proofer/links_spec.rb
@@ -132,12 +67,12 @@ 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: '0'
 requirements: []
@@ -156,7 +91,10 @@ test_files:
 - spec/html/proofer/fixtures/brokenLinkInternal.html
 - spec/html/proofer/fixtures/brokenLinkWithNumber.html
 - spec/html/proofer/fixtures/existingImageExternal.html
+- spec/html/proofer/fixtures/folder/index.html
 - spec/html/proofer/fixtures/gpl.png
+- spec/html/proofer/fixtures/index.html
+- spec/html/proofer/fixtures/linkToFolder.html
 - spec/html/proofer/fixtures/linkWithHttps.html
 - spec/html/proofer/fixtures/linkWithRedirect.html
 - spec/html/proofer/fixtures/missingImageAlt.html
@@ -166,6 +104,7 @@ test_files:
 - spec/html/proofer/fixtures/missingImageInternal.html
 - spec/html/proofer/fixtures/missingImageSrc.html
 - spec/html/proofer/fixtures/missingLinkHref.html
+- spec/html/proofer/fixtures/rootLink.html
 - spec/html/proofer/fixtures/terribleImageName.html
 - spec/html/proofer/images_spec.rb
 - spec/html/proofer/links_spec.rb