commonmarker 0.5.0 → 0.5.1

data/lib/commonmarker.rb

@@ -13,12 +13,15 @@ module CommonMarker
   # Public:  Parses a Markdown string into an HTML string.
   #
   # text - A {String} of text
-  # option - Either a {Symbol} or {Array of Symbol}s indicating the parse options
+  # option - Either a {Symbol} or {Array of Symbol}s indicating the render options
   #
   # Returns a {String} of converted HTML.
-  def self.render_html(text, option = :default)
+  def self.render_html(text, options = :default)
     fail TypeError, 'text must be a string!' unless text.is_a?(String)
-    Node.markdown_to_html(text.encode('UTF-8'), Config.process_options(option)).force_encoding('UTF-8')
+    opts = Config.process_options(options, :render)
+    text = text.encode('UTF-8')
+    html = Node.markdown_to_html(text, opts)
+    html.force_encoding('UTF-8')
   end
 
   # Public: Parses a Markdown string into a `document` node.
@@ -27,10 +30,11 @@ module CommonMarker
   # option - A {Symbol} or {Array of Symbol}s indicating the parse options
   #
   # Returns the `document` node.
-  def self.render_doc(text, option = :default)
+  def self.render_doc(text, options = :default)
     fail TypeError, 'text must be a string!' unless text.is_a?(String)
+    opts = Config.process_options(options, :parse)
     text = text.encode('UTF-8')
-    Node.parse_document(text, text.bytesize, Config.process_options(option))
+    Node.parse_document(text, text.bytesize, opts)
   end
 
   class Node
@@ -46,9 +50,12 @@ module CommonMarker
 
     # Public: Convert the node to an HTML string.
     #
+    # options - A {Symbol} or {Array of Symbol}s indicating the render options
+    #
     # Returns a {String}.
-    def to_html(option = :default)
-      _render_html(Config.process_options(option)).force_encoding('utf-8')
+    def to_html(options = :default)
+      opts = Config.process_options(options, :render)
+      _render_html(opts).force_encoding('utf-8')
     end
 
     # Internal: Iterate over the children (if any) of the current pointer.

data/lib/commonmarker/config.rb

@@ -1,34 +1,42 @@
 require 'ruby-enum'
-
 module CommonMarker
-  # For Ruby::Enum, this must be a class, not a module
-  class Config
-    include Ruby::Enum
+  # For Ruby::Enum, these must be classes, not modules
+  module Config
+    class Parse
+      include Ruby::Enum
+
+      define :default, 0
+      define :normalize, 4
+      define :validate_utf8, 16
+      define :smart, 8
+    end
 
-    define :default, 0
-    define :sourcepos, 1
-    define :hardbreaks, 2
-    define :normalize, 4
-    define :smart, 8
-    define :validate_utf8, 16
-    define :safe, 32
+    class Render
+      include Ruby::Enum
+
+      define :default, 0
+      define :sourcepos, 1
+      define :hardbreaks, 2
+      define :safe, 32
+    end
 
-    def self.process_options(option)
+    def self.process_options(option, type)
+      type = Config.const_get(type.capitalize)
       if option.is_a?(Symbol)
-        check_option(option)
-        Config.to_h[option]
+        check_option(option, type)
+        type.to_h[option]
       elsif option.is_a?(Array)
         option = [nil] if option.empty?
         # neckbearding around. the map will both check the opts and then bitwise-OR it
-        option.map { |o| Config.check_option(o); Config.to_h[o] }.inject(0, :|)
+        option.map { |o| check_option(o, type); type.to_h[o] }.inject(0, :|)
       else
-        fail TypeError, 'delimiter type must be a valid symbol or array of symbols'
+        fail TypeError, 'option type must be a valid symbol or array of symbols'
       end
     end
 
-    def self.check_option(option)
-      unless Config.keys.include?(option)
-        fail TypeError, "option #{option} does not exist"
+    def self.check_option(option, type)
+      unless type.keys.include?(option)
+        fail TypeError, "option ':#{option}' does not exist for #{type}"
       end
     end
   end

data/lib/commonmarker/version.rb

@@ -1,3 +1,3 @@
 module CommonMarker
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/test/test_encoding.rb

@@ -4,7 +4,8 @@ class TestEncoding < Minitest::Test
   # see http://git.io/vq4FR
   def test_encoding
     contents = File.read(File.join(FIXTURES_DIR, 'curly.md'))
-    render = CommonMarker.render_html(contents, :smart)
+    doc = CommonMarker.render_doc(contents, :smart)
+    render = doc.to_html
     assert_equal render.rstrip, '<p>This curly quote “makes commonmarker throw an exception”.</p>'
   end
 end

data/test/test_linebreaks.rb

@@ -3,17 +3,11 @@ require 'test_helper'
 class TestLinebreaks < Minitest::Test
   def test_hardbreak_no_spaces
     doc = CommonMarker.render_doc("foo\nbaz")
-    assert_equal "<p>foo\nbaz</p>\n", doc.to_html
-
-    doc = CommonMarker.render_doc("foo\nbaz", :hardbreaks)
     assert_equal "<p>foo<br />\nbaz</p>\n", doc.to_html(:hardbreaks)
   end
 
   def test_hardbreak_with_spaces
     doc = CommonMarker.render_doc("foo  \nbaz")
-    assert_equal "<p>foo<br />\nbaz</p>\n", doc.to_html
-
-    doc = CommonMarker.render_doc("foo  \nbaz", :hardbreaks)
     assert_equal "<p>foo<br />\nbaz</p>\n", doc.to_html(:hardbreaks)
   end
 end

data/test/test_maliciousness.rb

@@ -64,10 +64,20 @@ class CommonMarker::TestMaliciousness < Minitest::Test
       CommonMarker.render_html(nil)
     end
 
+    err = assert_raises TypeError do
+      CommonMarker.render_html("foo \n baz", [:smart])
+    end
+    assert_equal err.message, 'option \':smart\' does not exist for CommonMarker::Config::Render'
+
     assert_raises TypeError do
       CommonMarker.render_doc("foo \n baz", 123)
     end
 
+    err = assert_raises TypeError do
+      CommonMarker.render_doc("foo \n baz", :safe)
+    end
+    assert_equal err.message, 'option \':safe\' does not exist for CommonMarker::Config::Parse'
+
     assert_raises TypeError do
       CommonMarker.render_doc("foo \n baz", :totes_fake)
     end

data/test/test_smartpunct.rb

@@ -4,7 +4,7 @@ class SmartPunctTest < Minitest::Test
   smart_punct = open_spec_file('smart_punct.txt', normalize: true)
 
   smart_punct.each do |testcase|
-    doc = CommonMarker.render_doc(testcase[:markdown], [:smart])
+    doc = CommonMarker.render_doc(testcase[:markdown], :smart)
 
     define_method("test_smart_punct_example_#{testcase[:example]}") do
       actual = doc.to_html.strip
@@ -12,4 +12,11 @@ class SmartPunctTest < Minitest::Test
       assert_equal testcase[:html], actual, testcase[:markdown]
     end
   end
+
+  def test_smart_hardbreak_no_spaces_render_doc
+    markdown = "\"foo\"\nbaz"
+    result = "<p>“foo”<br />\nbaz</p>\n"
+    doc = CommonMarker.render_doc(markdown, :smart)
+    assert_equal result, doc.to_html([:hardbreaks])
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-enum
@@ -149,6 +149,15 @@ files:
 - ext/commonmarker/cmark/build/CMakeFiles/2.8.10.1/CompilerIdC/a.out
 - ext/commonmarker/cmark/build/CMakeFiles/2.8.10.1/CompilerIdCXX/CMakeCXXCompilerId.cpp
 - ext/commonmarker/cmark/build/CMakeFiles/2.8.10.1/CompilerIdCXX/a.out
+- ext/commonmarker/cmark/build/CMakeFiles/3.3.2/CMakeCCompiler.cmake
+- ext/commonmarker/cmark/build/CMakeFiles/3.3.2/CMakeCXXCompiler.cmake
+- ext/commonmarker/cmark/build/CMakeFiles/3.3.2/CMakeDetermineCompilerABI_C.bin
+- ext/commonmarker/cmark/build/CMakeFiles/3.3.2/CMakeDetermineCompilerABI_CXX.bin
+- ext/commonmarker/cmark/build/CMakeFiles/3.3.2/CMakeSystem.cmake
+- ext/commonmarker/cmark/build/CMakeFiles/3.3.2/CompilerIdC/CMakeCCompilerId.c
+- ext/commonmarker/cmark/build/CMakeFiles/3.3.2/CompilerIdC/a.out
+- ext/commonmarker/cmark/build/CMakeFiles/3.3.2/CompilerIdCXX/CMakeCXXCompilerId.cpp
+- ext/commonmarker/cmark/build/CMakeFiles/3.3.2/CompilerIdCXX/a.out
 - ext/commonmarker/cmark/build/CMakeFiles/CMakeDirectoryInformation.cmake
 - ext/commonmarker/cmark/build/CMakeFiles/CMakeError.log
 - ext/commonmarker/cmark/build/CMakeFiles/CMakeOutput.log
@@ -156,6 +165,9 @@ files:
 - ext/commonmarker/cmark/build/CMakeFiles/Makefile2
 - ext/commonmarker/cmark/build/CMakeFiles/TargetDirectories.txt
 - ext/commonmarker/cmark/build/CMakeFiles/cmake.check_cache
+- ext/commonmarker/cmark/build/CMakeFiles/feature_tests.bin
+- ext/commonmarker/cmark/build/CMakeFiles/feature_tests.c
+- ext/commonmarker/cmark/build/CMakeFiles/feature_tests.cxx
 - ext/commonmarker/cmark/build/CMakeFiles/progress.marks
 - ext/commonmarker/cmark/build/CTestTestfile.cmake
 - ext/commonmarker/cmark/build/Makefile
@@ -390,7 +402,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: CommonMark parser and renderer. Written in C, wrapped in Ruby.