rmultimarkdown 4.6.0.1 → 4.6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d09abf7122bde215cae33570b460aa1d63874cfc
-  data.tar.gz: a9cf6ae5f6f8738f471266cd9594285dc32c32a8
+  metadata.gz: 167af5d3d0863a48d28427711ecbc8bcd42fe9cd
+  data.tar.gz: 83c2e5097b502293ae34ce4ba5ad293f4acf6af6
 SHA512:
-  metadata.gz: feba15b48f3fe5ba7340d3c2037b48ebb44d8f1ba82a125216018e646081cf4ce5dd2d67c23c2acc00d8bf3f4854cb2335ea9f885f63d4368221aa9f550dd192
-  data.tar.gz: 0f47cae9ff4087bd5ca8c1780a8aafcdc0b378e71387e580fa892708633f743cc571c66bea40444a447af172604e1495c6b632791a6c4cb9aa7b657dcbaabf1c
+  metadata.gz: 7ea5083a0b5d47cc067f35db9152ce9245e1991eb525be81cef504f883a593122dd0c7b2f98341b634ce01e3a1e47aae7f089347b553774e0844efd77da7419e
+  data.tar.gz: 7cd100553e21772c28fedb0a56ede9f8b87790f3bc0a8c58ed7dde10dc1b65c578b30cd8370ebf35480ba7c4eba83e746607fd6a63a2282a7efc31ea934b9dc3

data/Rakefile

@@ -60,7 +60,9 @@ namespace :test do
 
   desc 'Run unit tests'
   task :unit => :build do |t|
-    ruby 'test/multi_markdown_test.rb'
+    FileList['test/*.rb'].each do |f|
+      ruby f
+    end
   end
 
   desc "Run conformance tests"

data/bin/rmultimarkdown

@@ -30,6 +30,7 @@ class Parser
       next if @used_short.include?(c) || c == "_"
       return c # returns from short_from method
     end
+    nil
   end
 
   def validate(options) # remove this method if you want fewer lines of code and don't need validations
@@ -52,14 +53,14 @@ class Parser
     @result = (@default_values || {}).clone # reset or new
     @optionparser ||= OptionParser.new do |p| # prepare only once
       @options.each do |o|
-        @used_short << short = o[2][:short] || short_from(o[0])
+        @used_short << short = o[2][:short] == false ? nil : o[2][:short] || short_from(o[0])
         @result[o[0]] = o[2][:default] || false # set default
         klass = o[2][:default].class == Fixnum ? Integer : o[2][:default].class
         desk = o[1] + (o[2][:nodefault] ? "" : " (default is #{@result[o[0]]})")
         if [TrueClass, FalseClass, NilClass].include?(klass) # boolean switch
-          p.on("-" << short, "--[no-]" << o[0].to_s.gsub("_", "-"), desk) {|x| @result[o[0]] = x}
+          p.on(short && "-" << short, "--" << o[0].to_s.gsub("_", "-"), desk) {|x| @result[o[0]] = x}
         else # argument with parameter
-          p.on("-" << short, "--" << o[0].to_s.gsub("_", "-") << " " << (o[2][:name] ? "[#{o[2][:name].to_s}]" : ""), klass, desk) {|x| @result[o[0]] = x}
+          p.on(short && "-" << short, "--" << o[0].to_s.gsub("_", "-") << " " << (o[2][:name] ? "[#{o[2][:name].to_s}]" : ""), klass, desk) {|x| @result[o[0]] = x}
         end
       end
 
@@ -85,25 +86,19 @@ end
 options = Parser.new do |p|
   p.banner = "Ruby interface to MultiMarkdown"
   p.version = "rmultimarkdown #{MultiMarkdown::VERSION}"
-  p.option :compatibility, "markdown compatibility mode", :default => false
-  p.option :filter_html, "filter out raw HTML except styles", :default => false
-  p.option :process_html, "process MultiMarkdown inside of raw HTML", :default => false
-  p.option :filter_styles, "filter out HTML styles", :default => false
-  p.option :smart, "use smart typography extension", :default => true
-  p.option :notes, "use notes extension", :default => true
-  p.option :output, "send output to FILE (default is stdout)", :name => "FILE", :default => "", :nodefault => true
-  p.option :to, "convert to FORMAT", :name => "FORMAT", :default => "html", :value_in_set => ["html","latex","memoir","beamer","odf","opml"]
-  p.option :extract, "extract and display metadata specified by KEY", :name => "KEY", :default => "", :nodefault => true
+   p.option :output, "send output to FILE (default is stdout)", :name => "FILE", :default => "", :nodefault => true, :short => "o"
+   p.option :to, "convert to FORMAT", :name => "FORMAT", :default => "html", :value_in_set => ["html","latex"], :short => "t"
+   p.option :extract, "extract and display metadata specified by KEY", :name => "KEY", :default => "", :nodefault => true, :short => "e"
+  MultiMarkdown::EXTENSIONS.each do |ext, opts|
+    p.option ext.to_sym, opts[:desc], :default => false, :short => opts[:short] || false
+  end
 end.process!
 
 # Convert options to MultiMarkdown module's options
 mmopts = []
-mmopts << :filter_html   if options[:filter_html]
-mmopts << :filter_styles if options[:filter_styles]
-mmopts << :process_html  if options[:process_html]
-mmopts << :smart         if options[:smart]
-mmopts << :notes         if options[:notes]
-mmopts << :compatibility if options[:compatibility]
+MultiMarkdown::EXTENSIONS.each do |ext, description|
+  mmopts << ext.to_sym if options[ext.to_sym]
+end
 
 # ARGV will now only contain input filename, if it contains anything
 STDIN.reopen(ARGV[0], 'rb') if ARGV.any?

data/ext/multi_markdown.c

@@ -19,16 +19,35 @@ static VALUE rb_cMultiMarkdown;
 
 static int get_exts(VALUE self) {
   int extensions = 0;
-  if (rb_funcall(self, rb_intern("smart"), 0) == Qtrue)
+  if (rb_funcall(self, rb_intern("complete"), 0) == Qtrue)
+    extensions = extensions | EXT_COMPLETE;
+  if (rb_funcall(self, rb_intern("snippet"), 0) == Qtrue)
+    extensions = extensions | EXT_SNIPPET;
+  if (rb_funcall(self, rb_intern("no_smart_quotes"), 0) != Qtrue)
     extensions = extensions | EXT_SMART;
-  if (rb_funcall(self, rb_intern("notes"), 0) == Qtrue)
+  if (rb_funcall(self, rb_intern("no_footnotes"), 0) != Qtrue)
     extensions = extensions | EXT_NOTES;
-  if (rb_funcall(self, rb_intern("filter_html"), 0) == Qtrue)
-    extensions = extensions | EXT_FILTER_HTML;
+  if (rb_funcall(self, rb_intern("no_anchors"), 0) == Qtrue)
+    extensions = extensions | EXT_NO_LABELS;
   if (rb_funcall(self, rb_intern("filter_styles"), 0) == Qtrue)
     extensions = extensions | EXT_FILTER_STYLES;
+  if (rb_funcall(self, rb_intern("filter_html"), 0) == Qtrue)
+    extensions = extensions | EXT_FILTER_HTML;
   if (rb_funcall(self, rb_intern("process_html"), 0) == Qtrue)
     extensions = extensions | EXT_PROCESS_HTML;
+  if (rb_funcall(self, rb_intern("no_metadata"), 0) == Qtrue)
+    extensions = extensions | EXT_NO_METADATA;
+  if (rb_funcall(self, rb_intern("obfuscate_email_addresses"), 0) == Qtrue)
+    extensions = extensions | EXT_OBFUSCATE;
+  if (rb_funcall(self, rb_intern("critic_markup_accept_all"), 0) == Qtrue)
+    extensions = extensions | EXT_CRITIC | EXT_CRITIC_ACCEPT;
+  if (rb_funcall(self, rb_intern("critic_markup_reject_all"), 0) == Qtrue)
+    extensions = extensions | EXT_CRITIC | EXT_CRITIC_REJECT;
+  if (rb_funcall(self, rb_intern("random_footnote_anchor_numbers"), 0) == Qtrue)
+    extensions = extensions | EXT_RANDOM_FOOT;
+  if (rb_funcall(self, rb_intern("escaped_line_breaks"), 0) == Qtrue)
+    extensions = extensions | EXT_ESCAPED_LINE_BREAKS;
+
   /* Compatibility overwrites all other extensions */
   if (rb_funcall(self, rb_intern("compatibility"), 0) == Qtrue)
     extensions = EXT_COMPATIBILITY;

data/lib/multi_markdown.rb

@@ -13,55 +13,36 @@ require 'multi_markdown/version'
 #
 class MultiMarkdown
 
-  # Set `true` to have smarty-like quote translation performed.
-  attr_accessor :smart
+  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}
+  }
 
-  # Set `true` to have footnotes processed.
-  attr_accessor :notes
-
-  # Do not output `<style>` tags included in the source text.
-  attr_accessor :filter_styles
-
-  # Do not output any raw HTML included in the source text.
-  attr_accessor :filter_html
-
-  # Process MultiMarkdown inside of raw HTML
-  attr_accessor :process_html
-
-  # Markdown compatibility mode
-  attr_accessor :compatibility
-
-  # Included for compatibility with RedCloth's interface.
-  attr_accessor :fold_lines
+  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:
-  #
-  # * `:smart` - Enable SmartyPants processing.
-  # * `:notes` - Enable footnotes.
-  # * `:filter_styles` - Do not output `<style>` tags included in the
-  #   source text.
-  # * `:filter_html` - Do not output raw HTML included in the
-  #   source text.
-  # * `:process_html` - Process MultiMarkdown code inside HTML tags.
-  # * `:compatibility` - Process MultiMarkdown code in Markdown
-  #   compatibility mode (disables all other extensions)
-  # * `:fold_lines` - RedCloth compatible line folding (not used).
-  #
+  # set various processing options. See MultiMarkdown::EXTENSIONS for more.
   def initialize(text, *extensions)
     @text = text
-    @smart = true
-    @notes = true
-    @filter_styles = false
-    @filter_html = false
-    @process_html = false
-    @compatibility = false
-    extensions.each { |e| send("#{e}=", true) }
-    if @compatibility
-      @smart = false
-      @notes = false
-      @process_html = false
+    extensions.each do |ext|
+      raise "Unknown extension: #{ext.inspect}" unless EXTENSIONS.keys.include?(ext.to_s)
+      send("#{ext}=", true)
     end
   end
 

data/lib/multi_markdown/version.rb

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

data/test/extensions_test.rb.rb

@@ -0,0 +1,174 @@
+# encoding: UTF-8
+
+$: << File.join(File.dirname(__FILE__), "../lib")
+
+require 'test/unit'
+require 'multi_markdown'
+
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rmultimarkdown
 version: !ruby/object:Gem::Version
-  version: 4.6.0.1
+  version: 4.6.0.2
 platform: ruby
 authors:
 - Till Schulte-Coerne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2014-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,6 +44,7 @@ files:
 - lib/multi_markdown.bundle
 - lib/multi_markdown.rb
 - lib/rmultimarkdown.rb
+- test/extensions_test.rb.rb
 - test/multi_markdown_test.rb
 - ext/multi_markdown.c
 - ext/extconf.h
@@ -109,4 +110,5 @@ signing_key:
 specification_version: 4
 summary: A MultiMarkdown 4 binding for Ruby
 test_files:
+- test/extensions_test.rb.rb
 - test/multi_markdown_test.rb