markascend 0.1

data/readme

@@ -0,0 +1,4 @@
+Markascend is an extensible markdown-like, macro-powered html document syntax and processor.
+Can be used as blog-generator, post-formatter or for literate programing.
+
+More on website: http://luikore.github.io/markascend

data/test/builtin_macros_test.rb

@@ -0,0 +1,73 @@
+require_relative "test_helper"
+
+class BuiltinMacrosTest < BaseTest
+  def test_del_underline_sub_sup
+    %w[del underline sub sup].each do |x|
+      assert_equal "<#{x}>#{x}</#{x}>", parse("\\#{x}(#{x})")
+    end
+  end
+
+  def test_img
+    assert_equal %Q{<img src="src" alt="alt"/>}, parse("\\img(src alt='alt')")
+    assert_equal %Q{<a href="href"><img src="src" alt="alt"/></a>}, parse("\\img(src alt='alt' href='href')")
+  end
+
+  def test_html
+    html = %Q{<a href="href">a</a>&nbsp;}
+    assert_equal html, parse("\\html{#{html}}")
+  end
+
+  def test_slim
+    html = %Q{<a href="href">a</a>}
+    assert_equal html, parse("\\slim(a href='href' a)")
+  end
+
+  def test_csv
+    res = Markascend.compile <<-MA
+\\csv
+  name,type
+  "Ahri",Mage
+  "Miss Fortune",DPS
+\\headless_csv
+  "Fizz",DPS
+  Sejuani,Tank
+MA
+    table1 = "<thead><tr><th>name</th><th>type</th></tr></thead>" +
+             "<tbody><tr><td>Ahri</td><td>Mage</td></tr><tr><td>Miss Fortune</td><td>DPS</td></tr></tbody>"
+    table2 = "<tbody><tr><td>Fizz</td><td>DPS</td></tr><tr><td>Sejuani</td><td>Tank</td></tr></tbody>"
+    assert res.index table1
+    assert res.index table2
+  end
+
+  def test_latex
+    assert_equal %Q{<code class="latex">\\frac{y}{x}</code>}, parse("\\latex{\\frac{y}{x}}")
+  end
+
+  def test_dot
+    res = parse("\\dot(digraph G{main -> parse;})").strip
+    src = Nokogiri::XML(res).xpath('//@src').text[/(?<=,).+$/]
+    f = Tempfile.new('img')
+    f << Base64.decode64(src)
+    path = f.path
+    f.close
+    output = `file #{path}`
+    assert output.index('PNG image data'), %Q|generated data should be png: but got #{output.inspect}|
+  end
+
+  def test_options
+    parse("\\options(a: [1, 2])")
+    assert_equal({"a" => [1, 2]}, @env.options)
+  end
+
+  def test_hi
+    parse("\\hi(none)")
+    assert_equal nil, @env.hi
+    parse("\\hi(c)\\hi(ruby)")
+    assert_equal 'ruby', @env.hi
+  end
+
+  def parse src
+    l = LineUnit.new @env, src, nil
+    l.parse
+  end
+end

data/test/line_unit_test.rb

@@ -0,0 +1,40 @@
+require_relative "test_helper"
+
+class LineUnitTest < BaseTest
+  def test_nested_italic_and_bold
+    assert_equal 'outside<b><i>i</i>b</b>', parse('outside***i*b**').join
+  end
+
+  def test_code
+    assert_equal '<code class="highlight">\\\\code</code>', parse('`\\\\code`').join
+    assert_equal '<code class="highlight">c`ode</code>', parse('``c`ode``').join
+    assert_equal '<code class="highlight"> </code>`', parse('`` ```').join
+  end
+
+  def test_math
+    assert_equal '<code class="math">\\\\math\$ </code>', parse('$\\\\math\$ $').join
+  end
+
+  def test_link
+    assert_equal '<a href="href">a</a>', parse('[a](href)').join
+  end
+
+  def test_footnote
+    assert_equal '<a href="#footnote-1">1</a>', parse('[.](first note)').join
+    assert_equal '<a href="#footnote-2">two</a>', parse('[.two](second note)').join
+    assert_equal [:footnote_id_ref, 1], parse('[:1]').first
+    assert_equal [:footnote_id_ref, 22], parse('[:22]').first
+    assert_equal [:footnote_acronym_ref, "two"], parse('[:two]').first
+  end
+
+  def test_sandbox_footnote
+    make_sandbox_env
+    first_note = '[.](first note)'
+    assert_equal first_note, parse('[.](first note)').join
+  end
+
+  def parse src
+    l = LineUnit.new @env, src, nil
+    l.parse []
+  end
+end

data/test/markascend_test.rb

@@ -0,0 +1,19 @@
+require_relative "test_helper"
+
+class MarkascendTest < BaseTest
+  def test_strip_tags
+    assert_equal '', Markascend.strip_tags('<script fraud-prop="></script>"></script>')
+    assert_equal 'Bold', Markascend.strip_tags('<b>Bold</b>')
+  end
+
+  def test_toc
+    res = Markascend.compile <<-MA, toc: true
+h1 h1
+h5 h5
+h3 h3
+    MA
+    dom = Nokogiri::HTML(res).xpath('//div[@id="toc"]/ol').first
+    assert_equal ['li', 'ol'], dom.children.map(&:name)
+    assert_equal ['ol', 'li'], dom.children[1].children.map(&:name)
+  end
+end

data/test/parser_test.rb

@@ -0,0 +1,93 @@
+require_relative "test_helper"
+
+class ParserTest < BaseTest
+  def test_hx
+    b = Parser.new @env, "h1#cen-tered lovely day!"
+    assert_equal "<h1 id=\"cen-tered\">lovely day!</h1>", b.parse
+  end
+
+  def test_sandbox_hx
+    make_sandbox_env
+    b = Parser.new @env, "h1#cen-tered lovely day!"
+    assert_equal "<h1>lovely day!</h1>", b.parse
+  end
+
+  def test_blocked_hx
+    b = Parser.new @env, "h3 followed by \\nop a block\n  content of block"
+    assert_equal "<h3>followed by \\nop a block</h3>", b.parse
+  end
+
+  def test_rec_block
+    b = Parser.new @env, <<-MA
+- ul1
+- ul2
+  + ol1
+  + ol2
+- > quote1
+    quote2
+MA
+    ol = "<ol><li>ol1</li>" + "<li>ol2</li></ol>"
+    quote = "<quote>quote1<br>quote2</quote>"
+    ul = "<ul><li>ul1</li>" + "<li>ul2#{ol}</li>" + "<li>#{quote}</li></ul>"
+    assert_equal ul, b.parse.strip
+  end
+
+  def test_warning_line
+    # should generate warning for missing macro contents
+    b = Parser.new @env, <<-MA
+- ul1
+  + ol1
+    - ul2
+      + ol2 \\img()
+MA
+    b.parse
+    assert b.warnings[4]
+  end
+
+  def test_code_block
+    code_text = proc do |b|
+      t = Nokogiri::HTML(b.parse.strip).xpath('//pre/code').text
+      CGI.unescape_html(t).strip
+    end
+
+    b = Parser.new @env, <<-MA
+|ruby
+  puts 'hello world'
+MA
+    assert_equal "puts 'hello world'", code_text[b]
+
+    b = Parser.new @env, <<-MA
+|
+  puts 'hello world'
+MA
+    assert_equal "puts 'hello world'", code_text[b]
+  end
+
+  def test_inline_macro_fallback_but_block_macro_not
+    invalid = "\\invalid{ <content> }"
+    expected = "<p>#{CGI.escape_html invalid}</p>"
+    assert_equal expected, Parser.new(@env, invalid).parse
+
+    invalid = "\\invalid\n  <content>"
+    assert_equal "<p>\\invalid</p>", Parser.new(@env, invalid).parse
+  end
+
+  def test_sandbox_macro
+    make_sandbox_env
+    src = '\options(a.png)'
+    expected = "<p>#{CGI.escape_html src}</p>"
+    assert_equal expected, Parser.new(@env, src).parse
+  end
+
+  def test_validate_default_macro_list
+    assert_equal Macro.instance_methods.grep(/parse_/).map(&:to_s).sort, Markascend::DEFAULT_MACROS.values.sort
+  end
+
+  def test_validate_default_line_unit_parser_list
+    assert_equal LineUnit.instance_methods.grep(/parse_/).map(&:to_s).sort, Markascend::DEFAULT_LINE_UNITS.sort
+  end
+
+  def test_footnote_validation
+
+  end
+end

data/test/popular_company_macros_test.rb

@@ -0,0 +1,42 @@
+require_relative "test_helper"
+
+class PopularCompanyMacrosTest < BaseTest
+  def test_twitter
+    assert_equal %Q{<a href="https://twitter.com/dhh">@dhh</a>}, parse("\\twitter(@dhh)")
+  end
+
+  def test_weibo
+    assert_equal %Q{<a href="https://weibo.com/dhh">@dhh</a>}, parse("\\weibo(@dhh)")
+  end
+
+  def test_wiki
+    assert_equal %Q|<a href="http://en.wikipedia.org/wiki/ruby(programing_language)">ruby(programing_language)</a>|, parse("\\wiki{ruby(programing_language)}")
+  end
+
+  def test_gist
+    res = %Q{<script src="https://gist.github.com/luikore/737238.js"></script>}
+    assert_equal res, parse("\\gist(luikore/737238)")
+    assert_equal res, parse("\\gist(luikore/737238.git)")
+    assert_equal res, parse("\\gist(gist.github.com/luikore/737238.git)")
+    assert_equal res, parse("\\gist(https://gist.github.com/luikore/737238)")
+  end
+
+  def test_video
+    youtube = parse("\\video(400x200 youtu.be/watch?v=TGPvtlnwH6E)")
+    assert youtube.start_with? '<iframe width="400" height="200"'
+    assert youtube.index('/embed/TGPvtlnwH6E'), youtube.inspect
+
+    vimeo = parse("\\video(400x200 vimeo.com/36820781)")
+    assert vimeo.start_with?('<iframe width="400" height="200"'), vimeo.inspect
+    assert vimeo.index('/video/36820781'), vimeo.inspect
+
+    nico = parse("\\video(400x200 sm32768)")
+    assert nico.start_with?('<script '), nico.inspect
+    assert nico.index('/thumb_watch/sm32768'), nico.inspect
+  end
+
+  def parse src
+    l = LineUnit.new @env, src, nil
+    l.parse
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require "test/unit"
+require_relative "../lib/markascend"
+begin
+  require "pry"
+rescue LoadError
+end
+
+require "slim"
+require "nokogiri" # for parsing the result
+require "tempfile"
+
+class BaseTest < Test::Unit::TestCase
+  include Markascend
+  def setup
+    @env = Env.new({})
+  end
+
+  def make_sandbox_env
+    @env = Env.new sandbox: true
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: markascend
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Zete Lui
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-08 00:00:00.000000000 Z
+dependencies: []
+description: Extensible markdown-like, macro-powered html document syntax and processor
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- readme
+- copying
+- lib/markascend/builtin_macros.rb
+- lib/markascend/env.rb
+- lib/markascend/line_unit.rb
+- lib/markascend/macro.rb
+- lib/markascend/parser.rb
+- lib/markascend/popular_company_macros.rb
+- lib/markascend.rb
+- test/builtin_macros_test.rb
+- test/line_unit_test.rb
+- test/markascend_test.rb
+- test/parser_test.rb
+- test/popular_company_macros_test.rb
+- test/test_helper.rb
+- Gemfile
+- rakefile
+- doc/api.ma
+- doc/index.ma
+- doc/syntax.ma
+homepage: https://github.com/luikore/markascend
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Extensible markdown-like, macro-powered html document syntax and processor
+test_files: []
+has_rdoc: false