textprov 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12591d9466d6f8f852a3aca23ff985f8183cf6013d95bb2a5f56282641d97a76
-  data.tar.gz: 11e17c28beb87e5a9e7ea32ffc6ba21dd80af8ad93a2c334545a2d9e080d824e
+  metadata.gz: '09bcc2ff61751119b016d0acadbe9e9e296e19dcd8b1632664c2a362e915a356'
+  data.tar.gz: bc636fba3afcf2b58039ad4b19341a33b918368d936753cbefdcd59f052e8107
 SHA512:
-  metadata.gz: 07f475db040b23d302de0bcea2b0ecbd02aa8ba7271bf1a9f0613fb4ebaebdcf58c2328cb96dc16b0d16c8ab8be7eb1ed53b1b28d018202640af4a546d2d634a
-  data.tar.gz: b51d9352b3f35ace72bb733afbe51c4321a79febde03dd7fc1c74f6257df1253aed97b3359bfbde5ea774cc47fa94f47338c0c0f988d969c10df1f1fc2ee229b
+  metadata.gz: 2f48ed09154f4b6cf765f6ab72d50b236b7440faceddfe4ba03eebe01b17a6377f81ee42f5b59b104d3db0870ceb93b72c327a0fb28c33226a46305d777efd70
+  data.tar.gz: 7ec4ff03e14412939775edc909187a51f100b1eaa5de1573afd10cf9f4cfa66f51497f895b27b6f71a6d8238d6b3f499c80a5f383d45ffa2b19aae6cea54bc69

data/LICENSE

@@ -1,21 +1,204 @@
-MIT License
-
 Copyright (c) 2026 TextProv contributors
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+
+                                 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

@@ -1,75 +1,111 @@
-# textprov (Ruby)
+# textprov — Ruby SDK demonstration
 
-The TextProv reference implementation in Ruby: it puts provenance marks in text
-and reads them back out. Standard library only.
+This working experiment encodes and decodes `human`/`ai` classifications using
+variation selectors and a limited replacement-PUA mode. Ruby 3.2+, standard
+library only. Its package identity and version describe executable code, not a
+versioned proposal standard. It does not implement voice references or detect
+who wrote text.
+
+From `ruby/`, run with `ruby -Ilib`, or install this checkout as a gem:
 
 ```ruby
 require "textprov"
 
-Textprov.mark("foo", state: "ai")             # "f\u{E0101}o\u{E0101}o\u{E0101}"
-Textprov.mark_added("abc", "abXc")            # mark only what an edit added
-Textprov.convert(marked, "vs", "pua")         # same states, other encoding
-Textprov.strip_marks(marked)                  # back to the original text
+marked = Textprov.mark("foo", state: "ai")
+raise unless marked == "f\u{E0101}o\u{E0101}o\u{E0101}"
+raise unless Textprov.strip_marks(marked) == "foo"
+Textprov.runs(marked)  # [["ai", marked]]
+Textprov.to_html(marked)  # span carrying data-prov="ai"
+Textprov.mark_added("abc", "abXc")
+Textprov.convert(marked, "vs", "pua")
+```
 
-Textprov.runs("f\u{E0101}oo")
-# => [["ai", "f\u{E0101}"], [nil, "oo"]]
+`mark` and `mark_added` accept `state:` and `mode:` (`vs` or `pua`). Only `human`
+and `ai` are accepted classifications. `runs` and `to_html` accept `strip:` and
+`merge_whitespace:` (alias `mergeWhitespace:`); HTML also accepts `class_prefix:`.
+Core functions accept `mapping: Textprov::Mapping.load(path)`.
+`Textprov.inspect_text` reports classifications without shadowing Ruby's `inspect`.
 
-Textprov.to_html("f\u{E0101}oo")
-# => '<span class="prov prov-ai" data-prov="ai">f\u{E0101}</span>oo'
+The PUA mode replaces eligible base characters; it is distinct from the
+[additive-PUA candidate](../docs/encodings/additive-pua.md). Genuine Unicode
+variation sequences can collide with the decoder, and stripping can remove
+legitimate glyph selection. Read the [baseline limitations](../experiments/baseline/README.md)
+and [VS profile](../docs/encodings/vs.md) before using arbitrary text.
 
-Textprov.inspect_text(marked)                 # a 'key: value' report of the states
-```
+The proposal [model](../docs/model.md) defines unattributed text as `Voice0`.
+This experiment reports unmarked runs as `nil`; classification labels are not
+implementations of nonzero voice references. Legacy `SPEC_VERSION` is a baseline
+identifier, not a proposal version.
 
-`runs` and `to_html` take `strip:`, `merge_whitespace:` (also `mergeWhitespace:`
-as an alias per SPEC's cross-language rule), and (for `to_html`)
-`class_prefix:`. `mark` and `mark_added` take `state:` and `mode:` (`"vs"` or
-`"pua"`). Every function takes `mapping: Textprov::Mapping.load(path)` to use a
-registry other than the copy vendored in this package.
+## HTML display
 
-The Ruby method is `Textprov.inspect_text`, not `.inspect`, so it does not
-shadow `Kernel#inspect`.
+`to_html` r󠄁e󠄁t󠄁u󠄁r󠄁n󠄁s󠄁 s󠄁p󠄁a󠄁n󠄁s󠄁 w󠄁i󠄁t󠄁h󠄁o󠄁u󠄁t󠄁 i󠄁n󠄁j󠄁e󠄁c󠄁t󠄁i󠄁n󠄁g󠄁 s󠄁t󠄁y󠄁l󠄁e󠄁s󠄁.󠄁 `Textprov.stylesheet` r󠄁e󠄁t󠄁u󠄁r󠄁n󠄁s󠄁
+t󠄁h󠄁e󠄁 p󠄁a󠄁c󠄁k󠄁a󠄁g󠄁e󠄁d󠄁 r󠄁e󠄁v󠄁e󠄁a󠄁l󠄁 C󠄁S󠄁S󠄁:󠄁 g󠄁r󠄁a󠄁d󠄁i󠄁e󠄁n󠄁t󠄁 m󠄁i󠄁s󠄁t󠄁 a󠄁n󠄁d󠄁 a󠄁 d󠄁o󠄁t󠄁t󠄁e󠄁d󠄁 u󠄁n󠄁d󠄁e󠄁r󠄁l󠄁i󠄁n󠄁e󠄁 a󠄁t󠄁 8󠄁0󠄁%󠄁
+s󠄁o󠄁u󠄁r󠄁c󠄁e󠄁-󠄁c󠄁o󠄁l󠄁o󠄁r󠄁 o󠄁p󠄁a󠄁c󠄁i󠄁t󠄁y󠄁.󠄁 T󠄁h󠄁e󠄁 w󠄁a󠄁v󠄁y󠄁/󠄁s󠄁a󠄁w󠄁t󠄁o󠄁o󠄁t󠄁h󠄁 p󠄁r󠄁o󠄁v󠄁e󠄁n󠄁a󠄁n󠄁c󠄁e󠄁 u󠄁n󠄁d󠄁e󠄁r󠄁l󠄁i󠄁n󠄁e󠄁 i󠄁s󠄁 d󠄁e󠄁f󠄁u󠄁n󠄁c󠄁t󠄁.󠄁
 
-## Install
+```ruby
+require "textprov"
 
-```sh
-gem install textprov
+File.write("textprov.css", Textprov.stylesheet, encoding: "UTF-8")
+html = Textprov.to_html(Textprov.mark("A draft", state: "ai"))
 ```
 
-Ruby 3.2+ is required. No runtime dependencies.
+S󠄁e󠄁r󠄁v󠄁e󠄁 t󠄁h󠄁a󠄁t󠄁 C󠄁S󠄁S󠄁 a󠄁s󠄁 a󠄁 s󠄁t󠄁a󠄁t󠄁i󠄁c󠄁 a󠄁s󠄁s󠄁e󠄁t󠄁 a󠄁n󠄁d󠄁 l󠄁i󠄁n󠄁k󠄁 i󠄁t󠄁 f󠄁r󠄁o󠄁m󠄁 t󠄁h󠄁e󠄁 H󠄁T󠄁M󠄁L󠄁 d󠄁o󠄁c󠄁u󠄁m󠄁e󠄁n󠄁t󠄁.󠄁 T󠄁h󠄁e󠄁 s󠄁a󠄁m󠄁e󠄁
+s󠄁t󠄁y󠄁l󠄁e󠄁s󠄁h󠄁e󠄁e󠄁t󠄁 s󠄁h󠄁i󠄁p󠄁s󠄁 i󠄁n󠄁 a󠄁l󠄁l󠄁 t󠄁h󠄁r󠄁e󠄁e󠄁 S󠄁D󠄁K󠄁s󠄁.󠄁 S󠄁e󠄁e󠄁 t󠄁h󠄁e󠄁
+[d󠄁i󠄁s󠄁p󠄁l󠄁a󠄁y󠄁 c󠄁o󠄁n󠄁v󠄁e󠄁n󠄁t󠄁i󠄁o󠄁n󠄁](../docs/development/provenance-display.md) f󠄁o󠄁r󠄁 n󠄁a󠄁t󠄁i󠄁v󠄁e󠄁
+l󠄁i󠄁n󠄁k󠄁,󠄁 p󠄁r󠄁o󠄁o󠄁f󠄁i󠄁n󠄁g󠄁,󠄁 a󠄁n󠄁d󠄁 c󠄁o󠄁m󠄁m󠄁e󠄁n󠄁t󠄁 i󠄁n󠄁t󠄁e󠄁g󠄁r󠄁a󠄁t󠄁i󠄁o󠄁n󠄁.󠄁 U󠄁n󠄁m󠄁a󠄁r󠄁k󠄁e󠄁d󠄁 t󠄁e󠄁x󠄁t󠄁 r󠄁e󠄁m󠄁a󠄁i󠄁n󠄁s󠄁 u󠄁n󠄁a󠄁t󠄁t󠄁r󠄁i󠄁b󠄁u󠄁t󠄁e󠄁d󠄁.󠄁
 
 ## CLI
 
 ```sh
-textprov -o marked.txt mark --ai draft.txt
-textprov mark-added old.txt new.txt
-textprov convert --from vs --to pua marked.txt
-textprov strip marked.txt
-textprov render marked.txt
-textprov inspect marked.txt
+ruby -Ilib exe/textprov -o marked.txt mark --ai draft.txt
+ruby -Ilib exe/textprov mark-added old.txt new.txt
+ruby -Ilib exe/textprov convert --from vs --to pua marked.txt
+ruby -Ilib exe/textprov strip marked.txt
+ruby -Ilib exe/textprov render marked.txt
+ruby -Ilib exe/textprov inspect marked.txt
 ```
 
-A file argument may be `-` for stdin; output goes to stdout unless `-o` is
-given. Text is read and written as UTF-8 verbatim, so CRLF survives.
-
-## Contract and mapping versions
+An installed gem exposes `textprov`. A file argument may be `-` for stdin;
+output goes to stdout unless `-o` is supplied. UTF-8 line endings are preserved.
 
-- Contract version 1 (see [SPEC.md](../SPEC.md)).
-- Mapping version 1 (see [mapping.json](../mapping.json)). `lib/textprov/mapping.json`
-  is a vendored copy and the test suite fails if it drifts from the canonical
-  file.
+## Checks
 
-## Tests
+From `ruby/`:
 
 ```sh
-bundle install
-bundle exec rake test
+ruby -Ilib -Itest -e 'Dir["test/test_*.rb"].each { |file| require File.expand_path(file) }'
 ```
 
-The suite runs every decoder, producer, and convert case in
-[fixtures.json](../fixtures.json), tests the producer properties from
-[SPEC.md](../SPEC.md) directly rather than only through recorded outputs, and
-unit-tests `cluster_end`, `to_html`, `strip_marks`, and the CLI.
+Alternatively use `bundle exec rake test`. Checks cover shared
+[fixtures](../experiments/baseline/fixtures.json), vendored mapping agreement,
+producer behavior, CLI output, and Unicode 17.0.0 grapheme segmentation.
+See [UCD sources](../ucd/README.md).
+
+Apache-2.0; see [LICENSE](LICENSE).
+
+## Passage and exact display
+
+```ruby
+passages = Textprov.to_html(marked_text, strip: true) # default display: "passage"
+exact = Textprov.to_html(marked_text, strip: true, display: "exact", merge_whitespace: false)
+```
+
+T󠄁h󠄁e󠄁 C󠄁L󠄁I󠄁 a󠄁c󠄁c󠄁e󠄁p󠄁t󠄁s󠄁 `textprov render --display passage|exact FILE`.󠄁
+
+P󠄁a󠄁s󠄁s󠄁a󠄁g󠄁e󠄁 v󠄁i󠄁e󠄁w󠄁 i󠄁s󠄁 t󠄁h󠄁e󠄁 d󠄁e󠄁f󠄁a󠄁u󠄁l󠄁t󠄁.󠄁 I󠄁t󠄁 h󠄁i󠄁g󠄁h󠄁l󠄁i󠄁g󠄁h󠄁t󠄁s󠄁 a󠄁 p󠄁a󠄁s󠄁s󠄁a󠄁g󠄁e󠄁 **c󠄁o󠄁n󠄁t󠄁a󠄁i󠄁n󠄁i󠄁n󠄁g󠄁** r󠄁e󠄁c󠄁o󠄁r󠄁d󠄁e󠄁d󠄁
+m󠄁a󠄁r󠄁k󠄁s󠄁,󠄁 i󠄁n󠄁c󠄁l󠄁u󠄁d󠄁i󠄁n󠄁g󠄁 u󠄁n󠄁m󠄁a󠄁r󠄁k󠄁e󠄁d󠄁 c󠄁h󠄁a󠄁r󠄁a󠄁c󠄁t󠄁e󠄁r󠄁s󠄁 b󠄁e󠄁t󠄁w󠄁e󠄁e󠄁n󠄁 t󠄁h󠄁e󠄁m󠄁;󠄁 i󠄁t󠄁 d󠄁o󠄁e󠄁s󠄁 n󠄁o󠄁t󠄁 a󠄁s󠄁s󠄁i󠄁g󠄁n󠄁 t󠄁h󠄁o󠄁s󠄁e󠄁
+c󠄁h󠄁a󠄁r󠄁a󠄁c󠄁t󠄁e󠄁r󠄁s󠄁 a󠄁n󠄁 o󠄁r󠄁i󠄁g󠄁i󠄁n󠄁.󠄁 P󠄁l󠄁a󠄁i󠄁n󠄁 p󠄁a󠄁r󠄁a󠄁g󠄁r󠄁a󠄁p󠄁h󠄁s󠄁 s󠄁t󠄁a󠄁y󠄁 p󠄁l󠄁a󠄁i󠄁n󠄁.󠄁 A󠄁 p󠄁a󠄁s󠄁s󠄁a󠄁g󠄁e󠄁 c󠄁o󠄁n󠄁t󠄁a󠄁i󠄁n󠄁i󠄁n󠄁g󠄁 b󠄁o󠄁t󠄁h󠄁
+b󠄁a󠄁s󠄁e󠄁l󠄁i󠄁n󠄁e󠄁 c󠄁l󠄁a󠄁s󠄁s󠄁i󠄁f󠄁i󠄁c󠄁a󠄁t󠄁i󠄁o󠄁n󠄁s󠄁 u󠄁s󠄁e󠄁s󠄁 a󠄁 n󠄁e󠄁u󠄁t󠄁r󠄁a󠄁l󠄁 m󠄁i󠄁x󠄁e󠄁d󠄁 t󠄁r󠄁e󠄁a󠄁t󠄁m󠄁e󠄁n󠄁t󠄁.󠄁 E󠄁x󠄁a󠄁c󠄁t󠄁 `[data-prov]`
+s󠄁p󠄁a󠄁n󠄁s󠄁 r󠄁e󠄁m󠄁a󠄁i󠄁n󠄁 s󠄁e󠄁p󠄁a󠄁r󠄁a󠄁t󠄁e󠄁 f󠄁r󠄁o󠄁m󠄁 t󠄁h󠄁e󠄁 d󠄁i󠄁s󠄁p󠄁l󠄁a󠄁y󠄁-󠄁o󠄁n󠄁l󠄁y󠄁 `[data-prov-passage]` w󠄁r󠄁a󠄁p󠄁p󠄁e󠄁r󠄁.󠄁
 
-## License
+D󠄁O󠄁M󠄁 p󠄁a󠄁s󠄁s󠄁a󠄁g󠄁e󠄁s󠄁 f󠄁o󠄁l󠄁l󠄁o󠄁w󠄁 p󠄁a󠄁r󠄁a󠄁g󠄁r󠄁a󠄁p󠄁h󠄁s󠄁,󠄁 h󠄁e󠄁a󠄁d󠄁i󠄁n󠄁g󠄁s󠄁,󠄁 l󠄁i󠄁s󠄁t󠄁 i󠄁t󠄁e󠄁m󠄁s󠄁,󠄁 a󠄁n󠄁d󠄁 t󠄁a󠄁b󠄁l󠄁e󠄁 c󠄁e󠄁l󠄁l󠄁s󠄁 w󠄁h󠄁i󠄁l󠄁e󠄁
+r󠄁e󠄁t󠄁a󠄁i󠄁n󠄁i󠄁n󠄁g󠄁 i󠄁n󠄁l󠄁i󠄁n󠄁e󠄁 f󠄁o󠄁r󠄁m󠄁a󠄁t󠄁t󠄁i󠄁n󠄁g󠄁.󠄁 P󠄁l󠄁a󠄁i󠄁n󠄁-󠄁t󠄁e󠄁x󠄁t󠄁 H󠄁T󠄁M󠄁L󠄁 e󠄁x󠄁p󠄁o󠄁r󠄁t󠄁s󠄁 u󠄁s󠄁e󠄁 b󠄁l󠄁a󠄁n󠄁k󠄁 l󠄁i󠄁n󠄁e󠄁s󠄁 a󠄁s󠄁 p󠄁a󠄁r󠄁a󠄁g󠄁r󠄁a󠄁p󠄁h󠄁
+b󠄁o󠄁u󠄁n󠄁d󠄁a󠄁r󠄁i󠄁e󠄁s󠄁.󠄁 T󠄁h󠄁e󠄁 o󠄁p󠄁t󠄁i󠄁o󠄁n󠄁a󠄁l󠄁 s󠄁h󠄁a󠄁r󠄁e󠄁d󠄁 s󠄁t󠄁y󠄁l󠄁e󠄁s󠄁h󠄁e󠄁e󠄁t󠄁 p󠄁a󠄁i󠄁n󠄁t󠄁s󠄁 t󠄁h󠄁e󠄁 s󠄁e󠄁l󠄁e󠄁c󠄁t󠄁e󠄁d󠄁 l󠄁a󠄁y󠄁e󠄁r󠄁 o󠄁n󠄁l󠄁y󠄁.󠄁
+S󠄁w󠄁i󠄁t󠄁c󠄁h󠄁i󠄁n󠄁g󠄁 a󠄁n󠄁 a󠄁n󠄁c󠄁e󠄁s󠄁t󠄁o󠄁r󠄁'󠄁s󠄁 `data-prov-display` b󠄁e󠄁t󠄁w󠄁e󠄁e󠄁n󠄁 `passage` a󠄁n󠄁d󠄁 `exact` c󠄁h󠄁a󠄁n󠄁g󠄁e󠄁s󠄁
+p󠄁a󠄁i󠄁n󠄁t󠄁 w󠄁i󠄁t󠄁h󠄁o󠄁u󠄁t󠄁 c󠄁h󠄁a󠄁n󠄁g󠄁i󠄁n󠄁g󠄁 t󠄁e󠄁x󠄁t󠄁 o󠄁r󠄁 e󠄁x󠄁a󠄁c󠄁t󠄁 s󠄁p󠄁a󠄁n󠄁s󠄁.󠄁
 
-MIT. See [LICENSE](LICENSE).
+T󠄁h󠄁e󠄁 d󠄁e󠄁c󠄁o󠄁d󠄁e󠄁r󠄁'󠄁s󠄁 `runs()` A󠄁P󠄁I󠄁 i󠄁s󠄁 u󠄁n󠄁c󠄁h󠄁a󠄁n󠄁g󠄁e󠄁d󠄁.󠄁 F󠄁o󠄁r󠄁 e󠄁x󠄁a󠄁c󠄁t󠄁 w󠄁h󠄁i󠄁t󠄁e󠄁s󠄁p󠄁a󠄁c󠄁e󠄁 a󠄁t󠄁t󠄁r󠄁i󠄁b󠄁u󠄁t󠄁i󠄁o󠄁n󠄁,󠄁 u󠄁s󠄁e󠄁
+`merge_whitespace: false` (󠄁J󠄁a󠄁v󠄁a󠄁S󠄁c󠄁r󠄁i󠄁p󠄁t󠄁/󠄁R󠄁u󠄁b󠄁y󠄁)󠄁 o󠄁r󠄁 `merge_whitespace=False` (󠄁P󠄁y󠄁t󠄁h󠄁o󠄁n󠄁)󠄁.󠄁
+P󠄁a󠄁s󠄁s󠄁a󠄁g󠄁e󠄁 m󠄁e󠄁t󠄁a󠄁d󠄁a󠄁t󠄁a󠄁 a󠄁l󠄁w󠄁a󠄁y󠄁s󠄁 k󠄁e󠄁e󠄁p󠄁s󠄁 w󠄁h󠄁i󠄁t󠄁e󠄁s󠄁p󠄁a󠄁c󠄁e󠄁 u󠄁n󠄁a󠄁s󠄁s󠄁i󠄁g󠄁n󠄁e󠄁d󠄁;󠄁 t󠄁h󠄁e󠄁 l󠄁e󠄁g󠄁a󠄁c󠄁y󠄁 w󠄁h󠄁i󠄁t󠄁e󠄁s󠄁p󠄁a󠄁c󠄁e󠄁-󠄁m󠄁e󠄁r󠄁g󠄁e󠄁
+o󠄁p󠄁t󠄁i󠄁o󠄁n󠄁 a󠄁p󠄁p󠄁l󠄁i󠄁e󠄁s󠄁 t󠄁o󠄁 e󠄁x󠄁p󠄁l󠄁i󠄁c󠄁i󠄁t󠄁l󠄁y󠄁 r󠄁e󠄁q󠄁u󠄁e󠄁s󠄁t󠄁e󠄁d󠄁 e󠄁x󠄁a󠄁c󠄁t󠄁 H󠄁T󠄁M󠄁L󠄁 o󠄁u󠄁t󠄁p󠄁u󠄁t󠄁.󠄁

data/lib/textprov/cli.rb

@@ -32,7 +32,7 @@ module Textprov
     end
 
     def version_string
-      "#{PROG} #{Textprov::VERSION} (contract #{Textprov::CONTRACT_VERSION}, mapping #{Textprov.default_mapping.version})"
+      "#{PROG} #{Textprov::VERSION} (experiment #{Textprov::SPEC_VERSION}, registry #{Textprov.default_mapping.version})"
     end
 
     def usage
@@ -40,11 +40,11 @@ module Textprov
         Usage: #{PROG} [-o FILE] COMMAND [OPTIONS] ARGS...
 
         Commands:
-          mark [--human|--ai|--mixed] [--mode vs|pua] FILE
-          mark-added [--human|--ai|--mixed] [--mode vs|pua] OLD NEW
+          mark [--human|--ai] [--mode vs|pua] FILE
+          mark-added [--human|--ai] [--mode vs|pua] OLD NEW
           convert --from vs|pua --to vs|pua FILE
           strip FILE
-          render [--strip] [--no-merge-whitespace] [--class-prefix P] FILE
+          render [--display passage|exact] [--strip] [--no-merge-whitespace] [--class-prefix P] FILE
           inspect FILE
 
         FILE may be '-' for stdin. Text is read and written as UTF-8 verbatim.
@@ -58,7 +58,7 @@ module Textprov
       i = 0
       while i < argv.length
         case argv[i]
-        when "--human", "--ai", "--mixed"
+        when "--human", "--ai"
           opts[:state] = argv[i].sub(/^--/, "")
         when "--mode"
           opts[:mode] = argv[i + 1]
@@ -67,6 +67,8 @@ module Textprov
 
           i += 1
         else
+          raise ArgumentError, "invalid option #{argv[i]}" if argv[i].start_with?("--")
+
           rest << argv[i]
         end
         i += 1
@@ -141,16 +143,20 @@ module Textprov
           Textprov.strip_marks(read_input(argv[0]))
         when "render"
           strip = false
-          merge_ws = true
+          merge_ws = false
           class_prefix = "prov"
+          display = "passage"
           rest = []
           i = 0
           while i < argv.length
             case argv[i]
             when "--strip" then strip = true
             when "--no-merge-whitespace" then merge_ws = false
+            when "--merge-whitespace" then merge_ws = true
             when "--class-prefix" then class_prefix = argv[i + 1]
                                        i += 1
+            when "--display" then display = argv[i + 1]
+                                  i += 1
             else rest << argv[i]
             end
             i += 1
@@ -158,7 +164,8 @@ module Textprov
           raise ArgumentError, "render: FILE required" if rest.empty?
 
           Textprov.to_html(read_input(rest[0]),
-                           strip: strip, merge_whitespace: merge_ws, class_prefix: class_prefix)
+                           strip: strip, merge_whitespace: merge_ws, class_prefix: class_prefix,
+                           display: display)
         when "inspect"
           raise ArgumentError, "inspect: FILE required" if argv.empty?