From 1505c0aa343a95babab8a3038ad177be9e06242c Mon Sep 17 00:00:00 2001 From: Gioele Barabucci Date: Fri, 29 Mar 2013 22:17:32 +0100 Subject: [PATCH 1/4] Store a copy of the Apache License 2.0 in the repository --- LICENSE | 202 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 202 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/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. From aad2c5c7ec5eb25ff2bbafac9b0c130d3347c6f5 Mon Sep 17 00:00:00 2001 From: Gioele Barabucci Date: Fri, 29 Mar 2013 22:19:18 +0100 Subject: [PATCH 2/4] Remove unused and outdated CHANGES file --- CHANGES.markdown | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 CHANGES.markdown diff --git a/CHANGES.markdown b/CHANGES.markdown deleted file mode 100644 index 4a8c304..0000000 --- a/CHANGES.markdown +++ /dev/null @@ -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. \ No newline at end of file From 4ae0f05b63ab7af6bc8870766c87a9197c1d66b3 Mon Sep 17 00:00:00 2001 From: Gioele Barabucci Date: Fri, 29 Mar 2013 22:26:39 +0100 Subject: [PATCH 3/4] Make compatible with current rubydoc.info (use YARD) --- .document | 5 ----- .gitignore | 1 + .yardopts | 3 +++ 3 files changed, 4 insertions(+), 5 deletions(-) delete mode 100644 .document create mode 100644 .yardopts diff --git a/.document b/.document deleted file mode 100644 index ecf3673..0000000 --- a/.document +++ /dev/null @@ -1,5 +0,0 @@ -README.rdoc -lib/**/*.rb -bin/* -features/**/*.feature -LICENSE diff --git a/.gitignore b/.gitignore index 811f660..2335c25 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ Gemfile.lock pkg/* .idea .rvmrc +.yardoc/ diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000..703b69e --- /dev/null +++ b/.yardopts @@ -0,0 +1,3 @@ +--readme README.markdown +- +LICENSE From ef05a9714fbc38ba2758dda18ae53a060a901cb2 Mon Sep 17 00:00:00 2001 From: Gioele Barabucci Date: Fri, 29 Mar 2013 22:36:37 +0100 Subject: [PATCH 4/4] Use proper Markdown formatting in README --- README.markdown | 82 ++++++++++++++++++++++++++++++------------------- 1 file changed, 51 insertions(+), 31 deletions(-) diff --git a/README.markdown b/README.markdown index 4ab27b8..8675e10 100644 --- a/README.markdown +++ b/README.markdown @@ -1,8 +1,12 @@ -# Ruby Readability +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. +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 + +Install +------- Command line: @@ -12,7 +16,9 @@ Bundler: gem "ruby-readability", :require => 'readability' -## Example + +Example +------- require 'rubygems' require 'readability' @@ -21,55 +27,69 @@ Bundler: 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: +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 `

` tags that have no text content; also + removes `

` 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`. - :tags - the base whitelist of tags to sanitize, defaults to %w[div p] - :remove_empty_nodes - remove

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 +Command Line Tool +----------------- -Readability comes with a command-line tool for experimentation in bin/readability. +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 +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: +Potential Issues +---------------- + +If you're on a Mac and are getting segmentation faults, see the discussion at + 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 +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 +License +------- -This code is under the Apache License 2.0. http://www.apache.org/licenses/LICENSE-2.0 +This code is under the Apache License 2.0. See . -Ruby port by starrhorne, libc, and iterationlabs. Special thanks to fizx and marcosinger. +Ruby port by starrhorne, libc, and iterationlabs. Special thanks to fizx and marcosinger.