oga 1.2.3 → 1.3.0

data/lib/oga/xml/expanded_name.rb

@@ -0,0 +1,12 @@
+module Oga
+  module XML
+    module ExpandedName
+      # Returns the expanded name of the current Element or Attribute.
+      #
+      # @return [String]
+      def expanded_name
+        namespace_name ? "#{namespace_name}:#{name}" : name
+      end
+    end # ExpandedName
+  end # XML
+end # Oga

data/lib/oga/xml/html_void_elements.rb

@@ -1,12 +1,10 @@
 module Oga
   module XML
-    ##
     # Names of the HTML void elements that should be handled when HTML lexing
     # is enabled.
     #
     # @api private
     # @return [Oga::Whitelist]
-    #
     HTML_VOID_ELEMENTS = Whitelist.new(%w{
       area base br col command embed hr img input keygen link meta param source
       track wbr

data/lib/oga/xml/lexer.rb

@@ -1,6 +1,5 @@
 module Oga
   module XML
-    ##
     # Low level lexer that supports both XML and HTML (using an extra option).
     # To lex HTML input set the `:html` option to `true` when creating an
     # instance of the lexer:
@@ -46,7 +45,6 @@ module Oga
     # Strict mode only applies to XML documents.
     #
     # @private
-    #
     class Lexer
       # These are all constant/frozen to remove the need for String allocations
       # every time they are referenced in the lexer.
@@ -96,12 +94,9 @@ module Oga
         HTML_CLOSE_SELF[key.upcase] = HTML_CLOSE_SELF[key]
       end
 
-      ##
       # Names of HTML tags of which the content should be lexed as-is.
-      #
       LITERAL_HTML_ELEMENTS = Whitelist.new([HTML_SCRIPT, HTML_STYLE])
 
-      ##
       # @param [String|IO] data The data to lex. This can either be a String or
       #  an IO instance.
       #
@@ -113,7 +108,6 @@ module Oga
       #
       # @option options [TrueClass|FalseClass] :strict Enables/disables strict
       #  parsing of XML documents, disabled by default.
-      #
       def initialize(data, options = {})
         @data   = data
         @html   = options[:html]
@@ -122,11 +116,9 @@ module Oga
         reset
       end
 
-      ##
       # Resets the internal state of the lexer. Typically you don't need to
       # call this method yourself as its called by #lex after lexing a given
       # String.
-      #
       def reset
         @line     = 1
         @elements = []
@@ -136,12 +128,10 @@ module Oga
         reset_native
       end
 
-      ##
       # Yields the data to lex to the supplied block.
       #
       # @return [String]
       # @yieldparam [String]
-      #
       def read_data
         if @data.is_a?(String)
           yield @data
@@ -157,7 +147,6 @@ module Oga
         end
       end
 
-      ##
       # Gathers all the tokens for the input and returns them as an Array.
       #
       # This method resets the internal state of the lexer after consuming the
@@ -165,7 +154,6 @@ module Oga
       #
       # @see #advance
       # @return [Array]
-      #
       def lex
         tokens = []
 
@@ -178,7 +166,6 @@ module Oga
         tokens
       end
 
-      ##
       # Advances through the input and generates the corresponding tokens. Each
       # token is yielded to the supplied block.
       #
@@ -196,7 +183,6 @@ module Oga
       # @yieldparam [Symbol] type
       # @yieldparam [String] value
       # @yieldparam [Fixnum] line
-      #
       def advance(&block)
         @block = block
 
@@ -212,44 +198,33 @@ module Oga
         @block = nil
       end
 
-      ##
       # @return [TrueClass|FalseClass]
-      #
       def html?
         @html == true
       end
 
-      ##
       # @return [TrueClass|FalseClass]
-      #
       def strict?
         @strict
       end
 
-      ##
       # @return [TrueClass|FalseClass]
-      #
       def html_script?
         html? && current_element == HTML_SCRIPT
       end
 
-      ##
       # @return [TrueClass|FalseClass]
-      #
       def html_style?
         html? && current_element == HTML_STYLE
       end
 
       private
 
-      ##
       # @param [Fixnum] amount The amount of lines to advance.
-      #
       def advance_line(amount = 1)
         @line += amount
       end
 
-      ##
       # Calls the supplied block with the information of the current token.
       #
       # @param [Symbol] type The token type.
@@ -258,192 +233,145 @@ module Oga
       # @yieldparam [String] type
       # @yieldparam [String] value
       # @yieldparam [Fixnum] line
-      #
       def add_token(type, value = nil)
         @block.call(type, value, @line)
       end
 
-      ##
       # Returns the name of the element we're currently in.
       #
       # @return [String]
-      #
       def current_element
         @elements.last
       end
 
-      ##
       # Called when processing a single quote.
-      #
       def on_string_squote
         add_token(:T_STRING_SQUOTE)
       end
 
-      ##
       # Called when processing a double quote.
-      #
       def on_string_dquote
         add_token(:T_STRING_DQUOTE)
       end
 
-      ##
       # Called when processing the body of a string.
       #
       # @param [String] value The data between the quotes.
-      #
       def on_string_body(value)
         add_token(:T_STRING_BODY, value)
       end
 
-      ##
       # Called when a doctype starts.
-      #
       def on_doctype_start
         add_token(:T_DOCTYPE_START)
       end
 
-      ##
       # Called on the identifier specifying the type of the doctype.
       #
       # @param [String] value
-      #
       def on_doctype_type(value)
         add_token(:T_DOCTYPE_TYPE, value)
       end
 
-      ##
       # Called on the identifier specifying the name of the doctype.
       #
       # @param [String] value
-      #
       def on_doctype_name(value)
         add_token(:T_DOCTYPE_NAME, value)
       end
 
-      ##
       # Called on the end of a doctype.
-      #
       def on_doctype_end
         add_token(:T_DOCTYPE_END)
       end
 
-      ##
       # Called on an inline doctype block.
       #
       # @param [String] value
-      #
       def on_doctype_inline(value)
         add_token(:T_DOCTYPE_INLINE, value)
       end
 
-      ##
       # Called on the open CDATA tag.
-      #
       def on_cdata_start
         add_token(:T_CDATA_START)
       end
 
-      ##
       # Called on the closing CDATA tag.
-      #
       def on_cdata_end
         add_token(:T_CDATA_END)
       end
 
-      ##
       # Called for the body of a CDATA tag.
       #
       # @param [String] value
-      #
       def on_cdata_body(value)
         add_token(:T_CDATA_BODY, value)
       end
 
-      ##
       # Called on the open comment tag.
-      #
       def on_comment_start
         add_token(:T_COMMENT_START)
       end
 
-      ##
       # Called on the closing comment tag.
-      #
       def on_comment_end
         add_token(:T_COMMENT_END)
       end
 
-      ##
       # Called on a comment.
       #
       # @param [String] value
-      #
       def on_comment_body(value)
         add_token(:T_COMMENT_BODY, value)
       end
 
-      ##
       # Called on the start of an XML declaration tag.
-      #
       def on_xml_decl_start
         add_token(:T_XML_DECL_START)
       end
 
-      ##
       # Called on the end of an XML declaration tag.
-      #
       def on_xml_decl_end
         add_token(:T_XML_DECL_END)
       end
 
-      ##
       # Called on the start of a processing instruction.
-      #
       def on_proc_ins_start
         add_token(:T_PROC_INS_START)
       end
 
-      ##
       # Called on a processing instruction name.
       #
       # @param [String] value
-      #
       def on_proc_ins_name(value)
         add_token(:T_PROC_INS_NAME, value)
       end
 
-      ##
       # Called on the body of a processing instruction.
       #
       # @param [String] value
-      #
       def on_proc_ins_body(value)
         add_token(:T_PROC_INS_BODY, value)
       end
 
-      ##
       # Called on the end of a processing instruction.
-      #
       def on_proc_ins_end
         add_token(:T_PROC_INS_END)
       end
 
-      ##
       # Called on the name of an element.
       #
       # @param [String] name The name of the element, including namespace.
-      #
       def on_element_name(name)
         before_html_element_name(name) if html?
 
         add_element(name)
       end
 
-      ##
       # Handles inserting of any missing tags whenever a new HTML tag is opened.
       #
       # @param [String] name
-      #
       def before_html_element_name(name)
         close_current = HTML_CLOSE_SELF[current_element]
 
@@ -463,27 +391,21 @@ module Oga
         end
       end
 
-      ##
       # @param [String] name
-      #
       def add_element(name)
         @elements << name
 
         add_token(:T_ELEM_NAME, name)
       end
 
-      ##
       # Called on the element namespace.
       #
       # @param [String] namespace
-      #
       def on_element_ns(namespace)
         add_token(:T_ELEM_NS, namespace)
       end
 
-      ##
       # Called on the closing `>` of the open tag of an element.
-      #
       def on_element_open_end
         return unless html?
 
@@ -496,12 +418,10 @@ module Oga
         end
       end
 
-      ##
       # Called on the closing tag of an element.
       #
       # @param [String] name The name of the element (minus namespace
       #  prefix). This is not set for self closing tags.
-      #
       def on_element_end(name = nil)
         return if @elements.empty?
 
@@ -520,31 +440,25 @@ module Oga
         @elements.pop
       end
 
-      ##
       # Called on regular text values.
       #
       # @param [String] value
-      #
       def on_text(value)
         return if value.empty?
 
         add_token(:T_TEXT, value)
       end
 
-      ##
       # Called on attribute namespaces.
       #
       # @param [String] value
-      #
       def on_attribute_ns(value)
         add_token(:T_ATTR_NS, value)
       end
 
-      ##
       # Called on tag attributes.
       #
       # @param [String] value
-      #
       def on_attribute(value)
         add_token(:T_ATTR, value)
       end

data/lib/oga/xml/namespace.rb

@@ -1,9 +1,7 @@
 module Oga
   module XML
-    ##
     # The Namespace class contains information about XML namespaces such as the
     # name and URI.
-    #
     class Namespace
       # @return [String]
       attr_accessor :name
@@ -11,35 +9,27 @@ module Oga
       # @return [String]
       attr_accessor :uri
 
-      ##
       # @param [Hash] options
       #
       # @option options [String] :name
       # @option options [String] :uri
-      #
       def initialize(options = {})
         @name = options[:name]
         @uri  = options[:uri]
       end
 
-      ##
       # @return [String]
-      #
       def to_s
         name.to_s
       end
 
-      ##
       # @return [String]
-      #
       def inspect
         "Namespace(name: #{name.inspect} uri: #{uri.inspect})"
       end
 
-      ##
       # @param [Oga::XML::Namespace] other
       # @return [TrueClass|FalseClass]
-      #
       def ==(other)
         other.is_a?(self.class) && name == other.name && uri == other.uri
       end