html_aide 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0c8ecb947f4e1433c02d4d3c66300908c3d49dc
+  data.tar.gz: 9865da568a9172ab2bbd31835e29dd2d582552ed
+SHA512:
+  metadata.gz: 9a325f843ec18410222da043149acaa70b1bb2b7cf640184d09e2019f855bd1bf1375b21ed96db3c279af424666d6c5fac1ffadd039654fbecec96fc1c2b7d3b
+  data.tar.gz: 6e524d7d532fe5768bd4f5ca9cc890de01ca2e9f5e31d42e0de52560f1aa23ab3aa1cf3f02e036e222f693e73fa25a6eb324d6bb815263cc0564ba351ff38de4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-gemset

@@ -0,0 +1 @@
+html_aide

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jeremy Woertink
+
+MIT License
+
+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,73 @@
+# WARNING:
+this gem is in super early stages, and API may change many times without notice.  
+
+# HtmlAide
+
+Use the HtmlAide to validate html snippets or entire page markup
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'html_aide'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html_aide
+
+## Usage
+
+```ruby
+snippet = '<div id="taco"><strong>Taco</strong> Meat</div>'
+validator = HtmlAide::Validator.validate(snippet)
+validator.valid? #=> true
+validator.class #=> HtmlAide::SnippetValidator
+validator.errors #=> []
+tag = validator.element #=> HtmlAide::Element
+tag.attributes #=> {:id => "taco"}
+tag.name #= 'div'
+tag.text #=> 'Taco Meat'
+tag.children #=> [<#HtmlAide::Element>]
+tag.children.first.name #=> 'strong'
+tag.children.first.to_s #=> '<strong>Taco</strong>'
+tag.to_s #=> '<div id="taco"><strong>Taco</strong> Meat</div>'
+```
+
+```ruby
+snippet = '<div>Messed up </div'
+validator = HtmlAide::Validator.validate(snippet)
+validator.valid? #=> false
+validator.class #=> HtmlAide::SnippetValidator
+validator.errors #=> [<#HtmlAide::InvalidElementError>]
+error = validator.errors.first #=> HtmlAide::InvalidElementError
+error.message #=> 'Syntax Error in element'
+validator.element #=> HtmlAide::NullElement
+```
+
+possible helpers
+
+```ruby
+snippet = '<div id="taco"><strong>Taco</strong> Meat</div>'
+snippet.html? #=> true
+validator = snippet.validate_html!
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/html_aide/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## Notes & thoughts
+My current vision for this project is that you can pass in a snippet of html like `<a href="http://www.google.com">Google</a>` and it would return an object that knows the type of element along with the attributes as well as if it's valid or not. An invalid snippet would also return an object, but more of a `NullObject` or something like that which would act similar to a valid object, but would have `errors` method which would include any validation errors that occurred.
+
+Instantiating this `HtmlAide::Validation` object would give you the option to choose page or snippet. The full page validation would look for things like doctype, proper head tags, etc... We could proxy this to `tidy` which would need to be required, or somehow included.
+
+More advanced markup like `<ul><li>Item</li></ul>` could be passed where the return object (`HtmlAide::HTMLElement` ?) would have a `children` method that could return a collection of the nested elements.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/html_aide.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'html_aide/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "html_aide"
+  spec.version       = HtmlAide::VERSION
+  spec.authors       = ["Jeremy Woertink"]
+  spec.email         = ["jeremywoertink@gmail.com"]
+  spec.summary       = %q{Validate HTML snippets and markup.}
+  spec.description   = %q{Validate HTML snippets and markup.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "ox"
+  spec.add_dependency "nokogiri"
+end

data/lib/html_aide.rb

@@ -0,0 +1,11 @@
+require 'ox'
+require 'nokogiri'
+require 'html_aide/validator'
+require 'html_aide/version'
+require 'html_aide/invalid_element_error'
+require 'html_aide/element'
+require 'html_aide/null_element'
+require 'html_aide/snippet_validator'
+
+module HtmlAide
+end

data/lib/html_aide/element.rb

@@ -0,0 +1,34 @@
+module HtmlAide
+  class Element
+    attr_reader :proxy
+
+    def initialize(node)
+      @proxy = node
+      @markup = Ox.to_xml(node).gsub("\n", '')
+    end
+
+    def name
+      proxy.name
+    end
+
+    def attributes
+      proxy.attributes
+    end
+
+    def text
+      @text ||= Nokogiri::HTML.parse(@markup).text.strip
+    end
+
+    def to_s
+      @markup
+    end
+
+    def children
+      @children ||= proxy.nodes.reject {|n|
+        String === n}.collect do |node|
+        Element.new(node)
+      end
+    end
+
+  end
+end

data/lib/html_aide/invalid_element_error.rb

@@ -0,0 +1,12 @@
+module HtmlAide
+  class InvalidElementError
+
+    def initialize(error)
+      @message = error.to_s
+    end
+
+    def message
+      @clean_message ||= @message.gsub(/\[\w+?.+\]/, '').strip
+    end
+  end
+end

data/lib/html_aide/null_element.rb

@@ -0,0 +1,9 @@
+module HtmlAide
+  class NullElement < Element
+
+    def initialize
+      node = Struct.new(:name, :attributes, :nodes).new('Null', {}, [])
+      super(node)
+    end
+  end
+end

data/lib/html_aide/snippet_validator.rb

@@ -0,0 +1,38 @@
+module HtmlAide
+  class SnippetValidator
+
+    def initialize(markup = '')
+      @markup = markup
+      @errors = []
+      create_node_and_set_element
+    end
+
+    # returns the parsed element
+    def element
+      @element
+    end
+
+    # returns true if the element and all children are valid
+    def valid?
+      @valid
+    end
+
+    def errors
+      @errors
+    end
+
+    private
+
+    def create_node_and_set_element
+      begin
+        node = Ox.parse(@markup)
+        @element = Element.new(node)
+        @valid = true
+      rescue Ox::ParseError => e
+        @element = NullElement.new
+        @errors << InvalidElementError.new(e)
+        @valid = false
+      end
+    end
+  end
+end

data/lib/html_aide/validator.rb

@@ -0,0 +1,9 @@
+module HtmlAide
+  class Validator
+    # validate markup and return the instance that validated the markup based on format
+    # possible future formats [:snippet, :document]
+    def self.validate(markup, format = :snippet)
+      @validator = HtmlAide.const_get("#{format.to_s.capitalize}Validator").new(markup)
+    end
+  end
+end

data/lib/html_aide/version.rb

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

data/spec/element_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe HtmlAide::Element do
+  before do
+    @markup = '<div id="taco"><strong>Taco</strong> Meat</div>'
+    @node = Ox.parse(@markup)
+  end
+
+  subject { HtmlAide::Element.new(@node) }
+
+  describe '#name' do
+    it 'returns div' do
+      expect(subject.name).to eq 'div'
+    end
+  end
+
+  describe '#attributes' do
+    it 'returns a hash' do
+      expect(subject.attributes).to be_kind_of Hash
+    end
+
+    it 'has the key id with a value "taco"' do
+      expect(subject.attributes).to have_key :id
+      expect(subject.attributes[:id]).to eq 'taco'
+    end
+  end
+
+  describe '#text' do
+    it 'returns Taco Meat' do
+      expect(subject.text).to eq 'Taco Meat'
+    end
+  end
+
+  describe '#to_s' do
+    it 'returns the original markup' do
+      pending "Ox messes with the markup"
+      expect(subject.to_s).to eq @markup
+    end
+  end
+
+  describe '#children' do
+    it 'returns an array with 1 element' do
+      expect(subject.children.count).to eq 1
+    end
+
+    it 'contains a strong Element object' do
+      expect(subject.children.collect(&:name)).to include 'strong'
+    end
+
+    it 'has a child element with the text Taco' do
+      expect(subject.children.first.text).to eq 'Taco'
+    end
+  end
+
+end

data/spec/invalid_element_error_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe HtmlAide::InvalidElementError do
+
+  describe '#message' do
+    it 'returns the string "invalid format"' do
+      error = HtmlAide::InvalidElementError.new('invalid format')
+      expect(error.message).to eq 'invalid format'
+    end
+
+    it 'removes the cruft from Ox' do
+      error = HtmlAide::InvalidElementError.new('invalid format, document not terminated at line 1, column 5 [parse.c:785]')
+      expect(error.message).to eq 'invalid format, document not terminated at line 1, column 5'
+    end
+  end
+
+end

data/spec/snippet_validator_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe HtmlAide::SnippetValidator do
+
+  context 'with good markup' do
+    before do
+      @valid_markup = '<div id="taco">Taco Meat</div>'
+    end
+
+    subject { HtmlAide::SnippetValidator.new(@valid_markup) }
+
+    describe '#element' do
+      it 'returns HtmlAide::Element' do
+        expect(subject.element).to be_kind_of HtmlAide::Element
+      end
+    end
+
+    describe '#valid?' do
+      it 'returns true' do
+        expect(subject).to be_valid
+      end
+    end
+  end
+
+  context 'with bad markup' do
+    before do
+      @invalid_markup = '<div>Messed up </div'
+    end
+
+    subject { HtmlAide::SnippetValidator.new(@invalid_markup) }
+
+    describe '#element' do
+      it 'returns HtmlAide::NullElement' do
+        expect(subject.element).to be_kind_of HtmlAide::NullElement
+      end
+    end
+
+    describe '#valid?' do
+      it 'returns false' do
+        expect(subject).to_not be_valid
+      end
+    end
+
+    describe '#errors' do
+      it 'is an array with 1 error object' do
+        expect(subject.errors.count).to eq 1
+        expect(subject.errors.first).to be_kind_of HtmlAide::InvalidElementError
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'html_aide'
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+  config.order = "random"
+  config.color = true
+end

data/spec/validator_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe HtmlAide::Validator do
+
+  describe '#initialize' do
+    it 'returns a SnippetValidator' do
+      v = HtmlAide::Validator.validate('')
+      expect(v).to be_kind_of HtmlAide::SnippetValidator
+    end
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: html_aide
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Woertink
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ox
+  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: nokogiri
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- html_aide.gemspec
+- lib/html_aide.rb
+- lib/html_aide/element.rb
+- lib/html_aide/invalid_element_error.rb
+- lib/html_aide/null_element.rb
+- lib/html_aide/snippet_validator.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/validator_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Validate HTML snippets and markup.
+test_files:
+- spec/element_spec.rb
+- spec/invalid_element_error_spec.rb
+- spec/snippet_validator_spec.rb
+- spec/spec_helper.rb
+- spec/validator_spec.rb