commonmarker 0.8.0 → 0.9.0

data/ext/commonmarker/commonmarker.h

@@ -1,8 +1,8 @@
 #ifndef COMMONMARKER_H
 #define COMMONMARKER_H
 
-#include "ruby.h"
 #include "cmark.h"
+#include "ruby.h"
 
 #define CSTR2SYM(s) (ID2SYM(rb_intern((s))))
 

data/lib/commonmarker.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require 'commonmarker/commonmarker'
 require 'commonmarker/config'
+require 'commonmarker/node'
 require 'commonmarker/renderer'
 require 'commonmarker/renderer/html_renderer'
 require 'commonmarker/version'
@@ -36,36 +37,4 @@ module CommonMarker
     text = text.encode('UTF-8')
     Node.parse_document(text, text.bytesize, opts)
   end
-
-  class Node
-    # Public: An iterator that "walks the tree," descending into children recursively.
-    #
-    # blk - A {Proc} representing the action to take for each child
-    def walk(&blk)
-      yield self
-      each_child do |child|
-        child.walk(&blk)
-      end
-    end
-
-    # 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(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.
-    def each_child
-      child = first_child
-      while child
-        nextchild = child.next
-        yield child
-        child = nextchild
-      end
-    end
-  end
 end

data/lib/commonmarker/node.rb

@@ -0,0 +1,45 @@
+module CommonMarker
+  class Node
+    include Enumerable
+
+    # Public: An iterator that "walks the tree," descending into children recursively.
+    #
+    # blk - A {Proc} representing the action to take for each child
+    def walk(&block)
+      return enum_for(:walk) unless block_given?
+
+      yield self
+      each do |child|
+        child.walk(&block)
+      end
+    end
+
+    # 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(options = :default)
+      opts = Config.process_options(options, :render)
+      _render_html(opts).force_encoding('utf-8')
+    end
+
+    # Public: Iterate over the children (if any) of the current pointer.
+    def each(&block)
+      return enum_for(:each) unless block_given?
+
+      child = first_child
+      while child
+        nextchild = child.next
+        yield child
+        child = nextchild
+      end
+    end
+
+    # Deprecated: Please use `each` instead
+    def each_child(&block)
+      warn '[DEPRECATION] `each_child` is deprecated.  Please use `each` instead.'
+      each(&block)
+    end
+  end
+end

data/lib/commonmarker/renderer.rb

@@ -16,7 +16,7 @@ module CommonMarker
     def out(*args)
       args.each do |arg|
         if arg == :children
-          @node.each_child { |child| out(child) }
+          @node.each { |child| out(child) }
         elsif arg.is_a?(Array)
           arg.each { |x| render(x) }
         elsif arg.is_a?(Node)
@@ -34,7 +34,7 @@ module CommonMarker
         document(node)
         return @stream.string
       elsif @in_plain && node.type != :text && node.type != :softbreak
-        node.each_child { |child| render(child) }
+        node.each { |child| render(child) }
       else
         begin
           send(node.type, node)

data/lib/commonmarker/version.rb

@@ -1,3 +1,3 @@
 module CommonMarker
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/test/test_basics.rb

@@ -1,53 +1,14 @@
 require 'test_helper'
 
-class TestNode < Minitest::Test
+class TestBasics < Minitest::Test
   def setup
     @doc = CommonMarker.render_doc('Hi *there*')
   end
 
-  def test_walk
-    nodes = []
-    @doc.walk do |node|
-      nodes << node.type
-    end
-    assert_equal [:document, :paragraph, :text, :emph, :text], nodes
-  end
-
-  def test_insert_illegal
-    assert_raises NodeError do
-      @doc.insert_before(@doc)
-    end
-  end
-
   def test_to_html
     assert_equal "<p>Hi <em>there</em></p>\n", @doc.to_html
   end
 
-  def test_html_renderer
-    renderer = HtmlRenderer.new
-    result = renderer.render(@doc)
-    assert_equal "<p>Hi <em>there</em></p>\n", result
-  end
-
-  def test_walk_and_set_string_content
-    @doc.walk do |node|
-      if node.type == :text && node.string_content == 'there'
-        node.string_content = 'world'
-        assert_equal 'world', node.string_content
-      end
-    end
-  end
-
-  def test_walk_and_delete_node
-    @doc.walk do |node|
-      if node.type == :emph
-        node.insert_before(node.first_child)
-        node.delete
-      end
-    end
-    assert_equal "<p>Hi there</p>\n", @doc.to_html
-  end
-
   def test_markdown_to_html
     html = CommonMarker.render_html('Hi *there*')
     assert_equal "<p>Hi <em>there</em></p>\n", html

data/test/test_node.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+
+class TestNode < Minitest::Test
+  def setup
+    @doc = CommonMarker.render_doc('Hi *there*, I am mostly text!')
+  end
+
+  def test_walk
+    nodes = []
+    @doc.walk do |node|
+      nodes << node.type
+    end
+    assert_equal [:document, :paragraph, :text, :emph, :text, :text, :text], nodes
+  end
+
+  def test_each
+    nodes = []
+    @doc.first_child.each do |node|
+      nodes << node.type
+    end
+    assert_equal [:text, :emph, :text, :text], nodes
+  end
+
+  def test_deprecated_each_child
+    nodes = []
+    @doc.first_child.each_child do |node|
+      nodes << node.type
+    end
+    assert_equal [:text, :emph, :text, :text], nodes
+  end
+
+  def test_select
+    nodes = @doc.first_child.select { |node| node.type == :text }
+    assert_equal CommonMarker::Node, nodes.first.class
+    assert_equal [:text, :text, :text], nodes.map(&:type)
+  end
+
+  def test_map
+    nodes = @doc.first_child.map(&:type)
+    assert_equal [:text, :emph, :text, :text], nodes
+  end
+
+  def test_insert_illegal
+    assert_raises NodeError do
+      @doc.insert_before(@doc)
+    end
+  end
+
+  def test_to_html
+    assert_equal "<p>Hi <em>there</em>, I am mostly text!</p>\n", @doc.to_html
+  end
+
+  def test_html_renderer
+    renderer = HtmlRenderer.new
+    result = renderer.render(@doc)
+    assert_equal "<p>Hi <em>there</em>, I am mostly text!</p>\n", result
+  end
+
+  def test_walk_and_set_string_content
+    @doc.walk do |node|
+      if node.type == :text && node.string_content == 'there'
+        node.string_content = 'world'
+      end
+    end
+    result = HtmlRenderer.new.render(@doc)
+    assert_equal "<p>Hi <em>world</em>, I am mostly text!</p>\n", result
+  end
+
+  def test_walk_and_delete_node
+    @doc.walk do |node|
+      if node.type == :emph
+        node.insert_before(node.first_child)
+        node.delete
+      end
+    end
+    assert_equal "<p>Hi there, I am mostly text!</p>\n", @doc.to_html
+  end
+end

data/test/test_renderer.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class TestRenderer < Minitest::Test
+  def setup
+    @doc = CommonMarker.render_doc('Hi *there*')
+  end
+
+  def test_html_renderer
+    renderer = HtmlRenderer.new
+    result = renderer.render(@doc)
+    assert_equal "<p>Hi <em>there</em></p>\n", result
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-enum
@@ -140,15 +140,15 @@ files:
 - ext/commonmarker/cmark/bench/stats.py
 - ext/commonmarker/cmark/benchmarks.md
 - ext/commonmarker/cmark/build/CMakeCache.txt
-- ext/commonmarker/cmark/build/CMakeFiles/3.5.1/CMakeCCompiler.cmake
-- ext/commonmarker/cmark/build/CMakeFiles/3.5.1/CMakeCXXCompiler.cmake
-- ext/commonmarker/cmark/build/CMakeFiles/3.5.1/CMakeDetermineCompilerABI_C.bin
-- ext/commonmarker/cmark/build/CMakeFiles/3.5.1/CMakeDetermineCompilerABI_CXX.bin
-- ext/commonmarker/cmark/build/CMakeFiles/3.5.1/CMakeSystem.cmake
-- ext/commonmarker/cmark/build/CMakeFiles/3.5.1/CompilerIdC/CMakeCCompilerId.c
-- ext/commonmarker/cmark/build/CMakeFiles/3.5.1/CompilerIdC/a.out
-- ext/commonmarker/cmark/build/CMakeFiles/3.5.1/CompilerIdCXX/CMakeCXXCompilerId.cpp
-- ext/commonmarker/cmark/build/CMakeFiles/3.5.1/CompilerIdCXX/a.out
+- ext/commonmarker/cmark/build/CMakeFiles/3.5.2/CMakeCCompiler.cmake
+- ext/commonmarker/cmark/build/CMakeFiles/3.5.2/CMakeCXXCompiler.cmake
+- ext/commonmarker/cmark/build/CMakeFiles/3.5.2/CMakeDetermineCompilerABI_C.bin
+- ext/commonmarker/cmark/build/CMakeFiles/3.5.2/CMakeDetermineCompilerABI_CXX.bin
+- ext/commonmarker/cmark/build/CMakeFiles/3.5.2/CMakeSystem.cmake
+- ext/commonmarker/cmark/build/CMakeFiles/3.5.2/CompilerIdC/CMakeCCompilerId.c
+- ext/commonmarker/cmark/build/CMakeFiles/3.5.2/CompilerIdC/a.out
+- ext/commonmarker/cmark/build/CMakeFiles/3.5.2/CompilerIdCXX/CMakeCXXCompilerId.cpp
+- ext/commonmarker/cmark/build/CMakeFiles/3.5.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
@@ -353,10 +353,12 @@ files:
 - ext/commonmarker/cmark/wrappers/wrapper.rb
 - ext/commonmarker/cmark/wrappers/wrapper.rkt
 - ext/commonmarker/commonmarker.c
+- ext/commonmarker/commonmarker.c.orig
 - ext/commonmarker/commonmarker.h
 - ext/commonmarker/extconf.rb
 - lib/commonmarker.rb
 - lib/commonmarker/config.rb
+- lib/commonmarker/node.rb
 - lib/commonmarker/renderer.rb
 - lib/commonmarker/renderer/html_renderer.rb
 - lib/commonmarker/version.rb
@@ -371,7 +373,9 @@ files:
 - test/test_helper.rb
 - test/test_linebreaks.rb
 - test/test_maliciousness.rb
+- test/test_node.rb
 - test/test_pathological_inputs.rb
+- test/test_renderer.rb
 - test/test_smartpunct.rb
 - test/test_spec.rb
 homepage: http://github.com/gjtorikian/commonmarker
@@ -411,6 +415,8 @@ test_files:
 - test/test_helper.rb
 - test/test_linebreaks.rb
 - test/test_maliciousness.rb
+- test/test_node.rb
 - test/test_pathological_inputs.rb
+- test/test_renderer.rb
 - test/test_smartpunct.rb
 - test/test_spec.rb