paru 1.5.0 → 1.5.1

data/lib/paru/filter/inline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -16,36 +18,35 @@
 # 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"
+require_relative 'node'
+require_relative 'inner_markdown'
 
 module Paru
-    module PandocFilter
-        # 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
-            def initialize(contents)
-                super contents, true
-            end 
+  module PandocFilter
+    # 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
 
-            # Is this Inline node inline? Of course!
-            #
-            # @return [Boolean] true
-            def is_inline?()
-                true
-            end
+      # Create a new Inline node with contents
+      # @param contents [Array] the contents of this inline node
+      def initialize(contents)
+        super(contents, true)
+      end
 
-            # Has this Inline node inline contents? Of course!
-            #
-            # @return [Boolean] true
-            def has_inline?()
-                true
-            end
+      # Is this Inline node inline? Of course!
+      #
+      # @return [Boolean] true
+      def is_inline?
+        true
+      end
 
-        end
+      # Has this Inline node inline contents? Of course!
+      #
+      # @return [Boolean] true
+      def has_inline?
+        true
+      end
     end
+  end
 end

data/lib/paru/filter/inner_markdown.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -17,69 +19,65 @@
 # 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
+  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}
+      # 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
+        elsif markdown.nil? || 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
+          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/int_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2020 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -16,27 +18,26 @@
 # 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 "../filter_error.rb"
+require_relative 'node'
+require_relative '../filter_error'
 
 module Paru
-    module PandocFilter
-
-        # An IntValue represents some sort of integer metadata about block or
-        # inline nodes
-        class IntValue
-          attr_accessor :value
+  module PandocFilter
+    # An IntValue represents some sort of integer metadata about block or
+    # inline nodes
+    class IntValue
+      attr_accessor :value
 
-          def initialize(value)
-            @value = value
-          end
+      def initialize(value)
+        @value = value
+      end
 
-          # Create an AST representation of this Node
-          #
-          # @return [Hash]
-          def to_ast()
-            @value
-          end
-        end
+      # Create an AST representation of this Node
+      #
+      # @return [Hash]
+      def to_ast
+        @value
+      end
     end
+  end
 end

data/lib/paru/filter/line_block.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -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 "./list.rb"
+require_relative 'list'
 
 module Paru
-    module PandocFilter
-        # 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
+  module PandocFilter
+    # 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

@@ -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 "./empty_inline.rb"
+require_relative 'empty_inline'
 
 module Paru
-    module PandocFilter
-        # A LineBreak is an empty inline element
-        class LineBreak < EmptyInline
-        end
+  module PandocFilter
+    # A LineBreak is an empty inline element
+    class LineBreak < EmptyInline
     end
+  end
 end

data/lib/paru/filter/link.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -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 "./attr.rb"
-require_relative "./target.rb"
+require_relative 'inline'
+require_relative 'attr'
+require_relative 'target'
 
 module Paru
-    module PandocFilter
-        # A Link node has an attribute object, an Inline description and a
-        # target
-        #
-        # @!attribute attr
-        #   @return [Attr]
-        #
-        # @!attribute target
-        #   @return [Target]
-        class Link < Inline
-            attr_accessor :attr, :target
-
-            # Create a new Link node with contents
-            #
-            # @param contents [Array] an array with attributes, description,
-            #   and target information
-            def initialize(contents)
-                @attr = Attr.new contents[0]
-                super contents[1]
-                @target = Target.new contents[2]
-            end
+  module PandocFilter
+    # A Link node has an attribute object, an Inline description and a
+    # target
+    #
+    # @!attribute attr
+    #   @return [Attr]
+    #
+    # @!attribute target
+    #   @return [Target]
+    class Link < Inline
+      attr_accessor :attr, :target
 
-            # Create an AST representation of this Link node
-            def ast_contents
-                [
-                    @attr.to_ast,
-                    super,
-                    @target.to_ast
-                ]
-            end
+      # Create a new Link node with contents
+      #
+      # @param contents [Array] an array with attributes, description,
+      #   and target information
+      def initialize(contents)
+        @attr = Attr.new contents[0]
+        super(contents[1])
+        @target = Target.new contents[2]
+      end
 
-        end
+      # Create an AST representation of this Link node
+      def ast_contents
+        [
+          @attr.to_ast,
+          super,
+          @target.to_ast
+        ]
+      end
     end
+  end
 end

data/lib/paru/filter/list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -16,49 +18,47 @@
 # 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 "./inline.rb"
+require_relative 'block'
+require_relative 'inline'
 
 module Paru
-    module PandocFilter
-        # A List node is a base node for various List node types
-        class List < Block
-
-            # Create a new List node based on contents
-            #
-            # @param contents [Array] the contents of the list
-            # @param node_class [Node = PandocFilter::Block] the contents are {Inline} nodes
-            def initialize(contents, node_class = Block)
-                super []
-                contents.each do |item|
-                    child = node_class.new(item)
-                    child.parent = self
+  module PandocFilter
+    # A List node is a base node for various List node types
+    class List < Block
+      # Create a new List node based on contents
+      #
+      # @param contents [Array] the contents of the list
+      # @param node_class [Node = PandocFilter::Block] the contents are {Inline} nodes
+      def initialize(contents, node_class = Block)
+        super([])
+        contents.each do |item|
+          child = node_class.new(item)
+          child.parent = self
 
-                    @children.push child
-                end
-            end
-
-            # Create an AST representation of this List node
-            def ast_contents()
-                @children.map {|child| child.ast_contents}
-            end
+          @children.push child
+        end
+      end
 
-            # Has this List node block contents?
-            #
-            # @return [Boolean] true
-            def has_block?()
-                true
-            end
+      # Create an AST representation of this List node
+      def ast_contents
+        @children.map(&:ast_contents)
+      end
 
-            # Convert this List to an array of markdown strings
-            #
-            # @return [String[]]
-            def to_array()
-                @children.map do |block|
-                    block.children.map{|c| c.markdown.strip}.join("\n")
-                end
-            end
+      # Has this List node block contents?
+      #
+      # @return [Boolean] true
+      def has_block?
+        true
+      end
 
+      # Convert this List to an array of markdown strings
+      #
+      # @return [String[]]
+      def to_array
+        @children.map do |block|
+          block.children.map { |c| c.markdown.strip }.join("\n")
         end
+      end
     end
+  end
 end

data/lib/paru/filter/list_attributes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
@@ -17,60 +19,59 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-    module PandocFilter
-        # ListAttributes represent the attributes of a list.
-        #
-        # @see http://hackage.haskell.org/package/pandoc-types-1.17.0.4/docs/Text-Pandoc-Definition.html#t:ListAttributes
-        #
-        # @!attribute start
-        #   @return [Integer]
-        #
-        # @!attribute number_style
-        #   @return [STYLES]
-        #
-        # @!attribute number_delim
-        #   @return [DELIMS]
-        class ListAttributes
-            
-            # The various styles of list numbers
-            STYLES = [
-                "DefaultStyle", 
-                "Example", 
-                "Decimal", 
-                "LowerRoman", 
-                "UpperRoman", 
-                "LowerAlpha", 
-                "UpperAlpha"
-            ]
+  module PandocFilter
+    # ListAttributes represent the attributes of a list.
+    #
+    # @see http://hackage.haskell.org/package/pandoc-types-1.17.0.4/docs/Text-Pandoc-Definition.html#t:ListAttributes
+    #
+    # @!attribute start
+    #   @return [Integer]
+    #
+    # @!attribute number_style
+    #   @return [STYLES]
+    #
+    # @!attribute number_delim
+    #   @return [DELIMS]
+    class ListAttributes
+      # The various styles of list numbers
+      STYLES = %w[
+        DefaultStyle
+        Example
+        Decimal
+        LowerRoman
+        UpperRoman
+        LowerAlpha
+        UpperAlpha
+      ].freeze
 
-            # The various delimeters of list numbers
-            DELIMS = [
-                "DefaultDelim", 
-                "Period", 
-                "OneParen", 
-                "TwoParens"
-            ]
+      # The various delimeters of list numbers
+      DELIMS = %w[
+        DefaultDelim
+        Period
+        OneParen
+        TwoParens
+      ].freeze
 
-            attr_accessor :start, :number_style, :number_delim
+      attr_accessor :start, :number_style, :number_delim
 
-            # Create a new ListAttribute object with attributes
-            #
-            # @param attributes [Array] an array with start, number style, and
-            #   number delimeter
-            def initialize(attributes)
-                @start = attributes[0]
-                @number_style = attributes[1]
-                @number_delim = attributes[2]
-            end
+      # Create a new ListAttribute object with attributes
+      #
+      # @param attributes [Array] an array with start, number style, and
+      #   number delimeter
+      def initialize(attributes)
+        @start = attributes[0]
+        @number_style = attributes[1]
+        @number_delim = attributes[2]
+      end
 
-            # Create an AST representation of this ListAttributes object
-            def to_ast()
-                [
-                    @start,
-                    @number_style,
-                    @number_delim
-                ]
-            end
-        end
+      # Create an AST representation of this ListAttributes object
+      def to_ast
+        [
+          @start,
+          @number_style,
+          @number_delim
+        ]
+      end
     end
+  end
 end