thredded-markdown_katex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c909cb1c04a74a744529f645d77d1faee3236ff1
+  data.tar.gz: cce8776eb2cd2729c7aa4747b74797d5334331e3
+SHA512:
+  metadata.gz: be17249c94f1137a52711a9a3e7e1e84bd72e45e01e4a9566ce50bbe92f91be0e120b4e8dfaf8bad2db580453ddcd429c6fbc91598b6975a4ac042058d3097df
+  data.tar.gz: f441d02a24a8cdaafeb03c0856fedc34eba6db6c280589bb9be356273eb2c24ecde142959c22ee7221590154de38b4abcf82b16692bead8dbece5c4ed959e364

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

data/README.md

@@ -0,0 +1,60 @@
+# Thredded Plugin: TeX math in Markdown via KaTex [![Build Status](https://travis-ci.org/thredded/thredded-markdown_katex.svg?branch=master)](https://travis-ci.org/thredded/thredded-markdown_katex) [![Test Coverage](https://codeclimate.com/github/thredded/thredded-markdown_katex/badges/coverage.svg)](https://codeclimate.com/github/thredded/thredded-markdown_katex/coverage) [![Code Climate](https://codeclimate.com/github/thredded/thredded-markdown_katex/badges/gpa.svg)](https://codeclimate.com/github/thredded/thredded-markdown_katex)
+
+A Thredded markdown plugin that renders TeX math server-side via [KaTeX].
+
+This is what it looks like:
+
+![screenshot](https://cloud.githubusercontent.com/assets/216339/22184709/a7799d12-e0cf-11e6-89dc-a0bf2206f98e.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thredded-markdown_katex', '~> 0.1.0'
+```
+
+And then execute:
+
+```bash
+bundle
+rails g thredded:markdown_katex:install
+```
+
+## Usage
+
+Wrap math in `$$`.
+
+See the [Kramdown Math documentation](https://kramdown.gettalong.org/syntax.html#math-blocks)
+for more information.
+
+## 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`.
+To release a new version, update the version number in `version.rb`,
+and then run `bundle exec rake release`, which will create a git tag for
+the version, push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/glebm/thredded-markdown_katex.
+
+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
+
+The gem is available as open source under the terms of
+the [MIT License](http://opensource.org/licenses/MIT).
+
+
+[KaTeX]: https://github.com/Khan/KaTeX

data/lib/generators/thredded/markdown_katex/install_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module Thredded
+  module MarkdownKatex
+    # Installs Thredded Katex plugin
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Installs Thredded Katex plugin.'
+      public_task :install
+
+      def install # rubocop:disable Metrics/MethodLength
+        scss_path = 'app/assets/stylesheets/application.scss'
+        if File.exist? scss_path
+          append_to_file scss_path, "\n" + '@import "katex";' + "\n"
+        end
+        sass_path = 'app/assets/stylesheets/application.sass'
+        if File.exist? sass_path
+          append_to_file sass_path, "\n" + '@import "katex"' + "\n"
+        end
+        css_path = 'app/assets/stylesheets/application.css'
+        if File.exist? css_path # rubocop:disable Style/GuardClause
+          append_to_file sass_path, "\n" + '//= require katex' + "\n"
+        end
+      end
+    end
+  end
+end

data/lib/thredded/markdown_katex/kramdown/katex_converter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Thredded
+  module MarkdownKatex
+    module Kramdown
+      # The KaTeX converter engine for Kramdown.
+      module KatexConverter
+        def self.call(_converter, el, _opts)
+          type = el.options[:category]
+          Katex.render(
+            el.value, display_mode: type == :block, throw_on_error: false
+          )
+        end
+      end
+    end
+  end
+end
+
+require 'kramdown/converter'
+Kramdown::Converter.module_eval do
+  add_math_engine :katex do |converter, el, opts|
+    add_math_engine(:katex, ::Thredded::MarkdownKatex::Kramdown::KatexConverter)
+    math_engine(:katex).call(converter, el, opts)
+  end
+end

data/lib/thredded/markdown_katex/mathml_whitelist.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+module Thredded
+  module MarkdownKatex
+    module MathMLWhitelist
+      # All the presentation MathML elements and attributes, as per the
+      # MathML Version 3.0 3rd Edition schema:
+      # https://www.w3.org/Math/draft-spec/appendixa.html
+
+      # Attributes common to all MathML elements
+      COMMON_ATT = %w(id xref class style href).freeze
+      # Attributes common to presentational elements
+      COMMON_PRES_ATT = %w(mathcolor mathbackground).freeze
+      # Attributes common to token elements
+      TOKEN_ATT = %w(mathvariant mathsize dir).freeze
+      # Attributes common to elements that can be indented
+      INDENT_ATT = %w(
+        indentalign indentshift indenttarget indentalignfirst indentshiftfirst
+        indentalignlast indentshiftlast
+      ).freeze
+      # Attributes common to definition elements
+      DEF_ENC_ATT = %w(definitionURL encoding).freeze
+
+      # All of these elements have MATHML_COMMON_PRES_ATT.
+      PRESENTATION_WHITELIST = {
+        'maction' => %w(actiontype selection),
+        'menclose' => %w(notation),
+        'merror' => %w(),
+        'mfenced' => %w(open close separators),
+        'mfrac' =>
+              %w(bevelled denomalign linethickness numalign),
+        'mglyph' => %w(src width height valign alt),
+        'mpadded' =>
+              %w(height depth width lspace voffset),
+        'mphantom' => %w(),
+        'mroot' => %w(),
+        'mrow' => %w(dir),
+        'msqrt' => %w(),
+        'mstyle' => INDENT_ATT + %w(
+          scriptlevel displaystyle scriptsizemultiplier scriptminsize
+          infixlinebreakstyle decimalpoint accent accentunder align
+          alignmentscope bevelled charalign charspacing close columnalign
+          columnlines columnspacing columnspan columnwidth crossout
+          denomalign depth dir edge equalcolumns equalrows fence form frame
+          framespacing groupalign height largeop leftoverhang length
+          linebreak linebreakmultchar linebreakstyle lineleading
+          linethickness location longdivstyle lquote lspace mathsize
+          mathvariant maxsize minlabelspacing minsize movablelimits
+          mslinethickness notation numalign open position rightoverhang
+          rowalign rowlines rowspacing rowspan rquote rspace selection
+          separator separators shift side stackalign stretchy
+          subscriptshift superscriptshift symmetric valign width
+        ),
+        'mi' => TOKEN_ATT,
+        'mn' => TOKEN_ATT,
+        'mo' => TOKEN_ATT + INDENT_ATT +
+                %w(form fence separator lspace rspace stretchy symmetric minsize
+                   maxsize largeop movablelimits accent linebreak lineleading
+                   linebreakstyle linebreakmultchar),
+        'ms' => TOKEN_ATT + %w(lquote rquote),
+        'mspace' => TOKEN_ATT + INDENT_ATT +
+                    %w(width height depth linebreak),
+        'mtext' => TOKEN_ATT,
+        'maligngroup' => %w(groupalign),
+        'malignmark' => %w(edge),
+        'mlabeledtr' => %w(rowalign columnalign groupalign),
+        'mtable' => %w(
+          align rowalign columnalign groupalign alignmentscope columnwidth
+          width rowspacing columnspacing rowlines columnlines frame
+          framespacing equalrows equalcolumns displaystyle side
+          minlabelspacing
+        ),
+        'mtd' => %w(rowspan columnspan rowalign columnalign groupalign),
+        'mtr' => %w(rowalign columnalign groupalign),
+        'mmultiscripts' => %w(superscriptshift subscriptshift),
+        'msub' => %w(subscriptshift),
+        'msup' => %w(superscriptshift),
+        'msubsup' => %w(superscriptshift subscriptshift),
+        'munder' => %w(accentunder align),
+        'mover' => %w(accent align),
+        'munderover' => %w(accent accentunder align),
+        'mlongdiv' => %w(position shift longdivstyle),
+        'mscarries' => %w(position location crossout scriptsizemultiplier),
+        'mscarry' => %w(location crossout),
+        'msgroup' => %w(position shift),
+        'msline' =>
+              %w(position length leftoverhang rightoverhang mslinethickness),
+        'none' => %w(),
+        'mprescripts' => %w(),
+        'msrow' => %w(position),
+        'mstack' => %w(align stackalign charalign charspacing)
+      }.freeze
+
+      OTHER_WHITELIST = {
+        'math' => %w(xmlns display maxwidth overflow altimg altimg-width
+                     altimg-height altimg-valign alttext cdgroup),
+        'semantics' => DEF_ENC_ATT,
+        'annotation' => %w(cd name src) + DEF_ENC_ATT,
+        'annotation-xml' => %w(cd name src) + DEF_ENC_ATT
+      }.freeze
+    end
+  end
+end

data/lib/thredded/markdown_katex/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Thredded
+  module MarkdownKatex
+    # Registers the thredded-markdown_katex initializer with Rails
+    class Railtie < Rails::Railtie
+      initializer 'thredded.markdown_katex', after: 'thredded' do
+        Thredded::MarkdownKatex.setup!
+      end
+    end
+  end
+end

data/lib/thredded/markdown_katex/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Thredded
+  module MarkdownKatex
+    VERSION = '0.1.0'
+  end
+end

data/lib/thredded/markdown_katex.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+require 'thredded/markdown_katex/version'
+require 'katex'
+require 'thredded/markdown_katex/railtie' if defined?(Rails)
+require 'thredded/markdown_katex/mathml_whitelist'
+
+module Thredded
+  # Adds TeX math support to Thredded markdown via KaTeX.
+  module MarkdownKatex
+    @options = {
+      math_engine: 'katex',
+      math_engine_opts: {}
+    }
+
+    KRAMDOWN_FILTER_CLASS_NAME = 'Thredded::HtmlPipeline::KramdownFilter'
+
+    class << self
+      attr_reader :options
+
+      def setup!
+        if pipeline_contains?(KRAMDOWN_FILTER_CLASS_NAME)
+          require 'thredded/markdown_katex/kramdown/katex_converter'
+          Thredded::HtmlPipeline::KramdownFilter.options.update(options)
+        else
+          raise "#{self.class.name} requires #{KRAMDOWN_FILTER_CLASS_NAME} " \
+                'in Thredded::ContentFormatter.pipeline_filters'
+        end
+
+        configure_whitelist!
+      end
+
+      private
+
+      def pipeline_contains?(name)
+        Thredded::ContentFormatter.pipeline_filters.map(&:name).include?(name)
+      end
+
+      def configure_whitelist!
+        whitelist_katex_html!
+        whitelist_mathml!
+      end
+
+      def whitelist_katex_html!
+        whitelist_element! 'span', %w(class style aria-hidden)
+        Thredded::ContentFormatter.whitelist[:css] ||= {}
+        Thredded::ContentFormatter.whitelist[:css][:properties] ||= []
+        Thredded::ContentFormatter.whitelist[:css][:properties] += %w(
+          color width height vertical-align margin-left margin-right font-size
+          top
+        )
+      end
+
+      def whitelist_mathml!
+        MathMLWhitelist::PRESENTATION_WHITELIST.each do |tag, attrs|
+          whitelist_element! tag, MathMLWhitelist::COMMON_ATT +
+                                  MathMLWhitelist::COMMON_PRES_ATT + attrs
+        end
+
+        MathMLWhitelist::OTHER_WHITELIST.each do |tag, attrs|
+          whitelist_element! tag, MathMLWhitelist::COMMON_ATT + attrs
+        end
+      end
+
+      def whitelist_element!(tag, attributes)
+        whitelist_el = Thredded::ContentFormatter.whitelist[:elements]
+        whitelist_el << tag unless whitelist_el.include?(tag)
+        whitelist_attr = Thredded::ContentFormatter.whitelist[:attributes]
+        whitelist_attr[tag] ||= []
+        whitelist_attr[tag] += attributes
+        whitelist_attr[tag].uniq!
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: thredded-markdown_katex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gleb Mazovetskiy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: katex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: thredded
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds TeX math support to Thredded markup via KaTeX.
+email:
+- glex.spb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/generators/thredded/markdown_katex/install_generator.rb
+- lib/thredded/markdown_katex.rb
+- lib/thredded/markdown_katex/kramdown/katex_converter.rb
+- lib/thredded/markdown_katex/mathml_whitelist.rb
+- lib/thredded/markdown_katex/railtie.rb
+- lib/thredded/markdown_katex/version.rb
+homepage: https://github.com/thredded/thredded-markdown_katex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.9
+signing_key: 
+specification_version: 4
+summary: Adds TeX math support to Thredded markup via KaTeX.
+test_files: []