mmd-ruby 5.2.0.1

data/lib/mmd-jekyll.rb

@@ -0,0 +1,19 @@
+# mmd-jekyll - Ruby MultiMarkdown Parser for Jekyll
+# Set your Markdown parser to 'MultiMarkdown' to use MultiMardown as your parser.
+# Made by Sl (Shahaf Levi) - slsrepo.com
+# © Copyright Sl's Repository Ltd, 2016. All Rights Reserved.
+
+class Jekyll::Converters::Markdown::MultiMarkdown
+  def initialize(config)
+    require 'mmd-ruby'
+    @config = config
+  rescue LoadError
+    STDERR.puts 'You are missing a library required for Markdown. Please run:'
+    STDERR.puts '  $ [sudo] gem install mmd-ruby'
+    raise FatalException.new("Missing dependency: mmd-ruby")
+  end
+
+  def convert(content)
+    MultiMarkdown.new(content, :escaped_line_breaks).to_html
+  end
+end

data/lib/mmd-ruby.rb

@@ -0,0 +1 @@
+require 'multimarkdown'

data/lib/mmd.rb

@@ -0,0 +1 @@
+require 'multimarkdown'

data/lib/multimarkdown-ruby.rb

@@ -0,0 +1 @@
+require 'multimarkdown'

data/lib/multimarkdown.rb

@@ -0,0 +1,69 @@
+require 'multimarkdown.so'
+require 'multimarkdown/version'
+
+# Front-end to fletcher penney's implementation of MultiMarkdown
+#
+# A simple processor:
+#     >> puts MultiMarkdown.new("Hello, World.").to_html
+#     <p>Hello, World.</p>
+#
+# With other stuff:
+#     >> puts MultiMarkdown.new("_Hello World!_", :smart, :filter_html).to_html
+#     <p><em>Hello World!</em></p>
+#
+class MultiMarkdown
+
+  EXTENSIONS = {
+    "compatibility" => {:desc => "Markdown compatibility mode (disables all other options)", :short => "c"},
+    "complete" => {:desc => "Force complete document", :short => "f"},
+    "snippet" => {:desc => "Force snippet only", :short => "s"},
+    "no_smart_quotes" => {:desc => "Disable Smart quotes", :short => false},
+    "no_footnotes" => {:desc => "Disable Footnotes", :short => false},
+    "no_anchors" => {:desc => "Don't add anchors to headers, etc.", :short => false},
+    "filter_styles" => {:desc => "Filter out style blocks", :short => false},
+    "filter_html" => {:desc => "Filter out raw HTML", :short => false},
+    "process_html" => {:desc => "Process Markdown inside HTML", :short => false},
+    "no_metadata" => {:desc => "Don't parse Metadata", :short => false},
+    "obfuscate_email_addresses" => {:desc => "Mask email addresses", :short => false},
+    "critic_markup_accept_all" => {:desc => "CriticMarkup: Accept all proposed changes", :short => "a"},
+    "critic_markup_reject_all" => {:desc => "CriticMarkup: Reject all proposed changes", :short => "r"},
+    "random_footnote_anchor_numbers" => {:desc => "Use random numbers for footnote link anchors", :short => false},
+    "escaped_line_breaks" => {:desc => "Escaped line break", :short => false}
+  }
+
+  EXTENSIONS.keys.each do |ext|
+    attr_accessor ext
+  end
+
+  # Create a new MultiMarkdown processor. The `text` argument is a string
+  # containing MultiMarkdown text. Variable other arguments may be supplied to
+  # set various processing options. See MultiMarkdown::EXTENSIONS for more.
+  def initialize(text, *extensions)
+    @text = text
+    extensions.each do |ext|
+      raise "Unknown extension: #{ext.inspect}" unless EXTENSIONS.keys.include?(ext.to_s)
+      send("#{ext}=", true)
+    end
+  end
+
+  alias extract_metadata extract_metadata_value
+
+  # Returns a Hash cointaining all Metadata
+  #
+  #
+  def metadata(key = nil)
+    if @cached_metadata.nil?
+      @cached_metadata = {}
+      extract_metadata_keys.each do |k|
+        @cached_metadata[k.downcase] = extract_metadata_value(k)
+      end
+    end
+
+    if key
+      @cached_metadata[key.to_s.downcase]
+    else
+      @cached_metadata.dup
+    end
+  end
+
+end

data/lib/multimarkdown/version.rb

@@ -0,0 +1,6 @@
+class MultiMarkdown
+
+  # The ruby 'multimarkdown' gem version
+  VERSION = "5.2.0.1"
+
+end

data/mmd-ruby.gemspec

@@ -0,0 +1,37 @@
+#   Copyright 2016 Sl's Repository Ltd
+#
+#   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.
+
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "multimarkdown/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mmd-ruby"
+  s.version     = MultiMarkdown::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Sl's Repository Ltd"]
+  s.email       = ["admin@slsrepo.com"]
+  s.homepage    = "https://slsrepo.com/products"
+  s.summary     = "MultiMarkdown wrapper for Ruby"
+  s.description = s.summary
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
+
+  s.add_dependency "bundler"
+
+  s.files = %w(LICENSE README.md Rakefile mmd-ruby.gemspec) + Dir.glob("{bin,lib,test}/**/*") + Dir.glob("{ext,MultiMarkdown-5/src}/*.{c,h,rb}")
+  s.test_files = Dir.glob("{test}/**/*")
+  s.executables = "mmd-ruby"
+  s.extensions = ['ext/extconf.rb']
+  s.require_paths = ["lib"]
+end

data/test/extensions_test.rb

@@ -0,0 +1,174 @@
+# encoding: UTF-8
+
+$: << File.join(File.dirname(__FILE__), "../lib")
+
+require 'test/unit'
+require 'multimarkdown'
+
+class ExtensionsTest < Test::Unit::TestCase
+
+  def test_force_complete_document
+    mmd = 'Some very simple _Markdown_'
+
+    # Don't change anything (default)
+    multimarkdown = MultiMarkdown.new(mmd)
+    assert !multimarkdown.to_html.include?('<html>'), "Found '<html>' tag: '#{multimarkdown.to_html}'"
+
+    # Force complete document
+    multimarkdown = MultiMarkdown.new(mmd, :complete)
+    assert multimarkdown.to_html.include?('<html>'), "Didn't find '<html>' tag: '#{multimarkdown.to_html}'"
+  end
+
+  def test_force_snippet_mode
+    mmd = "Meta1: Value\nMeta2: Value2\n\nHello!"
+
+    # Don't change anything (default)
+    multimarkdown = MultiMarkdown.new(mmd)
+    assert multimarkdown.to_html.include?('<html>'), "Didn't find '<html>' tag: '#{multimarkdown.to_html}'"
+
+    # Force snippet
+    multimarkdown = MultiMarkdown.new(mmd, :snippet)
+    assert !multimarkdown.to_html.include?('<html>'), "Found '<html>' tag: '#{multimarkdown.to_html}'"
+  end
+
+  def test_smart_quotes
+    mmd = 'Quotes are "beautiful"'
+
+    # Don't change anything (default)
+    multimarkdown = MultiMarkdown.new(mmd)
+    assert multimarkdown.to_html.include?('&#8220;'), "Didn't find nice quote '&#8220;': '#{multimarkdown.to_html}'"
+    assert multimarkdown.to_html.include?('&#8221;'), "Didn't find nice quote '&#8221;': '#{multimarkdown.to_html}'"
+    assert !multimarkdown.to_html.include?('&quot;'), "Found quote '&quot;': '#{multimarkdown.to_html}'"
+
+    # Disble smart quotes
+    multimarkdown = MultiMarkdown.new(mmd, :no_smart_quotes)
+    assert_equal '<p>Quotes are &quot;beautiful&quot;</p>', multimarkdown.to_html.strip
+end
+
+  def test_footnotes
+    mmd = <<eof
+Here is some text containing a footnote.[^somesamplefootnote]
+
+[^somesamplefootnote]: Here is the text of the footnote itself.
+eof
+
+    # Don't change anything (default)
+    multimarkdown = MultiMarkdown.new(mmd)
+    assert multimarkdown.to_html.include?('class="footnotes"'),  "Didn't find footnote container: '#{multimarkdown.to_html}'"
+    assert multimarkdown.to_html.include?('text of the footnote itself'),  "Didn't find footnote text: '#{multimarkdown.to_html}'"
+    assert multimarkdown.to_html.include?('#fnref:1'),  "Didn't find footnote anchor '#fnref:1': '#{multimarkdown.to_html}'"
+
+    multimarkdown = MultiMarkdown.new(mmd, :random_footnote_anchor_numbers)
+    assert !multimarkdown.to_html.include?('#fnref:1'),  "Found footnote anchor '#fnref:1': '#{multimarkdown.to_html}'"
+
+    multimarkdown = MultiMarkdown.new(mmd, :no_footnotes)
+    assert !multimarkdown.to_html.include?('class="footnotes"'),  "Found footnote container: '#{multimarkdown.to_html}'"
+    assert multimarkdown.to_html.include?('[^somesamplefootnote]'),  "Didn't find footnote markdown text: '#{multimarkdown.to_html}'"
+
+  end
+
+  def test_anchors
+    mmd = '# A Heading'
+
+    # Don't change anything (default)
+    multimarkdown = MultiMarkdown.new(mmd)
+    assert multimarkdown.to_html.include?('id="aheading"'),  "Didn't find a tag with 'id=\"aheading\"': '#{multimarkdown.to_html}'"
+
+    # Turn off auto anchors
+    multimarkdown = MultiMarkdown.new(mmd, :no_anchors)
+    assert !multimarkdown.to_html.include?('id="aheading"'),  "Found a tag with 'id=\"aheading\"': '#{multimarkdown.to_html}'"
+  end
+
+  def test_filter_styles
+    mmd = '<style>p {color: red}</style> <span style="color: blue">It is blue!</span>'
+
+    # Don't change anything (default)
+    multimarkdown = MultiMarkdown.new(mmd)
+    assert multimarkdown.to_html.include?('<style>p {color: red}</style>'), "Didn't find '<style>' tag: '#{multimarkdown.to_html}'"
+    assert multimarkdown.to_html.include?('style="color: blue"'), "Didn't inline 'style': '#{multimarkdown.to_html}'"
+
+    # Disbale styles
+    multimarkdown = MultiMarkdown.new(mmd, :filter_styles)
+    assert !multimarkdown.to_html.include?('<style>p {color: red}</style>'), "Found '<style>' tag: '#{multimarkdown.to_html}'"
+    # Doesn't work: assert !multimarkdown.to_html.include?('style="color: blue"'), "Found inline 'style': '#{multimarkdown.to_html}'"
+  end
+
+  def test_filter_html
+    mmd = '<span>Hello from HTML</span>Pure Markdown'
+
+    # Don't change anything (default)
+    multimarkdown = MultiMarkdown.new(mmd)
+    assert multimarkdown.to_html.include?('<span>Hello from HTML</span>'), "Didn't find '<span>' tag: '#{multimarkdown.to_html}'"
+    assert multimarkdown.to_html.include?('Pure Markdown<'), "Didn't find Markdown: '#{multimarkdown.to_html}'"
+
+    # Disbale html
+    multimarkdown = MultiMarkdown.new(mmd, :filter_html)
+    assert_equal "<p>Hello from HTMLPure Markdown</p>", multimarkdown.to_html.strip
+  end
+
+  # TODO
+  # See https://github.com/fletcher/MultiMarkdown-4/issues/97
+  def disabled_test_markdown_in_html
+    mmd = 'Hello <span>[World](http://world.de)</span>!'
+
+    # No Markdown in html supported (default)
+    multimarkdown = MultiMarkdown.new(mmd)
+    assert_equal "<p>Hello <span>_World_</span>!</p>", multimarkdown.to_html.strip
+
+    # now with the extension turned on
+    multimarkdown = MultiMarkdown.new(mmd, :process_html)
+    assert_equal "<p>Hello <span><em>World</em></span>!</p>", multimarkdown.to_html.strip
+  end
+
+
+  def test_no_metadata
+    mmd = "A: B\n\nBlabla"
+
+    # Don't do anything (default)
+    multimarkdown = MultiMarkdown.new(mmd, :no_metadata)
+    assert multimarkdown.to_html.include?('A: B'), "Didn't find metadata style text: '#{multimarkdown.to_html}'"
+ end
+
+  def test_obfuscation
+    mmd = '[Contact me](mailto:mail@example.com)'
+
+    # Don't do anything (default)
+    multimarkdown = MultiMarkdown.new(mmd)
+    assert multimarkdown.to_html.include?('mail@example.com'), "Didn't find email address: '#{multimarkdown.to_html}'"
+
+    # Obfuscate
+    multimarkdown = MultiMarkdown.new(mmd, :obfuscate_email_addresses)
+    assert !multimarkdown.to_html.include?('mail@example.com'), "Found email address: '#{multimarkdown.to_html}'"
+  end
+
+  def test_critic_markup
+    mmd = 'This is a {++green ++} test.'
+
+    # Don't do anything (default)
+    multimarkdown = MultiMarkdown.new(mmd)
+    assert_equal "<p>This is a {++green ++} test.</p>", multimarkdown.to_html.strip
+
+    # Include changes
+    multimarkdown = MultiMarkdown.new(mmd, :critic_markup_accept_all)
+    assert_equal "<p>This is a green test.</p>", multimarkdown.to_html.strip
+
+    # Ignore changes
+    multimarkdown = MultiMarkdown.new(mmd, :critic_markup_reject_all)
+    assert_equal "<p>This is a test.</p>", multimarkdown.to_html.strip
+  end
+
+  def test_escaped_line_breaks
+    mmd = <<eof
+This is a cool MultiMarkdown\\
+Feature
+eof
+
+    # Don't do anything (default)
+    multimarkdown = MultiMarkdown.new(mmd)
+    assert !multimarkdown.to_html.include?('<br/>'), "Found '<br/>' tag: '#{multimarkdown.to_html}'"
+
+    multimarkdown = MultiMarkdown.new(mmd, :escaped_line_breaks)
+    assert multimarkdown.to_html.include?('<br/>'), "Didn't find '<br/>' tag: '#{multimarkdown.to_html}'"
+  end
+
+end

data/test/multimarkdown_test.rb

@@ -0,0 +1,77 @@
+# encoding: UTF-8
+
+$: << File.join(File.dirname(__FILE__), "../lib")
+
+require 'test/unit'
+require 'multimarkdown'
+
+class MultiMarkdownTest < Test::Unit::TestCase
+
+  def test_extension_methods_present_on_multimarkdown_class
+    assert MultiMarkdown.instance_methods.include?(:to_html),
+        "MultiMarkdown class should respond to #to_html"
+  end
+
+  def test_simple_one_liner_to_html
+    multimarkdown = MultiMarkdown.new('Hello World.')
+    assert_respond_to multimarkdown, :to_html
+    assert_equal "<p>Hello World.</p>", multimarkdown.to_html.strip
+  end
+
+  def test_inline_multimarkdown_to_html
+    multimarkdown = MultiMarkdown.new('_Hello World_!')
+    assert_respond_to multimarkdown, :to_html
+    assert_equal "<p><em>Hello World</em>!</p>", multimarkdown.to_html.strip
+  end
+
+  def test_multimarkdown_in_html_to_html
+    multimarkdown = MultiMarkdown.new('Hello <span>_World_</span>!',:process_html)
+    assert_respond_to multimarkdown, :to_html
+    assert_equal "<p>Hello <span><em>World</em></span>!</p>", multimarkdown.to_html.strip
+  end
+
+  def test_version_fits
+    assert MultiMarkdown::VERSION =~ /^#{MultiMarkdown::MMD_VERSION}/,
+        "Expected MultiMarkdown's version (#{MultiMarkdown::VERSION}) to start with the C library's version (#{MultiMarkdown::MMD_VERSION})"
+  end
+
+  def test_meta_attributes
+    multimarkdown = MultiMarkdown.new(<<-eof)
+meta1: Foo
+meta2: Bar
+
+Lorem Ipsum
+    eof
+    assert_equal ["meta1", "meta2"], multimarkdown.extract_metadata_keys()
+
+    assert_equal "Foo", multimarkdown.extract_metadata_value("Meta1")
+    assert_equal "Bar", multimarkdown.extract_metadata_value("Meta2")
+  end
+
+  def test_cached_metadata
+      multimarkdown = MultiMarkdown.new(<<-eof)
+MetaTheMeta1: Foo
+MetaTheMeta2: Bar
+
+Lorem Ipsum
+    eof
+
+    assert_equal({"metathemeta1" => "Foo", "metathemeta2" => "Bar"}, multimarkdown.metadata)
+
+    assert_equal("Foo", multimarkdown.metadata("MetaTheMeta1"))
+    assert_equal(nil, multimarkdown.metadata["MetaTheMeta1"])
+  end
+
+  def test_encoding
+      multimarkdown = MultiMarkdown.new(<<-eof)
+umlauts: M€tädätä
+
+ÄÖÜßäöüµ√
+=========
+
+eof
+      assert_match(/<h1[^>]*>ÄÖÜßäöüµ√<\/h1>/, multimarkdown.to_html.strip)
+      assert_equal("M€tädätä", multimarkdown.metadata('umlauts'))
+  end
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: mmd-ruby
+version: !ruby/object:Gem::Version
+  version: 5.2.0.1
+platform: ruby
+authors:
+- Sl's Repository Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: MultiMarkdown wrapper for Ruby
+email:
+- admin@slsrepo.com
+executables:
+- mmd-ruby
+extensions:
+- ext/extconf.rb
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- Rakefile
+- mmd-ruby.gemspec
+- bin/mmd-ruby
+- lib/mmd-jekyll.rb
+- lib/mmd-ruby.rb
+- lib/mmd.rb
+- lib/multimarkdown/version.rb
+- lib/multimarkdown-ruby.rb
+- lib/multimarkdown.bundle
+- lib/multimarkdown.rb
+- test/extensions_test.rb
+- test/multimarkdown_test.rb
+- ext/multimarkdown.c
+- ext/extconf.h
+- ext/extconf.rb
+- MultiMarkdown-5/src/beamer.c
+- MultiMarkdown-5/src/critic.c
+- MultiMarkdown-5/src/GLibFacade.c
+- MultiMarkdown-5/src/html.c
+- MultiMarkdown-5/src/latex.c
+- MultiMarkdown-5/src/lyx.c
+- MultiMarkdown-5/src/lyxbeamer.c
+- MultiMarkdown-5/src/memoir.c
+- MultiMarkdown-5/src/multimarkdown.c
+- MultiMarkdown-5/src/odf.c
+- MultiMarkdown-5/src/opml.c
+- MultiMarkdown-5/src/parse_utilities.c
+- MultiMarkdown-5/src/parser.c
+- MultiMarkdown-5/src/rng.c
+- MultiMarkdown-5/src/rtf.c
+- MultiMarkdown-5/src/strtok.c
+- MultiMarkdown-5/src/text.c
+- MultiMarkdown-5/src/toc.c
+- MultiMarkdown-5/src/transclude.c
+- MultiMarkdown-5/src/writer.c
+- MultiMarkdown-5/src/beamer.h
+- MultiMarkdown-5/src/critic.h
+- MultiMarkdown-5/src/glib.h
+- MultiMarkdown-5/src/GLibFacade.h
+- MultiMarkdown-5/src/html.h
+- MultiMarkdown-5/src/latex.h
+- MultiMarkdown-5/src/libMultiMarkdown.h
+- MultiMarkdown-5/src/lyx.h
+- MultiMarkdown-5/src/lyxbeamer.h
+- MultiMarkdown-5/src/memoir.h
+- MultiMarkdown-5/src/odf.h
+- MultiMarkdown-5/src/opml.h
+- MultiMarkdown-5/src/parser.h
+- MultiMarkdown-5/src/rtf.h
+- MultiMarkdown-5/src/strtok.h
+- MultiMarkdown-5/src/text.h
+- MultiMarkdown-5/src/toc.h
+- MultiMarkdown-5/src/transclude.h
+- MultiMarkdown-5/src/version.h
+- MultiMarkdown-5/src/writer.h
+homepage: https://slsrepo.com/products
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: MultiMarkdown wrapper for Ruby
+test_files:
+- test/extensions_test.rb
+- test/multimarkdown_test.rb