greenmat 3.2.2.1 → 3.5.1.1

data/ext/greenmat/stack.h

@@ -1,3 +1,25 @@
+/*
+ * Copyright (c) 2015, Vicent Marti
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
 #ifndef STACK_H__
 #define STACK_H__
 

data/greenmat.gemspec

@@ -21,9 +21,10 @@ Gem::Specification.new do |s|
   s.executables = ["greenmat"]
   s.require_paths = ["lib"]
 
+  s.add_development_dependency "activesupport"
   s.add_development_dependency "nokogiri", "~> 1.6.0"
-  s.add_development_dependency "rake-compiler", "~> 0.8.3"
+  s.add_development_dependency "rake", "~> 12.2.1"
+  s.add_development_dependency "rake-compiler", "~> 1.0.3"
   s.add_development_dependency "rspec", "~> 3.2"
-  s.add_development_dependency "rubygems-xcodeproj_generator", '~> 0.1'
-  s.add_development_dependency "test-unit", "~> 2.5.4"
+  s.add_development_dependency "test-unit", "~> 3.2.3"
 end

data/lib/greenmat.rb

@@ -53,7 +53,7 @@ module Greenmat
           '>' => '>',
           '"' => '"',
           "'" => ''',
-          "/" => '&#x2F',
+          "/" => '/',
         })
       end
     end

data/lib/greenmat/cli.rb

@@ -0,0 +1,86 @@
+require 'greenmat'
+require 'optparse'
+
+module Greenmat
+  # This class aims at easing the creation of custom
+  # binary for your needs. For example, you can add new
+  # options or change the existing ones. The parsing
+  # is handled by Ruby's OptionParser. For instance:
+  #
+  #   class Custom::CLI < Greenmat::CLI
+  #     def self.options_parser
+  #       super.tap do |opts|
+  #         opts.on("--rainbow") do
+  #           @@options[:rainbow] = true
+  #         end
+  #       end
+  #     end
+  #
+  #     def self.render_object
+  #       @@options[:rainbow] ? RainbowRender : super
+  #     end
+  #   end
+  class CLI
+    def self.options_parser
+      @@options = {
+        render_extensions: {},
+        parse_extensions: {},
+        smarty_pants: false
+      }
+
+      OptionParser.new do |opts|
+        opts.banner = "Usage: greenmat [--parse <extension>...] " \
+                      "[--render <extension>...] [--smarty] <file>..."
+
+        opts.on("--parse EXTENSION", "Enable a parsing extension") do |ext|
+          ext = ext.gsub('-', '_').to_sym
+          @@options[:parse_extensions][ext] = true
+        end
+
+        opts.on("--render EXTENSION", "Enable a rendering extension") do |ext|
+          ext = ext.gsub('-', '_').to_sym
+          @@options[:render_extensions][ext] = true
+        end
+
+        opts.on("--smarty", "Enable Smarty Pants") do
+          @@options[:smarty_pants] = true
+        end
+
+        opts.on_tail("-v", "--version", "Display the current version") do
+          STDOUT.puts "Greenmat #{Greenmat::VERSION}"
+          exit
+        end
+
+        opts.on_tail("-h", "--help", "Display this help message") do
+          puts opts
+          exit
+        end
+      end
+    end
+
+    def self.process(args)
+      self.legacy_parse!(args)
+      self.options_parser.parse!(args)
+      STDOUT.write parser_object.render(ARGF.read)
+    end
+
+    def self.render_object
+      @@options[:smarty_pants] ? Render::SmartyHTML : Render::HTML
+    end
+
+    def self.parser_object
+      renderer = render_object.new(@@options[:render_extensions])
+      Greenmat::Markdown.new(renderer, @@options[:parse_extensions])
+    end
+
+    def self.legacy_parse!(args) # :nodoc:
+      # Workaround for backward compatibility as OptionParser
+      # doesn't support the --flag-OPTION syntax.
+      args.select {|a| a =~ /--(parse|render)-/ }.each do |arg|
+        args.delete(arg)
+        arg = arg.partition(/\b-/)
+        args.push(arg.first, arg.last)
+      end
+    end
+  end
+end

data/lib/greenmat/compat.rb

@@ -1,8 +1,3 @@
-require 'greenmat'
-
-# Deprecated: Please use the default API to parse Markdown
-# documents ; this layer will be removed in Greenmat 4.0.
-#
 # Creates an instance of Greenmat with the RedCloth API.
 class GreenmatCompat
   attr_accessor :text

data/lib/greenmat/render_strip.rb

@@ -13,7 +13,7 @@ module Greenmat
         :autolink, :codespan, :double_emphasis,
         :emphasis, :underline, :raw_html,
         :triple_emphasis, :strikethrough,
-        :superscript,
+        :superscript, :highlight, :quote,
 
         # footnotes
         :footnotes, :footnote_def, :footnote_ref,
@@ -43,6 +43,18 @@ module Greenmat
       def header(text, header_level)
         text + "\n"
       end
+
+      def table(header, body)
+        "#{header}#{body}"
+      end
+
+      def table_row(content)
+        content + "\n"
+      end
+
+      def table_cell(content, alignment)
+        content + "\t"
+      end
     end
   end
 end

data/lib/greenmat/version.rb

@@ -1,3 +1,3 @@
 module Greenmat
-  VERSION = '3.2.2.1'
+  VERSION = '3.5.1.1'
 end

data/spec/greenmat/markdown_spec.rb

@@ -1,4 +1,5 @@
 require 'greenmat'
+require "active_support/core_ext/string/strip"
 
 module Greenmat
   RSpec.describe Markdown do
@@ -61,5 +62,127 @@ module Greenmat
         end
       end
     end
+
+    context 'with fenced_code_blocks option' do
+      let(:options) { { fenced_code_blocks: true } }
+
+      context 'with language and filename syntax' do
+        let(:text) do
+          <<-EOS.strip_heredoc
+            ```ruby:example.rb
+            puts :foo
+            ```
+          EOS
+        end
+
+        it 'generates <code> tag with data-metadata attribute' do
+          expect(rendered_html).to eq <<-EOS.strip_heredoc
+            <pre><code data-metadata="ruby:example.rb">puts :foo
+            </code></pre>
+          EOS
+        end
+      end
+    end
+
+    context 'with deeply nested list' do
+      let(:text) do
+        <<-EOS.strip_heredoc
+          * 1
+              * 2
+                  * 3
+                      * 4
+                          * 5
+                              * 6
+                                  * 7
+                                      * 8
+                                          * 9
+                                              * 10
+                                                  * 11
+        EOS
+      end
+
+      it 'renders the list up to 10 nesting and then gives up' do
+        expect(rendered_html).to eq <<-EOS.strip_heredoc
+          <ul>
+          <li>1
+
+          <ul>
+          <li>2
+
+          <ul>
+          <li>3
+
+          <ul>
+          <li>4
+
+          <ul>
+          <li>5
+
+          <ul>
+          <li>6
+
+          <ul>
+          <li>7
+
+          <ul>
+          <li>8
+
+          <ul>
+          <li>9
+
+          <ul>
+          <li>10
+
+          <ul>
+          <li></li>
+          </ul></li>
+          </ul></li>
+          </ul></li>
+          </ul></li>
+          </ul></li>
+          </ul></li>
+          </ul></li>
+          </ul></li>
+          </ul></li>
+          </ul></li>
+          </ul>
+        EOS
+      end
+    end
+
+    context 'with a deeply nested structure that can exist in the wild' do
+      let(:text) do
+        <<-EOS.strip_heredoc
+          > > * 1
+          > >     * 2
+          > >         * 3
+          > >             * [_**Qiita**_](https://qiita.com)
+        EOS
+      end
+
+      it 'renders it properly' do
+        expect(rendered_html).to eq <<-EOS.strip_heredoc
+          <blockquote>
+          <blockquote>
+          <ul>
+          <li>1
+
+          <ul>
+          <li>2
+
+          <ul>
+          <li>3
+
+          <ul>
+          <li><a href="https://qiita.com"><em><strong>Qiita</strong></em></a></li>
+          </ul></li>
+          </ul></li>
+          </ul></li>
+          </ul>
+          </blockquote>
+          </blockquote>
+        EOS
+      end
+    end
   end
 end

data/test/custom_render_test.rb

@@ -4,16 +4,48 @@ require 'test_helper'
 class CustomRenderTest < Greenmat::TestCase
   class SimpleRender < Greenmat::Render::HTML
     def emphasis(text)
-      "<em class=\"cool\">#{text}</em>"
+      if @options[:no_intra_emphasis]
+        return %(<em class="no_intra_emphasis">#{text}</em>)
+      end
+
+      %(<em class="cool">#{text}</em>)
+    end
+
+    def header(text, level)
+      "My little poney" if @options[:with_toc_data]
     end
   end
 
   def test_simple_overload
     md = Greenmat::Markdown.new(SimpleRender)
-    html_equal "<p>This is <em class=\"cool\">just</em> a test</p>\n",
+    assert_equal "<p>This is <em class=\"cool\">just</em> a test</p>\n",
       md.render("This is *just* a test")
   end
 
+  def test_renderer_options
+    parser = Greenmat::Markdown.new(SimpleRender.new(with_toc_data: true))
+    output = parser.render("# A title")
+
+    assert_match "My little poney", output
+  end
+
+  def test_markdown_options
+    parser = Greenmat::Markdown.new(SimpleRender, no_intra_emphasis: true)
+    output = parser.render("*foo*")
+
+    assert_match "no_intra_emphasis", output
+  end
+
+  def test_original_options_hash_is_not_mutated
+    options = { with_toc_data: true }
+    render  = SimpleRender.new(options)
+    parser  = Greenmat::Markdown.new(render, tables: true)
+
+    computed_options = render.instance_variable_get(:"@options")
+
+    refute_equal computed_options.object_id, options.object_id
+  end
+
   class NilPreprocessRenderer < Greenmat::Render::HTML
     def preprocess(fulldoc)
       nil
@@ -25,4 +57,11 @@ class CustomRenderTest < Greenmat::TestCase
     assert_equal(nil,md.render("Anything"))
   end
 
+  def test_base_render_without_quote_callback
+    # Regression test for https://github.com/vmg/greenmat/issues/569
+    render = Class.new(Greenmat::Render::Base)
+    parser = Greenmat::Markdown.new render.new, quote: true
+
+    assert_equal "", parser.render(%(a "quote"))
+  end
 end

data/test/greenmat_bin_test.rb

@@ -0,0 +1,80 @@
+require 'test_helper'
+require 'tempfile'
+
+class GreenmatBinTest < Greenmat::TestCase
+  def setup
+    @fixture_file = Tempfile.new('bin')
+    @fixture_path = @fixture_file.path
+
+    @fixture_file.write "A ==simple== fixture file -- with " \
+                        "a [link](https://github.com)."
+    @fixture_file.rewind
+  end
+
+  def teardown
+    @fixture_file.unlink
+  end
+
+  def test_vanilla_bin
+    run_bin(@fixture_path)
+
+    expected = "<p>A ==simple== fixture file -- with " \
+               "a <a href=\"https://github.com\">link</a>.</p>\n"
+
+    assert_equal expected, @output
+  end
+
+  def test_enabling_a_parse_option
+    run_bin("--parse", "highlight", @fixture_path)
+
+    assert_output "<mark>"
+    refute_output "=="
+  end
+
+  def test_enabling_a_render_option
+    run_bin("--render", "no-links", @fixture_path)
+
+    assert_output "[link]"
+    refute_output "</a>"
+  end
+
+  def test_enabling_smarty_pants
+    run_bin("--smarty", @fixture_path)
+
+    assert_output "&ndash"
+    refute_output "--"
+  end
+
+  def test_version_option
+    run_bin("--version")
+    assert_output "Greenmat #{Greenmat::VERSION}"
+  end
+
+  def test_legacy_option_parsing
+    run_bin("--parse-highlight", "--render-no-links", @fixture_path)
+
+    assert_output "<mark>"
+    refute_output "=="
+
+    assert_output "[link]"
+    refute_output "</a>"
+  end
+
+  private
+
+  def run_bin(*args)
+    bin_path = File.expand_path('../../bin/greenmat', __FILE__)
+    ruby = RbConfig.ruby
+    IO.popen("#{ruby} #{bin_path} #{args.join(" ")}") do |stream|
+      @output = stream.read
+    end
+  end
+
+  def assert_output(pattern)
+    assert_match pattern, @output
+  end
+
+  def refute_output(pattern)
+    refute_match Regexp.new(pattern), @output
+  end
+end