nokogiri-fitzsimmons 1.5.5

data/ROADMAP.md

@@ -0,0 +1,86 @@
+# Roadmap for 2.0
+
+## 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
+
+* (closed) https://github.com/sparklemotion/nokogiri/issues/666
+  Some ideas for a better attributes API?
+
+
+## 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 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
+
+
+## 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?
+Would it help if we deprecated support for Ruby 1.8.7? 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.

data/Rakefile

@@ -0,0 +1,194 @@
+# -*- ruby -*-
+require 'rubygems'
+
+gem 'hoe'
+require 'hoe'
+Hoe.plugin :debugging
+Hoe.plugin :git
+Hoe.plugin :gemspec
+Hoe.plugin :bundler
+Hoe.add_include_dirs '.' # for ruby 1.9.2
+
+GENERATED_PARSER    = "lib/nokogiri/css/parser.rb"
+GENERATED_TOKENIZER = "lib/nokogiri/css/tokenizer.rb"
+CROSS_DIR           =  File.join(File.dirname(__FILE__), 'ports')
+
+def java?
+  !! (RUBY_PLATFORM =~ /java/)
+end
+
+require 'tasks/nokogiri.org'
+
+HOE = Hoe.spec 'nokogiri-fitzsimmons' do
+  developer 'Aaron Patterson', 'aaronp@rubyforge.org'
+  developer 'Mike Dalessio',   'mike.dalessio@gmail.com'
+  developer 'Yoko Harada',     'yokolet@gmail.com'
+  developer 'Tim Elliott',     'tle@holymonkey.com'
+  developer 'Justin Fitzsimmons', 'justin@fitzsimmons.ca'
+
+  self.readme_file  = ['README',    ENV['HLANG'], 'rdoc'].compact.join('.')
+  self.history_file = ['CHANGELOG', ENV['HLANG'], 'rdoc'].compact.join('.')
+
+  self.extra_rdoc_files = FileList['*.rdoc','ext/nokogiri/*.c']
+
+  self.clean_globs += [
+    'nokogiri.gemspec',
+    'lib/nokogiri/nokogiri.{bundle,jar,rb,so}',
+    'lib/nokogiri/1.{8,9}',
+    # GENERATED_PARSER,
+    # GENERATED_TOKENIZER
+  ]
+
+  self.extra_dev_deps += [
+    ["hoe-bundler",     ">= 1.1"],
+    ["hoe-debugging",   ">= 1.0.3"],
+    ["hoe-gemspec",     ">= 1.0"],
+    ["hoe-git",         ">= 1.4"],
+    ["mini_portile",    ">= 0.2.2"],
+    ["minitest",        "~> 2.2.2"],
+    ["rake",            ">= 0.9"],
+    ["rake-compiler",   "=  0.8.0"]
+  ]
+  if ! java?
+    self.extra_dev_deps += [
+      ["racc",            ">= 1.4.6"],
+      ["rexical",         ">= 1.0.5"]
+    ]
+  end
+
+  if java?
+    self.spec_extras = { :platform => 'java' }
+  else
+    self.spec_extras = {
+      :extensions => ["ext/nokogiri/extconf.rb"],
+      :required_ruby_version => '>= 1.8.7'
+    }
+  end
+
+  self.testlib = :minitest
+end
+
+# ----------------------------------------
+
+if java?
+  # TODO: clean this section up.
+  require "rake/javaextensiontask"
+  Rake::JavaExtensionTask.new("nokogiri", HOE.spec) do |ext|
+    jruby_home = RbConfig::CONFIG['prefix']
+    ext.ext_dir = 'ext/java'
+    ext.lib_dir = 'lib/nokogiri'
+    jars = ["#{jruby_home}/lib/jruby.jar"] + FileList['lib/*.jar']
+    ext.classpath = jars.map { |x| File.expand_path x }.join ':'
+  end
+
+  gem_build_path = File.join 'pkg', HOE.spec.full_name
+
+  task gem_build_path => [:compile] do
+    cp 'lib/nokogiri/nokogiri.jar', File.join(gem_build_path, 'lib', 'nokogiri')
+    HOE.spec.files += ['lib/nokogiri/nokogiri.jar']
+  end
+else
+  mingw_available = true
+  begin
+    require 'tasks/cross_compile'
+  rescue
+    mingw_available = false
+  end
+  require "rake/extensiontask"
+
+  HOE.spec.files.reject! { |f| f =~ %r{\.(java|jar)$} }
+
+  Rake::ExtensionTask.new("nokogiri", HOE.spec) do |ext|
+    ext.lib_dir = File.join(*['lib', 'nokogiri', ENV['FAT_DIR']].compact)
+    ext.config_options << ENV['EXTOPTS']
+    if mingw_available
+      ext.cross_compile  = true
+      ext.cross_platform = ["x86-mswin32-60", "x86-mingw32"]
+      ext.cross_config_options << "--with-xml2-include=#{File.join($recipes[:libxml2].path, 'include', 'libxml2')}"
+      ext.cross_config_options << "--with-xml2-lib=#{File.join($recipes[:libxml2].path, 'lib')}"
+      ext.cross_config_options << "--with-iconv-dir=#{$recipes[:libiconv].path}"
+      ext.cross_config_options << "--with-xslt-dir=#{$recipes[:libxslt].path}"
+      ext.cross_config_options << "--with-zlib-dir=#{CROSS_DIR}"
+    end
+  end
+end
+
+# ----------------------------------------
+
+desc "Generate css/parser.rb and css/tokenizer.rex"
+task 'generate' => [GENERATED_PARSER, GENERATED_TOKENIZER]
+task 'gem:spec' => 'generate' if Rake::Task.task_defined?("gem:spec")
+
+file GENERATED_PARSER => "lib/nokogiri/css/parser.y" do |t|
+  racc = RbConfig::CONFIG['target_os'] =~ /mswin32/ ? '' : `which racc`.strip
+  racc = "#{::RbConfig::CONFIG['bindir']}/racc" if racc.empty?
+  racc = %x{command -v racc}.strip if racc.empty?
+  sh "#{racc} -l -o #{t.name} #{t.prerequisites.first}"
+end
+
+file GENERATED_TOKENIZER => "lib/nokogiri/css/tokenizer.rex" do |t|
+  sh "rex --independent -o #{t.name} #{t.prerequisites.first}"
+end
+
+[:compile, :check_manifest].each do |task_name|
+  Rake::Task[task_name].prerequisites << GENERATED_PARSER
+  Rake::Task[task_name].prerequisites << GENERATED_TOKENIZER
+end
+
+# ----------------------------------------
+
+desc "set environment variables to build and/or test with debug options"
+task :debug do
+  ENV['NOKOGIRI_DEBUG'] = "true"
+  ENV['CFLAGS'] ||= ""
+  ENV['CFLAGS'] += " -DDEBUG"
+end
+
+require 'tasks/test'
+
+task :java_debug do
+  ENV['JAVA_OPTS'] = '-Xdebug -Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=y' if java? && ENV['JAVA_DEBUG']
+end
+
+Rake::Task[:test].prerequisites << :compile
+Rake::Task[:test].prerequisites << :java_debug
+Rake::Task[:test].prerequisites << :check_extra_deps unless java?
+if Hoe.plugins.include?(:debugging)
+  ['valgrind', 'valgrind:mem', 'valgrind:mem0'].each do |task_name|
+    Rake::Task["test:#{task_name}"].prerequisites << :compile
+  end
+end
+
+# ----------------------------------------
+
+desc "build a windows gem without all the ceremony."
+task "gem:windows" => "gem" do
+  cross_rubies = ["1.8.7-p330", "1.9.2-p136"]
+  ruby_cc_version = cross_rubies.collect { |_| _.split("-").first }.join(":") # e.g., "1.8.7:1.9.2"
+  rake_compiler_config_path = "#{ENV['HOME']}/.rake-compiler/config.yml"
+
+  unless File.exists? rake_compiler_config_path
+    raise "rake-compiler has not installed any cross rubies. try running 'env --unset=HOST rake-compiler cross-ruby VERSION=#{cross_rubies.first}'"
+  end
+  rake_compiler_config = YAML.load_file(rake_compiler_config_path)
+
+  # check that rake-compiler config contains the right patchlevels. see #279 for background,
+  # and http://blog.mmediasys.com/2011/01/22/rake-compiler-updated-list-of-supported-ruby-versions-for-cross-compilation/
+  # for more up-to-date docs.
+  cross_rubies.each do |version|
+    majmin, patchlevel = version.split("-")
+    rbconfig = "rbconfig-#{majmin}"
+    unless rake_compiler_config.key?(rbconfig) && rake_compiler_config[rbconfig] =~ /-#{patchlevel}/
+      raise "rake-compiler '#{rbconfig}' not #{patchlevel}. try running 'env --unset=HOST rake-compiler cross-ruby VERSION=#{version}'"
+    end
+  end
+
+  # verify that --export-all is in the 1.9 rbconfig. see #279,#374,#375.
+  rbconfig_19 = rake_compiler_config["rbconfig-1.9.2"]
+  raise "rbconfig #{rbconfig_19} needs --export-all in its DLDFLAGS value" if File.read(rbconfig_19).split("\n").grep(/CONFIG\["DLDFLAGS"\].*--export-all/).empty?
+
+  pkg_config_path = [:libxslt, :libxml2].collect { |pkg| File.join($recipes[pkg].path, "lib/pkgconfig") }.join(":")
+  sh("env PKG_CONFIG_PATH=#{pkg_config_path} RUBY_CC_VERSION=#{ruby_cc_version} rake cross native gem") || raise("build failed!")
+end
+
+# vim: syntax=Ruby

data/STANDARD_RESPONSES.md

@@ -0,0 +1,47 @@
+# Standard Responses to Requests
+
+These responses are needed often enough that I figured, let's just
+check them in for future reference and use.
+
+
+# Not enough information to help
+
+Hello!
+
+Thanks for asking this question! However, without more information,
+Team Nokogiri cannot reproduce your issue, and so we cannot offer much
+help.
+
+Please provide us with:
+
+* A self-contained script (one that we can run without modification,
+  and preferably without making external network connections).
+
+* Please note that you need to include the XML/HTML that you are
+  operating on.
+
+* The output of `nokogiri -v`, which will provide details about your
+  platform and versions of ruby, libxml2 and nokogiri.
+
+For more information about requesting help or reporting bugs, please
+take a look at http://bit.ly/nokohelp
+
+Thank you so much!
+
+
+# Not a bug
+
+Hello!
+
+Thanks for asking this question! Your request for assistance using
+Nokogiri will not go unanswered!
+
+However, Nokogiri's Github Issues is reserved for reporting bugs or
+submitting patches. If you ask your question on the mailing list, Team
+Nokogiri promises someone will provide you with an answer in a timely
+manner.
+
+If you'd like to read up on Team Nokogiri's rationale for this policy,
+please go to http://bit.ly/nokohelp.
+
+Thank you so much for understanding! And thank you for using Nokogiri.

data/Y_U_NO_GEMSPEC.md

@@ -0,0 +1,155 @@
+(note: this was originally a blog post published at http://blog.flavorjon.es/2012/03/y-u-no-gemspec.html)
+
+## tl;dr
+
+1. Team Nokogiri are not 10-foot-tall code-crunching robots, so `master` is usually unstable.
+2. Unstable code can corrupt your data and crash your application, which would make everybody look bad.
+3. Therefore, the _risk_ associated with using unstable code is severe; for you _and_ for Team Nokogiri.
+4. The absence of a gemspec is a risk mitigation tactic.
+5. You can always ask for an RC release.
+
+
+## Why Isn't There a Gemspec!?
+
+OHAI! Thank you for asking this question!
+
+Team Nokogiri gets asked this pretty frequently. Just a sample from
+the historical record:
+
+* [Issue #274](https://github.com/sparklemotion/nokogiri/issues/274)
+* [Issue #371](https://github.com/sparklemotion/nokogiri/issues/371)
+* [A commit removing nokogiri.gemspec](https://github.com/sparklemotion/nokogiri/commit/7f17a643a05ca381d65131515b54d4a3a61ca2e1#commitcomment-667477)
+* [A nokogiri-talk thread](http://groups.google.com/group/nokogiri-talk/browse_thread/thread/4706b002e492d23f)
+* [Another nokogiri-talk thread](http://groups.google.com/group/nokogiri-talk/browse_thread/thread/0b201bb80ea3eea0)
+
+Sometimes people imply that we've forgotten, or that we don't how to
+properly manage our codebase. Those people are super fun to respond
+to!
+
+We've gone back and forth a couple of times over the past few years,
+but the current policy of Team Nokogiri is to **not** provide a
+gemspec in the Github repo. This is a conscious choice, not an
+oversight.
+
+
+## But You Didn't Answer the Question!
+
+Ah, I was hoping you wouldn't notice. Well, OK, let's do this, if
+you're serious about it.
+
+I'd like to start by talking about _risk_. Specifically, the risk
+associated with using a known-unstable version of Nokogiri.
+
+
+### Risk
+
+One common way to evaluate the _risk_ of an incident is:
+
+    risk = probability x impact
+
+You can read more about this on [the internets](http://en.wikipedia.org/wiki/Risk_Matrix).
+
+The _risk_ associated with a Nokogiri bug could be loosely defined by
+answering the questions:
+
+* "How likely is it that a bug exists?" (probability)
+* "How severe will the consequences of a bug be?" (impact)
+
+
+### Probability
+
+The `master` branch should be considered unstable. Team Nokogiri are
+not 10-foot-tall code-crunching robots; we are humans. We make
+mistakes, and as a result, any arbitrary commit on `master` is likely
+to contain bugs.
+
+Just as an example, Nokogiri `master` was unstable for about five
+months between November 2011 and March 2012. It was unstable not
+because we were sloppy, or didn't care, but because the fixes were
+hard and unobvious.
+
+When we release Nokogiri, we test for memory leaks and invalid memory
+access on all kinds of platforms with many flavors of Ruby and lots of
+versions of libxml2. Because these tests are time-consuming, we don't
+run them on every commit. We run them often when preparing a release.
+
+If we're releasing Nokogiri, it means we think it's rock solid.
+
+And if we're not releasing it, it means there are probably bugs.
+
+
+### Impact
+
+Nokogiri is a gem with native extensions. This means it's not pure
+Ruby -- there's C or Java code being compiled and run, which means
+that there's always a chance that the gem will crash your application,
+or worse. Possible outcomes include:
+
+* leaking memory
+* corrupting data
+* making benign code crash (due to memory corruption)
+
+So, then, a bug in a native extension can have much worse downside
+than you might think. It's not just going to do something unexpected;
+it's possibly going to do terrible, awful things to your application
+and data.
+
+**Nobody** wants that to happen. Especially Team Nokogiri.
+
+
+### Risk, Redux
+
+So, if you accept the equation
+
+    risk = probability x impact
+
+and you believe me when I say that:
+
+* the probablility of a bug in unreleased code is high, and
+* the impact of a bug is likely to be severe,
+
+then you should easily see that the _risk_ associated with a bug in
+Nokogiri is quite high.
+
+Part of Team Nokogiri's job is to try to mitigate this risk. We have a
+number of tactics that we use to accomplish this:
+
+* we respond quickly to bug reports, particularly when they are possible memory issues
+* we review each others' commits
+* we have a thorough test suite, and we test-drive new features
+* we discuss code design and issues on a core developer mailing list
+* we use valgrind to test for memory issues (leaks and invalid
+  access) on multiple combinations of OS, libxml2 and Ruby
+* we package release candidates, and encourage devs to use them
+* **we do NOT commit a gemspec in our git repository**
+
+Yes, that's right, the absence of a gemspec is a risk mitigation
+tactic. Not only does Team Nokogiri not want to imply support for
+`master`, we want to **actively discourage** people from using
+it. Because it's not stable.
+
+
+## But I Want to Do It Anyway
+
+Another option, is to email the [nokogiri-talk
+list](http://groups.google.com/group/nokogiri-talk) and ask for a
+release candidate to be built. We're pretty accommodating if there's a
+bugfix that's a blocker for you. And if we can't release an RC, we'll
+tell you why.
+
+And in the end, nothing is stopping you from cloning the repo and
+generating a private gemspec. This is an extra step or two, but it has
+the benefit of making sure developers have thought through the costs
+and risks involved; and it tends to select for developers who know
+what they're doing.
+
+
+## In Conclusion
+
+Team Nokogiri takes stability very seriously. We want everybody who
+uses Nokogiri to have a pleasant experience. And so we want to make
+sure that you're using the best software we can make.
+
+Please keep in mind that we're trying very hard to do the right thing
+for all Nokogiri users out there in Rubyland. Nokogiri loves you very
+much, and we hope you love it back.