motion-markdown-it-plugins 1.0.0

data/spec/container/api_spec.rb

@@ -0,0 +1,76 @@
+#------------------------------------------------------------------------------
+describe 'api' do
+  
+  #------------------------------------------------------------------------------
+  it 'renderer' do
+    md = MarkdownIt::Parser.new
+    md.use(MotionMarkdownItPlugins::Container, 'spoiler',
+      { render: lambda {|tokens, idx, _options, env, renderer| 
+                  tokens[idx].nesting == 1 ? "<details><summary>click me</summary>\n" : "</details>\n" }})
+    res = md.render("::: spoiler\n*content*\n:::\n")
+    expect(res).to eq "<details><summary>click me</summary>\n<p><em>content</em></p>\n</details>\n"
+  end
+
+  #------------------------------------------------------------------------------
+  it '2 char marker' do
+    md = MarkdownIt::Parser.new
+    md.use(MotionMarkdownItPlugins::Container, 'spoiler', {marker: '->'})
+    res = md.render("->->-> spoiler\n*content*\n->->->\n")
+    expect(res).to eq "<div class=\"spoiler\">\n<p><em>content</em></p>\n</div>\n"
+  end
+
+  #------------------------------------------------------------------------------
+  it 'marker should not collide with fence' do
+    md = MarkdownIt::Parser.new
+    md.use(MotionMarkdownItPlugins::Container, 'spoiler', {marker: '`'})
+    res = md.render("``` spoiler\n*content*\n```\n")
+    expect(res).to eq "<div class=\"spoiler\">\n<p><em>content</em></p>\n</div>\n"
+  end
+
+  #------------------------------------------------------------------------------
+  it 'marker should not collide with fence #2' do
+    md = MarkdownIt::Parser.new
+    md.use(MotionMarkdownItPlugins::Container, 'spoiler', {marker: '`'})
+    res = md.render("\n``` not spoiler\n*content*\n```\n")
+    expect(res).to eq "<pre><code class=\"language-not\">*content*\n</code></pre>\n"
+  end
+
+  #------------------------------------------------------------------------------
+  describe 'validator' do
+
+    #------------------------------------------------------------------------------
+    it 'should skip rule if return value is falsy' do
+      md = MarkdownIt::Parser.new
+      md.use(MotionMarkdownItPlugins::Container, 'name', {validate: lambda {|params| false} })
+      res = md.render(":::foo\nbar\n:::\n")
+      expect(res).to eq "<p>:::foo\nbar\n:::</p>\n"
+    end
+
+    #------------------------------------------------------------------------------
+    it 'should accept rule if return value is true' do
+      md = MarkdownIt::Parser.new
+      md.use(MotionMarkdownItPlugins::Container, 'name', {validate: lambda {|params| true} })
+      res = md.render(":::foo\nbar\n:::\n")
+      expect(res).to eq "<div class=\"name\">\n<p>bar</p>\n</div>\n"
+    end
+
+    #------------------------------------------------------------------------------
+    it 'rule should call it' do
+      count = 0
+
+      md = MarkdownIt::Parser.new
+      md.use(MotionMarkdownItPlugins::Container, 'name', {validate: lambda {|params| count += 1} })
+      md.parse(":\n::\n:::\n::::\n:::::\n", {})
+      expect(count).to eq 3
+    end
+
+    #------------------------------------------------------------------------------
+    it 'should not trim params' do
+      md = MarkdownIt::Parser.new
+      md.use(MotionMarkdownItPlugins::Container, 'name', 
+           {validate: lambda {|params| expect(params).to eq '     name '; return 1  } })
+      md.parse("::: \tname \ncontent\n:::\n", {})
+     end
+  end
+
+end

data/spec/container/default_spec.rb

@@ -0,0 +1,8 @@
+fixture_dir  = fixture_path('container/fixtures')
+
+#------------------------------------------------------------------------------
+describe 'default container' do
+  md = MarkdownIt::Parser.new
+  md.use(MotionMarkdownItPlugins::Container, 'name')
+  generate(File.join(fixture_dir, 'default.txt'), md)
+end

data/spec/container/misc_spec.rb

@@ -0,0 +1,17 @@
+#------------------------------------------------------------------------------
+describe 'coverage' do
+
+  #------------------------------------------------------------------------------
+  it 'marker coverage' do
+    md = MarkdownIt::Parser.new
+    md.use(MotionMarkdownItPlugins::Container, 'fox', 
+            { marker: 'foo',
+              validate: lambda {|params| expect(params).to eq 'fox'; return 1}
+              })
+    tok = md.parse("foofoofoofox\ncontent\nfoofoofoofoo\n", {})
+
+    expect(tok[0].markup).to eq 'foofoofoo'
+    expect(tok[0].info).to eq 'fox'
+    expect(tok[4].markup).to eq 'foofoofoofoo'
+  end
+end

data/spec/deflist/deflist_spec.rb

@@ -0,0 +1,9 @@
+fixture_dir  = fixture_path('deflist/fixtures')
+
+#------------------------------------------------------------------------------
+describe 'markdown-it-deflist' do
+  md = MarkdownIt::Parser.new
+  md.use(MotionMarkdownItPlugins::Deflist)
+
+  generate(File.join(fixture_dir, 'deflist.txt'), md)
+end

data/spec/ins/ins_spec.rb

@@ -0,0 +1,9 @@
+fixture_dir  = fixture_path('ins/fixtures')
+
+#------------------------------------------------------------------------------
+describe 'markdown-it-ins' do
+  md = MarkdownIt::Parser.new
+  md.use(MotionMarkdownItPlugins::Ins)
+
+  generate(File.join(fixture_dir, 'ins.txt'), md)
+end

data/spec/mark/mark_spec.rb

@@ -0,0 +1,9 @@
+fixture_dir  = fixture_path('mark/fixtures')
+
+#------------------------------------------------------------------------------
+describe 'markdown-it-mark' do
+  md = MarkdownIt::Parser.new
+  md.use(MotionMarkdownItPlugins::Mark)
+
+  generate(File.join(fixture_dir, 'mark.txt'), md)
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# make sure to have `--require spec_helper` in `.rspec` to have the
+# spec_helper.rb included automatically in spec files   
+require 'byebug'
+require 'benchmark'
+require 'motion-markdown-it-plugins'
+require 'testgen_helper'

data/spec/sub/sub_spec.rb

@@ -0,0 +1,9 @@
+fixture_dir  = fixture_path('sub/fixtures')
+
+#------------------------------------------------------------------------------
+describe 'markdown-it-sub' do
+  md = MarkdownIt::Parser.new
+  md.use(MotionMarkdownItPlugins::Sub)
+
+  generate(File.join(fixture_dir, 'sub.txt'), md)
+end

data/spec/sup/sup_spec.rb

@@ -0,0 +1,9 @@
+fixture_dir  = fixture_path('sup/fixtures')
+
+#------------------------------------------------------------------------------
+describe 'markdown-it-sup' do
+  md = MarkdownIt::Parser.new
+  md.use(MotionMarkdownItPlugins::Sup)
+
+  generate(File.join(fixture_dir, 'sup.txt'), md)
+end

data/spec/testgen_helper.rb

@@ -0,0 +1,80 @@
+#------------------------------------------------------------------------------
+def fixture_path(relative_path)
+  main_spec_dir = File.dirname(__FILE__)
+  fixture_dir   = File.join(main_spec_dir, relative_path)
+end
+
+#------------------------------------------------------------------------------
+def generate(datafile, parser)
+  tests = get_tests(datafile)
+
+  if ENV['example']
+    define_test(tests[ENV['example'].to_i - 1], parser, true)
+  else
+    tests.each do |t|
+      define_test(t, parser)
+    end
+  end
+end
+
+#------------------------------------------------------------------------------
+def get_tests(specfile)
+  line_number    = 0
+  start_line     = 0
+  end_line       = 0
+  example_number = 0
+  markdown_lines = []
+  html_lines     = []
+  state          = 0  # 0 regular text, 1 markdown example, 2 html output
+  headertext     = ''
+  tests          = []
+  header_re      = /#+ /
+  filename       = File.basename(specfile)
+  
+  File.open(specfile) do |specf|
+    specf.each_line do |line|
+      line_number += 1
+      if state == 0 && header_re =~ line
+        headertext = line.gsub(header_re, '').strip
+      end
+      if line.strip == "."
+        state = (state + 1) % 3
+        if state == 0
+          example_number += 1
+          end_line = line_number
+          tests << {
+              markdown:   markdown_lines.join.gsub('→',"\t"),
+              html:       html_lines.join,
+              example:    example_number,
+              start_line: start_line,
+              end_line:   end_line,
+              section:    headertext,
+              filename:   filename}
+          start_line     = 0
+          markdown_lines = []
+          html_lines     = []
+        end
+      elsif state == 1
+        if start_line == 0
+          start_line = line_number - 1
+        end
+        markdown_lines << line
+      elsif state == 2
+        html_lines << line
+      end
+    end
+  end
+  return tests
+end
+
+#------------------------------------------------------------------------------
+def define_test(testcase, parser, debug_tokens = false)
+
+  it "#{testcase[:filename]} #{testcase[:section]} (#{testcase[:example].to_s}/#{testcase[:start_line]}-#{testcase[:end_line]}) with markdown:\n#{testcase[:markdown]}" do
+    if debug_tokens
+      parser.parse(testcase[:markdown], { references: {} }).each {|token| pp token.to_json}
+    end
+    expect(parser.render(testcase[:markdown])).to eq testcase[:html]
+  end
+
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: motion-markdown-it-plugins
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brett Walker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: motion-markdown-it
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Plugins for use with motion-markdown-it
+email: github@digitalmoksha.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/motion-markdown-it-plugins.rb
+- lib/motion-markdown-it-plugins/abbr/abbr.rb
+- lib/motion-markdown-it-plugins/checkbox_replace/checkbox_replace.rb
+- lib/motion-markdown-it-plugins/container/container.rb
+- lib/motion-markdown-it-plugins/deflist/deflist.rb
+- lib/motion-markdown-it-plugins/ins/ins.rb
+- lib/motion-markdown-it-plugins/mark/mark.rb
+- lib/motion-markdown-it-plugins/sub/sub.rb
+- lib/motion-markdown-it-plugins/sup/sup.rb
+- lib/motion-markdown-it-plugins/version.rb
+- spec/abbr/abbr_spec.rb
+- spec/checkbox_replace/checkbox_replace_spec.rb
+- spec/container/api_spec.rb
+- spec/container/default_spec.rb
+- spec/container/misc_spec.rb
+- spec/deflist/deflist_spec.rb
+- spec/ins/ins_spec.rb
+- spec/mark/mark_spec.rb
+- spec/spec_helper.rb
+- spec/sub/sub_spec.rb
+- spec/sup/sup_spec.rb
+- spec/testgen_helper.rb
+homepage: https://github.com/digitalmoksha/motion-markdown-it-plugins
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Plugins for motion-markdown-it
+test_files:
+- spec/abbr/abbr_spec.rb
+- spec/checkbox_replace/checkbox_replace_spec.rb
+- spec/container/api_spec.rb
+- spec/container/default_spec.rb
+- spec/container/misc_spec.rb
+- spec/deflist/deflist_spec.rb
+- spec/ins/ins_spec.rb
+- spec/mark/mark_spec.rb
+- spec/spec_helper.rb
+- spec/sub/sub_spec.rb
+- spec/sup/sup_spec.rb
+- spec/testgen_helper.rb