diff --git a/.gitignore b/.gitignore index fb5ebaa..fa49fc4 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,8 @@ pom.xml.asc .lein-deps-sum .lein-failures .lein-plugins +.lein-env +.lein-repl-history \#*# *~ *.swp diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..4c9ad98 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,201 @@ + 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. diff --git a/README.md b/README.md index ce8d1bf..b4dcf81 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ A simple wrapper around the Boilerpipe text extraction library. With Leiningen, add it to the dependencies in `project.clj`: ```clojure -[io.curtis/boilerpipe-clj "0.2.0"] +[io.curtis/boilerpipe-clj "0.3.0"] ``` ## Usage @@ -29,10 +29,10 @@ The main function for extracting human-readable text from an HTML document is `get-text`. ```clojure -user=> (def article (slurp "http://www.newyorker.com/reporting/2013/03/11/130311fa_fact_kolbert?currentPage=all")) +user=> (def article (slurp "https://help.github.com/articles/open-source-licensing")) #'user/article -user=> (get-text article) ;;Uses the ArticleExtractor by default; it's tuned for news -"REM Sleep\nNathaniel Kleitman, known as the “father of modern sleep research,” was born in 1895...[redacted]" +user=> (get-text article) +"all\nPublic repositories on GitHub are often used to share open source software. Open source software is software that is licensed so that others are free to use, change, [...]" ``` It expects HTML as a String for its first argument, but you can also opt to use @@ -40,8 +40,8 @@ different strategies for extracting text by passing it an extractor instance as the second arg. ```clojure -user=> (get-text article boilerpipe-clj.extractors/default-extractor) -"Some people can’t go to sleep until late; others can’t sleep in. Both suffer “social jet lag.”...[redacted]" +user=> (get-text article boilerpipe-clj.extractors/default-extractor) +"Open source licensing\nWhich license is right for me?!\nDon't fret! Choosing an open source license can be confusing. That's why we created choosealicense.com , a website that helps you make decisions about how to license your code. [...]" ``` ### Extraction Strategies - boilerpipe-clj.extractors @@ -57,12 +57,6 @@ Defining your own strategies is not currently possible from Clojure. Please refer to the Boilerpipe documentation for more info on implementing them in Java. -### Utility Functions- boilerpipe-clj.util - -Utility functions for pretty-printing results or munging the returned text for -display are currently available in the `boilerpipe-clj.utils` namespace. This -may be subject to change. - ## Contributors * Curtis Gagliardi ([@cgag](https://github.com/cgag)) * Nick Barnwell ([@nickbarnwell](https://github.com/nickbarnwell)) @@ -70,5 +64,16 @@ may be subject to change. ## License Copyright © 2013 [Curtis Gagliardi](http://curtis.io/) +Copyright © 2013 [Nick Barnwell](https://github.com/nickbarnwell) + +boilerpipe-clj is provided under the ASL 2.0 license. + +The full license is available in LICENSE.md + +## Changes + +### 0.3.0 -Distributed under the Eclipse Public License, the same as Clojure. +Remove util namespace, it's outside the scope of this library. It only made it in here +due to lazyness when pulling this code out of another project. I suspect no one but me +was using them anyway. diff --git a/project.clj b/project.clj index 1c5419a..f1ec4c4 100644 --- a/project.clj +++ b/project.clj @@ -1,8 +1,8 @@ -(defproject io.curtis/boilerpipe-clj "0.2.1-SNAPSHOT" +(defproject io.curtis/boilerpipe-clj "0.3.0" :description "A simple wrapper around the Boilerpipe library for extracting text from html articles/pages" :url "http://curtis.io" - :license {:name "Eclipse Public License" - :url "http://www.eclipse.org/legal/epl-v10.html"} + :license {:name "Apache License, Version 2.0" + :url "http://www.apache.org/licenses/LICENSE-2.0.html"} :dependencies [[org.clojure/clojure "1.5.1"] [org.thnetos/cd-client "0.3.4" :exclusions [org.clojure/clojure cheshire]] [net.sourceforge.nekohtml/nekohtml "1.9.15"] diff --git a/src/boilerpipe_clj/core.clj b/src/boilerpipe_clj/core.clj index a4de0d9..2b88d91 100644 --- a/src/boilerpipe_clj/core.clj +++ b/src/boilerpipe_clj/core.clj @@ -1,6 +1,5 @@ (ns boilerpipe-clj.core (:require [boilerpipe-clj.extractors :as ext]) - (:require [boilerpipe-clj.util :as util]) (:import (de.l3s.boilerpipe.extractors ExtractorBase))) (defn get-text @@ -12,9 +11,3 @@ (get-text source ext/article-extractor)) ([^String source ^ExtractorBase extractor] (.getText extractor source))) - -(defn get-text-as-html [source & [extractor]] - "Takes HTML as String and returns extracted content in

tags." - (util/wrap-paragraphs (if extractor - (get-text source extractor) - (get-text source)))) diff --git a/src/boilerpipe_clj/util.clj b/src/boilerpipe_clj/util.clj deleted file mode 100644 index 384794a..0000000 --- a/src/boilerpipe_clj/util.clj +++ /dev/null @@ -1,6 +0,0 @@ -(ns boilerpipe-clj.util) - -(defn wrap-paragraphs - "Wraps the paragraphs of the text in

tags." - [text] - (clojure.string/replace text #"(.+)" "

$1

")) diff --git a/test/boilerpipe_clj/core_test.clj b/test/boilerpipe_clj/core_test.clj index 49ef252..8049792 100644 --- a/test/boilerpipe_clj/core_test.clj +++ b/test/boilerpipe_clj/core_test.clj @@ -1,7 +1,6 @@ (ns boilerpipe-clj.core-test (:require [clojure.test :refer :all] [boilerpipe-clj.core :refer :all] - [boilerpipe-clj.util :as util] [boilerpipe-clj.extractors :as ext])) (defonce test-article @@ -25,10 +24,3 @@ res (get-text test-article ext)] (is (and (not= res "") (not (nil? res))))))) - -;; TODO: Test wrap-paragraphs and get-text-as-html -(deftest test-wrap-paragraphs - (testing "wrap-paragraphs successfully wraps newline separated paragraphs in

tags" - )) - -;; TODO: More fine grained tests for the extractors. Not sure what these tests would look like.