html_aide 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84a4214a1dd1e8ca6c2cd56a857f5b05258e2749
-  data.tar.gz: f1b8d75bdbbc117dcc8ad0789298caa02e0cfdb8
+  metadata.gz: e1a1f5377d543d9e34982c7f3789b75666f94675
+  data.tar.gz: 59d8f79763036abdd59eadda864d806ea51e7a71
 SHA512:
-  metadata.gz: ed7d0580d08699bebe5ba7c8c8d2a689e56ca7805b3db0ea44d5beeb646277070ef19998d5f72e4681ec3abca53c2fc2701b07cea4f395a9bfafb15bf13539e9
-  data.tar.gz: 35096bd9be92d694f7ab1106a9b59100d46afd5067a108a414c992f2d9e8e6a6f9f93d889447684d3503d1ea9ebbf581a68fe0d1762a47542a33aa159318e472
+  metadata.gz: 3e6c817643a102d433d144dbb879aae3641ebb420835cdea13efe4d62fa6eb4f777cd074a18a01bd456d1decbd6fa2add444edc9a6fc48a36e384a5a63801101
+  data.tar.gz: 13bb561966785842dcee474e4e3278a9c273dc24a4ca4e613bb1ac022721e298e9ae1e7c6118beb3e007bebc7425286fa86f6534779fdfaeb6542e01a80bb540

data/README.md

@@ -61,12 +61,29 @@ validator.valid? #=> false
 validator.errors.first.message #=> 'taco is not a valid HTML tag'
 ```
 
-## Future implementations
+_Extend your object with HtmlAide_
 
 ```ruby
-snippet = '<div id="taco"><strong>Taco</strong> Meat</div>'
-snippet.html? #=> true
-validator = snippet.validate_html!
+class MySpecialObject
+  using HtmlAide
+  attr_accessor :markup
+
+  def initialize(some_markup)
+    @markup = some_markup
+  end
+
+  def is_html?
+    @markup.html?
+  end
+
+  def to_element
+    @markup.to_html
+  end
+end
+
+obj = MySpecialObject.new('<div>Taco Meat</div>')
+obj.is_html? #=> true
+obj.to_element #=> <#HtmlAide::Element>
 ```
 
 ## Contributing

data/html_aide.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_dependency "ox"
   spec.add_dependency "nokogiri"
+  spec.add_dependency "rest-client"
+  spec.add_dependency "oj"
 end

data/lib/html_aide.rb

@@ -1,5 +1,11 @@
+require 'bundler'
+Bundler.require(:default, :development)
 require 'ox'
 require 'nokogiri'
+require 'oj'
+require 'rest-client'
+
+require 'html_aide/string'
 require 'html_aide/tag'
 require 'html_aide/markup_parser'
 require 'html_aide/validator'
@@ -8,6 +14,7 @@ require 'html_aide/invalid_element_error'
 require 'html_aide/element'
 require 'html_aide/null_element'
 require 'html_aide/snippet_validator'
+require 'html_aide/page_validator'
 
 module HtmlAide
 end

data/lib/html_aide/markup_parser.rb

@@ -1,15 +1,35 @@
 module HtmlAide
   class MarkupParser
+    class ParseError < StandardError; end
 
-    def self.parse(markup)
-      node = Ox.parse(markup)
-      node = Tag.parse(node)
+    def self.parse(markup, mode = :weak)
+      parser = new
+      parser.send("#{mode}_parse", markup)
     rescue Ox::ParseError => e
       raise ParseError, e.to_s
     rescue Tag::ParseError => e
       raise ParseError, e.to_s
     end
 
-    class ParseError < StandardError; end
+    private
+
+    # Weak mode is for parsing snippets of markup
+    def weak_parse(markup)
+      node = Ox.parse(markup)
+      node = Tag.parse(node)
+    end
+
+    # Strict mode is for parsing an entire document
+    def strict_parse(markup)
+      response = RestClient.post(
+        "http://validator.nu/?out=json",
+        markup,
+        { 'Content-Type' => 'text/html; charset=utf-8', 'Content-Encoding' => 'UTF-8' }
+      )
+      @json = Oj.load(response.body)
+      errors = @json['messages'].select { |mssg| mssg['type'] == 'error' }
+      raise ParseError, errors.to_json if errors.any?
+      @json
+    end
   end
 end

data/lib/html_aide/page_validator.rb

@@ -0,0 +1,30 @@
+module HtmlAide
+  class PageValidator
+
+    def initialize(markup = '')
+      @markup = markup
+      @errors = []
+      parse_markup_for_errors
+    end
+
+    def valid?
+      @valid
+    end
+
+    def errors
+      @errors
+    end
+
+    private
+
+    def parse_markup_for_errors
+      begin
+        node = MarkupParser.parse(@markup, :strict)
+        @valid = true
+      rescue MarkupParser::ParseError => e
+        @errors += Oj.dump(e)
+        @valid = false
+      end
+    end
+  end
+end

data/lib/html_aide/string.rb

@@ -0,0 +1,14 @@
+module HtmlAide
+  refine String do
+
+    def html?
+      HtmlAide::Validator.validate(self).valid?
+    end
+
+    def to_html
+      node = HtmlAide::MarkupParser.parse(self)
+      Element.new(node)
+    end
+
+  end
+end

data/lib/html_aide/tag.rb

@@ -1,10 +1,11 @@
+require 'pry'
 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
+      datalist dd del details dfn div dl dt doctype
       em embed
       fieldset figcaption figure footer form
       h1 h2 h3 h4 h5 h6 head header hgroup hr html
@@ -24,6 +25,8 @@ module HtmlAide
       wbr
     ).freeze
 
+    DOCTYPE_REGEXP = /<\!doctype\shtml>/i
+
     def self.parse(ox_node)
       raise ParseError, "#{ox_node.name} is not a valid HTML tag." unless valid_tag?(ox_node.name)
       ox_node

data/lib/html_aide/version.rb

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

data/spec/string_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+class AFakeClass
+  using HtmlAide
+
+  def markup
+    "<div>Yup</div>"
+  end
+
+  def html?
+    markup.html?
+  end
+
+  def to_html
+    markup.to_html
+  end
+end
+
+describe AFakeClass do
+
+  describe '#html?' do
+    it 'validates the string as html' do
+      tester = AFakeClass.new
+      expect(tester).to be_html
+    end
+  end
+
+  describe '#to_html' do
+    it 'turns the markup into an HtmlAide::Element object' do
+      tester = AFakeClass.new
+      expect(tester.to_html.name).to eq 'div'
+      expect(tester.to_html.class).to eq HtmlAide::Element
+    end
+  end
+
+end

data/spec/validator_spec.rb

@@ -25,6 +25,12 @@ describe HtmlAide::Validator do
         validator = HtmlAide::Validator.validate('<input />')
         expect(validator).to be_valid
       end
+
+      it 'returns true for a full page markup' do
+        full_page = '<!DOCTYPE html><html><head><title>Test</title></head></html>'
+        validator = HtmlAide::Validator.validate(full_page, :page)
+        expect(validator).to be_valid
+      end
     end
 
     context 'when the markup is not valid' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html_aide
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jeremy Woertink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-27 00:00:00.000000000 Z
+date: 2014-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Validate HTML snippets and markup.
 email:
 - jeremywoertink@gmail.com
@@ -114,7 +142,9 @@ files:
 - lib/html_aide/invalid_element_error.rb
 - lib/html_aide/markup_parser.rb
 - lib/html_aide/null_element.rb
+- lib/html_aide/page_validator.rb
 - lib/html_aide/snippet_validator.rb
+- lib/html_aide/string.rb
 - lib/html_aide/tag.rb
 - lib/html_aide/validator.rb
 - lib/html_aide/version.rb
@@ -122,6 +152,7 @@ files:
 - spec/invalid_element_error_spec.rb
 - spec/snippet_validator_spec.rb
 - spec/spec_helper.rb
+- spec/string_spec.rb
 - spec/tag_spec.rb
 - spec/validator_spec.rb
 homepage: https://github.com/devpointlabs/html_aide
@@ -153,5 +184,6 @@ test_files:
 - spec/invalid_element_error_spec.rb
 - spec/snippet_validator_spec.rb
 - spec/spec_helper.rb
+- spec/string_spec.rb
 - spec/tag_spec.rb
 - spec/validator_spec.rb