paru 0.2.5c → 0.2.5f

data/lib/paru/filter/list.rb

@@ -16,32 +16,34 @@
 # 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"
+
 module Paru
     module PandocFilter
-        require_relative "./block"
-
         # 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
-            def initialize contents
+            # @param node_class [Node = PandocFilter::Block] the contents are {Inline} nodes
+            def initialize(contents, node_class = Block)
                 super []
                 contents.each do |item|
-                    @children.push Block.new item
+                    @children.push node_class.new item
                 end
             end
 
             # Create an AST representation of this List node
-            def ast_contents
+            def ast_contents()
                 @children.map {|child| child.ast_contents}
             end
 
             # Has this List node block contents?
             #
             # @return [Boolean] true
-            def has_block?
+            def has_block?()
                 true
             end
         end

data/lib/paru/filter/math.rb

@@ -16,10 +16,10 @@
 # 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"
+
 module Paru
     module PandocFilter
-        require_relative "./inline"
-
         # A Math Inline node with the type of math node and the mathematical
         # contents
         #

data/lib/paru/filter/meta.rb

@@ -16,16 +16,15 @@
 # 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 "./meta_map.rb"
+  
 module Paru
     module PandocFilter
-        require_relative "./meta_map"
-  
         # A Meta node represents the metadata of a document. It is a MetaMap
         # node.
         #
         # @see http://hackage.haskell.org/package/pandoc-types-1.17.0.4/docs/Text-Pandoc-Definition.html#t:Meta
         class Meta < MetaMap
-
             # The type of a Meta is "meta"
             # 
             # @return [String] "meta"
@@ -42,11 +41,23 @@ module Paru
             #
             # @return [MetaMap] a MetaMap representation of this metadata
             def to_meta_map()
-                map = MetaMap.new []
+                map = MetaMap.new
                 map.children = @children
                 map
             end
 
+            # Convert a {MetaMap} node to a {Meta} node
+            #
+            # @param meta_map [MetaMap] the {MetaMap} node to convert to a
+            #   {Meta} node.
+            #
+            # @return [Meta]
+            def self.from_meta_map(meta_map)
+                meta = Meta.new {}
+                meta.children = meta_map.children unless meta_map.children.nil? or meta_map.children.empty?
+                meta
+            end
+
         end
     end
 end

data/lib/paru/filter/meta_blocks.rb

@@ -16,10 +16,10 @@
 # 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"
+
 module Paru
     module PandocFilter
-        require_relative "./node"
-
         # A MetaBlocks Node contains a list of {Block} nodes
         class MetaBlocks < Node
         end

data/lib/paru/filter/meta_bool.rb

@@ -16,11 +16,10 @@
 # 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 "./meta_value.rb"
+
 module Paru
     module PandocFilter
-
-        require_relative "./meta_value"
-
         # A MetaBool Note representa a Boolean value
         class MetaBool < MetaValue
         end

data/lib/paru/filter/meta_inlines.rb

@@ -16,12 +16,14 @@
 # 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"
+
 module Paru
     module PandocFilter
-        require_relative "./node"
-
         # A MetaInlines node contains a list of {Inline} nodes
         class MetaInlines < Node
+            include InnerMarkdown
         end
     end
 end

data/lib/paru/filter/meta_list.rb

@@ -16,11 +16,10 @@
 # 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"
+
 module Paru
     module PandocFilter
-
-        require_relative "./node"
-
         # A MetaList node contains a list of MetaValue nodes
         class MetaList < Node
         end

data/lib/paru/filter/meta_map.rb

@@ -16,20 +16,21 @@
 # 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
+require_relative "./node.rb"
 
-        require_relative "./node"
-        require_relative "../pandoc.rb"
+require_relative "../pandoc.rb"
 
+module Paru
+    module PandocFilter
         # A MetaMap Node is a map of String keys with MetaValue values
         class MetaMap < Node
             include Enumerable
 
             # Create a new MetaMap based on the contents
             #
-            # @param contents [Array] a list of key-value pairs
-            def initialize(contents)
+            # @param contents [Hash = {}] a list of key-value pairs, defaults
+            #   to an empty hash
+            def initialize(contents = {})
                 @children = Hash.new
 
                 if contents.is_a? Hash
@@ -41,8 +42,7 @@ module Paru
                 end
             end
 
-            # Get the value belonging to key. Prefer to use the {has?}, {get},
-            # {replace} and {delete} methods to manipulate metadata.
+            # Get the value belonging to key. 
             #
             # @param key [String] the key
             #
@@ -51,9 +51,7 @@ module Paru
                 @children[key]
             end
 
-            # Set a value with a key. It is easier to use the {yaml} method to set
-            # metadata properties; the {yaml} method is the preferred method
-            # to set the metadata.
+            # Set a value with a key. 
             #
             # @param key [String] the key to set
             # @param value [MetaBlocks|MetaBool|MetaInlines|MetaList|MetaMap|MetaString|MetaValue] the value to set
@@ -67,146 +65,16 @@ module Paru
                     yield(key, value)
                 end
             end
-            
-            # Mixin the YAML code into this metadata object
-            #
-            # @param yaml_string [YAML] A string with YAML data
-            # @return [MetaMap] this MetaMap object
-            #
-            # @example Set some properties in the metadata
-            #   #!/usr/bin/env ruby
-            #   require "paru/filter"
-            #   require "date"
-            #
-            #   Paru::Filter.run do
-            #     metadata.yaml <<~YAML
-            #       ---
-            #       date: #{Date.today.to_s}
-            #       title: This **is** the title
-            #       pandoc_options:
-            #         from: markdown
-            #         toc: true
-            #       keywords:
-            #       - metadata
-            #       - pandoc
-            #       - filter
-            #       ...
-            #     YAML
-            #   end
-            #
-            def yaml(yaml_string)
-                meta_from_yaml(yaml_string).each do |key, value|
-                    self[key] = value
-                end
-                self
-            end
-
-            # Replace the property in this MetaMap matching the selector with
-            # metadata specified by second parameter. If that parameter is a
-            # String, it is treated as a YAML string.
-            #
-            # @param selector [String] a dot-separated sequence of property
-            # names denoting a sequence of descendants.
-            #
-            # @param value [MetaBlocks|MetaBool|MetaInlines|MetaList|MetaMap|MetaString|MetaValue|String]
-            #   if value is a String, it is treated as a yaml string
-            def replace(selector, value)
-                parent = select(selector, true)
-                if value.is_a? String
-                    value = meta_from_yaml(value)
-                end
-                parent.children[last_key(selector)] = value
-            end
-
-            # Get the property in this MetaMap matching the selector
-            #
-            # @param selector [String] a dot-separated sequence of property
-            #   names denoting a sequence of descendants.
-            #
-            # @return [MetaBlocks|MetaBool|MetaInlines|MetaList|MetaMap|MetaString|MetaValue] the value matching the selected property, nil if it cannot be found
-            def get(selector)
-                select(selector)
-            end 
-
-            # Has this MetaMap a descendant matching selector?
-            #
-            # @param selector [String] a dot-separated sequence of property
-            #   names denoting a sequence of descendants
-            #
-            # @return [Boolean] True if this MetaMap contains a descendant
-            #   matching selector, false otherwise
-            def has?(selector)
-                not select(selector).nil?
-            end
-
-            # Delete the property in this MetaMap that matches the selector
-            #
-            # @param selector [String] a dot-separated sequence of property
-            #   names denoting a sequence of descendants
-            #
-            # @return [MetaBlocks|MetaBool|MetaInlines|MetaList|MetaMap|MetaString|MetaValue] the value of the deleted property, nil if it cannot be found
-            #
-            def delete(selector)
-                parent = select(selector, true)
-                parent.children.delete(last_key(selector))
-            end
 
             # The AST contents
             def ast_contents()
                 ast = Hash.new
                 @children.each_pair do |key, value|
                     ast[key] = value.to_ast
-                end
+                end if @children.is_a? Hash
                 ast
             end
-            
-            private
-
-            # Select a node given a selector as a dot separated sequence of
-            # descendant names.
-            #
-            # @param selector [String] Dot separated sequence of property
-            #   names
-            #
-            # @param get_parent [Boolean = false] Get the parent MetaMap
-            #   of the selected property instead of its value
-            # 
-            # @return [MetaBlocks|MetaBool|MetaInlines|MetaList|MetaMap|MetaString|MetaValue] the value of the deleted property, nil if it cannot be found
-            def select(selector, get_parent = false)
-                keys = selector.split(".")
-                level = self
-
-                while not keys.empty?
-                    key = keys.shift
-                    if not level.children.has_key? key
-                        return nil
-                    else
-                        if get_parent and keys.empty?
-                            return level
-                        else
-                            level = level[key]
-                        end
-                    end
-                end
-
-                level
-            end 
-
-            # Get the last key in this selector
-            def last_key(selector)
-                selector.split(".").last
-            end
 
-            # Convert a yaml string to a MetaMap
-            def meta_from_yaml(yaml_string)
-                json_string = Pandoc.new do
-                    from "markdown"
-                    to "json"
-                end << yaml_string
-
-                meta_doc = PandocFilter::Document.from_JSON json_string
-                meta_doc.meta.to_meta_map
-            end
         end
     end
 end

data/lib/paru/filter/meta_string.rb

@@ -19,7 +19,7 @@
 module Paru
     module PandocFilter
 
-        require_relative "./meta_value"
+        require_relative "./meta_value.rb"
 
         # A MetaString Node represents a String value
         class MetaString < MetaValue

data/lib/paru/filter/meta_value.rb

@@ -16,18 +16,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 "./inner_markdown.rb"
+
 module Paru
     module PandocFilter
-
-        require_relative "./node"
-
         # A MetaValue Node is either a MetaMap, MetaList, MetaBool, MetaString, MetaInlines, or a MetaBlocks.
         #
         # @see http://hackage.haskell.org/package/pandoc-types-1.17.0.4/docs/Text-Pandoc-Definition.html#t:MetaValue
         #
         # @!attribute value
-        #   @return [String]
+        #   @return [String|Boolean]
         class MetaValue < Node
+            include InnerMarkdown
 
             attr_accessor :value
 

data/lib/paru/filter/metadata.rb

@@ -0,0 +1,114 @@
+#--
+# Copyright 2015, 2016, 2017 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 "yaml"
+require_relative "../pandoc.rb"
+require_relative "../filter_error.rb"
+
+module Paru
+    module PandocFilter
+        # A Metadata object is a Ruby Hash representation of a pandoc metadata
+        # node.
+        class Metadata < Hash
+
+            # Create a new Metadata object based on the contents.
+            #
+            # @param contents [MetaMap|String|Hash] the initial contents of this
+            #   metadata. If contents is a String, it is treated as a YAML string
+            #   and converted to a Hash first.
+            #
+            # @raise Error when converting contents to a Hash fails
+            def initialize(contents = {})
+                if not contents.is_a? Hash
+                    # If not a Hash, it is either a YAML string or can be
+                    # converted to a YAML string
+                    if contents.is_a? PandocFilter::MetaMap
+                        yaml_string = meta2yaml contents
+                    elsif contents.is_a? String
+                        yaml_string = contents
+                    else
+                        raise FilterError.new("Expected a Hash, MetaMap, or String, got '#{contents}' instead.")
+                    end
+
+                    # Try to convert the YAML string to a Hash
+                    if yaml_string.empty?
+                        contents = {}
+                    else
+                        contents = YAML.load yaml_string
+                    end
+
+                    if not contents
+                        # Error parsing YAML
+                        raise FilterError.new("Unable to convert YAML string '#{yaml_string}' to a Hash.")
+                    end
+                end
+
+                # Merge the contents with this newly created Metadata
+                contents.each do |key, value|
+                    self[key] = value
+                end
+            end
+
+            # Convert this Metadata to a pandoc AST representation of
+            # metadata: {PandocFilter::Meta}
+            #
+            # @return [Meta] the pandoc AST representation as a {PandocFilter::Meta} node
+            def to_meta()
+                if self.empty?
+                    PandocFilter::Meta.new {}
+                else
+                    begin
+                        yaml_string = "#{clean_hash.to_yaml}..."
+                        yaml2json = Paru::Pandoc.new {from "markdown"; to "json"}
+                        json_string = yaml2json << yaml_string
+                        meta_doc = PandocFilter::Document.from_JSON json_string
+                        meta_doc.meta
+                    rescue
+                    end
+                end
+            end
+
+            private 
+
+            # Convert a {PandocFilter::Meta} node to a Metadata
+            #
+            # @param meta [Meta|MetaMap] the {PandocFilter::Meta} node to convert to a
+            #   MetadataHash
+            def meta2yaml(meta)
+                begin
+                    json2yaml = Paru::Pandoc.new {from "json"; to "markdown"; standalone}
+                    meta = PandocFilter::Meta.from_meta_map(meta) unless meta.is_a? PandocFilter::Meta
+                    meta_doc = PandocFilter::Document.new(PandocFilter::CURRENT_PANDOC_VERSION, meta.to_ast, [])
+                    yaml_string = json2yaml << meta_doc.to_JSON
+                    yaml_string.strip
+                rescue
+                end
+            end
+
+            # Create a true Hash from this Metadata to prevent the +to_yaml+
+            # method from mixing in the name of this class and confusing pandoc
+            def clean_hash
+                hash = {}
+                each do |key, value|
+                    hash[key] = value
+                end
+                hash
+            end
+        end
+    end
+end