temml 0.31.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa0fa7ff4509d37528fafb96fdca5e25741fc25ca440c85715be8ba72312f919
+  data.tar.gz: d0d17ac0475376720146dbce3fd664555da06c325373cf6ba9e253a48a21bbf2
+SHA512:
+  metadata.gz: 51c1b4edeacf54b8b101856b552db20baaae066254adebb975101615e2709cbff4875a27736fcb13fd2feaeb92109cdd7c96e026ae020e716d89fd0ae2513cb6
+  data.tar.gz: d4ea1405771cc52249a1605cb164f8b7347a6e5369383c74dd95101972042ae5b68161ac7b079a524923076ea8e4229ee42b65271398ed05e2372bf1dd6aa8a1

data/COPYING.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.

data/README.md

@@ -0,0 +1,123 @@
+# Temml for Ruby
+
+[![](https://github.com/sudotac/temml-ruby/actions/workflows/lint-and-test.yml/badge.svg)](https://github.com/sudotac/temml-ruby/actions/workflows/lint-and-test.yml)
+
+temml-ruby is a fork of [katex-ruby], focusing on the support of [Temml] instead of [KaTeX].
+
+This rubygem enables you to render TeX math to MathML Core using [Temml].
+It uses [ExecJS] under the hood.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'temml', '~> 0.31.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install temml
+
+## Usage
+
+Render some math:
+
+```ruby
+Temml.render('c = \\pm\\sqrt{a^2 + b^2}')
+=> "<math><mrow><mi>c</mi><mo>=</mo></mrow><mrow><mo>±</mo></mrow><mrow><msqrt><mrow><msup><mi>a</mi><mn>2</mn></msup><mo>+</mo><msup><mi>b</mi><mn>2</mn></msup></mrow></msqrt></mrow></math>"
+```
+
+If you're on Rails, the result is marked as `html_safe`.
+
+Any error in the markup is raised by default. To avoid this and render error
+text instead, pass `throwOnError: false`:
+
+```ruby
+Temml.render('\\', throwOnError: false)
+=> "<span class=\"temml-error\" style=\"color:#b22222;white-space:pre-line;\">\\\n\nParseError:  Unexpected character: &#x27;\\&#x27; at position 1: \n\\̲</span>"
+```
+
+Note that this will catch even `ParseError`s (unlike native Temml).
+
+### Assets
+
+For this rendered math to look nice, you will also need to include Temml CSS
+and web fonts into the webpage.
+
+I recommend you use the CSS bundled with this gem, to ensure version
+compatibility.
+
+You also need to include the appropriate web fonts for the CSS
+you have chosen to use.
+Please refer to [Temml's documentation](https://temml.org/docs/en/administration.html#fonts)
+for details.
+
+#### Automatic registrations
+
+If you use Rails, Sprockets without Rails, or Hanami, the assets are registered
+automatically.
+
+For example, if you want to use Latin Modern font,
+`//= require Temml-Latin-Modern` if you use CSS or `@import "_Temml-Latin-Modern"` if you use Sass.
+
+You can also `//= require temml` in your JS to access the Temml renderer in the
+browser.
+
+#### Manual registration
+
+The assets are located in the `vendor/assets` directory of the gem. The root
+path to the root directory of the gem is available via `Temml.gem_path`, e.g.:
+
+```ruby
+File.join(Temml.gem_path, 'vendor', 'assets')
+```
+
+### Temml version
+
+The version of Temml bundled with this gem is available via:
+
+```ruby
+Temml::TEMML_VERSION
+```
+
+### Caching
+
+If you cache the output of `Temml.render`, make sure to use the Temml
+version in the cache key, as the output may change between versions.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/sudotac/temml-ruby.
+
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+This gem is almost based on [katex-ruby] and my additional contribution is tiny and trivial,
+so I will make this gem available under the terms of [CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/).
+
+Note that you must follow the licenses of [katex-ruby], [Temml] and [KaTeX],
+which are distributed under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+See the license files in the [license](license) directory.
+
+[katex-ruby]: https://github.com/glebm/katex-ruby
+[KaTeX]: https://github.com/Khan/KaTeX
+[Temml]: https://github.com/ronkok/Temml
+[ExecJS]: https://github.com/rails/execjs

data/lib/temml/engine.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: CC0-1.0 AND MIT
+
+module Temml
+  # Registers Temml fonts, stylesheets, and javascripts with Rails.
+  class Engine < ::Rails::Engine
+    initializer 'temml.assets' do |app|
+      # We deliberately do not place the assets in vendor/assets but in
+      # vendor/temml instead, as vendor/assets is added to asset paths
+      # by default but we have to avoid including the non-sprockets stylesheet.
+      %w[fonts javascripts images].each do |sub|
+        path = root.join('vendor', 'temml', sub).to_s
+        app.config.assets.paths << path if File.directory?(path)
+      end
+      # Use sprockets versions of temml CSS that use asset-path for
+      # referencing fonts.
+      # One file is a Sass partial and the other one is .css.erb.
+      app.config.assets.paths << root.join(
+        'vendor', 'temml', 'sprockets', 'stylesheets'
+      ).to_s
+    end
+  end
+end

data/lib/temml/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: CC0-1.0 AND MIT
+
+module Temml
+  VERSION = '0.31.0'
+  TEMML_VERSION = '0.13.5'
+end

data/lib/temml.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: CC0-1.0 AND MIT
+
+require 'temml/version'
+require 'execjs'
+require 'erb'
+
+# Provides a Ruby wrapper for Temml server-side rendering.
+module Temml
+  @load_context_mutex = Mutex.new
+  @temml_context = nil
+  @execjs_runtime = -> { ExecJS.runtime }
+
+  class << self
+    # rubocop:disable Naming/MethodParameterName, Naming/VariableName
+
+    # Renders the given math expression to MathML via temml.renderToString.
+    #
+    # Additional options must be passed as anonymous keyword arguments.
+    # See https://temml.org/docs/en/administration.html#options
+    #
+    # @param math [String] The math (Latex) expression
+    # @param throwOnError [Boolean] Whether to raise on error. If false,
+    #   renders the error message instead (even in case of ParseError, unlike
+    #   the native temml).
+    # @return [String] MathML. If strings respond to html_safe, the result will
+    #   be HTML-safe.
+    # @note This method is thread-safe as long as your ExecJS runtime is
+    #   thread-safe. MiniRacer is the recommended runtime.
+    def render(math, throwOnError: true, **)
+      maybe_html_safe temml_context.call(
+        'temml.renderToString',
+        math,
+        throwOnError:,
+        **
+      )
+    rescue ExecJS::ProgramError => e
+      raise e if throwOnError
+    end
+    # rubocop:enable Naming/MethodParameterName, Naming/VariableName
+
+    # The ExecJS runtime factory, default: `-> { ExecJS.runtime }`.
+    # Set this before calling any other methods to use a different runtime.
+    #
+    # This proc is guaranteed to be called at most once.
+    attr_accessor :execjs_runtime
+
+    def temml_context
+      @load_context_mutex.synchronize do
+        @temml_context ||= @execjs_runtime.call.compile File.read temml_js_path
+      end
+    end
+
+    def temml_js_path
+      File.expand_path File.join('vendor', 'temml', 'javascripts', 'temml.js'),
+                       gem_path
+    end
+
+    def gem_path
+      @gem_path ||=
+        File.expand_path(File.join(File.dirname(__FILE__), '..'))
+    end
+
+    private
+
+    def maybe_html_safe(html)
+      if html.respond_to?(:html_safe)
+        html.html_safe
+      else
+        html
+      end
+    end
+  end
+end
+
+if defined?(Rails)
+  require 'temml/engine'
+else
+  assets_path = File.join(Temml.gem_path, 'vendor', 'temml')
+  if defined?(Sprockets)
+    %w[fonts javascripts images].each do |subdirectory|
+      path = File.join(assets_path, subdirectory)
+      Sprockets.append_path(path) if File.directory?(path)
+    end
+    Sprockets.append_path(File.join(assets_path, 'sprockets', 'stylesheets'))
+  elsif defined?(Hanami)
+    Hanami::Assets.sources << assets_path
+  end
+end

data/license/KaTeX/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2020 Khan Academy and other 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.

data/license/Temml/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ron Kok
+
+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.

data/license/katex-ruby/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Gleb Mazovetskiy
+
+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.