paru 0.2.5c → 0.2.5f

data/lib/paru/filter/node.rb

@@ -16,14 +16,24 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "../pandoc.rb"
+
+require_relative './ast_manipulation.rb'
+
 module Paru
     # PandocFilter is a module containig the paru's Filter functionality 
     module PandocFilter
+        # A Paru::Pandoc converter from JSON to markdown
+        AST2MARKDOWN = Paru::Pandoc.new do
+            from "json"
+            to "markdown"
+        end
 
-        require_relative "./ast_manipulation"
-        require_relative "./markdown"
-        require_relative "../pandoc"
-        require_relative "./document"
+        # A Paru::Pandoc converter from markdown to JSON
+        MARKDOWN2JSON = Paru::Pandoc.new do
+            from "markdown"
+            to "json"
+        end
 
         # Every node in a Pandoc AST is mapped to Node. Filters are all about
         # manipulating Nodes.
@@ -33,22 +43,68 @@ module Paru
         class Node
             include Enumerable
             include ASTManipulation
-            include Markdown
 
             attr_accessor :parent
 
-            Dir[File.dirname(__FILE__) + '/*.rb'].each do |file|
-                require_relative file
-            end
+            # Block level nodes
+            require_relative './block_quote.rb'
+            require_relative './block.rb'
+            require_relative './bullet_list.rb'
+            require_relative './code_block.rb'
+            require_relative './definition_list_item.rb'
+            require_relative './definition_list.rb'
+            require_relative './div.rb'
+            require_relative './empty_block.rb'
+            require_relative './header.rb'
+            require_relative './horizontal_rule.rb'
+            require_relative './line_block.rb'
+            require_relative './null.rb'
+            require_relative './ordered_list.rb'
+            require_relative './para.rb'
+            require_relative './plain.rb'
+            require_relative './raw_block.rb'
+            require_relative './table.rb'
+            require_relative './table_row.rb'
+
+            # Inline level nodes
+            require_relative './cite.rb'
+            require_relative './code.rb'
+            require_relative './emph.rb'
+            require_relative './empty_inline.rb'
+            require_relative './image.rb'
+            require_relative './inline.rb'
+            require_relative './line_break.rb'
+            require_relative './link.rb'
+            require_relative './math.rb'
+            require_relative './note.rb'
+            require_relative './quoted.rb'
+            require_relative './raw_inline.rb'
+            require_relative './small_caps.rb'
+            require_relative './soft_break.rb'
+            require_relative './space.rb'
+            require_relative './span.rb'
+            require_relative './strikeout.rb'
+            require_relative './strong.rb'
+            require_relative './str.rb'
+            require_relative './subscript.rb'
+            require_relative './superscript.rb'
+
+            # Metadata level nodes
+            require_relative './meta_blocks.rb'
+            require_relative './meta_bool.rb'
+            require_relative './meta_inlines.rb'
+            require_relative './meta_list.rb'
+            require_relative './meta_map.rb'
+            require_relative './meta_string.rb'
 
             # Create a new Node with contents. Also indicate if this node has
             # inline children or block children.
             #
-            # @param contents [Array<pandoc node in JSON>] the contents of
+            # @param contents [Array<pandoc node in JSON> = []] the contents of
             #   this node
             # @param inline_children [Boolean] does this node have
             #   inline children (true) or block children (false).
-            def initialize(contents, inline_children = false)
+            def initialize(contents = [], inline_children = false)
                 @children = []
                 @parent = nil
 
@@ -110,7 +166,7 @@ module Paru
             # @return [Boolean] True if this node has any children, false
             #   otherwise.
             def has_children?()
-                defined? @children and @children.size > 0
+                defined? @children and not @children.nil? and @children.size > 0
             end
 
             # Get this node's children,
@@ -281,6 +337,69 @@ module Paru
                 }
             end
 
+            # Get the markdown representation of this Node, including the Node
+            # itself.
+            #
+            # @return [String] the outer markdown representation of this Node
+            def markdown()
+                temp_doc = PandocFilter::Document.fragment [self]
+                markdown = AST2MARKDOWN << temp_doc.to_JSON
+                markdown
+            end
+
+            alias outer_markdown markdown
+            
+            # Set the markdown representation of this Node: replace this Node
+            # by the Node represented by the markdown string. If an inline
+            # node is being replaced and the replacement has more than one
+            # paragraph, only the contents of the first paragraph is used
+            #
+            # @param markdown [String] the markdown string to replace this
+            #   Node
+            #
+            # @example Replacing all horizontal lines by a Plain node saying "hi"
+            #   Paru::Filter.run do
+            #       with "HorizontalLine" do |line|
+            #           line.markdown = "hi"
+            #       end
+            #   end
+            #       
+            def markdown=(markdown)
+                json = MARKDOWN2JSON << markdown
+                temp_doc = PandocFilter::Document.from_JSON json
+
+                if not has_parent? or is_root?
+                    @children = temp_doc.children
+                else
+                    # replace current node by new nodes
+                    # There is a difference between inline and block nodes
+                    current_index = parent.find_index self
+
+                    # By default, pandoc creates a Block level node when
+                    # converting a string. However, if the original is a
+                    # inline level node, so should its replacement node(s) be.
+                    # Only using first block node (paragraph?)
+                    if is_inline?
+                        temp_doc = temp_doc.children.first
+                        
+                        if not temp_doc.children.all? {|node| node.is_inline?}
+                            raise Error.new "Cannot replace the inline level node represented by '#{outer_markdown}' with markdown that converts to block level nodes: '#{markdown}'."
+                        end
+                        
+                    end
+                        
+                    index = current_index
+                    temp_doc.each do |child|
+                        index += 1
+                        parent.insert index, child
+                    end
+                    # Remove the original node
+                    parent.remove_at current_index
+                end
+
+            end
+
+            alias outer_markdown= markdown=
         end
     end
 end

data/lib/paru/filter/note.rb

@@ -16,12 +16,11 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./inline.rb"
+require_relative "./block.rb"
+
 module Paru
     module PandocFilter
-
-        require_relative "./inline"
-        require_relative "./block"
-
         # A Note node like a foot note or end note. It is a special node in
         # the sense that itself is an Inline level node, but its contents are
         # Block level.

data/lib/paru/filter/null.rb

@@ -16,10 +16,10 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./empty_block.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./empty_block"
-
         # A Null node is an EmptyBlock node
         class Null < EmptyBlock
         end

data/lib/paru/filter/ordered_list.rb

@@ -16,11 +16,11 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./list.rb"
+require_relative "./list_attributes.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./list"
-        require_relative "./list_attributes"
-
         # An OrderedList Node 
         # 
         # @example In markdown an ordered list looks like
@@ -39,14 +39,14 @@ module Paru
             #
             # @param contents [Array]
             def initialize(contents)
-                @list_attributes = ListAttributes.new contents[0]
                 super contents[1]
+                @list_attributes = ListAttributes.new contents[0]
             end
 
             # The AST contents
             #
             # @return [Array]
-            def ast_contents
+            def ast_contents()
                 [
                     @list_attributes.to_ast,
                     super

data/lib/paru/filter/para.rb

@@ -16,12 +16,14 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./block.rb"
+require_relative "./inner_markdown.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./block"
-
         # A Para is a paragraph: a list of Inline nodes
         class Para < Block
+            include InnerMarkdown
 
             # Create a new Para node based on the contents
             #

data/lib/paru/filter/plain.rb

@@ -16,14 +16,16 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./block.rb"
+require_relative "./inner_markdown.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./block"
-
         # A Plain node is a basic {Block} level node with {Inline} child nodes. Not
         # to be confused with {Para}, which represents a paragraph. A Plain
         # is a more general type of block level node.
         class Plain < Block
+            include InnerMarkdown
 
             # Create a new Plain node based on contents
             #

data/lib/paru/filter/quoted.rb

@@ -16,10 +16,10 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./inline.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./inline"
-
         # A Quoted node represents a quote with a type and the contents of the
         # quote
         #

data/lib/paru/filter/raw_block.rb

@@ -16,10 +16,11 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./block.rb"
+require_relative "./inner_markdown.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./block"
-
         # A RawBlock node has a format and a string contents
         #
         # @!attribute format
@@ -28,6 +29,7 @@ module Paru
         # @!attribute string
         #   @return [String]
         class RawBlock < Block
+            include InnerMarkdown
             attr_accessor :format, :string
 
             # Create a new RawBlock node based on the contents
@@ -38,7 +40,7 @@ module Paru
             end
 
             # Create an AST representation of this RawBlock node
-            def to_ast()
+            def ast_contents()
                 [
                     @format,
                     @string

data/lib/paru/filter/raw_inline.rb

@@ -16,11 +16,10 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./inline.rb"
+
 module Paru
     module PandocFilter
-
-        require_relative "./inline"
-
         # A RawInline node has a format  and a string value
         #
         # @!attribute format

data/lib/paru/filter/small_caps.rb

@@ -16,10 +16,10 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./inline.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./inline"
-
         # A SmallCaps node is an inline level node representing SMALL CAPS
         # text
         class SmallCaps < Inline

data/lib/paru/filter/soft_break.rb

@@ -16,10 +16,10 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./empty_inline.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./empty_inline"
-
         # A SoftBreak node
         class SoftBreak < EmptyInline
         end

data/lib/paru/filter/space.rb

@@ -16,10 +16,10 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./empty_inline.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./empty_inline"
-
         # A Space node
         class Space < EmptyInline
         end

data/lib/paru/filter/span.rb

@@ -16,12 +16,11 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./inline.rb"
+require_relative "./attr.rb"
+
 module Paru
     module PandocFilter
-
-        require_relative "./inline"
-        require_relative "./attr"
-
         # A Span node is a general Inline level node with attributes and
         # contens
         #

data/lib/paru/filter/str.rb

@@ -16,10 +16,10 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./inline.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./inline"
-
         # A Str node represents a string
         #
         # @!attribute string

data/lib/paru/filter/strikeout.rb

@@ -16,10 +16,10 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./inline.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./inline"
-
         # A Strikeout inline node
         class Strikeout < Inline
         end

data/lib/paru/filter/strong.rb

@@ -16,10 +16,10 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./inline.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./inline"
-
         # A Strong inline node
         class Strong < Inline
         end

data/lib/paru/filter/subscript.rb

@@ -16,10 +16,10 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require_relative "./inline.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./inline"
-
         # A Subscript inline node
         class Subscript < Inline
         end