paru 0.4.3 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b56730c82e1a52321e635423e8bf5dcd5679cc4902a44c6bdcb9ea5f7eb02644
-  data.tar.gz: 3368084001dd7f8a3d16b93c6b57a2a671762b8c853f90116a4ff8575b3562c5
+  metadata.gz: dc1a2d8d47cd75c3bc4d34a4fbbbecf8eca9d475e8e3f2aa1260f02e39f8885f
+  data.tar.gz: df6b6ea223c9e48067ddd342a51715fb6fbab95d08e94c5f26f263b789dd63fe
 SHA512:
-  metadata.gz: ddaeba8c423ca4c44284b448019161f6a287d11e3bd721b006e2c499ac096d9901be16f43511a9a6a337a3ad7b79a3cb727ff4e4a1d25f43c3e141201ef6c6ea
-  data.tar.gz: f20c5628b950ac5f4f5188a71ec714b5662b1340ac331d6bc073f78247f1df42edcde89f58823642a9dc75bb358499e202fc78842f3761d362ba8e4cd1e5c094
+  metadata.gz: ceaa544a0e8963d59c70700f3208bac827a2c2274dd4be86673ccfc26977c59914c8b8d69521d8b2629ec745bda85c316a55ac47d5b0e69fa177d88e4fef2c47
+  data.tar.gz: 9113b9aaae1d0f4fe3e4188a76556984542b8281154faba088dd38a97630d3a66031d8d0b49b029069bd719178b355be6e240bcdd7bedfa3ad754083143668bf

data/lib/paru/filter/caption.rb

@@ -61,6 +61,9 @@ module Paru
                 ]
             end
 
+            # Create an AST representation of this Node
+            #
+            # @return [Hash]
             def to_ast()
               ast_contents()
             end

data/lib/paru/filter/cell.rb

@@ -64,6 +64,9 @@ module Paru
                 ]
             end
 
+            # Create an AST representation of this Node
+            #
+            # @return [Hash]
             def to_ast()
               ast_contents()
             end

data/lib/paru/filter/definition_list.rb

@@ -30,7 +30,10 @@ module Paru
             def initialize(contents)
                 super []
                 contents.each do |item|
-                    @children.push DefinitionListItem.new item
+                    child = DefinitionListItem.new item
+                    child.parent = self
+
+                    @children.push child
                 end
             end
 

data/lib/paru/filter/definition_list_item.rb

@@ -37,8 +37,15 @@ module Paru
             #
             # @param item [Array] the [term, definition]
             def initialize(item)
+                super []
+
                 @term = Block.new item[0]
+                @term.parent = self
+                @children << @term
+
                 @definition = List.new item[1]
+                @definition.parent = self
+                @children << @definition
             end
 
             # Create an AST representation of this DefinitionListItem

data/lib/paru/filter/int_value.rb

@@ -31,6 +31,9 @@ module Paru
             @value = value
           end
 
+          # Create an AST representation of this Node
+          #
+          # @return [Hash]
           def to_ast()
             @value
           end

data/lib/paru/filter/list.rb

@@ -31,7 +31,10 @@ module Paru
             def initialize(contents, node_class = Block)
                 super []
                 contents.each do |item|
-                    @children.push node_class.new item
+                    child = node_class.new(item)
+                    child.parent = self
+
+                    @children.push child
                 end
             end
 

data/lib/paru/filter/row.rb

@@ -61,6 +61,9 @@ module Paru
                 ]
             end
 
+            # Create an AST representation of this Node
+            #
+            # @return [Hash]
             def to_ast()
               ast_contents()
             end

data/lib/paru/filter/table_body.rb

@@ -72,6 +72,9 @@ module Paru
                 ]
             end
 
+            # Create an AST representation of this Node
+            #
+            # @return [Hash]
             def to_ast()
               ast_contents()
             end

data/lib/paru/filter/table_end.rb

@@ -58,6 +58,9 @@ module Paru
                 ]
             end
 
+            # Create an AST representation of this Node
+            #
+            # @return [Hash]
             def to_ast()
               ast_contents()
             end

data/lib/paru/filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017, 2022 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -284,6 +284,11 @@ module Paru
                 end
             end
 
+            @ran_before = false
+            @ran_after = false
+            instance_eval(&block) # run filter with before block
+            @ran_before = true
+
             @current_node = @document
 
             nodes_to_filter.each do |node|
@@ -299,6 +304,9 @@ module Paru
                 instance_eval(&block) # run the actual filter code
             end
 
+            @ran_after = true
+            instance_eval(&block) # run filter with after block
+
             write_document
         end
 
@@ -308,8 +316,26 @@ module Paru
         # @param selector [String] a selector string 
         # @yield [Node] the current node if it matches the selector
         def with(selector)
-            @selectors[selector] = Selector.new selector unless @selectors.has_key? selector
-            yield @current_node if @selectors[selector].matches? @current_node, @filtered_nodes
+            if @ran_before and !@ran_after
+              @selectors[selector] = Selector.new selector unless @selectors.has_key? selector
+              yield @current_node if @selectors[selector].matches? @current_node, @filtered_nodes
+            end
+        end
+
+        # Before running the filter on all nodes, the +document+ is passed to
+        # the block to this +before+ method. This method is run exactly once.
+        #
+        # @yield [Document] the document
+        def before()
+          yield @document unless @ran_before
+        end
+
+        # After running the filter on all nodes, the +document+ is passed to
+        # the block to this +after+ method. This method is run exactly once.
+        #
+        # @yield [Document] the document
+        def after()
+          yield @document if @ran_after
         end
 
         # Stop processing the document any further and output it as it is now.
@@ -324,7 +350,6 @@ module Paru
             exit true
         end
 
-
         private
 
         # The Document node from JSON formatted pandoc document structure

data/lib/paru/info.rb

@@ -0,0 +1,90 @@
+#--
+# Copyright 2022 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/>.
+#++
+require_relative "error.rb"
+
+module Paru
+  # Information about pandoc
+  #
+  # @!attribute version
+  #   @return [Array<Integer>] Pandoc's version, like [2, 18, 1]
+  #
+  # @!attribute data_dir
+  #   @return [String] Pandoc's default data directory
+  #
+  # @!attribute scripting_engine
+  #   @return [String] Pandoc's internal scripting engine, like "Lua 5.4"
+  class Info
+    attr_reader :version, :data_dir, :scripting_engine
+
+    # Create a new Info object
+    #
+    # @param path [String] the path to pandoc. Defaults to 'pandoc', i.e.,
+    # assumes it's on the environment's path.
+    def initialize(path = "pandoc")
+      begin
+        # Get pandoc's version information
+        version_string = ''
+        IO.popen("#{path} --version", 'r+') do |p|
+          p.close_write
+          version_string << p.read
+        end
+
+        # Extract the version as an array of integers, like SemVer.
+        @version = version_string
+          .match(/pandoc.* (\d+\.\d+.*)$/)[1]
+          .split(".")
+          .map {|s| s.to_i}
+
+        # Extract the data directory
+        @data_dir = version_string.match(/User data directory: (.+)$/)[1]
+
+        # Extract scripting engine
+        @scripting_engine = version_string.match(/Scripting engine: (.+)$/)[1]
+      rescue StandardError => err
+        warn "Error extracting pandoc's information: #{err.message}"
+        warn "Using made up values instead."
+
+        @version = @version || [2, 18]
+        @data_dir = @data_dir || "."
+        @scripting_engine = @scripting_engine || "Lua 5.4"
+      end
+    end
+
+    # Get pandoc's info by key like a Hash for backwards compatability.
+    #
+    # @deprecated Use Info's getters instead.
+    # 
+    # @param key [String|Symbol] the key for the information to look up.
+    # Info only supports keys 'version' and 'data_dir'.
+    # @return [Any] Information associated with the key.
+    # @raise [Error] for an unknown key.
+    def [](key)
+      case key
+      when "verion", :version
+        version
+      when "data_dir", :data_dir
+        data_dir
+      when "scripting_engine", :scripting_engine
+        scripting_engine
+      else
+        throw Error.new "Info does not know key '#{key}'"
+      end
+    end
+  end
+end

data/lib/paru/pandoc.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017, 2022 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -21,6 +21,7 @@ require "shellwords"
 require "yaml"
 
 require_relative "error.rb"
+require_relative "info.rb"
 
 module Paru
     # Pandoc is a wrapper around the pandoc document converter. See
@@ -92,8 +93,7 @@ module Paru
         # directory. This method is typically used in scripts that use Paru to
         # automate the use of pandoc.
         #
-        # @return [Hash{:version => Array<Integer>, :data_dir => String}] Pandoc's
-        #   version, such as "[2.10.1]" and the data directory, such as "/home/huub/.pandoc".
+        # @return [Info] Pandoc's version, such as "[2.10.1]" and the data directory, such as "/home/huub/.pandoc".
         def self.info()
             @@info
         end
@@ -216,43 +216,7 @@ module Paru
                             "pandoc"
                         end
 
-        begin
-            version_string = ''
-            IO.popen("#{@@pandoc_exec} --version", 'r+') do |p|
-                p.close_write
-                version_string << p.read
-            end
-        rescue StandardError => err
-            throw Error.new "Unable to run pandoc via command '#{@@pandoc_exec} --version': #{err.message}"
-        end
-
-        version = version_string
-                    .match(/pandoc.* (\d+\.\d+.*)$/)[1]
-                    .split(".")
-                    .map {|s| s.to_i}
-        major_version = version[0]
-
-        # Pandoc version 2.7 introduced a new default data dir to comply
-        # with XDG Base Directory Specification
-
-        xdg_data_dir, old_data_dir = version_string.match(/User data directory: (.+)$/)[1].split(" or ")
-
-        if File.directory? xdg_data_dir then
-            data_dir = xdg_data_dir
-        elsif not old_data_dir.nil? and File.directory? old_data_dir then
-            # The new-style data directory does not exist, but the
-            # old-style does, so use the old-style data directory for
-            # backwards compatibility
-            data_dir = old_data_dir
-        else
-            # Neither data directory exists, default to the new default
-            data_dir = xdg_data_dir
-        end
-
-        @@info = {
-            :version => version,
-            :data_dir => data_dir
-        }
+        @@info = Info.new(@@pandoc_exec)
 
         # For each pandoc command line option a method is defined as follows:
         OPTIONS = YAML.load_file File.join(__dir__, "pandoc_options.yaml")

data/lib/paru/pandoc_options.yaml

@@ -58,13 +58,14 @@ tab_stop:                   4
 track_changes:              "accept"
 extract_media:              ""
 abbreviations:              ""
+trace:                      true
 #####
 # General writing options:
 #####
-sandbox:                    false
 standalone:                 true
 template:                   ""
 variable:                   [""]
+sandbox:                    true
 print_default_template:     ""
 print_default_data_file:    ""
 eol:                        "native"
@@ -84,7 +85,7 @@ include_before_body:        [""]
 include_after_body:         [""]
 resource_path:              ""
 request_header:             ""
-no_check_certificate:       false
+no_check_certificate:       true
 #####
 # Options affecting specific writers
 #####
@@ -94,7 +95,7 @@ ascii:                      true
 reference_links:            true
 reference_location:         "block"
 markdown_headings:          "atx"
-atx_headers:                false
+atx_headers:                true
 top_level_division:         "section"
 number_sections:            true
 number_offset:              2
@@ -137,4 +138,3 @@ gladtex:                    true
 #####
 dump_args:                  true
 ignore_args:                true
-trace:                      true

data/lib/paru/selector.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017, 2022 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -32,6 +32,12 @@ module Paru
     # that selector expression or not.
     class Selector
 
+        # Pseudo selector to select any inline and block node
+        ANY_SELECTOR = "*"
+
+        # All pseudo selectors
+        PSEUDO_SELECTORS = [ANY_SELECTOR]
+
         # Create a new Selector based on the selector string
         #
         # @param selector [String] the selector string
@@ -51,9 +57,14 @@ module Paru
         # @return [Boolean] True if the node in the context of the
         #   filtered_nodes is selected by this Selector
         def matches? node, filtered_nodes
-            node.type == @type and 
-                @classes.all? {|c| node.has_class? c } and    
-                @relations.all? {|r| r.matches? node, filtered_nodes}
+            case @type 
+            when ANY_SELECTOR
+              Paru::PANDOC_TYPES.include? node.type
+            else
+              node.type == @type and 
+                  @classes.all? {|c| node.has_class? c } and    
+                  @relations.all? {|r| r.matches? node, filtered_nodes}
+            end
         end
 
         private 
@@ -61,7 +72,7 @@ module Paru
         S = /\s*/
         # Improved CSS class selector taken from https://stackoverflow.com/questions/448981/which-characters-are-valid-in-css-class-names-selectors/449000#449000
         CLASS = /(\.-?[_a-zA-Z]+[_a-zA-Z0-9-]*)/
-        TYPE = /(?<type>(?<name>[A-Z][a-zA-Z]*)(?<classes>#{CLASS}*))/
+        TYPE = /(?<type>(?<name>[A-Z][a-zA-Z]*|\*)(?<classes>#{CLASS}*))/
         OTHER_TYPE = /(?<other_type>(?<other_name>[A-Z][a-zA-Z]*)(?<other_classes>#{CLASS}*))/
         OPERATOR = /(?<operator>\+|-|>)/
         DISTANCE = /(?<distance>[1-9][0-9]*)/
@@ -87,7 +98,7 @@ module Paru
 
         # Is type actually a Pandoc AST node type?
         def is_pandoc_type(type)
-            Paru::PANDOC_TYPES.include? type
+          Paru::PANDOC_TYPES.concat(PSEUDO_SELECTORS).include? type
         end
 
         def expect(parts, part)
@@ -176,8 +187,10 @@ module Paru
 
         def is_descendant?(node)
             distance = 0
+            parent = nil
             begin
                 distance += 1 if @distance > 0
+                node = parent unless parent.nil?
                 parent = node.parent
                 ancestry = parent.type == @type and @classes.all? {|c| parent.has_class? c}
             end while not ancestry and not parent.is_root? and distance <= @distance

data/lib/paru.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016, 2017, 2018, 2019, 2020 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017, 2018, 2019, 2020, 2022 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,6 +17,6 @@
 # Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-    # Paru's current version
-    VERSION = [0, 4, 3]
+  # Paru's current version
+  VERSION = [1, 0, 2].freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paru
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 1.0.2
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-20 00:00:00.000000000 Z
+date: 2022-06-22 00:00:00.000000000 Z
 dependencies: []
 description: Control pandoc with Ruby and write pandoc filters in Ruby
 email: Huub@heerdebeer.org
@@ -93,6 +93,7 @@ files:
 - lib/paru/filter/value.rb
 - lib/paru/filter/version.rb
 - lib/paru/filter_error.rb
+- lib/paru/info.rb
 - lib/paru/pandoc.rb
 - lib/paru/pandoc2yaml.rb
 - lib/paru/pandoc_options.yaml
@@ -109,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.8
+      version: 2.7.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="