diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..faf7ed3 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,21 @@ +# newlines +* text=auto eol=lf + +*.abap text eol=lf +*.css text eol=lf +*.html text eol=lf +*.js text eol=lf +*.json text eol=lf +*.md text eol=lf +*.svg text eol=lf +*.sh text eol=lf +*.txt text eol=lf +*.xml text eol=lf +*.yaml text eol=lf +*.yml text eol=lf + +*.gif binary +*.jpeg binary +*.jpg binary +*.png binary +*.webp binary diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..55e4dcb --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# All contributions are important small and big +github: abappm +github: mbtools diff --git a/.github/workflows/reuse.yml b/.github/workflows/reuse.yml index 0ddfc58..7bc1392 100644 --- a/.github/workflows/reuse.yml +++ b/.github/workflows/reuse.yml @@ -1,11 +1,20 @@ +# SPDX-FileCopyrightText: 2022 Free Software Foundation Europe e.V. +# +# SPDX-License-Identifier: CC0-1.0 + name: REUSE Compliance Check -on: [push, pull_request,workflow_dispatch] +on: [push, pull_request, workflow_dispatch] + +permissions: + contents: read jobs: - test: + Reuse-Compliance-Check: runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: REUSE Compliance Check - uses: fsfe/reuse-action@v1 + uses: fsfe/reuse-action@694eabb15673ec601ea19d4cd949969141372512 # v5.0.0 diff --git a/.reuse/dep5 b/.reuse/dep5 deleted file mode 100644 index c8bda8a..0000000 --- a/.reuse/dep5 +++ /dev/null @@ -1,8 +0,0 @@ -Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ -Upstream-Name: ABAP HTML Diff -Upstream-Contact: Marc Bernard -Source: https://github.com/Marc-Bernard-Tools/ABAP-HTML-Diff - -Files: * -Copyright: 2022 Marc Bernard -License: MIT diff --git a/CHANGELOG.md b/CHANGELOG.md index f949739..40e35c8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,19 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). The project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and [ISO Date Format](https://www.iso.org/iso-8601-date-and-time-format.html). -## [Unreleased] - -### Added - -### Changed - -### Fixed - +See [unreleased changes] for the latest updates. ## Version [1.0.0] - 2022-01-01 Initial Release. - -[Unreleased]: https://github.com/Marc-Bernard-Tools/ABAP-.../compare/1.0.0...main -[1.0.0]: https://github.com/Marc-Bernard-Tools/ABAP-.../releases/tag/1.0.0 +[unreleased changes]: https://github.com/abapPM/ABAP-HTML-Diff/compare/1.0.0...main +[1.0.0]: https://github.com/abapPM/ABAP-HTML-Diff/releases/tag/1.0.0 diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 0000000..1625c17 --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. \ No newline at end of file diff --git a/README.md b/README.md index 1858a4f..8b545e8 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,23 @@ -![Version](https://img.shields.io/endpoint?url=https://shield.abap.space/version-shield-json/github/Marc-Bernard-Tools/ABAP-HTML-Diff/src/zcl_htmldiff.clas.abap/c_version&label=Version&color=blue) +![Version](https://img.shields.io/endpoint?url=https://shield.abappm.com/github/abapPM/ABAP-HTML-Diff/src/zcl_htmldiff.clas.abap/c_version&label=Version&color=blue) -[![License](https://img.shields.io/github/license/Marc-Bernard-Tools/ABAP-HTML-Diff?label=License&color=success)](LICENSE) -[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?color=success)](https://github.com/Marc-Bernard-Tools/.github/blob/main/CODE_OF_CONDUCT.md) -[![REUSE Status](https://api.reuse.software/badge/github.com/Marc-Bernard-Tools/ABAP-HTML-Diff)](https://api.reuse.software/info/github.com/Marc-Bernard-Tools/ABAP-HTML-Diff) +[![License](https://img.shields.io/github/license/abapPM/ABAP-HTML-Diff?label=License&color=success)](LICENSE) +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?color=success)](https://github.com/abapPM/.github/blob/main/CODE_OF_CONDUCT.md) +[![REUSE Status](https://api.reuse.software/badge/github.com/abapPM/ABAP-HTML-Diff)](https://api.reuse.software/info/github.com/abapPM/ABAP-HTML-Diff) # ABAP HTML Diff Library to highlight the content difference between two HTML strings (htmldiff). -Made by [Marc Bernard Tools](https://marcbernardtools.com/) giving back to the [SAP Community](https://community.sap.com/) - -NO WARRANTIES, [MIT License](LICENSE) - -## HTML Diff - This is a diffing library that understands HTML. Best suited for cases when you want to show a diff of user-generated HTML. -- The implementation is a port of JavaScript (https://github.com/alaorneto/htmldiffer, no license defined) -- which is a port of CoffeeScript (https://github.com/tnwinc/htmldiff.js, MIT license) -- which is a port of the original Ruby (https://github.com/myobie/htmldiff, MIT license) - An enhancement was made so the code can also produce the diff of two texts (tags are treated like text). +NO WARRANTIES, [MIT License](LICENSE) + ## Prerequisites SAP Basis 7.4 or higher -## Installation - -You can install ABAP Differ using [abapGit](https://github.com/abapGit/abapGit) either creating a new online repository for https://github.com/Marc-Bernard-Tools/ABAP-HTML-Diff or downloading the repository [ZIP file](https://github.com/Marc-Bernard-Tools/ABAP-HTML-Diff/archive/main.zip) and creating a new offline repository. - -We recommend using package `$HTMLDIFF`. - ## Usage ### Diffing HTML @@ -54,7 +40,8 @@ lv_original = '\n' && ' \n' && ' \n' && ' This is some interesting text.\n'. - +``` +```abap lv_modified = '\n' && '

First paragraph.

\n' && '
    \n' @@ -67,9 +54,9 @@ lv_modified = '\n' REPLACE ALL OCCURRENCES OF '\n' IN lv_original WITH cl_abap_char_utilities=>newline. REPLACE ALL OCCURRENCES OF '\n' IN lv_modified WITH cl_abap_char_utilities=>newline. - + li_htmldiff = zcl_htmldiff=>create( ). - + lv_diff = li_htmldiff->htmldiff( iv_before = lv_original iv_after = lv_modified @@ -96,7 +83,7 @@ lv_diff = li_htmldiff->htmldiff( iv_before = lv_original iv_after = lv_modified iv_with_img = abap_true ). -``` +``` Result: @@ -120,7 +107,7 @@ There are a few other options you can set in the `constructor`/`create` statemen Using CSS classes, the result will distinguish between inserts (class `diffins`), deletes (class `diffdel`), and updates (class `diffmod`). -See the [test classes](https://github.com/Marc-Bernard-Tools/ABAP-HTML-Diff/blob/main/src/zcl_htmldiff.clas.testclasses.abap) for more examples. +See the [test classes](https://github.com/abapPM/ABAP-HTML-Diff/blob/main/src/zcl_htmldiff.clas.testclasses.abap) for more examples. ### Diffing Text @@ -140,7 +127,7 @@ lv_modified = 'a b c'. lv_diff = li_htmldiff->textdiff( iv_before = lv_original iv_after = lv_modified ). -``` +``` Result: @@ -188,17 +175,33 @@ With the CSS class option, use the following: .diffmod { background-color: #ffffdd; } ``` +## Installation + +Install `html-diff` as a global module in your system using [apm](https://abappm.com). + +or + +Specify the `html-diff` module as a dependency in your project and import it to your namespace using [apm](https://abappm.com). + ## Contributions -All contributions are welcome! Read our [Contribution Guidelines](CONTRIBUTING.md), fork this repo, and create a pull request. +All contributions are welcome! Read our [Contribution Guidelines](https://github.com/abapPM/{{repo}}/blob/main/CONTRIBUTING.md), fork this repo, and create a pull request. -## About +You can install the developer version of ABAP HTML Diff using [abapGit](https://github.com/abapGit/abapGit) by creating a new online repository for `https://github.com/abapPM/ABAP-HTML-Diff`. + +Recommended SAP package: `$HTML-DIFF` + +## Attribution + +- The implementation is a port of JavaScript (https://github.com/alaorneto/htmldiffer, no license defined) +- which is a port of CoffeeScript (https://github.com/tnwinc/htmldiff.js, MIT license) +- which is a port of the original Ruby (https://github.com/myobie/htmldiff, MIT license) -Made with :heart: in Canada +## About -Copyright 2021 Marc Bernard +Made with ❤ in Canada -Follow [@marcfbe](https://twitter.com/marcfbe) on Twitter +Copyright 2025 apm.to Inc. -

    MBT Logo

    +Follow [@marcf.be](https://bsky.app/profile/marcf.be) on Blueksy and [@marcfbe](https://linkedin.com/in/marcfbe) or LinkedIn diff --git a/REUSE.toml b/REUSE.toml new file mode 100644 index 0000000..3ab830b --- /dev/null +++ b/REUSE.toml @@ -0,0 +1,6 @@ +version = 1 + +[[annotations]] +path = "**/*" +SPDX-FileCopyrightText = "2025 apm.to Inc. " +SPDX-License-Identifier = "MIT" diff --git a/package.abap.json b/package.abap.json new file mode 100644 index 0000000..c792774 --- /dev/null +++ b/package.abap.json @@ -0,0 +1,42 @@ +{ + "name": "xxx", + "version": "1.0.0", + "description": "XXX", + "type": "module", + "keywords": [ + "abap", + "apm", + "module" + ], + "homepage": "https://abappm.com", + "bugs": { + "url": "https://github.com/abapPM/ABAP-XXX" + }, + "license": "MIT", + "author": { + "name": "Marc Bernard", + "url": "https://abappm.com", + "email": "marc@abappm.com" + }, + "maintainers": [ + { + "name": "Marc Bernard", + "url": "https://github.com/mbtools", + "email": "marc@abappm.com" + } + ], + "repository": { + "url": "https://github.com/abapPM/ABAP-XXX" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/abapPM" + }, + "dependencies": { + "error": "^1.0.0" + }, + "engines": { + "abap": ">=7.50", + "apm": ">=1" + } +}