paru 1.5.0 → 1.5.1

data/lib/paru/filter/document.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2015, 2016, 2017, 2020, 2023 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015--2025 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -16,125 +18,120 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
-require "json"
+require 'json'
 
-require_relative "./node.rb"
-require_relative "./plain.rb"
-require_relative "./meta.rb"
-require_relative "./version.rb"
+require_relative 'node'
+require_relative 'plain'
+require_relative 'meta'
+require_relative 'version'
 
-require_relative "../filter_error.rb"
+require_relative '../filter_error'
 
 module Paru
-    module PandocFilter
-        # Pandoc type version key
-        VERSION = "pandoc-api-version"
-        # Pandoc type meta key
-        META = "meta"
-        # Pandoc type block key
-        BLOCKS = "blocks"
-
-        # The current pandoc type version
-        # @see https://hackage.haskell.org/package/pandoc-types
-        CURRENT_PANDOC_VERSION = [1, 23]
-
-        # Each file that is being filtered by pandoc is represented by a root
-        # Document. It is the root node of the AST of the document in the file.
-        #
-        # @!attribute meta
-        #   @return [Meta] the metadata of this document
-        class Document < Node
-
-            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)
-                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 [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.nil? or node_list.any? {|n| n.is_block?}
-                    new_doc = Document.new CURRENT_PANDOC_VERSION, meta, []
-                    new_doc.children = node_list
-                else
-                    node = PandocFilter::Plain.new [] 
-                    node.children = node_list
-                    new_doc = Document.new CURRENT_PANDOC_VERSION, meta, [node.to_ast]
-                end
-
-                new_doc
-            end
-
-            # Create a new Document node based on the pandoc type version,
-            # metadata, and the contents of the document
-            #
-            # @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()
-                {
-                    VERSION => @version.to_ast,
-                    META => @meta.to_ast,
-                    BLOCKS => ast_contents
-                }
-            end
-
-            # Create a JSON string representation of the AST of this Document.
-            # Use this to write back the manipulated AST in a format that
-            # pandoc understands.
-            def to_JSON
-                to_ast.to_json
-            end
+  module PandocFilter
+    # Pandoc type version key
+    VERSION = 'pandoc-api-version'
+    # Pandoc type meta key
+    META = 'meta'
+    # Pandoc type block key
+    BLOCKS = 'blocks'
+
+    # The current pandoc type version
+    # @see https://hackage.haskell.org/package/pandoc-types
+    CURRENT_PANDOC_VERSION = [1, 23].freeze
+
+    # Each file that is being filtered by pandoc is represented by a root
+    # Document. It is the root node of the AST of the document in the file.
+    #
+    # @!attribute meta
+    #   @return [Meta] the metadata of this document
+    class Document < Node
+      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)
+        begin
+          doc = JSON.parse json
+          version, metadata, contents = doc.values_at(VERSION, META, BLOCKS)
+        rescue Exception => e
+          raise FilterError, <<~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 ((version <=> CURRENT_PANDOC_VERSION) == -1) && metadata.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
+
+        PandocFilter::Document.new version, metadata, contents
+      end
+
+      # Create a new Document fragment from a list of Node elements
+      #
+      # @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 = {}
+
+        if node_list.nil? || node_list.any?(&:is_block?)
+          new_doc = Document.new CURRENT_PANDOC_VERSION, meta, []
+          new_doc.children = node_list
+        else
+          node = PandocFilter::Plain.new []
+          node.children = node_list
+          new_doc = Document.new CURRENT_PANDOC_VERSION, meta, [node.to_ast]
+        end
+
+        new_doc
+      end
+
+      # Create a new Document node based on the pandoc type version,
+      # metadata, and the contents of the document
+      #
+      # @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
+        {
+          VERSION => @version.to_ast,
+          META => @meta.to_ast,
+          BLOCKS => ast_contents
+        }
+      end
+
+      # Create a JSON string representation of the AST of this Document.
+      # Use this to write back the manipulated AST in a format that
+      # pandoc understands.
+      def to_JSON
+        to_ast.to_json
+      end
     end
+  end
 end

data/lib/paru/filter/emph.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -16,12 +18,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 'inline'
 
 module Paru
-    module PandocFilter
-        # An Emph, emphasized Inline
-        class Emph < Inline
-        end
+  module PandocFilter
+    # An Emph, emphasized Inline
+    class Emph < Inline
     end
+  end
 end

data/lib/paru/filter/empty_block.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -16,24 +18,23 @@
 # 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 'block'
 
 module Paru
-    module PandocFilter
-        # An EmptyBlock, has not contents
-        class EmptyBlock < Block
-
-            # Create an empty block
-            def initialize(contents = [])
-                super []
-            end
+  module PandocFilter
+    # An EmptyBlock, has not contents
+    class EmptyBlock < Block
+      # Create an empty block
+      def initialize(_contents = [])
+        super([])
+      end
 
-            # Create an AST representation of this EmptyBlock
-            def to_ast
-                {
-                    "t" => ast_type
-                }
-            end
-        end
+      # Create an AST representation of this EmptyBlock
+      def to_ast
+        {
+          't' => ast_type
+        }
+      end
     end
+  end
 end

data/lib/paru/filter/empty_inline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -16,31 +18,30 @@
 # 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 'inline'
 
 module Paru
-    module PandocFilter
-        # An EmptyInline node, has no content
-        class EmptyInline < Inline
-
-            # Create an EmptyInline node
-            def initialize _
-                super []
-            end
+  module PandocFilter
+    # An EmptyInline node, has no content
+    class EmptyInline < Inline
+      # Create an EmptyInline node
+      def initialize(_)
+        super([])
+      end
 
-            # Has this empty inline contents?
-            #
-            # @return [Boolean] false
-            def has_inline?
-                false
-            end
+      # Has this empty inline contents?
+      #
+      # @return [Boolean] false
+      def has_inline?
+        false
+      end
 
-            # Create an AST representation of this EmptyInline
-            def to_ast
-                {
-                    "t" => ast_type
-                }
-            end
-        end
+      # Create an AST representation of this EmptyInline
+      def to_ast
+        {
+          't' => ast_type
+        }
+      end
     end
+  end
 end

data/lib/paru/filter/figure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2023 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -16,50 +18,50 @@
 # 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 "./caption.rb"
-require_relative "./inner_markdown.rb"
+require_relative 'block'
+require_relative 'attr'
+require_relative 'caption'
+require_relative 'inner_markdown'
 
 module Paru
-    module PandocFilter
-        # A Figure node consisting of an attribute object, a caption, and a list of Block nodes.
-        class Figure < Block
-            include InnerMarkdown
+  module PandocFilter
+    # A Figure node consisting of an attribute object, a caption, and a list of Block nodes.
+    class Figure < Block
+      include InnerMarkdown
 
-            # A Figure node has an attribute object
-            #
-            # @!attribute attr
-            #   @return [Attr]
-            #
-            # @!attribute caption
-            #   @return Caption
-            attr_accessor :attr, :caption
+      # A Figure node has an attribute object
+      #
+      # @!attribute attr
+      #   @return [Attr]
+      #
+      # @!attribute caption
+      #   @return Caption
+      attr_accessor :attr, :caption
 
-            # Create a new Figure node based on the contents
-            #
-            # @param contents [Array] 
-            def initialize(contents)
-                @attr = Attr.new contents[0]
-                @caption = Caption.new contents[1]
-                super contents[2]
-            end
+      # Create a new Figure node based on the contents
+      #
+      # @param contents [Array]
+      def initialize(contents)
+        @attr = Attr.new contents[0]
+        @caption = Caption.new contents[1]
+        super(contents[2])
+      end
 
-            # Create an AST representation of this Figure node.
-            def ast_contents()
-                [
-                    @attr.to_ast,
-                    @caption.to_ast,
-                    super
-                ]
-            end
+      # Create an AST representation of this Figure node.
+      def ast_contents
+        [
+          @attr.to_ast,
+          @caption.to_ast,
+          super
+        ]
+      end
 
-            # Has this Figure node Blocks as children?
-            #
-            # @return [Boolean] true
-            def has_block?
-                true
-            end
-        end
+      # Has this Figure node Blocks as children?
+      #
+      # @return [Boolean] true
+      def has_block?
+        true
+      end
     end
+  end
 end

data/lib/paru/filter/header.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -16,50 +18,50 @@
 # 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"
+require_relative 'block'
+require_relative 'attr'
+require_relative 'inner_markdown'
 
 module Paru
-    module PandocFilter
-        # A Header node has a level, an attribute object and the contents of
-        # the header as a list on Inline nodes.
-        #
-        # @!attribute level
-        #   @return [Integer]
-        #
-        # @!attribute attr
-        #   @return [Attr]
-        class Header < Block
-            include InnerMarkdown
+  module PandocFilter
+    # A Header node has a level, an attribute object and the contents of
+    # the header as a list on Inline nodes.
+    #
+    # @!attribute level
+    #   @return [Integer]
+    #
+    # @!attribute attr
+    #   @return [Attr]
+    class Header < Block
+      include InnerMarkdown
 
-            attr_accessor :level, :attr
+      attr_accessor :level, :attr
 
-            # Create a new Header node
-            #
-            # @param contents [Array] an array with the level, attribute, and
-            #   the header contents
-            def initialize(contents)
-                @level = contents[0]
-                @attr = Attr.new contents[1]
-                super contents[2], true
-            end
+      # Create a new Header node
+      #
+      # @param contents [Array] an array with the level, attribute, and
+      #   the header contents
+      def initialize(contents)
+        @level = contents[0]
+        @attr = Attr.new contents[1]
+        super(contents[2], true)
+      end
 
-            # Create an AST representation of this Header node
-            def ast_contents()
-                [
-                    @level,
-                    @attr.to_ast,
-                    super
-                ]
-            end
+      # Create an AST representation of this Header node
+      def ast_contents
+        [
+          @level,
+          @attr.to_ast,
+          super
+        ]
+      end
 
-            # Has this Header node inline contents?
-            #
-            # @return [Boolean] true
-            def has_inline?
-                true
-            end
-        end
+      # Has this Header node inline contents?
+      #
+      # @return [Boolean] true
+      def has_inline?
+        true
+      end
     end
+  end
 end

data/lib/paru/filter/horizontal_rule.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -16,12 +18,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 "./empty_block.rb"
+require_relative 'empty_block'
 
 module Paru
-    module PandocFilter
-        # HorizontalRule
-        class HorizontalRule < EmptyBlock
-        end
+  module PandocFilter
+    # HorizontalRule
+    class HorizontalRule < EmptyBlock
     end
+  end
 end

data/lib/paru/filter/image.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -16,19 +18,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 "./link.rb"
+require_relative 'link'
 
 module Paru
-    module PandocFilter
-        # An Image has an attribute object, a caption, and a target
-        class Image < Link
-
-            # Although Image is defined to be inline, probably because in HTML it
-            # can be an inline element, often it acts like a block element.
-            # @return [Boolean] true 
-            def can_act_as_both_block_and_inline?
-                true
-            end
-        end
+  module PandocFilter
+    # An Image has an attribute object, a caption, and a target
+    class Image < Link
+      # Although Image is defined to be inline, probably because in HTML it
+      # can be an inline element, often it acts like a block element.
+      # @return [Boolean] true
+      def can_act_as_both_block_and_inline?
+        true
+      end
     end
+  end
 end