nokogiri 1.0.0 → 1.6.8.1

data/README.md

@@ -0,0 +1,166 @@
+# Nokogiri
+
+* http://nokogiri.org
+* Installation: http://nokogiri.org/tutorials/installing_nokogiri.html
+* Tutorials:    http://nokogiri.org
+* README:       https://github.com/sparklemotion/nokogiri
+* Mailing List: https://groups.google.com/group/nokogiri-talk
+* Bug Reports:  https://github.com/sparklemotion/nokogiri/issues
+
+
+## Status
+
+[![Travis Build Status](https://travis-ci.org/sparklemotion/nokogiri.svg?branch=master)](https://travis-ci.org/sparklemotion/nokogiri)
+[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/sparklemotion/nokogiri?branch=master&svg=true)](https://ci.appveyor.com/project/flavorjones/nokogiri?branch=master)
+[![Code Climate](https://codeclimate.com/github/sparklemotion/nokogiri.png)](https://codeclimate.com/github/sparklemotion/nokogiri)
+[![Version Eye](https://www.versioneye.com/ruby/nokogiri/badge.png)](https://www.versioneye.com/ruby/nokogiri)
+
+
+## Description
+
+Nokogiri (鋸) is an HTML, XML, SAX, and Reader parser.  Among
+Nokogiri's many features is the ability to search documents via XPath
+or CSS3 selectors.
+
+
+## Features
+
+* XML/HTML DOM parser which handles broken HTML
+* XML/HTML SAX parser
+* XML/HTML Push parser
+* XPath 1.0 support for document searching
+* CSS3 selector support for document searching
+* XML/HTML builder
+* XSLT transformer
+
+Nokogiri parses and searches XML/HTML using native libraries (either C
+or Java, depending on your Ruby), which means it's fast and
+standards-compliant.
+
+
+## Installation
+
+If this doesn't work:
+
+```
+gem install nokogiri
+```
+
+then please start troubleshooting here:
+
+> http://www.nokogiri.org/tutorials/installing_nokogiri.html
+
+There are currently 1,237 Stack Overflow questions about Nokogiri
+installation. The vast majority of them are out of date and therefore
+incorrect. __Please do not use Stack Overflow.__
+
+Instead, [tell us](http://nokogiri.org/tutorials/getting_help.html)
+when the above instructions don't work for you. This allows us to both
+help you directly and improve the documentation.
+
+
+### Binary packages
+
+Binary packages are available for some distributions.
+
+* Debian: https://packages.debian.org/sid/ruby-nokogiri
+* SuSE: https://download.opensuse.org/repositories/devel:/languages:/ruby:/extensions/
+* Fedora: http://s390.koji.fedoraproject.org/koji/packageinfo?packageID=6756
+
+
+## Support
+
+There are open-source tutorials (to which we invite contributions!) here: http://nokogiri.org/tutorials
+
+* The Nokogiri mailing list is active: https://groups.google.com/group/nokogiri-talk
+* The Nokogiri bug tracker is here: https://github.com/sparklemotion/nokogiri/issues
+* Before filing a bug report, please read our submission guidelines: http://nokogiri.org/tutorials/getting_help.html
+* The IRC channel is #nokogiri on freenode.
+
+
+## Synopsis
+
+Nokogiri is a large library, but here is example usage for parsing and examining a document:
+
+```ruby
+#! /usr/bin/env ruby
+
+require 'nokogiri'
+require 'open-uri'
+
+# Fetch and parse HTML document
+doc = Nokogiri::HTML(open('http://www.nokogiri.org/tutorials/installing_nokogiri.html'))
+
+puts "### Search for nodes by css"
+doc.css('nav ul.menu li a', 'article h2').each do |link|
+  puts link.content
+end
+
+puts "### Search for nodes by xpath"
+doc.xpath('//nav//ul//li/a', '//article//h2').each do |link|
+  puts link.content
+end
+
+puts "### Or mix and match."
+doc.search('nav ul.menu li a', '//article//h2').each do |link|
+  puts link.content
+end
+```
+
+
+## Requirements
+
+* Ruby 1.9.3 or higher, including any development packages necessary
+  to compile native extensions.
+
+* In Nokogiri 1.6.0 and later libxml2 and libxslt are bundled with the
+  gem, but if you want to use the system versions:
+
+  * at install time, set the environment variable
+    `NOKOGIRI_USE_SYSTEM_LIBRARIES` or else use the
+    `--use-system-libraries` argument. (See
+    http://nokogiri.org/tutorials/installing_nokogiri.html#using_your_system_libraries
+    for specifics.)
+
+  * libxml2 >=2.6.21 with iconv support
+    (libxml2-dev/-devel is also required)
+
+  * libxslt, built with and supported by the given libxml2
+    (libxslt-dev/-devel is also required)
+
+
+## Encoding
+
+Strings are always stored as UTF-8 internally.  Methods that return
+text values will always return UTF-8 encoded strings.  Methods that
+return a string containing markup (like `to_xml`, `to_html` and
+`inner_html`) will return a string encoded like the source document.
+
+__WARNING__
+
+Some documents declare one encoding, but actually use a different
+one. In these cases, which encoding should the parser choose?
+
+Data is just a stream of bytes. Humans add meaning to that stream. Any
+particular set of bytes could be valid characters in multiple
+encodings, so detecting encoding with 100% accuracy is not
+possible. `libxml2` does its best, but it can't be right all the time.
+
+If you want Nokogiri to handle the document encoding properly, your
+best bet is to explicitly set the encoding.  Here is an example of
+explicitly setting the encoding to EUC-JP on the parser:
+
+```ruby
+  doc = Nokogiri.XML('<foo><bar /><foo>', nil, 'EUC-JP')
+```
+
+## Development
+
+```bash
+  bundle install
+  bundle exec rake
+```
+
+## License
+
+MIT. See the `LICENSE.txt` file.

data/ROADMAP.md

@@ -0,0 +1,111 @@
+# Roadmap for API Changes
+
+## overhaul serialize/pretty printing API
+
+* https://github.com/sparklemotion/nokogiri/issues/530
+  XHTML formatting can't be turned off
+
+* https://github.com/sparklemotion/nokogiri/issues/415
+  XML formatting should be no formatting
+
+
+## overhaul and optimize the SAX parsing
+
+* see fairy wing throwdown - SAX parsing is wicked slow.
+
+
+## Node should not be Enumerable; and should have a better attributes API
+
+* https://github.com/sparklemotion/nokogiri/issues/679
+  Mixing in Enumerable has some unintended consequences; plus we want to improve the attributes API
+
+* Some ideas for a better attributes API?
+  * (closed) https://github.com/sparklemotion/nokogiri/issues/666
+  * https://github.com/sparklemotion/nokogiri/issues/765
+
+
+## improve CSS query parsing
+
+* https://github.com/sparklemotion/nokogiri/issues/528
+  support `:not()` with a nontrivial argument, like `:not(div p.c)`
+
+* https://github.com/sparklemotion/nokogiri/issues/451
+  chained :not pseudoselectors
+
+* better jQuery selector and CSS pseudo-selector support:
+  * https://github.com/sparklemotion/nokogiri/issues/621
+  * https://github.com/sparklemotion/nokogiri/issues/342
+  * https://github.com/sparklemotion/nokogiri/issues/628
+  * https://github.com/sparklemotion/nokogiri/issues/652
+  * https://github.com/sparklemotion/nokogiri/issues/688
+
+* https://github.com/sparklemotion/nokogiri/issues/394
+  nth-of-type is wrong, and possibly other selectors as well
+
+* https://github.com/sparklemotion/nokogiri/issues/309
+  incorrect query being executed
+
+* https://github.com/sparklemotion/nokogiri/issues/350
+  :has is wrong?
+
+
+## DocumentFragment
+
+* there are a few tickets about searches not working properly if you
+  use or do not use the context node as part of the search.
+  - https://github.com/sparklemotion/nokogiri/issues/213
+  - https://github.com/sparklemotion/nokogiri/issues/370
+  - https://github.com/sparklemotion/nokogiri/issues/454
+  - https://github.com/sparklemotion/nokogiri/issues/572
+  could we fix this by making DocumentFragment be a subclass of NodeSet?
+
+
+## Better Syntax for custom XPath function handler
+
+* https://github.com/sparklemotion/nokogiri/pull/464
+
+
+## Better Syntax around Node#xpath and NodeSet#xpath
+
+* look at those methods, and use of Node#extract_params in Node#{css,search}
+  * we should standardize on a hash of options for these and other calls
+* what should NodeSet#xpath return?
+  * https://github.com/sparklemotion/nokogiri/issues/656
+
+## Encoding
+
+We have a lot of issues open around encoding. How bad are things?
+Somebody who knows encoding well should head this up.
+
+* Extract EncodingReader as a real object that can be injected
+  https://groups.google.com/forum/#!msg/nokogiri-talk/arJeAtMqvkg/tGihB-iBRSAJ
+
+
+## Reader
+
+It's fundamentally broken, in that we can't stop people from crashing
+their application if they want to use object reference unsafely.
+
+
+## Class methods that require Document
+
+There are a few methods, like `Nokogiri::XML::Comment.new` that
+require a Document object.
+
+We should probably make Document instance methods to wrap this, since
+it's a non-obvious expectation and thus fails as a convention.
+
+So, instead, let's make alternative methods like
+`Nokogiri::XML::Document#new_comment`, and recommend those as the
+proper convention.
+
+
+## `collect_namespaces` is just broken
+
+`collect_namespaces` is returning a hash, which means it can't return
+namespaces with the same prefix. See this issue for background:
+
+> https://github.com/sparklemotion/nokogiri/issues/885
+
+Do we care? This seems like a useless method, but then again I hate
+XML, so what do I know?