html_aide 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0c8ecb947f4e1433c02d4d3c66300908c3d49dc
-  data.tar.gz: 9865da568a9172ab2bbd31835e29dd2d582552ed
+  metadata.gz: 84a4214a1dd1e8ca6c2cd56a857f5b05258e2749
+  data.tar.gz: f1b8d75bdbbc117dcc8ad0789298caa02e0cfdb8
 SHA512:
-  metadata.gz: 9a325f843ec18410222da043149acaa70b1bb2b7cf640184d09e2019f855bd1bf1375b21ed96db3c279af424666d6c5fac1ffadd039654fbecec96fc1c2b7d3b
-  data.tar.gz: 6e524d7d532fe5768bd4f5ca9cc890de01ca2e9f5e31d42e0de52560f1aa23ab3aa1cf3f02e036e222f693e73fa25a6eb324d6bb815263cc0564ba351ff38de4
+  metadata.gz: ed7d0580d08699bebe5ba7c8c8d2a689e56ca7805b3db0ea44d5beeb646277070ef19998d5f72e4681ec3abca53c2fc2701b07cea4f395a9bfafb15bf13539e9
+  data.tar.gz: 35096bd9be92d694f7ab1106a9b59100d46afd5067a108a414c992f2d9e8e6a6f9f93d889447684d3503d1ea9ebbf581a68fe0d1762a47542a33aa159318e472

data/README.md

@@ -21,6 +21,8 @@ Or install it yourself as:
 
 ## Usage
 
+_With valid markup_
+
 ```ruby
 snippet = '<div id="taco"><strong>Taco</strong> Meat</div>'
 validator = HtmlAide::Validator.validate(snippet)
@@ -37,6 +39,8 @@ tag.children.first.to_s #=> '<strong>Taco</strong>'
 tag.to_s #=> '<div id="taco"><strong>Taco</strong> Meat</div>'
 ```
 
+_With invalid markup_
+
 ```ruby
 snippet = '<div>Messed up </div'
 validator = HtmlAide::Validator.validate(snippet)
@@ -44,11 +48,20 @@ validator.valid? #=> false
 validator.class #=> HtmlAide::SnippetValidator
 validator.errors #=> [<#HtmlAide::InvalidElementError>]
 error = validator.errors.first #=> HtmlAide::InvalidElementError
-error.message #=> 'Syntax Error in element'
+error.message #=> 'invalid format, document not terminated at line 1, column 21'
 validator.element #=> HtmlAide::NullElement
 ```
 
-possible helpers
+_Also validates invalid HTML 5 tags_
+
+```ruby
+snippet = '<taco>Chicken Soft</taco>'
+validator = HtmlAide::Validator.validate(snippet)
+validator.valid? #=> false
+validator.errors.first.message #=> 'taco is not a valid HTML tag'
+```
+
+## Future implementations
 
 ```ruby
 snippet = '<div id="taco"><strong>Taco</strong> Meat</div>'

data/html_aide.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["jeremywoertink@gmail.com"]
   spec.summary       = %q{Validate HTML snippets and markup.}
   spec.description   = %q{Validate HTML snippets and markup.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/devpointlabs/html_aide"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/html_aide.rb

@@ -1,5 +1,7 @@
 require 'ox'
 require 'nokogiri'
+require 'html_aide/tag'
+require 'html_aide/markup_parser'
 require 'html_aide/validator'
 require 'html_aide/version'
 require 'html_aide/invalid_element_error'

data/lib/html_aide/markup_parser.rb

@@ -0,0 +1,15 @@
+module HtmlAide
+  class MarkupParser
+
+    def self.parse(markup)
+      node = Ox.parse(markup)
+      node = Tag.parse(node)
+    rescue Ox::ParseError => e
+      raise ParseError, e.to_s
+    rescue Tag::ParseError => e
+      raise ParseError, e.to_s
+    end
+
+    class ParseError < StandardError; end
+  end
+end

data/lib/html_aide/snippet_validator.rb

@@ -25,10 +25,10 @@ module HtmlAide
 
     def create_node_and_set_element
       begin
-        node = Ox.parse(@markup)
+        node = MarkupParser.parse(@markup)
         @element = Element.new(node)
         @valid = true
-      rescue Ox::ParseError => e
+      rescue MarkupParser::ParseError => e
         @element = NullElement.new
         @errors << InvalidElementError.new(e)
         @valid = false

data/lib/html_aide/tag.rb

@@ -0,0 +1,38 @@
+module HtmlAide
+  class Tag
+    VALID_TAGS = %w(
+      a abbr address area article aside audio
+      b base bdi bdo blockquote body br button
+      canvas caption cite code col colgroup
+      datalist dd del details dfn div dl dt
+      em embed
+      fieldset figcaption figure footer form
+      h1 h2 h3 h4 h5 h6 head header hgroup hr html
+      i iframe img input ins
+      kbd keygen
+      label legend li link
+      map mark menu menuitem meta meter
+      nav noscript
+      object ol optgroup option output
+      p param pre progress
+      q
+      rp rt ruby
+      s samp script section select small source span strong summary sup
+      table tbody td textarea tfoot th thead time title tr track
+      ul
+      var video
+      wbr
+    ).freeze
+
+    def self.parse(ox_node)
+      raise ParseError, "#{ox_node.name} is not a valid HTML tag." unless valid_tag?(ox_node.name)
+      ox_node
+    end
+
+    def self.valid_tag?(tag_name)
+      VALID_TAGS.include?(tag_name)
+    end
+
+    class ParseError < StandardError; end
+  end
+end

data/lib/html_aide/version.rb

@@ -1,3 +1,3 @@
 module HtmlAide
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/tag_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe HtmlAide::Tag do
+
+  describe '.parse' do
+    let(:bad_node) { Ox.parse('<taco></taco>') }
+    let(:good_node) { Ox.parse('<p></p>') }
+    it 'takes an ox node and raises an error for an invalid tag' do
+      expect { HtmlAide::Tag.parse(bad_node) }.to raise_error 'taco is not a valid HTML tag.'
+    end
+
+    it 'returns the original node when all is good' do
+      expect(HtmlAide::Tag.parse(good_node)).to eq good_node
+    end
+  end
+
+  describe '.valid_tag?' do
+    it 'takes the tag name section and returns true' do
+      expect(HtmlAide::Tag.valid_tag?('section')).to eq true
+    end
+    it 'takes the tag name blink and returns false' do
+      expect(HtmlAide::Tag.valid_tag?('blink')).to eq false
+    end
+  end
+end

data/spec/validator_spec.rb

@@ -2,10 +2,44 @@ require 'spec_helper'
 
 describe HtmlAide::Validator do
 
-  describe '#initialize' do
+  describe '.validate' do
     it 'returns a SnippetValidator' do
-      v = HtmlAide::Validator.validate('')
+      v = HtmlAide::Validator.validate('<a></a>')
       expect(v).to be_kind_of HtmlAide::SnippetValidator
     end
   end
+
+  describe '#valid?' do
+    context 'when the markup is valid' do
+      it 'returns true for a normal snippet' do
+        validator = HtmlAide::Validator.validate('<div id="taco">Taco</div>')
+        expect(validator).to be_valid
+      end
+
+      it 'returns true for a nested snippet' do
+        validator = HtmlAide::Validator.validate('<div id="taco">Taco <strong>Meat</strong></div>')
+        expect(validator).to be_valid
+      end
+
+      it 'returns true for valid html tags' do
+        validator = HtmlAide::Validator.validate('<input />')
+        expect(validator).to be_valid
+      end
+    end
+
+    context 'when the markup is not valid' do
+      it 'returns false for a broken tag' do
+        validator = HtmlAide::Validator.validate('<div id="taco">Taco</div')
+        expect(validator).to_not be_valid
+      end
+      it 'returns false for a nested broken tag' do
+        validator = HtmlAide::Validator.validate('<div id="taco">Taco <strong>Meat</strong</div>')
+        expect(validator).to_not be_valid
+      end
+      it 'returns false for invalid tags' do
+        validator = HtmlAide::Validator.validate('<taco>Meat</taco>')
+        expect(validator).to_not be_valid
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html_aide
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeremy Woertink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,16 +112,19 @@ files:
 - lib/html_aide.rb
 - lib/html_aide/element.rb
 - lib/html_aide/invalid_element_error.rb
+- lib/html_aide/markup_parser.rb
 - lib/html_aide/null_element.rb
 - lib/html_aide/snippet_validator.rb
+- lib/html_aide/tag.rb
 - lib/html_aide/validator.rb
 - lib/html_aide/version.rb
 - spec/element_spec.rb
 - spec/invalid_element_error_spec.rb
 - spec/snippet_validator_spec.rb
 - spec/spec_helper.rb
+- spec/tag_spec.rb
 - spec/validator_spec.rb
-homepage: ''
+homepage: https://github.com/devpointlabs/html_aide
 licenses:
 - MIT
 metadata: {}
@@ -150,4 +153,5 @@ test_files:
 - spec/invalid_element_error_spec.rb
 - spec/snippet_validator_spec.rb
 - spec/spec_helper.rb
+- spec/tag_spec.rb
 - spec/validator_spec.rb