paru 0.2.5c → 0.2.5f

data/lib/paru/filter/code_block.rb

@@ -16,11 +16,12 @@
 # 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 "./attr.rb"
+require_relative "./inner_markdown.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./block"
-        require_relative "./attr"
-
         # A CodeBlock is a Block level node with an attribute object and the
         # code as a string
         #
@@ -30,6 +31,7 @@ module Paru
         # @!attribute string
         #   @return [String]
         class CodeBlock < Block
+            include InnerMarkdown
             attr_accessor :attr, :string
 
             # Create a new CodeBlock based on the contents

data/lib/paru/filter/definition_list.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 "./block.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./block"
-
         # A DefinitionList is a list of term-definition pairs, respecitively an Inline list and a Block list.
         class DefinitionList < Block
             # Create a new DefinitionList node

data/lib/paru/filter/definition_list_item.rb

@@ -16,12 +16,12 @@
 # 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 "./list.rb"
+require_relative "./inline.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./block"
-        require_relative "./list"
-        require_relative "./inline"
-
         # A DefinitionListItem is a helper node to represent the pair of a term
         # and its definition in a DefinitionList
         #

data/lib/paru/filter/div.rb

@@ -16,13 +16,15 @@
 # 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 "./attr.rb"
+require_relative "./inner_markdown.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./block"
-        require_relative "./attr"
-
         # A Div node consisting of an attribute object and a list of Block nodes.
         class Div < Block
+            include InnerMarkdown
 
             # Create a new Div node based on the contents
             #

data/lib/paru/filter/document.rb

@@ -16,15 +16,17 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
-module Paru
-    module PandocFilter
+require "json"
 
-        require "json"
-        require_relative "./node"
-        require_relative "./plain"
-        require_relative "./meta"
-        require_relative "./version"
+require_relative "./node.rb"
+require_relative "./plain.rb"
+require_relative "./meta.rb"
+require_relative "./version.rb"
 
+require_relative "../filter_error.rb"
+
+module Paru
+    module PandocFilter
         # Pandoc type version key
         VERSION = "pandoc-api-version"
         # Pandoc type meta key
@@ -43,28 +45,56 @@ module Paru
         #   @return [Meta] the metadata of this document
         class Document < Node
 
-            attr_reader :meta
+            attr_accessor :meta
 
             # Create a new Document from a JSON representation of the AST
             #
             # @param json [String] a JSON string representation of the AST of a document
             # @return [Document] the newly created document
+            #
+            # @raise [ParuFilterError] when parsing JSON AST from pandoc fails
+            #   or the parsed results do not make sense.
             def self.from_JSON(json)
-                doc = JSON.parse json
-                version, metadata, contents = doc.values_at(VERSION, META, BLOCKS)
+                begin
+                    doc = JSON.parse json
+                    version, metadata, contents = doc.values_at(VERSION, META, BLOCKS)
+                rescue Exception => e
+                    raise FilterError.new <<WARNING
+Unable to read document.
+
+Most likely cause: Paru expects a pandoc installation that has been
+compiled with pandoc-types >= #{CURRENT_PANDOC_VERSION.join('.')}. You can
+check which pandoc-types have been compiled with your pandoc installation by
+running `pandoc -v`. 
+
+Original error message: #{e.message}
+WARNING
+                end
+
+                if -1 == (version <=> CURRENT_PANDOC_VERSION)
+                    if metadata.has_key?('debug_')
+                        warn <<WARNING
+pandoc-types API version used in document (version = #{version.join('.')}) is
+lower than the version of pandoc-types used by paru
+(#{CURRENT_PANDOC_VERSION.join('.')}. If you experience unexpected results,
+please try updating pandoc or downgrading paru.
+WARNING
+                    end
+                end
+
                 PandocFilter::Document.new version, metadata, contents
             end
 
             # Create a new Document fragment from a list of Node elements
             #
-            # @param node_list [Array<Node>] a list of nodes to create a Document
+            # @param node_list [Node[]] a list of nodes to create a Document
             #   fragment from
             #
             # @return [Document] the document containing nodes in node_list
             def self.fragment(node_list)
                 meta = Hash.new
 
-                if node_list.any? {|n| n.is_block?}
+                if node_list.nil? or node_list.any? {|n| n.is_block?}
                     new_doc = Document.new CURRENT_PANDOC_VERSION, meta, []
                     new_doc.children = node_list
                 else
@@ -79,15 +109,16 @@ module Paru
             # Create a new Document node based on the pandoc type version,
             # metadata, and the contents of the document
             #
-            # @param version [Array<Integer>] the version of pandoc types
-            # @param meta [Array] metadata
-            # @param contents [Array] contents
-            def initialize(version, meta, contents)
+            # @param version [Integer = CURRENT_PANDOC_VERSION] the version of pandoc types
+            # @param meta [Array = []] metadata
+            # @param contents [Array = []] contents
+            def initialize(version = CURRENT_PANDOC_VERSION, meta = [], contents = [])
                 @version = Version.new version
                 @meta = Meta.new meta
                 super contents
             end
 
+
             # Create an AST representation of this Document
             def to_ast()
                 {

data/lib/paru/filter/emph.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"
-
         # An Emph, emphasized Inline
         class Emph < Inline
         end

data/lib/paru/filter/empty_block.rb

@@ -16,15 +16,15 @@
 # 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"
+
 module Paru
     module PandocFilter
-        require_relative "./block"
-
         # An EmptyBlock, has not contents
         class EmptyBlock < Block
 
             # Create an empty block
-            def initialize _
+            def initialize(contents = [])
                 super []
             end
 

data/lib/paru/filter/empty_inline.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"
-
         # An EmptyInline node, has no content
         class EmptyInline < Inline
 

data/lib/paru/filter/header.rb

@@ -16,11 +16,12 @@
 # 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 "./attr.rb"
+require_relative "./inner_markdown.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./block"
-        require_relative "./attr"
-
         # A Header node has a level, an attribute object and the contents of
         # the header as a list on Inline nodes.
         #
@@ -30,6 +31,8 @@ module Paru
         # @!attribute attr
         #   @return [Attr]
         class Header < Block
+            include InnerMarkdown
+
             attr_accessor :level, :attr
 
             # Create a new Header node

data/lib/paru/filter/horizontal_rule.rb

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

data/lib/paru/filter/image.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 "./link.rb"
+
 module Paru
     module PandocFilter
-
-        require_relative "./link"
-
         # An Image has an attribute object, a caption, and a target
         class Image < Link
 

data/lib/paru/filter/inline.rb

@@ -16,13 +16,15 @@
 # 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 "./node.rb"
+require_relative "./inner_markdown.rb"
+
 module Paru
     module PandocFilter
-        require_relative "./node"
-
         # An Inline node
         # @see http://hackage.haskell.org/package/pandoc-types-1.17.0.4/docs/Text-Pandoc-Definition.html#t:Inline
         class Inline < Node
+            include InnerMarkdown
 
             # Create a new Inline node with contents
             # @param contents [Array] the contents of this inline node
@@ -43,6 +45,7 @@ module Paru
             def has_inline?()
                 true
             end
+
         end
     end
 end

data/lib/paru/filter/inner_markdown.rb

@@ -0,0 +1,85 @@
+#--
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
+#
+# This file is part of Paru
+#
+# Paru is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Paru is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Paru.  If not, see <http://www.gnu.org/licenses/>.
+#++
+module Paru
+    module PandocFilter
+
+        # A mixin to add inner_markdown properties to Nodes for which it makes
+        # sense to have an inner_markdown. Only those nodes that have a clear
+        # identifiable Inline level content, have the {#inner_markdown}
+        # method. This are almost all Inline nodes (except Cite) and Block
+        # level nodes with Inline contents like {Para} or {Header}.
+        module InnerMarkdown
+
+            # Get the markdown representation of this Node's children. 
+            #
+            # @return [String] the inner markdown representation of this Node
+            #
+            # @example Replace all occurrences of "hello" by "world" in all paragraphs
+            #   Paru::Filter.run do
+            #       with "Para" do |p|
+            #           p.inner_markdown = p.inner_markdown.gsub "hello", "world"
+            #       end
+            #   end         
+            #
+            def inner_markdown()
+                if has_children?
+                    temp_doc = PandocFilter::Document.fragment @children
+                    AST2MARKDOWN << temp_doc.to_JSON
+                elsif has_string?
+                    @string
+                end
+            end
+
+            # Replace this Node's children with the Nodes represented by the
+            # markdown string
+            #
+            # @param markdown [String] the markdown string to replace this
+            #   Node's children
+            #
+            # @example Replace all occurrences of "hello" by "world" in all paragraphs
+            #   Paru::Filter.run do
+            #       with "Para" do |p|
+            #           p.inner_markdown = p.inner_markdown.gsub "hello", "world"
+            #       end
+            #   end         
+            #
+            def inner_markdown=(markdown)
+                if has_string?
+                    @string = markdown
+                else
+                    if markdown.nil? or markdown.empty?
+                        @children = []
+                    else 
+                        json = MARKDOWN2JSON << markdown
+                        temp_doc = PandocFilter::Document.from_JSON json
+                        temp_doc.children.each {|c| c.parent = @parent}
+
+                        if has_inline?
+                            @children = temp_doc.children.first.children
+                        elsif has_block?
+                            @children = temp_doc.children
+                        else
+                            # Unknown; what to do here?
+                        end
+                    end
+                end
+            end
+        end
+    end
+end     

data/lib/paru/filter/line_block.rb

@@ -16,12 +16,18 @@
 # 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"
+
 module Paru
     module PandocFilter
-        require_relative "./list.rb"
-
         # A LineBlock is a List of Lists of Inline nodes
         class LineBlock < List
+            # Create a new LineBlock node based on contents
+            #
+            # @param contents [Array] the contents of the LineBlock
+            def initialize(contents)
+                super(contents, Para)
+            end
         end
     end
 end

data/lib/paru/filter/line_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 LineBreak is an empty inline element
         class LineBreak < EmptyInline
         end

data/lib/paru/filter/link.rb

@@ -16,13 +16,12 @@
 # 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"
+require_relative "./target.rb"
+
 module Paru
     module PandocFilter
-
-        require_relative "./inline"
-        require_relative "./attr"
-        require_relative "./target"
-
         # A Link node has an attribute object, an Inline description and a
         # target
         #