sparklemotion/nokogiri

View on GitHub
lib/nokogiri/html5/builder.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

module Nokogiri
  module HTML5
    ###
    # Nokogiri HTML5 builder is used for building HTML documents. It is very similar to the
    # Nokogiri::XML::Builder.  In fact, you should go read the documentation for
    # Nokogiri::XML::Builder before reading this documentation.
    #
    # The construction behavior is identical to HTML4::Builder, but HTML5 documents implement the
    # [HTML5 standard's serialization
    # algorithm](https://www.w3.org/TR/2008/WD-html5-20080610/serializing.html).
    #
    # == Synopsis:
    #
    # Create an HTML5 document with a body that has an onload attribute, and a
    # span tag with a class of "bold" that has content of "Hello world".
    #
    #   builder = Nokogiri::HTML5::Builder.new do |doc|
    #     doc.html {
    #       doc.body(:onload => 'some_func();') {
    #         doc.span.bold {
    #           doc.text "Hello world"
    #         }
    #       }
    #     }
    #   end
    #   puts builder.to_html
    #
    # The HTML5 builder inherits from the XML builder, so make sure to read the
    # Nokogiri::XML::Builder documentation.
    class Builder < Nokogiri::XML::Builder
      ###
      # Convert the builder to HTML
      def to_html
        @doc.to_html
      end
    end
  end
end