oga 1.0.2 → 1.0.3

data/lib/oga/version.rb

@@ -1,3 +1,3 @@
 module Oga
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end # Oga

data/lib/oga/whitelist.rb

@@ -7,14 +7,14 @@ module Oga
     # @return [TrueClass|FalseClass]
     #
     def allow?(name)
-      return names.include?(name)
+      names.include?(name)
     end
 
     ##
     # @return [Oga::Blacklist]
     #
     def to_blacklist
-      return Blacklist.new(names)
+      Blacklist.new(names)
     end
   end # Whitelist
 end # Oga

data/lib/oga/xml/attribute.rb

@@ -3,19 +3,17 @@ module Oga
     ##
     # Class for storing information about a single XML attribute.
     #
-    # @!attribute [rw] name
-    #  The name of the attribute.
-    #  @return [String]
-    #
-    # @!attribute [rw] namespace_name
-    #  @return [String]
-    #
-    # @!attribute [r] element
-    #  The element this attribute belongs to.
-    #  @return [Oga::XML::Element]
-    #
     class Attribute
-      attr_accessor :name, :namespace_name, :element
+      # The name of the attribute.
+      # @return [String]
+      attr_accessor :name
+
+      # @return [String]
+      attr_accessor :namespace_name
+
+      # The element this attribute belongs to.
+      # @return [Oga::XML::Element]
+      attr_accessor :element
 
       ##
       # The default namespace available to all attributes. This namespace can
@@ -59,7 +57,7 @@ module Oga
           end
         end
 
-        return @namespace
+        @namespace
       end
 
       ##
@@ -81,14 +79,14 @@ module Oga
           @decoded = true
         end
 
-        return @value
+        @value
       end
 
       ##
       # @return [String]
       #
       def text
-        return value.to_s
+        value.to_s
       end
 
       alias_method :to_s, :text
@@ -105,7 +103,7 @@ module Oga
 
         enc_value = value ? Entities.encode(value) : nil
 
-        return %Q(#{full_name}="#{enc_value}")
+        %Q(#{full_name}="#{enc_value}")
       end
 
       ##
@@ -122,7 +120,7 @@ module Oga
           end
         end
 
-        return "Attribute(#{segments.join(' ')})"
+        "Attribute(#{segments.join(' ')})"
       end
 
       private
@@ -131,7 +129,7 @@ module Oga
       # @return [TrueClass|FalseClass]
       #
       def html?
-        return !!@element && @element.html?
+        !!@element && @element.html?
       end
     end # Attribute
   end # XML

data/lib/oga/xml/cdata.rb

@@ -10,7 +10,7 @@ module Oga
       # @return [String]
       #
       def to_xml
-        return "<![CDATA[#{text}]]>"
+        "<![CDATA[#{text}]]>"
       end
     end # Cdata
   end # XML

data/lib/oga/xml/character_node.rb

@@ -4,10 +4,8 @@ module Oga
     # Base class for nodes that represent a text-like value such as Text and
     # Comment nodes.
     #
-    # @!attribute [rw] text
-    #  @return [String]
-    #
     class CharacterNode < Node
+      # @return [String]
       attr_accessor :text
 
       ##
@@ -25,14 +23,14 @@ module Oga
       # @return [String]
       #
       def to_xml
-        return text.to_s
+        text.to_s
       end
 
       ##
       # @return [String]
       #
       def inspect
-        return "#{self.class.to_s.split('::').last}(#{text.inspect})"
+        "#{self.class.to_s.split('::').last}(#{text.inspect})"
       end
     end # CharacterNode
   end # XML

data/lib/oga/xml/comment.rb

@@ -10,7 +10,7 @@ module Oga
       # @return [String]
       #
       def to_xml
-        return "<!--#{text}-->"
+        "<!--#{text}-->"
       end
     end # Comment
   end # XML

data/lib/oga/xml/doctype.rb

@@ -3,28 +3,26 @@ module Oga
     ##
     # Class used for storing information about Doctypes.
     #
-    # @!attribute [rw] name
-    #  The name of the doctype (e.g. "HTML").
-    #  @return [String]
-    #
-    # @!attribute [rw] type
-    #  The type of the doctype (e.g. "PUBLIC").
-    #  @return [String]
-    #
-    # @!attribute [rw] public_id
-    #  The public ID of the doctype.
-    #  @return [String]
-    #
-    # @!attribute [rw] system_id
-    #  The system ID of the doctype.
-    #  @return [String]
-    #
-    # @!attribute [rw] inline_rules
-    #  The inline doctype rules.
-    #  @return [String]
-    #
     class Doctype
-      attr_accessor :name, :type, :public_id, :system_id, :inline_rules
+      # The name of the doctype (e.g. "HTML").
+      # @return [String]
+      attr_accessor :name
+
+      # The type of the doctype (e.g. "PUBLIC").
+      # @return [String]
+      attr_accessor :type
+
+      # The public ID of the doctype.
+      # @return [String]
+      attr_accessor :public_id
+
+      # The system ID of the doctype.
+      # @return [String]
+      attr_accessor :system_id
+
+      # The inline doctype rules.
+      # @return [String]
+      attr_accessor :inline_rules
 
       ##
       # @example
@@ -58,7 +56,7 @@ module Oga
         segments << %Q{ "#{system_id}"} if system_id
         segments << " [#{inline_rules}]" if inline_rules
 
-        return segments + '>'
+        segments + '>'
       end
 
       ##
@@ -77,7 +75,7 @@ module Oga
           end
         end
 
-        return "Doctype(#{segments.join(' ')})"
+        "Doctype(#{segments.join(' ')})"
       end
     end # Doctype
   end # XML

data/lib/oga/xml/document.rb

@@ -4,24 +4,18 @@ module Oga
     # Class used for storing information about an entire XML document. This
     # includes the doctype, XML declaration, child nodes and more.
     #
-    # @!attribute [rw] doctype
-    #  The doctype of the document.
-    #  @return [Oga::XML::Doctype]
-    #
-    # @!attribute [rw] xml_declaration
-    #  The XML declaration of the document.
-    #  @return [Oga::XML::XmlDeclaration]
-    #
-    # @!attribute [r] type
-    #  The document type, either `:xml` or `:html`.
-    #  @return [Symbol]
-    #
     class Document
       include Querying
       include Traversal
 
-      attr_accessor :doctype, :xml_declaration
+      # @return [Oga::XML::Doctype]
+      attr_accessor :doctype
+
+      # @return [Oga::XML::XmlDeclaration]
+      attr_accessor :xml_declaration
 
+      # The document type, either `:xml` or `:html`.
+      # @return [Symbol]
       attr_reader :type
 
       ##
@@ -44,7 +38,7 @@ module Oga
       # @return [Oga::XML::NodeSet]
       #
       def children
-        return @children ||= NodeSet.new([], self)
+        @children ||= NodeSet.new([], self)
       end
 
       ##
@@ -76,14 +70,14 @@ module Oga
           xml = xml_declaration.to_xml + "\n" + xml.strip
         end
 
-        return xml
+        xml
       end
 
       ##
       # @return [TrueClass|FalseClass]
       #
       def html?
-        return type.equal?(:html)
+        type.equal?(:html)
       end
 
       ##
@@ -103,7 +97,7 @@ module Oga
           end
         end
 
-        return <<-EOF.strip
+        <<-EOF.strip
 Document(
   #{segments.join("\n  ")}
 )

data/lib/oga/xml/element.rb

@@ -4,29 +4,19 @@ module Oga
     # Class that contains information about an XML element such as the name,
     # attributes and child nodes.
     #
-    # @!attribute [rw] name
-    #  The name of the element.
-    #  @return [String]
-    #
-    # @!attribute [r] namespace_name
-    #  The name of the namespace.
-    #  @return [String]
-    #
-    # @!attribute [rw] attributes
-    #  The attributes of the element.
-    #  @return [Array<Oga::XML::Attribute>]
-    #
-    # @!attribute [rw] namespaces
-    #  The registered namespaces.
-    #  @return [Hash]
-    #
     class Element < Node
       include Querying
 
+      # @return [String]
       attr_reader :namespace_name
 
-      attr_accessor :name, :attributes
+      # @return [String]
+      attr_accessor :name
+
+      # @return [Array<Oga::XML::Attribute>]
+      attr_accessor :attributes
 
+      # @return [Hash]
       attr_writer :namespaces
 
       ##
@@ -105,7 +95,7 @@ module Oga
       def get(name)
         found = attribute(name)
 
-        return found ? found.value : nil
+        found ? found.value : nil
       end
 
       ##
@@ -175,7 +165,7 @@ module Oga
           @namespace = available[namespace_name] || available[XMLNS_PREFIX]
         end
 
-        return @namespace
+        @namespace
       end
 
       ##
@@ -185,7 +175,7 @@ module Oga
       # @return [Hash]
       #
       def namespaces
-        return html? ? {} : @namespaces
+        html? ? {} : @namespaces
       end
 
       ##
@@ -195,7 +185,7 @@ module Oga
       # @return [TrueClass|FalseClass]
       #
       def default_namespace?
-        return namespace == DEFAULT_NAMESPACE || namespace.nil?
+        namespace == DEFAULT_NAMESPACE || namespace.nil?
       end
 
       ##
@@ -204,7 +194,7 @@ module Oga
       # @return [String]
       #
       def text
-        return children.text
+        children.text
       end
 
       ##
@@ -219,7 +209,7 @@ module Oga
           text << node.text
         end
 
-        return text
+        text
       end
 
       ##
@@ -235,7 +225,7 @@ module Oga
           nodes << child if child.is_a?(Text)
         end
 
-        return nodes
+        nodes
       end
 
       ##
@@ -290,7 +280,7 @@ module Oga
           segments << "#{attr}: #{value.inspect}"
         end
 
-        return "Element(#{segments.join(' ')})"
+        "Element(#{segments.join(' ')})"
       end
 
       ##
@@ -339,7 +329,7 @@ module Oga
           end
         end
 
-        return @available_namespaces
+        @available_namespaces
       end
 
       ##
@@ -356,7 +346,7 @@ module Oga
           self_closing = false
         end
 
-        return self_closing
+        self_closing
       end
 
       ##
@@ -411,7 +401,7 @@ module Oga
       def split_name(name)
         segments = name.to_s.split(':')
 
-        return segments.pop, segments.pop
+        [segments.pop, segments.pop]
       end
 
       ##
@@ -431,7 +421,7 @@ module Oga
           ns_matches = true
         end
 
-        return name_matches && ns_matches
+        name_matches && ns_matches
       end
     end # Element
   end # XML

data/lib/oga/xml/entities.rb

@@ -42,7 +42,7 @@ module Oga
       #
       # @return [Regexp]
       #
-      REGULAR_ENTITY = /&[a-zA-Z]+;/
+      REGULAR_ENTITY = /&[a-zA-Z0-9]+;/
 
       ##
       # Regexp for matching XML/HTML entities such as "&".
@@ -74,7 +74,7 @@ module Oga
           end
         end
 
-        return input
+        input
       end
 
       ##
@@ -85,7 +85,7 @@ module Oga
       # @return [String]
       #
       def self.encode(input, mapping = ENCODE_MAPPING)
-        return input.gsub(ENCODE_REGEXP, mapping)
+        input.gsub(ENCODE_REGEXP, mapping)
       end
     end # Entities
   end # XML