amath 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30b2c9e57788d5b280dd5f5f2675bccbb388b4fa48b3d79e79a4b09768eceb07
+  data.tar.gz: b353722b5783b39e8ec920647f62f4701a466c247b6953190041d05ee16d81e7
+SHA512:
+  metadata.gz: 52db2fbc98d705ddb9469c56e6c5d9f860f543503c589d2d12aafb544bba5fac2341dae738dca13972d2eb5bd57a15f29c217b602ccca8b4e4e7c043ce81ea0f
+  data.tar.gz: e6f215511e89e94c5b1cec01cbd2990c1d2070262b2ba7ba44375f105fe9e9b704d7bb109cef99a4cae0bb5c764ea4f03131a6e8c93519ba07e34ebec83a0a20

data/LICENSE.md

@@ -0,0 +1,31 @@
+Licenses & Copyright
+====================
+
+This license file adheres to the formatting guidelines of
+[readable-licenses](https://github.com/nevir/readable-licenses).
+
+
+Ribose's BSD 2-Clause License
+-----------------------------
+
+Copyright (c) 2026, [Ribose Inc](https://www.ribose.com).
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1.  Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+
+2.  Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

data/README.adoc

@@ -0,0 +1,108 @@
+= Amath: AsciiMath parser for Ruby
+
+== Purpose
+
+Amath is a parser for https://asciimath.org[AsciiMath], the plain-text
+notation for mathematics. It turns input like this into a parse tree:
+
+[source]
+----
+sum_(i=1)^n i^2 = (n(n+1)(2n+1))/6
+----
+
+The tree records the structure of the formula: which symbols, fractions,
+roots, sub- and superscripts, matrices and brackets it contains, and how they
+nest. Your code decides what to do with it, such as rendering, converting or
+analysing it.
+
+== Grammar
+
+The AsciiMath grammar will be written in PARG, the grammar language of
+https://github.com/parsanol/parsanol-ruby[Parsanol], and compiled into a
+checksummed artifact that the gem loads at runtime. The repository will hold:
+
+* `grammars/`: the grammar source.
+* `artifacts/`: the compiled artifact.
+* `corpora/`: conformance cases with the input and the tree it must produce.
+
+== Installation
+
+Amath has not been released to RubyGems yet. Until it is, use it from Git in
+your `Gemfile`:
+
+[source,ruby]
+----
+gem "amath", github: "plurimath/amath"
+----
+
+Amath needs Ruby 3.2 or later. Its only runtime dependency is
+https://github.com/parsanol/parsanol-ruby[Parsanol].
+
+== Usage
+
+[source,ruby]
+----
+require "amath"
+
+tree = Amath.parse("x_y")
+# => {expr: {sequence: {symbol: "x"@0}, expr: {symbol: "_"@1, ...}}}
+----
+
+The result is a Parsanol tree: hashes and arrays whose leaves are
+`Parsanol::Slice` objects. Each leaf knows its text and where it starts in
+the input. Empty input gives back an empty string.
+
+Numbers use a dot as the decimal marker unless you say otherwise. A comma and
+the Arabic decimal separator are also supported:
+
+[source,ruby]
+----
+Amath.parse("1,5", decimal: ",")
+Amath.parse("1\u066B5", decimal: "\u066B")
+----
+
+Input that is not valid AsciiMath raises `Amath::ParseError`, which tells you
+where the parser gave up:
+
+[source,ruby]
+----
+begin
+  Amath.parse("x 1.")
+rescue Amath::ParseError => e
+  e.char_offset # => position in characters
+  e.byte_offset # => position in UTF-8 bytes
+end
+----
+
+Amath uses Parsanol's fast native engine where it is available and its pure
+Ruby engine elsewhere. You can choose one with `engine: :native` or
+`engine: :ruby`; asking for the native engine where it cannot run raises
+`Amath::EngineUnavailable` rather than quietly using Ruby.
+The native engine has a recursion limit (roughly 100 levels of nested
+brackets); by default amath parses deeper input with the Ruby engine, while
+`engine: :native` raises `Amath::NestingTooDeep`, a kind of
+`Amath::ParseError`.
+Long sums and sequences (thousands of terms) are not nesting: both engines
+parse them without going deeper as the expression gets longer.
+`Amath.last_engine` tells you which engine handled the last call.
+
+The exact rules for trees, positions, engines and errors are in
+link:docs/parser-contract.adoc[the parser contract].
+
+== Status
+
+Amath parses all of Plurimath's AsciiMath: Plurimath uses it for AsciiMath
+input
+(https://github.com/plurimath/plurimath/issues/494[plurimath/plurimath#494]).
+It also reads the measurement-uncertainty forms `ustd(...)`, `uexp(...)` and
+`ucov(...)` that Plurimath turns into uncertainty nodes
+(https://github.com/plurimath/plurimath/issues/493[plurimath/plurimath#493]).
+Shared exponents can be written as `ustd((3.85, 0.23)e4)` or
+`ustd(680(41)e-3)`; see the link:docs/parser-contract.adoc[parser contract]
+for the parse-tree fields and the corresponding expanded/interval call forms.
+
+It has not been released to RubyGems yet.
+
+== License
+
+Copyright Ribose Inc. Licensed under the BSD 2-Clause License; see link:LICENSE.md[].

data/artifacts/asciimath.checksums.txt

@@ -0,0 +1,10 @@
+# Written by scripts/compile.rb. Envelope checksum is Parsanol's own (PN 2);
+# the sha256 lines are of the files' bytes.
+artifact_checksum sha256:e90f836c851504dfcbd5b3d97c9224f2f1c8cb4d2167c10fc6f1d02a62646d43
+compiler_version 1.3.109
+source_hash sha256:566f8ba866e921308b3b947b2443a1278ffc1125e2b20a4afb5c14132f91f975
+artifacts/asciimath.json sha256:4b8392c6c92d201dde0aee5a87a7f24337a5b6367362c9bd21881b855e4609d2
+grammars/asciimath.parg sha256:566f8ba866e921308b3b947b2443a1278ffc1125e2b20a4afb5c14132f91f975
+data/vocabulary.json sha256:965b1f5c4e2d14ba7d045ba79c09097b42c311b737175c2199faca0cc87cf2a6
+entries dot comma arabic
+order_warnings 496