paru 1.5.0 → 1.5.1

data/lib/paru/filter/cell.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 "./value.rb"
-require_relative "./int_value.rb"
+require_relative 'block'
+require_relative 'value'
+require_relative 'int_value'
 
 module Paru
-    module PandocFilter
-        # A Cell node represents a cell in a table's head, body, or foot.
-        #  
-        # @!attribute attr
-        #   @return Attr
-        #
-        # @!attribute alignment
-        #   @return Value containing a String, one of AlignRight, AlignLeft,
-        #   AlignCenter, or AlignDefault.
-        #
-        # @!attribute rowspan
-        #   @return Value containing an Integer
-        #
-        # @!attribute colspan
-        #   @return Value containing an Integer
-        class Cell < Block
-            attr_accessor :attr, :alignment, :rowspan, :colspan
+  module PandocFilter
+    # A Cell node represents a cell in a table's head, body, or foot.
+    #
+    # @!attribute attr
+    #   @return Attr
+    #
+    # @!attribute alignment
+    #   @return Value containing a String, one of AlignRight, AlignLeft,
+    #   AlignCenter, or AlignDefault.
+    #
+    # @!attribute rowspan
+    #   @return Value containing an Integer
+    #
+    # @!attribute colspan
+    #   @return Value containing an Integer
+    class Cell < Block
+      attr_accessor :attr, :alignment, :rowspan, :colspan
 
-            # Create a new Cell based on the row_data
-            #
-            # @param contents [Array]
-            def initialize(contents)
-                @attr = Attr.new contents[0]
-                @alignment = Value.new contents[1]
-                @rowspan = IntValue.new contents[2]
-                @colspan = IntValue.new contents[3]
+      # Create a new Cell based on the row_data
+      #
+      # @param contents [Array]
+      def initialize(contents)
+        @attr = Attr.new contents[0]
+        @alignment = Value.new contents[1]
+        @rowspan = IntValue.new contents[2]
+        @colspan = IntValue.new contents[3]
 
-                super contents[4]
-            end
+        super(contents[4])
+      end
 
-            # The AST contents of this Cell
-            #
-            # @return [Array]
-            def ast_contents
-                [
-                  @attr.to_ast,
-                  @alignment.to_ast,
-                  @rowspan.to_ast,
-                  @colspan.to_ast,
-                  @children.map {|child| child.to_ast}
-                ]
-            end
+      # The AST contents of this Cell
+      #
+      # @return [Array]
+      def ast_contents
+        [
+          @attr.to_ast,
+          @alignment.to_ast,
+          @rowspan.to_ast,
+          @colspan.to_ast,
+          @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

data/lib/paru/filter/citation.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,58 +18,58 @@
 # 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
-        # A Citation consists of an id, a prefix, a suffix, a mode, a note
-        # number, and integer hash. All of which are optional.
-        #
-        # @see https://hackage.haskell.org/package/pandoc-types-1.17.0.5/docs/Text-Pandoc-Definition.html#t:Citation
-        #
-        # @!attribute id
-        #   @return [String]
-        #
-        # @!attribute prefix
-        #   @return [Array<Inline>]
-        #
-        # @!attribute suffix
-        #   @return [Array<Inline>]
-        #
-        # @!attribute mode
-        #   @return [String]
-        #
-        # @!attribute note_num
-        #   @return [Integer]
-        #
-        # @!attribute hash  
-        #   @return [Integer]
-        class Citation
-            attr_accessor :id, :prefix, :suffix, :mode, :note_num, :hash
+  module PandocFilter
+    # A Citation consists of an id, a prefix, a suffix, a mode, a note
+    # number, and integer hash. All of which are optional.
+    #
+    # @see https://hackage.haskell.org/package/pandoc-types-1.17.0.5/docs/Text-Pandoc-Definition.html#t:Citation
+    #
+    # @!attribute id
+    #   @return [String]
+    #
+    # @!attribute prefix
+    #   @return [Array<Inline>]
+    #
+    # @!attribute suffix
+    #   @return [Array<Inline>]
+    #
+    # @!attribute mode
+    #   @return [String]
+    #
+    # @!attribute note_num
+    #   @return [Integer]
+    #
+    # @!attribute hash
+    #   @return [Integer]
+    class Citation
+      attr_accessor :id, :prefix, :suffix, :mode, :note_num, :hash
 
-            # Create a new Citation node base on an AST specification
-            #
-            # @param spec [Hash] the specification of this citation
-            def initialize(spec)
-                @id = spec["citationId"] if spec.has_key? "citationId"
-                @prefix = Inline.new spec["citationPrefix"] if spec.has_key? "citationPrefix"
-                @suffix = Inline.new spec["citationSuffix"] if spec.has_key? "citationSuffix"
-                @mode = spec["citationMode"] if spec.has_key? "citationMode"
-                @note_num = spec["citationNoteNum"] if spec.has_key? "citationNoteNum"
-                @hash = spec["citationHash"] if spec.has_key? "citationHash"
-            end
+      # Create a new Citation node base on an AST specification
+      #
+      # @param spec [Hash] the specification of this citation
+      def initialize(spec)
+        @id = spec['citationId'] if spec.key? 'citationId'
+        @prefix = Inline.new spec['citationPrefix'] if spec.key? 'citationPrefix'
+        @suffix = Inline.new spec['citationSuffix'] if spec.key? 'citationSuffix'
+        @mode = spec['citationMode'] if spec.key? 'citationMode'
+        @note_num = spec['citationNoteNum'] if spec.key? 'citationNoteNum'
+        @hash = spec['citationHash'] if spec.key? 'citationHash'
+      end
 
-            # Convert this Citation to an AST representation
-            def to_ast()
-                citation = Hash.new
-                citation["citationId"] = @id if not @id.nil?
-                citation["citationPrefix"] = @prefix.ast_contents if not @prefix.nil?
-                citation["citationSuffix"] = @suffix.ast_contents if not @suffix.nil?
-                citation["citationMode"] = @mode if not @mode.nil?
-                citation["citationNoteNum"] = @note_num if not @note_num.nil?
-                citation["citationHash"] = @hash if not @hash.nil?
-                citation
-            end
-        end
+      # Convert this Citation to an AST representation
+      def to_ast
+        citation = {}
+        citation['citationId'] = @id unless @id.nil?
+        citation['citationPrefix'] = @prefix.ast_contents unless @prefix.nil?
+        citation['citationSuffix'] = @suffix.ast_contents unless @suffix.nil?
+        citation['citationMode'] = @mode unless @mode.nil?
+        citation['citationNoteNum'] = @note_num unless @note_num.nil?
+        citation['citationHash'] = @hash unless @hash.nil?
+        citation
+      end
     end
+  end
 end

data/lib/paru/filter/cite.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,42 +18,41 @@
 # 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 "./citation.rb"
+require_relative 'inline'
+require_relative 'citation'
 
 module Paru
-    module PandocFilter
-        # A Cite node, consisting of a list of Citation nodes, and a list of
-        # Inline nodes
-        #
-        # @!attribute citations
-        #   @return [Array<Citation>]
-        class Cite < Inline
-            attr_accessor :citations
+  module PandocFilter
+    # A Cite node, consisting of a list of Citation nodes, and a list of
+    # Inline nodes
+    #
+    # @!attribute citations
+    #   @return [Array<Citation>]
+    class Cite < Inline
+      attr_accessor :citations
 
-            # Create a new Cite node
-            #
-            # @param contents [Array] an array containing a list of citations
-            #   and a list of inline nodes
-            def initialize(contents)
-                super contents[1]
-                @citations = []
-                contents[0].each do |citation|
-                    @citations.push Citation.new(citation)
-                end
-            end
+      # Create a new Cite node
+      #
+      # @param contents [Array] an array containing a list of citations
+      #   and a list of inline nodes
+      def initialize(contents)
+        super(contents[1])
+        @citations = []
+        contents[0].each do |citation|
+          @citations.push Citation.new(citation)
+        end
+      end
 
-            # Create an AST representation of this Cite node.
-            def ast_contents()
-                [
-                    @citations.map {|citation| citation.to_ast},
-                    super
-                ]
-            end
+      # Create an AST representation of this Cite node.
+      def ast_contents
+        [
+          @citations.map(&:to_ast),
+          super
+        ]
+      end
 
-            #undef_method :inner_markdown
-            #undef_method :inner_markdown=
-        end
+      # undef_method :inner_markdown
+      # undef_method :inner_markdown=
     end
+  end
 end
-

data/lib/paru/filter/code.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,59 +18,59 @@
 # 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 'inline'
+require_relative 'attr'
 
 module Paru
-    module PandocFilter
-        # A Code node, with an attribute object and the code itself as a
-        # string.
-        #
-        # @!attribute attr 
-        #   @return [Attr]
-        #
-        # @!attribute string
-        #   @return [String]
-        class Code < Inline
-            attr_accessor :attr, :string
+  module PandocFilter
+    # A Code node, with an attribute object and the code itself as a
+    # string.
+    #
+    # @!attribute attr
+    #   @return [Attr]
+    #
+    # @!attribute string
+    #   @return [String]
+    class Code < Inline
+      attr_accessor :attr, :string
+
+      # Create a new Code node
+      #
+      # @param contents [Array] an array of the attribute and the code
+      def initialize(contents)
+        @attr = Attr.new contents[0]
+        @string = contents[1]
+      end
 
-            # Create a new Code node
-            #
-            # @param contents [Array] an array of the attribute and the code
-            def initialize(contents)
-                @attr = Attr.new contents[0]
-                @string = contents[1]
-            end
+      # Create an AST representation of this Code node.
+      def ast_contents
+        [
+          @attr.to_ast,
+          @string
+        ]
+      end
 
-            # Create an AST representation of this Code node.
-            def ast_contents()
-                [
-                    @attr.to_ast,
-                    @string
-                ]
-            end
+      # Has this Code node a string contents?
+      #
+      # @return [Boolean] true
+      def has_string?
+        true
+      end
 
-            # Has this Code node a string contents?
-            #
-            # @return [Boolean] true
-            def has_string?()
-                true
-            end
+      # Has this code node inline contents?
+      #
+      # @return [Boolean] false
+      def has_inline?
+        false
+      end
 
-            # Has this code node inline contents?
-            #
-            # @return [Boolean] false
-            def has_inline?()
-                false
-            end
-            
-            # Get the markdown representation of this Node, including the Node
-            # itself.
-            #
-            # @return [String] the outer markdown representation of this Node
-            def markdown()
-                super.strip
-            end
-        end
+      # Get the markdown representation of this Node, including the Node
+      # itself.
+      #
+      # @return [String] the outer markdown representation of this Node
+      def markdown
+        super.strip
+      end
     end
+  end
 end

data/lib/paru/filter/code_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,89 +18,87 @@
 # 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 CodeBlock is a Block level node with an attribute object and the
-        # code as a string
-        #
-        # @!attribute attr 
-        #   @return [Attr]
-        #
-        # @!attribute string
-        #   @return [String]
-        class CodeBlock < Block
-            include InnerMarkdown
-            attr_accessor :attr, :string
+  module PandocFilter
+    # A CodeBlock is a Block level node with an attribute object and the
+    # code as a string
+    #
+    # @!attribute attr
+    #   @return [Attr]
+    #
+    # @!attribute string
+    #   @return [String]
+    class CodeBlock < Block
+      include InnerMarkdown
+
+      attr_accessor :attr, :string
 
-            # Create a new CodeBlock based on the contents
-            #
-            # @param contents [Array] an array with the attribute and the code
-            #   string
-            def initialize(contents)
-                @attr = Attr.new contents[0]
-                @string = contents[1]
-            end
+      # Create a new CodeBlock based on the contents
+      #
+      # @param contents [Array] an array with the attribute and the code
+      #   string
+      def initialize(contents)
+        @attr = Attr.new contents[0]
+        @string = contents[1]
+      end
 
-            # An AST representation of this CodeBlock
-            def ast_contents()
-                [
-                    @attr.to_ast,
-                    @string
-                ]
-            end
+      # An AST representation of this CodeBlock
+      def ast_contents
+        [
+          @attr.to_ast,
+          @string
+        ]
+      end
 
-            # Has this CodeBlock string contents?
-            #
-            # @return [Boolean] true
-            def has_string?()
-                true
-            end
+      # Has this CodeBlock string contents?
+      #
+      # @return [Boolean] true
+      def has_string?
+        true
+      end
 
-            # Write this CodeBlock's contents to file
-            #
-            # @param filename {String} the path to the file to write
-            def to_file(filename)
-                File.open(filename, "w") do |file|
-                    file.write "#{@string}\n"
-                end
-            end
+      # Write this CodeBlock's contents to file
+      #
+      # @param filename {String} the path to the file to write
+      def to_file(filename)
+        File.write(filename, "#{@string}\n")
+      end
 
-            # Create a new CodeBlock based on the contents of a file, and,
-            # optionally, a language
-            #
-            # @param filename {String} the path to the file to read the
-            #   contents from
-            # @param language {String} the language of the contents
-            #
-            # @return [CodeBlock]
-            def self.from_file(filename, language = "")
-                return self.from_code_string(File.read(filename), language) 
-            end
+      # Create a new CodeBlock based on the contents of a file, and,
+      # optionally, a language
+      #
+      # @param filename {String} the path to the file to read the
+      #   contents from
+      # @param language {String} the language of the contents
+      #
+      # @return [CodeBlock]
+      def self.from_file(filename, language = '')
+        from_code_string(File.read(filename), language)
+      end
 
-            # Get this CodeBlock's contents as a string
-            #
-            # @return [String]
-            def to_code_string()
-                return @string
-            end
+      # Get this CodeBlock's contents as a string
+      #
+      # @return [String]
+      def to_code_string
+        @string
+      end
 
-            # Create a new CodeBlock based on a string and, optionally, a
-            # language
-            # 
-            #
-            # @param code_string [String] the string with code to use as the
-            #   contents of the CodeBlock
-            # @param language [String] the optional language class
-            # @return [CodeBlock]
-            def self.from_code_string(code_string, language = "")
-                attributes = ["", [language], []]
-                code_block = CodeBlock.new [attributes, code_string]
-                return code_block
-            end
-        end
+      # Create a new CodeBlock based on a string and, optionally, a
+      # language
+      #
+      #
+      # @param code_string [String] the string with code to use as the
+      #   contents of the CodeBlock
+      # @param language [String] the optional language class
+      # @return [CodeBlock]
+      def self.from_code_string(code_string, language = '')
+        attributes = ['', [language], []]
+        CodeBlock.new [attributes, code_string]
+      end
     end
+  end
 end