paru 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6150ea5eb07cbf87b85a54f5acdeacc38dc6fb0dff0fec57f2c0150c7fff7e31
-  data.tar.gz: 9cc1f75bea6f4d4e5d8cfb8b8d228ec08d3b50c11bb3f091ce393972aa40d95c
+  metadata.gz: f8a2edbbb37d2775d83f83c568b3071bfc3f817c47581844c65e828413e1d5e9
+  data.tar.gz: ba0ddc768641749cd4264ad0ed4a64f1dc1ff91791254fa0efe12243156cfe6c
 SHA512:
-  metadata.gz: b09e3fa5e9d25cbacf2b663d464a3717375fdfeece027c38838c4b3cd2c427b7f3cdd55db72fb562b53843bbd5173424158b38066c9456d0e481feca53debf54
-  data.tar.gz: 4306a0799e8dad73dc442cba841417fcb578ebda84f14efe2306a73dc4f5f0f9a49361911e252981d709a3e1e593e5ae61b48c682940fedf25ed7cae9cf5faf7
+  metadata.gz: 46c86674922f8d99eb8c0c507aae32efd86fcc14c78e94ba09fa9fc284a4a8cade7499aee6ba0b58142eba21099c9309d6e62863b32f3b3307872ee14d5c0df7
+  data.tar.gz: 2c63b6428068bf6c6b0622d5fb1706798d0b6aa935b8593f5174af091be7656f789df3dd6510fa6dfb1be07495334313ef73e9eb194dc2a8b7b1afff8af25ace

data/lib/paru/error.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015--2025 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,7 +19,7 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-    # An error class to use as a basis for paru specific errors.
-    class Error < RuntimeError
-    end
+  # An error class to use as a basis for paru specific errors.
+  class Error < RuntimeError
+  end
 end

data/lib/paru/filter/ast_manipulation.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015--2025 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,107 +19,104 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-    module PandocFilter
-        # ASTManipulation is a mixin for Node with some standard tree
-        # manipulation methods such as inserting or removing nodes, replacing
-        # nodes, and so on.
-        module ASTManipulation
-
-            # Find index of child
-            #
-            # @param child [Node] the child to find the index for
-            #
-            # @return [Number] the index of child or nil
-            def find_index(child)
-                @children.find_index child
-            end
-
+  module PandocFilter
+    # ASTManipulation is a mixin for Node with some standard tree
+    # manipulation methods such as inserting or removing nodes, replacing
+    # nodes, and so on.
+    module ASTManipulation
+      # Find index of child
+      #
+      # @param child [Node] the child to find the index for
+      #
+      # @return [Number] the index of child or nil
+      def find_index(child)
+        @children.find_index child
+      end
 
-            # Get the child node at index
-            #
-            # @param index [Number] the index of the child to get
-            #
-            # @return [Node] the child at index
-            def get(index)
-                @children[index]
-            end
+      # Get the child node at index
+      #
+      # @param index [Number] the index of the child to get
+      #
+      # @return [Node] the child at index
+      def get(index)
+        @children[index]
+      end
 
-            # Insert child node among this node's children at position index.
-            #
-            # @param index [Integer] the position to insert the child
-            # @param child [Node] the child to insert
-            def insert(index, child)
-                @children.insert index, child
-            end
+      # Insert child node among this node's children at position index.
+      #
+      # @param index [Integer] the position to insert the child
+      # @param child [Node] the child to insert
+      def insert(index, child)
+        @children.insert index, child
+      end
 
-            # Delete child from this node's children.
-            #
-            # @param child [Node] the child node to delete.
-            def delete(child)
-                @children.delete child
-            end
+      # Delete child from this node's children.
+      #
+      # @param child [Node] the child node to delete.
+      def delete(child)
+        @children.delete child
+      end
 
-            # Remove the child at position index from this node's children
-            #
-            # @param index [Integer] the position of the child to remove
-            def remove_at(index)
-                @children.delete_at index
-            end 
+      # Remove the child at position index from this node's children
+      #
+      # @param index [Integer] the position of the child to remove
+      def remove_at(index)
+        @children.delete_at index
+      end
 
-            # Append a child to the list with this node's children.
-            #
-            # @param child [Node] the child to append.
-            def append(child)
-                @children.push child
-            end
-            alias << append
+      # Append a child to the list with this node's children.
+      #
+      # @param child [Node] the child to append.
+      def append(child)
+        @children.push child
+      end
+      alias << append
 
-            # Prepend a child to the list with this node's children.
-            #
-            # @param child [Node] the child to prepend.
-            def prepend(child)
-                insert 0, child
-            end
+      # Prepend a child to the list with this node's children.
+      #
+      # @param child [Node] the child to prepend.
+      def prepend(child)
+        insert 0, child
+      end
 
-            # Replace a child from this node's children with a new child.
-            #
-            # @param old_child [Node] the child to replace
-            # @param new_child [Node] the replacement child
-            def replace(old_child, new_child)
-                old_child_index = find_index old_child
-                if old_child_index then
-                    replace_at old_child_index, new_child
-                end
-            end
+      # Replace a child from this node's children with a new child.
+      #
+      # @param old_child [Node] the child to replace
+      # @param new_child [Node] the replacement child
+      def replace(old_child, new_child)
+        old_child_index = find_index old_child
+        return unless old_child_index
 
-            # Replace the child at position index from this node's children
-            # with a new child.
-            #
-            # @param index [Integer] the position of the child to replace
-            # @param new_child [Node] the replacement child
-            def replace_at(index, new_child)
-                @children[index] = new_child
-            end
+        replace_at old_child_index, new_child
+      end
 
-            # Walk the node tree starting at this node, depth first, and apply
-            # block to each node in the tree
-            #
-            # @param block [Proc] the block to apply to each node in this node
-            #   tree
-            #
-            # @yield [Node]
-            def each_depth_first(&block)    
-                yield self
+      # Replace the child at position index from this node's children
+      # with a new child.
+      #
+      # @param index [Integer] the position of the child to replace
+      # @param new_child [Node] the replacement child
+      def replace_at(index, new_child)
+        @children[index] = new_child
+      end
 
-                if has_been_replaced?
-                    node = get_replacement
-                else
-                    node = self
-                end
+      # Walk the node tree starting at this node, depth first, and apply
+      # block to each node in the tree
+      #
+      # @param block [Proc] the block to apply to each node in this node
+      #   tree
+      #
+      # @yield [Node]
+      def each_depth_first(&block)
+        yield self
 
-                node.each {|child| child.each_depth_first(&block)} if node.has_children?
-            end
+        node = if has_been_replaced?
+                 get_replacement
+               else
+                 self
+               end
 
-        end
+        node.each { |child| child.each_depth_first(&block) } if node.has_children?
+      end
     end
+  end
 end

data/lib/paru/filter/attr.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015--2025 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,82 +19,86 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-    module PandocFilter
-        # Attr represents an attribute object for a node. It contains of an id, a
-        # list of class names and a list of key-value pairs. 
-        #
-        # @see https://hackage.haskell.org/package/pandoc-types-1.17.0.5/docs/Text-Pandoc-Definition.html#t:Attr
-        #
-        # @!attribute id
-        #   @return [String]
-        #
-        # @!attribute classes
-        #   @return [Array<String>]
-        class Attr
-            include Enumerable
+  module PandocFilter
+    # Attr represents an attribute object for a node. It contains of an id, a
+    # list of class names and a list of key-value pairs.
+    #
+    # @see https://hackage.haskell.org/package/pandoc-types-1.17.0.5/docs/Text-Pandoc-Definition.html#t:Attr
+    #
+    # @!attribute id
+    #   @return [String]
+    #
+    # @!attribute classes
+    #   @return [Array<String>]
+    class Attr
+      include Enumerable
+
+      attr_accessor :id, :classes
+
+      # Create a new attributes object
+      #
+      # @param attributes [Array = []] the attributes as [id, [class names],
+      #   [key-value pairs]]
+      def initialize(attributes = [])
+        id, classes, data = attributes
+
+        @id = id || ''
+
+        @classes = classes || []
+        @classes = [@classes] unless @classes.is_a? Array
 
-            attr_accessor :id, :classes
+        @data = data.to_h
+      end
 
-            # Create a new attributes object
-            #
-            # @param attributes [Array = []] the attributes as [id, [class names],
-            #   [key-value pairs]]
-            def initialize(attributes = [])
-                id, classes, data = attributes
-          
-                @id = id || ""
+      # For each key-value pair of this attributes object
+      def each
+        @data.each
+      end
 
-                @classes = classes || []
-                @classes = [@classes] unless @classes.is_a? Array
+      # Get the value for key in this attributes object
+      #
+      # @param key [String] the key to get the value for. Nil if it does
+      # not exists
+      def [](key)
+        return unless @data.key? key
 
-                @data = Hash[data] || {}
-            end
+        @data[key]
+      end
 
-            # For each key-value pair of this attributes object
-            def each
-                @data.each
-            end
+      # Does this attributes object have this key?
+      #
+      # @param name [String] key to find
+      #
+      # @return [Boolean] true if this key exist, false otherwise
+      def has_key?(name)
+        @data.key? name
+      end
 
-            # Get the value for key in this attributes object
-            #
-            # @param key [String] the key to get the value for. Nil if it does
-            # not exists
-            def [](key) 
-                if @data.key? key
-                    @data[key]
-                end 
-            end
+      alias key? has_key?
 
-            # Does this attributes object have this key?
-            #
-            # @param name [String] key to find
-            #
-            # @return [Boolean] true if this key exist, false otherwise
-            def has_key?(name)
-                @data.key? name
-            end
+      # Does this attributes object have a class?
+      #
+      # @param name [String] the class name to search for.
+      #
+      # @return [Boolean] true if this class name exist, false
+      #   otherwise.
+      def has_class?(name)
+        @classes.include? name
+      end
 
-            # Does this attributes object have a class?
-            #
-            # @param name [String] the class name to search for.
-            #
-            # @return [Boolean] true if this class name exist, false
-            #   otherwise.
-            def has_class?(name)
-                @classes.include? name
-            end
+      alias class? has_class?
 
-            # Convert this attributes object to an AST representation
-            #
-            # @return [Array] Array containing id, class name list, and
-            #   key-value pair list
-            def to_ast
-                [
-                    @id,
-                    @classes,
-                    @data.to_a
-                ]
-            end
-        end
+      # Convert this attributes object to an AST representation
+      #
+      # @return [Array] Array containing id, class name list, and
+      #   key-value pair list
+      def to_ast
+        [
+          @id,
+          @classes,
+          @data.to_a
+        ]
+      end
     end
+  end
 end

data/lib/paru/filter/block.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015--2025 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -16,20 +18,19 @@
 # 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 'node'
 
 module Paru
-    module PandocFilter
-        # A Block level node.
-        # @see https://hackage.haskell.org/package/pandoc-types-1.17.0.5/docs/Text-Pandoc-Definition.html#t:Block
-        class Block < Node
-
-            # Is this node a block?
-            #
-            # @return [Boolean] true
-            def is_block?
-                true
-            end
-        end
+  module PandocFilter
+    # A Block level node.
+    # @see https://hackage.haskell.org/package/pandoc-types-1.17.0.5/docs/Text-Pandoc-Definition.html#t:Block
+    class Block < Node
+      # Is this node a block?
+      #
+      # @return [Boolean] true
+      def is_block?
+        true
+      end
     end
+  end
 end

data/lib/paru/filter/block_quote.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015--2025 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -16,18 +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 "./block.rb"
+require_relative 'block'
 
 module Paru
-    module PandocFilter
-        # A BlockQuote node. Contains a list of Blocks
-        class BlockQuote < Block
-            # Has this node a block?
-            #
-            # @return [Boolean] true
-            def has_block?
-                true
-            end
-        end
+  module PandocFilter
+    # A BlockQuote node. Contains a list of Blocks
+    class BlockQuote < Block
+      # Has this node a block?
+      #
+      # @return [Boolean] true
+      def has_block?
+        true
+      end
     end
+  end
 end

data/lib/paru/filter/bullet_list.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015--2025 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -16,22 +18,21 @@
 # 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'
 
 module Paru
-    module PandocFilter
-        # BulletList, contains a list of list of Block nodes.
-        class BulletList < List
-
-            # Create a new BulletList from an array of markdown strings
-            #
-            # @param items [String[]] array of markdown strings as items of
-            #   the new BulletList
-            # @return [BulletList]
-            def self.from_array(items)
-                ast_items = items.map {|item| [Block.from_markdown(item).to_ast]}
-                BulletList.new ast_items
-            end
-        end
+  module PandocFilter
+    # BulletList, contains a list of list of Block nodes.
+    class BulletList < List
+      # Create a new BulletList from an array of markdown strings
+      #
+      # @param items [String[]] array of markdown strings as items of
+      #   the new BulletList
+      # @return [BulletList]
+      def self.from_array(items)
+        ast_items = items.map { |item| [Block.from_markdown(item).to_ast] }
+        BulletList.new ast_items
+      end
     end
+  end
 end

data/lib/paru/filter/caption.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2020, 2023 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2020--2025 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -16,60 +18,60 @@
 # 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"
-require_relative "./short_caption.rb"
+require_relative 'block'
+require_relative 'inner_markdown'
+require_relative 'short_caption'
 
 module Paru
-    module PandocFilter
-        # A table or figure's caption, can contain an optional short caption
-        class Caption < Block
-            include InnerMarkdown
+  module PandocFilter
+    # A table or figure's caption, can contain an optional short caption
+    class Caption < Block
+      include InnerMarkdown
 
-            attr_accessor :short  
+      attr_accessor :short
 
-            # Create a new Caption based on the contents
-            #
-            # @param contents [Array]
-            def initialize(contents)
-                if contents[0].nil?
-                  @short = nil
-                else
-                  @short = ShortCaption.new contents[0]
-                end
-                super(contents[1])
-            end
+      # Create a new Caption based on the contents
+      #
+      # @param contents [Array]
+      def initialize(contents)
+        @short = if contents[0].nil?
+                   nil
+                 else
+                   ShortCaption.new contents[0]
+                 end
+        super(contents[1])
+      end
 
-            # Does this Caption have a short caption?
-            #
-            # @return [Boolean]
-            def has_short?()
-                not @short.nil?
-            end
+      # Does this Caption have a short caption?
+      #
+      # @return [Boolean]
+      def has_short?
+        !@short.nil?
+      end
 
-            # Has this node a block?
-            #
-            # @return [Boolean] true
-            def has_block?
-                true
-            end
+      # Has this node a block?
+      #
+      # @return [Boolean] true
+      def has_block?
+        true
+      end
 
-            # The AST contents of this Caption node
-            #
-            # @return [Array]
-            def ast_contents()
-                [
-                  if has_short? then @short.to_ast else nil end,
-                  @children.map {|row| row.to_ast}
-                ]
-            end
+      # The AST contents of this Caption node
+      #
+      # @return [Array]
+      def ast_contents
+        [
+          has_short? ? @short.to_ast : nil,
+          @children.map(&:to_ast)
+        ]
+      end
 
-            # Create an AST representation of this Node
-            #
-            # @return [Hash]
-            def to_ast()
-              ast_contents()
-            end
-        end
+      # Create an AST representation of this Node
+      #
+      # @return [Hash]
+      def to_ast
+        ast_contents
+      end
     end
+  end
 end