Abstract out a bunch of Nokogiri extensions into new Niceogiri gem so…

… we can use them elsewhere
negativecode · Jun 9, 2011 · 44c112c · 44c112c
1 parent 38cc5d5
commit 44c112c
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 410 deletions.
diff --git a/blather.gemspec b/blather.gemspec
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency("eventmachine", ["~> 0.12.6"])
   s.add_dependency("nokogiri", [">= 1.4.0"])
+  s.add_dependency("niceogiri", [">= 0.0.3"])
   s.add_dependency("minitest", [">= 1.7.1"])
   s.add_dependency("activesupport", [">= 3.0.7"])
 

diff --git a/lib/blather.rb b/lib/blather.rb
@@ -2,7 +2,7 @@
 %w[
   rubygems
   eventmachine
-  nokogiri
+  niceogiri
   ipaddr
   digest/md5
   digest/sha1
@@ -13,7 +13,6 @@
 
   blather/core_ext/eventmachine
   blather/core_ext/ipaddr
-  blather/core_ext/nokogiri
 
   blather/errors
   blather/errors/sasl_error

diff --git a/lib/blather/core_ext/nokogiri.rb b/lib/blather/core_ext/nokogiri.rb
diff --git a/lib/blather/xmpp_node.rb b/lib/blather/xmpp_node.rb
@@ -2,15 +2,14 @@ module Blather
 
   # Base XML Node
   # All XML classes subclass XMPPNode it allows the addition of helpers
-  class XMPPNode < Nokogiri::XML::Node
+  class XMPPNode < Niceogiri::XML::Node
     # @private
     BASE_NAMES = %w[presence message iq].freeze
 
     # @private
     @@registrations = {}
 
-    class_inheritable_accessor  :registered_ns,
-                                :registered_name
+    class_inheritable_accessor :registered_ns, :registered_name
 
     # Register a new stanza class to a name and/or namespace
     #
@@ -32,8 +31,7 @@ def self.register(name, ns = nil)
     # @param [String, nil] xmlns the namespace the node belongs to
     # @return [Class, nil] the class appropriate for the name/ns combination
     def self.class_from_registration(name, ns = nil)
-      name = name.to_s
-      @@registrations[[name, ns]]
+      @@registrations[[name.to_s, ns]]
     end
 
     # Import an XML::Node to the appropriate class
@@ -58,43 +56,8 @@ def self.import(node)
     # @param [XML::Document, nil] doc the document to attach the node to. If
     # not provided one will be created
     # @return a new object with the registered name and namespace
-    def self.new(name = nil, doc = nil)
-      name ||= self.registered_name
-
-      node = super name.to_s, (doc || Nokogiri::XML::Document.new)
-      node.document.root = node unless doc
-      node.namespace = self.registered_ns unless BASE_NAMES.include?(name.to_s)
-      node
-    end
-
-    # Helper method to read an attribute
-    #
-    # @param [#to_sym] attr_name the name of the attribute
-    # @param [String, Symbol, nil] to_call the name of the method to call on
-    # the returned value
-    # @return nil or the value
-    def read_attr(attr_name, to_call = nil)
-      val = self[attr_name.to_sym]
-      val && to_call ? val.__send__(to_call) : val
-    end
-
-    # Helper method to write a value to an attribute
-    #
-    # @param [#to_sym] attr_name the name of the attribute
-    # @param [#to_s] value the value to set the attribute to
-    def write_attr(attr_name, value)
-      self[attr_name.to_sym] = value
-    end
-
-    # Helper method to read the content of a node
-    #
-    # @param [#to_sym] node the name of the node
-    # @param [String, Symbol, nil] to_call the name of the method to call on
-    # the returned value
-    # @return nil or the value
-    def read_content(node, to_call = nil)
-      val = content_from node.to_sym
-      val && to_call ? val.__send__(to_call) : val
+    def self.new(name = registered_name, doc = nil)
+      super name, doc, BASE_NAMES.include?(name.to_s) ? nil : self.registered_ns
     end
 
     # Turn the object into a proper stanza
@@ -103,133 +66,6 @@ def read_content(node, to_call = nil)
     def to_stanza
       self.class.import self
     end
-
-    # @private
-    alias_method :nokogiri_namespace=, :namespace=
-    # Attach a namespace to the node
-    #
-    # @overload namespace=(ns)
-    #   Attach an already created XML::Namespace
-    #   @param [XML::Namespace] ns the namespace object
-    # @overload namespace=(ns)
-    #   Create a new namespace and attach it
-    #   @param [String] ns the namespace uri
-    # @overload namespace=(namespaces)
-    #   Createa and add new namespaces from a hash
-    #   @param [Hash] namespaces a hash of prefix => uri pairs
-    def namespace=(namespaces)
-      case namespaces
-      when Nokogiri::XML::Namespace
-        self.nokogiri_namespace = namespaces
-      when String
-        self.add_namespace nil, namespaces
-      when Hash
-        if ns = namespaces.delete(nil)
-          self.add_namespace nil, ns
-        end
-        namespaces.each do |p, n|
-          ns = self.add_namespace p, n
-          self.nokogiri_namespace = ns
-        end
-      end
-    end
-
-    # Helper method to get the node's namespace
-    #
-    # @return [XML::Namespace, nil] The node's namespace object if it exists
-    def namespace_href
-      namespace.href if namespace
-    end
-
-    # Remove a child with the name and (optionally) namespace given
-    #
-    # @param [String] name the name or xpath of the node to remove
-    # @param [String, nil] ns the namespace the node is in
-    def remove_child(name, ns = nil)
-      child = xpath(name, ns).first
-      child.remove if child
-    end
-
-    # Remove all children with a given name regardless of namespace
-    #
-    # @param [String] name the name of the nodes to remove
-    def remove_children(name)
-      xpath("./*[local-name()='#{name}']").remove
-    end
-
-    # The content of the named node
-    #
-    # @param [String] name the name or xpath of the node
-    # @param [String, nil] ns the namespace the node is in
-    # @return [String, nil] the content of the node
-    def content_from(name, ns = nil)
-      child = xpath(name, ns).first
-      child.content if child
-    end
-
-    # Sets the content for the specified node.
-    # If the node exists it is updated. If not a new node is created
-    # If the node exists and the content is nil, the node will be removed
-    # entirely
-    #
-    # @param [String] node the name of the node to update/create
-    # @param [String, nil] content the content to set within the node
-    def set_content_for(node, content = nil)
-      if content
-        child = xpath(node).first
-        self << (child = XMPPNode.new(node, self.document)) unless child
-        child.content = content
-      else
-        remove_child node
-      end
-    end
-
-    alias_method :copy, :dup
-
-    # Inherit the attributes and children of an XML::Node
-    #
-    # @param [XML::Node] stanza the node to inherit
-    # @return [self]
-    def inherit(stanza)
-      set_namespace stanza.namespace if stanza.namespace
-      inherit_attrs stanza.attributes
-      stanza.children.each do |c|
-        self << (n = c.dup)
-        ns = n.namespace_definitions.find { |ns| ns.prefix == c.namespace.prefix }
-        n.namespace = ns if ns
-      end
-      self
-    end
-
-    # Inherit a set of attributes
-    #
-    # @param [Hash] attrs a hash of attributes to set on the node
-    # @return [self]
-    def inherit_attrs(attrs)
-      attrs.each  { |name, value| self[name] = value }
-      self
-    end
-
-    # The node as XML
-    #
-    # @return [String] XML representation of the node
-    def inspect
-      self.to_xml
-    end
-
-    # Check that a set of fields are equal between nodes
-    #
-    # @param [XMPPNode] other the other node to compare against
-    # @param [*#to_s] fields the set of fields to compare
-    # @return [Fixnum<-1,0,1>]
-    def eql?(o, *fields)
-      o.is_a?(self.class) && fields.all? { |f| self.__send__(f) == o.__send__(f) }
-    end
-
-    # @private
-    def ==(o)
-      eql?(o)
-    end
   end  # XMPPNode
 
 end  # Blather