niceogiri 0.0.3

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Niceogiri
+
+Copyright (c) 2011 Jeff Smick, Ben Langfeld
+ 
+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,31 @@
+# Niceogiri [ ![Build status](http://travis-ci.org/benlangfeld/niceogiri.png) ](http://travis-ci.org/benlangfeld/niceogiri)
+
+Some wrappers around and helpers for XML manipulation using Nokogiri
+
+## Project Pages
+
+* [Docs](http://rdoc.info/github/benlangfeld/Niceogiri)
+* [GitHub](https://github.com/benlangfeld/niceorigi)
+* [Gemcutter](http://gemcutter.org/gems/niceogiri)
+* [Google Group](http://groups.google.com/group/xmpp-blather)
+
+# Usage
+
+## Installation
+
+    gem install niceogiri
+
+# Contributions
+
+All contributions are welcome, even encouraged. However, contributions must be
+well tested. If you send me a branch name to merge that'll get my attention faster
+than a change set made directly on master.
+
+# Authors
+
+* [Jeff Smick](http://github.com/sprsquish)
+* [Ben Langfeld](http://github.com/benlangfeld)
+
+# Copyright
+
+Copyright (c) 2011 Jeff Smick, Ben Langfeld. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'spec'
+  test.pattern = 'spec/**/*_spec.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'spec'
+  test.pattern = 'spec/**/*_spec.rb'
+  test.rcov_opts += ['--exclude \/Library\/Ruby,spec\/', '--xrefs']
+  test.verbose = true
+end
+
+require 'yard'
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.options = ['--no-private', '-m', 'markdown', '-o', './doc/public/yard']
+end
+
+task :default => :test

data/lib/niceogiri/core_ext/nokogiri.rb

@@ -0,0 +1,44 @@
+# @private
+module Nokogiri
+  module XML
+
+    # Nokogiri::Node extensions
+    class Node
+      # Alias #name to #element_name so we can use #name in an XMPP Stanza context
+      alias_method :element_name, :name
+      alias_method :element_name=, :name=
+
+      alias_method :attr_set, :[]=
+      # Override Nokogiri's attribute setter to add the ability to kill an attribute
+      # by setting it to nil and to be able to lookup an attribute by symbol
+      #
+      # @param [#to_s] name the name of the attribute
+      # @param [#to_s, nil] value the new value or nil to remove it
+      def []=(name, value)
+        name = name.to_s
+        value.nil? ? remove_attribute(name) : attr_set(name, value.to_s)
+      end
+
+      alias_method :nokogiri_xpath, :xpath
+      # Override Nokogiri's #xpath method to add the ability to use symbols for lookup
+      # and namespace designation
+      def xpath(*paths)
+        paths[0] = paths[0].to_s
+
+        if paths.size > 1 && (namespaces = paths.pop).is_a?(Hash)
+          paths << namespaces.inject({}) { |h,v| h[v[0].to_s] = v[1]; h }
+        end
+
+        nokogiri_xpath *paths
+      end
+      alias_method :find, :xpath
+
+      # Return the first element at a specified xpath
+      # @see #xpath
+      def find_first(*paths)
+        xpath(*paths).first
+      end
+    end
+
+  end # XML
+end # Nokogiri

data/lib/niceogiri/version.rb

@@ -0,0 +1,3 @@
+module Niceogiri
+  VERSION = "0.0.3"
+end

data/lib/niceogiri/xml/node.rb

@@ -0,0 +1,176 @@
+module Niceogiri
+  module XML
+
+    # Base XML Node
+    # All XML classes subclass Node - it allows the addition of helpers
+    class Node < Nokogiri::XML::Node
+      # Create a new Node object
+      #
+      # @param [String, nil] name the element name
+      # @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 name and namespace
+      def self.new(name = nil, doc = nil, ns = nil)
+        super(name.to_s, (doc || Nokogiri::XML::Document.new)).tap do |node|
+          node.document.root = node unless doc
+          node.namespace = ns if ns
+        end
+      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
+      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
+          self.add_namespace nil, ns if ns = namespaces.delete(nil)
+          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 = Node.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] node the node to inherit
+      # @return [self]
+      def inherit(node)
+        set_namespace node.namespace if node.namespace
+        inherit_attrs node.attributes
+        node.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 [Node] 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  # Node
+  end # XML
+end  # Niceogiri

data/lib/niceogiri.rb

@@ -0,0 +1,7 @@
+%w{
+  nokogiri
+
+  niceogiri/version
+  niceogiri/core_ext/nokogiri
+  niceogiri/xml/node
+}.each { |f| require f}

data/niceogiri.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "niceogiri/version"
+
+Gem::Specification.new do |s|
+  s.name        = "niceogiri"
+  s.version     = Niceogiri::VERSION
+  s.authors     = ["Ben Langfeld", "Jeff Smick"]
+  s.email       = ["ben@langfeld.me", "sprsquish@gmail.com"]
+  s.homepage    = "https://github.com/benlangfeld/Niceogiri"
+  s.summary     = %q{Some additional niceties atop Nokogiri}
+  s.description = %q{Make dealing with XML less painful}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.rdoc_options = %w{--charset=UTF-8}
+  s.extra_rdoc_files = %w{LICENSE README.md}
+
+  s.add_dependency("nokogiri", [">= 1.4.0"])
+
+  s.add_development_dependency("minitest", ["~> 1.7.1"])
+  s.add_development_dependency("bundler", ["~> 1.0.0"])
+  s.add_development_dependency("rcov", ["~> 0.9.9"])
+  s.add_development_dependency("yard", ["~> 0.6.1"])
+  s.add_development_dependency("bluecloth", ["~> 2.1.0"])
+  s.add_development_dependency("rake")
+end

data/spec/niceogiri/xml/node_spec.rb

@@ -0,0 +1,204 @@
+require 'spec_helper'
+
+module Niceogiri
+  module XML
+    describe Node do
+      before { @doc = Nokogiri::XML::Document.new }
+
+      it 'generates a new node automatically setting the document' do
+        n = Node.new 'foo'
+        n.element_name.must_equal 'foo'
+        n.document.wont_equal @doc
+      end
+
+      it 'sets the new document root to the node' do
+        n = Node.new 'foo'
+        n.document.root.must_equal n
+      end
+
+      it 'does not set the document root if the document is provided' do
+        n = Node.new 'foo', @doc
+        n.document.root.wont_equal n
+      end
+
+      it 'generates a new node with the given document' do
+        n = Node.new 'foo', @doc
+        n.element_name.must_equal 'foo'
+        n.document.must_equal @doc
+      end
+
+      it 'provides an attribute reader' do
+        foo = Node.new
+        foo.read_attr(:bar).must_be_nil
+        foo[:bar] = 'baz'
+        foo.read_attr(:bar).must_equal 'baz'
+      end
+
+      it 'provides an attribute reader with converstion' do
+        foo = Node.new
+        foo.read_attr(:bar, :to_sym).must_be_nil
+        foo[:bar] = 'baz'
+        foo.read_attr(:bar, :to_sym).must_equal :baz
+      end
+
+      it 'provides an attribute writer' do
+        foo = Node.new
+        foo[:bar].must_be_nil
+        foo.write_attr(:bar, 'baz')
+        foo[:bar].must_equal 'baz'
+      end
+
+      it 'provides a content reader' do
+        foo = Node.new('foo')
+        foo << (bar = Node.new('bar', foo.document))
+        bar.content = 'baz'
+        foo.read_content(:bar).must_equal 'baz'
+      end
+
+      it 'provides a content reader that converts the value' do
+        foo = Node.new('foo')
+        foo << (bar = Node.new('bar', foo.document))
+        bar.content = 'baz'
+        foo.read_content(:bar, :to_sym).must_equal :baz
+      end
+
+      it 'provides a content writer' do
+        foo = Node.new('foo')
+        foo.set_content_for :bar, 'baz'
+        foo.content_from(:bar).must_equal 'baz'
+      end
+
+      it 'provides a content writer that removes a child when set to nil' do
+        foo = Node.new('foo')
+        foo << (bar = Node.new('bar', foo.document))
+        bar.content = 'baz'
+        foo.content_from(:bar).must_equal 'baz'
+        foo.xpath('bar').wont_be_empty
+
+        foo.set_content_for :bar, nil
+        foo.content_from(:bar).must_be_nil
+        foo.xpath('bar').must_be_empty
+      end
+
+      it 'provides "attr_accessor" for namespace' do
+        n = Node.new('foo')
+        n.namespace.must_be_nil
+
+        n.namespace = 'foo:bar'
+        n.namespace_href.must_equal 'foo:bar'
+      end
+
+      it 'will remove a child element' do
+        n = Node.new 'foo'
+        n << Node.new('bar', n.document)
+        n << Node.new('bar', n.document)
+
+        n.find(:bar).size.must_equal 2
+        n.remove_child 'bar'
+        n.find(:bar).size.must_equal 1
+      end
+
+      it 'will remove a child with a specific xmlns' do
+        n = Node.new 'foo'
+        n << Node.new('bar')
+        c = Node.new('bar')
+        c.namespace = 'foo:bar'
+        n << c
+
+        n.find(:bar).size.must_equal 1
+        n.find('//xmlns:bar', :xmlns => 'foo:bar').size.must_equal 1
+        n.remove_child '//xmlns:bar', :xmlns => 'foo:bar'
+        n.find(:bar).size.must_equal 1
+        n.find('//xmlns:bar', :xmlns => 'foo:bar').size.must_equal 0
+      end
+
+      it 'will remove all child elements' do
+        n = Node.new 'foo'
+        n << Node.new('bar')
+        n << Node.new('bar')
+
+        n.find(:bar).size.must_equal 2
+        n.remove_children 'bar'
+        n.find(:bar).size.must_equal 0
+      end
+
+      it 'provides a copy mechanism' do
+        n = Node.new 'foo'
+        n2 = n.copy
+        n2.object_id.wont_equal n.object_id
+        n2.element_name.must_equal n.element_name
+      end
+
+      it 'provides an inherit mechanism' do
+        n = Node.new 'foo'
+        n2 = Node.new 'foo'
+        n2.content = 'bar'
+        n2['foo'] = 'bar'
+
+        n.inherit(n2)
+        n['foo'].must_equal 'bar'
+        n.content.must_equal 'bar'
+        n2.to_s.must_equal n.to_s
+      end
+
+      it 'holds on to namespaces when inheriting content' do
+        n = Nokogiri::XML.parse('<message><bar:foo xmlns:bar="http://bar.com"></message>').root
+        n2 = Node.new('message').inherit n
+        n2.to_s.must_equal n.to_s
+      end
+
+      it 'provides a mechanism to inherit attrs' do
+        n = Node.new 'foo'
+        n2 = Node.new 'foo'
+        n2['foo'] = 'bar'
+
+        n.inherit_attrs(n2.attributes)
+        n['foo'].must_equal 'bar'
+      end
+
+      it 'has a content_from helper that pulls the content from a child node' do
+        f = Node.new('foo')
+        f << (b = Node.new('bar'))
+        b.content = 'content'
+        f.content_from(:bar).must_equal 'content'
+      end
+
+      it 'returns nil when sent #content_from and a missing node' do
+        f = Node.new('foo')
+        f.content_from(:bar).must_be_nil
+      end
+
+      it 'creates a new node and sets content when sent #set_content_for' do
+        f = Node.new('foo')
+        f.must_respond_to :set_content_for
+        f.xpath('bar').must_be_empty
+        f.set_content_for :bar, :baz
+        f.xpath('bar').wont_be_empty
+        f.xpath('bar').first.content.must_equal 'baz'
+      end
+
+      it 'removes a child node when sent #set_content_for with nil' do
+        f = Node.new('foo')
+        f << (b = Node.new('bar'))
+        f.must_respond_to :set_content_for
+        f.xpath('bar').wont_be_empty
+        f.set_content_for :bar, nil
+        f.xpath('bar').must_be_empty
+      end
+
+      it 'will change the content of an existing node when sent #set_content_for' do
+        f = Node.new('foo')
+        f << (b = Node.new('bar'))
+        b.content = 'baz'
+        f.must_respond_to :set_content_for
+        f.xpath('bar').wont_be_empty
+        f.xpath('bar').first.content.must_equal 'baz'
+        control = f.xpath('bar').first.pointer_id
+
+        f.set_content_for :bar, 'fiz'
+        f.xpath('bar').first.content.must_equal 'fiz'
+        f.xpath('bar').first.pointer_id.must_equal control
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'niceogiri'
+require 'minitest/spec'
+
+MiniTest::Unit.autorun

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification 
+name: niceogiri
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Ben Langfeld
+- Jeff Smick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-09 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 7
+        - 1
+        version: 1.7.1
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 9
+        version: 0.9.9
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: Make dealing with XML less painful
+email: 
+- ben@langfeld.me
+- sprsquish@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/niceogiri.rb
+- lib/niceogiri/core_ext/nokogiri.rb
+- lib/niceogiri/version.rb
+- lib/niceogiri/xml/node.rb
+- niceogiri.gemspec
+- spec/niceogiri/xml/node_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/benlangfeld/Niceogiri
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Some additional niceties atop Nokogiri
+test_files: 
+- spec/niceogiri/xml/node_spec.rb
+- spec/spec_helper.rb