ruby-readability 0.5.7 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c4e7dd91c7e7dbd34238150565daacd14d19c4f
+  data.tar.gz: fa8ef220bba559a5e3621de373bc3cb5295f9583
+SHA512:
+  metadata.gz: 37f7e00448f2390cf87166899d967ad8521413b727e89a97f977310ceedf51e2f4a99201b046484bde645257ff9828ea3e1365056575776f107f50d0d1a8d15d
+  data.tar.gz: 2e4bcfceac1c8be2b2cd9cc9ed725f459f57bebfc87beaf940e972a2ed8b37e73d5681955b71a8cebc9ffee246e92b3f33cc8c983ec2ee97b201268149555e73

data/.gitignore

@@ -5,3 +5,6 @@ Gemfile.lock
 pkg/*
 .idea
 .rvmrc
+.ruby-gemset
+.ruby-version
+.yardoc/

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+script: "bundle exec rspec"

data/.yardopts

@@ -0,0 +1,3 @@
+--readme README.markdown
+-
+LICENSE

data/Gemfile

@@ -1,6 +1,7 @@
 source "http://rubygems.org"
 
 gem 'fastimage', '~> 1.2.13'
+gem 'rake'
 
 group :test do
   gem "fakeweb",      "~> 1.3.0"

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,103 @@
+Ruby Readability
+================
+
+Ruby Readability is a tool for extracting the primary readable content of a
+webpage. It is a Ruby port of arc90's readability project.
+
+Build Status
+------------
+
+[![Build Status](https://travis-ci.org/cantino/ruby-readability.png)](https://travis-ci.org/cantino/ruby-readability)
+
+Install
+-------
+
+Command line:
+
+    (sudo) gem install ruby-readability
+
+Bundler:
+
+    gem "ruby-readability", :require => 'readability'
+
+
+Example
+-------
+
+    require 'rubygems'
+    require 'readability'
+    require 'open-uri'
+
+    source = open('http://lab.arc90.com/experiments/readability/').read
+    puts Readability::Document.new(source).content
+
+
+Options
+-------
+
+You may provide options to `Readability::Document.new`, including:
+
+* `:tags`: the base whitelist of tags to sanitize, defaults to `%w[div p]`;
+* `:remove_empty_nodes`: remove `<p>` tags that have no text content; also
+  removes `<p>` tags that contain only images;
+* `:attributes`: whitelist of allowed attributes;
+* `:debug`: provide debugging output, defaults false;
+* `:encoding`: if the page is of a known encoding, you can specify it; if left
+   unspecified, the encoding will be guessed (only in Ruby 1.9.x). If you wish
+   to disable guessing, supply `:do_not_guess_encoding => true`;
+* `:html_headers`: in Ruby 1.9.x these will be passed to the
+   `guess_html_encoding` gem to aid with guessing the HTML encoding;
+* `:ignore_image_format`: for use with .images.  For example:
+  `:ignore_image_format => ["gif", "png"]`;
+* `:min_image_height`: set a minimum image height for `#images`;
+* `:min_image_width`: set a minimum image width for `#images`.
+
+
+Command Line Tool
+-----------------
+
+Readability comes with a command-line tool for experimentation in
+`bin/readability`.
+
+    Usage: readability [options] URL
+        -d, --debug                      Show debug output
+        -i, --images                     Keep images and links
+        -h, --help                       Show this message
+
+
+Images
+------
+
+You can get a list of images in the content area with `Document#images`. This
+feature requires that the `fastimage` gem be installed.
+
+    rbody = Readability::Document.new(body, :tags => %w[div p img a], :attributes => %w[src href], :remove_empty_nodes => false)
+    rbody.images
+
+
+Potential Issues
+----------------
+
+If you're on a Mac and are getting segmentation faults, see the discussion at
+<https://github.com/sparklemotion/nokogiri/issues/404> and consider updating
+your version of `libxml2`. Version 2.7.8 of `libxml2`, installed with `brew`,
+worked for me:
+
+    gem install nokogiri -- --with-xml2-include=/usr/local/Cellar/libxml2/2.7.8/include/libxml2 --with-xml2-lib=/usr/local/Cellar/libxml2/2.7.8/lib --with-xslt-dir=/usr/local/Cellar/libxslt/1.1.26
+
+Or if you're using bundler and Rails 3, you can run this command to make
+bundler always globally build `nokogiri` this way:
+
+    bundle config build.nokogiri -- --with-xml2-include=/usr/local/Cellar/libxml2/2.7.8/include/libxml2 --with-xml2-lib=/usr/local/Cellar/libxml2/2.7.8/lib --with-xslt-dir=/usr/local/Cellar/libxslt/1.1.26
+
+
+License
+-------
+
+This code is under the Apache License 2.0. See <http://www.apache.org/licenses/LICENSE-2.0>.
+
+Ruby port by cantino, starrhorne, libc, and iterationlabs. Special thanks to fizx and marcosinger.
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/cantino/ruby-readability/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/lib/readability.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'rubygems'
 require 'nokogiri'
 require 'guess_html_encoding'
@@ -22,7 +24,7 @@ module Readability
       @options = DEFAULT_OPTIONS.merge(options)
       @input = input
 
-      if RUBY_VERSION =~ /^1\.9\./ && !@options[:encoding]
+      if RUBY_VERSION =~ /^(1\.9|2)/ && !@options[:encoding]
         @input = GuessHtmlEncoding.encode(@input, @options[:html_headers]) unless @options[:do_not_guess_encoding]
         @options[:encoding] = @input.encoding.to_s
       end
@@ -409,17 +411,27 @@ module Readability
 
           # Otherwise, replace the element with its contents
         else
-          if replace_with_whitespace[el.node_name]
-            el.swap(Nokogiri::XML::Text.new(' ' << el.text << ' ', el.document))
+          # If element is root, replace the node as a text node
+          if el.parent.nil?
+            node = Nokogiri::XML::Text.new(el.text, el.document)
+            break
           else
-            el.swap(Nokogiri::XML::Text.new(el.text, el.document))
+            if replace_with_whitespace[el.node_name]
+              el.swap(Nokogiri::XML::Text.new(' ' << el.text << ' ', el.document))
+            else
+              el.swap(Nokogiri::XML::Text.new(el.text, el.document))
+            end
           end
         end
 
       end
 
+      s = Nokogiri::XML::Node::SaveOptions
+      save_opts = s::NO_DECLARATION | s::NO_EMPTY_TAGS | s::AS_XHTML
+      html = node.serialize(:save_with => save_opts)
+
       # Get rid of duplicate whitespace
-      node.to_html.gsub(/[\r\n\f]+/, "\n" ).gsub(/[\t  ]+/, " ")
+      return html.gsub(/[\r\n\f]+/, "\n" )
     end
 
     def clean_conditionally(node, candidates, selector)

data/ruby-readability.gemspec

@@ -3,10 +3,10 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "ruby-readability"
-  s.version     = '0.5.7'
+  s.version     = '0.6.0'
   s.authors     = ["Andrew Cantino", "starrhorne", "libc", "Kyle Maxwell"]
   s.email       = ["andrew@iterationlabs.com"]
-  s.homepage    = "http://github.com/iterationlabs/ruby-readability"
+  s.homepage    = "http://github.com/cantino/ruby-readability"
   s.summary     = %q{Port of arc90's readability project to ruby}
   s.description = %q{Port of arc90's readability project to ruby}
 

data/spec/fixtures/code.html

@@ -0,0 +1,13 @@
+<html>
+  <body>
+    <code><pre>
+root
+  indented
+    </pre></code>
+
+    <pre><code>
+second
+  indented
+    </code></pre>
+  </body>
+</html>

data/spec/readability_spec.rb

@@ -472,5 +472,40 @@ describe Readability do
   
   end
   
-  
+  describe "Code blocks" do
+    before do
+      @code = File.read(File.dirname(__FILE__) + "/fixtures/code.html")
+      @content  = Readability::Document.new(@code, 
+                                        :tags => %w[div p img a ul ol li h1 h2 h3 h4 h5 h6 blockquote strong em b code pre],
+                                        :attributes => %w[src href],
+                                        :remove_empty_nodes => false).content
+      @doc = Nokogiri::HTML(@content)
+    end
+
+    it "preserve the code blocks" do
+      @doc.css("code pre").text.should == "\nroot\n  indented\n    "
+    end
+
+    it "preserve backwards code blocks" do
+      @doc.css("pre code").text.should == "\nsecond\n  indented\n    "
+    end
+  end
+
+  describe "remove all tags" do
+    it "should work for an incomplete piece of HTML" do
+      doc = Readability::Document.new('<div>test</div', :tags => [])
+      doc.content.should == 'test'
+    end
+
+    it "should work for a HTML document" do
+      doc = Readability::Document.new('<html><head><title>title!</title></head><body><div><p>test</p></div></body></html>',
+                                      :tags => [])
+      doc.content.should == 'test'
+    end
+
+    it "should work for a plain text" do
+      doc = Readability::Document.new('test', :tags => [])
+      doc.content.should == 'test'
+    end
+  end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-readability
 version: !ruby/object:Gem::Version
-  version: 0.5.7
-  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrew Cantino
@@ -12,86 +11,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2014-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: guess_html_encoding
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.0.4
 description: Port of arc90's readability project to ruby
@@ -102,12 +91,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
 - .gitignore
 - .rspec
-- CHANGES.markdown
+- .travis.yml
+- .yardopts
 - Gemfile
-- README.markdown
+- LICENSE
+- README.md
 - Rakefile
 - bin/readability
 - lib/readability.rb
@@ -115,6 +105,7 @@ files:
 - ruby-readability.gemspec
 - spec/fixtures/bbc.html
 - spec/fixtures/cant_read.html
+- spec/fixtures/code.html
 - spec/fixtures/images/dim_1416768a.jpg
 - spec/fixtures/images/sign_up_emails_682__703711a.gif
 - spec/fixtures/images/sign_up_emails_682__703712a.gif
@@ -133,33 +124,33 @@ files:
 - spec/readability_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-homepage: http://github.com/iterationlabs/ruby-readability
+homepage: http://github.com/cantino/ruby-readability
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: ruby-readability
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Port of arc90's readability project to ruby
 test_files:
 - spec/fixtures/bbc.html
 - spec/fixtures/cant_read.html
+- spec/fixtures/code.html
 - spec/fixtures/images/dim_1416768a.jpg
 - spec/fixtures/images/sign_up_emails_682__703711a.gif
 - spec/fixtures/images/sign_up_emails_682__703712a.gif

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/CHANGES.markdown

@@ -1,7 +0,0 @@
-Oct 1, 2012:
-
-- Merged in austinrfnd's `author` handling code.
-
-Dec 13, 2012
-
-- Use fastimage instead of mini_magick for JRuby compat.

data/README.markdown

@@ -1,75 +0,0 @@
-# Ruby Readability
-
-Ruby Readability is a tool for extracting the primary readable content of a webpage.  It is a Ruby port of arc90's readability project.
-
-## Install
-
-Command line:
-
-    (sudo) gem install ruby-readability
-
-Bundler:
-
-    gem "ruby-readability", :require => 'readability'
-
-## Example
-
-    require 'rubygems'
-    require 'readability'
-    require 'open-uri'
-
-    source = open('http://lab.arc90.com/experiments/readability/').read
-    puts Readability::Document.new(source).content
-
-## Options
-
-You may provide options to Readability::Document.new, including:
-
-    :tags                - the base whitelist of tags to sanitize, defaults to %w[div p]
-    :remove_empty_nodes  - remove <p> tags that have no text content; also removes p tags that contain only images
-    :attributes          - whitelist of allowed attributes
-    :debug               - provide debugging output, defaults false
-    :encoding            - if the page is of a known encoding, you can specify it; if left unspecified,
-                           the encoding will be guessed (only in Ruby 1.9.x).  If you wish to disable guessing,
-                           supply :do_not_guess_encoding => true.
-    :html_headers        - in Ruby 1.9.x these will be passed to the guess_html_encoding gem
-                           to aid with guessing the HTML encoding
-    :ignore_image_format - for use with .images.  For example: :ignore_image_format => ["gif", "png"]
-    :min_image_height    - set a minimum image height for .images
-    :min_image_width     - set a minimum image width for .images
-
-## Command Line Tool
-
-Readability comes with a command-line tool for experimentation in bin/readability.
-
-    Usage: readability [options] URL
-        -d, --debug                      Show debug output
-        -i, --images                     Keep images and links
-        -h, --help                       Show this message
-
-## Images
-
-You can get a list of images in the content area with `.images`.  This feature requires that the `fastimage` gem be installed    
-
-    rbody = Readability::Document.new(body, :tags => %w[div p img a], :attributes => %w[src href], :remove_empty_nodes => false)
-    rbody.images
-
-## Potential Issues
-
-If you're on a Mac and are getting segmentation faults, see the discussion at https://github.com/sparklemotion/nokogiri/issues/404 and consider updating your version of libxml2.  Version 2.7.8 of libxml2, installed with `brew`, worked for me:
-
-    gem install nokogiri -- --with-xml2-include=/usr/local/Cellar/libxml2/2.7.8/include/libxml2 --with-xml2-lib=/usr/local/Cellar/libxml2/2.7.8/lib --with-xslt-dir=/usr/local/Cellar/libxslt/1.1.26
-
-Or if you're using bundler and Rails 3, you can run this command to make bundler always globally build `nokogiri` this way
-
-    bundle config build.nokogiri -- --with-xml2-include=/usr/local/Cellar/libxml2/2.7.8/include/libxml2 --with-xml2-lib=/usr/local/Cellar/libxml2/2.7.8/lib --with-xslt-dir=/usr/local/Cellar/libxslt/1.1.26
-
-# Change Log
-
- * Version 0.5.1, released 3/13/2012 - The `ignore_image_format` option now defaults to an empty array, no longer excluding gif files by default.  MiniMagic fetches are no longer attempted on local images.
-
-# License
-
-This code is under the Apache License 2.0.  http://www.apache.org/licenses/LICENSE-2.0
-
-Ruby port by starrhorne, libc, and iterationlabs.  Special thanks to fizx and marcosinger.