paru 0.2.4.2 → 0.2.4.3

data/lib/paru/pandoc_options.yaml

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -16,7 +16,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 # See http://pandoc.org/README.html for an overview of all options
-# 
+#++
 # General options
 from:                     ""
 read:                     ""
@@ -41,7 +41,7 @@ file_scope:               true
 filter:                   [""]
 metadata:                 [""]
 normalize:                true
-preserve_tabs:           true
+preserve_tabs:            true
 tab_stop:                 4
 track_changes:            "accept"
 extract_media:            true

data/lib/paru/selector.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2015, 2016 Huub de Beer <Huub@heerdebeer.org>
+# Copyright 2015, 2016, 2017 Huub de Beer <Huub@heerdebeer.org>
 #
 # This file is part of Paru
 #
@@ -17,157 +17,180 @@
 # along with Paru.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Paru
-  require_relative "./filter"
-  require_relative "./error"
-
-  class SelectorParseError < Error
-  end
-
-  class Selector
-
-    def initialize selector
-      @type = "Unknown"
-      @relations = []
-      parse selector
-    end
-
-    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}
-    end
-
-    private 
-
-    S = /\s*/
-    TYPE = /(?<type>(?<name>[A-Z][a-zA-Z]*)(?<classes>(\.[a-zA-Z-]+)*))/
-    OTHER_TYPE = /(?<other_type>(?<other_name>[A-Z][a-zA-Z]*)(?<other_classes>(\.[a-zA-Z-]+)*))/
-    OPERATOR = /(?<operator>\+|-|>)/
-    DISTANCE = /(?<distance>[1-9][0-9]*)/
-    RELATION = /(?<relation>#{S}#{OTHER_TYPE}#{S}#{OPERATOR}#{S}#{DISTANCE}?#{S})/
-    RELATIONS = /(?<relations>#{RELATION}+)/
-    SELECTOR = /\A#{S}(?<selector>#{RELATIONS}?#{S}#{TYPE})#{S}\Z/
-
-    def parse selector_string
-      partial_match = expect_match SELECTOR, selector_string
-      @type, @classes = expect_pandoc_type partial_match
-
-      while continue_parsing? partial_match
-        operator = expect partial_match, :operator
-        distance = expect_integer partial_match, :distance 
-        type, classes = expect_pandoc_other_type partial_match
-
-        @relations.push Relation.new(operator, distance, type, classes)
-
-        partial_match = rest partial_match
-      end
-    end 
-
-    def is_pandoc_type type
-      Paru::PANDOC_TYPES.include? type
-    end
-
-    def expect parts, part
-      raise SelectorParseError.new "Expected #{part}" if parts[part].nil?
-      parts[part]
+    require_relative './filter'
+    require_relative './error'
+
+    # SelectorParseError is thrown when there is an error parsing a selector
+    # used in a filter.
+    class SelectorParseError < Error
+    end
+
+
+    # A Selector models a relationship between Pandoc AST nodes, such as
+    # parent-child or sibling. Selectors in paru are like CSS selectors, but
+    # more limited because the Pandoc AST is quite simple.
+    #
+    # Given a selector expression, Selector determines if a node complies with
+    # that selector expression or not.
+    class Selector
+
+        # Create a new Selector based on the selector string
+        #
+        # @param selector [String] the selector string
+        def initialize(selector)
+            @type = 'Unknown'
+            @relations = []
+            parse selector
+        end
+
+        # Does node get selected by this Selector in the context of the already filtered
+        # nodes?
+        #
+        # @param node [Node] the node to check against this Selector
+        # @param filtered_nodes [Array<Node>] the context of filtered nodes to take
+        #   into account as well
+        #
+        # @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}
+        end
+
+        private 
+
+        S = /\s*/
+        TYPE = /(?<type>(?<name>[A-Z][a-zA-Z]*)(?<classes>(\.[a-zA-Z-]+)*))/
+        OTHER_TYPE = /(?<other_type>(?<other_name>[A-Z][a-zA-Z]*)(?<other_classes>(\.[a-zA-Z-]+)*))/
+        OPERATOR = /(?<operator>\+|-|>)/
+        DISTANCE = /(?<distance>[1-9][0-9]*)/
+        RELATION = /(?<relation>#{S}#{OTHER_TYPE}#{S}#{OPERATOR}#{S}#{DISTANCE}?#{S})/
+        RELATIONS = /(?<relations>#{RELATION}+)/
+        SELECTOR = /\A#{S}(?<selector>#{RELATIONS}?#{S}#{TYPE})#{S}\Z/
+
+        # Parse the selector_string to construct this Selector
+        def parse(selector_string)
+            partial_match = expect_match SELECTOR, selector_string
+            @type, @classes = expect_pandoc_type partial_match
+
+            while continue_parsing? partial_match
+                operator = expect partial_match, :operator
+                distance = expect_integer partial_match, :distance 
+                type, classes = expect_pandoc_other_type partial_match
+
+                @relations.push Relation.new(operator, distance, type, classes)
+
+                partial_match = rest partial_match
+            end
+        end 
+
+        # Is type actually a Pandoc AST node type?
+        def is_pandoc_type(type)
+            Paru::PANDOC_TYPES.include? type
+        end
+
+        def expect(parts, part)
+            raise SelectorParseError.new "Expected #{part}" if parts[part].nil?
+            parts[part]
+        end
+
+        def expect_match(regexp, string)
+            match = regexp.match string
+            raise SelectorParseError.new "Unable to parse '#{string}'" if match.nil?
+            match
+        end
+
+        def expect_pandoc_type(parts)
+            type = expect parts, :name
+            classes = parts[:classes].split(".").select {|c| not c.empty?} if not parts[:classes].nil?
+            raise SelectorParseError.new "Expected a Pandoc type, got '#{type}' instead" if not is_pandoc_type type
+            [type, classes]
+        end
+
+        def expect_pandoc_other_type(parts)
+            type = expect parts, :other_name
+            classes = parts[:other_classes].split('.').select {|c| not c.empty?} if not parts[:other_classes].nil?
+            raise SelectorParseError.new "Expected a Pandoc type, got '#{type}' instead" if not is_pandoc_type type
+            [type, classes]
+        end
+
+        def expect_integer(parts, part)
+            if parts[part].nil?
+                number = 0
+            else
+                number = parts[part].to_i
+                raise SelectorParseError.new "Expected a positive #{part}, got '#{parts[part]}' instead" if number <= 0
+            end
+            number
+        end
+
+        def continue_parsing?(parts)
+            not parts.nil? and not parts[:relations].nil?
+        end
+
+        def rest(parts)
+            rest_string = parts[:relations].slice 0, parts[:relations].size - parts[:relation].size
+            RELATIONS.match rest_string
+        end
+    end
+
+    # @private
+    class Relation
+        def initialize(selector, distance, type, classes)
+            @selector = selector
+            @distance = distance
+            @type = type
+            @classes = classes
+        end
+
+        def matches?(node, filtered_nodes)
+            level_nodes = filtered_nodes.keep_if do |n| 
+                node.is_inline? == n.is_inline? or 
+                    node.can_act_as_both_block_and_inline?
+            end
+            previous_nodes = previous level_nodes, @distance
+            case @selector
+            when '+'
+                in_sequence? node, previous_nodes
+            when '-'
+                not_in_sequence? node, previous_nodes
+            when '>'
+                is_descendant? node
+            else
+                false
+            end 
+        end
+
+        def in_sequence?(node, previous_nodes)
+            previous_nodes.any? do |other|
+                other.type == @type and @classes.all? {|c| other.has_class? c}
+            end
+        end
+
+        def not_in_sequence?(node, previous_nodes)
+            previous_nodes.all? do |other|
+                other.type != @type or not @classes.all? {|c| other.has_class? c}
+            end
+        end
+
+        def is_descendant?(node)
+            distance = 0
+            begin
+                distance += 1 if @distance > 0
+                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
+            ancestry
+        end
+
+        def previous(filtered_nodes, distance)
+            distance = [distance, filtered_nodes.size - 1].min
+            if distance <= 0
+                filtered_nodes.slice(0, filtered_nodes.size - 1)
+            else
+                filtered_nodes.slice(-1 * distance - 1, distance)
+            end
+        end
     end
-
-    def expect_match regexp, string
-      match = regexp.match string
-      raise SelectorParseError.new "Unable to parse '#{string}'" if match.nil?
-      match
-    end
-
-    def expect_pandoc_type parts
-      type = expect parts, :name
-      classes = parts[:classes].split(".").select {|c| not c.empty?} if not parts[:classes].nil?
-      raise SelectorParseError.new "Expected a Pandoc type, got '#{type}' instead" if not is_pandoc_type type
-      [type, classes]
-    end
-
-    def expect_pandoc_other_type parts
-      type = expect parts, :other_name
-      classes = parts[:other_classes].split(".").select {|c| not c.empty?} if not parts[:other_classes].nil?
-      raise SelectorParseError.new "Expected a Pandoc type, got '#{type}' instead" if not is_pandoc_type type
-      [type, classes]
-    end
-
-    def expect_integer parts, part
-      if parts[part].nil?
-        number = 0
-      else
-        number = parts[part].to_i
-        raise SelectorParseError.new "Expected a positive #{part}, got '#{parts[part]}' instead" if number <= 0
-      end
-      number
-    end
-
-    def continue_parsing? parts
-      not parts.nil? and not parts[:relations].nil?
-    end
-
-    def rest parts
-      rest_string = parts[:relations].slice 0, parts[:relations].size - parts[:relation].size
-      RELATIONS.match rest_string
-    end
-  end
-
-  class Relation
-    def initialize selector, distance, type, classes
-      @selector = selector
-      @distance = distance
-      @type = type
-      @classes = classes
-    end
-
-    def matches? node, filtered_nodes
-      level_nodes = filtered_nodes.keep_if do |n| 
-        node.is_inline? == n.is_inline? or 
-          node.can_act_as_both_block_and_inline?
-      end
-      previous_nodes = previous level_nodes, @distance
-      case @selector
-      when "+"
-        in_sequence? node, previous_nodes
-      when "-"
-        not_in_sequence? node, previous_nodes
-      when ">"
-        is_descendant? node
-      else
-        false
-      end 
-    end
-
-    def in_sequence? node, previous_nodes
-      previous_nodes.any? do |other|
-        other.type == @type and @classes.all? {|c| other.has_class? c}
-      end
-    end
-
-    def not_in_sequence? node, previous_nodes
-      previous_nodes.all? do |other|
-        other.type != @type or not @classes.all? {|c| other.has_class? c}
-      end
-    end
-
-    def is_descendant? node
-      distance = 0
-      begin
-        distance += 1 if @distance > 0
-        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
-      ancestry
-    end
-
-    def previous filtered_nodes, distance
-      distance = [distance, filtered_nodes.size - 1].min
-      if distance <= 0
-        filtered_nodes.slice(0, filtered_nodes.size - 1)
-      else
-        filtered_nodes.slice(-1 * distance - 1, distance)
-      end
-    end
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paru
 version: !ruby/object:Gem::Version
-  version: 0.2.4.2
+  version: 0.2.4.3
 platform: ruby
 authors:
 - Huub de Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-05-19 00:00:00.000000000 Z
 dependencies: []
 description: Use Pandoc (http://www.pandoc.org) with ruby
 email: Huub@heerdebeer.org
@@ -23,7 +23,6 @@ files:
 - lib/paru.rb
 - lib/paru/error.rb
 - lib/paru/filter.rb
-- lib/paru/filter/alignment.rb
 - lib/paru/filter/ast_manipulation.rb
 - lib/paru/filter/attr.rb
 - lib/paru/filter/block.rb

data/lib/paru/filter/alignment.rb

@@ -1,30 +0,0 @@
-#--
-# Copyright 2015, 2016 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/>.
-#++
-module Paru
-  module PandocFilter
-
-    class Alignment
-      ALIGNMENTS = ["AlignLeft", "AlignRight", "AlignCenter", "AlignDefault"]
-
-      def initialize config
-        @config = config
-      end
-    end
-  end
-end