mmarkdown 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d990b8d6e63571648d6303a66ed508272b67f132
-  data.tar.gz: c46eaad8a0f50ed7fef341349b7299a5de798e5b
+  metadata.gz: 0e9e949c9202f9084f2ee497db3de0b37be0ba8c
+  data.tar.gz: 0ae5c043bafbadcfd6b25f26a258e0972a223a7e
 SHA512:
-  metadata.gz: 11290f0c30d6ab56c53f532e59eeaca63b40b357baa10f87c2072164a8804c6b6d731ad78481aa8d07f2199dda2cf94b80ad23a1be5b1ac4bee576b76dcb013f
-  data.tar.gz: 1d033224938323da53c17bd35e9c9d1303e59c8159a8f83016fe773c7b4d046c9b94a91a7ee86477fba5d759ca0300ecf34982d4de401e564677338a65e82ecd
+  metadata.gz: 73dbc3fbfb0a82cfb186bbae4bf982d097a6e2aa505b5b8dc28818b3e29ca1f9635042f0720e89fedb3c55e41a2bdf293aae280869911f0c880f889fb763966a
+  data.tar.gz: 0ab8de3c139440c445d2e0fc26a33a9d4b83bd0581ce93a1bf34eb65d602916645851d2fece950513103d1726f0790104b84888eee268cd8a5950f4381e03045

data/Rakefile

@@ -32,6 +32,68 @@ Convert Markdown to HTML with MathML
     EOF
   end
 rescue LoadError
-  puts "Jewelr not installed"
+  puts "Jeweler not installed"
+end
+
+require 'rdoc/task'
+require 'rdoc/generator/darkfish'
+
+#module RDoc::Generator::Markup
+#  alias :org_formatter :formatter
+#  def formatter
+#    org_formatter
+#
+#    @formatter.add_tag(:Math, "<math>", "</math>")
+#    @formatter
+#  end
+#end
+
+require 'rdoc'
+class RDoc::RDoc
+  alias_method :org_document, :document
+  def document options
+
+    m = RDoc::Markup.new
+    m.add_html("math", :MathML)
+    m.add_html("msup", :MathML_msup)
+    m.add_html("mi",   :MathML_mi)
+    m.add_html("mn",   :MathML_mn)
+    m.add_html("mo",   :MathML_mo)
+
+    h = RDoc::Markup::ToHtml.new(nil, m)
+    h.add_tag(:MathML,
+          "<math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'>",
+          "</math>")
+    h.add_tag(:MathML_msup, "<msup>", "</msup>")
+    h.add_tag(:MathML_mi,   "<mi>",   "</mi>")
+    h.add_tag(:MathML_mn,   "<mn>",   "</mn>")
+    h.add_tag(:MathML_mo,   "<mo stretchy='false'>", "</mo>")
+
+    rdoc_options = load_options
+    rdoc_options.parse(options)
+    rdoc_options.formatter = h
+
+    org_document(rdoc_options)
+
+    #p @generator.store.rdoc
+
+    #str  = "<math>"
+    #str += "  <msup><mi>x</mi><mn>2</mn></msup>"
+    #str += "  <mo>+</mo>"
+    #str += "  <msup><mi>y</mi><mn>2</mn></msup>"
+    #str += "  <mo>=</mo>"
+    #str += "  <msup><mi>r</mi><mn>2</mn></msup>"
+    #str += "</math>\n"
+
+    #puts h.convert(str)
+
+  end
+end
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "Readme.md"
+  rdoc.rdoc_files.include("Readme.md", "lib/**/*.rb")
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "MMarkdown"
 end
 

data/Readme.md

@@ -1,5 +1,29 @@
 # MMarkdown
-Markdown with math equations
+Markdown with math equations as MathML
+
+## Markdown with Equations
+LaTeX style equations in the areas surrounded by <code>\\(</code> and
+<code>\\)</code> are converted to inline equations.
+
+    \( x^2 + y^2 = r^2 \)
+generates
+
+    <math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'>
+      <msup>
+        <mi>x</mi><mn>2</mn></msup>
+        <mo stretchy='false'>+</mo>
+        <msup><mi>y</mi><mn>2</mn></msup>
+        <mo stretchy='false'>=</mo><msup>
+        <mi>r</mi><mn>2</mn>
+      </msup>
+    </math>
+
+and shown as
+<math>
+  <msup><mi>x</mi><mn>2</mn></msup>
+  <mo>+</mo><msup><mi>y</mi><mn>2</mn></msup>
+  <mo>=</mo><msup><mi>r</mi><mn>2</mn></msup>
+</math>
 
 ## Install
     gem install mmarkdown
@@ -8,6 +32,7 @@ Markdown with math equations
     mmarkdown <file.md>
 
 ----
+
 ## Author
 Hiroyuki Tanaka
 

data/bin/mmarkdown

@@ -35,6 +35,18 @@ option_parser = OptionParser.new {|opts|
     options[:stdout] = true
   }
 
+  opts.on("--style STYLE", String, "File name inserted as header") {|style|
+    options[:style_file] = style
+  }
+
+  opts.on("--title TITLE", String, "Title of created html file") {|title|
+    options[:title] = title
+  }
+
+  opts.on("--footer FOOTER", String, "File name for footer") {|footer|
+    options[:footer] = footer
+  }
+
   opts.on("-h", "--help", "Shows this message") {
     puts opts
     exit
@@ -64,7 +76,7 @@ end
 if options[:toc]
   html_string = MMarkdown.new(md_string).toc_html(options[:toc])
 else
-  html_string = MMarkdown.new(md_string).to_str
+  html_string = MMarkdown.new(md_string, title: options[:title]).to_str
 end
 
 unless options[:stdout]

data/lib/mmarkdown/version.rb

@@ -2,7 +2,7 @@
 class MMarkdown
   VERSION_MAJOR    = 0
   VERSION_MINOR    = 0
-  VERSION_REVISION = 7
+  VERSION_REVISION = 8
 
   VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_REVISION}"
 end

data/lib/mmarkdown.rb

@@ -10,9 +10,11 @@ class MMarkdown
     return self.new(str)
   end
 
-  def initialize md_string
+  def initialize md_string, title: nil, style: nil, footer: nil
     @md_mathml = equations_to_mathml(md_string)
 
+    @md_mathml.gsub!(/%%.*$/, '')
+
     parse_extensions = {no_intra_emphasis: true,
                         tables: true,
                         fenced_code_blocks: true,
@@ -28,8 +30,41 @@ class MMarkdown
     render = Redcarpet::Render::HTML.new(render_extensions)
 
     @md = Redcarpet::Markdown.new(render, parse_extensions).render(@md_mathml)
+
+    if title or style or footer
+      @header  = "<!DOCTYPE html>\n"
+      @header += "<html>\n"
+      @header += "<head>\n"
+
+      if title
+        @header += "  <title>" + title + "</title>\n"
+      end
+
+      if style
+        style_str = "  <style type=\"text/css\">\n"
+        File.open(style).each_line {|line|
+          style_str += ("    " + line)
+        }
+
+        @header += style_str
+        @header += "  </style>\n"
+      end
+
+      @header += "</head>\n"
+      @header += "<body>\n"
+
+      @footer = ""
+      if footer
+        @footer += "<footer>\n"
+        @footer += File.open(footer).read
+        @footer += "</footer>\n"
+      end
+      @footer += "</body>\n</html>\n"
+    end
   end
 
+  ##
+  # Converts equations to MathML format
   def equations_to_mathml string
     equations = []
 
@@ -45,6 +80,8 @@ class MMarkdown
     return string_mathml
   end
 
+  ##
+  # Returns list of table of contetns
   def toc_html nesting_level = 3
     render_toc = Redcarpet::Render::HTML_TOC.new(nesting_level: nesting_level)
     toc_html = Redcarpet::Markdown.new(render_toc).render(@md_mathml)
@@ -52,8 +89,22 @@ class MMarkdown
     return toc_html
   end
 
+  ##
+  # Returns HTML
   def to_str
-    @md.to_str
+    str = ""
+    if @header
+      str += @header
+    end
+
+    str += @md.to_str
+
+    if @footer
+      str += @footer
+    end
+
+    return str
   end
+  alias :to_html :to_str
 end
 

data/test/footer.html

@@ -0,0 +1 @@
+footer test

data/test/test.css

@@ -0,0 +1,2 @@
+h1 {background-color: blue}
+h2 {background-color: skyblue}

data/test/test_mmarkdown.rb

@@ -5,7 +5,7 @@ require "#{__dir__}/../lib/mmarkdown"
 
 class MMarkdownTest < MiniTest::Test
   def test_mmarkdown
-    md_string = File.open("#{__dir__}/test.md").read
+    md_string = File.open("#{__dir__}/test.mmd").read
     html_actual = MMarkdown.new(md_string).to_str
 
     html_expected = File.open("#{__dir__}/test.html").read
@@ -14,8 +14,22 @@ class MMarkdownTest < MiniTest::Test
                  Nokogiri::HTML::DocumentFragment.parse(html_actual).to_html)
   end
 
+  def test_with_title
+    md_string = File.open("#{__dir__}/test.mmd").read
+    html_actual = MMarkdown.new(md_string,
+                                title: "Test",
+                                style: "#{__dir__}/test.css",
+                                footer: "#{__dir__}/footer.html"
+                               ).to_str
+
+    html_expected = File.open("#{__dir__}/test_with_title.html").read
+
+    assert_equal(Nokogiri::HTML::DocumentFragment.parse(html_expected).to_html,
+                 Nokogiri::HTML::DocumentFragment.parse(html_actual).to_html)
+  end
+
   def test_toc_html
-    md_string = File.open("#{__dir__}/test.md").read
+    md_string = File.open("#{__dir__}/test.mmd").read
 
     mmarkdown = MMarkdown.new(md_string)
     toc_actual = mmarkdown.toc_html

data/test/test_with_title.html

@@ -0,0 +1,95 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Test</title>
+  <style type="text/css">
+    h1 {background-color: blue}
+    h2 {background-color: skyblue}
+  </style>
+</head>
+<body>
+<h1 id="test">Test</h1>
+
+<p>This is a test data</p>
+
+<h2 id="equation">Equation</h2>
+
+<p>This is an equation. <math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><msup><mi>x</mi><mn>2</mn></msup><mo stretchy='false'>+</mo><msup><mi>y</mi><mn>2</mn></msup><mo stretchy='false'>=</mo><msup><mi>r</mi><mn>2</mn></msup></math>,
+(<math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><mi>x</mi><mo stretchy='false'>=</mo><mi>r</mi><mi>cos</mi><mi>&theta;</mi></math> and <math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><mi>y</mi><mo stretchy='false'>=</mo><mi>r</mi><mi>sin</mi><mi>&theta;</mi></math>).</p>
+
+<p>And this is the second
+<math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><msup><mi>sin</mi><mn>2</mn></msup><mi>&theta;</mi><mo stretchy='false'>+</mo><msup><mi>cos</mi><mn>2</mn></msup><mi>&theta;</mi><mo stretchy='false'>=</mo><mn>1</mn></math>.</p>
+
+<p>日本語の後の数式 <math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><msubsup><mo stretchy='false'>&sum;</mo><mrow><mi>i</mi><mo stretchy='false'>=</mo><mn>0</mn></mrow><mrow><mi>N</mi></mrow></msubsup><msub><mi>x</mi><mi>i</mi></msub></math></p>
+
+<p>Block style
+<math xmlns='http://www.w3.org/1998/Math/MathML' display='block'><msubsup><mo stretchy='false'>&int;</mo><mrow><mo stretchy='false'>-</mo><mn>&infin;</mn></mrow><mrow><mn>&infin;</mn></mrow></msubsup><mi>f</mi><mfenced open='(' close=')'><mrow><mi>x</mi></mrow></mfenced><mspace width='0.167em' /><mi>d</mi><mi>x</mi></math></p>
+
+<p>Same equation again <math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><msup><mi>sin</mi><mn>2</mn></msup><mi>&theta;</mi><mo stretchy='false'>+</mo><msup><mi>cos</mi><mn>2</mn></msup><mi>&theta;</mi><mo stretchy='false'>=</mo><mn>1</mn></math>.</p>
+
+<p>vector:
+<math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><mover><mrow><mi>x</mi></mrow><mo>&rightarrow;</mo></mover><mo stretchy='false'>+</mo><mover><mrow><mi>y</mi></mrow><mo>&rightarrow;</mo></mover><mo stretchy='false'>=</mo><mover><mrow><mi>p</mi></mrow><mo>&rightarrow;</mo></mover></math></p>
+
+<h2 id="markdown">Markdown</h2>
+
+<p><em>italic</em></p>
+
+<p><u>underline</u></p>
+
+<p><strong>bold</strong></p>
+
+<p><strong><em>bold italic</em></strong></p>
+
+<h3 id="list">List</h3>
+
+<ul>
+<li>item1</li>
+<li>item2
+
+<ul>
+<li>nested item2-1</li>
+<li>nested item2-2</li>
+</ul></li>
+</ul>
+
+<ol>
+<li>item3</li>
+<li>item4</li>
+</ol>
+
+<h3 id="quote">Quote</h3>
+
+<blockquote>
+<p>quote</p>
+</blockquote>
+
+<h3 id="table">Table</h3>
+
+<table><thead>
+<tr>
+<th style="text-align: left">head1</th>
+<th style="text-align: center">head2</th>
+<th style="text-align: right">head3</th>
+</tr>
+</thead><tbody>
+<tr>
+<td style="text-align: left">item</td>
+<td style="text-align: center">item</td>
+<td style="text-align: right">item</td>
+</tr>
+</tbody></table>
+
+<h3 id="syntax-highlight">Syntax highlight</h3>
+
+<pre><code class="ruby">a = [1, 2, 3]
+a.reduce(0, :+)
+</code></pre>
+
+<h3 id="link">Link</h3>
+
+<p><a href="http://google.com">google</a></p>
+<footer>
+footer test
+</footer>
+</body>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mmarkdown
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Hiroyuki Tanaka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2015-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -80,9 +80,12 @@ files:
 - bin/mmarkdown
 - lib/mmarkdown.rb
 - lib/mmarkdown/version.rb
+- test/footer.html
+- test/test.css
 - test/test.html
-- test/test.md
+- test/test.mmd
 - test/test_mmarkdown.rb
+- test/test_with_title.html
 homepage: http://github.com/tanahiro/mmarkdown
 licenses:
 - MIT License
@@ -103,11 +106,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Markdown with MathML
 test_files:
+- test/footer.html
+- test/test.css
 - test/test.html
-- test/test.md
+- test/test.mmd
 - test/test_mmarkdown.rb
+- test/test_with_title.html