readability-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bcab6fa16fd851068954a9fa17a234e29f23f7406e094bc6f265954c29ce231a
+  data.tar.gz: c2866940fbd118a73065bd51de75491e9a02284ca0287953a53e8841d117029d
+SHA512:
+  metadata.gz: 4ce2c23e7ddc3321dabd4bd45762c8c7950ceb4e3fb2bf1f48852c66937d0715f98027a0233b8e6f2a09628fc28f078eba8e68b2336c7f219890af3ddc9daae3
+  data.tar.gz: 86b0254a34654db1e910b3b8b0640fca6f77a1f518d29bd9816f49035e9308f492fb747be8e6b82257bdae7a2b184a7e13d469b91ed83e9fd1acdcacdbed3403

data/LICENSE

@@ -0,0 +1,189 @@
+                                 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 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, as submitted to the 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 developing and
+      distributing the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      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 the 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 any
+      Contribution embodied within the Work constitutes patent 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, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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 in addition 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works as Your own modifications.
+
+   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 reproducing 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 exemplary 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 all 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 offer only
+      conditions consistent with this License, and charge a fee for,
+      acceptance of warranty or liability obligations only on Your own behalf
+      and solely on Your terms, 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
+
+   Copyright 2024 Arc90 Inc
+
+   This Ruby port (readability-rb) is based on Mozilla's Readability.js
+   (https://github.com/mozilla/readability), itself derived from Arc90's
+   original readability project.
+
+   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,107 @@
+# Readability
+
+Ruby port of [Mozilla Readability.js](https://github.com/mozilla/readability) -- extract readable article content from HTML pages, like Firefox Reader View.
+
+[![Gem Version](https://img.shields.io/gem/v/readability-rb)](https://rubygems.org/gems/readability-rb)
+[![Build Status](https://github.com/andycroll/readability-rb/actions/workflows/ci.yml/badge.svg)](https://github.com/andycroll/readability-rb/actions)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
+
+Passes all 130 Mozilla test fixtures.
+
+## Installation
+
+Add this line to your application's **Gemfile**:
+
+```ruby
+gem "readability-rb"
+```
+
+## Quick Start
+
+```ruby
+result = Readability.parse(html, url: "https://example.com/article")
+
+result.title        # article title
+result.byline       # author name
+result.content      # cleaned HTML content
+result.text_content # plain text content
+result.excerpt      # short summary
+result.length       # text content length
+result.site_name    # site name
+result.published_time # publication date
+result.dir          # text direction
+result.lang         # language
+```
+
+## Usage
+
+### Parse an article
+
+```ruby
+html = Net::HTTP.get(URI("https://example.com/article"))
+result = Readability.parse(html, url: "https://example.com/article")
+
+puts result.title
+puts result.content
+```
+
+Returns a `Readability::Result` or `nil` if parsing fails.
+
+### Check if a page is readable
+
+```ruby
+if Readability.readerable?(html)
+  result = Readability.parse(html)
+end
+```
+
+Accepts `min_score` and `min_content_length` options.
+
+```ruby
+Readability.readerable?(html, min_score: 30, min_content_length: 200)
+```
+
+### Use the lower-level API
+
+Pass a Nokogiri document directly.
+
+```ruby
+doc = Nokogiri::HTML5(html)
+result = Readability::Document.new(doc, url: "https://example.com").parse
+```
+
+### Custom serializer
+
+Replace the default HTML serializer.
+
+```ruby
+result = Readability.parse(html, serializer: ->(el) { el.to_html })
+```
+
+## Options
+
+| Option | Description | Default |
+| --- | --- | --- |
+| `url` | Base URL for resolving relative links | `nil` |
+| `max_elems_to_parse` | Max elements before aborting (0 = no limit) | `0` |
+| `nb_top_candidates` | Number of top candidates to consider | `5` |
+| `char_threshold` | Min characters for a successful parse | `500` |
+| `classes_to_preserve` | CSS classes to keep on elements | `[]` |
+| `keep_classes` | Preserve all CSS classes | `false` |
+| `disable_json_ld` | Skip JSON-LD metadata extraction | `false` |
+| `allowed_video_regex` | Regex for allowed video embed URLs | built-in |
+| `link_density_modifier` | Adjust link density calculation | `0` |
+| `serializer` | Lambda to serialize the content element | `inner_html` |
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/andycroll/readability-rb/issues)
+- Fix bugs and [submit pull requests](https://github.com/andycroll/readability-rb/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+## License
+
+Apache 2.0